Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
|
Settings used by FileProfile during its creation and throughout its lifetime. More...
#include <src/api/mip/file/file_profile.h>
Public Member Functions | |
bool | CanCacheLicenses () const |
Gets whether or not end user licenses (EULs) are cached locally. | |
CacheStorageType | GetCacheStorageType () const |
Get whether caches are stored in memory or on disk. | |
std::shared_ptr< ConsentDelegate > | GetConsentDelegate () const |
Gets the consent delegate used to request user consent connecting to services. | |
DnsRedirection | GetDnsRedirection () const |
Gets the dns redirect mode. | |
std::shared_ptr< HttpDelegate > | GetHttpDelegate () const |
Get the HTTP delegate (if any) provided by the application. | |
const std::shared_ptr< void > & | GetLoggerContext () const |
Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile. | |
std::shared_ptr< MipContext > | GetMipContext () const |
Get MIP context which represents shared state across all profiles. | |
std::shared_ptr< Observer > | GetObserver () const |
Gets the observer that receives notifications of events related to FileProfile. | |
const std::string & | GetSessionId () const |
Gets the session ID. | |
std::shared_ptr< TaskDispatcherDelegate > | GetTaskDispatcherDelegate () const |
Get the TaskDispatcher delegate (if any) provided by the application. | |
void | SetCanCacheLicenses (bool canCacheLicenses) |
Configures whether or not end user licenses (EULs) will be cached locally. | |
void | SetDnsRedirection (DnsRedirection dnsRedirection) |
Sets the dns redirection mode that controls how redirection is handled during online operations. | |
void | SetHttpDelegate (const std::shared_ptr< HttpDelegate > &httpDelegate) |
Override default HTTP stack with client's own. | |
void | SetLoggerContext (const std::shared_ptr< void > &loggerContext) |
Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile. | |
void | SetSessionId (const std::string &sessionId) |
Sets the session ID. | |
void | SetTaskDispatcherDelegate (const std::shared_ptr< TaskDispatcherDelegate > &taskDispatcherDelegate) |
Override default asynchonous task dispatching handling with client's own. | |
Settings (const std::shared_ptr< MipContext > &mipContext, CacheStorageType cacheStorageType, std::shared_ptr< ConsentDelegate > consentDelegate, std::shared_ptr< Observer > observer) | |
FileProfile::Settings constructor. | |
Settings used by FileProfile during its creation and throughout its lifetime.
Definition at line 153 of file file_profile.h.
|
inline |
FileProfile::Settings constructor.
mipContext | Global context settings |
cacheStorageType | Store any cached state in memory or on disk |
consentDelegate | Delegate used to obtain user permission to access external resources |
observer | Observer instance that will receive notifications of events related to FileProfile |
Definition at line 163 of file file_profile.h.
|
inline |
Gets whether or not end user licenses (EULs) are cached locally.
Definition at line 275 of file file_profile.h.
|
inline |
Get whether caches are stored in memory or on disk.
Definition at line 184 of file file_profile.h.
|
inline |
Gets the consent delegate used to request user consent connecting to services.
Definition at line 191 of file file_profile.h.
|
inline |
Gets the dns redirect mode.
Definition at line 302 of file file_profile.h.
|
inline |
Get the HTTP delegate (if any) provided by the application.
Definition at line 212 of file file_profile.h.
|
inline |
Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
Definition at line 285 of file file_profile.h.
|
inline |
Get MIP context which represents shared state across all profiles.
Definition at line 205 of file file_profile.h.
|
inline |
Gets the observer that receives notifications of events related to FileProfile.
Definition at line 198 of file file_profile.h.
|
inline |
Gets the session ID.
Definition at line 254 of file file_profile.h.
|
inline |
Get the TaskDispatcher delegate (if any) provided by the application.
Definition at line 226 of file file_profile.h.
|
inline |
Configures whether or not end user licenses (EULs) will be cached locally.
canCacheLicenses | Whether or not engine should cache a license when opening protected content |
Definition at line 266 of file file_profile.h.
|
inline |
Sets the dns redirection mode that controls how redirection is handled during online operations.
dnsRedirection | The redirection mode to use |
Definition at line 311 of file file_profile.h.
|
inline |
Override default HTTP stack with client's own.
httpDelegate | HTTP callback interface implemented by client application |
Definition at line 219 of file file_profile.h.
|
inline |
Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
loggerContext | The logger context |
Definition at line 293 of file file_profile.h.
|
inline |
Sets the session ID.
sessionId | Session ID that will be used to correlate logs/telemetry |
Definition at line 245 of file file_profile.h.
|
inline |
Override default asynchonous task dispatching handling with client's own.
taskDispatcherDelegate | Task dispatching callback interface implemented by client application |
Definition at line 236 of file file_profile.h.