Client Library Development Guide

Features spec

Page Moved

The contents of this page can now be found here on sdk.ably.com

We have also moved most of the other pages from within this Client Library Development Guide section of this site to that new location.

Test guidelines

Moved to here on sdk.ably.com

REST client library

Moved to here on sdk.ably.com

RestClient

Moved to here on sdk.ably.com

Auth

Moved to here on sdk.ably.com

Channels

Moved to here on sdk.ably.com

RestChannel

Moved to here on sdk.ably.com

Plugins

Moved to here on sdk.ably.com

PluginType

Moved to here on sdk.ably.com

VCDiffDecoder

Moved to here on sdk.ably.com

RestPresence

Moved to here on sdk.ably.com

Encryption

Moved to here on sdk.ably.com

Forwards compatibility

Moved to here on sdk.ably.com

Batch Operations

Moved to here on sdk.ably.com

Realtime client library features

Moved to here on sdk.ably.com

RealtimeClient

Moved to here on sdk.ably.com

Connection

Moved to here on sdk.ably.com

Channels

Moved to here on sdk.ably.com

RealtimeChannel

Moved to here on sdk.ably.com

RealtimePresence

Moved to here on sdk.ably.com

EventEmitter mixin / interface

Moved to here on sdk.ably.com

Incremental backoff and jitter

Moved to here on sdk.ably.com

Forwards compatibility

Moved to here on sdk.ably.com

State conditions and operations

Moved to here on sdk.ably.com

Connection.state effects on realtime operations

Moved to here on sdk.ably.com

Push notifications

Moved to here on sdk.ably.com

Activation State Machine

Moved to here on sdk.ably.com

Push device authentication

Moved to here on sdk.ably.com

Push channels

Moved to here on sdk.ably.com

LocalDevice

Moved to here on sdk.ably.com

Types

Data types

Moved to here on sdk.ably.com

Message

DeltaExtras

PresenceMessage

ProtocolMessage

PaginatedResult

HttpPaginatedResponse

TokenRequest

TokenDetails

Token string

AuthDetails

Stats

ErrorInfo

ConnectionStateChange

ChannelStateChange

Capability – API not defined yet

ConnectionDetails

ChannelProperties

ChannelDetails

ChannelStatus

ChannelOccupancy

ChannelMetrics

BatchSpec

BatchResult

BatchPublishResponse

  • (BPB1) Moved to here on sdk.ably.com
  • (BPB2) Moved to here on sdk.ably.com
    • (BPB2a) channel is the channel name which this publish request was directed to
    • (BPB2b) messageId contains the resultant message ID, if the request succeeds and is null if error is present
    • (BPB2c) error contains an ErrorInfo object if this publish request failed, and is null if it succeeded

BatchPresenceResponse

BatchPresence

MessageFilter

ReferenceExtras

Option types

Moved to here on sdk.ably.com

ClientOptions

TokenParams

Moved to here on sdk.ably.com

AuthOptions

ChannelOptions

CipherParams

CipherParamOptions

Push notifications

Moved to here on sdk.ably.com

PushChannelSubscription

DeviceDetails

DevicePushDetails

Client Library defaults

Moved to here on sdk.ably.com

Interface Definition

Moved to here on sdk.ably.com

Old specs

Moved to here on sdk.ably.com


Need help?

If you need any help with your implementation or if you have encountered any problems, do get in touch. You can also quickly find answers from our knowledge base, and blog.