Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
FileHandler::Observer Class Reference

Observer interface for clients to get notifications events related to file handler. More...

#include <file_handler.h>

Public Member Functions

virtual void OnCreateFileHandlerSuccess (const std::shared_ptr< FileHandler > &fileHandler, const std::shared_ptr< void > &context)
 Called when the handler is created successfully.
 
virtual void OnCreateFileHandlerFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when creating the handler failed.
 
virtual void OnClassifySuccess (const std::vector< std::shared_ptr< Action > > &actions, const std::shared_ptr< void > &context)
 Called when classify success.
 
virtual void OnClassifyFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when classify failed.
 
virtual void OnGetDecryptedTemporaryFileSuccess (const std::string &decryptedFilePath, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary file success.
 
virtual void OnGetDecryptedTemporaryFileFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary file failed.
 
virtual void OnGetDecryptedTemporaryStreamSuccess (const std::shared_ptr< Stream > &decryptedStream, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary stream success.
 
virtual void OnGetDecryptedTemporaryStreamFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when getting the decrypted temporary stream failed.
 
virtual void OnCommitSuccess (bool committed, const std::shared_ptr< void > &context)
 Called when committing the changes to the file were successful.
 
virtual void OnCommitFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when committing the changes to the file failed.
 
virtual void OnInspectSuccess (const std::shared_ptr< FileInspector > &fileInspector, const std::shared_ptr< void > &context)
 Called when inspect success.
 
virtual void OnInspectFailure (const std::exception_ptr &error, const std::shared_ptr< void > &context)
 Called when inspect failed.
 

Detailed Description

Observer interface for clients to get notifications events related to file handler.

Note
All errors inherit from mip::Error.
Client should not call the engine back on the thread that calls the observer.

Member Function Documentation

◆ OnClassifyFailure()

virtual void FileHandler::Observer::OnClassifyFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when classify failed.

◆ OnClassifySuccess()

virtual void FileHandler::Observer::OnClassifySuccess ( const std::vector< std::shared_ptr< Action > > & actions,
const std::shared_ptr< void > & context )
inlinevirtual

Called when classify success.

◆ OnCommitFailure()

virtual void FileHandler::Observer::OnCommitFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when committing the changes to the file failed.

◆ OnCommitSuccess()

virtual void FileHandler::Observer::OnCommitSuccess ( bool committed,
const std::shared_ptr< void > & context )
inlinevirtual

Called when committing the changes to the file were successful.

◆ OnCreateFileHandlerFailure()

virtual void FileHandler::Observer::OnCreateFileHandlerFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when creating the handler failed.

◆ OnCreateFileHandlerSuccess()

virtual void FileHandler::Observer::OnCreateFileHandlerSuccess ( const std::shared_ptr< FileHandler > & fileHandler,
const std::shared_ptr< void > & context )
inlinevirtual

Called when the handler is created successfully.

◆ OnGetDecryptedTemporaryFileFailure()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryFileFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary file failed.

◆ OnGetDecryptedTemporaryFileSuccess()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryFileSuccess ( const std::string & decryptedFilePath,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary file success.

◆ OnGetDecryptedTemporaryStreamFailure()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryStreamFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary stream failed.

◆ OnGetDecryptedTemporaryStreamSuccess()

virtual void FileHandler::Observer::OnGetDecryptedTemporaryStreamSuccess ( const std::shared_ptr< Stream > & decryptedStream,
const std::shared_ptr< void > & context )
inlinevirtual

Called when getting the decrypted temporary stream success.

◆ OnInspectFailure()

virtual void FileHandler::Observer::OnInspectFailure ( const std::exception_ptr & error,
const std::shared_ptr< void > & context )
inlinevirtual

Called when inspect failed.

◆ OnInspectSuccess()

virtual void FileHandler::Observer::OnInspectSuccess ( const std::shared_ptr< FileInspector > & fileInspector,
const std::shared_ptr< void > & context )
inlinevirtual

Called when inspect success.


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