Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
DelegationLicenseSettings Class Referenceabstract

#include <delegation_license_settings.h>

Inheritance diagram for DelegationLicenseSettings:
ProtectionCommonSettings

Public Member Functions

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.
 
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.
 
- Public Member Functions inherited from ProtectionCommonSettings
 ProtectionCommonSettings (std::string applicationScenarioId=std::string())
 
std::string GetApplicationScenarioId () const
 Gets the scenario Id provided by the application which is used to correlation with the server.
 
void SetApplicationScenarioId (std::string applicationScenarioId)
 Sets the scenario Id provided by the application.
 
bool GetIsOfflineOnly () const
 Gets whether or not ProtectionEngine operation allows for online HTTP operations.
 
virtual void SetIsOfflineOnly (bool isOfflineOnly)
 Sets whether or not ProtectionEngine operation allows for online HTTP operations.
 
void SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings)
 Set the custom settings, used for feature gating and testing.
 
const std::vector< std::pair< std::string, std::string > > & GetCustomSettings () const
 Get the custom settings, used for feature gating and testing.
 

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.
 

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

◆ 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

◆ 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

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