Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
metadata_action.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
27/**
28 * @brief This file contains the MetadataAction class.
29 *
30 * @file metadata_action.h
31 */
32
33#ifndef API_MIP_UPE_METADATA_ACTION_H_
34#define API_MIP_UPE_METADATA_ACTION_H_
35
36#include <string>
37#include <vector>
38
39#include "mip/mip_namespace.h"
40#include "mip/upe/action.h"
42
43MIP_NAMESPACE_BEGIN
44/**
45 * @brief An Action that adds metadata information to the content.
46 *
47 */
48class MetadataAction : public Action {
49public:
50 /**
51 * @brief Get the list of names of metadata that should be removed from content.
52 *
53 * @return a vector of strings to remove.
54 * @note Removing metadata should be done before adding metadata.
55 */
56 virtual const std::vector<std::string>& GetMetadataToRemove() const = 0;
57 /**
58 * @brief Get the metadata name/value pairs that should be added to the content.
59 *
60 * @return const std::vector<MetadataEntry>&
61 * @note Removing metadata should be done before adding metadata.
62 */
63 virtual const std::vector<MetadataEntry>& GetMetadataToAdd() const = 0;
64 /** @cond DOXYGEN_HIDE */
65 virtual ~MetadataAction() { }
66protected:
67 MetadataAction(const std::string& id) : Action(id) { }
68 /** @endcond */
69};
70
71MIP_NAMESPACE_END
72
73#endif // API_MIP_UPE_METADATA_ACTION_H_
A file containing the Action base class and the ActionType enumerator.
Interface for an action.
Definition action.h:93
An Action that adds metadata information 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 const std::vector< MetadataEntry > & GetMetadataToAdd() const =0
Get the metadata name/value pairs that should be added to the content.
This file contains the MetadataEntry class.
MIP namespace macros.