Clase FileHandler

Interfaz para todas las funciones de control de archivos.

Resumen

Miembros Descripciones
public std::shared_ptr<ContentLabel GetLabel> () Comienza a recuperar la etiqueta de confidencialidad del archivo.
public std::vector<std::p air<std::string, std::string>> GetProperties(uint32_t version) Recupera las propiedades del archivo según la versión.
public std::shared_ptr<ProtectionHandler> GetProtection() Comienza a recuperar la directiva de protección del archivo.
public void RegisterContentForTrackingAndRevocationAsync(bool isOwnerNotificationEnabled, const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>&context) Registre el contenido para realizar el seguimiento y la revocación.
public void RevokeContentAsync(const std::shared_ptr<ProtectionEngine::Observer>& observer, const std::shared_ptr<void>& context) Realice la revocación del contenido.
public void ClassifyAsync(const std::shared_ptr<void>& context) Ejecuta las reglas en el controlador y devuelve la lista de acciones que se van a ejecutar.
public void InspectAsync(const std::shared_ptr<void>&context) Cree un objeto inspector de archivos, que se usa para recuperar el contenido del archivo de los formatos de archivo compatibles.
public void SetLabel(const std::shared_ptr<Label>&label, const LabelingOptions&labelingOptions, const Protection Configuración&protection Configuración) Establece la etiqueta de confidencialidad en el archivo.
public void DeleteLabel(const LabelingOptions& labelingOptions) Elimina la etiqueta de confidencialidad del archivo.
public void SetProtection(const std::shared_ptr<ProtectionDescriptor& protectionDescriptor>, const Protection Configuración& protection Configuración) Establece los permisos personalizados o basados en plantillas (según protectionDescriptor-GetProtectionType>) en el archivo.
public void SetProtection(const std::shared_ptr<ProtectionHandler& protectionHandler>) Establece la protección en un documento mediante un controlador de protección existente.
public void RemoveProtection() Quita la protección del archivo. Si el formato de archivo original no admite el etiquetado, la etiqueta se perderá cuando se quite la protección. Cuando el formato nativo admite el etiquetado, se mantienen los metadatos de la etiqueta.
public void CommitAsync(const std::string& outputFilePath, const std::shared_ptr<void>&context) Escribe los cambios en el archivo especificado por el parámetro outputFilePath.
public void CommitAsync(const std::shared_ptr<Stream>& outputStream, const std::shared_ptr<void>& context) Escribe los cambios en la secuencia especificada por el parámetro outputStream.
public bool IsModified() Comprueba si hay cambios para confirmar en el archivo.
public void GetDecryptedTemporaryFileAsync(const std::shared_ptr<void>& context) Devuelve una ruta de acceso a un archivo temporal (que se eliminará si es posible): que representa el contenido descifrado.
public void GetDecryptedTemporaryStreamAsync(const std::shared_ptr<void>& context) Devuelve una secuencia, que representa el contenido descifrado.
public void NotifyCommitSuccessful(const std::string& actualFilePath) Para llamar a cuando se han confirmado los cambios en el disco.
public std::string GetOutputFileName() Calcula el nombre de archivo de salida y la extensión en función del nombre de archivo original y los cambios acumulados.

Miembros

Función GetLabel

Comienza a recuperar la etiqueta de confidencialidad del archivo.

Excepciones

  • NotSupportedError: cuando un motor de protección solo está en uso y no se encuentra ningún controlador de directivas.

Función GetProperties

Recupera las propiedades del archivo según la versión.

Función GetProtection

Comienza a recuperar la directiva de protección del archivo.

Función RegisterContentForTrackingAndRevocationAsync

Registre el contenido para realizar el seguimiento y la revocación.

Parámetros:

  • isOwnerNotificationEnabled: establézcalo en true para notificar al propietario por correo electrónico cada vez que el documento se descifra o false para no enviar la notificación.

  • observer: una clase que implementa la interfaz ProtectionHandler::Observer

  • context: contexto de cliente que se reenvía opacamente a los observadores y httpDelegate opcional

Devuelve: objeto de control asincrónico.

Función RevokeContentAsync

Realice la revocación del contenido.

Parámetros:

  • observer: una clase que implementa la interfaz ProtectionHandler::Observer

  • context: contexto de cliente que se reenvía opacamente a los observadores y httpDelegate opcional

Devuelve: objeto de control asincrónico.

Función ClassifyAsync

Ejecuta las reglas en el controlador y devuelve la lista de acciones que se van a ejecutar.

Devuelve: lista de acciones que se deben aplicar en el contenido.

Excepciones

  • NotSupportedError: cuando un motor de protección solo está en uso y no se encuentra ningún controlador de directivas.

Función InspectAsync

Cree un objeto inspector de archivos, que se usa para recuperar el contenido del archivo de los formatos de archivo compatibles.

Devuelve: un inspector de archivos.

Función SetLabel

Establece la etiqueta de confidencialidad en el archivo. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync. El método Privileged y Auto permite que la API invalide cualquier etiqueta existente Throws JustificationRequiredError al establecer la etiqueta requiere que la operación esté justificada (mediante el parámetro labelingOptions).

Excepciones

  • NotSupportedError: cuando un motor de protección solo está en uso y no se encuentra ningún controlador de directivas.

Función DeleteLabel

Elimina la etiqueta de confidencialidad del archivo. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync. El método Privileged y Auto permite que la API invalide cualquier etiqueta existente Throws JustificationRequiredError al establecer la etiqueta requiere que la operación esté justificada (mediante el parámetro labelingOptions).

Excepciones

  • NotSupportedError: cuando un motor de protección solo está en uso y no se encuentra ningún controlador de directivas.

Función SetProtection

Establece los permisos personalizados o basados en plantillas (según protectionDescriptor-GetProtectionType>) en el archivo. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync.

Función SetProtection

Establece la protección en un documento mediante un controlador de protección existente. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync.

Función RemoveProtection

Quita la protección del archivo. Si el formato de archivo original no admite el etiquetado, la etiqueta se perderá cuando se quite la protección. Cuando el formato nativo admite el etiquetado, se mantienen los metadatos de la etiqueta. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync.

Función CommitAsync

Escribe los cambios en el archivo especificado por |outputFilePath| Parámetro. Se llamará a FileHandler::Observer en caso de éxito o error. Si el espacio en disco del archivo de salida no es suficiente, la función FileHandler::CommitAsync puede generar archivos dañados. En este caso, elimine los archivos dañados y ajuste el tamaño del disco o elija otro disco antes de reintentar la operación.

Función CommitAsync

Escribe los cambios en la secuencia especificada por |outputStream| Parámetro. |outputStream| no debe ser el mismo que inputStream usado para crear el controlador. Se llamará a FileHandler::Observer en caso de éxito o error. Si el espacio en disco del archivo de salida no es suficiente, la función FileHandler::CommitAsync puede generar archivos dañados. En este caso, elimine los archivos dañados y ajuste el tamaño del disco o elija otro disco antes de reintentar la operación.

Función IsModified

Comprueba si hay cambios para confirmar en el archivo. Los cambios no se escribirán en el archivo hasta que se llame a CommitAsync.

Función GetDecryptedTemporaryFileAsync

Devuelve una ruta de acceso a un archivo temporal (que se eliminará si es posible): que representa el contenido descifrado. Se llamará a FileHandler::Observer en caso de éxito o error.

Función GetDecryptedTemporaryStreamAsync

Devuelve una secuencia, que representa el contenido descifrado. Se llamará a FileHandler::Observer en caso de éxito o error.

Función NotifyCommitSuccessful

Para llamar a cuando se han confirmado los cambios en el disco.

Parámetros:

  • actualFilePath: ruta de acceso del archivo real para el archivo de salida

Desencadena un evento audit

Excepciones

  • NotSupportedError: cuando un motor de protección solo está en uso y no se encuentra ningún controlador de directivas.

Función GetOutputFileName

Calcula el nombre de archivo de salida y la extensión en función del nombre de archivo original y los cambios acumulados.