ARTCipherParams

Objective-C

@interface ARTCipherParams : NSObject <ARTCipherParamsCompatible>

Swift

class ARTCipherParams : NSObject, ARTCipherParamsCompatible

Sets the properties to configure encryption for an ARTRestChannel or ARTRealtimeChannel object.

  • The algorithm to use for encryption. Only AES is supported and is the default value.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull algorithm;

    Swift

    var algorithm: String { get }
  • key

    The private key used to encrypt and decrypt payloads.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSData *_Nonnull key;

    Swift

    var key: Data { get }

  • The length of the key in bits; for example 128 or 256.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger keyLength;

    Swift

    var keyLength: UInt { get }

  • The cipher mode. Only CBC is supported and is the default value.

    Declaration

    Objective-C

    @property (readonly, getter=getMode) NSString *_Nonnull mode;

    Swift

    var mode: String { get }
  • iv

    Undocumented

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSData *iv

    Swift

    var iv: Data? { get }

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithAlgorithm:(NSString *)algorithm key:(id<ARTCipherKeyCompatible>)key iv:(NSData *_Nullable)iv;

    Swift

    init(algorithm: String, key: any ARTCipherKeyCompatible, iv: Data?)