Appearance
@pitcher/canvas-ui
Modules
| Module | Description |
|---|---|
| internal | - |
Enumerations
PitcherBroadcastedEventName
Enumeration Members
PitcherEventName
Enumeration Members
PitcherExternalEventName
Enumeration Members
| Enumeration Member | Value |
|---|---|
CREATE_AND_OPEN_CANVAS | "create_and_open_canvas" |
OPEN_CANVAS | "open_canvas" |
OPEN_CREATE_CANVAS | "open_create_canvas" |
SELECT_ACCOUNT | "select_account" |
START_CALL | "start_call" |
PitcherMessageType
Enumeration Members
| Enumeration Member | Value |
|---|---|
REQUEST | "PITCHER_REQUEST" |
RESPONSE | "PITCHER_RESPONSE" |
PitcherResponseStatus
Enumeration Members
| Enumeration Member | Value |
|---|---|
ERROR | "error" |
OK | "ok" |
Interfaces
AdminToastRequest
Represents a request to show a toast notification.
Properties
AICompletePayload
Payload for an on-device AI completion (ai.complete, iOS only). The exact iOS wire contract — keys are already snake_case, do not rename.
Properties
AICompleteResult
Result of an on-device AI completion (ai.complete, iOS only).
Properties
| Property | Type | Description |
|---|---|---|
elapsed_seconds? | number | - |
text | string | The generated completion text. |
time_to_first_token_seconds? | number | - |
tokens_generated? | number | - |
AIRuntimeCapabilities
Capabilities of the AI runtime serving ai.complete on the current platform. On iOS this is the native on-device (Gemma) bridge answer — snake_case wire fields come straight from the native handler. On web there is no local model; the SDK answers statically with the online (Bedrock) runtime.
Properties
ApiEventMap
Properties
| Property | Type |
|---|---|
event | PitcherEvent |
ApiOptions
Properties
| Property | Type |
|---|---|
casing? | "camel" | "snake" |
errorLogger? | (p) => string | void |
fetchMode? | FetchMode |
logLevel? | "off" | "info" | "debug" |
AppsDbDeleteEntryPayload
Payload for appsDbDeleteEntry.
Properties
| Property | Type |
|---|---|
id | string |
AppsDbEntriesResult
Entry-list result shared by appsDbGetEntries and appsDbPsql.
Properties
| Property | Type |
|---|---|
entries | AppsDbEntry[] |
hasMore? | boolean |
totalCount? | number |
AppsDbEntry
A single AppsDB entry (next-core core_appsdb_entries row / iOS offline mirror record).
Properties
| Property | Type | Description |
|---|---|---|
created_at? | string | - |
data | Record<string, any> | Opaque application data. Keys are stored verbatim (no casing transformation). |
id | string | Unique identifier (ULID). |
instance_id? | string | null | - |
org_id? | string | null | - |
type | string | Object type the entry belongs to (e.g. personalfolders, favorite). |
updated_at? | string | - |
user_id? | number | null | - |
AppsDbGetEntriesPayload
Payload for appsDbGetEntries — list AppsDB entries of a type.
Properties
AppsDbPsqlPayload
Payload for appsDbPsql — a PSQL (SQL-like) query against AppsDB, e.g. SELECT * FROM favorite WHERE user_id = 1 AND data.file_id = 'abc'.
Properties
| Property | Type |
|---|---|
query | string |
AppsDbUpsertEntryPayload
Payload for appsDbUpsertEntry. With id the entry is updated (the server deep-merges data); without id a new entry is created.
Properties
| Property | Type | Description |
|---|---|---|
data | Record<string, any> | - |
id? | string | - |
instance_id? | string | - |
no_user_id? | boolean | Create an instance-wide entry with no user attribution (allowlist-gated server-side, see next-core appsdb/ownership.ts). |
type? | string | - |
user_id? | number | - |
CreateAndOpenCanvasEvent
Properties
| Property | Type |
|---|---|
account_id? | string |
CRMCreatePayload
Payload for creating CRM records (Web only). Uses Salesforce REST API to create records.
Properties
| Property | Type | Description |
|---|---|---|
records | Record<string, unknown>[] | Array of records to create. Each record is a key-value map of field names to values. Field names should use Salesforce API names (e.g., 'Account__c', 'Order_Date__c'). |
service? | CRMServiceType | Optional name of the CRM service to use. |
sobject | string | The Salesforce object type (e.g., 'Account', 'Contact', 'Order__c'). |
CRMDeleteObject
Represents a single CRM object to be deleted.
Properties
| Property | Type | Description |
|---|---|---|
ids | string[] | Array of IDs of the records to delete. |
table_name | string | The name of the CRM table/object to delete from. |
CRMDescribePayload
Payload for retrieving CRM object metadata/describe (Web only). Uses Salesforce REST API to fetch object metadata including fields and picklist values.
Properties
| Property | Type | Description |
|---|---|---|
service? | CRMServiceType | Optional name of the CRM service to use. |
sobject | string | The Salesforce object type to describe (e.g., 'Account', 'Contact', 'Opportunity'). |
CRMLayoutPayload
Payload for retrieving CRM object layout (Web only). Uses Salesforce REST API to fetch object layout information including sections, fields arrangement, and form factors.
Properties
| Property | Type | Description |
|---|---|---|
form_factor? | string | Optional form factor (e.g., 'Large', 'Medium', 'Small'). |
layout_type? | string | Optional layout type (e.g., 'Full', 'Compact'). |
mode? | string | Optional mode (e.g., 'Create', 'Edit', 'View'). |
record_type_id? | string | Optional record type ID for record type specific layouts. |
service? | CRMServiceType | Optional name of the CRM service to use. |
sobject | string | The Salesforce object type to get layout for (e.g., 'Account', 'Contact', 'Opportunity'). |
CRMQueryPayload
Payload for executing a query against CRM.
Properties
| Property | Type | Description |
|---|---|---|
query | string | The query string to execute. |
service? | CRMServiceType | Optional name of the service to be queried. |
CRMSmartDeleteObjectsPayload
Payload for deleting CRM objects (iOS only).
Properties
| Property | Type | Description |
|---|---|---|
objects | CRMDeleteObject[] | Array of CRM objects to be deleted. |
CRMSmartObjectLayoutPayload
Payload for getting CRM smart object layout (iOS only).
Properties
CRMSmartObjectMetadataPayload
Payload for retrieving CRM smart object metadata (iOS only).
Properties
CRMSmartObjectValidationRulesPayload
Payload for getting CRM smart object validation rules (iOS only).
Properties
| Property | Type | Description |
|---|---|---|
object | string | The name of the CRM object (e.g., 'Account', 'Contact', 'Opportunity'). |
CRMUpsertPayload
Payload for upserting CRM records (Web only). Uses Salesforce REST API to insert or update records based on external ID.
Properties
| Property | Type | Description |
|---|---|---|
external_id_field | string | The external ID field used to match existing records for update. If a record with matching external ID exists, it will be updated; otherwise, a new record is created. |
records | Record<string, unknown>[] | Array of records to upsert. Each record is a key-value map of field names to values. Field names should use Salesforce API names (e.g., 'Account__c', 'Order_Date__c'). |
service? | CRMServiceType | Optional name of the CRM service to use. |
sobject | string | The Salesforce object type (e.g., 'Account', 'Contact', 'Order__c'). |
GetInstanceMetadataTemplatesPayload
Payload for getting instance metadata templates.
Properties
LocationRoute
Represents a route in the location.
Properties
| Property | Type | Description |
|---|---|---|
is_inactive | boolean | Indicates when application is still registered but not used right now. |
is_mounted | boolean | Indicates if the route is mounted. |
is_restoring | boolean | Indicates if the route is being restored. |
path | string | The path of the route. |
query | Record<string, any> | The query parameters of the route. |
NotificationPayload
Payload for sending a notification.
Properties
| Property | Type | Description |
|---|---|---|
content | string | Content of the notification. |
type? | "native" | "alert" | Type of the notification. |
OpenCanvasPitcherEvent
Properties
| Property | Type |
|---|---|
account_id? | string |
account_name? | string |
canvas_id? | string |
edit_mode? | "true" | "false" |
OpenCreateCanvasPitcherEvent
PIT-9807: a CRM deep link that opens the create dialog prefilled; the rep confirms. Every value arrives as a URL query string (?event[name]=open_create_canvas&event[template_id]=…).
Properties
OpenExternalUrlRequestPayload
Payload object for opening an external URL.
Properties
| Property | Type | Description |
|---|---|---|
options? | string | Additional options for opening the URL. |
target? | "_self" | "_blank" | The target where the URL should be opened. Defaults to '_blank'. |
url | string | The URL to open. |
OpenRequestPayload
Payload object for opening a file.
Properties
| Property | Type | Description |
|---|---|---|
canvasCorrelationId? | string | Tracking id for the canvas presentation session. |
canvasInView? | boolean | Indicates if the canvas is in view. |
context? | Record<string, any> | Optional, overrides over the context of the current canvas, useful for injecting file annotation data. Default is {}. |
fileId? | string | Id of the file to open. |
files? | object | Ids of the files to open and the strategy to open them with. |
files.ids | string[] | - |
files.strategy | "simultaneous" | "swap" | - |
fromCanvasId? | string | Id of the canvas from which the file is opened. |
isInCall? | boolean | Indicates if the user is in a call. |
isOverlayApp? | boolean | Indicates if the app should be opened as overlay. |
newTab? | boolean | Indicates if the file should be opened in a new tab. |
pageIndex? | number | Optional, page index to open. Default is null. |
search? | string | Search query string within the file. |
startTime? | number | Optional, video start timestamp in seconds. Default is null. |
url? | string | null | URL of the file content. |
usedInSectionId? | string | Id of the canvas section from which the file is opened. |
OpenWebViewAlwaysOnTop
Payload object for opening a web view that is always on top.
Properties
OrgConfigResponse
Properties
PeerConnectivityContext
Indexable
[
key:string]:unknown
Properties
| Property | Type |
|---|---|
canvasId? | string |
fileId? | string |
routeName? | string |
routePath? | string |
viewId? | string |
viewType? | string |
PeerConnectivityDispatchOptions
Properties
| Property | Type | Description |
|---|---|---|
isFeatureEnabled? | boolean | Guards if feature flag is enabled for the current organization. |
PeerConnectivityEvent
Extends
PeerConnectivityEventPayload<TData,TContext>
Type Parameters
| Type Parameter | Default type |
|---|---|
TData extends Record<string, unknown> | Record<string, unknown> |
TContext extends PeerConnectivityContext | PeerConnectivityContext |
Properties
| Property | Type | Overrides | Inherited from |
|---|---|---|---|
action | string | - | PeerConnectivityEventPayload.action |
context? | TContext | - | PeerConnectivityEventPayload.context |
data? | TData | - | PeerConnectivityEventPayload.data |
metadata | PeerConnectivityMetadata | PeerConnectivityEventPayload.metadata | - |
version | number | PeerConnectivityEventPayload.version | - |
PeerConnectivityEventPayload
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
TData extends Record<string, unknown> | Record<string, unknown> |
TContext extends PeerConnectivityContext | PeerConnectivityContext |
Properties
| Property | Type |
|---|---|
action | string |
context? | TContext |
data? | TData |
metadata? | Partial<PeerConnectivityMetadata> |
version? | number |
PeerConnectivityMetadata
Properties
| Property | Type |
|---|---|
correlationId | string |
extras? | Record<string, unknown> |
source | string |
timestamp | number |
PiaSearchAnswerPayload
Payload for piaSearchAnswer — one high-level question-answering call over the instance's content, routed on-device (iOS Gemma) or online (next-core Bedrock route) based on the pia_search_config flag mode.
Properties
PiaSearchAnswerResult
Unified piaSearchAnswer result across both serving paths.
Properties
| Property | Type | Description |
|---|---|---|
answer | string | The answer text. |
citations? | PiaSearchCitation[] | Which page(s) of each cited file the answer was grounded in (PIT-8062). Online, document-grounded path only, and only when the instance has the enable_pia_search_page_citations flag on. Optional at RUNTIME, not merely in the types. Consumers load this SDK from an unversioned CDN tag, so the bundle a rep runs may predate the field entirely; and a backend with the flag off omits it from the body. The key is absent in those cases — never null, never []. A cited file with no page information still appears in cited_file_ids: degrade to a file-level citation, never to an empty state. |
cited_file_ids? | string[] | File ids (from the candidate context) the answer drew on. Online path only. |
confidence? | "high" | "medium" | "low" | Model self-reported confidence. Online path only. |
degraded? | true | true when the server's echo guard discarded the model's answer (PIT-7914): answer is the fallback text, cited_file_ids is empty and citations is absent. Show no sources for it, keyword matches included. Online path only; absent on every normal answer and from bundles that predate the field. |
source | "online" | "on_device" | Which runtime produced the answer. |
PiaSearchCitation
Page-level attribution for ONE cited file (PIT-8062).
page_indices is 0-based — the same base openFile(fileId, pageIndex) and the iOS page_index → pdfPageIndex bridge take, so a consumer passes the value straight through and only adds 1 for a user-facing label. The model emits 1-based page numbers (it echoes the label it was shown); next-core's pia-search route converts them exactly once, server-side.
Properties
PitcherAPI
Extends
Methods
emit()
emit<
Key>(eventName,params):void
Type Parameters
| Type Parameter |
|---|
Key extends "event" |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
params | ApiEventMap[Key] |
Returns
void
Inherited from
off()
off<
Key>(eventName,fn):void
Type Parameters
| Type Parameter |
|---|
Key extends "event" |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
fn | EventReceiver<ApiEventMap[Key]> |
Returns
void
Inherited from
on()
on<
Key>(eventName,fn):void
Type Parameters
| Type Parameter |
|---|
Key extends "event" |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
fn | EventReceiver<ApiEventMap[Key]> |
Returns
void
Inherited from
request()
request(
type,body,callback):Promise<PitcherResponse>
Parameters
| Parameter | Type |
|---|---|
type | string |
body | any |
callback | () => any |
Returns
PitcherEnv
Properties
| Property | Type | Description |
|---|---|---|
capabilities? | string[] | Bridge capabilities the running native host advertises (PIT-7682). Only web posts to the API directly and needs no capability check — every NATIVE host (isNativeHost(env.mode)) routes requests through its own bridge handlers. That includes the Tauri desktop/Android shell (pitcher-impact-tauri-ng), which reports its own build target as mode (MACOS / WINDOWS / ANDROID) and states what it supports here. A host that omits a token behaves exactly like an old iPad build — consumers that treat absent as unsupported degrade it safely — so gaining a capability means implementing the forwarding first. Tokens are <request_type>.<field>, e.g. share_canvas.brand_id. Feature-detect on them rather than on version: an older host omits the key entirely, so absent must be treated as unsupported. The shape is not guaranteed either — it crosses a bridge from native code — so check Array.isArray before .includes, or a string value substring-matches the gate open. Defined natively in BridgeCapabilities (pitcher-impact-ios-ng); the strings are a permanent contract because web builds in the wild keep checking them. |
client_type? | "admin" | "dsr" | "impact" | "impact-canvas-home" | "course" | - |
crm_shape? | Record<string, any> | - |
device_locale? | string | - |
launch_darkly? | LaunchDarklyEnv | - |
mode | "WEB" | "IOS" | "WINDOWS" | "ANDROID" | "MACOS" | The HOST the web layer is running inside — mode IS the platform, one value per OS. WEB is the browser; everything else is a NATIVE shell with a JS bridge and an offline mirror (IOS the iPad, MACOS/WINDOWS/ANDROID the Tauri desktop/Android shell). Never write mode === 'IOS' to mean "native" — use isNativeHost(mode) (@sdk/platform), which is mode !== 'WEB' so a host newer than this bundle still takes the native branch. Values are only ever ADDED to this union — never renamed or removed, apps in the field compare them. IOS stays the right test only for iPad HARDWARE: MultipeerConnectivity (peer session), the Salesforce Mobile SDK's SmartStore, on-device inference — subsystems no other host has. |
permissions? | string[] | - |
pitcher | object | - |
pitcher.access_token | string | - |
pitcher.id_token | string | - |
pitcher.impersonated_by? | string | - |
pitcher.instance | PitcherInstance | - |
pitcher.org_config? | OrgConfigResponse | - |
pitcher.organization | PitcherOrg | - |
pitcher.token_claims | Record<string, any> | - |
pitcher.user | User | - |
state? | object | - |
state.active_canvas_id? | string | - |
state.active_file? | object | - |
state.active_file.id | string | - |
state.active_section_id? | string | - |
state.canvas_correlation_id? | string | - |
sync_badge_value? | number | - |
ui_locale? | string | Locale the user picked in the Pitcher shell. Web only — iOS has no picker and reports device_locale instead. Apps should prefer this and fall back: `ui_locale |
PitcherEvent
Properties
| Property | Type |
|---|---|
body | void | PitcherEnv | Record<string, any> | File | UpdateLocationPitcherEvent | OpenCanvasPitcherEvent | CreateAndOpenCanvasEvent | OpenCreateCanvasPitcherEvent | StartCallPitcherEvent | SelectAccountPitcherEvent | RouteChangedPitcherEvent | { access_token: string; } | { section_id?: string; url: string; } | { user_triggered: boolean; } | { progress: number; upload_uid: string; } | { payload: any; type: "File Entered" | "File Exited" | "Web File Entered" | "Web File Exited" | "Page Entered" | "Page Exited" | "Page Viewed" | "App Entered" | "App Exited" | "Canvas Entered" | "Canvas Exited" | "Canvas Heartbeat" | "Wizard Entered" | "Wizard Exited" | "Canvas Shared" | "Customer Sentiment Captured" | "Canvas Page Entered" | "Canvas Page Exited" | "Canvas Component Entered" | "Canvas Component Exited" | "Canvas File Downloaded" | "Canvas Downloaded" | "User Feedback Captured" | "User Bug Reported" | "User File Reviewed" | "Hotspot Clicked" | "Collection Player Content Changed" | "Comment Added" | "Comment Replied" | "Comment Assigned" | "Comment Resolved" | "Comment Deleted"; } | Partial<CanvasRetrieve> | Pick<CanvasRetrieve, "id" | "context"> | { file_id?: string; view_id?: string; } | { file_id?: string; view_id?: string; } | { canvas_id?: string; current_page_index?: number; } | { canvas_id?: string; current_page_index?: number; } | { canvas_id?: string; } | { canvas_id?: string; } | { item_id: string; } | { is_in_sharebox: boolean; item_id: string; } | { item_id: string; } | { error?: string; is_in_sharebox: boolean; item_id: string; success: boolean; } | { count: number; } | { id: string; last_error: string; table_name: string; } | PeerConnectivityEvent<Record<string, unknown>, PeerConnectivityContext> | SttPartialEvent | SttInterruptedEvent | { body: string; } | { body: { canvas_id?: string; current_page_index: number; }; } | { body: { canvas_id?: string; current_page_index: number; }; } | { body: { canvas_id: string; }; } | { body: { canvas_id: string; }; } | { body: { route_name: string; route_path: string; }; } |
type | keyof PitcherEventMap |
PitcherEventMap
Properties
| Property | Type | Description |
|---|---|---|
access_token_renewed | object | The shell renewed the Pitcher access token. Apps that cached env.pitcher.access_token (instead of reading it lazily via getEnv()) should replace their copy with this one. See web-only for now — Impact iOS does not emit this event yet; keep a pull fallback (getEnv() / refreshAccessToken()) for cross-platform apps. |
access_token_renewed.access_token | string | - |
analytics_captured | object | See iOS-only |
analytics_captured.payload | any | - |
analytics_captured.type | "File Entered" | "File Exited" | "Web File Entered" | "Web File Exited" | "Page Entered" | "Page Exited" | "Page Viewed" | "App Entered" | "App Exited" | "Canvas Entered" | "Canvas Exited" | "Canvas Heartbeat" | "Wizard Entered" | "Wizard Exited" | "Canvas Shared" | "Customer Sentiment Captured" | "Canvas Page Entered" | "Canvas Page Exited" | "Canvas Component Entered" | "Canvas Component Exited" | "Canvas File Downloaded" | "Canvas Downloaded" | "User Feedback Captured" | "User Bug Reported" | "User File Reviewed" | "Hotspot Clicked" | "Collection Player Content Changed" | "Comment Added" | "Comment Replied" | "Comment Assigned" | "Comment Resolved" | "Comment Deleted" | - |
canvas_close_requested | object | - |
canvas_close_requested.canvas_id? | string | - |
canvas_closed | object | - |
canvas_closed.body | object | - |
canvas_closed.body.canvas_id | string | - |
canvas_context_stored | Pick<CanvasRetrieve, "id" | "context"> | - |
canvas_next_button_clicked | object | - |
canvas_next_button_clicked.body | object | - |
canvas_next_button_clicked.body.canvas_id? | string | - |
canvas_next_button_clicked.body.current_page_index | number | - |
canvas_open_requested | object | - |
canvas_open_requested.canvas_id? | string | - |
canvas_opened | object | - |
canvas_opened.body | object | - |
canvas_opened.body.canvas_id | string | - |
canvas_page_next_requested | object | - |
canvas_page_next_requested.canvas_id? | string | - |
canvas_page_next_requested.current_page_index? | number | - |
canvas_page_previous_requested | object | - |
canvas_page_previous_requested.canvas_id? | string | - |
canvas_page_previous_requested.current_page_index? | number | - |
canvas_previous_button_clicked | object | - |
canvas_previous_button_clicked.body | object | - |
canvas_previous_button_clicked.body.canvas_id? | string | - |
canvas_previous_button_clicked.body.current_page_index | number | - |
canvas_updated | Record<string, any> | - |
canvas_updated_success | Partial<CanvasRetrieve> | - |
content_list_refresh_requested | void | See iOS-only |
create_and_open_canvas | CreateAndOpenCanvasEvent | - |
entered_fullscreen | void | See WEB-only |
env_changed | PitcherEnv | - |
exited_fullscreen | void | See WEB-only |
file_closed | object | - |
file_closed.file_id? | string | - |
file_closed.view_id? | string | - |
file_downloaded | File | See iOS-only |
file_opened | object | - |
file_opened.file_id? | string | - |
file_opened.view_id? | string | - |
file_upload_progress | object | See iOS-only |
file_upload_progress.progress | number | - |
file_upload_progress.upload_uid | string | - |
file:download | object | - |
file:download.body | string | - |
global_photo_captured | object | See iOS-only |
global_photo_captured.section_id? | string | - |
global_photo_captured.url | string | - |
item_sharebox_add_completed | object | - |
item_sharebox_add_completed.error? | string | - |
item_sharebox_add_completed.is_in_sharebox | boolean | - |
item_sharebox_add_completed.item_id | string | - |
item_sharebox_add_completed.success | boolean | - |
item_sharebox_add_requested | object | - |
item_sharebox_add_requested.item_id | string | - |
item_sharebox_status_requested | object | - |
item_sharebox_status_requested.item_id | string | - |
item_sharebox_status_updated | object | - |
item_sharebox_status_updated.is_in_sharebox | boolean | - |
item_sharebox_status_updated.item_id | string | - |
network_connection_established | void | See iOS-only |
network_connection_lost | void | See iOS-only |
non_files_sync_finished | object | See iOS-only |
non_files_sync_finished.user_triggered | boolean | - |
open_canvas | OpenCanvasPitcherEvent | - |
open_create_canvas | OpenCreateCanvasPitcherEvent | - |
peer_connectivity_event | PeerConnectivityEvent | - |
photos_captured | void | See iOS-only |
route_change_requested | RouteChangedPitcherEvent | See iOS-only |
route_changed | object | - |
route_changed.body | object | - |
route_changed.body.route_name | string | - |
route_changed.body.route_path | string | - |
select_account | SelectAccountPitcherEvent | - |
start_call | StartCallPitcherEvent | - |
stt.interrupted | SttInterruptedEvent | Speech-to-text dictation session ended WITHOUT a stt.stop (e.g. a call recording preempted the mic on iOS, or a fatal capture error on web). Stop waiting for partials and reset the field. Cross-platform. |
stt.partial | SttPartialEvent | Speech-to-text dictation partial (PITCHER_REQUEST stt.start session). Cross-platform (iOS bridge and the web host engine). text is the FULL transcript so far — replace, don't append. |
submit_postcall_clicked | void | - |
sync_badge_value_reported | object | See iOS-only |
sync_badge_value_reported.count | number | - |
sync_box_resolve_error_tapped | object | See iOS-only Fired when user taps "Fix" on a failed SFDC sync error in the Syncbox. The id may be a Salesforce ID, external ID, or locally-generated temp ID. |
sync_box_resolve_error_tapped.id | string | Record ID that failed to sync (SF ID, external ID, or temp ID like PIT_...) |
sync_box_resolve_error_tapped.last_error | string | Salesforce sync error message |
sync_box_resolve_error_tapped.table_name | string | SFDC object/soup name (e.g. "Event", "Call2_vod__c") |
ui:hide-modal | void | - |
ui:show-modal | void | - |
update_location | UpdateLocationPitcherEvent | - |
PitcherInterface
Extends
Properties
| Property | Type |
|---|---|
API | PitcherAPI |
Methods
emit()
emit<
Key>(eventName,params):void
Type Parameters
| Type Parameter |
|---|
Key extends EventKey<PitcherEventMap> |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
params | PitcherEventMap[Key] |
Returns
void
Inherited from
off()
off<
Key>(eventName,fn):void
Type Parameters
| Type Parameter |
|---|
Key extends EventKey<PitcherEventMap> |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
fn | EventReceiver<PitcherEventMap[Key]> |
Returns
void
Inherited from
on()
on<
Key>(eventName,fn):void
Type Parameters
| Type Parameter |
|---|
Key extends EventKey<PitcherEventMap> |
Parameters
| Parameter | Type |
|---|---|
eventName | Key |
fn | EventReceiver<PitcherEventMap[Key]> |
Returns
void
Inherited from
PitcherMessage
Properties
| Property | Type |
|---|---|
request | object |
request.body? | Record<string, any> |
request.id | string |
request.type | string |
type | "PITCHER_EVENT" |
PitcherResponse
Properties
| Property | Type |
|---|---|
request | object |
request.body? | Record<string, any> |
request.id | string |
request.type | string |
response | object |
response.body? | Record<string, any> |
response.status | PitcherResponseStatus |
type | RESPONSE |
QueryPayload
Payload for executing a query.
Properties
| Property | Type | Description |
|---|---|---|
args? | string[][] | Optional arguments for the query. |
query | string | The query string to execute. |
RouteChangedPitcherEvent
Properties
| Property | Type |
|---|---|
route_name | string |
route_path | string |
SelectAccountPitcherEvent
Preselects an account in the meeting bar without starting a call. Used by the SFDC passthrough Prepare flow.
Properties
| Property | Type |
|---|---|
account? | object |
account.id | string |
account.name? | string |
SharePayload
Payload for iOS sharing dialog.
Properties
| Property | Type | Description |
|---|---|---|
body? | string | Body |
subject? | string | Subject |
text | string | Text to be shared. |
ShowPeerSessionRequestPayload
Payload for showing peer session dialog.
Properties
| Property | Type | Description |
|---|---|---|
x | number | The x-coordinate of the button that triggered the action. |
y | number | The y-coordinate of the button that triggered the action. |
ShowSyncboxRequestPayload
Payload for showing syncbox dialog.
Properties
| Property | Type | Description |
|---|---|---|
x | number | The x-coordinate of the button that triggered the action. |
y | number | The y-coordinate of the button that triggered the action. |
SlideSearchPayload
Payload for slideSearch (PIT-9090) — ranks the slides of one wizard template configuration for a query through the next-core pia-prepare/slide-search route. Online only.
visible_group_names / visible_slide_refs are the caller's own visibility evaluation (what the rep can currently see). The server intersects them with the configuration and the caller's ACL; they are a scope hint, not a security boundary.
Properties
SlideSearchResult
Result of slideSearch.
Properties
| Property | Type | Description |
|---|---|---|
mode | "full_realm" | "compact" | "prefiltered" | How the realm reached the model: every slide in full, every slide compact, or a lexical pre-cut. |
realm_size | number | Slides in the narrowed, ACL-filtered realm. |
results | SlideSearchResultItem[] | - |
SlideSearchResultItem
One ranked slide from slideSearch.
Properties
StartCallPitcherEvent
Properties
SttAvailabilityResult
Result of stt.availability — a side-effect-free capability check an app should call BEFORE offering a mic button. It does NOT prompt for the microphone or download any model; it only reports whether dictation could be started, so the UI can hide/disable the control up front.
Properties
| Property | Type | Description |
|---|---|---|
available | boolean | Dictation can be started right now — the feature is enabled AND an engine can run on this device. |
engine | SttEngineKind | null | The engine that would answer stt.start, or null when unavailable. Note "webspeech" sends audio off-device, so a UI may want to reflect that. |
reason? | SttUnavailableReason | Present when available is false: "disabled" (feature flag off) or "unsupported" (no engine on this device / browser). |
SttInterruptedEvent
Body of the stt.interrupted event (host → JS; native bridge on iOS, the Impact host engine on web). Fires only when a session ends WITHOUT a stt.stop — a normal stt.stop does NOT fire this.
Properties
SttPartialEvent
Body of the stt.partial event (host → JS; native bridge on iOS, the Impact host engine on web). Fires roughly every ~2s while recording.
Properties
SttStartPayload
Payload for stt.start — cross-platform (identical shape on iOS and web). Keys are already snake_case, so LowLevelApi's snakeCaseKeys transform is a no-op (no RAW_PAYLOAD_METHODS entry needed; the vocabulary string values are left untouched by the key-only transform).
Properties
SttStopPayload
Payload for stt.stop — cross-platform.
Properties
| Property | Type | Description |
|---|---|---|
session_id | string | The session_id passed to the matching stt.start. |
SttStopResult
Result of stt.stop — cross-platform.
Properties
| Property | Type | Description |
|---|---|---|
transcript | string | The final, full transcript for the session. |
SubmitUserFeedbackPayload
Payload for submitting user feedback.
Properties
| Property | Type | Description |
|---|---|---|
data | Record<string, any> | Data associated with the feedback. |
type | "bug" | "feedback" | Type of feedback being submitted. |
TtsSpeakPayload
Payload for tts.speak. The exact native wire contract — keys are single words, so LowLevelApi's snakeCaseKeys transform is a no-op; no RAW_PAYLOAD_METHODS entry is needed.
Properties
TtsSpeakResult
Result of tts.speak. The promise resolves when the utterance FINISHES.
Properties
| Property | Type | Description |
|---|---|---|
completed | boolean | true → finished speaking naturally; false → it was stopped (tts.stop) or replaced by a newer tts.speak (only one utterance is active at a time). |
UiOpenCollectionPlayerOverlayGroup
Properties
| Property | Type | Description |
|---|---|---|
id | string | File ID |
name | string | File name |
slides? | object[] | Optional: specific slides/pages to show from the file |
UiOpenCollectionPlayerOverlayRequest
Properties
| Property | Type | Description |
|---|---|---|
groups | UiOpenCollectionPlayerOverlayGroup[] | Array of files/slides to be played in the collection |
name | string | The display name for the collection |
UiOpenGlobalPopupRequest
Properties
| Property | Type | Description |
|---|---|---|
app_name | string | Name of the app to open |
extra_context? | Record<string, any> | Extra context to pass to the app |
UiOpenGlobalPopupResponse
Properties
| Property | Type | Description |
|---|---|---|
success | boolean | Whether the popup was successfully opened |
UiOpenSharingSettingsRequest
Properties
| Property | Type |
|---|---|
default_auth_strategy? | string |
files | object[] |
UiOpenSharingSettingsResponse
Properties
UiPreselectSfdcMeetingIdRequest
Properties
| Property | Type | Description |
|---|---|---|
eventId | string | Salesforce Meeting ID |
UiPreselectSfdcMeetingIdResponse
Properties
| Property | Type | Description |
|---|---|---|
event | SfEvent | null | Salesforce Event |
UiToastRequest
Properties
UpdateLocationOnGetRoutesRequest
Interface for the 'get_routes_request' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "get_routes_request" | The action type. | UpdateLocation.action |
app | string | The application identifier. | - |
UpdateLocationOnGetRoutesResponse
Interface for the 'get_routes_response' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "get_routes_response" | The action type. | UpdateLocation.action |
app | string | The application identifier. | - |
routes | LocationRoutes | The routes in the response. | - |
UpdateLocationOnMounted
Interface for the 'mounted' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "mounted" | The action type. | UpdateLocation.action |
app | string | The application identifier. | - |
UpdateLocationOnRegister
Interface for the 'register' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "register" | The action type. | UpdateLocation.action |
child_app | string | The child application identifier. | - |
parent_app? | string | The parent application identifier (optional). | - |
path? | string | The path of the route (optional). | - |
query? | Record<string, any> | The query parameters of the route (optional). | - |
UpdateLocationOnRestore
Interface for the 'restore' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "restore" | The action type. | UpdateLocation.action |
routes | Record<string, Omit<LocationRoute, "is_mounted">> | The routes to be restored. | - |
UpdateLocationOnRestoreCompleted
Interface for the 'restore_completed' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "restore_completed" | The action type. | UpdateLocation.action |
app | string | The application identifier. | - |
path | string | The path of the route. | - |
query | Record<string, any> | The query parameters of the route. | - |
UpdateLocationOnUnregister
Interface for the 'unregister' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "unregister" | The action type. | UpdateLocation.action |
app | string | The application identifier. | - |
UpdateLocationOnUpdate
Interface for the 'update' update location action.
Extends
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
action | "update" | The action type. | UpdateLocation.action |
routes | Record<string, Omit<LocationRoute, "is_restoring" | "is_mounted" | "is_inactive">> | The routes to be updated. | - |
UpsertCRMObject
Represents a single CRM object to be upserted.
Properties
| Property | Type | Description |
|---|---|---|
external_id_path? | string | Optional external ID path for identifying records during upsert. Used to determine if a record should be created or updated. Important: Always provide this field when performing updates to ensure records are matched correctly. Without it, the operation may create duplicate records instead of updating existing ones. |
objects | Record<string, any>[] | Array of objects to upsert. Each object is a key-value map of field names to values. Important: When creating new records, each object must include an explicit identifier field (e.g., Id) passed from the frontend. The backend does not auto-generate IDs. |
table_name | string | The name of the CRM table/object to upsert into. |
UpsertCRMObjectsPayload
Payload for upserting CRM objects (iOS only).
Properties
| Property | Type | Description |
|---|---|---|
objects | UpsertCRMObject[] | Array of CRM objects to be upserted. |
WeeklyFocusRankAccountContext
Properties
| Property | Type |
|---|---|
sections | object[] |
WeeklyFocusRankMeeting
Properties
| Property | Type | Description |
|---|---|---|
account_id | string | - |
account_name | string | - |
attendee_count? | number | - |
event_id | string | - |
meeting_subject | string | - |
meeting_time | string | ISO datetime, or a date-only 'YYYY-MM-DD'. |
WeeklyFocusRankPayload
Payload for weeklyFocusRank — one high-level call that ranks the rep's next-7-days meetings, routed on-device (iOS Gemma) or online (next-core Bedrock route). Calendar fetching stays caller-side: the caller owns the meeting list and passes it in.
Properties
| Property | Type | Description |
|---|---|---|
context? | Record<string, WeeklyFocusRankAccountContext> | One CRM context bundle per UNIQUE account, keyed by account_id (open tasks, opportunity state, recent calls — whatever the admin mapped). |
instance_id? | string | Instance to rank in. Defaults to the env's active instance. |
max_picks? | number | How many meetings to pick (1-8, default 5). |
meetings | WeeklyFocusRankMeeting[] | The rep's meetings. Windowed to today + 6 days by the SDK/route — send the whole calendar if that is what you have. |
one_per_account? | boolean | Keep at most one pick per account. Default true. |
time_zone? | string | IANA zone the 7-day window is measured in. Defaults to the device's zone, which is the rep's zone on-device; ALWAYS sent to the online route, whose server clock is UTC. |
WeeklyFocusRankPick
One ranked pick, resolved back to a real meeting id.
Properties
| Property | Type | Description |
|---|---|---|
event_id | string | - |
rank | number | 1 = highest priority; unique and contiguous from 1. |
reason | string | - |
WeeklyFocusRankResult
Unified weeklyFocusRank result across both serving paths.
Properties
| Property | Type | Description |
|---|---|---|
collapsed_count | number | Meetings in the 7-day window that were NOT picked — including those the ranking never saw. The surface renders this as "+N more this week". |
hero | string | One or two sentences summarising the week. Empty when the week is empty. |
source | "online" | "on_device" | Which runtime produced the ranking. |
top | WeeklyFocusRankPick[] | The picked meetings, highest priority first. |
Type Aliases
AdminCaptureAppErrorRequest
AdminCaptureAppErrorRequest =
Record<string,any>
Error object to send to Pitcher sentry instance
AdminEnv
AdminEnv =
object
Represents the admin environment.
Properties
client_type?
optionalclient_type?: typeofCLIENT_TYPE[keyof typeofCLIENT_TYPE]
crm_shape?
optionalcrm_shape?:Record<string,any>
launch_darkly?
optionallaunch_darkly?:LaunchDarklyEnv
mode?
optionalmode?:PitcherEnv["mode"]
Pitcher environment settings.
pitcher
pitcher:
PitcherEnv["pitcher"]
state?
optionalstate?:PitcherEnv["state"]
ui_locale?
optionalui_locale?:PitcherEnv["ui_locale"]
AdminMessage
AdminMessage<
Payload> =object
Represents an admin message with a specific payload.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
Payload | any | The type of the message data. |
Properties
body
body:
object
Body of the message containing the message type and payload data.
| Name | Type | Description |
|---|---|---|
data | Payload | Payload data for the message. |
type | typeof ADMIN_MESSAGE_TYPES[keyof typeof ADMIN_MESSAGE_TYPES] | Type of the admin message. |
id
id:
string
Unique identifier for the message.
type
type: typeof
ADMIN_MESSAGE
Type of the admin message.
AdminMessagePayloads
AdminMessagePayloads =
object
Properties
admin_env_changed
admin_env_changed:
AdminEnv
AdminOpenCollectionPlayerOverlayGroup
AdminOpenCollectionPlayerOverlayGroup =
object
Properties
id
id:
string
name
name:
string
slides?
optionalslides?:object[]
| Name | Type |
|---|---|
file_id | string |
slide_index | number |
AdminOpenCollectionPlayerOverlayRequest
AdminOpenCollectionPlayerOverlayRequest =
object
Properties
groups
groups:
AdminOpenCollectionPlayerOverlayGroup[]
name
name:
string
AdminRequest
AdminRequest<
Payload> =object
Represents an admin request with a specific payload.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
Payload | any | The type of the payload data. |
Properties
body
body:
object
Body of the request containing the method type and payload data.
| Name | Type | Description |
|---|---|---|
data | Payload | Payload data for the request. |
type | typeof ADMIN_API_METHOD_TYPES[keyof typeof ADMIN_API_METHOD_TYPES] | Type of the admin API method. |
id
id:
string
Unique identifier for the request.
type
type: typeof
ADMIN_API_TYPES["ADMIN_REQUEST"]
Type of the admin API request.
AdminResponse
AdminResponse<
Response> =object
Represents an admin response with a specific payload.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
Response | any | The type of the response data. |
Properties
body
body:
Response
Body of the response containing the response data.
id
id:
string
Unique identifier for the response.
type
type: typeof
ADMIN_API_TYPES["ADMIN_RESPONSE"]
Type of the admin API response.
AdminSelectAgendaRequest
AdminSelectAgendaRequest =
object
Properties
attach_to?
optionalattach_to?:AgendaSelectorProps["attachTo"]
initial_agenda?
optionalinitial_agenda?:AgendaSelectorProps["initialAgenda"]
AdminSelectAgendaResponse
AdminSelectAgendaResponse =
object
Properties
content?
optionalcontent?:Agenda
Selected content
user_action
user_action:
"cancelled"|"selected"
User action result
AdminSelectCanvasesRequest
AdminSelectCanvasesRequest =
object
Properties
allowed_ids?
optionalallowed_ids?:Canvas["id"][]
Array of canvas ids to include in the picker (optional).
allowed_types?
optionalallowed_types?: ("canvas"|"canvas-template"|"section"|"section-template")[]
Array of canvas types to include in the picker (optional).
initial_metadata_filters?
optionalinitial_metadata_filters?:Record<string,any>
Initial metadata filters to apply to the picker (optional).
selections?
optionalselections?:CanvasSelection[]
Array of selections.
sequencing_key?
optionalsequencing_key?:string
The sequencing key to use for ordering the canvases (optional).
AdminSelectCanvasesResponse
AdminSelectCanvasesResponse =
object
Properties
canvases?
optionalcanvases?:Canvas[]
Selected canvases
user_action
user_action:
"cancelled"|"selected"
User action result
AdminSelectCollectionPlayerRequest
AdminSelectCollectionPlayerRequest =
object
Properties
attach_to?
optionalattach_to?:CollectionSelectorProps["attachTo"]
close_on_settings?
optionalclose_on_settings?:CollectionSelectorProps["closeOnSettings"]
hide_close?
optionalhide_close?:CollectionSelectorProps["hideClose"]
initial_data?
optionalinitial_data?:CollectionSelectorProps["initialData"]
initial_metadata_filters?
optionalinitial_metadata_filters?:CollectionSelectorProps["initialMetadataFilters"]
open_settings?
optionalopen_settings?:CollectionSelectorProps["openSettings"]
readonly_name?
optionalreadonly_name?:CollectionSelectorProps["readonlyName"]
translations?
optionaltranslations?:CollectionSelectorProps["translations"]
AdminSelectCollectionPlayerResponse
AdminSelectCollectionPlayerResponse =
object
Properties
content?
optionalcontent?:CollectionPlayer
Selected content
user_action
user_action:
"cancelled"|"selected"|"settings"
User action result
AdminSelectContentRequest
AdminSelectContentRequest =
object
Represents a request to select content.
Properties
allow_converted_deck_pages?
optionalallow_converted_deck_pages?:boolean
Lets the user pick single pages of a PPTX deck converted to HTML, as with a PDF (optional). Such a page has a page image but no PDF behind it, so set this only where a page is shown as an image.
allowed_ids?
optionalallowed_ids?:File["id"][]
Array of file ids to include in the picker (optional).
allowed_original_extensions?
optionalallowed_original_extensions?:string[]
Array of file extensions to scope out list of the results (optional). Only files with these extensions will be shown.
allowed_selector_types?
optionalallowed_selector_types?:SelectorType[]
Array of selector types to include in the picker (optional).
content_type?
optionalcontent_type?:"file"|"slide"|"content"
Type of content to allow selection for (optional). file: Files only slide: Slides only content: Files and slides
Default
ts
'content'disable_no_pptx_data?
optionaldisable_no_pptx_data?:boolean
Disables files from selection which do not have pptx_data in metadata object (optional).
disable_no_sharable?
optionaldisable_no_sharable?:boolean
Disables files from selection which are not sharable (optional).
initial_metadata_filters?
optionalinitial_metadata_filters?:Record<string,any>
Initial metadata filters to apply to the picker (optional).
max_selections?
optionalmax_selections?:number
Maximum number of selections allowed (optional).
min_selections?
optionalmin_selections?:number
Minimum number of selections allowed (optional).
only_allow_content_pdf_pages?
optionalonly_allow_content_pdf_pages?:boolean
Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
selections?
optionalselections?:Selection[]
List of selections to hydrate the picker with.
style?
optionalstyle?:Record<string,any>
CSS style to apply to the picker (optional).
AdminSelectContentResponse
AdminSelectContentResponse =
object
Represents a response to a content selection request.
Properties
content?
optionalcontent?: (SelectedFile|SelectedPage)[]
Selected content, if any.
user_action
user_action:
"cancelled"|"selected"
Action taken by the user.
CRMServiceType
CRMServiceType =
"salesforce"|"dynamics"|"sap"
DsrEnv
DsrEnv =
Pick<PitcherEnv,"mode"|"launch_darkly"|"client_type"|"state"> &object
Type Declaration
pitcher?
optionalpitcher?:object
pitcher.access_token?
optionalaccess_token?:string
DsrMessage
DsrMessage<
Payload> =object
Type Parameters
| Type Parameter | Default type |
|---|---|
Payload | any |
Properties
body
body:
object
| Name | Type |
|---|---|
data | Payload |
type | typeof DSR_MESSAGE_TYPES[keyof typeof DSR_MESSAGE_TYPES] |
id
id:
string
type
type: typeof
DSR_MESSAGE
DsrMessagePayloads
DsrMessagePayloads =
object
Properties
dsr_env_changed
dsr_env_changed:
DsrEnv
DsrRequest
DsrRequest<
Payload> =object
Type Parameters
| Type Parameter | Default type |
|---|---|
Payload | any |
Properties
body
body:
object
| Name | Type |
|---|---|
data | Payload |
type | typeof DSR_API_METHOD_TYPES[keyof typeof DSR_API_METHOD_TYPES] |
id
id:
string
type
type: typeof
DSR_API_TYPES["DSR_REQUEST"]
DsrResponse
DsrResponse<
Response> =object
Type Parameters
| Type Parameter | Default type |
|---|---|
Response | any |
Properties
body
body:
Response
id
id:
string
type
type: typeof
DSR_API_TYPES["DSR_RESPONSE"]
FolderListRequest
FolderListRequest =
object
Properties
fields?
optionalfields?:string
filters?
optionalfilters?:Record<string,any>
id__in?
optionalid__in?:string[]
name?
optionalname?:string
ordering?
optionalordering?:string
page?
optionalpage?:number
page_size?
optionalpage_size?:number
search?
optionalsearch?:string
JsApiLocation
JsApiLocation =
"ui"|"admin"|"dsr"|"impact"
ListFilesPayload
Payload for listing files with optional filters.
Type Declaration
content_type?
optionalcontent_type?:File["content_type"] |File["content_type"][]
Filter for content types.
created_at__range?
optionalcreated_at__range?:string
Range filter for creation date.
expires_at__range?
optionalexpires_at__range?:string
Range filter for expiration date.
id__in?
optionalid__in?:string
Filter for file IDs.
type?
Filter for file types.
updated_at__range?
optionalupdated_at__range?:string
Range filter for update date.
LocationRoutes
LocationRoutes =
Record<string,LocationRoute>
A record of location routes.
PeerConnectivityAction
PeerConnectivityAction = typeof
PeerConnectivityActions[keyof typeofPeerConnectivityActions] |string
PeerConnectivityEventHandler
PeerConnectivityEventHandler<
TData,TContext> = (event) =>void
Type Parameters
| Type Parameter | Default type |
|---|---|
TData extends Record<string, unknown> | Record<string, unknown> |
TContext extends PeerConnectivityContext | PeerConnectivityContext |
Parameters
| Parameter | Type |
|---|---|
event | PeerConnectivityEvent<TData, TContext> |
Returns
void
PitcherMode
PitcherMode =
PitcherEnv["mode"]
PitcherPlatformType
PitcherPlatformType = typeof
PLATFORM_TYPE[keyof typeofPLATFORM_TYPE]
ShareResponse
ShareResponse =
object
Represents a response to a iOS sharing dialog.
Properties
activity_type?
optionalactivity_type?:string
Type of share action.
user_action
user_action:
"cancelled"|"shared"
Action taken by the user.
SttEngineKind
SttEngineKind =
"native"|"whisper"|"webspeech"
Which engine answers stt.start on the current platform: "native" (iOS on-device Speech), "whisper" (web on-device Whisper) or "webspeech" (web cloud fallback, audio leaves the device).
SttErrorCode
SttErrorCode =
"STT_DISABLED"|"STT_DEVICE_UNSUPPORTED"|"STT_MODEL_NOT_READY"|"STT_BUSY"|"STT_MIC_PERMISSION_DENIED"|"STT_NOT_RECORDING"|"STT_CAPTURE_FAILED"|"STT_ERROR"
Error codes returned on a rejected stt.start / stt.stop — cross-platform (iOS bridge AND the web host engines). Surfaced verbatim in the rejected request's error body (iOS: error_code/errorCode; web: the error message / reason string — read them uniformly via api.sttErrorCode).
STT_DISABLED— theenable_stt_dictationconfig flag is off for this instance.STT_DEVICE_UNSUPPORTED— the device can't run the on-device model.STT_MODEL_NOT_READY— the whisper model isn't downloaded yet. Trigger a model download (ai.download_modelwith"whisper"), then retrystt.start.STT_BUSY— the mic is held by another session (a live call recording, or another dictation). Surface a "mic in use" hint / prompt to stop the other session.STT_MIC_PERMISSION_DENIED— microphone permission was denied.STT_NOT_RECORDING—stt.stopfor asession_idthat isn't active.STT_CAPTURE_FAILED/STT_ERROR— generic capture / other failure.
SttUnavailableReason
SttUnavailableReason =
"disabled"|"unsupported"
Why dictation is unavailable: "disabled" (the enable_stt_dictation instance flag is off) or "unsupported" (no engine can run on this device).
SupportedEnvLocale
SupportedEnvLocale = typeof
supportedEnvLocales[number]
TtsErrorCode
TtsErrorCode =
"TTS_EMPTY_TEXT"|"TTS_VOICE_UNAVAILABLE"|"TTS_MODEL_NOT_READY"|"TTS_ERROR"
Error codes returned on tts.speak — as a bridge APIError ({ code, message, details }) on iOS, or in the host { reason } on web.
TTS_EMPTY_TEXT— no text was provided.TTS_VOICE_UNAVAILABLE— alanguagewas requested but no installed voice matches. The message tells the user to download it (iOS Settings › Accessibility › Spoken Content › Voices) — surface it so the UI can prompt.TTS_MODEL_NOT_READY— the web on-device model isn't downloaded/loaded yet. When Web Speech is supported, the web host retries transparently through it, so apps normally never see this. It only surfaces when Web Speech is unavailable; if the Web Speech retry itself fails, its error propagates instead.TTS_ERROR— unexpected fallback.
UiAppFullscreenChangeRequest
UiAppFullscreenChangeRequest =
object
Properties
is_fullscreen
is_fullscreen:
boolean
Whether the app is now showing content fullscreen (true) or has left fullscreen (false)
UiAppOpenRequestPayload
UiAppOpenRequestPayload =
Record<string,string>
A canvas link's allowlisted route query, sent to the app already on screen, e.g. { training_id }.
UiAppResizeRequest
UiAppResizeRequest =
object
Properties
height
height:
number
Requested height as the number of pixels
UiAppSetDataPayload
UiAppSetDataPayload =
object
Properties
canvas
canvas:
CanvasRetrieve
Canvas data
canvas_correlation_id
canvas_correlation_id:
string|undefined
Canvas correlation ID for tracking
client
client:
string|null
Client name
component_id
component_id:
string
Component ID
display_mode
display_mode:
string|undefined
Display mode
full_screen_mode
full_screen_mode:
boolean|undefined
Full screen mode status
height
height:
string|undefined
Height of the canvas
in_call
in_call:
boolean
Call status
is_edit_mode
is_edit_mode:
boolean
Edit mode status
platform
platform:
string|undefined
Platform name
section_index
section_index:
number|null
Section index in section list
section_list_id
section_list_id:
string|null
Section list ID
settings
settings:
EmbeddableProps["settings"] |null
Embeddable settings
used_in_section
used_in_section:
CanvasSection|null
Section used in canvas
user
user:
User|null
User information
width
width:
string|undefined
Width of the canvas
UiAppUpdateDataPayload
UiAppUpdateDataPayload =
object
Properties
in_call
in_call:
boolean
Call status
is_edit_mode
is_edit_mode:
boolean
Edit mode status
UiBroadcastRequest
UiBroadcastRequest =
Record<string,any>
UiCanvasNavigatePageRequest
UiCanvasNavigatePageRequest =
object
Properties
page
page:
ComponentNode["id"]
The id of the component we want to navigate to
UiCanvasUpdatedPayload
UiCanvasUpdatedPayload =
object
Properties
canvas
canvas:
CanvasRetrieve
Canvas data
UiCaptureAppErrorRequest
UiCaptureAppErrorRequest =
Record<string,any>
Error object to send to Pitcher sentry instance
UiCompletePostcallRequest
UiCompletePostcallRequest =
object
Properties
was_successfully_submitted?
optionalwas_successfully_submitted?:boolean
Indicates if the postcall was successfully submitted
UiMeetingCanceledPayload
UiMeetingCanceledPayload =
object
Properties
accountId?
optionalaccountId?:string
Account ID
eventId?
optionaleventId?:string
Event ID
UiMessageEnvelope
UiMessageEnvelope<
T> =object
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends typeof UI_MESSAGE_TYPES[keyof typeof UI_MESSAGE_TYPES] | typeof UI_MESSAGE_TYPES[keyof typeof UI_MESSAGE_TYPES] |
Properties
body
body:
UiMessagePayloads[T]
Message body
type
type:
T
Message type
UiMessagePayloads
UiMessagePayloads =
object
Properties
ui_app_open_request
ui_app_open_request:
UiAppOpenRequestPayload
ui_app_set_data
ui_app_set_data:
UiAppSetDataPayload
ui_app_update_data
ui_app_update_data:
UiAppUpdateDataPayload
ui_canvas_updated
ui_canvas_updated:
UiCanvasUpdatedPayload
ui_meeting_canceled
ui_meeting_canceled:
UiMeetingCanceledPayload
ui_prompt_pia_response_streamed
ui_prompt_pia_response_streamed:
UiPromptPiaResponseStreamedPayload
ui_section_list_updated
ui_section_list_updated:
UiSectionListUpdatedPayload
UiOpenRequest
UiOpenRequest =
OpenRequestPayload&object
Type Declaration
app_context?
optionalapp_context?:Record<string,any>
Context to pass to the app
app_embed_location?
optionalapp_embed_location?:EmbedLocation
Embed location of the app
app_name?
optionalapp_name?:string
Name of the app to open
UiPrintCanvasRequest
UiPrintCanvasRequest =
object
Properties
id
id:
CanvasRetrieve["id"]
Canvas ID to print
notify_url?
optionalnotify_url?:string
Optional HTTPS URL for async download notifications
UiPrintCanvasResponse
UiPrintCanvasResponse =
object
Properties
job_id?
optionaljob_id?:string
Job ID for tracking the async download
success
success:
boolean
Indicates if the request was successful
UiPromptPiaRequest
UiPromptPiaRequest =
object
Properties
id
id:
string
Unique identifier of this prompt (needed for streaming event)
prompt
prompt:
string
Prompt to send to PIA
UiPromptPiaResponse
UiPromptPiaResponse =
object
Properties
id
id:
string
Unique identifier of this prompt (needed for streaming event)
response
response:
string
PIA response
UiPromptPiaResponseStreamedPayload
UiPromptPiaResponseStreamedPayload =
object
Properties
chunk
chunk:
string
Current chunk of the response
id
id:
string
Unique identifier of this prompt
partial_response
partial_response:
string
PIA response so far
UiSectionListUpdatedPayload
UiSectionListUpdatedPayload =
object
Properties
canvas
canvas:
CanvasRetrieve|null
Canvas data
section_list_component_id
section_list_component_id:
string
Section list component ID
section_list_ids
section_list_ids:
string[]
List of section IDs
UiSelectAgendaRequest
UiSelectAgendaRequest =
object
Properties
attach_to?
optionalattach_to?:AgendaSelectorProps["attachTo"]
initial_agenda?
optionalinitial_agenda?:AgendaSelectorProps["initialAgenda"]
UiSelectAgendaResponse
UiSelectAgendaResponse =
object
Properties
content?
optionalcontent?:Agenda
Selected content
user_action
user_action:
"cancelled"|"selected"
User action result
UiSelectCanvasesRequest
UiSelectCanvasesRequest =
object
Properties
allowed_ids?
optionalallowed_ids?:Canvas["id"][]
allowed_types?
optionalallowed_types?: ("canvas"|"canvas-template"|"section"|"section-template")[]
initial_metadata_filters?
optionalinitial_metadata_filters?:Record<string,any>
selections?
optionalselections?:CanvasSelection[]
Array of selections
UiSelectCanvasesResponse
UiSelectCanvasesResponse =
object
Properties
canvases?
optionalcanvases?:Canvas[]
Selected canvases
user_action
user_action:
"cancelled"|"selected"
User action result
UiSelectCollectionPlayerRequest
UiSelectCollectionPlayerRequest =
object
Properties
attach_to?
optionalattach_to?:CollectionSelectorProps["attachTo"]
close_on_settings?
optionalclose_on_settings?:CollectionSelectorProps["closeOnSettings"]
hide_close?
optionalhide_close?:CollectionSelectorProps["hideClose"]
initial_data?
optionalinitial_data?:CollectionSelectorProps["initialData"]
initial_metadata_filters?
optionalinitial_metadata_filters?:CollectionSelectorProps["initialMetadataFilters"]
open_settings?
optionalopen_settings?:CollectionSelectorProps["openSettings"]
readonly_name?
optionalreadonly_name?:CollectionSelectorProps["readonlyName"]
translations?
optionaltranslations?:CollectionSelectorProps["translations"]
UiSelectCollectionPlayerResponse
UiSelectCollectionPlayerResponse =
object
Properties
content?
optionalcontent?:CollectionPlayer
Selected content
user_action
user_action:
"cancelled"|"selected"|"settings"
User action result
UiSelectContentRequest
UiSelectContentRequest =
object
Properties
allow_converted_deck_pages?
optionalallow_converted_deck_pages?:boolean
Lets the user pick single pages of a PPTX deck converted to HTML, as with a PDF (optional). Such a page has a page image but no PDF behind it, so set this only where a page is shown as an image.
allowed_asset_content_types?
optionalallowed_asset_content_types?:FileContentTypeEnum[]
allowed_content_types?
optionalallowed_content_types?:FileContentTypeEnum[]
allowed_ids?
optionalallowed_ids?:File["id"][]
allowed_original_extensions?
optionalallowed_original_extensions?:string[]
Array of file extensions to scope out list of the results (optional). Only files with these extensions will be shown.
allowed_selector_types?
optionalallowed_selector_types?:SelectorType[]
content_type?
optionalcontent_type?:"file"|"slide"|"content"
disable_no_pptx_data?
optionaldisable_no_pptx_data?:boolean
Disables files from selection which do not have pptx_data in metadata object (optional).
disable_no_sharable?
optionaldisable_no_sharable?:boolean
Disables files from selection which are not sharable (optional).
embed_variant?
optionalembed_variant?:string
Named sub-embedding of the content selector, forwarded verbatim to the selector app's window.initialize payload so ONE selector app can present itself differently per caller (PIT-7510: ng-wizard for the pitchdeck wizard). embed_location itself is set by the HOST and always wins, so a caller-specific context needs its own field.
initial_metadata_filters?
optionalinitial_metadata_filters?:Record<string,any>
max_selections?
optionalmax_selections?:number
min_selections?
optionalmin_selections?:Range<0,999>
only_allow_content_pdf_pages?
optionalonly_allow_content_pdf_pages?:boolean
Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
selections?
optionalselections?:Selection[]
Array of selections
UiSelectContentResponse
UiSelectContentResponse =
object
Properties
content?
optionalcontent?: (SelectedFile|SelectedPage)[]
Selected content
user_action
user_action:
"cancelled"|"selected"
User action result
UiSetPostcallStyleRequest
UiSetPostcallStyleRequest =
Record<string,any>
UiUpdateCanvasRequest
UiUpdateCanvasRequest =
Mutable<CanvasRetrieve> &object
Type Declaration
fields?
optionalfields?:string
Comma-separated list of field keys to return from the server
UpdateLocationPitcherEvent
UpdateLocationPitcherEvent =
UpdateLocationOnUnregister|UpdateLocationOnRestore|UpdateLocationOnUpdate|UpdateLocationOnRegister|UpdateLocationOnRestoreCompleted|UpdateLocationOnMounted|UpdateLocationOnGetRoutesRequest|UpdateLocationOnGetRoutesResponse
Union type for all update location pitcher events.
Variables
ADMIN_API_METHOD_TYPES
constADMIN_API_METHOD_TYPES:object
Type Declaration
CAPTURE_APP_ERROR
readonlyCAPTURE_APP_ERROR:"admin_capture_app_error"='admin_capture_app_error'
CLOSE
readonlyCLOSE:"admin_close_file_overlay"='admin_close_file_overlay'
CREATE_CANVAS
readonlyCREATE_CANVAS:"admin_create_canvas"='admin_create_canvas'
GET_APP_CONFIG
readonlyGET_APP_CONFIG:"admin_get_app_config"='admin_get_app_config'
GET_CANVAS
readonlyGET_CANVAS:"admin_get_canvas"='admin_get_canvas'
GET_CANVASES
readonlyGET_CANVASES:"admin_get_canvases"='admin_get_canvases'
GET_ENV
readonlyGET_ENV:"admin_get_env"='admin_get_env'
GET_FILE
readonlyGET_FILE:"admin_get_file"='admin_get_file'
GET_FILES
readonlyGET_FILES:"admin_get_files"='admin_get_files'
GET_INSTANCE_METADATA_TEMPLATES
readonlyGET_INSTANCE_METADATA_TEMPLATES:"admin_get_instance_metadata_templates"='admin_get_instance_metadata_templates'
GET_USERS
readonlyGET_USERS:"admin_get_users"='admin_get_users'
OPEN
readonlyOPEN:"admin_open_file_overlay"='admin_open_file_overlay'
OPEN_CANVAS_OVERLAY
readonlyOPEN_CANVAS_OVERLAY:"admin_open_canvas_overlay"='admin_open_canvas_overlay'
OPEN_COLLECTION_PLAYER_OVERLAY
readonlyOPEN_COLLECTION_PLAYER_OVERLAY:"admin_open_collection_player_overlay"='admin_open_collection_player_overlay'
SELECT_AGENDA_CONTENT
readonlySELECT_AGENDA_CONTENT:"admin_select_agenda_content"='admin_select_agenda_content'
SELECT_CANVASES
readonlySELECT_CANVASES:"admin_select_canvases"='admin_select_canvases'
SELECT_COLLECTION_PLAYER_CONTENT
readonlySELECT_COLLECTION_PLAYER_CONTENT:"admin_select_collection_player_content"='admin_select_collection_player_content'
SELECT_CONTENT
readonlySELECT_CONTENT:"admin_select_content"='admin_select_content'
TOAST
readonlyTOAST:"admin_toast"='admin_toast'
UPDATE_CANVAS
readonlyUPDATE_CANVAS:"admin_update_canvas"='admin_update_canvas'
ADMIN_API_TYPES
constADMIN_API_TYPES:object
Type Declaration
ADMIN_REQUEST
readonlyADMIN_REQUEST:"ADMIN_REQUEST"='ADMIN_REQUEST'
ADMIN_RESPONSE
readonlyADMIN_RESPONSE:"ADMIN_RESPONSE"='ADMIN_RESPONSE'
ADMIN_MESSAGE
constADMIN_MESSAGE:"ADMIN_MESSAGE"
ADMIN_MESSAGE_TYPES
constADMIN_MESSAGE_TYPES:object
Type Declaration
ENV_CHANGED
readonlyENV_CHANGED:"admin_env_changed"='admin_env_changed'
DEFAULT_PEER_CONNECTIVITY_VERSION
constDEFAULT_PEER_CONNECTIVITY_VERSION:1=1
DSR_API_METHOD_TYPES
constDSR_API_METHOD_TYPES:object
Type Declaration
CLOSE
readonlyCLOSE:"dsr_close"='dsr_close'
DSR_EMBEDDABLE_READY
readonlyDSR_EMBEDDABLE_READY:"dsr_embeddable_ready"='dsr_embeddable_ready'
GET_APP_CONFIG
readonlyGET_APP_CONFIG:"dsr_get_app_config"='dsr_get_app_config'
GET_ENV
readonlyGET_ENV:"dsr_get_env"='dsr_get_env'
GET_FILE
readonlyGET_FILE:"dsr_get_file"='dsr_get_file'
DSR_API_TYPES
constDSR_API_TYPES:object
Type Declaration
DSR_REQUEST
readonlyDSR_REQUEST:"DSR_REQUEST"='DSR_REQUEST'
DSR_RESPONSE
readonlyDSR_RESPONSE:"DSR_RESPONSE"='DSR_RESPONSE'
DSR_MESSAGE
constDSR_MESSAGE:"DSR_MESSAGE"
DSR_MESSAGE_TYPES
constDSR_MESSAGE_TYPES:object
Type Declaration
ENV_CHANGED
readonlyENV_CHANGED:"dsr_env_changed"='dsr_env_changed'
highLevelApi
highLevelApi:
ReturnType<typeofcreateHighLevelApi>
PEER_CONNECTIVITY_EVENT
constPEER_CONNECTIVITY_EVENT:"peer_connectivity_event"='peer_connectivity_event'
PEER_CONNECTIVITY_HANDLER_MATCH_ALL
constPEER_CONNECTIVITY_HANDLER_MATCH_ALL:"*"='*'
PeerConnectivityActions
constPeerConnectivityActions:object
Type Declaration
BROWSER_FOLDER_OPEN
readonlyBROWSER_FOLDER_OPEN:"browser.folder.open"='browser.folder.open'
CANVAS_CLOSE
readonlyCANVAS_CLOSE:"canvas.close"='canvas.close'
CANVAS_OPEN
readonlyCANVAS_OPEN:"canvas.open"='canvas.open'
CANVAS_PAGE_NEXT
readonlyCANVAS_PAGE_NEXT:"canvas.navigate.next"='canvas.navigate.next'
CANVAS_PAGE_PREVIOUS
readonlyCANVAS_PAGE_PREVIOUS:"canvas.navigate.previous"='canvas.navigate.previous'
FILE_CLOSE
readonlyFILE_CLOSE:"file.close"='file.close'
FILE_OPEN
readonlyFILE_OPEN:"file.open"='file.open'
ROUTE_CHANGE
readonlyROUTE_CHANGE:"route.change"='route.change'
PITCHER_EVENT
constPITCHER_EVENT:"PITCHER_EVENT"
supportedEnvLocales
constsupportedEnvLocales: readonly ["da","de","el","en","es","fr","it","ja","nl","pl","pt","pt-br","th","tr","zh"]
The platform locale roster for installable apps: every locale an app's src/locales/ bundles when it follows the platform-wide i18n rollout (PIT-8288). An app that bundles fewer passes its own roster to resolveEnvLocale instead.
Not canvas-ui's supportedLocales (Impact/Admin UI, no pl/tr). Both are star-exported from canvas-ui's main.lib.ts, so the names must stay distinct.
UI_API_METHOD_TYPES
constUI_API_METHOD_TYPES:object
Type Declaration
UI_APP_FULLSCREEN_CHANGE
readonlyUI_APP_FULLSCREEN_CHANGE:"ui_app_fullscreen_change"='ui_app_fullscreen_change'
UI_APP_LOADED
readonlyUI_APP_LOADED:"ui_app_loaded"='ui_app_loaded'
UI_APP_RESIZE
readonlyUI_APP_RESIZE:"ui_app_resize"='ui_app_resize'
UI_BROADCAST
readonlyUI_BROADCAST:"ui_broadcast"='ui_broadcast'
UI_CANCEL_MEETING
readonlyUI_CANCEL_MEETING:"ui_cancel_meeting"='ui_cancel_meeting'
UI_CANVAS_NAVIGATE_NEXT_PAGE
readonlyUI_CANVAS_NAVIGATE_NEXT_PAGE:"ui_canvas_navigate_next_page"='ui_canvas_navigate_next_page'
UI_CANVAS_NAVIGATE_PAGE
readonlyUI_CANVAS_NAVIGATE_PAGE:"ui_canvas_navigate_page"='ui_canvas_navigate_page'
UI_CANVAS_NAVIGATE_PREVIOUS_PAGE
readonlyUI_CANVAS_NAVIGATE_PREVIOUS_PAGE:"ui_canvas_navigate_previous_page"='ui_canvas_navigate_previous_page'
UI_CAPTURE_APP_ERROR
readonlyUI_CAPTURE_APP_ERROR:"ui_capture_app_error"='ui_capture_app_error'
UI_CLOSE_CANVAS_DRAWER
readonlyUI_CLOSE_CANVAS_DRAWER:"ui_close_canvas_drawer"='ui_close_canvas_drawer'
UI_CLOSE_CANVAS_SECTION_EXECUTION
readonlyUI_CLOSE_CANVAS_SECTION_EXECUTION:"ui_close_canvas_section_execution"='ui_close_canvas_section_execution'
UI_CLOSE_GLOBAL_POPUP
readonlyUI_CLOSE_GLOBAL_POPUP:"ui_close_global_popup"='ui_close_global_popup'
UI_COMPLETE_POSTCALL
readonlyUI_COMPLETE_POSTCALL:"ui_complete_postcall"='ui_complete_postcall'
UI_DISABLE_POSTCALL_SUBMIT
readonlyUI_DISABLE_POSTCALL_SUBMIT:"ui_disable_postcall_submit"='ui_disable_postcall_submit'
UI_EMBEDDABLE_READY
readonlyUI_EMBEDDABLE_READY:"ui_embeddable_ready"='ui_embeddable_ready'
UI_ENABLE_POSTCALL_SUBMIT
readonlyUI_ENABLE_POSTCALL_SUBMIT:"ui_enable_postcall_submit"='ui_enable_postcall_submit'
UI_OPEN
readonlyUI_OPEN:"ui_open"='ui_open'
UI_OPEN_CANVAS_OVERLAY
readonlyUI_OPEN_CANVAS_OVERLAY:"ui_open_canvas_overlay"='ui_open_canvas_overlay'
UI_OPEN_COLLECTION_PLAYER_OVERLAY
readonlyUI_OPEN_COLLECTION_PLAYER_OVERLAY:"ui_open_collection_player_overlay"='ui_open_collection_player_overlay'
UI_OPEN_GLOBAL_POPUP
readonlyUI_OPEN_GLOBAL_POPUP:"ui_open_global_popup"='ui_open_global_popup'
UI_OPEN_SHARING_SETTINGS
readonlyUI_OPEN_SHARING_SETTINGS:"ui_open_sharing_settings"='ui_open_sharing_settings'
UI_PRESELECT_SFDC_MEETING_ID
readonlyUI_PRESELECT_SFDC_MEETING_ID:"ui_preselect_sfdc_meeting_id"='ui_preselect_sfdc_meeting_id'
UI_PRINT_CANVAS
readonlyUI_PRINT_CANVAS:"ui_print_canvas"='ui_print_canvas'
UI_PROMPT_PIA
readonlyUI_PROMPT_PIA:"ui_prompt_pia"='ui_prompt_pia'
UI_RESUME_MEETING
readonlyUI_RESUME_MEETING:"ui_resume_meeting"='ui_resume_meeting'
UI_SELECT_AGENDA_CONTENT
readonlyUI_SELECT_AGENDA_CONTENT:"ui_select_agenda_content"='ui_select_agenda_content'
UI_SELECT_CANVASES
readonlyUI_SELECT_CANVASES:"ui_select_canvases"='ui_select_canvases'
UI_SELECT_COLLECTION_PLAYER_CONTENT
readonlyUI_SELECT_COLLECTION_PLAYER_CONTENT:"ui_select_collection_player_content"='ui_select_collection_player_content'
UI_SELECT_CONTENT
readonlyUI_SELECT_CONTENT:"ui_select_content"='ui_select_content'
UI_SET_POSTCALL_STYLE
readonlyUI_SET_POSTCALL_STYLE:"ui_set_postcall_style"='ui_set_postcall_style'
UI_STOP_MEETING
readonlyUI_STOP_MEETING:"ui_stop_meeting"='ui_stop_meeting'
UI_TOAST
readonlyUI_TOAST:"ui_toast"='ui_toast'
UI_UPDATE_CANVAS
readonlyUI_UPDATE_CANVAS:"ui_update_canvas"='ui_update_canvas'
UI_UPDATE_LOCATION
readonlyUI_UPDATE_LOCATION:"ui_update_location"='ui_update_location'
UI_MESSAGE
constUI_MESSAGE:"UI_MESSAGE"
UI_MESSAGE_TYPES
constUI_MESSAGE_TYPES:object
Type Declaration
UI_APP_OPEN_REQUEST
readonlyUI_APP_OPEN_REQUEST:"ui_app_open_request"='ui_app_open_request'
UI_APP_SET_DATA
readonlyUI_APP_SET_DATA:"ui_app_set_data"='ui_app_set_data'
UI_APP_UPDATE_DATA
readonlyUI_APP_UPDATE_DATA:"ui_app_update_data"='ui_app_update_data'
UI_CANVAS_UPDATED
readonlyUI_CANVAS_UPDATED:"ui_canvas_updated"='ui_canvas_updated'
UI_MEETING_CANCELED
readonlyUI_MEETING_CANCELED:"ui_meeting_canceled"='ui_meeting_canceled'
UI_PROMPT_PIA_RESPONSE_STREAMED
readonlyUI_PROMPT_PIA_RESPONSE_STREAMED:"ui_prompt_pia_response_streamed"='ui_prompt_pia_response_streamed'
UI_SECTION_LIST_UPDATED
readonlyUI_SECTION_LIST_UPDATED:"ui_section_list_updated"='ui_section_list_updated'
UI_NATIVE_MESSAGE_TYPES
constUI_NATIVE_MESSAGE_TYPES: readonly ["ui_app_set_data","ui_app_update_data","ui_canvas_updated"]
WEB_MODE
constWEB_MODE:"WEB"
The one value a browser reports. Every other mode comes from a native shell's bridge.
Functions
| Function | Description |
|---|---|
| createScopedPitcherApi | A DEDICATED api instance for a call site that needs different options, without touching the shared singleton every other consumer holds. |
| getAvailableApis | - |
| isNativeHost | Is this host a NATIVE shell rather than a browser? |
| platformTypeForMode | - |
| registerPeerConnectivityHandler | - |
| resolveEnvLocale | Resolve an app's locale from the platform env: ui_locale (the locale picked in the Pitcher shell, web only), falling back to device_locale (the iOS device locale). Both are TOP-LEVEL env keys, siblings of pitcher. NEVER env.pitcher.user.language: that field is dead (PIT-7554). |
| sendPeerConnectivityEvent | - |
| useAdmin | API methods available in the CatalogIQ Admin. |
| useApi | This method returns an object containing the API methods that are available to you in a given environment, whether that be the Canvas, UI, Admin or DSR. |
| useDsr | API methods available in the CatalogIQ default UI. |
| usePitcherApi | Check out the returned object documentation for the list of available methods. |
| useUi | API methods available in the CatalogIQ default UI. |