ARTPushChannelSubscription

Objective-C

@interface ARTPushChannelSubscription : NSObject

Swift

class ARTPushChannelSubscription : NSObject

Contains the subscriptions of a device, or a group of devices sharing the same clientId, has to a channel in order to receive push notifications.

  • The unique ID of the device.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *deviceId;

    Swift

    var deviceId: String? { get }

  • The ID of the client the device, or devices are associated to.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *clientId;

    Swift

    var clientId: String? { get }

  • The channel the push notification subscription is for.

    Declaration

    Objective-C

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

    Swift

    var channel: String { get }

  • Creates an ARTPushChannelSubscription object for a channel and single device.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDeviceId:(nonnull NSString *)deviceId
                                 channel:(nonnull NSString *)channelName;

    Swift

    init(deviceId: String, channel channelName: String)

    Parameters

    deviceId

    The unique ID of the device.
    channelName

    The channel name.

    Return Value

    An ARTPushChannelSubscription object.

  • Creates an ARTPushChannelSubscription object for a channel and group of devices sharing the same clientId.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithClientId:(nonnull NSString *)clientId
                                 channel:(nonnull NSString *)channelName;

    Swift

    init(clientId: String, channel channelName: String)

    Parameters

    clientId

    The ID of the client.
    channelName

    The channel name.

    Return Value

    An ARTPushChannelSubscription object.