Configuration Options
You can customize the behavior of the PRODUCT Flutter SDK through configuration options.
Setting Configuration
Pass options when creating the UpscopeConfiguration:
final config = UpscopeConfiguration(
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',
);
await Upscope.instance.initialize(config);
Configuration Options
Each option resolves in this order: a value you pass here overrides the matching dashboard setting, which overrides the SDK's built-in default (shown in the Default column).
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 |
|---|---|---|---|
showTerminateButton | bool | true | Show a button in the banner to end the screen sharing session. |
showUpscopeLink | bool? | true | Show the UserView link to the user. Setting this to false only works if whitelabeling is included in your plan. |
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 | bool? | (Set through the admin interface) | Allow agents to remotely tap on the screen. |
allowRemoteScroll | bool? | (Set through the admin interface) | Allow agents to remotely scroll the screen. |
requireControlRequest | bool? | false | Require user approval before agents can use remote input. When it resolves false, remote input is granted without a separate control request. |
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. |
customControlRequestUI | bool? | false | Replace the native control request prompt with your own UI. When true, the SDK emits on the onControlRequest stream instead of showing the native prompt; you must listen and call respondToControlRequest, otherwise control requests stall. See Listening for Events. |
Lookup Code
| Option | Type | Default | Description |
|---|---|---|---|
enableLookupCodeOnShake | bool? | (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. |
Multi-Language Translations
Every text option (titles, messages, and the strings above) also accepts a map keyed by language code instead of a single string. The translation matching the device language is shown, falling back to en if the device language isn't included:
translationsYes: {'en': 'Yes', 'it': 'Si'},
translationsNo: {'en': 'No', 'it': 'No'},
All of these can also be configured per language through the dashboard.
Full Device Sharing (iOS only)
These options configure the iOS Broadcast Upload Extension required for full-device screen sharing (the broadcast options are ignored on Android). To gate full-device requests behind your own UI, set customFullDeviceRequestUI: true and listen on the onFullDeviceRequest stream — see Listening for Events for how to respond.
| Option | Type | Description |
|---|---|---|
broadcastAppGroupId | String? | App Group identifier shared between your iOS app and the Broadcast Upload Extension. Required for full-device screen sharing on iOS. |
broadcastExtensionBundleId | String? | Bundle identifier of your iOS Broadcast Upload Extension, used to auto-start the system broadcast picker. |
disableFullScreenWhenMasked | bool? | When true, full-device sharing is declined while masked content is on screen. Set false to allow it even with masked content present. Default: set through the admin interface. |
customFullDeviceRequestUI | bool? | iOS and Android — gate full-device requests behind your own UI. When true, the SDK emits on the onFullDeviceRequest stream instead of proceeding directly to the system permission prompt; you must listen and call respondToFullDeviceRequest, otherwise requests stall. Default false = straight to the system prompt. See Listening for Events. |
System Options
| Option | Type | Description |
|---|---|---|
autoConnect | bool | Automatically connect on initialization. Default: true (set through the admin interface). |
region | String? | Server region for connections. |
Full Example
final config = UpscopeConfiguration(
apiKey: 'YOUR_API_KEY',
requireAuthorizationForSession: true,
autoConnect: true,
authorizationPromptTitle: 'Screen Share',
authorizationPromptMessage: '{%agentName%|Support} wants to help you',
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',
// iOS only — required for full-device screen sharing
broadcastAppGroupId: 'group.com.example.app',
broadcastExtensionBundleId: 'com.example.app.BroadcastExtension',
);
await Upscope.instance.initialize(config);