Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
publishing_use_license_request.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 the PublishingUseLicenseRequest interface
29 *
30 * @file publishing_use_license_request.h
31 */
32
33#ifndef API_MIP_PROTECTION_PUBLISHING_USE_LICENSE_REQUEST_H_
34#define API_MIP_PROTECTION_PUBLISHING_USE_LICENSE_REQUEST_H_
35
36#include <memory>
37#include <string>
38
39#include "mip/mip_export.h"
40#include "mip/mip_namespace.h"
41
42MIP_NAMESPACE_BEGIN
43
44/**
45 * @brief Request for a use license in the publishing request
46 */
48public:
49 /**
50 * @brief Sets the optional delegated user. If this is not set then the prelicense is for the user in the token
51 *
52 * @param delegatedUserEmail the delegation email.
53 *
54 * @note A delegated user is specified when the authenticating user/application is acting on behalf of another user
55 */
56 virtual void SetDelegatedUserEmail(const std::string& delegatedUserEmail) = 0;
57
58 /**
59 * @brief Gets the delegated user
60 *
61 * @return Delegated user
62 *
63 * @note A delegated user is specified when the authenticating user/application is acting on behalf of another user
64 */
65 virtual const std::string& GetDelegatedUserEmail() const = 0;
66
67 /**
68 * @brief Creates a PublishingUseLicenseRequest object
69 *
70 * @return A PublishingUseLicenseRequest object
71 */
72 MIP_API static std::shared_ptr<PublishingUseLicenseRequest> __CDECL CreatePublishingUseLicenseRequest();
73
74 /** @cond DOXYGEN_HIDE */
76protected:
78 /** @endcond */
79};
80
81MIP_NAMESPACE_END
82#endif // API_MIP_PROTECTION_PUBLISHING_USE_LICENSE_REQUEST_H_
Request for a use license in the publishing request.
virtual const std::string & GetDelegatedUserEmail() const =0
Gets the delegated user.
virtual void SetDelegatedUserEmail(const std::string &delegatedUserEmail)=0
Sets the optional delegated user.
static MIP_API std::shared_ptr< PublishingUseLicenseRequest > __CDECL CreatePublishingUseLicenseRequest()
Creates a PublishingUseLicenseRequest object.
A file export/import macros.
MIP namespace macros.