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

Abstraction for identity. More...

#include <src/api/mip/common_types.h>

Public Member Functions

const std::string & GetEmail () const
 Get the email.
 
const std::string & GetName () const
 Get the user's friendly name.
 
 Identity ()
 Default Identity constructor used when a user email address is not known.
 
 Identity (const Identity &other)
 Identity copy constructor.
 
 Identity (const std::string &email)
 Identity constructor used when a user email address is known.
 
 Identity (const std::string &email, const std::string &name)
 Identity constructor used when a user email address and user name is known.
 

Detailed Description

Abstraction for identity.

Definition at line 270 of file common_types.h.

Constructor & Destructor Documentation

◆ Identity() [1/4]

Identity::Identity ( )
inline

Default Identity constructor used when a user email address is not known.

Definition at line 275 of file common_types.h.

275{ }

◆ Identity() [2/4]

Identity::Identity ( const Identity & other)
inline

Identity copy constructor.

Parameters
Identityused to create the copy.

Definition at line 281 of file common_types.h.

282 : mEmail(other.mEmail),
283 mName(other.mName) { }

◆ Identity() [3/4]

Identity::Identity ( const std::string & email)
inlineexplicit

Identity constructor used when a user email address is known.

Parameters
emailmust be valid email address.

Definition at line 290 of file common_types.h.

290: mEmail(email) { }

◆ Identity() [4/4]

Identity::Identity ( const std::string & email,
const std::string & name )
inlineexplicit

Identity constructor used when a user email address and user name is known.

Parameters
emailmust be valid email address.
nameuser name.

Definition at line 298 of file common_types.h.

298: mEmail(email), mName(name) { }

Member Function Documentation

◆ GetEmail()

const std::string & Identity::GetEmail ( ) const
inline

Get the email.

Returns
the email.

Definition at line 305 of file common_types.h.

305{ return mEmail; }

◆ GetName()

const std::string & Identity::GetName ( ) const
inline

Get the user's friendly name.

used for text marking.

Returns
the friendly name.

Definition at line 312 of file common_types.h.

312{ return mName; }

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