class ProtectionEngine

Hanterar skyddsrelaterade åtgärder relaterade till en specifik identitet.

Sammanfattning

Medlemmar	Beskrivningar
public const Inställningar& Get Inställningar() const	Hämtar motorinställningarna.
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 Inställningar>& template Inställningar)	Hämta en samling mallar som är tillgängliga för en användare.
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context)	Hämta en samling mallar som är tillgängliga för en användare.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>&context, const std::shared_ptr<const GetTemplates Inställningar>& template Inställningar)	Hämta en samling mallar som är tillgängliga för en användare.
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>&context)	Hämta en samling mallar som är tillgängliga för en användare.
public bool IsFeatureSupported(FeatureId featureId)	Kontrollera att funktionen stöds.
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 Inställningar&<settings)	Hämta en samling rättigheter som är tillgängliga för en användare för ett etikett-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, const ProtectionCommon Inställningar& settings)	Hämta en samling rättigheter som är tillgängliga för en användare för ett labelId.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishing Inställningar& settings, const std::shared_ptr<ProtectionHandler::Observer>&observer, const std::shared_ptr<void>&context)<	Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishing Inställningar& settings, const std::shared_ptr<void>&context)	Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.
public std::shared_ptr AsyncControl> CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption Inställningar& settings, const std::shared_ptr<ProtectionHandler::Observer>&observer, const std::shared_ptr<void>&context)<	Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::Consumption Inställningar& settings, const std::shared_ptr<void>&context)	Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.
public bool LoadUserCert(const std::shared_ptr<void>&context, const ProtectionCommon Inställningar& settings)	läs in användarlicensorcertifikatet i förebyggande syfte, vilket är användbart när bakgrundsinläsningen annars med förlicensieringen kan medföra ytterligare ett nätverksanrop.
public std::shared_ptr<AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer>&observer, const std::shared_ptr<void>&context, const ProtectionCommon Inställningar& settings)	läs in användarlicensorcertifikatet i förebyggande syfte, vilket är användbart när bakgrundsinläsningen annars med förlicensieringen kan medföra ytterligare ett nätverksanrop.
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>&context, const ProtectionCommon Inställningar& settings)	Registrera publiceringslicens (PL) för dokumentspårning och återkallande.
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 Inställningar&> settings)<	Registrera publiceringslicens (PL) för dokumentspårning och återkallande.
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>&context, const ProtectionCommon Inställningar& settings)	Utför återkallning för innehåll.
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 Inställningar& settings)	Utför återkallning för innehåll.
public std::vector<std::shared_ptr<DelegationLicense>> CreateDelegationLicenses(const DelegationLicense Inställningar& settings, const std::shared_ptr<void>&context)	Skapar en delegerad licens.
public std::shared_ptr<AsyncControl> CreateDelegationLicensesAsync(const DelegationLicense Inställningar& settings, const std::shared_ptr<ProtectionEngine::Observer>&observer, const std::shared_ptr<void>&context)	Skapar en delegerad licens.
public std::shared_ptr<TenantInformation> GetTenantInformation(const ProtectionCommon Inställningar& settings, const std::shared_ptr<void>&context)	Läser in användarlicensgivarens certifikat och returnerar information om klientorganisationen.
public std::shared_ptr<AsyncControl> GetTenantInformationAsync(const ProtectionCommon Inställningar& settings, const std::shared_ptr<ProtectionEngine::Observer>&observer, const std::shared_ptr<void>&context)	Läser in användarlicensgivarens certifikat och returnerar information om klientorganisationen.
public std::shared_ptr<LicenseRightsData> GetLicenseRightsData(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>&context, const ProtectionCommon Inställningar& settings)	Hämta licensbehörighetsdata.
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 Inställningar& settings)	Hämta licensbehörighetsdata.

Medlemmar

Get Inställningar-funktion

Hämtar motorinställningarna.

Returnerar: Motorinställningar

Funktionen GetTemplatesAsync

Hämta en samling mallar som är tillgängliga för en användare.

Parametrar:

• observer: En klass som implementerar Gränssnittet ProtectionEngine::Observer

• kontext: Klientkontext som ogenomskinligt skickas tillbaka till observatörer och valfri HttpDelegate

• template Inställningar: Inställningar att använda när du hämtar mallar

Returnerar: Async-kontrollobjekt.

Funktionen GetTemplatesAsync

Hämta en samling mallar som är tillgängliga för en användare.

Parametrar:

• observer: En klass som implementerar Gränssnittet ProtectionEngine::Observer

• kontext: Klientkontext som ogenomskinligt skickas tillbaka till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

Funktionen GetTemplates

Hämta en samling mallar som är tillgängliga för en användare.

Parametrar:

• kontext: Klientkontext som ogenomskinligt skickas till valfri HttpDelegate

• template Inställningar: Inställningar att använda när du hämtar mallar

Returnerar: Lista över mall-ID:t

Funktionen GetTemplates

Hämta en samling mallar som är tillgängliga för en användare.

Parametrar:

• kontext: Klientkontext som ogenomskinligt skickas till valfri HttpDelegate

Returnerar: Lista över mall-ID:t

Funktionen IsFeatureSupported

Kontrollera att funktionen stöds.

Parametrar:

• featureId: ID för funktionen för att kontrollera

Returnerar: Booleskt resultat

Funktionen GetRightsForLabelIdAsync

Hämta en samling rättigheter som är tillgängliga för en användare för ett etikett-ID.

Parametrar:

• documentId: Dokument-ID som är associerat med dokumentmetadata

• labelId: Etikett-ID som är associerat med dokumentmetadata som dokumentet skapades med

• ownerEmail: ägaren av dokumentet

• S: Delegerad användare anges när den autentiserande användaren/programmet agerar för en annan användares räkning, tom om ingen

• observer: En klass som implementerar Gränssnittet ProtectionEngine::Observer

• kontext: Samma kontext vidarebefordras till ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess eller ProtectionEngine::Observer::OnGetRightsForLabelIdFailure

Returnerar: Async-kontrollobjekt.

Funktionen GetRightsForLabelId

Hämta en samling rättigheter som är tillgängliga för en användare för ett labelId.

Parametrar:

• documentId: Dokument-ID som är associerat med dokumentmetadata

• labelId: Etikett-ID som är associerat med dokumentmetadata som dokumentet skapades med

• ownerEmail: Ägaren av dokumentet

• S: Delegerad användare anges när den autentiserande användaren/programmet agerar för en annan användares räkning, tom om ingen

• kontext: Samma kontext vidarebefordras till valfri HttpDelegate

Returnerar: Lista över rättigheter

Funktionen CreateProtectionHandlerForPublishingAsync

Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.

Parametrar:

• inställningar: Skyddsinställningar

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt. Om inställningarna endast är offline måste motorn tidigare ha kallat GetTemplatesAsync och LoadUserCertAsync

Funktionen CreateProtectionHandlerForPublishing

Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.

Parametrar:

• inställningar: Skyddsinställningar

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Returnerar: ProtectionHandler Om inställningarna endast är offline måste motorn tidigare ha kallat GetTemplates och LoadUserCert

Funktionen CreateProtectionHandlerForConsumptionAsync

Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.

Parametrar:

• inställningar: Skyddsinställningar

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

Funktionen CreateProtectionHandlerForConsumption

Skapar en skyddshanterare där rättigheter/roller tilldelas till specifika användare.

Parametrar:

• inställningar: Skyddsinställningar

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Returnerar: ProtectionHandler

LoadUserCert-funktion

läs in användarlicensorcertifikatet i förebyggande syfte, vilket är användbart när bakgrundsinläsningen annars med förlicensieringen kan medföra ytterligare ett nätverksanrop.

Parametrar:

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Returnerar: Sant om det har lästs in, annars falskt.

LoadUserCertAsync-funktion

läs in användarlicensorcertifikatet i förebyggande syfte, vilket är användbart när bakgrundsinläsningen annars med förlicensieringen kan medföra ytterligare ett nätverksanrop.

Parametrar:

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

Funktionen RegisterContentForTrackingAndRevocation

Registrera publiceringslicens (PL) för dokumentspårning och återkallande.

Parametrar:

• contentName: Namnet som associeras med det innehåll som anges av serializedPublishingLicense. Om serializedPublishingLicense anger ett innehållsnamn har det värdet företräde.

• isOwnerNotificationEnabled: Ställ in på true för att meddela ägaren via e-post när dokumentet dekrypteras eller falskt för att inte skicka meddelandet.

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Funktionen RegisterContentForTrackingAndRevocationAsync

Registrera publiceringslicens (PL) för dokumentspårning och återkallande.

Parametrar:

• serializedPublishingLicense: Serialiserad publiceringslicens från skyddat innehåll

• contentName: Namnet som associeras med det innehåll som anges av serializedPublishingLicense. Om serializedPublishingLicense anger ett innehållsnamn har det värdet företräde

• isOwnerNotificationEnabled: Ställ in på true för att meddela ägaren via e-post när dokumentet dekrypteras eller falskt för att inte skicka meddelandet.

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

Funktionen RevokeContent

Utför återkallning för innehåll.

Parametrar:

• serializedPublishingLicense: Serialiserad publiceringslicens från skyddat innehåll

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Funktionen RevokeContentAsync

Utför återkallning för innehåll.

Parametrar:

• serializedPublishingLicense: Serialiserad publiceringslicens från skyddat innehåll

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

Funktionen CreateDelegationLicenses

Skapar en delegerad licens.

Parametrar:

• inställningar: Delegeringsinställningarna

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: En vektor för delegeringslicenserNa Använd den här metoden för att skapa licenser för en lista över användare

Funktionen CreateDelegationLicensesAsync

Skapar en delegerad licens.

Parametrar:

• inställningar: Delegeringsinställningarna

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt. Använd den här metoden för att skapa licenser för en lista över användare. Ta emot DelegeringLicense-vektorn i motringning OnCreateDelegatedLicensesSuccess Failures skickas i OnCreateDelegatedLicensesFailure

Funktionen GetTenantInformation

Läser in användarlicensgivarens certifikat och returnerar information om klientorganisationen.

Parametrar:

• inställningar: De vanliga inställningarna

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

Returnerar: TenantInformation

Funktionen GetTenantInformationAsync

Läser in användarlicensgivarens certifikat och returnerar information om klientorganisationen.

Parametrar:

• inställningar: De vanliga inställningarna

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

Returnerar: Async-kontrollobjekt.

• ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess anropas för att lyckas ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure anropas vid fel

Funktionen GetLicenseRightsData

Hämta licensbehörighetsdata.

Parametrar:

• serializedPublishingLicense: Serialiserad publiceringslicens från skyddat innehåll

• kontext: Klientkontext som ogenomskinligt vidarebefordras till valfri HttpDelegate

• inställningar: De vanliga inställningarna

Returnerar: Licensbehörighetsdata

Funktionen GetLicenseRightsDataAsync

Hämta licensbehörighetsdata.

Parametrar:

• serializedPublishingLicense: Serialiserad publiceringslicens från skyddat innehåll

• observer: En klass som implementerar Gränssnittet ProtectionHandler::Observer

• kontext: Klientkontext som ogenomskinligt vidarebefordras till observatörer och valfri HttpDelegate

• inställningar: De vanliga inställningarna

Returnerar: Async-kontrollobjekt.