Configuration Options

Setting Configuration

Pass options when creating the UpscopeConfiguration:

let 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"
)

try Upscope.shared.initialize(with: 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).

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

translationsYes: ["en": "Yes", "it": "Si"],
translationsNo: ["en": "No", "it": "No"]

Custom Authorization UI

onSessionRequest is only invoked when requireAuthorizationForSession resolves true — when authorization is disabled (locally or via the team's dashboard setting), sessions start without any prompt and the handler is never called.

You can replace the default authorization dialog with your own UI by setting the onSessionRequest property after creating the configuration:

var config = UpscopeConfiguration(
    apiKey: "YOUR_API_KEY",
    requireAuthorizationForSession: true
)

config.onSessionRequest = { response, agentName in
    // Show your custom UI here
    // Call response.accept() or response.reject()
    myCustomAlert.show(agentName: agentName) { accepted in
        if accepted {
            response.accept()
        } else {
            response.reject()
        }
    }
    // Return a Cancellable for cleanup if the request is dismissed externally
    return Cancellable {
        myCustomAlert.dismiss()
    }
}

try Upscope.shared.initialize(with: config)

Similarly, use onControlRequest to customize the remote control authorization prompt:

var config = UpscopeConfiguration(
    apiKey: "YOUR_API_KEY",
    requireControlRequest: true
)

config.onControlRequest = { response, agentName in
    // Show your custom UI, e.g. "{agentName} wants to control your screen"
    myControlAlert.show(agentName: agentName) { accepted in
        if accepted {
            response.accept()
        } else {
            response.reject()
        }
    }
    return nil // or return a Cancellable
}

Use onFullDeviceRequest to intercept full-device sharing requests before the system broadcast picker appears:

var config = UpscopeConfiguration(
    apiKey: "YOUR_API_KEY"
)

config.onFullDeviceRequest = { response, agentName in
    // Show your custom UI before the system broadcast picker
    myCustomAlert.show(agentName: agentName) { accepted in
        if accepted {
            response.accept() // proceeds to the system broadcast picker
        } else {
            response.reject() // declines without showing the picker
        }
    }
    // Return a Cancellable called if the request is dismissed externally
    return Cancellable {
        myCustomAlert.dismiss()
    }
}

try Upscope.shared.initialize(with: config)

Full Example

let config = UpscopeConfiguration(
    apiKey: "YOUR_API_KEY",
    requireAuthorizationForSession: 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"
)

try Upscope.shared.initialize(with: config)