Agent SDK
Public Attributes | List of all members
ionicsdk.filecipher.FileCipherEncryptAttributes Class Reference

Allows for extended input and output options during encryption. More...

Inheritance diagram for ionicsdk.filecipher.FileCipherEncryptAttributes:

Public Attributes

 keyidOut
 (string) The key ID (also known as the key tag)
 
 keydataOut
 (KeyData) The key bytes
 
 familyOut
 (FileCipherFamily) The file cipher family the file was encrypted with
 
 version
 (string) The file format version to encrypt with - It can be left empty to use the latest version (recommended). More...
 
 attributes
 (agent::KeyAttributesDict) The key attributes to associate with the key used to encrypt the file
 
 mutableAttributes
 (agent::KeyAttributesDict) The key mutable attributes to associate with data chunk protection key
 
 metadata
 (agent::MetadataDict) The metadata properties to send along with the HTTP request
 
 enablePortionMarking
 (boolean) Determines if portion marking is enabled. More...
 

Detailed Description

Allows for extended input and output options during encryption.

Instance Variables:
keyidOut (string): The key ID (also known as the key tag).
familyOut (FileCipherFamily): The file cipher family the file was encrypted with.
version (string): The file format version to encrypt with. It can be left empty to use the latest version (recommended).
attributes (agent::KeyAttributesDict): The key attributes to associate with the key used to encrypt the file.
metadata (agent::MetadataDict): The metadata properties to send along with the HTTP request.
mutableAttributes (agent::KeyAttributesDict): The key mutable attributes to associate with data chunk protection key.

Member Data Documentation

§ enablePortionMarking

ionicsdk.filecipher.FileCipherEncryptAttributes.enablePortionMarking

(boolean) Determines if portion marking is enabled.

§ version

ionicsdk.filecipher.FileCipherEncryptAttributes.version

(string) The file format version to encrypt with - It can be left empty to use the latest version (recommended).


The documentation for this class was generated from the following file: