class ProtectionEngine

Zarządza akcjami dotyczącymi ochrony związanymi z określoną tożsamością.

Podsumowanie

Członkowie Opisy
public const Ustawienia& Get Ustawienia() const Pobiera ustawienia aparatu.
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 Ustawienia& template Ustawienia>) Pobierz kolekcję szablonów dostępnych dla użytkownika.
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Pobierz kolekcję szablonów dostępnych dla użytkownika.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context, const std::shared_ptr<const GetTemplates Ustawienia& template Ustawienia>) Pobierz kolekcję szablonów dostępnych dla użytkownika.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context) Pobierz kolekcję szablonów dostępnych dla użytkownika.
public bool IsFeatureSupported(FeatureId featureId) Sprawdź, czy funkcja jest obsługiwana.
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 Ustawienia&<settings) Pobierz kolekcję praw dostępnych dla użytkownika dla identyfikatora etykiety.
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 Ustawienia& settings) Pobierz kolekcję praw dostępnych dla użytkownika dla identyfikatora labelId.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishing Ustawienia& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishing Ustawienia& settings, const std::shared_ptr<void>& context) Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption Ustawienia& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::Consumption Ustawienia& settings, const std::shared_ptr<void>& context) Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.
public bool LoadUserCert(const std::shared_ptr<void>& context, const ProtectionCommon Ustawienia& settings) wstępne ładowanie certyfikatu licencjodawcy użytkownika, przydatne podczas ładowania w tle innego przy użyciu prelicencjonowania może spowodować dodatkowe wywołanie sieciowe.
public std::shared_ptr<AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context, const ProtectionCommon Ustawienia& settings) wstępne ładowanie certyfikatu licencjodawcy użytkownika, przydatne podczas ładowania w tle innego przy użyciu prelicencjonowania może spowodować dodatkowe wywołanie sieciowe.
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>& context, const ProtectionCommon Ustawienia& settings) Zarejestruj licencję publikowania (PL) na potrzeby śledzenia i odwoływania dokumentów.
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 Ustawienia&> settings)< Zarejestruj licencję publikowania (PL) na potrzeby śledzenia i odwoływania dokumentów.
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon Ustawienia& settings) Wykonaj odwołanie dla zawartości.
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 Ustawienia& settings) Wykonaj odwołanie dla zawartości.
public std::vector<std::shared_ptr<DelegationLicense>> CreateDelegationLicenses(const DelegationLicense Ustawienia& settings, const std::shared_ptr<void>& context) Tworzy licencję delegowana.
public std::shared_ptr AsyncControl> CreateDelegationLicensesAsync(const DelegationLicense Ustawienia& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context)< Tworzy licencję delegowana.
public std::shared_ptr<TenantInformation GetTenantInformation>(const ProtectionCommon Ustawienia& settings, const std::shared_ptr<void>& context) Ładuje certyfikat licencjodawcy użytkownika i zwraca informacje o dzierżawie.
public std::shared_ptr<AsyncControl> GetTenantInformationAsync(const ProtectionCommon Ustawienia& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Ładuje certyfikat licencjodawcy użytkownika i zwraca informacje o dzierżawie.
public std::shared_ptr<LicenseRightsData GetLicenseRightsData>(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon Ustawienia& settings) Pobieranie danych dotyczących praw licencji.
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 Ustawienia& settings) Pobieranie danych dotyczących praw licencji.

Członkowie

Get Ustawienia, funkcja

Pobiera ustawienia aparatu.

Zwraca: Ustawienia aparatu

GetTemplatesAsync, funkcja

Pobierz kolekcję szablonów dostępnych dla użytkownika.

Parametry:

  • observer: klasa implementowania interfejsu ProtectionEngine::Observer

  • context: Kontekst klienta, który zostanie nieprzezroczysty przekazany z powrotem do obserwatorów i opcjonalny httpDelegate

  • template Ustawienia: Ustawienia użyć podczas uzyskiwania szablonów

Zwraca: obiekt kontrolki asynchronicznego.

GetTemplatesAsync, funkcja

Pobierz kolekcję szablonów dostępnych dla użytkownika.

Parametry:

  • observer: klasa implementowania interfejsu ProtectionEngine::Observer

  • context: Kontekst klienta, który zostanie nieprzezroczysty przekazany z powrotem do obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

GetTemplates, funkcja

Pobierz kolekcję szablonów dostępnych dla użytkownika.

Parametry:

  • context: Kontekst klienta, który zostanie nieprzejrzysty przekazany do opcjonalnego elementu HttpDelegate

  • template Ustawienia: Ustawienia użyć podczas uzyskiwania szablonów

Zwraca: lista identyfikatorów szablonów

GetTemplates, funkcja

Pobierz kolekcję szablonów dostępnych dla użytkownika.

Parametry:

  • context: Kontekst klienta, który zostanie nieprzejrzysty przekazany do opcjonalnego elementu HttpDelegate

Zwraca: lista identyfikatorów szablonów

IsFeatureSupported, funkcja

Sprawdź, czy funkcja jest obsługiwana.

Parametry:

  • featureId: identyfikator funkcji do sprawdzenia

Zwraca: wynik logiczny

GetRightsForLabelIdAsync, funkcja

Pobierz kolekcję praw dostępnych dla użytkownika dla identyfikatora etykiety.

Parametry:

  • documentId: identyfikator dokumentu skojarzony z metadanymi dokumentu

  • labelId: identyfikator etykiety skojarzony z metadanymi dokumentu, z którymi został utworzony dokument

  • ownerEmail: właściciel dokumentu

  • Uwierzytelnianie: użytkownik delegowany jest określony, gdy uwierzytelniający użytkownik/aplikacja działa w imieniu innego użytkownika, pusty, jeśli nie

  • observer: klasa implementowania interfejsu ProtectionEngine::Observer

  • context: Ten sam kontekst zostanie przekazany do elementu ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess lub ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Zwraca: obiekt kontrolki asynchronicznego.

GetRightsForLabelId, funkcja

Pobierz kolekcję praw dostępnych dla użytkownika dla identyfikatora labelId.

Parametry:

  • documentId: identyfikator dokumentu skojarzony z metadanymi dokumentu

  • labelId: identyfikator etykiety skojarzony z metadanymi dokumentu, z którymi został utworzony dokument

  • ownerEmail: właściciel dokumentu

  • Uwierzytelnianie: użytkownik delegowany jest określony, gdy uwierzytelniający użytkownik/aplikacja działa w imieniu innego użytkownika, pusty, jeśli nie

  • context: ten sam kontekst zostanie przekazany do opcjonalnego elementu HttpDelegate

Zwraca: Lista praw

CreateProtectionHandlerForPublishingAsync, funkcja

Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.

Parametry:

  • ustawienia: Ustawienia ochrony

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego. Jeśli ustawienia są tylko w trybie offline, aparat musi mieć wcześniej nazwę GetTemplatesAsync i LoadUserCertAsync

CreateProtectionHandlerForPublishing, funkcja

Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.

Parametry:

  • ustawienia: Ustawienia ochrony

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

Zwraca: Program ProtectionHandler jeśli ustawienia są tylko w trybie offline, aparat musi mieć wcześniej nazwę GetTemplates i LoadUserCert

CreateProtectionHandlerForConsumptionAsync, funkcja

Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.

Parametry:

  • ustawienia: Ustawienia ochrony

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

CreateProtectionHandlerForConsumption, funkcja

Tworzy procedurę obsługi ochrony, w której prawa/role są przypisywane do określonych użytkowników.

Parametry:

  • ustawienia: Ustawienia ochrony

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

Zwraca: ProtectionHandler

LoadUserCert, funkcja

wstępne ładowanie certyfikatu licencjodawcy użytkownika, przydatne podczas ładowania w tle innego przy użyciu prelicencjonowania może spowodować dodatkowe wywołanie sieciowe.

Parametry:

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

Zwraca wartość: prawda, jeśli pomyślnie załadowano wartość false.

LoadUserCertAsync, funkcja

wstępne ładowanie certyfikatu licencjodawcy użytkownika, przydatne podczas ładowania w tle innego przy użyciu prelicencjonowania może spowodować dodatkowe wywołanie sieciowe.

Parametry:

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

RegisterContentForTrackingAndRevocation, funkcja

Zarejestruj licencję publikowania (PL) na potrzeby śledzenia i odwoływania dokumentów.

Parametry:

  • contentName: nazwa skojarzona z zawartością określoną przez serializedPublishingLicense. Jeśli serializedPublishingLicense określa nazwę zawartości, ta wartość będzie mieć pierwszeństwo.

  • isOwnerNotificationEnabled: ustaw wartość true, aby powiadomić właściciela za pośrednictwem poczty e-mail za każdym razem, gdy dokument zostanie odszyfrowany, lub wartość false, aby nie wysłać powiadomienia.

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

RegisterContentForTrackingAndRevocationAsync, funkcja

Zarejestruj licencję publikowania (PL) na potrzeby śledzenia i odwoływania dokumentów.

Parametry:

  • serializedPublishingLicense: serializowana licencja publikowania z chronionej zawartości

  • contentName: nazwa skojarzona z zawartością określoną przez serializedPublishingLicense. Jeśli serializedPublishingLicense określa nazwę zawartości, ta wartość będzie mieć pierwszeństwo

  • isOwnerNotificationEnabled: ustaw wartość true, aby powiadomić właściciela za pośrednictwem poczty e-mail za każdym razem, gdy dokument zostanie odszyfrowany, lub wartość false, aby nie wysłać powiadomienia.

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

RevokeContent, funkcja

Wykonaj odwołanie dla zawartości.

Parametry:

  • serializedPublishingLicense: serializowana licencja publikowania z chronionej zawartości

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

RevokeContentAsync, funkcja

Wykonaj odwołanie dla zawartości.

Parametry:

  • serializedPublishingLicense: serializowana licencja publikowania z chronionej zawartości

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

CreateDelegationLicenses, funkcja

Tworzy licencję delegowana.

Parametry:

  • settings: Ustawienia delegowania

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: wektor licencji delegowania Użyj tej metody, aby utworzyć licencje dla listy użytkowników

CreateDelegationLicensesAsync, funkcja

Tworzy licencję delegowana.

Parametry:

  • settings: Ustawienia delegowania

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego. Użyj tej metody, aby utworzyć licencje dla listy użytkowników. Odbieranie wektora DelegowanieLicense w wywołaniu zwrotnym OnCreateDelegatedLicensesSuccess failures są wysyłane w elemencie OnCreateDelegatedLicensesFailure

GetTenantInformation, funkcja

Ładuje certyfikat licencjodawcy użytkownika i zwraca informacje o dzierżawie.

Parametry:

  • ustawienia: typowe ustawienia

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

Zwraca: TenantInformation

GetTenantInformationAsync, funkcja

Ładuje certyfikat licencjodawcy użytkownika i zwraca informacje o dzierżawie.

Parametry:

  • ustawienia: typowe ustawienia

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

Zwraca: obiekt kontrolki asynchronicznego.

  • ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess zostanie wywołana w przypadku powodzenia ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure zostanie wywołana w przypadku niepowodzenia

GetLicenseRightsData, funkcja

Pobieranie danych dotyczących praw licencji.

Parametry:

  • serializedPublishingLicense: serializowana licencja publikowania z chronionej zawartości

  • context: Kontekst klienta, który będzie nieprzejrzysty dla opcjonalnego elementu HttpDelegate

  • ustawienia: typowe ustawienia

Zwraca: dane praw licencji

GetLicenseRightsDataAsync, funkcja

Pobieranie danych dotyczących praw licencji.

Parametry:

  • serializedPublishingLicense: serializowana licencja publikowania z chronionej zawartości

  • observer: klasa implementowania interfejsu ProtectionHandler::Observer

  • context: kontekst klienta, który będzie nieprzejrzysty dla obserwatorów i opcjonalny httpDelegate

  • ustawienia: typowe ustawienia

Zwraca: obiekt kontrolki asynchronicznego.