Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
DelegationLicenseSettings Class Referenceabstract

#include <src/api/mip/protection/delegation_license_settings.h>

+ Inheritance diagram for DelegationLicenseSettings:
+ Collaboration diagram for DelegationLicenseSettings:

Public Member Functions

std::string GetApplicationScenarioId () const
 Gets the scenario Id provided by the application which is used to correlation with the server.
 
virtual bool GetAquireEndUserLicenses () const =0
 Gets the boolean value that indicates whether or not to obtain end user license in addition to the delegate license.
 
const std::vector< std::pair< std::string, std::string > > & GetCustomSettings () const
 Get the custom settings, used for feature gating and testing.
 
bool GetIsOfflineOnly () const
 Gets whether or not ProtectionEngine operation allows for online HTTP operations.
 
virtual std::shared_ptr< const PublishingLicenseInfoGetLicenseInfo () const =0
 Gets the PublishingLicenseInfo, the publishing license.
 
virtual const std::vector< std::string > & GetUsers () const =0
 Gets the list of users for the request.
 
void SetApplicationScenarioId (std::string applicationScenarioId)
 Sets the scenario Id provided by the application.
 
void SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings)
 Set the custom settings, used for feature gating and testing.
 
virtual void SetIsOfflineOnly (bool isOfflineOnly)
 Sets whether or not ProtectionEngine operation allows for online HTTP operations.
 

Static Public Member Functions

static MIP_API std::shared_ptr< DelegationLicenseSettings > __CDECL CreateDelegationLicenseSettings (const PublishingLicenseInfo &licenseInfo, const std::vector< std::string > &users, bool acquireEndUserLicenses)
 Creates a DelegationLicenseSettings object.
 
static MIP_API std::shared_ptr< DelegationLicenseSettings > __CDECL CreateDelegationLicenseSettings (const std::shared_ptr< MipContext > &mipContext, const PublishingLicenseInfo &licenseInfo, const std::vector< std::string > &users, bool acquireEndUserLicenses)
 Creates a DelegationLicenseSettings object.
 

Detailed Description

Definition at line 47 of file delegation_license_settings.h.

Member Function Documentation

◆ CreateDelegationLicenseSettings() [1/2]

static MIP_API std::shared_ptr< DelegationLicenseSettings > __CDECL DelegationLicenseSettings::CreateDelegationLicenseSettings ( const PublishingLicenseInfo & licenseInfo,
const std::vector< std::string > & users,
bool acquireEndUserLicenses )
static

Creates a DelegationLicenseSettings object.

Parameters
licenseInfoThe publishing license to request licenses for
usersA list of user email addresses to create licenses for
acquireEndUserLicensesWhether to include end user licenses (license bound to the users) or to only include a delegated license (bound to the identity on the engine)
Returns
A DelegationLicenseSettings object

◆ CreateDelegationLicenseSettings() [2/2]

static MIP_API std::shared_ptr< DelegationLicenseSettings > __CDECL DelegationLicenseSettings::CreateDelegationLicenseSettings ( const std::shared_ptr< MipContext > & mipContext,
const PublishingLicenseInfo & licenseInfo,
const std::vector< std::string > & users,
bool acquireEndUserLicenses )
static

Creates a DelegationLicenseSettings object.

Parameters
licenseInfoThe publishing license to request licenses for
usersA list of user email addresses to create licenses for
acquireEndUserLicensesWhether to include end user licenses (license bound to the users) or to only include a delegated license (bound to the identity on the engine)
Returns
A DelegationLicenseSettings object

◆ GetApplicationScenarioId()

std::string ProtectionCommonSettings::GetApplicationScenarioId ( ) const
inlineinherited

Gets the scenario Id provided by the application which is used to correlation with the server.

Returns
Application scenario Id

Definition at line 57 of file protection_common_settings.h.

57 {
58 return mApplicationScenarioId;
59 }

◆ GetAquireEndUserLicenses()

virtual bool DelegationLicenseSettings::GetAquireEndUserLicenses ( ) const
pure virtual

Gets the boolean value that indicates whether or not to obtain end user license in addition to the delegate license.

Returns
Whether to aquire end user licenses

◆ GetCustomSettings()

const std::vector< std::pair< std::string, std::string > > & ProtectionCommonSettings::GetCustomSettings ( ) const
inlineinherited

Get the custom settings, used for feature gating and testing.

Returns
List of name/value pairs.

Definition at line 108 of file protection_common_settings.h.

108 {
109 return mCustomSettings;
110 }

◆ GetIsOfflineOnly()

bool ProtectionCommonSettings::GetIsOfflineOnly ( ) const
inlineinherited

Gets whether or not ProtectionEngine operation allows for online HTTP operations.

Returns
True if HTTP operations are disallowed, else false
Note
If this returns true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

Definition at line 79 of file protection_common_settings.h.

79{ return mIsOfflineOnly; }

◆ GetLicenseInfo()

virtual std::shared_ptr< const PublishingLicenseInfo > DelegationLicenseSettings::GetLicenseInfo ( ) const
pure virtual

Gets the PublishingLicenseInfo, the publishing license.

Returns
The PublishingLicenseInfo

◆ GetUsers()

virtual const std::vector< std::string > & DelegationLicenseSettings::GetUsers ( ) const
pure virtual

Gets the list of users for the request.

Returns
The users

◆ SetApplicationScenarioId()

void ProtectionCommonSettings::SetApplicationScenarioId ( std::string applicationScenarioId)
inlineinherited

Sets the scenario Id provided by the application.

Parameters
Theapplication scenario Id

Definition at line 66 of file protection_common_settings.h.

66{ mApplicationScenarioId = applicationScenarioId; }

◆ SetCustomSettings()

void ProtectionCommonSettings::SetCustomSettings ( const std::vector< std::pair< std::string, std::string > > & customSettings)
inlineinherited

Set the custom settings, used for feature gating and testing.

Parameters
customSettingsList of name/value pairs.

Definition at line 99 of file protection_common_settings.h.

99 {
100 mCustomSettings = customSettings;
101 }

◆ SetIsOfflineOnly()

virtual void ProtectionCommonSettings::SetIsOfflineOnly ( bool isOfflineOnly)
inlinevirtualinherited

Sets whether or not ProtectionEngine operation allows for online HTTP operations.

Parameters
isOfflineOnlyTrue if HTTP operations are disallowed, else false
Note
If this is set to true, operation will only succeed if necessary content has already been cached. A mip::NetworkError will be thrown if needed info is not found. Consumption - content has already been previously decrypted and its unexpired license is cached. Protection - unexpired templates have been cached and user cert is loaded Others - undefined

Definition at line 92 of file protection_common_settings.h.

92{ mIsOfflineOnly = isOfflineOnly; }

The documentation for this class was generated from the following file: