DirectoryObject Class Reference

The directory object information which includes- type, email, objectId and PUID. More...

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

Public Types
enum class	DirectoryObjectType {   UNKNOWN = 0 ,   INTERNAL = 1 ,   USER = 2 ,   GROUP = 3 }
	Describes the type of directory object. More...

Public Member Functions
	DirectoryObject (const DirectoryObjectType type, const std::string &email, const std::string &objectId, const std::string &puid)
	DirectoryObject constructor.
DirectoryObjectType	GetDirectoryObjectType () const
	Gets type of directory object.
const std::string &	GetEmail () const
	Gets email address of directory object.
const std::string &	GetObjectId () const
	Gets object ID of directory object.
const std::string &	GetPuid () const
	Gets GUID of directory object.

Detailed Description

The directory object information which includes- type, email, objectId and PUID.

Definition at line 48 of file license_rights_data.h.

Member Enumeration Documentation

DirectoryObjectType

enum class DirectoryObject::DirectoryObjectType

strong

Describes the type of directory object.

Enumerator
UNKNOWN
INTERNAL	Internal user - ANYONE.
USER	individual user
GROUP	group object

Definition at line 53 of file license_rights_data.h.

                                 {
    UNKNOWN = 0,
    INTERNAL = 1,  /**< Internal user - ANYONE */
    USER = 2, /**< individual user */
    GROUP = 3 /**< group object */
  };

Constructor & Destructor Documentation

DirectoryObject()

DirectoryObject::DirectoryObject ( const DirectoryObjectType type, const std::string & email, const std::string & objectId, const std::string & puid )

inline

DirectoryObject constructor.

Parameters

type	The type of directory object
email	The email of directory object
objectId	The object ID of directory object
puid	The PUID of directory object

Definition at line 68 of file license_rights_data.h.

      : mType(type), mEmail(email), mObjectId(objectId), mPuid(puid){};

Member Function Documentation

GetDirectoryObjectType()

DirectoryObjectType DirectoryObject::GetDirectoryObjectType ( ) const

inline

Gets type of directory object.

Returns

Type of directory object

Definition at line 77 of file license_rights_data.h.

{ return mType; };

GetEmail()

const std::string & DirectoryObject::GetEmail ( ) const

inline

Gets email address of directory object.

Returns

Email address of directory object

Definition at line 84 of file license_rights_data.h.

{ return mEmail; };

GetObjectId()

const std::string & DirectoryObject::GetObjectId ( ) const

inline

Gets object ID of directory object.

Returns

object ID of directory object

Definition at line 91 of file license_rights_data.h.

{ return mObjectId; };

GetPuid()

const std::string & DirectoryObject::GetPuid ( ) const

inline

Gets GUID of directory object.

Returns

GUID of directory object

Definition at line 98 of file license_rights_data.h.

{ return mPuid; };

---

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

• src/api/mip/protection/license_rights_data.h