Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
MetadataAction Class Referenceabstract

An Action that adds metadata information to the content. More...

#include <src/api/mip/upe/metadata_action.h>

+ Inheritance diagram for MetadataAction:
+ Collaboration diagram for MetadataAction:

Public Member Functions

virtual const std::vector< MetadataEntry > & GetMetadataToAdd () const =0
 Get the metadata name/value pairs that should be added to the content.
 
virtual const std::vector< std::string > & GetMetadataToRemove () const =0
 Get the list of names of metadata that should be removed from content.
 
virtual ActionType GetType () const =0
 Get the type of Action.
 

Detailed Description

An Action that adds metadata information to the content.

Definition at line 48 of file metadata_action.h.

Member Function Documentation

◆ GetMetadataToAdd()

virtual const std::vector< MetadataEntry > & MetadataAction::GetMetadataToAdd ( ) const
pure virtual

Get the metadata name/value pairs that should be added to the content.

Returns
const std::vector<MetadataEntry>&
Note
Removing metadata should be done before adding metadata.

◆ GetMetadataToRemove()

virtual const std::vector< std::string > & MetadataAction::GetMetadataToRemove ( ) const
pure virtual

Get the list of names of metadata that should be removed from content.

Returns
a vector of strings to remove.
Note
Removing metadata should be done before adding metadata.

◆ GetType()

virtual ActionType Action::GetType ( ) const
pure virtualinherited

Get the type of Action.

Returns
ActionType The type of derived action this base class can be cast to.

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