@pitcher/canvas-ui

Modules

Module	Description
internal	-

Enumerations

PitcherBroadcastedEventName

Enumeration Members

Enumeration Member	Value
CANVAS_CLOSED	"canvas_closed"
CANVAS_NEXT_BUTTON_CLICKED	"canvas_next_button_clicked"
CANVAS_OPENED	"canvas_opened"
CANVAS_PREVIOUS_BUTTON_CLICKED	"canvas_previous_button_clicked"
FAVORITES_CHANGED	"favorites:changed"
FILE_DOWNLOAD	"file:download"
ROUTE_CHANGED	"route_changed"
UI_HIDE_MODAL	"ui:hide-modal"
UI_SHOW_MODAL	"ui:show-modal"

---

PitcherEventName

Enumeration Members

Enumeration Member	Value
ANALYTICS_CAPTURED	"analytics_captured"
APP_BACKGROUNDED	"app_backgrounded"
APP_FOREGROUNDED	"app_foregrounded"
CANVAS_CLOSE_REQUESTED	"canvas_close_requested"
CANVAS_OPEN_REQUESTED	"canvas_open_requested"
CANVAS_PAGE_NEXT_REQUESTED	"canvas_page_next_requested"
CANVAS_PAGE_PREVIOUS_REQUESTED	"canvas_page_previous_requested"
CANVAS_UPDATED	"canvas_updated"
CANVAS_UPDATED_SUCCESS	"canvas_updated_success"
CONTENT_LIST_REFRESH_REQUESTED	"content_list_refresh_requested"
ENTERED_FULLSCREEN	"entered_fullscreen"
ENV_CHANGED	"env_changed"
EXITED_FULLSCREEN	"exited_fullscreen"
FILE_CLOSED	"file_closed"
FILE_DOWNLOADED	"file_downloaded"
FILE_OPENED	"file_opened"
FILE_UPLOAD_PROGRESS	"file_upload_progress"
GLOBAL_PHOTO_CAPTURED	"global_photo_captured"
ITEM_SHAREBOX_ADD_COMPLETED	"item_sharebox_add_completed"
ITEM_SHAREBOX_ADD_REQUESTED	"item_sharebox_add_requested"
ITEM_SHAREBOX_STATUS_REQUESTED	"item_sharebox_status_requested"
ITEM_SHAREBOX_STATUS_UPDATED	"item_sharebox_status_updated"
NETWORK_CONNECTION_ESTABLISHED	"network_connection_established"
NETWORK_CONNECTION_LOST	"network_connection_lost"
NON_FILES_SYNC_FINISHED	"non_files_sync_finished"
OPEN_FOLDER_REQUESTED	"open_folder_requested"
PEER_CONNECTIVITY_EVENT	"peer_connectivity_event"
PHOTOS_CAPTURED	"photos_captured"
ROUTE_CHANGE_REQUESTED	"route_change_requested"
SUBMIT_POSTCALL_CLICKED	"submit_postcall_clicked"
SYNC_BADGE_VALUE_REPORTED	"sync_badge_value_reported"
UPDATE_LOCATION	"update_location"

---

PitcherExternalEventName

Enumeration Members

Enumeration Member	Value
CREATE_AND_OPEN_CANVAS	"create_and_open_canvas"
OPEN_CANVAS	"open_canvas"
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

Property	Type	Description
closable?	boolean	Indicates if the toast can be closed manually (optional).
duration?	number	Duration for which the toast should be displayed (optional).
keepAliveOnHover?	boolean	Indicates if the toast should remain visible when hovered over (optional).
message	string	Message to be displayed in the toast.
showIcon?	boolean	Indicates if an icon should be shown in the toast (optional).
type	"error" | "info" | "warning" | "success" | "loading"	Type of the toast notification.

---

ApiEventMap

Properties

Property	Type
event	PitcherEvent

---

ApiOptions

Properties

Property	Type
casing?	"camel" | "snake"
errorLogger?	(p: any) => string | void
fetchMode?	FetchMode
logLevel?	"off" | "info" | "debug"

---

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

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').
object	string	The name of the CRM object (e.g., 'Account', 'Contact', 'Opportunity').
record_type_id?	string	Optional record type ID.

---

CRMSmartObjectMetadataPayload

Payload for retrieving CRM smart object metadata (iOS only).

Properties

Property	Type	Description
object	string	The name of the CRM object to retrieve metadata for (e.g., 'Account', 'Contact', 'Opportunity').
record_type_id?	string	Optional record type ID to retrieve metadata for a specific record type.

---

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

Property	Type	Description
ordering?	string	Ordering of the metadata templates. String containing field name to order by.
page?	number	Page number for pagination.
page_size?	number	Number of items per page.
search?	string	Search query for filtering metadata templates.

---

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"

---

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?	null | string	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

Property	Type	Description
modal_settings	object	Settings for the modal window.
modal_settings.height	number	The height of the modal window.
modal_settings.width	number	The width of the modal window.
modal_settings.x	number	The x-coordinate of the modal window.
modal_settings.y	number	The y-coordinate of the modal window.
url	string	The URL to open in the web view.

---

OrgConfigResponse

Properties

Property	Type
auth0	object
auth0.audience	string
auth0.auth0_domain	string
auth0.domain	string
auth0.issuer	string
auth0.region	"us" | "eu" | "au"
auth0.web_client_id	string
auth0_tenant_region	"us" | "eu" | "au"
datadog_region	"us" | "eu"
region	"us" | "eu" | "au"
segment	object
segment.web_write_key	string
segment_region	"us" | "eu"
sentry_region	"us" | "eu"

---

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<TData, TContext>

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<TData, TContext>

Extended by

• PeerConnectivityEvent

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

---

PitcherAPI

Extends

• Emitter<ApiEventMap>

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

Emitter.emit

---

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

Emitter.off

---

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

Emitter.on

---

request()

request(type, body, callback): Promise<PitcherResponse>

Parameters

Parameter	Type
type	string
body	any
callback	() => any

Returns

Promise<PitcherResponse>

---

PitcherEnv

Properties

Property	Type
client_type?	"admin" | "dsr" | "impact" | "impact-canvas-home"
crm_shape?	Record<string, any>
device_locale?	string
launch_darkly?	LaunchDarklyEnv
mode	"WEB" | "IOS" | "WINDOWS" | "ANDROID"
pitcher	object
pitcher.access_token	string
pitcher.id_token	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

---

PitcherEvent

Properties

Property	Type
body	void | PitcherEnv | Record<string, any> | File | UpdateLocationPitcherEvent | OpenCanvasPitcherEvent | CreateAndOpenCanvasEvent | StartCallPitcherEvent | RouteChangedPitcherEvent | { 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" | "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" | "Algolia Search Performed" | "Algolia Search No Results" | "Algolia Search Result Clicked"; } | Partial<CanvasRetrieve> | { 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; } | PeerConnectivityEvent<Record<string, unknown>, PeerConnectivityContext> | { body: PaginatedData<Favorite>; } | { 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
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" | "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" | "Algolia Search Performed" | "Algolia Search No Results" | "Algolia Search Result Clicked"	-
canvas_close_requested	object	-
canvas_close_requested.canvas_id?	string	-
canvas_closed	object	-
canvas_closed.body	object	-
canvas_closed.body.canvas_id	string	-
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
favorites:changed	object	-
favorites:changed.body	PaginatedData<Favorite>	-
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	-
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	-
start_call	StartCallPitcherEvent	-
submit_postcall_clicked	void	-
sync_badge_value_reported	object	See iOS-only
sync_badge_value_reported.count	number	-
ui:hide-modal	void	-
ui:show-modal	void	-
update_location	UpdateLocationPitcherEvent	-

---

PitcherInterface

Extends

• Emitter<PitcherEventMap>

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

Emitter.emit

---

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

Emitter.off

---

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

Emitter.on

---

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

---

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.

---

StartCallPitcherEvent

Properties

Property	Type
account?	object
account.id	string
account.name	string
canvas_id?	string
contact_ids?	string[]
edit_mode?	"true" | "false"
post_action?	string
post_action_path?	string

---

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.

---

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

---

UiPreselectSfdcMeetingIdRequest

Properties

Property	Type	Description
eventId	string	Salesforce Meeting ID

---

UiPreselectSfdcMeetingIdResponse

Properties

Property	Type	Description
event	null | SfEvent	Salesforce Event

---

UiToastRequest

Properties

Property	Type	Default value	Description
closable?	boolean	true	Visibility of the close button, default is true
duration?	number	3500	Optional, value in milliseconds
keepAliveOnHover?	boolean	true	Toast won't be hidden as long as it is hovered
message	string	**REQUIRED**	Text to show inside the toast
showIcon?	boolean	true	Set to false to hide the icon
type	"error" | "info" | "warning" | "success" | "loading"	**REQUIRED**	Type of the toast, influences the default icon

---

UpdateLocationOnGetRoutesRequest

Interface for the 'get_routes_request' update location action.

Extends

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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

• UpdateLocation

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.

Type Aliases

AdminCaptureAppErrorRequest

AdminCaptureAppErrorRequest: object

Error object to send to Pitcher sentry instance

---

AdminEnv

AdminEnv: object

Represents the admin environment.

Type declaration

client_type?

optional client_type: typeof CLIENT_TYPE[keyof typeof CLIENT_TYPE]

crm_shape?

optional crm_shape: Record<string, any>

launch_darkly?

optional launch_darkly: LaunchDarklyEnv

mode?

optional mode: PitcherEnv["mode"]

Pitcher environment settings.

pitcher

pitcher: PitcherEnv["pitcher"]

state?

optional state: PitcherEnv["state"]

---

AdminMessage<Payload>

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.

Type declaration

body

body: object

Body of the message containing the message type and payload data.

body.data

data: Payload

Payload data for the message.

body.type

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

Type declaration

admin_env_changed

admin_env_changed: AdminEnv

---

AdminOpenCollectionPlayerOverlayGroup

AdminOpenCollectionPlayerOverlayGroup: object

Type declaration

id

id: string

name

name: string

slides?

optional slides: object[]

---

AdminOpenCollectionPlayerOverlayRequest

AdminOpenCollectionPlayerOverlayRequest: object

Type declaration

groups

groups: AdminOpenCollectionPlayerOverlayGroup[]

name

name: string

---

AdminRequest<Payload>

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.

Type declaration

body

body: object

Body of the request containing the method type and payload data.

body.data

data: Payload

Payload data for the request.

body.type

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<Response>

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.

Type declaration

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

Type declaration

attach_to?

optional attach_to: AgendaSelectorProps["attachTo"]

initial_agenda?

optional initial_agenda: AgendaSelectorProps["initialAgenda"]

---

AdminSelectAgendaResponse

AdminSelectAgendaResponse: object

Type declaration

content?

optional content: Agenda

Selected content

user_action

user_action: "cancelled" | "selected"

User action result

---

AdminSelectCanvasesRequest

AdminSelectCanvasesRequest: object

Type declaration

allowed_ids?

optional allowed_ids: Canvas["id"][]

Array of canvas ids to include in the picker (optional).

allowed_types?

optional allowed_types: ("canvas" | "canvas-template" | "section" | "section-template")[]

Array of canvas types to include in the picker (optional).

initial_metadata_filters?

optional initial_metadata_filters: Record<string, any>

Initial metadata filters to apply to the picker (optional).

selections?

optional selections: CanvasSelection[]

Array of selections.

sequencing_key?

optional sequencing_key: string

The sequencing key to use for ordering the canvases (optional).

---

AdminSelectCanvasesResponse

AdminSelectCanvasesResponse: object

Type declaration

canvases?

optional canvases: Canvas[]

Selected canvases

user_action

user_action: "cancelled" | "selected"

User action result

---

AdminSelectCollectionPlayerRequest

AdminSelectCollectionPlayerRequest: object

Type declaration

attach_to?

optional attach_to: CollectionSelectorProps["attachTo"]

close_on_settings?

optional close_on_settings: CollectionSelectorProps["closeOnSettings"]

hide_close?

optional hide_close: CollectionSelectorProps["hideClose"]

initial_data?

optional initial_data: CollectionSelectorProps["initialData"]

initial_metadata_filters?

optional initial_metadata_filters: CollectionSelectorProps["initialMetadataFilters"]

open_settings?

optional open_settings: CollectionSelectorProps["openSettings"]

readonly_name?

optional readonly_name: CollectionSelectorProps["readonlyName"]

translations?

optional translations: CollectionSelectorProps["translations"]

---

AdminSelectCollectionPlayerResponse

AdminSelectCollectionPlayerResponse: object

Type declaration

content?

optional content: CollectionPlayer

Selected content

user_action

user_action: "cancelled" | "selected" | "settings"

User action result

---

AdminSelectContentRequest

AdminSelectContentRequest: object

Represents a request to select content.

Type declaration

allowed_ids?

optional allowed_ids: File["id"][]

Array of file ids to include in the picker (optional).

allowed_original_extensions?

optional allowed_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?

optional allowed_selector_types: SelectorType[]

Array of selector types to include in the picker (optional).

content_type?

optional content_type: "file" | "slide" | "content"

Type of content to allow selection for (optional). file: Files only slide: Slides only content: Files and slides

Default

'content'

disable_no_pptx_data?

optional disable_no_pptx_data: boolean

Disables files from selection which do not have pptx_data in metadata object (optional).

disable_no_sharable?

optional disable_no_sharable: boolean

Disables files from selection which are not sharable (optional).

initial_metadata_filters?

optional initial_metadata_filters: Record<string, any>

Initial metadata filters to apply to the picker (optional).

max_selections?

optional max_selections: number

Maximum number of selections allowed (optional).

min_selections?

optional min_selections: number

Minimum number of selections allowed (optional).

only_allow_content_pdf_pages?

optional only_allow_content_pdf_pages: boolean

Only allow content pdf pages (optional). User will be forced to select a page from the pdf.

selections?

optional selections: Selection[]

List of selections to hydrate the picker with.

style?

optional style: Record<string, any>

CSS style to apply to the picker (optional).

---

AdminSelectContentResponse

AdminSelectContentResponse: object

Represents a response to a content selection request.

Type declaration

content?

optional content: (SelectedFile | SelectedPage)[]

Selected content, if any.

user_action

user_action: "cancelled" | "selected"

Action taken by the user.

---

CRMServiceType

CRMServiceType: "salesforce" | "dynamics" | "sap"

---

DsrEnv

DsrEnv: object

Type declaration

client_type?

optional client_type: undefined | "admin" | "dsr" | "impact" | "impact-canvas-home"

launch_darkly?

optional launch_darkly: undefined | LaunchDarklyEnv

mode

mode: "WEB" | "IOS" | "WINDOWS" | "ANDROID"

pitcher?

optional pitcher: undefined | { access_token: string; }

state?

optional state: undefined | { active_canvas_id: string; active_file: { id: string; }; active_section_id: string; canvas_correlation_id: string; }

---

DsrMessage<Payload>

DsrMessage<Payload>: object

Type Parameters

Type Parameter	Default type
Payload	any

Type declaration

body

body: object

body.data

data: Payload

body.type

type: typeof DSR_MESSAGE_TYPES[keyof typeof DSR_MESSAGE_TYPES]

id

id: string

type

type: typeof DSR_MESSAGE

---

DsrMessagePayloads

DsrMessagePayloads: object

Type declaration

dsr_env_changed

dsr_env_changed: DsrEnv

---

DsrRequest<Payload>

DsrRequest<Payload>: object

Type Parameters

Type Parameter	Default type
Payload	any

Type declaration

body

body: object

body.data

data: Payload

body.type

type: typeof DSR_API_METHOD_TYPES[keyof typeof DSR_API_METHOD_TYPES]

id

id: string

type

type: typeof DSR_API_TYPES["DSR_REQUEST"]

---

DsrResponse<Response>

DsrResponse<Response>: object

Type Parameters

Type Parameter	Default type
Response	any

Type declaration

body

body: Response

id

id: string

type

type: typeof DSR_API_TYPES["DSR_RESPONSE"]

---

FolderListRequest

FolderListRequest: object

Type declaration

fields?

optional fields: string

filters?

optional filters: Record<string, any>

id__in?

optional id__in: string[]

name?

optional name: string

ordering?

optional ordering: string

page?

optional page: number

page_size?

optional page_size: number

search?

optional search: string

---

GetRecentFilesPayload

GetRecentFilesPayload: object

Payload for getting recent files.

Type declaration

size?

optional size: number

Number of recent files to retrieve.

---

JsApiLocation

JsApiLocation: "ui" | "admin" | "dsr" | "impact"

---

ListFilesPayload

ListFilesPayload: object

Payload for listing files with optional filters.

Type declaration

access_type

access_type: undefined | AccessTypeEnum

app_metadata

app_metadata: undefined | Record<string, any>

content_extension

content_extension: undefined | null | string

content_length

content_length: undefined | null | number

content_type

content_type: undefined | FileContentTypeEnum & (FileContentTypeEnum | FileContentTypeEnum[])

content_url

content_url: undefined | null | string

created_at

created_at: undefined | string

created_at__range?

optional created_at__range: undefined | string

Range filter for creation date.

created_by

created_by: undefined | MiniUser

download_type

download_type: undefined | DownloadTypeEnum

expires_at

expires_at: undefined | null | string

expires_at__range?

optional expires_at__range: undefined | string

Range filter for expiration date.

folder

folder: undefined | MiniFolder

folder_id

folder_id: undefined | string

global_id

global_id: undefined | string

id

id: undefined | string

id__in?

optional id__in: undefined | string

Filter for file IDs.

instance_id

instance_id: undefined | string

metadata

metadata: undefined | Record<string, any>

modified_at

modified_at: undefined | string

modified_by

modified_by: undefined | MiniUser

name

name: undefined | string

original_extension

original_extension: undefined | null | string

original_url

original_url: undefined | null | string

owned_by

owned_by: undefined | MiniUser

permissions

permissions: undefined | FilePermission

published_at

published_at: undefined | null | string

role

role: undefined | CollaborationRoleEnum

shared_link

shared_link: undefined | MiniSharedLink

size

size: undefined | null | number

status

status: undefined | FileStatusEnum

tags

tags: undefined | string[]

thumbnail_url

thumbnail_url: undefined | null | string

type?

optional type: undefined | FileTypeEnum | FileTypeEnum[]

Filter for file types.

updated_at__range?

optional updated_at__range: undefined | string

Range filter for update date.

zip_size

zip_size: undefined | null | number

zip_url

zip_url: undefined | null | string

---

LocationRoutes

LocationRoutes: object

A record of location routes.

---

PeerConnectivityAction

PeerConnectivityAction: typeof PeerConnectivityActions[keyof typeof PeerConnectivityActions] | string

---

PeerConnectivityEventHandler()<TData, TContext>

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

---

ShareResponse

ShareResponse: object

Represents a response to a iOS sharing dialog.

Type declaration

activity_type?

optional activity_type: string

Type of share action.

user_action

user_action: "cancelled" | "shared"

Action taken by the user.

---

UiAppResizeRequest

UiAppResizeRequest: object

Type declaration

height

height: number

Requested height as the number of pixels

---

UiAppSetDataPayload

UiAppSetDataPayload: object

Type declaration

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

Type declaration

in_call

in_call: boolean

Call status

is_edit_mode

is_edit_mode: boolean

Edit mode status

---

UiBroadcastRequest

UiBroadcastRequest: object

---

UiCanvasNavigatePageRequest

UiCanvasNavigatePageRequest: object

Type declaration

page

page: ComponentNode["id"]

The id of the component we want to navigate to

---

UiCanvasUpdatedPayload

UiCanvasUpdatedPayload: object

Type declaration

canvas

canvas: CanvasRetrieve

Canvas data

---

UiCaptureAppErrorRequest

UiCaptureAppErrorRequest: object

Error object to send to Pitcher sentry instance

---

UiCompletePostcallRequest

UiCompletePostcallRequest: object

Type declaration

was_successfully_submitted?

optional was_successfully_submitted: boolean

Indicates if the postcall was successfully submitted

---

UiMeetingCanceledPayload

UiMeetingCanceledPayload: object

Type declaration

accountId?

optional accountId: string

Account ID

eventId?

optional eventId: string

Event ID

---

UiMessageEnvelope<T>

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]

Type declaration

body

body: UiMessagePayloads[T]

Message body

type

type: T

Message type

---

UiMessagePayloads

UiMessagePayloads: object

Type declaration

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: object

Type declaration

app_context?

optional app_context: undefined | Record<string, any>

Context to pass to the app

app_embed_location?

optional app_embed_location: undefined | EmbedLocation

Embed location of the app

app_name?

optional app_name: undefined | string

Name of the app to open

canvasCorrelationId?

optional canvasCorrelationId: undefined | string

Tracking id for the canvas presentation session.

canvasInView?

optional canvasInView: undefined | boolean

Indicates if the canvas is in view.

context?

optional context: undefined | Record<string, any>

Optional, overrides over the context of the current canvas, useful for injecting file annotation data. Default is {}.

fileId?

optional fileId: undefined | string

Id of the file to open.

files?

optional files: undefined | { ids: string[]; strategy: "simultaneous" | "swap"; }

Ids of the files to open and the strategy to open them with.

fromCanvasId?

optional fromCanvasId: undefined | string

Id of the canvas from which the file is opened.

isInCall?

optional isInCall: undefined | boolean

Indicates if the user is in a call.

isOverlayApp?

optional isOverlayApp: undefined | boolean

Indicates if the app should be opened as overlay.

newTab?

optional newTab: undefined | boolean

Indicates if the file should be opened in a new tab.

pageIndex?

optional pageIndex: undefined | number

Optional, page index to open. Default is null.

search?

optional search: undefined | string

Search query string within the file.

startTime?

optional startTime: undefined | number

Optional, video start timestamp in seconds. Default is null.

url?

optional url: undefined | null | string

URL of the file content.

usedInSectionId?

optional usedInSectionId: undefined | string

Id of the canvas section from which the file is opened.

---

UiPrintCanvasRequest

UiPrintCanvasRequest: object

Type declaration

id

id: CanvasRetrieve["id"]

Canvas ID to print

notify_url?

optional notify_url: string

Optional HTTPS URL for async download notifications

---

UiPrintCanvasResponse

UiPrintCanvasResponse: object

Type declaration

job_id?

optional job_id: string

Job ID for tracking the async download

success

success: boolean

Indicates if the request was successful

---

UiPromptPiaRequest

UiPromptPiaRequest: object

Type declaration

id

id: string

Unique identifier of this prompt (needed for streaming event)

prompt

prompt: string

Prompt to send to PIA

---

UiPromptPiaResponse

UiPromptPiaResponse: object

Type declaration

id

id: string

Unique identifier of this prompt (needed for streaming event)

response

response: string

PIA response

---

UiPromptPiaResponseStreamedPayload

UiPromptPiaResponseStreamedPayload: object

Type declaration

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

Type declaration

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

Type declaration

attach_to?

optional attach_to: AgendaSelectorProps["attachTo"]

initial_agenda?

optional initial_agenda: AgendaSelectorProps["initialAgenda"]

---

UiSelectAgendaResponse

UiSelectAgendaResponse: object

Type declaration

content?

optional content: Agenda

Selected content

user_action

user_action: "cancelled" | "selected"

User action result

---

UiSelectCanvasesRequest

UiSelectCanvasesRequest: object

Type declaration

allowed_ids?

optional allowed_ids: Canvas["id"][]

allowed_types?

optional allowed_types: ("canvas" | "canvas-template" | "section" | "section-template")[]

initial_metadata_filters?

optional initial_metadata_filters: Record<string, any>

selections?

optional selections: CanvasSelection[]

Array of selections

---

UiSelectCanvasesResponse

UiSelectCanvasesResponse: object

Type declaration

canvases?

optional canvases: Canvas[]

Selected canvases

user_action

user_action: "cancelled" | "selected"

User action result

---

UiSelectCollectionPlayerRequest

UiSelectCollectionPlayerRequest: object

Type declaration

attach_to?

optional attach_to: CollectionSelectorProps["attachTo"]

close_on_settings?

optional close_on_settings: CollectionSelectorProps["closeOnSettings"]

hide_close?

optional hide_close: CollectionSelectorProps["hideClose"]

initial_data?

optional initial_data: CollectionSelectorProps["initialData"]

initial_metadata_filters?

optional initial_metadata_filters: CollectionSelectorProps["initialMetadataFilters"]

open_settings?

optional open_settings: CollectionSelectorProps["openSettings"]

readonly_name?

optional readonly_name: CollectionSelectorProps["readonlyName"]

translations?

optional translations: CollectionSelectorProps["translations"]

---

UiSelectCollectionPlayerResponse

UiSelectCollectionPlayerResponse: object

Type declaration

content?

optional content: CollectionPlayer

Selected content

user_action

user_action: "cancelled" | "selected" | "settings"

User action result

---

UiSelectContentRequest

UiSelectContentRequest: object

Type declaration

allowed_asset_content_types?

optional allowed_asset_content_types: FileContentTypeEnum[]

allowed_content_types?

optional allowed_content_types: FileContentTypeEnum[]

allowed_ids?

optional allowed_ids: File["id"][]

allowed_original_extensions?

optional allowed_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?

optional allowed_selector_types: SelectorType[]

content_type?

optional content_type: "file" | "slide" | "content"

disable_no_pptx_data?

optional disable_no_pptx_data: boolean

Disables files from selection which do not have pptx_data in metadata object (optional).

disable_no_sharable?

optional disable_no_sharable: boolean

Disables files from selection which are not sharable (optional).

initial_metadata_filters?

optional initial_metadata_filters: Record<string, any>

max_selections?

optional max_selections: number

min_selections?

optional min_selections: Range<0, 999>

only_allow_content_pdf_pages?

optional only_allow_content_pdf_pages: boolean

Only allow content pdf pages (optional). User will be forced to select a page from the pdf.

selections?

optional selections: Selection[]

Array of selections

---

UiSelectContentResponse

UiSelectContentResponse: object

Type declaration

content?

optional content: (SelectedFile | SelectedPage)[]

Selected content

user_action

user_action: "cancelled" | "selected"

User action result

---

UiSetPostcallStyleRequest

UiSetPostcallStyleRequest: object

---

UiUpdateCanvasRequest

UiUpdateCanvasRequest: object

Type declaration

access_type

access_type: undefined | AccessTypeEnum

account

account: undefined | null | Account

content

content: undefined | Record<string, any>

context

context: any

created_at

created_at: string

created_by

created_by: MiniUser

events

events: MiniEvent[]

expires_at

expires_at: undefined | null | string

fields?

optional fields: undefined | string

Comma-separated list of field keys to return from the server

folder_id

folder_id: undefined | null | string

id

id: string

indicators

indicators: undefined | null | Record<string, any>

instance_id

instance_id: string

is_block

is_block: undefined | boolean

is_default

is_default: undefined | boolean

is_draft

is_draft: undefined | boolean

is_editable

is_editable: undefined | boolean

is_section

is_section: undefined | boolean

is_template

is_template: undefined | boolean

metadata

metadata: any

modified_at

modified_at: string

modified_by

modified_by: MiniUser

name

name: string

owned_by

owned_by: MiniUser

sections

sections: CanvasSection[]

shared_link

shared_link: MiniSharedLink

start_at

start_at: undefined | null | string

tags

tags: undefined | string[]

template

template: MiniCanvas

theme

theme: undefined | null | Record<string, any>

thumbnail_url

thumbnail_url: undefined | null | string

---

UpdateLocationPitcherEvent

UpdateLocationPitcherEvent: UpdateLocationOnUnregister | UpdateLocationOnRestore | UpdateLocationOnUpdate | UpdateLocationOnRegister | UpdateLocationOnRestoreCompleted | UpdateLocationOnMounted | UpdateLocationOnGetRoutesRequest | UpdateLocationOnGetRoutesResponse

Union type for all update location pitcher events.

Variables

ADMIN_API_METHOD_TYPES

const ADMIN_API_METHOD_TYPES: object

Type declaration

CAPTURE_APP_ERROR

readonly CAPTURE_APP_ERROR: "admin_capture_app_error" = 'admin_capture_app_error'

CLOSE

readonly CLOSE: "admin_close_file_overlay" = 'admin_close_file_overlay'

CREATE_CANVAS

readonly CREATE_CANVAS: "admin_create_canvas" = 'admin_create_canvas'

GET_APP_CONFIG

readonly GET_APP_CONFIG: "admin_get_app_config" = 'admin_get_app_config'

GET_CANVAS

readonly GET_CANVAS: "admin_get_canvas" = 'admin_get_canvas'

GET_CANVASES

readonly GET_CANVASES: "admin_get_canvases" = 'admin_get_canvases'

GET_ENV

readonly GET_ENV: "admin_get_env" = 'admin_get_env'

GET_FILE

readonly GET_FILE: "admin_get_file" = 'admin_get_file'

GET_FILES

readonly GET_FILES: "admin_get_files" = 'admin_get_files'

GET_INSTANCE_METADATA_TEMPLATES

readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates" = 'admin_get_instance_metadata_templates'

GET_USERS

readonly GET_USERS: "admin_get_users" = 'admin_get_users'

OPEN

readonly OPEN: "admin_open_file_overlay" = 'admin_open_file_overlay'

OPEN_CANVAS_OVERLAY

readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay" = 'admin_open_canvas_overlay'

OPEN_COLLECTION_PLAYER_OVERLAY

readonly OPEN_COLLECTION_PLAYER_OVERLAY: "admin_open_collection_player_overlay" = 'admin_open_collection_player_overlay'

SELECT_AGENDA_CONTENT

readonly SELECT_AGENDA_CONTENT: "admin_select_agenda_content" = 'admin_select_agenda_content'

SELECT_CANVASES

readonly SELECT_CANVASES: "admin_select_canvases" = 'admin_select_canvases'

SELECT_COLLECTION_PLAYER_CONTENT

readonly SELECT_COLLECTION_PLAYER_CONTENT: "admin_select_collection_player_content" = 'admin_select_collection_player_content'

SELECT_CONTENT

readonly SELECT_CONTENT: "admin_select_content" = 'admin_select_content'

TOAST

readonly TOAST: "admin_toast" = 'admin_toast'

UPDATE_CANVAS

readonly UPDATE_CANVAS: "admin_update_canvas" = 'admin_update_canvas'

---

ADMIN_API_TYPES

const ADMIN_API_TYPES: object

Type declaration

ADMIN_REQUEST

readonly ADMIN_REQUEST: "ADMIN_REQUEST" = 'ADMIN_REQUEST'

ADMIN_RESPONSE

readonly ADMIN_RESPONSE: "ADMIN_RESPONSE" = 'ADMIN_RESPONSE'

---

ADMIN_MESSAGE

const ADMIN_MESSAGE: "ADMIN_MESSAGE"

---

ADMIN_MESSAGE_TYPES

const ADMIN_MESSAGE_TYPES: object

Type declaration

ENV_CHANGED

readonly ENV_CHANGED: "admin_env_changed" = 'admin_env_changed'

---

DEFAULT_PEER_CONNECTIVITY_VERSION

const DEFAULT_PEER_CONNECTIVITY_VERSION: 1 = 1

---

DSR_API_METHOD_TYPES

const DSR_API_METHOD_TYPES: object

Type declaration

CLOSE

readonly CLOSE: "dsr_close" = 'dsr_close'

DSR_EMBEDDABLE_READY

readonly DSR_EMBEDDABLE_READY: "dsr_embeddable_ready" = 'dsr_embeddable_ready'

GET_APP_CONFIG

readonly GET_APP_CONFIG: "dsr_get_app_config" = 'dsr_get_app_config'

GET_ENV

readonly GET_ENV: "dsr_get_env" = 'dsr_get_env'

GET_FILE

readonly GET_FILE: "dsr_get_file" = 'dsr_get_file'

---

DSR_API_TYPES

const DSR_API_TYPES: object

Type declaration

DSR_REQUEST

readonly DSR_REQUEST: "DSR_REQUEST" = 'DSR_REQUEST'

DSR_RESPONSE

readonly DSR_RESPONSE: "DSR_RESPONSE" = 'DSR_RESPONSE'

---

DSR_MESSAGE

const DSR_MESSAGE: "DSR_MESSAGE"

---

DSR_MESSAGE_TYPES

const DSR_MESSAGE_TYPES: object

Type declaration

ENV_CHANGED

readonly ENV_CHANGED: "dsr_env_changed" = 'dsr_env_changed'

---

highLevelApi

highLevelApi: ReturnType<typeof createHighLevelApi>

---

PEER_CONNECTIVITY_EVENT

const PEER_CONNECTIVITY_EVENT: "peer_connectivity_event" = 'peer_connectivity_event'

---

PEER_CONNECTIVITY_HANDLER_MATCH_ALL

const PEER_CONNECTIVITY_HANDLER_MATCH_ALL: "*" = '*'

---

PeerConnectivityActions

const PeerConnectivityActions: object

Type declaration

BROWSER_FOLDER_OPEN

readonly BROWSER_FOLDER_OPEN: "browser.folder.open" = 'browser.folder.open'

CANVAS_CLOSE

readonly CANVAS_CLOSE: "canvas.close" = 'canvas.close'

CANVAS_OPEN

readonly CANVAS_OPEN: "canvas.open" = 'canvas.open'

CANVAS_PAGE_NEXT

readonly CANVAS_PAGE_NEXT: "canvas.navigate.next" = 'canvas.navigate.next'

CANVAS_PAGE_PREVIOUS

readonly CANVAS_PAGE_PREVIOUS: "canvas.navigate.previous" = 'canvas.navigate.previous'

FILE_CLOSE

readonly FILE_CLOSE: "file.close" = 'file.close'

FILE_OPEN

readonly FILE_OPEN: "file.open" = 'file.open'

ROUTE_CHANGE

readonly ROUTE_CHANGE: "route.change" = 'route.change'

---

PITCHER_EVENT

const PITCHER_EVENT: "PITCHER_EVENT"

---

UI_API_METHOD_TYPES

const UI_API_METHOD_TYPES: object

Type declaration

UI_APP_LOADED

readonly UI_APP_LOADED: "ui_app_loaded" = 'ui_app_loaded'

UI_APP_RESIZE

readonly UI_APP_RESIZE: "ui_app_resize" = 'ui_app_resize'

UI_BROADCAST

readonly UI_BROADCAST: "ui_broadcast" = 'ui_broadcast'

UI_CANCEL_MEETING

readonly UI_CANCEL_MEETING: "ui_cancel_meeting" = 'ui_cancel_meeting'

UI_CANVAS_NAVIGATE_NEXT_PAGE

readonly UI_CANVAS_NAVIGATE_NEXT_PAGE: "ui_canvas_navigate_next_page" = 'ui_canvas_navigate_next_page'

UI_CANVAS_NAVIGATE_PAGE

readonly UI_CANVAS_NAVIGATE_PAGE: "ui_canvas_navigate_page" = 'ui_canvas_navigate_page'

UI_CANVAS_NAVIGATE_PREVIOUS_PAGE

readonly UI_CANVAS_NAVIGATE_PREVIOUS_PAGE: "ui_canvas_navigate_previous_page" = 'ui_canvas_navigate_previous_page'

UI_CAPTURE_APP_ERROR

readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error" = 'ui_capture_app_error'

UI_CLOSE_CANVAS_DRAWER

readonly UI_CLOSE_CANVAS_DRAWER: "ui_close_canvas_drawer" = 'ui_close_canvas_drawer'

UI_CLOSE_CANVAS_SECTION_EXECUTION

readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution" = 'ui_close_canvas_section_execution'

UI_CLOSE_GLOBAL_POPUP

readonly UI_CLOSE_GLOBAL_POPUP: "ui_close_global_popup" = 'ui_close_global_popup'

UI_COMPLETE_POSTCALL

readonly UI_COMPLETE_POSTCALL: "ui_complete_postcall" = 'ui_complete_postcall'

UI_DISABLE_POSTCALL_SUBMIT

readonly UI_DISABLE_POSTCALL_SUBMIT: "ui_disable_postcall_submit" = 'ui_disable_postcall_submit'

UI_EMBEDDABLE_READY

readonly UI_EMBEDDABLE_READY: "ui_embeddable_ready" = 'ui_embeddable_ready'

UI_ENABLE_POSTCALL_SUBMIT

readonly UI_ENABLE_POSTCALL_SUBMIT: "ui_enable_postcall_submit" = 'ui_enable_postcall_submit'

UI_OPEN

readonly UI_OPEN: "ui_open" = 'ui_open'

UI_OPEN_CANVAS_OVERLAY

readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay" = 'ui_open_canvas_overlay'

UI_OPEN_COLLECTION_PLAYER_OVERLAY

readonly UI_OPEN_COLLECTION_PLAYER_OVERLAY: "ui_open_collection_player_overlay" = 'ui_open_collection_player_overlay'

UI_OPEN_GLOBAL_POPUP

readonly UI_OPEN_GLOBAL_POPUP: "ui_open_global_popup" = 'ui_open_global_popup'

UI_PRESELECT_SFDC_MEETING_ID

readonly UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id" = 'ui_preselect_sfdc_meeting_id'

UI_PRINT_CANVAS

readonly UI_PRINT_CANVAS: "ui_print_canvas" = 'ui_print_canvas'

UI_PROMPT_PIA

readonly UI_PROMPT_PIA: "ui_prompt_pia" = 'ui_prompt_pia'

UI_RESUME_MEETING

readonly UI_RESUME_MEETING: "ui_resume_meeting" = 'ui_resume_meeting'

UI_SELECT_AGENDA_CONTENT

readonly UI_SELECT_AGENDA_CONTENT: "ui_select_agenda_content" = 'ui_select_agenda_content'

UI_SELECT_CANVASES

readonly UI_SELECT_CANVASES: "ui_select_canvases" = 'ui_select_canvases'

UI_SELECT_COLLECTION_PLAYER_CONTENT

readonly UI_SELECT_COLLECTION_PLAYER_CONTENT: "ui_select_collection_player_content" = 'ui_select_collection_player_content'

UI_SELECT_CONTENT

readonly UI_SELECT_CONTENT: "ui_select_content" = 'ui_select_content'

UI_SET_POSTCALL_STYLE

readonly UI_SET_POSTCALL_STYLE: "ui_set_postcall_style" = 'ui_set_postcall_style'

UI_STOP_MEETING

readonly UI_STOP_MEETING: "ui_stop_meeting" = 'ui_stop_meeting'

UI_TOAST

readonly UI_TOAST: "ui_toast" = 'ui_toast'

UI_UPDATE_CANVAS

readonly UI_UPDATE_CANVAS: "ui_update_canvas" = 'ui_update_canvas'

UI_UPDATE_LOCATION

readonly UI_UPDATE_LOCATION: "ui_update_location" = 'ui_update_location'

---

UI_MESSAGE

const UI_MESSAGE: "UI_MESSAGE"

---

UI_MESSAGE_TYPES

const UI_MESSAGE_TYPES: object

Type declaration

UI_APP_SET_DATA

readonly UI_APP_SET_DATA: "ui_app_set_data" = 'ui_app_set_data'

UI_APP_UPDATE_DATA

readonly UI_APP_UPDATE_DATA: "ui_app_update_data" = 'ui_app_update_data'

UI_CANVAS_UPDATED

readonly UI_CANVAS_UPDATED: "ui_canvas_updated" = 'ui_canvas_updated'

UI_MEETING_CANCELED

readonly UI_MEETING_CANCELED: "ui_meeting_canceled" = 'ui_meeting_canceled'

UI_PROMPT_PIA_RESPONSE_STREAMED

readonly UI_PROMPT_PIA_RESPONSE_STREAMED: "ui_prompt_pia_response_streamed" = 'ui_prompt_pia_response_streamed'

UI_SECTION_LIST_UPDATED

readonly UI_SECTION_LIST_UPDATED: "ui_section_list_updated" = 'ui_section_list_updated'

---

UI_NATIVE_MESSAGE_TYPES

const UI_NATIVE_MESSAGE_TYPES: readonly ["ui_app_set_data", "ui_app_update_data", "ui_canvas_updated"]

Functions

Function	Description
getAvailableApis	-
registerPeerConnectivityHandler	-
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.