Skip to content

class_mip_protectiondescriptorbuilder.md

Latest commit

 

History

History
118 lines (74 loc) · 4.18 KB

class_mip_protectiondescriptorbuilder.md

File metadata and controls

118 lines (74 loc) · 4.18 KB
title class ProtectionDescriptorBuilder
description Documents the protectiondescriptorbuilder::undefined class of the Microsoft Information Protection (MIP) SDK.
author msmbaldwin
ms.service information-protection
ms.topic reference
ms.author mbaldwin
ms.date 11/07/2023

class ProtectionDescriptorBuilder

Constructs a ProtectionDescriptor that describes protection associated with a piece of content.

Summary

Members Descriptions
public MIP_API std::shared_ptr<ProtectionDescriptor> Build() Creates a ProtectionDescriptor whose access permissions are defined by this ProtectionDescriptorBuilder instance.
public void SetName(const std::string& value) Sets protection policy name.
public void SetDescription(const std::string& value) Sets protection policy description.
public void SetContentValidUntil(const std::chrono::time_point<std::chrono::system_clock>& value) Sets protection policy expiration time.
public void SetAllowOfflineAccess(bool value) Sets if protection policy allows offline content access or not.
public void SetReferrer(const std::string& uri) Sets protection policy referrer address.
public void SetEncryptedAppData(const std::map<std::string, std::string>& value) Sets app-specific data that should be encrypted.
public void SetSignedAppData(const std::map<std::string, std::string>& value) Sets app-specific data that should be signed.
public void SetDoubleKeyUrl(const std::string& doubleKeyUrl) Sets the double key url to be used for custom protection.
public void SetLabelInfo(const LabelInfo& labelId) Sets the label id and tenant id for UDP protection. Only allowed for custom protection type.
enum LicenseType License type to create a specialized license.

Members

Build function

Creates a ProtectionDescriptor whose access permissions are defined by this ProtectionDescriptorBuilder instance.

Returns: New ProtectionDescriptor instance

SetName function

Sets protection policy name.

Parameters:

  • value: Protection policy name

SetDescription function

Sets protection policy description.

Parameters:

  • value: Policy description

SetContentValidUntil function

Sets protection policy expiration time.

Parameters:

  • value: Policy expiration time

SetAllowOfflineAccess function

Sets if protection policy allows offline content access or not.

Parameters:

  • value: If policy allows offline content access or not

SetReferrer function

Sets protection policy referrer address.

Parameters:

  • uri: Policy referrer address

The referrer is a URI that can be displayed to the user upon failed protection policy acquisition that contains information on how that user can gain permission to access the content.

SetEncryptedAppData function

Sets app-specific data that should be encrypted.

Parameters:

  • value: App-specific data

An application can specify a dictionary of app-specific data that will be encrypted by the protection service. This encrypted data is independent of the signed data set by SetSignedAppData.

SetSignedAppData function

Sets app-specific data that should be signed.

Parameters:

  • value: App-specific data

An application can specify a dictionary of app-specific data that will be signed by the protection service. This signed data is independent of the encrypted data set by SetEncryptedAppData.

SetDoubleKeyUrl function

Sets the double key url to be used for custom protection.

Parameters:

  • doubleKeyUrl: Double key url

SetLabelInfo function

Sets the label id and tenant id for UDP protection. Only allowed for custom protection type.

Parameters:

  • LabelInfo: label info containing labelId and tenantId.

LicenseType enum

Values Descriptions
DoNotForward Defines a do not forward license type.
EncryptOnly Defines an encrypt only license type.

License type to create a specialized license.