Classe ProtectionEngine

Gestisce le azioni correlate alla protezione correlate a un'identità specifica.

Riepilogo

Membri Descrizione
public const Impostazioni& Get Impostazioni() const Ottiene le impostazioni del motore.
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context, const std::shared_ptr<const GetTemplates Impostazioni>& template Impostazioni) Ottenere la raccolta di modelli disponibili per un utente.
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Ottenere la raccolta di modelli disponibili per un utente.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context, const std::shared_ptr<const GetTemplates Impostazioni>& template Impostazioni) Ottenere la raccolta di modelli disponibili per un utente.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context) Ottenere la raccolta di modelli disponibili per un utente.
public bool IsFeatureSupported(FeatureId featureId) Il controllo è supportato dalla funzionalità.
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>& observer, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni&<settings) Ottenere la raccolta di diritti disponibili per un utente per un ID etichetta.
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 ProtectionCommon Impostazioni& settings) Ottenere la raccolta di diritti disponibili per un utente per un labelId.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishing Impostazioni& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishing Impostazioni& settings, const std::shared_ptr<void>& context) Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption Impostazioni& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::Consumption Impostazioni& settings, const std::shared_ptr<void>& context) Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.
public bool LoadUserCert(const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) caricare preventivamente il certificato di licenza utente, utile quando il caricamento in background in altro caso tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.
public std::shared_ptr<AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) caricare preventivamente il certificato di licenza utente, utile quando il caricamento in background in altro caso tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) Registrare la licenza di pubblicazione (PL) per il rilevamento e la revoca dei documenti.
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 ProtectionCommon Impostazioni&> settings)< Registrare la licenza di pubblicazione (PL) per il rilevamento e la revoca dei documenti.
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) Eseguire la revoca per il contenuto.
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 ProtectionCommon Impostazioni& settings) Eseguire la revoca per il contenuto.
public std::vector<std::shared_ptr<DelegationLicense>> CreateDelegationLicenses(const DelegationLicense Impostazioni& settings, const std::shared_ptr<void>& context) Crea una licenza delegata.
public std::shared_ptr AsyncControl> CreateDelegationLicensesAsync(const DelegationLicense Impostazioni& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context)< Crea una licenza delegata.
public std::shared_ptr<TenantInformation> GetTenantInformation(const ProtectionCommon Impostazioni& settings, const std::shared_ptr<void>& context) Carica il certificato di licenza utente e restituisce informazioni sul tenant.
public std::shared_ptr<AsyncControl> GetTenantInformationAsync(const ProtectionCommon Impostazioni& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Carica il certificato di licenza utente e restituisce informazioni sul tenant.
public std::shared_ptr<LicenseRightsData> GetLicenseRightsData(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) Ottenere i dati sui diritti di licenza.
public std::shared_ptr<AsyncControl> GetLicenseRightsDataAsync(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context, const ProtectionCommon Impostazioni& settings) Ottenere i dati sui diritti di licenza.

Membri

Funzione Get Impostazioni

Ottiene le impostazioni del motore.

Restituisce: impostazioni del motore

Funzione GetTemplatesAsync

Ottenere la raccolta di modelli disponibili per un utente.

Parametri:

  • observer: classe che implementa l'interfaccia ProtectionEngine::Observer

  • context: contesto client che verrà passato in modo opaco agli osservatori e facoltativo HttpDelegate

  • template Impostazioni: Impostazioni da usare per ottenere modelli

Restituisce: oggetto controllo asincrono.

Funzione GetTemplatesAsync

Ottenere la raccolta di modelli disponibili per un utente.

Parametri:

  • observer: classe che implementa l'interfaccia ProtectionEngine::Observer

  • context: contesto client che verrà passato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione GetTemplates

Ottenere la raccolta di modelli disponibili per un utente.

Parametri:

  • context: contesto client che verrà passato in modo opaco a HttpDelegate facoltativo

  • template Impostazioni: Impostazioni da usare per ottenere modelli

Restituisce: elenco di ID modello

Funzione GetTemplates

Ottenere la raccolta di modelli disponibili per un utente.

Parametri:

  • context: contesto client che verrà passato in modo opaco a HttpDelegate facoltativo

Restituisce: elenco di ID modello

Funzione IsFeatureSupported

Il controllo è supportato dalla funzionalità.

Parametri:

  • featureId: ID della funzionalità da controllare

Restituisce: risultato booleano

Funzione GetRightsForLabelIdAsync

Ottenere la raccolta di diritti disponibili per un utente per un ID etichetta.

Parametri:

  • documentId: ID documento associato ai metadati del documento

  • labelId: ID etichetta associato ai metadati del documento con cui è stato creato il documento

  • ownerEmail: proprietario del documento

  • R: l'utente delegato viene specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utente, vuoto se nessuno

  • observer: classe che implementa l'interfaccia ProtectionEngine::Observer

  • context: lo stesso contesto verrà inoltrato a ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess o ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Restituisce: oggetto controllo asincrono.

Funzione GetRightsForLabelId

Ottenere la raccolta di diritti disponibili per un utente per un labelId.

Parametri:

  • documentId: ID documento associato ai metadati del documento

  • labelId: ID etichetta associato ai metadati del documento con cui è stato creato il documento

  • ownerEmail: proprietario del documento

  • R: l'utente delegato viene specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utente, vuoto se nessuno

  • context: lo stesso contesto verrà inoltrato a HttpDelegate facoltativo

Restituisce: elenco di diritti

Funzione CreateProtectionHandlerForPublishingAsync

Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.

Parametri:

  • impostazioni: impostazioni di protezione

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono. Se le impostazioni sono solo offline, il motore deve avere precedentemente chiamato GetTemplatesAsync e LoadUserCertAsync

Funzione CreateProtectionHandlerForPublishing

Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.

Parametri:

  • impostazioni: impostazioni di protezione

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Restituisce: ProtectionHandler Se le impostazioni sono solo offline, il motore deve avere precedentemente chiamato GetTemplates e LoadUserCert

Funzione CreateProtectionHandlerForConsumptionAsync

Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.

Parametri:

  • impostazioni: impostazioni di protezione

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione CreateProtectionHandlerForConsumption

Crea un gestore di protezione in cui i diritti/ruoli vengono assegnati a utenti specifici.

Parametri:

  • impostazioni: impostazioni di protezione

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Restituisce: ProtectionHandler

Funzione LoadUserCert

caricare preventivamente il certificato di licenza utente, utile quando il caricamento in background in altro caso tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.

Parametri:

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Restituisce: True se il caricamento è stato eseguito correttamente. In caso contrario, false.

Funzione LoadUserCertAsync

caricare preventivamente il certificato di licenza utente, utile quando il caricamento in background in altro caso tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.

Parametri:

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione RegisterContentForTrackingAndRevocation

Registrare la licenza di pubblicazione (PL) per il rilevamento e la revoca dei documenti.

Parametri:

  • contentName: nome associato al contenuto specificato dall'oggetto serializedPublishingLicense. Se serializedPublishingLicense specifica un nome di contenuto, tale valore avrà la precedenza.

  • isOwnerNotificationEnabled: impostare su true per notificare al proprietario tramite posta elettronica ogni volta che il documento viene decrittografato o false per non inviare la notifica.

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Funzione RegisterContentForTrackingAndRevocationAsync

Registrare la licenza di pubblicazione (PL) per il rilevamento e la revoca dei documenti.

Parametri:

  • serializedPublishingLicense: licenza di pubblicazione serializzata da contenuto protetto

  • contentName: nome associato al contenuto specificato dall'oggetto serializedPublishingLicense. Se serializedPublishingLicense specifica un nome di contenuto, tale valore avrà la precedenza

  • isOwnerNotificationEnabled: impostare su true per notificare al proprietario tramite posta elettronica ogni volta che il documento viene decrittografato o false per non inviare la notifica.

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

RevokeContent, funzione

Eseguire la revoca per il contenuto.

Parametri:

  • serializedPublishingLicense: licenza di pubblicazione serializzata da contenuto protetto

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Funzione RevokeContentAsync

Eseguire la revoca per il contenuto.

Parametri:

  • serializedPublishingLicense: licenza di pubblicazione serializzata da contenuto protetto

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

Funzione CreateDelegationLicenses

Crea una licenza delegata.

Parametri:

  • impostazioni: impostazioni di delega

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: vettore delle licenze di delega Utilizzare questo metodo per creare licenze per un elenco di utenti

Funzione CreateDelegationLicensesAsync

Crea una licenza delegata.

Parametri:

  • impostazioni: impostazioni di delega

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono. Usare questo metodo per creare licenze per un elenco di utenti. Ricevere il vettore DelegationLicense nel callback OnCreateDelegatedLicensesSuccess Errori vengono inviati in OnCreateDelegatedLicensesFailure

Funzione GetTenantInformation

Carica il certificato di licenza utente e restituisce informazioni sul tenant.

Parametri:

  • settings: impostazioni comuni

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

Restituisce: TenantInformation

Funzione GetTenantInformationAsync

Carica il certificato di licenza utente e restituisce informazioni sul tenant.

Parametri:

  • settings: impostazioni comuni

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

Restituisce: oggetto controllo asincrono.

  • ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccesss verrà chiamato su success ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure verrà chiamato in caso di errore

Funzione GetLicenseRightsData

Ottenere i dati sui diritti di licenza.

Parametri:

  • serializedPublishingLicense: licenza di pubblicazione serializzata da contenuto protetto

  • context: contesto client che verrà inoltrato in modo opaco a HttpDelegate facoltativo

  • settings: impostazioni comuni

Restituisce: dati sui diritti di licenza

Funzione GetLicenseRightsDataAsync

Ottenere i dati sui diritti di licenza.

Parametri:

  • serializedPublishingLicense: licenza di pubblicazione serializzata da contenuto protetto

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observer

  • context: contesto client che verrà inoltrato in modo opaco agli osservatori e facoltativo HttpDelegate

  • settings: impostazioni comuni

Restituisce: oggetto controllo asincrono.