class FileProfile::Settings
Settings used by FileProfile during its creation and throughout its lifetime.
Summary
Members | Descriptions |
---|---|
public Settings(const std::shared_ptr<MipContext>& mipContext, CacheStorageType cacheStorageType, std::shared_ptr<ConsentDelegate> consentDelegate, std::shared_ptr<Observer> observer) | FileProfile::Settings constructor. |
public CacheStorageType GetCacheStorageType() const | Get whether caches are stored in memory or on disk. |
public std::shared_ptr<ConsentDelegate> GetConsentDelegate() const | Gets the consent delegate used to request user consent connecting to services. |
public std::shared_ptr<Observer> GetObserver() const | Gets the observer that receives notifications of events related to FileProfile. |
public std::shared_ptr<MipContext> GetMipContext() const | Get MIP context which represents shared state across all profiles. |
public std::shared_ptr<HttpDelegate> GetHttpDelegate() const | Get the HTTP delegate (if any) provided by the application. |
public void SetHttpDelegate(const std::shared_ptr<HttpDelegate>& httpDelegate) | Override default HTTP stack with client's own. |
public std::shared_ptr<TaskDispatcherDelegate> GetTaskDispatcherDelegate() const | Get the TaskDispatcher delegate (if any) provided by the application. |
public void SetTaskDispatcherDelegate(const std::shared_ptr<TaskDispatcherDelegate>& taskDispatcherDelegate) | Override default asynchonous task dispatching handling with client's own. |
public void SetSessionId(const std::string& sessionId) | Sets the session ID. |
public const std::string& GetSessionId() const | Gets the session ID. |
public void SetCanCacheLicenses(bool canCacheLicenses) | Configures whether or not end user licenses (EULs) will be cached locally. |
public bool CanCacheLicenses() const | Gets whether or not end user licenses (EULs) are cached locally. |
public 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. |
public 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. |
public DnsRedirection GetDnsRedirection() const | Gets the dns redirect mode. |
public void SetDnsRedirection(DnsRedirection dnsRedirection) | Sets the dns redirection mode that controls how redirection is handled during online operations. |
Members
Settings function
FileProfile::Settings constructor.
Parameters:
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
GetCacheStorageType function
Get whether caches are stored in memory or on disk.
Returns: Storage type used
GetConsentDelegate function
Gets the consent delegate used to request user consent connecting to services.
Returns: Consent delegate used for requesting user consent
GetObserver function
Gets the observer that receives notifications of events related to FileProfile.
Returns: Observer that receives notifications of events related to FileProfile
GetMipContext function
Get MIP context which represents shared state across all profiles.
Returns: MIP context
GetHttpDelegate function
Get the HTTP delegate (if any) provided by the application.
Returns: HTTP delegate to be used for HTTP operations
SetHttpDelegate function
Override default HTTP stack with client's own.
Parameters:
- httpDelegate: HTTP callback interface implemented by client application
GetTaskDispatcherDelegate function
Get the TaskDispatcher delegate (if any) provided by the application.
Returns: TaskDispatcher delegate to be used for executing asynchronous tasks
SetTaskDispatcherDelegate function
Override default asynchonous task dispatching handling with client's own.
Parameters:
- taskDispatcherDelegate: Task dispatching callback interface implemented by client application
tasks can reference profile objects preventing its destruction as a result taskdispatcher queues should not be shared.
SetSessionId function
Sets the session ID.
Parameters:
- sessionId: Session ID that will be used to correlate logs/telemetry
GetSessionId function
Gets the session ID.
Returns: Session ID that will be used to correlate logs/telemetry
SetCanCacheLicenses function
Configures whether or not end user licenses (EULs) will be cached locally.
Parameters:
- canCacheLicenses: Whether or not engine should cache a license when opening protected content
If true, opening protected content will cache the associated license locally. If false, opening protected content will always perform HTTP operation to acquire the license from the RMS service.
CanCacheLicenses function
Gets whether or not end user licenses (EULs) are cached locally.
Returns: License caching configuration
GetLoggerContext function
Get logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
Returns: The logger context
SetLoggerContext function
Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created profile.
Parameters:
- loggerContext: The logger context
GetDnsRedirection function
Gets the dns redirect mode.
Returns: The redirect mode used
SetDnsRedirection function
Sets the dns redirection mode that controls how redirection is handled during online operations.
Parameters:
- dnsRedirection: The redirection mode to use