Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
user_rights.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 Defines UserRights class
29 *
30 * @file user_rights.h
31 */
32
33#ifndef API_MIP_USER_RIGHTS_H_
34#define API_MIP_USER_RIGHTS_H_
35
36#include <string>
37#include <vector>
38
39#include "mip/mip_namespace.h"
40
41MIP_NAMESPACE_BEGIN
42
43/**
44 * @brief A group of users and the rights associated with them
45 */
47public:
48 /**
49 * @brief UserRights constructor
50 *
51 * @param users Group of users that share the same rights
52 * @param rights Rights shared by group of users
53 */
54 UserRights(const std::vector<std::string>& users, const std::vector<std::string>& rights) : mUsers(users), mRights(rights) {}
55
56 /**
57 * @brief Gets users associated with a set of rights
58 *
59 * @return Users associated with a set of rights
60 */
61 const std::vector<std::string>& Users() const { return mUsers; }
62
63 /**
64 * @brief Gets rights associated with a group of users
65 *
66 * @return Rights associated with a group of users
67 */
68 const std::vector<std::string>& Rights() const { return mRights; }
69
70private:
71 std::vector<std::string> mUsers;
72 std::vector<std::string> mRights;
73};
74
75MIP_NAMESPACE_END
76
77#endif // API_MIP_USER_RIGHTS_H_
A group of users and the rights associated with them.
Definition user_rights.h:46
const std::vector< std::string > & Users() const
Gets users associated with a set of rights.
Definition user_rights.h:61
const std::vector< std::string > & Rights() const
Gets rights associated with a group of users.
Definition user_rights.h:68
UserRights(const std::vector< std::string > &users, const std::vector< std::string > &rights)
UserRights constructor.
Definition user_rights.h:54
MIP namespace macros.