Classe ProtectionEngineclass ProtectionEngine

Gestisce azioni correlate alla protezione relative a un'identità specifica.Manages protection-related actions related to a specific identity.

RiepilogoSummary

MembriMembers DescrizioniDescriptions
public const Settings& GetSettings() constpublic const Settings& GetSettings() const Ottiene le impostazioni del motore.Gets the engine settings.
public std:: shared_ptr <AsyncControl> GetTemplatesAsync (const std:: shared_ptr <ProtectionEngine::Observer>& Observer, const std:: shared_ptr <void>& context)public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Ottiene la raccolta di modelli disponibili per un utente.Get collection of templates available to a user.
public std:: Vector <std::shared_ptr<TemplateDescriptor> > gettemplates (const std:: shared_ptr <void>& context)public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context) Ottiene la raccolta di modelli disponibili per un utente.Get collection of templates available to a user.
public bool IsFeatureSupported (FeatureId featureId)public bool IsFeatureSupported(FeatureId featureId) Verificare che la funzionalità sia supportata.Check is feature supported.
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)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) Ottiene la raccolta di diritti disponibili per un utente per un ID etichetta.Get collection of rights available to a user for a label ID.
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)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) Ottiene la raccolta di diritti disponibili per un utente per un labelId.Get collection of rights available to a user for a 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)public std::shared_ptr<AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::PublishingSettings& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context) Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.
public std:: shared_ptr <ProtectionHandler> CreateProtectionHandlerForPublishing (const ProtectionHandler::P ublishingsettings& Settings, const std:: shared_ptr <void>& context)public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::PublishingSettings& settings, const std::shared_ptr<void>& context) Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.
public std:: shared_ptr <AsyncControl> CreateProtectionHandlerForConsumptionAsync (const ProtectionHandler:: ConsumptionSettings& Settings, const std:: shared_ptr <ProtectionHandler::Observer>& Observer, const std:: shared_ptr <void>& context)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 gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.
public std:: shared_ptr <ProtectionHandler> CreateProtectionHandlerForConsumption (const ProtectionHandler:: ConsumptionSettings& Settings, const std:: shared_ptr <void>& context)public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::ConsumptionSettings& settings, const std::shared_ptr<void>& context) Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.
public bool LoadUserCert (const std:: shared_ptr <void>& context)public bool LoadUserCert(const std::shared_ptr<void>& context) pre-preventivamente: caricare il certificato concessore di licenze utente, utile quando il caricamento in background tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.pre-emptively load user licensor certificate, useful when background loading else using prelicense might incurr an additional network call.
public std:: shared_ptr <AsyncControl> LoadUserCertAsync (const std:: shared_ptr <ProtectionEngine::Observer>& Observer, const std:: shared_ptr <void>& context)public std::shared_ptr<AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) pre-preventivamente: caricare il certificato concessore di licenze utente, utile quando il caricamento in background tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.pre-emptively load user licensor certificate, useful when background loading else using prelicense might incurr an additional network call.
public void RegisterContentForTrackingAndRevocation (const std:: Vector <uint8_t>& serializedPublishingLicense, const std:: string& ContentName, bool isOwnerNotificationEnabled, const std:: shared_ptr <void>& context)public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>& context) Registrare la licenza di pubblicazione (PL) per il rilevamento dei documenti & revoca.Register publishing license (PL) for document tracking & revocation.
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)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) Registrare la licenza di pubblicazione (PL) per il rilevamento dei documenti & revoca.Register publishing license (PL) for document tracking & revocation.
public void RevokeContent (const std:: Vector <uint8_t>& serializedPublishingLicense, const std:: shared_ptr <void>& context)public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context) Eseguire la revoca per il contenuto.Perform revocation for content.
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)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) Eseguire la revoca per il contenuto.Perform revocation for content.
public std:: Vector <std::shared_ptr<DelegationLicense> > CreateDelegationLicenses (const DelegationLicenseSettings& Settings, const std:: shared_ptr <void>& context)public std::vector<std::shared_ptr<DelegationLicense>> CreateDelegationLicenses(const DelegationLicenseSettings& settings, const std::shared_ptr<void>& context) Crea una licenza delegata.Creates a delegated license.
public std:: shared_ptr <AsyncControl> CreateDelegationLicensesAsync (const DelegationLicenseSettings& Settings, const std:: shared_ptr <ProtectionEngine::Observer>& Observer, const std:: shared_ptr <void>& context)public std::shared_ptr<AsyncControl> CreateDelegationLicensesAsync(const DelegationLicenseSettings& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Crea una licenza delegata.Creates a delegated license.

MembriMembers

GetSettings (funzione)GetSettings function

Ottiene le impostazioni del motore.Gets the engine settings.

Restituisce: impostazioni del motoreReturns: Engine settings

GetTemplatesAsync (funzione)GetTemplatesAsync function

Ottiene la raccolta di modelli disponibili per un utente.Get collection of templates available to a user.

ParametriParameters:

  • observer: classe che implementa l'interfaccia ProtectionEngine::Observerobserver: A class implementing the ProtectionEngine::Observer interface

  • context: contesto client che verrà nuovamente passato in maniera opaca agli observer e all'oggetto HttpDelegate facoltativocontext: Client context that will be opaquely passed back to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

Funzione gettemplatesGetTemplates function

Ottiene la raccolta di modelli disponibili per un utente.Get collection of templates available to a user.

ParametriParameters:

  • context: contesto client che verrà passato in maniera opaca all'oggetto HttpDelegate facoltativocontext: Client context that will be opaquely passed to optional HttpDelegate

Restituisce: elenco di ID modelloReturns: List of template IDs

IsFeatureSupported (funzione)IsFeatureSupported function

Verificare che la funzionalità sia supportata.Check is feature supported.

ParametriParameters:

  • FeatureId: ID della funzionalità da controllarefeatureId: id of feature to check

Restituisce: risultato booleanoReturns: Boolean result

GetRightsForLabelIdAsync (funzione)GetRightsForLabelIdAsync function

Ottiene la raccolta di diritti disponibili per un utente per un ID etichetta.Get collection of rights available to a user for a label ID.

ParametriParameters:

  • documentId: ID documento associato ai metadati del documentodocumentId: Document ID associated with the document metadata

  • LabelId: ID etichetta associato ai metadati del documento con cui è stato creato il documentolabelId: Label ID associated with the document metadata with which the document created

  • owneremail: proprietario del documentoownerEmail: owner of the document

  • R: l'utente delegato viene specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utente, vuoto se non è presente alcun valoreA: delegated user is specified when the authenticating user/application is acting on behalf of another user, empty if none

  • observer: classe che implementa l'interfaccia ProtectionEngine::Observerobserver: A class implementing the ProtectionEngine::Observer interface

  • context: questo stesso contesto verrà inoltrato a ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess o ProtectionEngine::Observer::OnGetRightsForLabelIdFailurecontext: This same context will be forwarded to ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess or ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Restituisce: oggetto controllo asincrono.Returns: Async control object.

GetRightsForLabelId (funzione)GetRightsForLabelId function

Ottiene la raccolta di diritti disponibili per un utente per un labelId.Get collection of rights available to a user for a labelId.

ParametriParameters:

  • documentId: ID documento associato ai metadati del documentodocumentId: Document ID associated with the document metadata

  • LabelId: ID etichetta associato ai metadati del documento con cui è stato creato il documentolabelId: Label ID associated with the document metadata with which the document created

  • ownerEmail: proprietario del documentoownerEmail: Owner of the document

  • R: l'utente delegato viene specificato quando l'utente o l'applicazione di autenticazione agisce per conto di un altro utente, vuoto se non è presente alcun valoreA: delegated user is specified when the authenticating user/application is acting on behalf of another user, empty if none

  • context: questo stesso contesto verrà inoltrato all'oggetto HttpDelegate facoltativocontext: This same context will be forwarded to optional HttpDelegate

Restituisce: elenco di dirittiReturns: List of rights

CreateProtectionHandlerForPublishingAsync (funzione)CreateProtectionHandlerForPublishingAsync function

Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.

ParametriParameters:

  • Impostazioni: impostazioni di protezionesettings: Protection settings

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

CreateProtectionHandlerForPublishing (funzione)CreateProtectionHandlerForPublishing function

Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.

ParametriParameters:

  • Impostazioni: impostazioni di protezionesettings: Protection settings

  • contesto: contesto client che verrà trasmesso in modo opaco a HttpDelegate facoltativocontext: Client context that will be opaquely forwarded to optional HttpDelegate

Restituisce: ProtectionHandlerReturns: ProtectionHandler

CreateProtectionHandlerForConsumptionAsync (funzione)CreateProtectionHandlerForConsumptionAsync function

Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.

ParametriParameters:

  • Impostazioni: impostazioni di protezionesettings: Protection settings

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

CreateProtectionHandlerForConsumption (funzione)CreateProtectionHandlerForConsumption function

Crea un gestore di protezione in cui diritti/ruoli vengono assegnati a utenti specifici.Creates a protection handler where rights/roles are assigned to specific users.

ParametriParameters:

  • Impostazioni: impostazioni di protezionesettings: Protection settings

  • contesto: contesto client che verrà trasmesso in modo opaco a HttpDelegate facoltativocontext: Client context that will be opaquely forwarded to optional HttpDelegate

Restituisce: ProtectionHandlerReturns: ProtectionHandler

LoadUserCert (funzione)LoadUserCert function

pre-preventivamente: caricare il certificato concessore di licenze utente, utile quando il caricamento in background tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.pre-emptively load user licensor certificate, useful when background loading else using prelicense might incurr an additional network call.

ParametriParameters:

  • contesto: contesto client che verrà trasmesso in modo opaco a HttpDelegate facoltativocontext: Client context that will be opaquely forwarded to optional HttpDelegate

Restituisce: true se il caricamento è riuscito altrimenti false.Returns: True if loaded successfully else false.

LoadUserCertAsync (funzione)LoadUserCertAsync function

pre-preventivamente: caricare il certificato concessore di licenze utente, utile quando il caricamento in background tramite prelicense potrebbe incorrere in una chiamata di rete aggiuntiva.pre-emptively load user licensor certificate, useful when background loading else using prelicense might incurr an additional network call.

ParametriParameters:

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

RegisterContentForTrackingAndRevocation (funzione)RegisterContentForTrackingAndRevocation function

Registrare la licenza di pubblicazione (PL) per il rilevamento dei documenti & revoca.Register publishing license (PL) for document tracking & revocation.

ParametriParameters:

  • ContentName: nome associato al contenuto specificato da serializedPublishingLicense.contentName: The name to associated with the content specified by the serializedPublishingLicense. Se serializedPublishingLicense specifica un nome di contenuto, tale valore avrà la precedenza.If the serializedPublishingLicense specifies a content name, that value will take precedence.

  • isOwnerNotificationEnabled: impostare su true per notificare al proprietario via posta elettronica ogni volta che il documento viene decrittografato oppure false per non inviare la notifica.isOwnerNotificationEnabled: Set to true to notify the owner via email whenever the document is decrypted, or false to not send the notification.

  • contesto: contesto client che verrà trasmesso in modo opaco a HttpDelegate facoltativocontext: Client context that will be opaquely forwarded to optional HttpDelegate

RegisterContentForTrackingAndRevocationAsync (funzione)RegisterContentForTrackingAndRevocationAsync function

Registrare la licenza di pubblicazione (PL) per il rilevamento dei documenti & revoca.Register publishing license (PL) for document tracking & revocation.

ParametriParameters:

  • serializedPublishingLicense: licenza di pubblicazione serializzata dal contenuto protettoserializedPublishingLicense: Serialized publishing license from protected content

  • ContentName: nome associato al contenuto specificato da serializedPublishingLicense.contentName: The name to associated with the content specified by the serializedPublishingLicense. Se serializedPublishingLicense specifica un nome di contenuto, tale valore avrà la precedenzaIf the serializedPublishingLicense specifies a content name, that value will take precedence

  • isOwnerNotificationEnabled: impostare su true per notificare al proprietario via posta elettronica ogni volta che il documento viene decrittografato oppure false per non inviare la notifica.isOwnerNotificationEnabled: Set to true to notify the owner via email whenever the document is decrypted, or false to not send the notification.

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

RevokeContent (funzione)RevokeContent function

Eseguire la revoca per il contenuto.Perform revocation for content.

ParametriParameters:

  • serializedPublishingLicense: licenza di pubblicazione serializzata dal contenuto protettoserializedPublishingLicense: Serialized publishing license from protected content

  • contesto: contesto client che verrà trasmesso in modo opaco a HttpDelegate facoltativocontext: Client context that will be opaquely forwarded to optional HttpDelegate

RevokeContentAsync (funzione)RevokeContentAsync function

Eseguire la revoca per il contenuto.Perform revocation for content.

ParametriParameters:

  • serializedPublishingLicense: licenza di pubblicazione serializzata dal contenuto protettoserializedPublishingLicense: Serialized publishing license from protected content

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object.

CreateDelegationLicenses (funzione)CreateDelegationLicenses function

Crea una licenza delegata.Creates a delegated license.

ParametriParameters:

  • Impostazioni: impostazioni di delegasettings: The delegation settings

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: un vettore delle licenze di delega usa questo metodo per creare licenze per un elenco di utentiReturns: A vector of the delegation licenses Use this method to create licenses for a list of users

CreateDelegationLicensesAsync (funzione)CreateDelegationLicensesAsync function

Crea una licenza delegata.Creates a delegated license.

ParametriParameters:

  • Impostazioni: impostazioni di delegasettings: The delegation settings

  • observer: classe che implementa l'interfaccia ProtectionHandler::Observerobserver: A class implementing the ProtectionHandler::Observer interface

  • contesto: contesto client che verrà inviato in modo opaco agli osservatori e HttpDelegate facoltativicontext: Client context that will be opaquely forwarded to observers and optional HttpDelegate

Restituisce: oggetto controllo asincrono.Returns: Async control object. Utilizzare questo metodo per creare licenze per un elenco di utenti.Use this method to create licenses for a list of users. Ricevere il vettore DelegationLicense negli errori di callback OnCreateDelegatedLicensesSuccess vengono inviati in OnCreateDelegatedLicensesFailureReceive the DelegationLicense vector in callback OnCreateDelegatedLicensesSuccess Failures are sent in OnCreateDelegatedLicensesFailure