EncryptionConfig class

Configures built-in encryption mode and key.

Annotations

• @JsonSerializable.new(explicitToJson: true, includeIfNull: false)

Properties

datastreamEncryptionEnabled → bool?

Whether to enable data stream encryption: true : Enable data stream encryption. false : (Default) Disable data stream encryption.

final

encryptionKdfSalt → Uint8List?

Salt, 32 bytes in length. It is recommended to generate the salt on the server side using OpenSSL. This parameter takes effect only when using aes128Gcm2 or aes256Gcm2 encryption modes. In this case, ensure that the value provided for this parameter is not all 0.

final

encryptionKey → String?

Built-in encryption key, of type String, with no length limit. It is recommended to use a 32-byte key. If this parameter is not specified or set to NULL, built-in encryption cannot be enabled, and the SDK returns error code -2.

final

encryptionMode → EncryptionMode?

Built-in encryption mode. See EncryptionMode. It is recommended to use aes128Gcm2 or aes256Gcm2 encryption modes. These two modes support salt and offer higher security.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited