Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
protection_common_settings.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 */
33#ifndef API_MIP_PROTECTION_COMMON_SETTINGS_H_
34#define API_MIP_PROTECTION_COMMON_SETTINGS_H_
35
36#include <string>
37#include <vector>
38
39#include "mip/mip_namespace.h"
40
41MIP_NAMESPACE_BEGIN
42
47public:
48 ProtectionCommonSettings(std::string applicationScenarioId = std::string())
49 : mApplicationScenarioId(applicationScenarioId),
50 mIsOfflineOnly(false) {}
51
57 std::string GetApplicationScenarioId() const {
58 return mApplicationScenarioId;
59 }
60
66 void SetApplicationScenarioId(std::string applicationScenarioId) { mApplicationScenarioId = applicationScenarioId; }
67
79 bool GetIsOfflineOnly() const { return mIsOfflineOnly; }
80
92 virtual void SetIsOfflineOnly(bool isOfflineOnly) { mIsOfflineOnly = isOfflineOnly; }
93
99 void SetCustomSettings(const std::vector<std::pair<std::string, std::string>>& customSettings) {
100 mCustomSettings = customSettings;
101 }
102
108 const std::vector<std::pair<std::string, std::string>>& GetCustomSettings() const {
109 return mCustomSettings;
110 }
111
113 virtual ~ProtectionCommonSettings() {}
114 ProtectionCommonSettings& operator=(const ProtectionCommonSettings& other) {
115 mApplicationScenarioId = other.mApplicationScenarioId;
116 mIsOfflineOnly = other.mIsOfflineOnly;
117 return *this;
118 }
119
120private:
121 std::string mApplicationScenarioId;
122 bool mIsOfflineOnly;
123 std::vector<std::pair<std::string, std::string>> mCustomSettings;
124
126};
127
128MIP_NAMESPACE_END
129
130#endif // API_MIP_PROTECTION_Common_SETTINGS_H_
Settings to use for protection operations.
Definition protection_common_settings.h:46
bool GetIsOfflineOnly() const
Gets whether or not ProtectionEngine operation allows for online HTTP operations.
Definition protection_common_settings.h:79
void SetApplicationScenarioId(std::string applicationScenarioId)
Sets the scenario Id provided by the application.
Definition protection_common_settings.h:66
void SetCustomSettings(const std::vector< std::pair< std::string, std::string > > &customSettings)
Set the custom settings, used for feature gating and testing.
Definition protection_common_settings.h:99
ProtectionCommonSettings(std::string applicationScenarioId=std::string())
Definition protection_common_settings.h:48
std::string GetApplicationScenarioId() const
Gets the scenario Id provided by the application which is used to correlate with the server.
Definition protection_common_settings.h:57
virtual void SetIsOfflineOnly(bool isOfflineOnly)
Sets whether or not ProtectionEngine operation allows for online HTTP operations.
Definition protection_common_settings.h:92
const std::vector< std::pair< std::string, std::string > > & GetCustomSettings() const
Get the custom settings, used for feature gating and testing.
Definition protection_common_settings.h:108
MIP namespace macros.