ARTLocalDevice

Objective-C

@interface ARTLocalDevice : ARTDeviceDetails

Swift

class ARTLocalDevice : ARTDeviceDetails, @unchecked Sendable

Contains the device identity token and secret of a device. ARTLocalDevice extends ARTDeviceDetails.

  • A unique device identity token used to communicate with APNS.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) ARTDeviceIdentityTokenDetails *identityTokenDetails;

    Swift

    var identityTokenDetails: ARTDeviceIdentityTokenDetails? { get }
  • A unique device secret generated by the Ably SDK.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) ARTDeviceSecret *secret;

    Swift

    var secret: String? { get }
  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic) id<ARTDeviceStorage> storage

    Swift

    var storage: any ARTDeviceStorage { get set }
  • Undocumented

    Declaration

    Objective-C

    + (instancetype)deviceWithStorage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger;

    Swift

    convenience init(storage: any ARTDeviceStorage, logger: InternalLog?)
  • Undocumented

    Declaration

    Objective-C

    - (nullable NSString *)apnsDeviceToken;

    Swift

    func apnsDeviceToken() -> String?
  • Undocumented

    Declaration

    Objective-C

    - (void)setAndPersistAPNSDeviceToken:(nullable NSString *)deviceToken tokenType:(NSString *)tokenType;

    Swift

    func setAndPersistAPNSDeviceToken(_ deviceToken: String?, tokenType: String)
  • Undocumented

    Declaration

    Objective-C

    - (void)setAndPersistAPNSDeviceToken:(nullable NSString *)deviceToken;

    Swift

    func setAndPersistAPNSDeviceToken(_ deviceToken: String?)
  • Undocumented

    Declaration

    Objective-C

    - (void)setAndPersistIdentityTokenDetails:(nullable ARTDeviceIdentityTokenDetails *)tokenDetails;

    Swift

    func setAndPersistIdentityTokenDetails(_ tokenDetails: ARTDeviceIdentityTokenDetails?)
  • Undocumented

    Declaration

    Objective-C

    - (BOOL)isRegistered;

    Swift

    func isRegistered() -> Bool
  • Undocumented

    Declaration

    Objective-C

    - (void)resetDetails;

    Swift

    func resetDetails()
  • Undocumented

    Declaration

    Objective-C

    - (void)setupDetailsWithClientId:(nullable NSString *)clientId;

    Swift

    func setupDetails(withClientId clientId: String?)
  • Undocumented

    Declaration

    Objective-C

    + (NSString *)generateId;

    Swift

    class func generateId() -> String
  • Undocumented

    Declaration

    Objective-C

    + (NSString *)generateSecret;

    Swift

    class func generateSecret() -> String
  • Undocumented

    Declaration

    Objective-C

    + (nullable NSString *)apnsDeviceTokenOfType:(nullable NSString *)tokenType fromStorage:(id<ARTDeviceStorage>)storage;

    Swift

    class func apnsDeviceToken(ofType tokenType: String?, from storage: any ARTDeviceStorage) -> String?