class ProtectionEngine

Administra acciones relacionadas con la protección relacionadas con una identidad específica.

Resumen

Miembros Descripciones
const pública Configuración & GetSettings() const Obtiene la configuración del motor.
public std::shared_ptr < AsyncControl > GetTemplatesAsync(const std::shared_ptr < ProtectionEngine::Observer, >& const std::shared_ptr void <>& context) Obtenga una colección de plantillas disponibles para un usuario.
public std::vector < std::shared_ptr < TemplateDescriptor >> GetTemplates(const std::shared_ptr < void >& context, const std::shared_ptr < const GetTemplatesSettings >& templateSettings) Obtenga una colección de plantillas disponibles para un usuario.
public std::shared_ptr < AsyncControl > GetTemplatesAsync(const std::shared_ptr < ProtectionEngine::Observer >& observer, const std::shared_ptr < void >& context, const std::shared_ptr < const GetTemplatesSettings >& templateSettings) Obtenga una colección de plantillas disponibles para un usuario.
public std::vector < std::shared_ptr < TemplateDescriptor >> GetTemplates(const std::shared_ptr < void >& context) Obtenga una colección de plantillas disponibles para un usuario.
bool público IsFeatureSupported(FeatureId featureId) La característica Comprobar es compatible.
public std::shared_ptr < AsyncControl > GetRightsForLabelIdAsync(const std::string & documentId, const std::string & labelId, const std::string & ownerEmail, const std::string & delegatedUserEmail, const std::shared_ptr < ProtectionEngine::Observer, >& const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Obtenga la colección de derechos disponibles para un usuario para un id. de etiqueta.
public std::vector < std::string > GetRightsForLabelId(const std::string & documentId, const std::string & labelId, const std::string & ownerEmail, const std::string & delegatedUserEmail, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Obtenga una colección de derechos disponibles para un usuario para un labelId.
public std::shared_ptr < AsyncControl > CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishingSettings & settings, const std::shared_ptr < ProtectionHandler::Observer >& observer, const std::shared_ptr < void >& context) Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.
public std::shared_ptr < ProtectionHandler > CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishingSettings & settings, const std::shared_ptr < void >& context) Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.
public std::shared_ptr < AsyncControl > CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::ConsumptionSettings & settings, const std::shared_ptr < ProtectionHandler::Observer >& observer, const std::shared_ptr < void >& context) Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.
public std::shared_ptr < ProtectionHandler > CreateProtectionHandlerForConsumption(const ProtectionHandler::ConsumptionSettings & settings, const std::shared_ptr < void >& context) Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.
bool público LoadUserCert(const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) cargue previamente el certificado de licencia de usuario, útil cuando la carga en segundo plano con licencia previa podría producirse en una llamada de red adicional.
public std::shared_ptr < AsyncControl > LoadUserCertAsync(const std::shared_ptr < ProtectionEngine::Observer >& observer, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) cargue previamente el certificado de licencia de usuario, útil cuando la carga en segundo plano con licencia previa podría producirse en una llamada de red adicional.
public void RegisterContentForTrackingAndRevocation(const std::vector < uint8_t >& serializedPublishingLicense, const std::string & contentName, bool isOwnerNotificationEnabled, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Registrar licencia de publicación (PL) para la revocación de seguimiento & de documentos.
public std::shared_ptr < AsyncControl > RegisterContentForTrackingAndRevocationAsync(const std::vector < uint8_t >& serializedPublishingLicense, const std::string & contentName, bool isOwnerNotificationEnabled, const std::shared_ptr < ProtectionEngine::Observer >& observer, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Registrar licencia de publicación (PL) para la revocación de seguimiento & de documentos.
public void RevokeContent(const std::vector < uint8_t >& serializedPublishingLicense, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Realice la revocación del contenido.
public std::shared_ptr < AsyncControl > RevokeContentAsync(const std::vector < uint8_t >& serializedPublishingLicense, const std::shared_ptr < ProtectionEngine::Observer >& observer, const std::shared_ptr < void >& context, const ProtectionCommonSettings & settings) Realice la revocación del contenido.
public std::vector < std::shared_ptr < DelegationLicense >> CreateDelegationLicenses(const DelegationLicenseSettings & settings, const std::shared_ptr < void >& context) Crea una licencia delegada.
public std::shared_ptr < AsyncControl > CreateDelegationLicensesAsync(const DelegationLicenseSettings & settings, const std::shared_ptr < ProtectionEngine::Observer >& observer, const std::shared_ptr < void >& context) Crea una licencia delegada.

Miembros

Función GetSettings

Obtiene la configuración del motor.

Devuelve: Configuración del motor

Función GetTemplatesAsync

Obtenga una colección de plantillas disponibles para un usuario.

Parámetros:

  • observador:una clase que implementa la interfaz ProtectionEngine::Observer

  • contexto:contexto de cliente que se volverá a pasar opacamente a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función GetTemplates

Obtenga una colección de plantillas disponibles para un usuario.

Parámetros:

  • contexto:contexto de cliente que se pasará de forma opaca a HttpDelegate opcional

  • templateSettings:Configuración usar al obtener plantillas

Devuelve: Lista de los IDs de plantilla

Función GetTemplatesAsync

Obtenga una colección de plantillas disponibles para un usuario.

Parámetros:

  • observador:una clase que implementa la interfaz ProtectionEngine::Observer

  • contexto:contexto de cliente que se volverá a pasar opacamente a los observadores y httpdelegate opcional

  • templateSettings:Configuración usar al obtener plantillas

Devuelve: objeto de control asincrónico.

Función GetTemplates

Obtenga una colección de plantillas disponibles para un usuario.

Parámetros:

  • contexto:contexto de cliente que se pasará de forma opaca a HttpDelegate opcional

Devuelve: Lista de los IDs de plantilla

Función IsFeatureSupported

La característica Comprobar es compatible.

Parámetros:

  • featureId:id. de característica para comprobar

Devuelve: resultado booleano

Función GetRightsForLabelIdAsync

Obtenga la colección de derechos disponibles para un usuario para un id. de etiqueta.

Parámetros:

  • documentId:Id. de documento asociado a los metadatos del documento

  • labelId:Id. de etiqueta asociado a los metadatos del documento con los que creó el documento

  • ownerEmail:propietario del documento

  • A:el usuario delegado se especifica cuando el usuario o la aplicación de autenticación actúa en nombre de otro usuario, vacío si ninguno

  • observador:una clase que implementa la interfaz ProtectionEngine::Observer

  • contexto:este mismo contexto se reenviará a ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess o [ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Devuelve: objeto de control asincrónico.

Función GetRightsForLabelId

Obtenga una colección de derechos disponibles para un usuario para un labelId.

Parámetros:

  • documentId:Id. de documento asociado a los metadatos del documento

  • labelId:Id. de etiqueta asociado a los metadatos del documento con los que creó el documento

  • ownerEmail:Propietario del documento

  • A:el usuario delegado se especifica cuando el usuario o la aplicación de autenticación actúa en nombre de otro usuario, vacío si ninguno

  • contexto:este mismo contexto se reenviará a HttpDelegate opcional

Devoluciones:Lista de derechos

Función CreateProtectionHandlerForPublishingAsync

Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.

Parámetros:

  • configuración:Configuración de protección

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función CreateProtectionHandlerForPublishing

Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.

Parámetros:

  • configuración:Configuración de protección

  • contexto:contexto de cliente que se reenviará de forma opaca a HttpDelegate opcional

Devuelve: ProtectionHandler

Función CreateProtectionHandlerForConsumptionAsync

Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.

Parámetros:

  • configuración:Configuración de protección

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función CreateProtectionHandlerForConsumption

Crea un controlador de protección donde se asignan derechos o roles a usuarios específicos.

Parámetros:

  • configuración:Configuración de protección

  • contexto:contexto de cliente que se reenviará de forma opaca a HttpDelegate opcional

Devuelve: ProtectionHandler

Función LoadUserCert

cargue previamente el certificado de licencia de usuario, útil cuando la carga en segundo plano con licencia previa podría producirse en una llamada de red adicional.

Parámetros:

  • contexto:contexto de cliente que se reenviará de forma opaca a HttpDelegate opcional

Devuelve:Verdadero si se carga correctamente de lo contrario, es falso.

Función LoadUserCertAsync

cargue previamente el certificado de licencia de usuario, útil cuando la carga en segundo plano con licencia previa podría producirse en una llamada de red adicional.

Parámetros:

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función RegisterContentForTrackingAndRevocation

Registrar licencia de publicación (PL) para la revocación de seguimiento & de documentos.

Parámetros:

  • contentName:el nombre asociado al contenido especificado por la serializedPublishingLicense. Si el serializedPublishingLicense especifica un nombre de contenido, ese valor tendrá prioridad.

  • isOwnerNotificationEnabled:Establezca el valor en true para notificar al propietario por correo electrónico siempre que se descifra el documento, o false para no enviar la notificación.

  • contexto:contexto de cliente que se reenviará de forma opaca a HttpDelegate opcional

Función RegisterContentForTrackingAndRevocationAsync

Registrar licencia de publicación (PL) para la revocación de seguimiento & de documentos.

Parámetros:

  • serializedPublishingLicense:Licencia de publicación serializada a partir de contenido protegido

  • contentName:el nombre asociado al contenido especificado por la serializedPublishingLicense. Si el serializedPublishingLicense especifica un nombre de contenido, ese valor tendrá prioridad

  • isOwnerNotificationEnabled:Establezca el valor en true para notificar al propietario por correo electrónico siempre que se descifra el documento, o false para no enviar la notificación.

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función RevokeContent

Realice la revocación del contenido.

Parámetros:

  • serializedPublishingLicense:Licencia de publicación serializada a partir de contenido protegido

  • contexto:contexto de cliente que se reenviará de forma opaca a HttpDelegate opcional

Función RevokeContentAsync

Realice la revocación del contenido.

Parámetros:

  • serializedPublishingLicense:Licencia de publicación serializada a partir de contenido protegido

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico.

Función CreateDelegationLicenses

Crea una licencia delegada.

Parámetros:

  • configuración:la configuración de delegación

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve:un vector de las licencias de delegación Use este método para crear licencias para una lista de usuarios

Función CreateDelegationLicensesAsync

Crea una licencia delegada.

Parámetros:

  • configuración:la configuración de delegación

  • observador:una clase que implementa la interfaz ProtectionHandler::Observer

  • contexto:contexto de cliente que se reenviará de forma opaca a los observadores y httpdelegate opcional

Devuelve: objeto de control asincrónico. Use este método para crear licencias para una lista de usuarios. Recibir el vector DelegationLicense en la devolución de llamada OnCreateDelegatedLicensesSuccess Failures se envían en OnCreateDelegatedLicensesFailure