Teilen über

Klasse ProtectionEngine

  • Artikel

Verwaltet schutzbezogene Aktionen im Zusammenhang mit einer bestimmten Identität.

Zusammenfassung

Mitglieder Beschreibungen
public const Einstellungen& Get Einstellungen() const Ruft die Moduleinstellungen ab.
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 Einstellungen>& template Einstellungen) Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context, const std::shared_ptr<const GetTemplates Einstellungen>& template Einstellungen) Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context) Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.
public bool IsFeatureSupported(FeatureId featureId) Die Überprüfung, ob Funktion unterstützt wird.
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 Einstellungen& settings) Abrufen der Sammlung von Rechten, die einem Benutzer für eine Bezeichnungs-ID zur Verfügung stehen.
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 Einstellungen& settings) Dient zum Abrufen der Sammlung von Rechten, die einem Benutzer für eine labelId zur Verfügung stehen.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishing Einstellungen& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishing Einstellungen& settings, const std::shared_ptr<void>& context) Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption Einstellungen& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::Consumption Einstellungen& settings, const std::shared_ptr<void>& context) Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.
public bool LoadUserCert(const std::shared_ptr<void>& context, const ProtectionCommon Einstellungen& settings) Vorab-Laden des Benutzer-Lizenzgeberzertifikats, nützlich beim Laden im Hintergrund, da sonst bei Verwendung der Vorlizenz ein zusätzlicher Netzwerkaufruf erfolgen kann.
public std::shared_ptr AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<<void>& context, const ProtectionCommon Einstellungen& settings) Vorab-Laden des Benutzer-Lizenzgeberzertifikats, nützlich beim Laden im Hintergrund, da sonst bei Verwendung der Vorlizenz ein zusätzlicher Netzwerkaufruf erfolgen kann.
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>& context, const ProtectionCommon Einstellungen& settings) 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, const ProtectionCommon Einstellungen&&> settings)< Register publishing license (PL) for document tracking & revocation.
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon Einstellungen& settings) Führt die Sperrung für Inhalte aus.
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 Einstellungen& settings) Führt die Sperrung für Inhalte aus.
public std::vector<std::shared_ptr DelegationLicense>> CreateDelegationLicenses(const DelegationLicense Einstellungen& settings, const std::shared_ptr<<void>& context) Erstellt eine delegierte Lizenz.
public std::shared_ptr AsyncControl> CreateDelegationLicensesAsync(const DelegationLicense Einstellungen& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context)< Erstellt eine delegierte Lizenz.
public std::shared_ptr<TenantInformation> GetTenantInformation(const ProtectionCommon Einstellungen& settings, const std::shared_ptr<void>& context) Lädt das Zertifikat des Benutzer-Lizenzgebers und gibt Informationen zum Mandanten zurück.
public std::shared_ptr<AsyncControl> GetTenantInformationAsync(const ProtectionCommon Einstellungen& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Lädt das Zertifikat des Benutzer-Lizenzgebers und gibt Informationen zum Mandanten zurück.
public std::shared_ptr LicenseRightsData> GetLicenseRightsData(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<<void>& context, const ProtectionCommon Einstellungen& settings) Abrufen von Lizenzrechtsdaten.
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 Einstellungen& settings) Abrufen von Lizenzrechtsdaten.

Mitglieder

GetSettings-Funktion

Ruft die Moduleinstellungen ab.

Gibt zurück: Moduleinstellungen

GetTemplatesAsync-Funktion

Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.

Parameter:

  • observer: Eine Klasse, die die ProtectionEngine::Observer-Schnittstelle implementiert

  • kontext: Clientkontext, der undurchsichtig an Beobachter und optionale HttpDelegate übergeben wird

  • templateSettings: Einstellungen, die beim Abrufen von Vorlagen verwendet werden

Rückgabe: Asynchrones Steuerungsobjekt.

GetTemplatesAsync-Funktion

Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.

Parameter:

  • observer: Eine Klasse, die die ProtectionEngine::Observer-Schnittstelle implementiert

  • kontext: Clientkontext, der undurchsichtig an Beobachter und optionale HttpDelegate übergeben wird

Rückgabe: Asynchrones Steuerungsobjekt.

GetTemplates-Funktion

Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.

Parameter:

  • context: Clientkontext, der undurchsichtig an optionale HttpDelegate übergeben wird

  • templateSettings: Einstellungen, die beim Abrufen von Vorlagen verwendet werden

Gibt zurück: Liste der Vorlagen-IDs

GetTemplates-Funktion

Abrufen einer Sammlung von Vorlagen, die für einen Benutzer verfügbar sind.

Parameter:

  • context: Clientkontext, der undurchsichtig an optionale HttpDelegate übergeben wird

Gibt zurück: Liste der Vorlagen-IDs

IsFeatureSupported-Funktion

Die Überprüfung, ob Funktion unterstützt wird.

Parameter:

  • featureId: ID der zu prüfenden Funktion

Rüchgabe: boolesches Ergebnis

GetRightsForLabelIdAsync-Funktion

Abrufen der Sammlung von Rechten, die einem Benutzer für eine Bezeichnungs-ID zur Verfügung stehen.

Parameter:

  • documentId: Dokument-ID, die den Dokumentmetadaten zugeordnet ist

  • labelId: Bezeichnungs-ID, die mit den Metadaten des Dokuments verbunden ist, mit denen das Dokument erstellt wurde

  • ownerEmail: Besitzer des Dokuments

  • A: Ein delegierter Benutzer wird angegeben, wenn der authentifizierende Benutzer / die Anwendung im Namen eines anderen Benutzers fungiert; wenn nicht gegeben, leer

  • observer: Eine Klasse, die die ProtectionEngine::Observer-Schnittstelle implementiert

  • context: This context will be forwarded to ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess or ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Rückgabe: Asynchrones Steuerungsobjekt.

GetRightsForLabelId-Funktion

Dient zum Abrufen der Sammlung von Rechten, die einem Benutzer für eine labelId zur Verfügung stehen.

Parameter:

  • documentId: Dokument-ID, die den Dokumentmetadaten zugeordnet ist

  • labelId: Bezeichnungs-ID, die mit den Metadaten des Dokuments verbunden ist, mit denen das Dokument erstellt wurde

  • ownerEmail: Besitzer des Dokuments

  • A: Ein delegierter Benutzer wird angegeben, wenn der authentifizierende Benutzer / die Anwendung im Namen eines anderen Benutzers fungiert; wenn nicht gegeben, leer

  • context: This context will be forwarded to optional HttpDelegate

Gibt zurück: Liste der Rechte

CreateProtectionHandlerForPublishingAsync-Funktion

Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.

Parameter:

  • settings: Schutzeinstellungen

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt. Wenn Einstellungen nur offline sind, muss das Modul zuvor "GetTemplatesAsync" und "LoadUserCertAsync" genannt haben.

CreateProtectionHandlerForPublishing-Funktion

Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.

Parameter:

  • settings: Schutzeinstellungen

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

Returns: ProtectionHandler If settings are offline, engine needs to have previously called GetTemplates and LoadUserCert

CreateProtectionHandlerForConsumptionAsync-Funktion

Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.

Parameter:

  • settings: Schutzeinstellungen

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt.

CreateProtectionHandlerForConsumption-Funktion

Erstellt einen Schutzhandler, bei dem bestimmten Benutzern Rechte/Rollen zugewiesen sind.

Parameter:

  • settings: Schutzeinstellungen

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

Rückgabe: ProtectionHandler

LoadUserCert-Funktion

Vorab-Laden des Benutzer-Lizenzgeberzertifikats, nützlich beim Laden im Hintergrund, da sonst bei Verwendung der Vorlizenz ein zusätzlicher Netzwerkaufruf erfolgen kann.

Parameter:

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

Rückgabe: True, wenn erfolgreich geladen, sonst false.

LoadUserCertAsync-Funktion

Vorab-Laden des Benutzer-Lizenzgeberzertifikats, nützlich beim Laden im Hintergrund, da sonst bei Verwendung der Vorlizenz ein zusätzlicher Netzwerkaufruf erfolgen kann.

Parameter:

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt.

RegisterContentForTrackingAndRevocation-Funktion

Register publishing license (PL) for document tracking & revocation.

Parameter:

  • contentName: Der Name, der dem von der serializedPublishingLicense angegebenen Inhalt zugeordnet ist. Wenn die serializedPublishingLicense einen Inhaltsnamen angibt, hat dieser Wert Vorrang.

  • isOwnerNotificationEnabled: Setzen Sie diesen Wert auf true, um den Besitzer per E-Mail zu benachrichtigen, wenn das Dokument entschlüsselt wird, oder auf false, um keine Benachrichtigung zu senden.

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

RegisterContentForTrackingAndRevocationAsync-Funktion

Register publishing license (PL) for document tracking & revocation.

Parameter:

  • serializedPublishingLicense: Lizenz zur seriellen Veröffentlichung von geschützten Inhalten

  • contentName: Der Name, der dem von der serializedPublishingLicense angegebenen Inhalt zugeordnet ist. Wenn die serializedPublishingLicense einen Inhaltsnamen angibt, hat dieser Wert Vorrang.

  • isOwnerNotificationEnabled: Setzen Sie diesen Wert auf true, um den Besitzer per E-Mail zu benachrichtigen, wenn das Dokument entschlüsselt wird, oder auf false, um keine Benachrichtigung zu senden.

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt.

RevokeContent-Funktion

Führt die Sperrung für Inhalte aus.

Parameter:

  • serializedPublishingLicense: Lizenz zur seriellen Veröffentlichung von geschützten Inhalten

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

RevokeContentAsync-Funktion

Führt die Sperrung für Inhalte aus.

Parameter:

  • serializedPublishingLicense: Lizenz zur seriellen Veröffentlichung von geschützten Inhalten

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt.

CreateDelegationLicenses-Funktion

Erstellt eine delegierte Lizenz.

Parameter:

  • settings: Die Delegierungseinstellungen

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Ein Vektor der Delegierungslizenzen Verwenden Sie diese Methode, um Lizenzen für eine Liste mit Benutzern zu erstellen

CreateDelegationLicensesAsync-Funktion

Erstellt eine delegierte Lizenz.

Parameter:

  • settings: Die Delegierungseinstellungen

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt. Verwenden Sie diese Methode, um Lizenzen für eine Liste mit Benutzern zu erstellen. Empfangen des DelegationLicense-Vektors in OnCreateDelegatedLicensesSuccess-Fehlern in Rückrufen werden in OnCreateDelegatedLicensesFailure gesendet

GetTenantInformation-Funktion

Lädt das Zertifikat des Benutzer-Lizenzgebers und gibt Informationen zum Mandanten zurück.

Parameter:

  • einstellungen: Die allgemeinen Einstellungen

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

Gibt zurück: TenantInformation

GetTenantInformationAsync-Funktion

Lädt das Zertifikat des Benutzer-Lizenzgebers und gibt Informationen zum Mandanten zurück.

Parameter:

  • einstellungen: Die allgemeinen Einstellungen

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

Rückgabe: Asynchrones Steuerungsobjekt.

  • ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess wird für success ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure aufgerufen.

GetLicenseRightsData-Funktion

Abrufen von Lizenzrechtsdaten.

Parameter:

  • serializedPublishingLicense: Lizenz zur seriellen Veröffentlichung von geschützten Inhalten

  • context: Client-Kontext, der undurchsichtig an optionales HttpDelegate weitergeleitet wird

  • einstellungen: Die allgemeinen Einstellungen

Gibt zurück: Die Lizenzrechtedaten

GetLicenseRightsDataAsync-Funktion

Abrufen von Lizenzrechtsdaten.

Parameter:

  • serializedPublishingLicense: Lizenz zur seriellen Veröffentlichung von geschützten Inhalten

  • observer: Eine Klasse, die die ProtectionHandler::Observer-Schnittstelle implementiert

  • context: Client-Kontext, der undurchsichtig an Beobachter und optionales HttpDelegate weitergeleitet wird

  • einstellungen: Die allgemeinen Einstellungen

Rückgabe: Asynchrones Steuerungsobjekt.