class FileHandler

Интерфейс для всех функций обработки файлов.

Итоги

Участники Descriptions
public std::shared_ptr<ContentLabel GetLabel> () Начинает получение метки конфиденциальности из файла.
public std::vector<std::p air<std::string, std::string>> GetProperties(uint32_t версия) Извлекает свойства файла в соответствии с версией.
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 LabelingOptions&labelingOptions, 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, чтобы не отправлять уведомление.

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция RevokeContentAsync

Выполните отзыв для содержимого.

Параметры:

  • наблюдатель: класс, реализующий интерфейс ProtectionHandler::Observer

  • контекст клиента, который будет непрозрачно пересылаться наблюдателям и необязательным HttpDelegate

Возвращает: объект элемента управления Async.

Функция ClassifyAsync

Выполняет правила в обработчике и возвращает список выполняемых действий.

Возвращается: список действий, которые должны применяться к содержимому.

Исключения

  • NotSupportedError: если используется только обработчик защиты, и обработчик политики не найден.

Функция InspectAsync

Создайте объект инспектора файлов, используемый для извлечения содержимого файла из совместимых форматов файлов.

Возвращает: инспектор файлов.

Функция SetLabel

Задает метку конфиденциальности для файла. Изменения не записываются в файл до вызова CommitAsync. Привилегированный и автоматический метод позволяют API переопределить все существующие метки Throws JustificationRequiredError при настройке метки требует, чтобы операция была оправдана (с помощью параметра labelingOptions).

Исключения

  • NotSupportedError: если используется только обработчик защиты, и обработчик политики не найден.

Функция DeleteLabel

Удаляет метку конфиденциальности из файла. Изменения не записываются в файл до вызова CommitAsync. Привилегированный и автоматический метод позволяют API переопределить все существующие метки Throws JustificationRequiredError при настройке метки требует, чтобы операция была оправдана (с помощью параметра labelingOptions).

Исключения

  • NotSupportedError: если используется только обработчик защиты, и обработчик политики не найден.

Функция SetProtection

Задает пользовательские или шаблонные разрешения (в соответствии с protectionDescriptor-GetProtectionType>) в файл. Изменения не записываются в файл до вызова CommitAsync.

Функция SetProtection

Задает защиту в документе с помощью существующего обработчика защиты. Изменения не записываются в файл до вызова CommitAsync.

Функция RemoveProtection

Удаляет защиту из файла. Если исходный формат файла не поддерживает метку, метка будет потеряна при удалении защиты. Если собственный формат поддерживает маркировку, метаданные метки сохраняются. Изменения не записываются в файл до вызова CommitAsync.

Функция CommitAsync

Записывает изменения в файл, указанный |outputFilePath| Параметр. FileHandler::Observer будет вызываться при успешном выполнении или сбое. Если дисковое пространство выходного файла недостаточно, функция FileHandler::CommitAsync может создать поврежденные файлы. В этом случае удалите поврежденные файлы и измените размер диска или выберите другой диск перед повтором операции.

Функция CommitAsync

Записывает изменения в поток, указанный |outputStream| Параметр. |outputStream| не должно совпадать с входным потоком, используемым для создания обработчика. FileHandler::Observer будет вызываться при успешном выполнении или сбое. Если дисковое пространство выходного файла недостаточно, функция FileHandler::CommitAsync может создать поврежденные файлы. В этом случае удалите поврежденные файлы и измените размер диска или выберите другой диск перед повтором операции.

Функция IsModified

Проверяет наличие изменений для фиксации файла. Изменения не записываются в файл до вызова CommitAsync.

Функция GetDecryptedTemporaryFileAsync

Возвращает путь к временному файлу (который будет удален по возможности) — представляющий расшифрованное содержимое. FileHandler::Observer будет вызываться при успешном выполнении или сбое.

Функция GetDecryptedTemporaryStreamAsync

Возвращает поток, представляющий расшифрованное содержимое. FileHandler::Observer будет вызываться при успешном выполнении или сбое.

Функция NotifyCommitSuccessful

Вызывается при фиксации изменений на диске.

Параметры:

  • actualFilePath: фактический путь к файлу вывода

Запускает событие аудита

Исключения

  • NotSupportedError: если используется только обработчик защиты, и обработчик политики не найден.

Функция GetOutputFileName

Вычисляет имя и расширение выходного файла на основе исходного имени файла и накопленных изменений.