Resources

< Back to JavaDoc

The following resources are available to be overwritten by applications.

Colors

Resource Name Default Value Description
sos_drawing_color
#fff44336 The color of annotations when the agent draws on screen
sos_audio_level_mute
#FFFFFF Color of the mute icon in the audio level meter
sos_fab_unselected_background
#333333 Background color used for unselected FABs on the Camera UI.
sos_fab_unselected_icon
#ffffff Icon color used for unselected FABs on the Camera UI.
sos_hangup_icon
#e74c3c Icon color used for unselected FABs on the Camera UI.
sos_video_text
#ffffff Text color displayed under FABs on the Camera UI.

Dimensions

Resource Name Default Value Description
sos_border_radius
1.5dp
sos_video_screen_margin
16dp
sos_video_message_height
135dp
sos_video_message_text_size
16sp
sos_video_message_alt_text_size
14sp
sos_video_message_info_icon_size
28dp
sos_agent_container_diameter
134dp The diameter of the round agent container frame (dp)
sos_agent_container_elevation
8dp The elevation of the agent UI
sos_onboarding_dialog_width
315.8dp The width of the Onboarding and Permissions dialogs.
sos_onboarding_header_height
60dp The height of the SOS header on the Onboarding and Permissions dialogs.
sos_onboarding_cancel_button_width
35dp The width of the cancel button displayed on the Onboarding and Permissions dialogs.
sos_onboarding_cancel_button_height
35dp The height of the cancel button displayed on the Onboarding and Permissions dialogs.
sos_onboarding_cancel_button_margin
12dp The margin around the cancel button displayed on the Onboarding and Permissions dialogs.
sos_onboarding_header_label_text_size
8pt The size of the header text that is displayed on the Onboarding and Permissions dialogs.
sos_onboarding_text_size
7pt The size of the body text that is displayed on the Onboarding and Permissions dialogs.
sos_onboarding_carousel_indicator_diameter
12dp The diameter of each carousel page indicator.
sos_onboarding_carousel_indicator_padding
5dp The padding around each carousel page indicator.
sos_onboarding_carousel_indicator_group_margin
10dp The margin around the carousel indicator group.
sos_onboarding_carousel_card_margin
10dp The margin around the default text presented in a carousel card.
sos_onboarding_carousel_default_text_size
8pt The text size for the default text presented in a carousel card.
sos_onboarding_button_padding
18dp The padding around the buttons on the Onboarding and Permissions dialogs.
sos_onboarding_button_margin
12dp The margin around the buttons on the Onboarding and Permissions dialogs.
sos_permissions_header_image_height
136.3dp The image height of the header image displayed on the Permissions dialog.
sos_permissions_message_padding
15dp The padding around the message displayed on the Permissions dialog.
sos_permissions_message_margin
8dp The margin around the message displayed on the Permissions dialog.
sos_permissions_button_icon_padding
12dp The padding around the icons displayed on the permissions buttons on the Permissions dialog.
sos_video_activity_audio_margin
8dp
sos_video_activity_audio_size
40dp
sos_fab_default_size
66dp
sos_fab_default_icon_size
24dp
sos_fab_elevation
8dp
sos_elevation
8dp
sos_video_button_context
12sp The size of the text under the video buttons (mute, end session, pause, etc)
sos_video_container_status_text_padding
8dp

Integers

Resource Name Default Value Description
sos_button_hide_timeout
4000 Delay hiding the round agent container buttons when they are showing (in ms)
sos_drawing_width
5 The width of the agent screen annotations (in dp)
sos_context_message_duration
3500 The duration that the radial container will display context messages
sos_video_dock_hide_timeout
5000 The duration the video dock will stay on the screen before hiding.

Strings

Resource Name Default Value Description
sos_agent_name
Agent The default name for the agent. Once we start a session this will be overwritten if set
sos_title
Salesforce SOS The title we present for any UI element that has a title, such as one of our dialogs
sos_connect_prompt
You are about to start an SOS session. You will be able to talk and screen share with an Agent in real time. Are you ready to experience the future of customer service? The dialog body we present when prompting to start an SOS session
sos_connect_positive
OK The positive choice for the start session prompt (saying yes to the dialog)
sos_connect_negative
Cancel The negative choice for the start session prompt (saying no to the dialog)
sos_continue_waiting_prompt
All agents are currently busy.\nContinue waiting? The dialog body we present when asking a customer if they would like to continue waiting for a session
sos_continue_waiting_positive
OK The positive choice for the continue waiting prompt (saying yes to the dialog)
sos_continue_waiting_negative
Quit The negative choice for the continue waiting prompt (saying no to the dialog)
sos_disconnect_prompt
Disconnect from the session? The dialog body we present when confirming that a user would like to end their session (after hitting an end session button)
sos_disconnect_positive
OK The positive choice for the disconnect prompt (saying yes to the dialog)
sos_disconnect_negative
Cancel The negative choice for the disconnect prompt (saying no to the dialog)
sos_network_test
Testing Network Connection The dialog body we present while the network test is running
sos_network_test_error
We are unable to conduct a network test. Unfortunately we cannot guarantee an awesome SOS customer experience. Would you like to continue anyway? The dialog body we present if the network test encounters an error
sos_end_session_error
The SOS session has ended because of an error. The Toast body we present when the session ends due to error
sos_end_session_timeout
The SOS session has timed out waiting for a connection. The Toast body we present when the session times out waiting for a connection
sos_end_session_local
You have ended the SOS session. The Toast body we present when the customer successfully ends their session
sos_end_session_remote
The Agent has ended the SOS session. The Toast body we present when the agent ends the SOS Session
sos_end_session_unknown
The SOS session has ended for an unknown reason. The Toast body we present when the session ends for an unknown reason (such as a 500 server error)
sos_end_session_no_agent
No agents are currently available. Please try again later. The Toast body we present when we cannot start a session due to no agents being online
sos_end_session_insufficient_network
Network not able to support SOS, please try again later. The Toast body we present when we cannot start a session due to insufficient network conditions
sos_end_session_network_lost
The SOS session ended because of a lost network connection. The Toast body we present when the network connection is lost during a session
sos_session_is_paused
Session paused The notification message used when a session is paused
sos_session_is_paused_alt
(agent cannot see screen) The alternate notification message used when a session is paused
sos_agent_is_paused
Session on hold The notification message used when the agent has paused the session
sos_agent_is_paused_alt
(agent has paused session) An alternate notification message used when the agent has paused the session.
sos_session_is_active
Speaking to SOS Agent. The notification message used when a session is active
sos_initializing_session
Initializing… The notification message used when a session is starting up
sos_waiting_for_agent
Waiting for an agent… The notification message used when the customer is ready to start a session, but still waiting for the agent to join
sos_agent_joining
Agent now joining… The notification message used when the agent is in the process of joining the SOS session
sos_waiting_for_reconnect
Waiting for agent to reconnect. Session will end automatically in %d seconds. The dialog message used when the agent unexpectedly disconnects
sos_reconnect_negative
End session The dialog option presented when the agent disconnects, asking the user if they would like to end the session
sos_reconnecting
Reconnecting… The notification message used when reconnecting to a session
sos_recording
recording Text overlayed on the agent container when the SOS session is being recorded
sos_default_notification_subtext
The SOS notification subtext. By default this is not used
sos_service_notification_channel_id
sos_service_channel The Notification Channel ID used when posting the foreground service notification used by SOS on devices running Android Oreo and later. Not translatable.
sos_service_notification_channel_name
SOS Service The name of the Notification Channel used when posting the foreground service notification used by SOS on devices running Android Oreo and later.
sos_notif_resume
Go to Session The label for the go back to session notification action (ie go back to the application the session is running in)
sos_notif_end
End Session The label for the end session notification action
sos_masking_sharing_paused
You are typing in a masked field. The Toast message presented when screen sharing stops due to the customer typing in a masked field
sos_masking_sharing_resumed
The session is active again. The Toast message presented when screen sharing resumes after the masked field the customer is typing in loses focus
sos_two_way_video_disabled
Two-way video is disabled. The Toast message presented when trying to start Two-way video sharing but the SosConfiguration does not allow it
sos_unexpected_camera_error
Unable to use your camera. The Toast message presented when we are unable to access the device camera
sos_start_camera_share
Syncing camera with agent… The Toast message displayed to the user when he starts sharing his camera (radial/classic UI only)
sos_start_screen_share
Syncing screen with agent… The Toast message displayed to the user when he starts sharing his screen (radial/classic UI only)
sos_session_on_hold
Your SOS session is on hold. The Toast message presented when the session is put on hold
sos_session_off_hold
Your SOS session has resumed. The Toast message presented when the session is taken off hold
sos_ui_status_initializing
Initializing Status message displayed when the session is initializing
sos_ui_status_network_test
Network test Status message displayed when the session is testing network speed
sos_ui_status_queued
In queue Status message displayed when the session is in the agent queue
sos_ui_status_connecting
Connecting Status message displayed when the session is connecting to an agent
sos_ui_status_audio_muted
Mic muted Status message displayed when the user's audio is muted
sos_ui_status_masked_fields_exposed
Field Masked.\nScreen hidden from agent Status message displayed when masked fields are exposed
sos_ui_status_screen_sharing_disabled
Screen sharing is disabled Status message displayed when screen sharing is disabled
sos_ui_status_agent_video_muted
Agent video paused Status message displayed when agent video is paused
sos_ui_status_session_recording
recording Message displayed when the session is being recorded
sos_ui_status_network_poor
Poor Network Message displayed when the connection strength is poor
sos_onboarding_header_label
SOS The header text shown at the top of the onboarding UI during session start.
sos_onboarding_cancel_button_content_description
Cancel The content description of the cancel button on the SOS onboarding UI. For accessibility.
sos_permissions_header_image_content_description
SOS is requesting device permissions. The content description of the permissions header image. For accessibility.
sos_permissions_message
We need something before we can connect you with an agent… The message displayed on the SOS permissions dialog
sos_permissions_microphone
Allow Microphone Access The label applied to the Microphone permission button on the SOS permissions dialog.
sos_permissions_camera
Allow Camera Access The label applied to the Camera permission button on the SOS permissions dialog.
sos_onboarding_accept_button_label
OK, GOT IT The button text displayed on the onboarding UI's Accept button
sos_onboarding_carousel_intro_text
You are about to co-browse your app with an expert who can see and draw on your screen.\nDon’t worry, they can’t see you :) The text displayed on the first default card of the onboarding dialog.
sos_onboarding_carousel_dragging_text
Drag the SOS window anywhere on your screen or tap to reveal controls. The text displayed on the second default card of the onboarding dialog.
sos_onboarding_carousel_controls_text
Tap to reveal controls to mute mic, pause screen share, and end session. The text displayed on the third default card of the onboarding dialog.
sos_permissions_denied_message
SOS requires device permissions that have been denied. Please visit the App Permissions screen in your device settings to allow them. The message shown to the user when they deny access to a permission and have selected the 'Never ask again' box.
sos_permissions_denied_button_label
End Session The button label shown on the dialog when the user has denied access to a permission.
sos_video_gesture_info_camera_swap
Double tap to flip camera Text displayed on the Video UI to describe the camera swap gesture.
sos_video_gesture_info_flashlight
Tap & hold anywhere to toggle flashlight Text displayed on the Video UI to describe the flashlight gesture.
sos_video_gesture_info_dismiss
GOT IT Text displayed on the dismissal button for gesture information on the Video UI.
sos_video_tip_icon_content_description
Helpful Tip Content description for the tip icon (i) displayed on the Video UI.
sos_end_session_connection_timeout
The session has timed out during connection. The toast shown whenever the session times out trying to connect to the agent
sos_video_session_paused_header
Session Paused The header of the message shown to the user when they have paused the session in camera mode
sos_video_agent_paused_header
Session on hold The header of the message shown to the user when the agent has paused the session in camera mode
sos_video_agent_paused_info
Agent has paused session Information message shown to the user when the agent has paused the session in camera mode
sos_video_session_paused_info
No one can see or hear you The text that appears below the header whenever the session is paused in camera mode
sos_video_pause_label
Pause The label under the pause/resume button in the video activity when the session is NOT paused.
sos_video_resume_label
Resume The label under the pause/resume button in the video activity when the session is PAUSED.
sos_video_mute_label
Mute The label under the mute/unmute button in the video activity when the session is NOT muted.
sos_video_unmute_label
Unmute The label under the mute/unmute button in the video activity when the session is MUTED.
sos_video_end_label
End The label under the end session button in the video activity.
sos_video_expand_agent_video
Expand agent video The label applied to the shrunk Agent video container during Camera sharing.
sos_video_expand_camera_video
Expand local camera video The label applied to the shrunk local camera video container during Camera sharing.
sos_video_back_to_app_label
Back to app Header that appears in the video activity that describes to the user they can click the header to return to the app. Essentially, this acts as a button.
sos_ui_status_flashlight_on
Flashlight On Label that describes a flashlight icon. Indicates that the phone flashlight is on

< Back to JavaDoc