类 FileHandler
所有文件处理函数的接口。
总结
成员 | 说明 |
---|---|
public std::shared_ptr<ContentLabel> GetLabel() | 开始从文件检索敏感度标签。 |
public std::vector<std::pair<std::string, std::string>> GetProperties(uint32_t version) | 根据版本检索文件属性。 |
public std::shared_ptr<ProtectionHandler> GetProtection() | 开始从文件检索保护策略。 |
public void RegisterContentForTrackingAndRevocationAsync(bool isOwnerNotificationEnabled, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) | 注册用于跟踪和吊销的内容。 |
public void RevokeContentAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) | 对内容执行吊销。 |
public void ClassifyAsync(const std::shared_ptr<void>& context) | 执行处理程序中的规则并返回要执行的操作列表。 |
public void InspectAsync(const std::shared_ptr<void>& context) | 创建一个文件检查器对象,用于从兼容的文件格式中检索文件内容。 |
public void SetLabel(const std::shared_ptr<Label>& label, const LabelOptions& labelOptions, const Protection设置& protection设置) | 将敏感度标签设置为文件。 |
public void DeleteLabel(const LabelingOptions& labelingOptions) | 从文件中删除敏感度标签。 |
public void SetProtection(const std::shared_ptr<ProtectionDescriptor& protectionDescriptor>, const Protection设置& protection设置) | 为文件设置自定义权限或基于模板的权限(根据 protectionDescriptor->GetProtectionType)。 |
public void SetProtection(const std::shared_ptr<ProtectionHandler& protectionHandler>) | 使用现有的保护处理程序对文档设置保护。 |
public void RemoveProtection() | 从文件中删除保护。 如果原始文件格式不支持标签,则在移除保护时标签将丢失。 当原生格式支持标签时,会维护标签元数据。 |
public void CommitAsync(const std::string& outputFilePath, const std::shared_ptr<void>& context) | 将更改写入 outputFilePath 参数指定的文件。 |
public void CommitAsync(const std::shared_ptr<Stream>& outputStream, const std::shared_ptr<void>& context) | 将更改写入 outputStream 参数指定的流。 |
public bool IsModified() | 检查是否有要提交到文件的更改。 |
public void GetDecryptedTemporaryFileAsync(const std::shared_ptr<void>& context) | 返回临时文件的路径(如果可能,将被删除) - 表示解密的内容。 |
public void GetDecryptedTemporaryStreamAsync(const std::shared_ptr<void>& context) | 返回流 - 表示解密的内容。 |
public void NotifyCommitSuccessful(const std::string& actualFilePath) | 在将更改提交到磁盘时调用。 |
public std::string GetOutputFileName() | 根据原始文件名和累积的更改计算输出文件名和扩展名。 |
成员
GetLabel 函数
开始从文件检索敏感度标签。
异常
- NotSupportedError:仅当仅使用保护引擎且未找到策略处理程序时。
GetProperties 函数
根据版本检索文件属性。
GetProtection 函数
开始从文件检索保护策略。
RegisterContentForTrackingAndRevocationAsync 函数
注册用于跟踪和吊销的内容。
参数:
isOwnerNotificationEnabled:设置为 true 以在文档被解密时通过电子邮件通知所有者,或设置为 false 以不发送通知。
observer:实现 ProtectionHandler::Observer 接口的类
context:将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文
返回结果:异步控制对象。
RevokeContentAsync 函数
对内容执行吊销。
参数:
observer:实现 ProtectionHandler::Observer 接口的类
context:将不透明地转发给观察者和可选 HttpDelegate 的客户端上下文
返回结果:异步控制对象。
ClassifyAsync 函数
执行处理程序中的规则并返回要执行的操作列表。
返回:应应用于内容的操作列表。
异常
- NotSupportedError:仅当仅使用保护引擎且未找到策略处理程序时。
InspectAsync 函数
创建一个文件检查器对象,用于从兼容的文件格式中检索文件内容。
返回结果:文件检查器。
SetLabel 函数
将敏感度标签设置为文件。 在调用 CommitAsync 之前,不会将更改写入文件。 Privileged 和 Auto 方法允许 API 在设置标签时重写任何现有标签 Throws JustificationRequiredError(通过 labelOptions 参数)进行对齐。
异常
- NotSupportedError:仅当仅使用保护引擎且未找到策略处理程序时。
DeleteLabel 函数
从文件中删除敏感度标签。 在调用 CommitAsync 之前,不会将更改写入文件。 Privileged 和 Auto 方法允许 API 在设置标签时重写任何现有标签 Throws JustificationRequiredError(通过 labelOptions 参数)进行对齐。
异常
- NotSupportedError:仅当仅使用保护引擎且未找到策略处理程序时。
SetProtection 函数
为文件设置自定义权限或基于模板的权限(根据 protectionDescriptor->GetProtectionType)。 在调用 CommitAsync 之前,不会将更改写入文件。
SetProtection 函数
使用现有的保护处理程序对文档设置保护。 在调用 CommitAsync 之前,不会将更改写入文件。
RemoveProtection 函数
从文件中删除保护。 如果原始文件格式不支持标签,则在移除保护时标签将丢失。 当原生格式支持标签时,会维护标签元数据。 在调用 CommitAsync 之前,不会将更改写入文件。
CommitAsync 函数
将更改写入 |outputFilePath 指定的文件 |参数。 FileHandler::Observer 将在成功或失败时调用。 如果输出文件的磁盘空间不足,则 FileHandler::CommitAsync 函数可能会生成损坏的文件。 在这种情况下,请删除损坏的文件,然后在重试操作之前调整磁盘大小或选择另一个磁盘。
CommitAsync 函数
将更改写入 |outputStream 指定的流 |参数。 |outputStream| 不能与用于创建处理程序的 inputStream 相同。 FileHandler::Observer 将在成功或失败时调用。 如果输出文件的磁盘空间不足,则 FileHandler::CommitAsync 函数可能会生成损坏的文件。 在这种情况下,请删除损坏的文件,然后在重试操作之前调整磁盘大小或选择另一个磁盘。
IsModified 函数
检查是否有要提交到文件的更改。 在调用 CommitAsync 之前,不会将更改写入文件。
GetDecryptedTemporaryFileAsync 函数
返回临时文件的路径(如果可能,将被删除) - 表示解密的内容。 FileHandler::Observer 将在成功或失败时调用。
GetDecryptedTemporaryStreamAsync 函数
返回流 - 表示解密的内容。 FileHandler::Observer 将在成功或失败时调用。
NotifyCommitSuccessful 函数
在将更改提交到磁盘时调用。
参数:
- actualFilePath:输出文件的实际文件路径
触发审核事件
异常
- NotSupportedError:仅当仅使用保护引擎且未找到策略处理程序时。
GetOutputFileName 函数
根据原始文件名和累积的更改计算输出文件名和扩展名。
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈