适用于 C++ 的 MIP SDK 参考

适用于 C++ 的 Microsoft 信息保护 (MIP) SDK 允许开发人员管理数据保护策略并将其应用于数据和其他数字资产。

适用于 C++ 的 MIP SDK 包括枚举和结构,以及下列类:

说明
类 AccessDeniedError 用户无法访问内容。 例如,无权限、内容已撤销。
操作 操作的接口。 每个操作都转换为,出于应用标签目的,应用程序需要执行的步骤(如策略所定义)
class ActionData 尚无记录。
类 AddContentFooterAction 指定向文档添加内容脚注的操作类。
AddContentHeaderAction 指定添加内容头的操作类。
AddWatermarkAction 指定添加水印的操作类。
AddWatermarkActionData 尚无记录。
AdhocProtectionRequiredError 应设置临时保护以完成对文件的操作。
类 ApplicationActionState 尚无记录。
ApplyLabelAction 应用标签操作要求,必须调用应用程序,才能应用特定标签。
Class ArgumentData 尚无记录。
类 AsyncControl 用于取消异步操作的类。
AuditDelegate 用于定义 MIP SDK 审核通知的接口的类。
AuditEvent 单个审核事件。
类 AuthDelegate 用于与身份验证相关的操作的委托。
BadInputError 输入不正确的错误,在 SDK API 输入无效时引发。
ClassificationData 尚无记录。
class ClassificationRequest 包含对执行状态的分类调用的请求的类。
ClassificationResult 包含对执行状态进行分类调用的结果的类。
类 ComputeEngine 尚无记录。
类 ComputeEngineContext 尚无记录。
ConditionData 尚无记录。
ConsentDelegate 执行许可相关操作的委托。
类 ConsentDeniedError 需要用户同意的操作未获得同意。
ProtectionHandler::ConsumptionSettings 用于创建 ProtectionHandler 以使用现有内容的设置。
ContentFormatNotSupportedError 内容格式不受支持。
ContentLabel 应用于一段内容(通常是文档)的Microsoft Purview 信息保护标签的抽象。
ContentMarkingActionData 尚无记录。
类 CustomAction CustomAction 是一个通用操作类,可将操作的所有子属性捕获为一个属性包。 调用方负责理解操作的含义。
类 CustomerKeyUnavailableError 创建自己需要但不可用的加密密钥。
DelegateResponseBase 所有 DelegateResponse 类的基类。
DelegateResponseError 委托响应错误。 响应在委托方法中遇到的错误时引发或返回。
DelegationLicense 尚无记录。
DelegationLicenseSettings 尚无记录。
DeprecatedApiError 调用方调用了一个弃用的 API。
DetailedClassificationResult 包含对执行状态进行分类调用的结果的类。
DiagnosticDelegate 用于定义 MIP SDK 审核/遥测通知的接口的类。
class DirectoryObject 目录对象信息,包括类型、电子邮件、objectId 和 PUID。
DirectoryObjectRights 目录对象和与之关联的权限。
DocumentState 尚无记录。
错误 将从 MIP SDK 报告(引发或返回)的所有错误的基类。
事件 单个审核/遥测事件。
EventContext 单个审核/遥测事件上下文。
EventProperty 单个审核/遥测属性。
ExecutionState 执行引擎所需的所有状态的接口。
类 FileEngine 此类提供适用于所有引擎功能的接口。
FileExecutionState 尚无记录。
类 FileHandler 适用于所有文件处理函数的接口。
类 FileInspector 尚无记录。
类 FileIOError 文件 IO 错误。
类 FileProfile FileProfile 类是用于使用 Microsoft 信息保护操作的根类。
类 FileStatus 所有文件状态函数的接口。
GetTemplatesSettings 获取模板时要使用的设置。
HttpDelegate 用于重写 HTTP 处理的接口。
HttpOperation 描述单个 HTTP 操作的接口,在替代 HttpDelegate 时由客户端应用程序实现。
HttpRequest 描述单个 HTTP 请求的接口。
HttpResponse 描述单个 HTTP 响应的接口,由客户端应用在重写 HttpDelegate 时实现。
标识 标识的抽象。
InsufficientBufferError 缓冲区不足错误。
InternalError 内部错误。 如果在执行期间出现意外,就会抛出此错误。
类 JsonDelegate 尚无记录。
类 JsonDocument JsonDocument 抽象类。
类 JsonValue 尚无记录。
JustificationRequiredError 尚无记录。
JustifyAction JustifyAction 要求必须合理解释标签降级,并设置执行状态下的响应。
标签 单个Microsoft Purview 信息保护标签的抽象。
Class LabelActionData 尚无记录。
Class LabelDisabledError 标签已禁用或处于非活动状态。
Class LabelGroupData 尚无记录。
LabelingOptions 用于为 SetLabel/DeleteLabel 方法配置标记选项的接口。
Class LabelNotFoundError 标签 ID 无法识别。
类 LicenseApplicationData 许可证中的应用程序数据。
LicenseConnectionInfo 许可证中的连接信息。
LicenseDescriptor 许可证中的描述符。
类 LicenseNameAndDescriptionItem 许可证中的描述符行项。
LicenseNotRegisteredError 许可证未注册。
LicenseRightsData 发布许可证的权限相关信息。
LoggerDelegate 定义 MIP SDK 记录器接口的类。
LogMessageData 存储日志消息的类。
MetadataAction 将元数据信息添加到内容的 Action。
MetadataEntry 元数据项的抽象类。
MetadataVersion MetadataVersion 的接口。 MetadataVersion 用于确定哪些元数据处于活动状态及其处理方式。
MipConfiguration MIP SDK 在其创建过程中和整个生命周期中使用的配置。
类 MipContext MipContext 表示在所有配置文件、引擎、处理程序之间共享的状态。
类 MsgAttachmentData 尚无记录。
类 MsgInspector 尚无记录。
NetworkError 网络错误。 对服务终结点执行网络调用时,由于意外行为所致。
NoAuthTokenError 由于缺少身份验证令牌,用户无法访问内容。
NoPermissionsError 用户无法访问内容。 例如,无权限、内容已撤销。
NoPolicyError 未为分类/标签配置租户策略。
NotSupportedError SDK 不支持应用程序请求执行的操作。
AuthDelegate::OAuth2Challenge 包含调用应用程序生成 oauth2 令牌所需的所有信息的类。
AuthDelegate::OAuth2Token 包含应用程序提供的访问令牌信息的类。
类 FileHandler::Observer Observer 接口,供客户端获取文件处理程序相关事件的通知。
类 FileProfile::Observer Observer 接口,供客户端获取配置文件相关事件的通知。
PolicyProfile::Observer Observer 接口,供客户端获取配置文件相关事件的通知。
ProtectionEngine::Observer 接收 ProtectionEngine 相关通知的接口。
ProtectionHandler::Observer 接收 ProtectionHandler 相关通知的接口。
ProtectionProfile::Observer 接收与 ProtectionProfile 相关通知的接口。
类 OperationCancelledError 已取消操作。
ParsedPublishingLicense 尚无记录。
ParsedPublishingLicenseBuilder 尚无记录。
PolicyEngine 此类提供适用于所有引擎功能的接口。
类 PolicyHandler 此类为文件上的所有策略处理程序函数提供一个接口。
类 PolicyPackageData 尚无记录。
PolicyProfile PolicyProfile 类是用于使用Microsoft Purview 信息保护操作的根类。 一个典型的应用程序只需要一个 PolicyProfile,但它可以按需创建多个配置文件。
PolicyRuleData 尚无记录。
类 PrivilegedRequiredError 当前标签已分配为特权操作 (与管理员操作等效) ,因此无法重写。
PropertyData 尚无记录。
类 ProtectAdhocAction 指定向文档添加临时保护的操作类。
类 ProtectAdhocDkAction 指定向文档添加临时双密钥保护的操作类。
类 ProtectByEncryptOnlyAction 指定向文档添加“仅加密”保护的操作类。
类 ProtectByTemplateAction 指定向文档添加模板保护的操作类。
类 ProtectDoNotForwardAction 指定向文档添加不转发保护的操作类。
类 ProtectDoNotForwardDkAction 指定向文档添加“不转发”双密钥保护的操作类。
类 ProtectionActionData 尚无记录。
ProtectionCommonSettings 用于保护操作的设置。
ProtectionDescriptor 与某段内容相关的保护说明。
ProtectionDescriptorBuilder 构造 ProtectionDescriptor,用于描述与一段内容相关的保护。
ProtectionEngine 管理与特定标识有关的保护相关操作。
ProtectionHandler 管理特定保护配置的保护相关操作。
ProtectionProfile ProtectionProfile 是用于执行保护操作的根类。
ProtectionSettings 用于为 SetLabel 方法配置保护选项的接口。
类 ProxyAuthenticationError 代理身份验证失败。
PublishingLicenseInfo 保存用于创建保护处理程序的发布许可证的详细信息。
ProtectionHandler::P ublishingSettings 用于创建 ProtectionHandler 以保护新内容的设置。
PublishingUseLicenseRequest 在发布请求中请求使用许可证。
RecommendLabelAction 建议标签操作是向用户建议标签。 在用户忽略建议标签后,应通过对执行状态采取受支持的操作来取消此调用。
RemoveContentFooterAction 指定从文档中删除内容脚注的操作类。
RemoveContentHeaderAction 指定从文档中删除内容头的操作类。
RemoveProtectionAction 指定从文档中删除保护的操作类。
RemoveWatermarkAction 指定从文档中删除水印的操作类。
类 RulePackageData 尚无记录。
类 SensitiveTypeClassificationData 尚无记录。
SensitivityConditionData 尚无记录。
SensitivityTypesRulePackage 尚无记录。
类 ServiceDisabledError 由于服务被禁用,用户无法访问内容。
类 ComputeEngine::Settings 尚无记录。
类 FileEngine::Settings 尚无记录。
类 FileProfile::Settings FileProfile 在其创建期间及其整个生存期内使用的 Settings。
PolicyEngine::Settings 定义与 PolicyEngine 关联的设置。
PolicyProfile::Settings PolicyProfile 在其创建期间及其整个生存期内使用的 Settings。
ProtectionEngine::Settings ProtectionEngine 在其创建期间及其整个生存期内使用的 Settings。
ProtectionProfile::Settings 由 ProtectionProfile 在创建期间及其整个生存期内使用的设置。
StorageDelegate 定义用于缓存的 MIP SDK 存储的接口的类。
StorageDelegate::StorageSettings StorageDelegate 使用的设置。
类 StorageTable 定义用于缓存的 MIP SDK 存储表的接口的类。
一个类,它定义 MIP SDK 和基于流的内容之间的接口。
SyncFileBaseData 尚无记录。
SyncFilePolicyData 尚无记录。
SyncFileSensitivityData 尚无记录。
TaskDispatcherDelegate 用于定义 MIP SDK 任务调度程序的接口的类。
TelemetryDelegate 用于定义 MIP SDK 遥测通知的接口的类。
TelemetryEvent 单个遥测事件。
TemplateArchivedError 模板 ID 已存档,无法进行保护。
TemplateDescriptor 尚无记录。
TemplateNotFoundError 模板 ID 无法由 RMS 服务识别。
TenantInformation 来自 RMS 的租户信息。
类 UserRights 一组用户以及与之关联的权限。