ARTDefault

Objective-C

@interface ARTDefault : NSObject

Swift

class ARTDefault : NSObject

Represents default library settings.

  • Undocumented

    Declaration

    Objective-C

    + (NSString *)apiVersion;

    Swift

    class func apiVersion() -> String

  • Undocumented

    Declaration

    Objective-C

    + (NSString *)libraryVersion;

    Swift

    class func libraryVersion() -> String

  • Undocumented

    Declaration

    Objective-C

    + (NSArray<NSString *> *)fallbackHosts;

    Swift

    class func fallbackHosts() -> [String]

  • Undocumented

    Declaration

    Objective-C

    + (NSArray<NSString *> *)fallbackHostsWithEnvironment:(NSString *_Nullable)environment;

    Swift

    class func fallbackHosts(withEnvironment environment: String?) -> [String]

  • Undocumented

    Declaration

    Objective-C

    + (NSString*)restHost;

    Swift

    class func restHost() -> String

  • Undocumented

    Declaration

    Objective-C

    + (NSString*)realtimeHost;

    Swift

    class func realtimeHost() -> String

  • Undocumented

    Declaration

    Objective-C

    + (int)port;

    Swift

    class func port() -> Int32

  • Undocumented

    Declaration

    Objective-C

    + (int)tlsPort;

    Swift

    class func tlsPort() -> Int32

  • Default in seconds of requested time to live for the token.

    Declaration

    Objective-C

    + (NSTimeInterval)ttl;

    Swift

    class func ttl() -> TimeInterval

  • When the client is in the ARTRealtimeConnectionState.ARTRealtimeDisconnected state, once this TTL has passed, the client should change the state to the ARTRealtimeConnectionState.ARTRealtimeSuspended state signifying that the state is now lost i.e. channels need to be reattached manually.

    Note that this default is override by any ARTConnectionDetails.connectionStateTtl of the ARTProtocolMessageConnected of the ARTProtocolMessage.

    Declaration

    Objective-C

    + (NSTimeInterval)connectionStateTtl;

    Swift

    class func connectionStateTtl() -> TimeInterval

  • Timeout for the wait of acknowledgement for operations performed via a realtime connection, before the client library considers a request failed and triggers a failure condition. Operations include establishing a connection with Ably, or sending a ARTProtocolMessageHeartbeat, ARTProtocolMessageConnect, ARTProtocolMessageAttach, ARTProtocolMessageDetach or ARTProtocolMessageClose request. It is the equivalent of ARTClientOptions.httpRequestTimeout but for realtime operations, rather than REST. The default is 10 seconds.

    Declaration

    Objective-C

    + (NSTimeInterval)realtimeRequestTimeout;

    Swift

    class func realtimeRequestTimeout() -> TimeInterval

  • The maximum size of messages that can be published in one go. For realtime publishes, the default can be overridden by the maxMessageSize in the ARTConnectionDetails object.

    Declaration

    Objective-C

    + (NSInteger)maxMessageSize;

    Swift

    class func maxMessageSize() -> Int

Private

  • Undocumented

    Declaration

    Objective-C

    + (void)setConnectionStateTtl:(NSTimeInterval)value;

    Swift

    class func setConnectionStateTtl(_ value: TimeInterval)

  • Undocumented

    Declaration

    Objective-C

    + (void)setMaxMessageSize:(NSInteger)value;

    Swift

    class func setMaxMessageSize(_ value: Int)

  • Undocumented

    Declaration

    Objective-C

    + (NSInteger)maxSandboxMessageSize;

    Swift

    class func maxSandboxMessageSize() -> Int

  • Undocumented

    Declaration

    Objective-C

    + (NSInteger)maxProductionMessageSize;

    Swift

    class func maxProductionMessageSize() -> Int