Microsoft Information Protection (MIP) SDK for C++: Reference 1.16
Doxygen-generated documentation for MIP SDK written in C++
|
Settings used to create a ProtectionHandler to protect new content. More...
#include <src/api/mip/protection/protection_handler.h>
Public Member Functions | |
std::string | GetApplicationScenarioId () const |
Gets the scenario Id provided by the application which is used to correlate with the server. | |
const std::vector< std::pair< std::string, std::string > > & | GetCustomSettings () const |
Get the custom settings, used for feature gating and testing. | |
const std::string & | GetDelegatedUserEmail () const |
Gets the delegated user. | |
bool | GetIsAuditedExtractionAllowed () const |
Gets whether or not non-MIP-aware applications are allowed to open protected content. | |
bool | GetIsDeprecatedAlgorithmPreferred () const |
Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility. | |
bool | GetIsOfflineOnly () const |
Gets whether or not ProtectionEngine operation allows for online HTTP operations. | |
std::shared_ptr< PublishingUseLicenseRequest > | GetPreLicenseRequest () const |
Gets the pre-license request. | |
const std::string & | GetPreLicenseUserEmail () const |
Gets the pre-license user. | |
std::shared_ptr< ProtectionDescriptor > | GetProtectionDescriptor () const |
std::shared_ptr< ProtectionHandler > | GetProtectionHandlerForRepublish () const |
Gets protection handler for republishing scenario. | |
const std::vector< uint8_t > & | GetPublishingLicenseForRepublish () const |
Gets the serialized republishing license. | |
bool | GetRegenerateContentKey () const |
Gets whether or not the content key and ID should be regenerated during republishing. | |
bool | GetRepairLabelIdAllowed () const |
Gets whether or not label id can be added to publishing license on republish. | |
bool | GetShouldRefreshTemplates () const |
Gets whether or not templates should be forcibly refreshed during offline publishing. | |
bool | IsPublishingFormatJson () const |
Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default). | |
PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor) | |
PublishingSettings constructor for enforcing protection on content. | |
PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::shared_ptr< ProtectionHandler > &protectionHandler) | |
PublishingSettings constructor for offline republishing. | |
PublishingSettings (const std::shared_ptr< ProtectionDescriptor > &protectionDescriptor, const std::vector< uint8_t > &serializedPublishingLicense) | |
PublishingSettings constructor for online republishing. | |
void | SetApplicationScenarioId (std::string applicationScenarioId) |
Sets the scenario Id provided by the application. | |
void | SetCustomSettings (const std::vector< std::pair< std::string, std::string > > &customSettings) |
Set the custom settings, used for feature gating and testing. | |
void | SetDelegatedUserEmail (const std::string &delegatedUserEmail) |
Sets the delegated user. | |
void | SetIsAuditedExtractionAllowed (bool isAuditedExtractionAllowed) |
Sets whether or not non-MIP-aware applications are allowed to open protected content. | |
void | SetIsDeprecatedAlgorithmPreferred (bool isDeprecatedAlgorithmPreferred) |
Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility. | |
virtual void | SetIsOfflineOnly (bool isOfflineOnly) |
Sets whether or not ProtectionEngine operation allows for online HTTP operations. | |
void | SetPreLicenseUserEmail (const std::string &preLicenseUserEmail) |
Sets pre-license user. | |
void | SetPublishingFormatJson (bool isPublishingFormatJson) |
Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default). | |
void | SetRegenerateContentKey (bool regenerateContentKey) |
Sets whether or not the content key and ID should be regenerated during republishing. | |
void | SetRepairLabelIdAllowed (bool repairAllowed) |
Sets whether or not label id can be added to publishing license on republish. | |
void | SetRequestPreLicense (std::shared_ptr< PublishingUseLicenseRequest > publishingUseLicenseRequest) |
Setting this will cause the publishing request to include a pre-license. | |
void | SetShouldRefreshTemplates (bool shouldRefreshTemplates) |
Sets whether or not templates should be forcibly refreshed during offline publishing. | |
Settings used to create a ProtectionHandler to protect new content.
Definition at line 228 of file protection_handler.h.
|
inline |
PublishingSettings constructor for enforcing protection on content.
protectionDescriptor | Protection details |
Definition at line 235 of file protection_handler.h.
|
inline |
PublishingSettings constructor for online republishing.
protectionDescriptor | New protection details |
serializedPublishingLicense | Original protection license |
Definition at line 250 of file protection_handler.h.
|
inline |
PublishingSettings constructor for offline republishing.
protectionDescriptor | New protection details |
protectionHandler | Original protection handler |
Definition at line 268 of file protection_handler.h.
|
inlineinherited |
Gets the scenario Id provided by the application which is used to correlate with the server.
Definition at line 57 of file protection_common_settings.h.
|
inlineinherited |
Get the custom settings, used for feature gating and testing.
Definition at line 108 of file protection_common_settings.h.
|
inline |
Gets the delegated user.
Definition at line 335 of file protection_handler.h.
|
inline |
Gets whether or not non-MIP-aware applications are allowed to open protected content.
Definition at line 292 of file protection_handler.h.
|
inline |
Gets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.
Definition at line 308 of file protection_handler.h.
|
inlineinherited |
Gets whether or not ProtectionEngine operation allows for online HTTP operations.
Definition at line 79 of file protection_common_settings.h.
|
inline |
Gets the pre-license request.
Definition at line 424 of file protection_handler.h.
|
inline |
Gets the pre-license user.
Definition at line 395 of file protection_handler.h.
|
inline |
Definition at line 280 of file protection_handler.h.
|
inline |
Gets protection handler for republishing scenario.
Definition at line 285 of file protection_handler.h.
|
inline |
Gets the serialized republishing license.
Definition at line 404 of file protection_handler.h.
|
inline |
Gets whether or not the content key and ID should be regenerated during republishing.
Definition at line 359 of file protection_handler.h.
|
inline |
Gets whether or not label id can be added to publishing license on republish.
Definition at line 435 of file protection_handler.h.
|
inline |
Gets whether or not templates should be forcibly refreshed during offline publishing.
Definition at line 454 of file protection_handler.h.
|
inline |
Gets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).
Definition at line 343 of file protection_handler.h.
|
inlineinherited |
Sets the scenario Id provided by the application.
applicationScenarioId | application scenario Id which is used to correlate with the server. |
Definition at line 66 of file protection_common_settings.h.
|
inlineinherited |
Set the custom settings, used for feature gating and testing.
customSettings | List of name/value pairs. |
Definition at line 99 of file protection_common_settings.h.
|
inline |
Sets the delegated user.
delegatedUserEmail | the delegation email. |
Definition at line 326 of file protection_handler.h.
|
inline |
Sets whether or not non-MIP-aware applications are allowed to open protected content.
isAuditedExtractionAllowed | If non-MIP-aware applications are allowed to open protected content |
Definition at line 299 of file protection_handler.h.
|
inline |
Sets whether or not deprecated crypto algorithm (ECB) is preferred for backwards compatibility.
isDeprecatedAlgorithmPreferred | if deprectated crypto algorithm is preferred |
Definition at line 315 of file protection_handler.h.
|
inlinevirtualinherited |
Sets whether or not ProtectionEngine operation allows for online HTTP operations.
isOfflineOnly | True if HTTP operations are disallowed, else false |
Definition at line 92 of file protection_common_settings.h.
|
inline |
Sets pre-license user.
preLicenseUserEmail | Pre-license user |
Definition at line 380 of file protection_handler.h.
References PublishingUseLicenseRequest::CreatePublishingUseLicenseRequest().
|
inline |
Sets whether or not the returned pl is in json format (xml format is more widely accepted and is the default).
isPublishingFormatJson | if json format is enabled. |
Definition at line 350 of file protection_handler.h.
|
inline |
Sets whether or not the content key and ID should be regenerated during republishing.
regenerateContentKey | If the content key and ID should be regenerated. |
Definition at line 366 of file protection_handler.h.
|
inline |
Sets whether or not label id can be added to publishing license on republish.
repairAllowed | if label info data in protection descriptor can be added to publishing license |
Definition at line 445 of file protection_handler.h.
|
inline |
Setting this will cause the publishing request to include a pre-license.
publishingUseLicenseRequest | The pre-license request |
Definition at line 415 of file protection_handler.h.
|
inline |
Sets whether or not templates should be forcibly refreshed during offline publishing.
shouldRefreshTemplates | If templates should be forcibly refreshed |
Definition at line 463 of file protection_handler.h.