You can customize the behavior of the UserView 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
| Option | Type | Default | Description |
|---|
requireAuthorizationForSession | boolean | true | Require user permission before screen sharing starts. |
authorizationPromptTitle | string | (Set through the admin interface) | Custom title for the authorization dialog. |
authorizationPromptMessage | string | (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
| Option | Type | Default | Description |
|---|
showBanner | boolean | (Set through the admin interface) | Show an in-app banner while a session is active. |
showTerminateButton | boolean | (Set through the admin interface) | Show a button in the banner to end the screen sharing session. |
endOfSessionMessage | string | (Set through the admin interface) | Message displayed when the session ends. |
stopSessionText | string | (Set through the admin interface) | Custom text for the stop session button. |
Remote Control
| Option | Type | Default | Description |
|---|
allowRemoteClick | boolean | true | Allow agents to remotely tap on the screen. |
allowRemoteScroll | boolean | true | Allow agents to remotely scroll the screen. |
requireControlRequest | boolean | (Set through the admin interface) | Require user approval before agents can use remote input. |
controlRequestTitle | string | (Set through the admin interface) | Custom title for the control request prompt. |
controlRequestMessage | string | (Set through the admin interface) | Custom message for the control request prompt. |
Lookup Code
| Option | Type | Default | Description |
|---|
enableLookupCodeOnShake | boolean | (Set through the admin interface) | Show lookup code popup when device is shaken. |
lookupCodeKeyTitle | string | (Set through the admin interface) | Custom title for the shake detection alert. |
lookupCodeKeyMessage | string | (Set through the admin interface) | Custom message for shake alert. Supports {%lookupCode%} placeholder. |
Localization Strings
| Option | Type | Description |
|---|
translationsYes | string | Custom text for "Allow" button in authorization prompt. |
translationsNo | string | Custom text for "Deny" button in authorization prompt. |
translationsOk | string | Custom text for "OK" button. |
System Options
| Option | Type | Description |
|---|
autoConnect | boolean | Automatically connect on initialization. Default: true (set through the admin interface). |
region | string | Server 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',
});
