FileProfile class is the root class for using the Microsoft Information Protection operations.
More...
#include <src/api/mip/file/file_profile.h>
|
virtual void | AcquirePolicyAuthToken (Cloud cloud, const std::shared_ptr< AuthDelegate > &authDelegate) const =0 |
| Trigger an authentication callback for policy.
|
|
virtual std::shared_ptr< AsyncControl > | AddEngineAsync (const FileEngine::Settings &settings, const std::shared_ptr< void > &context)=0 |
| Starts adding a new file engine to the profile.
|
|
virtual std::shared_ptr< AsyncControl > | DeleteEngineAsync (const std::string &id, const std::shared_ptr< void > &context)=0 |
| Starts deleting the file engine with the given ID.
|
|
virtual const Settings & | GetSettings () const =0 |
| Returns the profile settings.
|
|
virtual std::shared_ptr< AsyncControl > | ListEnginesAsync (const std::shared_ptr< void > &context)=0 |
| Starts list engines operation.
|
|
virtual std::shared_ptr< AsyncControl > | UnloadEngineAsync (const std::string &id, const std::shared_ptr< void > &context)=0 |
| Starts unloading the file engine with the given ID.
|
|
FileProfile class is the root class for using the Microsoft Information Protection operations.
A typical application will only need one Profile.
Definition at line 53 of file file_profile.h.
◆ AcquirePolicyAuthToken()
virtual void FileProfile::AcquirePolicyAuthToken |
( |
Cloud | cloud, |
|
|
const std::shared_ptr< AuthDelegate > & | authDelegate ) const |
|
pure virtual |
Trigger an authentication callback for policy.
- Parameters
-
cloud | Azure cloud |
authDelegate | Authentication callback that will be invoked |
- Note
- MIP will not cache or do anything else with the value returned by the auth delegate. This function is recommended for applications that aren't "logged in" until after MIP requests an auth token. It allows an application to fetch a token before MIP actually requires one.
◆ AddEngineAsync()
virtual std::shared_ptr< AsyncControl > FileProfile::AddEngineAsync |
( |
const FileEngine::Settings & | settings, |
|
|
const std::shared_ptr< void > & | context ) |
|
pure virtual |
Starts adding a new file engine to the profile.
- Returns
- Async control object.
- Note
- FileProfile::Observer will be called upon success or failure.
◆ DeleteEngineAsync()
virtual std::shared_ptr< AsyncControl > FileProfile::DeleteEngineAsync |
( |
const std::string & | id, |
|
|
const std::shared_ptr< void > & | context ) |
|
pure virtual |
Starts deleting the file engine with the given ID.
All data for the given profile will be deleted.
- Returns
- Async control object.
- Note
- FileProfile::Observer will be called upon success or failure.
◆ GetSettings()
virtual const Settings & FileProfile::GetSettings |
( |
| ) |
const |
|
pure virtual |
Returns the profile settings.
◆ GetVersion()
static FILE_API const char *__CDECL FileProfile::GetVersion |
( |
| ) |
|
|
static |
Gets library version.
- Returns
- Version string
◆ ListEnginesAsync()
virtual std::shared_ptr< AsyncControl > FileProfile::ListEnginesAsync |
( |
const std::shared_ptr< void > & | context | ) |
|
|
pure virtual |
Starts list engines operation.
- Returns
- Async control object.
- Note
- FileProfile::Observer will be called upon success or failure.
◆ LoadAsync()
static FILE_API std::shared_ptr< AsyncControl > __CDECL FileProfile::LoadAsync |
( |
const Settings & | settings, |
|
|
const std::shared_ptr< void > & | context ) |
|
static |
Starts loading a profile based on the provided |settings|.
- Returns
- Async control object.
- Note
- FileProfile::Observer will be called upon success or failure.
◆ UnloadEngineAsync()
virtual std::shared_ptr< AsyncControl > FileProfile::UnloadEngineAsync |
( |
const std::string & | id, |
|
|
const std::shared_ptr< void > & | context ) |
|
pure virtual |
Starts unloading the file engine with the given ID.
- Returns
- Async control object.
- Note
- FileProfile::Observer will be called upon success or failure.
The documentation for this class was generated from the following file: