SosAvailability

Class Overview

API used for monitoring the SOS system for agent availability updates. Availability checks should usually follow this pattern:

1. Call addListener(Listener) to add a listener object (typically an activity).
2. Call startPolling(Context, String, String, String) to start polling for availability changes.
3. React to calls to onSosAvailabilityChange(Status) to enable or disable SOS-related functionality.
4. When the listener object is no longer needed, call removeListener(Listener) (e.g. in the activity's onDestroy() method.)
5. Call stopPolling() if you no longer need to monitor SOS availability.

Usage Example

  
    public class MyActivity extends Activity implements SosAvailability.Listener {

      @Override
      public void onCreate (Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Add ourselves as an availability listener.
        SosAvailability.addListener(this);

        // Update the UI based on the last known availability status, if any.
        updateAvailability(SosAvailability.getStatus());

        // Start polling to receive any change in the status.
        if (!SosAvailability.isPolling()) {
          SosAvailability.startPolling(this, organizationId, deploymentId, liveAgentPod);
        }
      }

      @Override
      public void onDestroy () {
        super.onDestroy();
        // Always makes sure to remove the listener.
        SosAvailability.removeListener(this);

        // Stop polling if appropriate. Don't do this if you want polling to continue in the
        // background.
        SosAvailability.stopPolling();
      }

      @Override
      public void onSosAvailabilityChange (SosAvailability.Status status) {
        updateAvailability(status);
      }

      private void updateAvailability (SosAvailability.Status status) {
        // Update the UI to reflect the availability status here.
      }
    }
  
 

Summary

[Expand] Inherited Methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()