ARTChannelOptions

Objective-C

@interface ARTChannelOptions : NSObject

Swift

class ARTChannelOptions : NSObject

Passes additional properties to an ARTRestChannel object, such as encryption.

  • Requests encryption for this channel when not nil, and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key). See an example.

    Declaration

    Objective-C

    @property (nonatomic, nullable) ARTCipherParams *cipher;

    Swift

    var cipher: ARTCipherParams? { get set }

  • Creates an options object using a key only.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCipherKey:
    (nonnull id<ARTCipherKeyCompatible>)key;

    Swift

    init(cipherKey key: ARTCipherKeyCompatible)

    Parameters

    key

    A private key used to encrypt and decrypt payloads.

    Return Value

    An ARTChannelOptions object.