Browse docs

Phone and Tablet Providers

Integrate custom apps through Base's active phone and tablet adapters.

Who is this page for?

This is an optional developer reference for integrating your own scripts with the configured phone or external tablet. You do not need to call these exports to install or use Sky job resources.

If you use an external phone or tablet, select its integration in Sky Base's configuration and follow Base setup. The Sky job resources use the shared adapters themselves. For example, OpenCustomPhoneApp is useful when your own script needs to open an external phone app; it is not an installation step.

These exports call the configured adapter. Provider support and result payloads depend on that adapter; registration does not install or start the external phone/tablet resource.

Phone — client

ExportPurpose
RegisterCustomPhoneApp(app)Register an app using the active provider's supported app contract
SendCustomPhoneAppMessage(identifier, data)Send data to the app
SendPhoneAppNotification(data)Send a local phone-app notification
GetPhoneNumber()Read the local number, or nil if unavailable
RegisterCustomPhoneNumber(number, handler)Register a dialable number where supported
RemoveCustomPhoneNumber(number)Remove an owned dialable number where supported
OpenCustomPhoneApp(identifier, data?)Open an app where supported

Phone — server

ExportPurpose
GetPhoneNumber(source)Read the selected player's number through the active provider
SendPhoneAppNotification(data)Send a provider notification using its supported payload

Do not reuse the client notification payload on the server without checking the selected provider's targeting fields.

Tablet — client

ExportPurpose
RegisterCustomTabletApp(app)Register an external-tablet app
RemoveCustomTabletApp(identifier)Remove an owned app where supported
SendCustomTabletAppMessage(identifier, event, data)Send an app event
SendTabletAppNotification(data)Send a local tablet-app notification
CloseExternalTablet()Request closure where supported

Tablet — server

SendTabletAppNotification(data, source?) sends a notification to the selected player through the active adapter.

The sd tablet adapter uses sd-phone's shared app registry with devices = "tablet". Its close operation returns false, "unsupported_provider_api" because that provider has no supported close API. Other adapters have their own capabilities.

For Sky's internal job tablet and apps, start with Jobs Base, Emergency Dispatch and tablet personalization.