Sos

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosAVListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeAVListener(SosAVListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosConnectionListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeConnectionListener(SosConnectionListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosHoldListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeHoldListener(SosHoldListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeListener(SosListener) when you no longer wish to receive events regarding SOS sessions. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosMaskingListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeMaskingListener(SosMaskingListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosNetworkTestListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeNetworkTestListener(SosNetworkTestListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Adds the given listener to all current and future SOS sessions until it is removed. Listeners may only be added once, multiple calls for a given listener will not add the listener multiple times.

See SosShareTypeListener for usage instructions.

Note that this listener instance is strongly referenced, and thus must be explicitly removed by calling removeShareTypeListener(SosShareTypeListener) when you no longer wish to receive events. Failure to remove a listener can result in a memory leak in your application.

Manually instruct the SOS framework to add a toast to the captured video stream sent to the agent.

Toasts present to the user will not be captured by default, and must be explicitly passed to the framework via this method in order to be drawn into the captured video.

Note that the Toast must not be null.

Manually instruct the SOS framework to add a dialog to the captured video stream sent to the agent. Dialogs present to the user will not be captured by default, and must be explicitly passed to the framework via this method in order to be drawn into the captured video.

Notes

The Dialog must not be null

A common pitfall is to create your dialog and immediately pass reference to Sos. In some cases this may not work. For example:

   
     MyDialogFragment myDialog = new MyDialogFragment();
     myDialog.show(getFragmentManager());
     Sos.captureExtra(myDialog.getDialog());
   
 

Will not work. Either getDialog will return null or the view will not be ready yet. In cases such as this it is recommended you wait until the DialogFragment is created to pass reference. For example:

   
     // From within `MyDialogFragment`
     @Override
     public Dialog onCreateDialog (Bundle savedInstanceState) {
       Dialog dialog = super.onCreateDialog(savedInstanceState);
       Sos.captureExtra(dialog);
       return dialog;
     }
   
 

Properly dispose of your Dialog if the Activity stops

You will observe odd behavior if you allow your Dialog to leak the app window.

   
     android.view.WindowLeaked: Activity com.yourpackage.YourActivity has leaked window com.android.internal...
   
 

Ends the currently active SOS session. If there is no active session then this method will have no effect.

Retrieve the configuration that was used to start the session.

Get the current Hold state of the session.

Retrieves the identifier for the current SOS session, if any.

Get the initial share type for the session based on your SosConfiguration and the presence of camera hardware on the end-user's device. For example, if your SosConfiguration has the default share type set to FrontFacingCamera but the user's device does not have a front camera, then the next available camera device will be chosen. If there are no camera devices present on the device, this method will return ScreenSharing. This method will return null unless the session has been started.

Retrieve the options that were used to start the session.

Retrieve the configuration that was used to start the session.

Returns the SemVer version string for the SDK.

Tells the SOS framework to hide any currently displayed keyboard bitmap.

Get whether screen sharing is currently enabled.

Checks to see if there is an active SOS session. An "active" session is one that has been started and has connected to the SOS Service, but is not yet ended.

Removes the specified listener object. Does nothing if the listener was not previously added with addAVListener(SosAVListener).

See SosAVListener for usage instructions.

Removes the specified listener object. Does nothing if the listener was not previously added with addConnectionListener(SosConnectionListener).

See SosConnectionListener for usage instructions.

Removes the specified listener object. Does nothing if the listener was not previously added with addHoldListener(SosHoldListener).

See SosHoldListener for usage instructions.

Removes the specified listener object. Does nothing if the listener was not previously added with addListener(SosListener).

Removes the specified listener object. Does nothing if the listener was not previously added with addMaskingListener(SosMaskingListener).

See SosMaskingListener for usage instructions.

Removes the specified listener object. Does nothing if the listener was not previously added with addNetworkTestListener(SosNetworkTestListener).

See SosNetworkTestListener for usage instructions.

Removes the specified listener object. Does nothing if the listener was not previously added with addShareTypeListener(SosShareTypeListener).

See SosShareTypeListener for usage instructions.

Build a new SOS session.

A session may be started by calling the start(Activity) method after all of your desired parameters have been set.

Mute/unmute the customer audio.

Set the position of the Agent's video view in the Service Cloud Console.

NOTE: The coordinate value you pass here will move the center of the agent's video container in the Service Cloud Console to that point.

This is done to allow a custom UI with a different window size to look more aligned by being center aligned. e.g. A view on the phone that is 500dp * 500dp would be substantially larger than the agent window in the Service Cloud Console. They will look more in-line with each other of the center of the views are on the same point of the screen.

If you are keeping two views in-line with each other, the recommended way to call this method looks like
Sos.setPosition(myView.getWidth() / 2 + myView.getX(), myView.getHeight() / 2 + myView.getY());

If you simply want to move the agent window, you are free to do so however you please.

Turn on/off screen sharing. The default behavior of SOS is to enable screen sharing during a session. However screen sharing can be enabled/disabled at any time.

Pause/un-pause the session. Pausing the session will halt the transmission of video and audio between the user and the agent.

Transition from the current share type to another.

Turn on/off two-way video. twoWayVideo(boolean) must be set to allow two-way video before starting the session.

Tell the SOS framework to display a bitmap representing a keyboard on the screen.