ProtectionEngine クラス

  • [アーティクル]

特定の ID に関連する保護関連のアクションを管理します。

まとめ

メンバー 説明
public const 設定& Get設定() const エンジンの設定を取得します。
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設定>& template設定) ユーザーが使用できるテンプレートのコレクションを取得します。
public std::shared_ptr<AsyncControl> GetTemplatesAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) ユーザーが使用できるテンプレートのコレクションを取得します。
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context, const std::shared_ptr<const GetTemplates設定& template設定>) ユーザーが使用できるテンプレートのコレクションを取得します。
public std::vector<std::shared_ptr<TemplateDescriptor>> GetTemplates(const std::shared_ptr<void>& context) ユーザーが使用できるテンプレートのコレクションを取得します。
public bool IsFeatureSupported(FeatureId featureId) 機能がサポートされているかどうかをチェックします。
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設定> settings) ラベル 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設定& settings) labelId に対してユーザーが使用できる権限のコレクションを取得します。
public std::shared_ptr AsyncControl> CreateProtectionHandlerForPublishingAsync(const ProtectionHandler::P ublishing設定& settings, const std::shared_ptr<ProtectionHandler::Observer& observer>, const std::shared_ptr<void>& context)< 特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForPublishing(const ProtectionHandler::P ublishing設定& settings, const std::shared_ptr<void>& context) 特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。
public std::shared_ptr AsyncControl> CreateProtectionHandlerForConsumptionAsync(const ProtectionHandler::Consumption設定& settings, const std::shared_ptr<ProtectionHandler::Observer>& observer, const std::shared_ptr<void>& context)< 特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。
public std::shared_ptr<ProtectionHandler> CreateProtectionHandlerForConsumption(const ProtectionHandler::Consumption設定& settings, const std::shared_ptr<void>& context) 特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。
public bool LoadUserCert(const std::shared_ptr<void>& context, const ProtectionCommon設定& settings) ユーザーのライセンサー証明書を事前に読み込みます。バックグラウンドの読み込みに役立ちます。それ以外の場合は、プレライセンスは追加のネットワーク呼び出しを発生させることがあります。
public std::shared_ptr<AsyncControl> LoadUserCertAsync(const std::shared_ptr<ProtectionEngine::Observer& observer>, const std::shared_ptr<void>& context, const ProtectionCommon設定& settings) ユーザーのライセンサー証明書を事前に読み込みます。バックグラウンドの読み込みに役立ちます。それ以外の場合は、プレライセンスは追加のネットワーク呼び出しを発生させることがあります。
public void RegisterContentForTrackingAndRevocation(const std::vector<uint8_t>& serializedPublishingLicense, const std::string& contentName, bool isOwnerNotificationEnabled, const std::shared_ptr<void>& context, const ProtectionCommon設定& settings) ドキュメント追跡と失効のための公開ライセンス (PL) を登録します。
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設定& settings) ドキュメント追跡と失効のための公開ライセンス (PL) を登録します。
public void RevokeContent(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon設定& settings) コンテンツの取り消しを行います。
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設定& settings) コンテンツの取り消しを行います。
public std::vector<std::shared_ptr<DelegationLicense>> CreateDelegationLicenses(const DelegationLicense設定& settings, const std::shared_ptr<void>& context) 委任されたライセンスを作成します。
public std::shared_ptr AsyncControl> CreateDelegationLicensesAsync(const DelegationLicense設定& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context)< 委任されたライセンスを作成します。
public std::shared_ptr<TenantInformation> GetTenantInformation(const ProtectionCommon設定& settings, const std::shared_ptr<void>& context) ユーザー ライセンサー証明書を読み込み、テナントに関する情報を返します。
public std::shared_ptr<AsyncControl> GetTenantInformationAsync(const ProtectionCommon設定& settings, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) ユーザー ライセンサー証明書を読み込み、テナントに関する情報を返します。
public std::shared_ptr<LicenseRightsData> GetLicenseRightsData(const std::vector<uint8_t>& serializedPublishingLicense, const std::shared_ptr<void>& context, const ProtectionCommon設定& settings) ライセンス権限データを取得します。
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設定& settings) ライセンス権限データを取得します。

メンバー

GetSettings 関数

エンジンの設定を取得します。

戻り値: エンジンの設定

GetTemplatesAsync 関数

ユーザーが使用できるテンプレートのコレクションを取得します。

パラメーター:

  • observer: ProtectionEngine::Observer インターフェイスを実装するクラス

  • context: オブザーバーとオプションの HttpDelegate に不透明に戻されるクライアント コンテキスト

  • templateSettings:テンプレートを取得する際に使用する設定

戻り値: 非同期制御オブジェクト。

GetTemplatesAsync 関数

ユーザーが使用できるテンプレートのコレクションを取得します。

パラメーター:

  • observer: ProtectionEngine::Observer インターフェイスを実装するクラス

  • context: オブザーバーとオプションの HttpDelegate に不透明に戻されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

GetTemplates 関数

ユーザーが使用できるテンプレートのコレクションを取得します。

パラメーター:

  • context: オプションの HttpDelegate に不透明に渡されるクライアント コンテキスト

  • templateSettings:テンプレートを取得する際に使用する設定

戻り値: テンプレート ID の一覧

GetTemplates 関数

ユーザーが使用できるテンプレートのコレクションを取得します。

パラメーター:

  • context: オプションの HttpDelegate に不透明に渡されるクライアント コンテキスト

戻り値: テンプレート ID の一覧

IsFeatureSupported 関数

機能がサポートされているかどうかをチェックします。

パラメーター:

  • featureId: チェックする機能の ID です

戻り値: ブール値の結果

GetRightsForLabelIdAsync 関数

ラベル ID に対してユーザーが使用できる権限のコレクションを取得します。

パラメーター:

  • documentId: ドキュメント メタデータに関連付けられているドキュメント ID

  • labelId: ドキュメントの作成時に使用されたドキュメント メタデータに関連付けられているラベル ID

  • ownerEmail: ドキュメントの所有者

  • A: 認証ユーザー/アプリケーションが別のユーザーに代わって操作している場合、委任されたユーザーを指定します。指定されない場合は空になります

  • observer: ProtectionEngine::Observer インターフェイスを実装するクラス

  • context: これと同じコンテキストが ProtectionEngine::Observer::OnGetRightsForLabelIdSuccess または ProtectionEngine::Observer::OnGetRightsForLabelIdFailure に転送されます

戻り値: 非同期制御オブジェクト。

GetRightsForLabelId 関数

labelId に対してユーザーが使用できる権限のコレクションを取得します。

パラメーター:

  • documentId: ドキュメント メタデータに関連付けられているドキュメント ID

  • labelId: ドキュメントの作成時に使用されたドキュメント メタデータに関連付けられているラベル ID

  • ownerEmail: ドキュメントの所有者

  • A: 認証ユーザー/アプリケーションが別のユーザーに代わって操作している場合、委任されたユーザーを指定します。指定されない場合は空になります

  • context: この同じコンテキストは、省略可能な HttpDelegate に転送されます

戻り値: 権限の一覧

CreateProtectionHandlerForPublishingAsync 関数

特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。

パラメーター:

  • settings: 保護設定

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。 設定がオフラインのみの場合、エンジンは以前に GetTemplatesAsync と LoadUserCertAsync を呼び出す必要があります

CreateProtectionHandlerForPublishing 関数

特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。

パラメーター:

  • settings: 保護設定

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: ProtectionHandler 設定がオフラインの場合、エンジンは以前に GetTemplates と LoadUserCert と呼ばれる必要があります

CreateProtectionHandlerForConsumptionAsync 関数

特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。

パラメーター:

  • settings: 保護設定

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

CreateProtectionHandlerForConsumption 関数

特定のユーザーに権限/ロールが割り当てられる保護ハンドラーを作成します。

パラメーター:

  • settings: 保護設定

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: ProtectionHandler

LoadUserCert 関数

ユーザーのライセンサー証明書を事前に読み込みます。バックグラウンドの読み込みに役立ちます。それ以外の場合は、プレライセンスは追加のネットワーク呼び出しを発生させることがあります。

パラメーター:

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 正常に読み込まれた場合は True、それ以外の場合は false。

LoadUserCertAsync 関数

ユーザーのライセンサー証明書を事前に読み込みます。バックグラウンドの読み込みに役立ちます。それ以外の場合は、プレライセンスは追加のネットワーク呼び出しを発生させることがあります。

パラメーター:

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

RegisterContentForTrackingAndRevocation 関数

ドキュメント追跡と失効のための公開ライセンス (PL) を登録します。

パラメーター:

  • contentName: serializedPublishingLicense に指定されたコンテンツに関連付けられた名前。 serializedPublishingLicense がコンテンツ名を指定している場合、その値が優先されます。

  • isOwnerNotificationEnabled: ドキュメントの暗号化が解除されるたびにメールで所有者に通知するには true に設定し、通知を送信しない場合は false に設定します。

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

RegisterContentForTrackingAndRevocationAsync 関数

ドキュメント追跡と失効のための公開ライセンス (PL) を登録します。

パラメーター:

  • serializedPublishingLicense: 保護されたコンテンツからのシリアル化された発行ライセンス

  • contentName: serializedPublishingLicense に指定されたコンテンツに関連付けられた名前。 serializedPublishingLicense がコンテンツ名を指定している場合、その値が優先されます

  • isOwnerNotificationEnabled: ドキュメントの暗号化が解除されるたびにメールで所有者に通知するには true に設定し、通知を送信しない場合は false に設定します。

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

RevokeContent 関数

コンテンツの取り消しを行います。

パラメーター:

  • serializedPublishingLicense: 保護されたコンテンツからのシリアル化された発行ライセンス

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

RevokeContentAsync 関数

コンテンツの取り消しを行います。

パラメーター:

  • serializedPublishingLicense: 保護されたコンテンツからのシリアル化された発行ライセンス

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

CreateDelegationLicenses 関数

委任されたライセンスを作成します。

パラメーター:

  • settings:委任の設定

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 委任ライセンスのベクター。ユーザー一覧に対してライセンスを作成するには、このメソッドを使用してください

CreateDelegationLicensesAsync 関数

委任されたライセンスを作成します。

パラメーター:

  • settings:委任の設定

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。 ユーザー一覧に対してライセンスを作成するには、このメソッドを使用してください。 コールバック OnCreateDelegatedLicensesSuccess で DelegationLicense ベクターを受け取ります。 失敗は OnCreateDelegatedLicensesFailure で送信されます

GetTenantInformation 関数

ユーザー ライセンサー証明書を読み込み、テナントに関する情報を返します。

パラメーター:

  • settings: 共通の設定

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: TenantInformation

GetTenantInformationAsync 関数

ユーザー ライセンサー証明書を読み込み、テナントに関する情報を返します。

パラメーター:

  • settings: 共通の設定

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

戻り値: 非同期制御オブジェクト。

  • ProtectionEngine::Observer::OnGetTenantInformationAsyncSuccess は、成功した ProtectionEngine::Observer::OnGetTenantInformationAsyncFailure が失敗時に呼び出されます

GetLicenseRightsData 関数

ライセンス権限データを取得します。

パラメーター:

  • serializedPublishingLicense: 保護されたコンテンツからのシリアル化された発行ライセンス

  • context: 省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

  • settings: 共通の設定

戻り値: ライセンス権限データ

GetLicenseRightsDataAsync 関数

ライセンス権限データを取得します。

パラメーター:

  • serializedPublishingLicense: 保護されたコンテンツからのシリアル化された発行ライセンス

  • observer: ProtectionHandler::Observer インターフェイスを実装するクラス

  • context: オブザーバーと省略可能な HttpDelegate に非透過的に転送されるクライアント コンテキスト

  • settings: 共通の設定

戻り値: 非同期制御オブジェクト。