The Reachability Indicator feature of Programmable Chat provides visibility into whether a User is online or offline within the Chat Service instance context. This feature also provides the User's reachability by Push Notification within the Chat Service instance.
Reachability state is automatically updated and synchronized by the Chat service, provided the feature is enabled. The feature is enabled on a "per Service instance" basis.
Note: It is important to note that Users exist within the scope of a Chat Service instance. Thus, the Reachability indicators are also within the same scope.
Each Service instance can have Reachability enabled or disabled. The default is disabled. Reachability state will not be updated if the feature is disabled for a given Service instance. Once enabled, the state will update and synchronize.
You must set the
ReachabilityEnabled property using the
Services REST resource to configure the Reachability Indicator feature.
To see if the feature is enabled for a Service instance, please refer to the
reachability_enabled property of the Service REST resource representation.
If you choose to enable Reachability Indicators and later wish to return to
disabled, set the
ReachabilityEnabled back to
The Reachability indicators are exposed for Users in two places:
- REST API - Users resource
- Client SDKs - User and UserDescriptor objects
The following read-only properties within the Users REST resource provide Reachability information for Users:
These properties are set by the Chat system if the Reachability Indicator feature is enabled for a User's Service instance.
Note: These properties can be
null under the following conditions:
- The Reachability Indicator feature is disabled for the Service instance
- The User has not been online since the Reachability indicator has been enabled
LIST GETresource representations only have a
falsevalue for specific GET requests
Please see the REST Users resource documentation for more information.
Within the Chat Client SDKs, the Reachability Indicator properties are exposed in the
Real-time updates to other Users' Reachability Indicator states are communicated via the
update event mechanism for subscribed User objects. Reachability on UserDescriptor objects is a snapshot in time. Please see the specific SDK API documentation for details, as each SDK/platform handles this
update a little differently.
An indicator of your Service instance's Reachability status (
reachability_enabled ) is also exposed at the SDK client level.
The read only client SDK properties exposed are:
Note: The above are representations. The specifics of how these properties are accessed are distinct for each language/SDK.
Note: These user properties are
read only and cannot be set. Chat will update these settings and synchronize them as necessary. The Service REST resource manages the Service-level Reachability feature.