Function: useApi()

useApi(options?): { API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: (type, callback) => void; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; unsubscribe: () => Promise<any>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; close: Promise<any>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; downloadFile: Promise<null>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<string>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; search: Promise<any>; selectDeviceFile: Promise<DeviceFile>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateMyUser: Promise<User>; } | { on: (type, handler) => Promise<() => void>; toast: (payload) => Promise<void>; captureAppError: Promise<void>; close: Promise<void>; createCanvas: Promise<CanvasRetrieve>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getEnv: Promise<AdminEnv>; getFile: Promise<File>; getFiles: Promise<PaginatedFileList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getUsers: Promise<PaginatedData<User>>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; selectAgendaContent: Promise<AdminSelectAgendaResponse>; selectCanvases: Promise<AdminSelectCanvasesResponse>; selectCollectionContent: Promise<AdminSelectCollectionPlayerResponse>; selectContent: Promise<AdminSelectContentResponse>; updateCanvas: Promise<CanvasRetrieve>; } | { API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; impact: { API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: (type, callback) => void; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; unsubscribe: () => Promise<any>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; close: Promise<any>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; downloadFile: Promise<null>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<string>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; search: Promise<any>; selectDeviceFile: Promise<DeviceFile>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateMyUser: Promise<User>; }; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: <T>(type, handler) => Promise<() => void>; onAppSetData: (handler) => Promise<() => void>; onAppUpdateData: (handler) => Promise<() => void>; onCanvasUpdated: (handler) => Promise<() => void>; onMeetingCanceled: (handler) => Promise<() => void>; onSectionListUpdated: (handler) => Promise<() => void>; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; ui: { on: <T>(type, handler) => Promise<() => void>; onAppSetData: (handler) => Promise<() => void>; onAppUpdateData: (handler) => Promise<() => void>; onCanvasUpdated: (handler) => Promise<() => void>; onMeetingCanceled: (handler) => Promise<() => void>; onSectionListUpdated: (handler) => Promise<() => void>; uiBroadcast: {}; appLoaded: Promise<void>; appResize: Promise<void>; cancelMeeting: Promise<void>; canvasNavigateNextPage: Promise<void>; canvasNavigatePage: Promise<void>; canvasNavigatePreviousPage: Promise<void>; captureAppError: Promise<void>; closeCanvasDrawer: Promise<void>; closeCanvasSectionExecution: Promise<void>; completePostcall: Promise<void>; disablePostcallSubmit: Promise<void>; embeddableReady: Promise<void>; enablePostcallSubmit: Promise<void>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; preselectSfdcMeetingId: Promise<UiPreselectSfdcMeetingIdResponse>; printCanvas: Promise<UiPrintCanvasResponse>; promptPia: Promise<UiPromptPiaResponse>; resumeMeeting: Promise<void>; selectAgendaContent: Promise<UiSelectAgendaResponse>; selectCanvases: Promise<UiSelectCanvasesResponse>; selectCollectionContent: Promise<UiSelectCollectionPlayerResponse>; selectContent: Promise<UiSelectContentResponse>; setPostcallStyle: Promise<void>; stopMeeting: Promise<void>; toast: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateLocation: Promise<any>; }; uiBroadcast: {}; unsubscribe: () => Promise<any>; appLoaded: Promise<void>; appResize: Promise<void>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; cancelMeeting: Promise<void>; canvasNavigateNextPage: Promise<void>; canvasNavigatePage: Promise<void>; canvasNavigatePreviousPage: Promise<void>; captureAppError: Promise<void>; close: Promise<any>; closeCanvasDrawer: Promise<void>; closeCanvasSectionExecution: Promise<void>; completePostcall: Promise<void>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; disablePostcallSubmit: Promise<void>; downloadFile: Promise<null>; embeddableReady: Promise<void>; enablePostcallSubmit: Promise<void>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; preselectSfdcMeetingId: Promise<UiPreselectSfdcMeetingIdResponse>; printCanvas: Promise<UiPrintCanvasResponse>; promptPia: Promise<UiPromptPiaResponse>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; resumeMeeting: Promise<void>; search: Promise<any>; selectAgendaContent: Promise<UiSelectAgendaResponse>; selectCanvases: Promise<UiSelectCanvasesResponse>; selectCollectionContent: Promise<UiSelectCollectionPlayerResponse>; selectContent: Promise<UiSelectContentResponse>; selectDeviceFile: Promise<DeviceFile>; setPostcallStyle: Promise<void>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; stopMeeting: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateLocation: Promise<any>; updateMyUser: Promise<User>; } | { broadcast: (event) => Promise<any>; on: (type, handler) => Promise<() => void>; close: Promise<void>; embeddableReady: Promise<void>; getAppConfig: Promise<Record<string, any>>; getEnv: Promise<DsrEnv>; getFile: Promise<File>; }

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.

• CatalogIQ UI - the method will return an object containing methods available in both usePitcherApi and useUi
• CatalogIQ DSR - the method will return the same result as useDsr
• CatalogIQ Admin - the method will return the same result as useAdmin

import { useApi } from '@pitcher/js-api'

const api = useApi()

Parameters

Parameter	Type
options?	ApiOptions

Returns

{ API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: (type, callback) => void; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; unsubscribe: () => Promise<any>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; close: Promise<any>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; downloadFile: Promise<null>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<string>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; search: Promise<any>; selectDeviceFile: Promise<DeviceFile>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateMyUser: Promise<User>; } | { on: (type, handler) => Promise<() => void>; toast: (payload) => Promise<void>; captureAppError: Promise<void>; close: Promise<void>; createCanvas: Promise<CanvasRetrieve>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getEnv: Promise<AdminEnv>; getFile: Promise<File>; getFiles: Promise<PaginatedFileList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getUsers: Promise<PaginatedData<User>>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; selectAgendaContent: Promise<AdminSelectAgendaResponse>; selectCanvases: Promise<AdminSelectCanvasesResponse>; selectCollectionContent: Promise<AdminSelectCollectionPlayerResponse>; selectContent: Promise<AdminSelectContentResponse>; updateCanvas: Promise<CanvasRetrieve>; } | { API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; impact: { API: LowLevelApi; broadcast: (event) => Promise<any>; broadcastToWebviews: (event) => Promise<any>; enterFullscreen: () => Promise<any>; exitFullscreen: () => Promise<any>; getRequestTypes: () => Promise<any>; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: (type, callback) => void; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; unsubscribe: () => Promise<any>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; close: Promise<any>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; downloadFile: Promise<null>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<string>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; search: Promise<any>; selectDeviceFile: Promise<DeviceFile>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateMyUser: Promise<User>; }; isFullscreen: () => Promise<any>; logout: () => Promise<any>; off: (type, callback) => void; on: <T>(type, handler) => Promise<() => void>; onAppSetData: (handler) => Promise<() => void>; onAppUpdateData: (handler) => Promise<() => void>; onCanvasUpdated: (handler) => Promise<() => void>; onMeetingCanceled: (handler) => Promise<() => void>; onSectionListUpdated: (handler) => Promise<() => void>; quitInstance: () => Promise<any>; subscribe: () => Promise<any>; ui: { on: <T>(type, handler) => Promise<() => void>; onAppSetData: (handler) => Promise<() => void>; onAppUpdateData: (handler) => Promise<() => void>; onCanvasUpdated: (handler) => Promise<() => void>; onMeetingCanceled: (handler) => Promise<() => void>; onSectionListUpdated: (handler) => Promise<() => void>; uiBroadcast: {}; appLoaded: Promise<void>; appResize: Promise<void>; cancelMeeting: Promise<void>; canvasNavigateNextPage: Promise<void>; canvasNavigatePage: Promise<void>; canvasNavigatePreviousPage: Promise<void>; captureAppError: Promise<void>; closeCanvasDrawer: Promise<void>; closeCanvasSectionExecution: Promise<void>; completePostcall: Promise<void>; disablePostcallSubmit: Promise<void>; embeddableReady: Promise<void>; enablePostcallSubmit: Promise<void>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; preselectSfdcMeetingId: Promise<UiPreselectSfdcMeetingIdResponse>; printCanvas: Promise<UiPrintCanvasResponse>; promptPia: Promise<UiPromptPiaResponse>; resumeMeeting: Promise<void>; selectAgendaContent: Promise<UiSelectAgendaResponse>; selectCanvases: Promise<UiSelectCanvasesResponse>; selectCollectionContent: Promise<UiSelectCollectionPlayerResponse>; selectContent: Promise<UiSelectContentResponse>; setPostcallStyle: Promise<void>; stopMeeting: Promise<void>; toast: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateLocation: Promise<any>; }; uiBroadcast: {}; unsubscribe: () => Promise<any>; appLoaded: Promise<void>; appResize: Promise<void>; assignCanvasTheme: Promise<{ canvas_id: string; theme_id: string; }>; cancelMeeting: Promise<void>; canvasNavigateNextPage: Promise<void>; canvasNavigatePage: Promise<void>; canvasNavigatePreviousPage: Promise<void>; captureAppError: Promise<void>; close: Promise<any>; closeCanvasDrawer: Promise<void>; closeCanvasSectionExecution: Promise<void>; completePostcall: Promise<void>; createCanvas: Promise<CanvasRetrieve>; createEvent: Promise<Event>; createFavorite: Promise<Favorite>; createFile: Promise<FileRetrieve>; createFolder: Promise<FolderRetrieve>; crmQuery: Promise<any>; crmSmartDeleteObjects: Promise<any>; crmSmartObjectMetadata: Promise<any>; crmSmartObjectValidationRules: Promise<any>; crmSmartQuery: Promise<any[]>; crmSmartUpsertObjects: Promise<any>; deleteCanvas: Promise<CanvasRetrieve>; deleteEvent: Promise<void>; deleteFavorite: Promise<void>; deleteFile: Promise<string>; deleteFolder: Promise<void>; deleteLocalFile: Promise<void>; disablePostcallSubmit: Promise<void>; downloadFile: Promise<null>; embeddableReady: Promise<void>; enablePostcallSubmit: Promise<void>; fetchDocumentInfo: Promise<{ [key: string]: unknown; pageCount: number; }>; getAppConfig: Promise<Record<string, any>>; getCanvas: Promise<CanvasRetrieve>; getCanvases: Promise<PaginatedData<CanvasRetrieve>>; getCanvasRecommendedFiles: Promise<CanvasRecommendedFiles>; getCanvasTheme: Promise<CanvasThemeRetrieve>; getCoreFolders: Promise<CoreFolderContentsRetrieve>; getEnv: Promise<PitcherEnv>; getEvents: Promise<PaginatedData<Event>>; getFavorites: Promise<PaginatedFavoriteList>; getFile: Promise<FileRetrieve>; getFileRevisionData: Promise<FileRetrieve>; getFileRevisions: Promise<FileRevision[]>; getFiles: Promise<PaginatedFileList>; getFolder: Promise<FolderRetrieve>; getFolders: Promise<PaginatedFolderList>; getInstanceMetadataTemplates: Promise<PaginatedMetadataTemplateList>; getLanguages: Promise<Language[]>; getRecentFiles: Promise<File[]>; getThemes: Promise<CanvasThemeRetrieve[]>; getUsers: Promise<PaginatedData<User>>; isOffline: Promise<boolean>; moveFolderItems: Promise<FolderRetrieve>; notify: Promise<void>; open: Promise<void>; openCanvasOverlay: Promise<void>; openCollectionPlayerOverlay: Promise<void>; openExternalUrl: Promise<void>; openWebViewAlwaysOnTop: Promise<void>; patchCoreFolder: Promise<CoreFolderContentsRetrieve>; preselectSfdcMeetingId: Promise<UiPreselectSfdcMeetingIdResponse>; printCanvas: Promise<UiPrintCanvasResponse>; promptPia: Promise<UiPromptPiaResponse>; query: Promise<any>; refreshAccessToken: any; refreshServiceToken: Promise<RefreshServiceTokenResponse>; renderPageAsImage: Promise<ArrayBuffer>; resumeMeeting: Promise<void>; search: Promise<any>; selectAgendaContent: Promise<UiSelectAgendaResponse>; selectCanvases: Promise<UiSelectCanvasesResponse>; selectCollectionContent: Promise<UiSelectCollectionPlayerResponse>; selectContent: Promise<UiSelectContentResponse>; selectDeviceFile: Promise<DeviceFile>; setPostcallStyle: Promise<void>; share: Promise<ShareResponse>; shareCanvas: Promise<SharedLink>; showPeerSession: Promise<void>; showSyncbox: Promise<void>; stopMeeting: Promise<void>; submitUserFeedback: Promise<any>; toast: Promise<void>; track: Promise<any>; triggerNonFilesSync: Promise<void>; unassignCanvasTheme: Promise<void>; updateCanvas: Promise<CanvasRetrieve>; updateCanvasIndicators: Promise<CanvasRetrieve>; updateEvent: Promise<Event>; updateFile: Promise<FileRetrieve>; updateFolder: Promise<FolderRetrieve>; updateLocation: Promise<any>; updateMyUser: Promise<User>; } | { broadcast: (event) => Promise<any>; on: (type, handler) => Promise<() => void>; close: Promise<void>; embeddableReady: Promise<void>; getAppConfig: Promise<Record<string, any>>; getEnv: Promise<DsrEnv>; getFile: Promise<File>; }