ARTClientInformation

Objective-C

@interface ARTClientInformation : NSObject

Swift

class ARTClientInformation : NSObject

Provides information about the Ably client library and the environment in which it’s running.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Returns the default key-value entries that the Ably client library uses to identify itself, and the environment in which it’s running, to the Ably service. Its keys are the names of the software components, and its values are their optional versions. The full list of keys that this method might return can be found here. For example, users of the ably-cocoa client library can find out the library version by fetching the value for the "ably-cocoa" key from the return value of this method.

    Declaration

    Objective-C

    @property (class, readonly) NSDictionary<NSString *, NSString *> *_Nonnull agents;

    Swift

    class var agents: [String : String] { get }

  • Returns the Agent library identifier. This method should only be used by Ably-authored SDKs.

    Declaration

    Objective-C

    + (nonnull NSString *)agentIdentifierWithAdditionalAgents:
    (nullable NSDictionary<NSString *, NSString *> *)additionalAgents;

    Swift

    class func agentIdentifier(withAdditionalAgents additionalAgents: [String : String]?) -> String

    Parameters

    additionalAgents

    A set of additional entries for the Agent library identifier. Its keys are the names of the agents, and its values are their optional versions. Pass ARTClientInformationAgentNotVersioned as the dictionary value for an agent that does not have a version.

    Return Value

    The Agent library identifier.