Preparing search index...
The search index is not available
canvas-ui
canvas-ui
canvas-ui
Modules
<internal>
Enumerations
PitcherBroadcastedEventName
PitcherEventName
PitcherExternalEventName
PitcherMessageType
PitcherResponseStatus
Interfaces
AdminToastRequest
ApiEventMap
ApiOptions
CreateAndOpenCanvasEvent
CRMQueryPayload
GetInstanceMetadataTemplatesPayload
LocationRoute
NotificationPayload
OpenCanvasPitcherEvent
OpenExternalUrlRequestPayload
OpenRequestPayload
OpenWebViewAlwaysOnTop
OrgConfigResponse
PitcherAPI
PitcherEnv
PitcherEvent
PitcherEventMap
PitcherInterface
PitcherMessage
PitcherResponse
QueryPayload
SharePayload
StartCallPitcherEvent
SubmitUserFeedbackPayload
UiPreselectSfdcMeetingIdRequest
UiPreselectSfdcMeetingIdResponse
UiToastRequest
UpdateLocationOnGetRoutesRequest
UpdateLocationOnGetRoutesResponse
UpdateLocationOnMounted
UpdateLocationOnRegister
UpdateLocationOnRestore
UpdateLocationOnRestoreCompleted
UpdateLocationOnUnregister
UpdateLocationOnUpdate
Type Aliases
AdminCaptureAppErrorRequest
AdminEnv
AdminMessage
AdminMessagePayloads
AdminRequest
AdminResponse
AdminSelectAgendaRequest
AdminSelectAgendaResponse
AdminSelectCanvasesRequest
AdminSelectCanvasesResponse
AdminSelectCollectionPlayerRequest
AdminSelectCollectionPlayerResponse
AdminSelectContentRequest
AdminSelectContentResponse
CRMServiceType
DsrEnv
DsrMessage
DsrMessagePayloads
DsrRequest
DsrResponse
FolderListRequest
GetRecentFilesPayload
JsApiLocation
ListFilesPayload
LocationRoutes
ShareResponse
UiAppResizeRequest
UiAppSetDataPayload
UiAppUpdateDataPayload
UiBroadcastRequest
UiCanvasNavigatePageRequest
UiCanvasUpdatedPayload
UiCaptureAppErrorRequest
UiCompletePostcallRequest
UiMeetingCanceledPayload
UiMessageEnvelope
UiMessagePayloads
UiOpenRequest
UiPromptPiaRequest
UiPromptPiaResponse
UiPromptPiaResponseStreamedPayload
UiSectionListUpdatedPayload
UiSelectAgendaRequest
UiSelectAgendaResponse
UiSelectCanvasesRequest
UiSelectCanvasesResponse
UiSelectCollectionPlayerRequest
UiSelectCollectionPlayerResponse
UiSelectContentRequest
UiSelectContentResponse
UiSetPostcallStyleRequest
UiUpdateCanvasRequest
UpdateLocationPitcherEvent
Variables
ADMIN_API_METHOD_TYPES
ADMIN_API_TYPES
ADMIN_MESSAGE
ADMIN_MESSAGE_TYPES
DSR_API_METHOD_TYPES
DSR_API_TYPES
DSR_MESSAGE
DSR_MESSAGE_TYPES
highLevelApi
PITCHER_EVENT
UI_API_METHOD_TYPES
UI_MESSAGE
UI_MESSAGE_TYPES
UI_NATIVE_MESSAGE_TYPES
Functions
getAvailableApis
useAdmin
useApi
useDsr
usePitcherApi
useUi
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Modules
<internal>
Enumerations
Pitcher
Broadcasted
Event
Name
Pitcher
Event
Name
Pitcher
External
Event
Name
Pitcher
Message
Type
Pitcher
Response
Status
Interfaces
Admin
Toast
Request
Api
Event
Map
Api
Options
Create
And
Open
Canvas
Event
CRMQuery
Payload
Get
Instance
Metadata
Templates
Payload
Location
Route
Notification
Payload
Open
Canvas
Pitcher
Event
Open
External
Url
Request
Payload
Open
Request
Payload
Open
Web
View
Always
On
Top
Org
Config
Response
PitcherAPI
Pitcher
Env
Pitcher
Event
Pitcher
Event
Map
Pitcher
Interface
Pitcher
Message
Pitcher
Response
Query
Payload
Share
Payload
Start
Call
Pitcher
Event
Submit
User
Feedback
Payload
Ui
Preselect
Sfdc
Meeting
Id
Request
Ui
Preselect
Sfdc
Meeting
Id
Response
Ui
Toast
Request
Update
Location
On
Get
Routes
Request
Update
Location
On
Get
Routes
Response
Update
Location
On
Mounted
Update
Location
On
Register
Update
Location
On
Restore
Update
Location
On
Restore
Completed
Update
Location
On
Unregister
Update
Location
On
Update
Type Aliases
Admin
Capture
App
Error
Request
Admin
Env
Admin
Message
Admin
Message
Payloads
Admin
Request
Admin
Response
Admin
Select
Agenda
Request
Admin
Select
Agenda
Response
Admin
Select
Canvases
Request
Admin
Select
Canvases
Response
Admin
Select
Collection
Player
Request
Admin
Select
Collection
Player
Response
Admin
Select
Content
Request
Admin
Select
Content
Response
CRMService
Type
Dsr
Env
Dsr
Message
Dsr
Message
Payloads
Dsr
Request
Dsr
Response
Folder
List
Request
Get
Recent
Files
Payload
Js
Api
Location
List
Files
Payload
Location
Routes
Share
Response
Ui
App
Resize
Request
Ui
App
Set
Data
Payload
Ui
App
Update
Data
Payload
Ui
Broadcast
Request
Ui
Canvas
Navigate
Page
Request
Ui
Canvas
Updated
Payload
Ui
Capture
App
Error
Request
Ui
Complete
Postcall
Request
Ui
Meeting
Canceled
Payload
Ui
Message
Envelope
Ui
Message
Payloads
Ui
Open
Request
Ui
Prompt
Pia
Request
Ui
Prompt
Pia
Response
Ui
Prompt
Pia
Response
Streamed
Payload
Ui
Section
List
Updated
Payload
Ui
Select
Agenda
Request
Ui
Select
Agenda
Response
Ui
Select
Canvases
Request
Ui
Select
Canvases
Response
Ui
Select
Collection
Player
Request
Ui
Select
Collection
Player
Response
Ui
Select
Content
Request
Ui
Select
Content
Response
Ui
Set
Postcall
Style
Request
Ui
Update
Canvas
Request
Update
Location
Pitcher
Event
Variables
ADMIN_
API_
METHOD_
TYPES
ADMIN_
API_
TYPES
ADMIN_
MESSAGE
ADMIN_
MESSAGE_
TYPES
DSR_
API_
METHOD_
TYPES
DSR_
API_
TYPES
DSR_
MESSAGE
DSR_
MESSAGE_
TYPES
high
Level
Api
PITCHER_
EVENT
UI_
API_
METHOD_
TYPES
UI_
MESSAGE
UI_
MESSAGE_
TYPES
UI_
NATIVE_
MESSAGE_
TYPES
Functions
get
Available
Apis
use
Admin
use
Api
use
Dsr
use
Pitcher
Api
use
Ui
canvas-ui
Loading...