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

The rights related information of the publishing license. More...

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

Public Member Functions

bool DoesContentExpire ()
 Checks if content has an expiration time or not.
 
const std::chrono::time_point< std::chrono::system_clock > GetContentValidUntil () const
 Gets protection expiration time.
 
const std::vector< DirectoryObjectRights > & GetDirectoryObjectsRights () const
 Gets the set of directory objects and the rights associated with them.
 
ProtectionType GetProtectionType () const
 Gets type of protection, whether it originated from protection SDK template or not.
 
 LicenseRightsData (const ProtectionType type, const std::vector< DirectoryObjectRights > &directoryObjectsRights, const std::chrono::time_point< std::chrono::system_clock > &contentValidUntil)
 LicenseRightsData constructor.
 

Detailed Description

The rights related information of the publishing license.

Definition at line 143 of file license_rights_data.h.

Constructor & Destructor Documentation

◆ LicenseRightsData()

LicenseRightsData::LicenseRightsData ( const ProtectionType type,
const std::vector< DirectoryObjectRights > & directoryObjectsRights,
const std::chrono::time_point< std::chrono::system_clock > & contentValidUntil )
inline

LicenseRightsData constructor.

Parameters
typeThe type of protection, whether it originated from protection SDK template or not
directoryObjectsRightsThe set of directory objects and the rights associated with them
contentValidUtilProtection expiration time

Definition at line 152 of file license_rights_data.h.

155 : mType(type), mDirectoryObjectsRights(directoryObjectsRights), mContentValidUntil(contentValidUntil){};

Member Function Documentation

◆ DoesContentExpire()

bool LicenseRightsData::DoesContentExpire ( )
inline

Checks if content has an expiration time or not.

Returns
True if content can expire, else false

Definition at line 176 of file license_rights_data.h.

176{ return mContentValidUntil.time_since_epoch().count() != 0; };

◆ GetContentValidUntil()

const std::chrono::time_point< std::chrono::system_clock > LicenseRightsData::GetContentValidUntil ( ) const
inline

Gets protection expiration time.

Returns
Protection expiration time

Definition at line 183 of file license_rights_data.h.

183{ return mContentValidUntil; };

◆ GetDirectoryObjectsRights()

const std::vector< DirectoryObjectRights > & LicenseRightsData::GetDirectoryObjectsRights ( ) const
inline

Gets the set of directory objects and the rights associated with them.

Returns
The set of directory objects and the rights associated with them

Definition at line 169 of file license_rights_data.h.

169{ return mDirectoryObjectsRights; };

◆ GetProtectionType()

ProtectionType LicenseRightsData::GetProtectionType ( ) const
inline

Gets type of protection, whether it originated from protection SDK template or not.

Returns
Type of protection

Definition at line 162 of file license_rights_data.h.

162{ return mType; };

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