Package io.ably.lib.types
See: Description
-
Enum Summary Enum Description Type Action Flag Action Describes the possible actions members in the presence set can emit. AnnotationAction Enumerates the possible values of the action field of an Annotation MessageAction Granularity Describes the interval unit over which statistics are gathered. ChannelMode Describes the possible flags used to configure client capabilities, using ChannelOptions. -
Class Summary Class Description RegistrationToken MessageSerializer MessageReader: internal Utility class to convert response bodies in different formats to Message and Message arrays. SummaryClientIdList The summary entry for aggregated annotations that use the flag.v1 aggregation method; also the per-name value for some other aggregation methods. Serializer Summary A summary of all the annotations that have been made to the message. PublishResult Contains the result of a publish operation. PublishResponse Contains the responses from a PublishResponsepublish request. ConnectionDetails Contains any constraints a client should adhere to and provides additional metadata about a io.ably.lib.realtime.Connection, such as if a request to publish a message that exceeds the maximum message size should be rejected immediately without communicating with Ably. ActionSerializer AuthDetails Contains the token string used to authenticate a client with Ably. ProtocolMessage A message sent and received over the Realtime protocol. ActionSerializer Serializer PresenceMessage A class representing an individual presence update to be sent or received via the Ably Realtime service. ErrorInfo A generic Ably error object that contains an Ably-specific status code, and a generic status code. DecodingContext ChannelOptions Passes additional properties to a io.ably.lib.rest.Channel or io.ably.lib.realtime.Channel object, such as encryption, ChannelMode and channel parameters. Serializer MessageExtras HttpPaginatedResponse A superset of PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it. BaseMessage AsyncHttpPaginatedResponse ChannelProperties Describes the properties of the channel state. ClientOptions Passes additional client-specific properties to the io.ably.lib.rest.AblyRest or the io.ably.lib.realtime.AblyRealtime. SummaryTotal AnnotationSerializer StatsReader StatsReader: internal Utility class to convert response bodies in different formats to Stats data. Serializer MessageVersion Contains the details regarding the current version of the message - including when it was updated and by whom. DeltaExtras Serializer ActionSerializer Annotation Serializer MessageAnnotations Contains information about annotations associated with a particular message. Capability A class representing an Ably Capability, providing convenience methods to simplify creation of token requests ConnectionTypes Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types. MessageCount Contains the aggregate counts for messages and data transferred. MessageCategory MessageTypes Contains a breakdown of summary stats data for different (channel vs presence) message types. MessageTraffic Contains a breakdown of summary stats data for traffic over various transport types. RequestCount Contains the aggregate counts for requests made. ResourceCount Contains the aggregate data for usage of a resource in a specific scope. ProcessedCount ProcessedMessages PushedMessages Details the stats on push notifications. Stats Contains application statistics for a specified time interval and time period. ProtocolSerializer MessageOperation Represents metadata about a message operation (update/delete). Batch Sets the channel names and message contents to publishBatch. Serializer Message Contains an individual message that is sent to, or received from, Ably. ErrorResponse Map ProxyOptions PresenceSerializer PresenceSerializer: internal Utility class to convert response bodies in different formats to PresenceMessage and PresenceMessage arrays. UpdateDeleteResult Contains the result of an update or delete message operation. HostFailedException AblyException An exception type encapsulating an Ably error code RecoveryKeyContext MessageDecodeException Special AblyException for message decoding problems SummaryClientIdCounts The per-name value for the multiple.v1 aggregation method. Param A class encapsulating a key/value pair -
Interface Summary Interface Description PaginatedResult Contains a page of results for message or presence history, stats, or REST presence requests. NonRetriableTokenException Implement this marker interface in your exception class if the token auth operation should not be retried. AsyncPaginatedResult A type that represents a page of results from a paginated query. Callback An interface allowing a client to be notified of the outcomeof an asynchronous operation. BasePaginatedResult A type that represents a page of results from a paginated query. ReadOnlyMap Exposes a subset of the Map interface, providing read only access only, removing mutating interfaces. Callback An interface allowing a client to be notified of the outcome of an asynchronous operation.