FileEngine::Settings Class Reference

Represents the settings for a FileEngine instance. More...

#include <src/api/mip/file/file_engine.h>

Collaboration diagram for FileEngine::Settings:

Public Member Functions
const std::string &	GetClientData () const
const std::string &	GetEngineId () const
const Identity &	GetIdentity () const
const std::string &	GetLocale () const
bool	IsLoadSensitivityTypesEnabled () const
void	SetEngineId (const std::string &id)
void	SetIdentity (const Identity &identity)
	Settings (const Identity &identity, const std::shared_ptr< AuthDelegate > &authDelegate, const std::string &clientData, const std::string &locale="", bool loadSensitivityTypes=false)
	Settings (const std::string &engineId, const std::shared_ptr< AuthDelegate > &authDelegate, const std::string &clientData, const std::string &locale="", bool loadSensitivityTypes=false)

Private Attributes
std::shared_ptr< AuthDelegate >	mAuthDelegate
std::string	mClientData
std::string	mEngineId
Identity	mIdentity
bool	mIsLoadSensitivityTypesEnabled
std::string	mLocale

Detailed Description

Represents the settings for a FileEngine instance.

Definition at line 64 of file file_engine.h.

Constructor & Destructor Documentation

Settings() [1/2]

FileEngine::Settings::Settings ( const std::string & engineId, const std::shared_ptr< AuthDelegate > & authDelegate, const std::string & clientData, const std::string & locale = "", bool loadSensitivityTypes = false )

inline

Definition at line 67 of file file_engine.h.

        : mEngineId(engineId),
          mAuthDelegate(authDelegate),
          mClientData(clientData),
          mLocale(locale),
          mIsLoadSensitivityTypesEnabled(loadSensitivityTypes) {
      if (mLocale.empty()) {
        mLocale = "en-US";
      }
    }

References mLocale.

Settings() [2/2]

FileEngine::Settings::Settings ( const Identity & identity, const std::shared_ptr< AuthDelegate > & authDelegate, const std::string & clientData, const std::string & locale = "", bool loadSensitivityTypes = false )

inline

Definition at line 84 of file file_engine.h.

        : mIdentity(identity),
          mAuthDelegate(authDelegate),
          mClientData(clientData),
          mLocale(locale),
          mIsLoadSensitivityTypesEnabled(loadSensitivityTypes) {
      if (mLocale.empty()) {
        mLocale = "en-US";
      }
    }

References mLocale.

Member Function Documentation

GetClientData()

const std::string & FileEngine::Settings::GetClientData ( ) const

inline

Definition at line 105 of file file_engine.h.

{ return mClientData; }

References mClientData.

GetEngineId()

const std::string & FileEngine::Settings::GetEngineId ( ) const

inline

Definition at line 101 of file file_engine.h.

{ return mEngineId; }

References mEngineId.

GetIdentity()

const Identity & FileEngine::Settings::GetIdentity ( ) const

inline

Definition at line 103 of file file_engine.h.

{ return mIdentity; }

References mIdentity.

GetLocale()

const std::string & FileEngine::Settings::GetLocale ( ) const

inline

Definition at line 106 of file file_engine.h.

{ return mLocale; }

References mLocale.

IsLoadSensitivityTypesEnabled()

bool FileEngine::Settings::IsLoadSensitivityTypesEnabled ( ) const

inline

Definition at line 107 of file file_engine.h.

{ return mIsLoadSensitivityTypesEnabled; }

References mIsLoadSensitivityTypesEnabled.

SetEngineId()

void FileEngine::Settings::SetEngineId ( const std::string & id )

inline

Definition at line 102 of file file_engine.h.

{ mEngineId = id; }

References mEngineId.

SetIdentity()

void FileEngine::Settings::SetIdentity ( const Identity & identity )

inline

Definition at line 104 of file file_engine.h.

{ mIdentity = identity; }

References mIdentity.

Member Data Documentation

mAuthDelegate

std::shared_ptr<AuthDelegate> FileEngine::Settings::mAuthDelegate

private

Definition at line 114 of file file_engine.h.

mClientData

std::string FileEngine::Settings::mClientData

private

Definition at line 115 of file file_engine.h.

Referenced by GetClientData().

mEngineId

std::string FileEngine::Settings::mEngineId

private

Definition at line 112 of file file_engine.h.

Referenced by GetEngineId(), and SetEngineId().

mIdentity

Identity FileEngine::Settings::mIdentity

private

Definition at line 113 of file file_engine.h.

Referenced by GetIdentity(), and SetIdentity().

mIsLoadSensitivityTypesEnabled

bool FileEngine::Settings::mIsLoadSensitivityTypesEnabled

private

Definition at line 117 of file file_engine.h.

Referenced by IsLoadSensitivityTypesEnabled().

mLocale

std::string FileEngine::Settings::mLocale

private

Definition at line 116 of file file_engine.h.

Referenced by GetLocale(), Settings(), and Settings().

---

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

• src/api/mip/file/file_engine.h