Specifies users and rights assigned for a file. This is information used for custom protection. More...

#include <PolicyDescriptor.h>

Public Member Functions
	PolicyDescriptor (const std::vector< UserRights > &userRightsList)
	Constructor for PolicyDescriptor which initializes the object with a list of user rights. More...

	PolicyDescriptor (const std::vector< UserRoles > &userRolesList)
	Constructor for PolicyDescriptor which initializes the object with a list of user roles. More...

const std::string &	Name ()
	Gets the name of the PolicyDescriptor.

void	Name (const std::string &value)
	Sets the name of the PolicyDescriptor. More...

const std::string &	Description ()
	Gets the description of the PolicyDescriptor.

void	Description (const std::string &value)
	Sets the description of the PolicyDescriptor. More...

const std::vector< UserRights > &	UserRightsList () const
	Gets the user's rights list. More...

const std::vector< UserRoles > &	UserRolesList ()
	Gets the user's roles list.

const std::chrono::time_point< std::chrono::system_clock > &	ContentValidUntil ()
	Gets the date that the content is valid until.

void	ContentValidUntil (const std::chrono::time_point< std::chrono::system_clock > &value)
	Sets the date that the content is valid until. More...

bool	AllowOfflineAccess ()
	Gets the setting of the offline access allowance control; True or False.

void	AllowOfflineAccess (bool value)
	Sets the True or False setting of the offline access allowance control. More...

std::shared_ptr< std::string >	Referrer () const
	Gets the referral URI of the PolicyDescriptor.

void	Referrer (std::shared_ptr< std::string >uri)
	Sets the referral URI of the PolicyDescriptor. More...

const AppDataHashMap &	EncryptedAppData ()
	Gets the encrypted app data.

void	EncryptedAppData (const AppDataHashMap &value)
	Sets the encrypted app data. More...

const AppDataHashMap &	SignedAppData ()
	Gets the signed app data.

void	SignedAppData (const AppDataHashMap &value)
	Sets the signed app data. More...

	PolicyDescriptor (std::shared_ptr< core::ProtectionPolicy >policy)

Detailed Description

Specifies users and rights assigned for a file. This is information used for custom protection.

Constructor & Destructor Documentation

rmscore::modernapi::PolicyDescriptor::PolicyDescriptor ( const std::vector< UserRights > & userRightsList )

Constructor for PolicyDescriptor which initializes the object with a list of user rights.

Parameters

userRightsList A collection of user rights.

rmscore::modernapi::PolicyDescriptor::PolicyDescriptor ( const std::vector< UserRoles > & userRolesList )

Constructor for PolicyDescriptor which initializes the object with a list of user roles.

Parameters

userRolesList A collection of user roles.

Member Function Documentation

void rmscore::modernapi::PolicyDescriptor::AllowOfflineAccess ( bool value )

inline

Sets the True or False setting of the offline access allowance control.

Parameters

value True, offline access is allowed or False, it is not.

void rmscore::modernapi::PolicyDescriptor::ContentValidUntil ( const std::chrono::time_point< std::chrono::system_clock > & value )

inline

Sets the date that the content is valid until.

Parameters

value Date the content is valid until.

void rmscore::modernapi::PolicyDescriptor::Description ( const std::string & value )

inline

Sets the description of the PolicyDescriptor.

Parameters

value PolicyDescriptor description to set.

void rmscore::modernapi::PolicyDescriptor::EncryptedAppData ( const AppDataHashMap & value )

inline

Sets the encrypted app data.

Parameters

value The encrypted app data to set.

void rmscore::modernapi::PolicyDescriptor::Name ( const std::string & value )

inline

Sets the name of the PolicyDescriptor.

Parameters

value PolicyDescriptor name to set.

void rmscore::modernapi::PolicyDescriptor::Referrer ( std::shared_ptr< std::string > uri )

inline

Sets the referral URI of the PolicyDescriptor.

Parameters

uri	The referral URI to set.

void rmscore::modernapi::PolicyDescriptor::SignedAppData ( const AppDataHashMap & value )

inline

Sets the signed app data.

Parameters

value The encrypted app data to set.

const std::vector<UserRights>& rmscore::modernapi::PolicyDescriptor::UserRightsList ( ) const

inline

Gets the user's rights list.

The value of the UserRightsList property will be null if the current user doesn't have access to the user rights information (i.e., is not the owner and does not have the VIEWRIGHTSDATA right).

Returns: List of users and their rights for this file.

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

sdk/rms_sdk/ModernAPI/PolicyDescriptor.h
sdk/rms_sdk/ModernAPI/PolicyDescriptor.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation