Documentation

    Configuration Options

    You can customize the behavior of the Co-Browsing API React Native SDK through configuration options.

    Setting Configuration

    Pass options when calling initialize():

    import Upscope from '@upscopeio/react-native-sdk';

Upscope.initialize({
  apiKey: 'YOUR_API_KEY',
  requireAuthorizationForSession: true,
  authorizationPromptTitle: 'Screen Sharing Request',
  authorizationPromptMessage: 'Allow {%agentName%|Support} to view your screen?',
  endOfSessionMessage: 'Thanks for using screen sharing!',
  translationsYes: 'Allow',
  translationsNo: 'Decline',
});

    Configuration Options

    Session Authorization

    OptionTypeDefaultDescription
    requireAuthorizationForSessionbooleantrueRequire user permission before screen sharing starts.
    authorizationPromptTitlestring(Set through the admin interface)Custom title for the authorization dialog.
    authorizationPromptMessagestring(Set through the admin interface)Custom message for the authorization dialog. Supports placeholders.

    Message Placeholders

    The authorizationPromptMessage supports these placeholders:

    • {%agentName%|fallback} - Agent's name with a fallback if unavailable
    • {%currentDomain%} - App name

    Example:

    authorizationPromptMessage: '{%agentName%|Our support team} would like to view your screen',

    UI Display

    OptionTypeDefaultDescription
    showBannerboolean(Set through the admin interface)Show an in-app banner while a session is active.
    showTerminateButtonboolean(Set through the admin interface)Show a button in the banner to end the screen sharing session.
    endOfSessionMessagestring(Set through the admin interface)Message displayed when the session ends.
    stopSessionTextstring(Set through the admin interface)Custom text for the stop session button.

    Remote Control

    OptionTypeDefaultDescription
    allowRemoteClickbooleantrueAllow agents to remotely tap on the screen.
    allowRemoteScrollbooleantrueAllow agents to remotely scroll the screen.
    requireControlRequestboolean(Set through the admin interface)Require user approval before agents can use remote input.
    controlRequestTitlestring(Set through the admin interface)Custom title for the control request prompt.
    controlRequestMessagestring(Set through the admin interface)Custom message for the control request prompt.

    Lookup Code

    OptionTypeDefaultDescription
    enableLookupCodeOnShakeboolean(Set through the admin interface)Show lookup code popup when device is shaken.
    lookupCodeKeyTitlestring(Set through the admin interface)Custom title for the shake detection alert.
    lookupCodeKeyMessagestring(Set through the admin interface)Custom message for shake alert. Supports {%lookupCode%} placeholder.

    Localization Strings

    OptionTypeDescription
    translationsYesstringCustom text for "Allow" button in authorization prompt.
    translationsNostringCustom text for "Deny" button in authorization prompt.
    translationsOkstringCustom text for "OK" button.

    System Options

    OptionTypeDescription
    autoConnectbooleanAutomatically connect on initialization. Default: true (set through the admin interface).
    regionstringServer region for connections.

    Full Example

    Upscope.initialize({
  apiKey: 'YOUR_API_KEY',
  autoConnect: true,
  requireAuthorizationForSession: true,
  authorizationPromptTitle: 'Screen Share',
  authorizationPromptMessage: '{%agentName%|Support} wants to help you',
  showBanner: true,
  showTerminateButton: true,
  endOfSessionMessage: 'Session ended. Thank you!',
  stopSessionText: 'End Session',
  allowRemoteClick: true,
  allowRemoteScroll: true,
  enableLookupCodeOnShake: true,
  lookupCodeKeyTitle: 'Your Code',
  lookupCodeKeyMessage: 'Share this code: {%lookupCode%}',
  translationsYes: 'Yes, share',
  translationsNo: 'No thanks',
  translationsOk: 'Got it',
  region: 'us-east',
});