Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
Public Member Functions | List of all members
FileExecutionState Class Reference

#include <file_execution_state.h>

Public Member Functions

virtual DataState GetDataState () const
 Gets the state of the content while the application is interacting with it.
 
virtual std::shared_ptr< ClassificationResults > GetClassificationResults (const std::shared_ptr< FileHandler > &, const std::vector< std::shared_ptr< ClassificationRequest > > &) const
 Return a map of classification results.
 
virtual std::map< std::string, std::string > GetAuditMetadata () const
 Return a map of application specific audit key-value pairs.
 
virtual const std::string GetApplicationScenarioId () const
 Return an identifier which correlates application events with the corresponding protection service REST requests.
 

Member Function Documentation

◆ GetApplicationScenarioId()

virtual const std::string FileExecutionState::GetApplicationScenarioId ( ) const
inlinevirtual

Return an identifier which correlates application events with the corresponding protection service REST requests.

Returns
An identifier (usually specified as a GUID)

◆ GetAuditMetadata()

virtual std::map< std::string, std::string > FileExecutionState::GetAuditMetadata ( ) const
inlinevirtual

Return a map of application specific audit key-value pairs.

Returns
a list of application specific audit metadata
Note
Registered Key:Value pairs Sender: Email Id for the sender Recipients: Represents a JSON array of recipients for an email LastModifiedBy: Email Id for the user who last modified the content LastModifiedDate: Date the content was last modified

◆ GetClassificationResults()

virtual std::shared_ptr< ClassificationResults > FileExecutionState::GetClassificationResults ( const std::shared_ptr< FileHandler > & ,
const std::vector< std::shared_ptr< ClassificationRequest > > &  ) const
inlinevirtual

Return a map of classification results.

Parameters
fileHandler- the file handler of the used file
classificationIdsa list of classification IDs.
Returns
a list of classification results.

◆ GetDataState()

virtual DataState FileExecutionState::GetDataState ( ) const
inlinevirtual

Gets the state of the content while the application is interacting with it.

Returns
State of the content data
The documentation for this class was generated from the following file: