Function usePitcherApi

usePitcherApi(
    options?: ApiOptions,
): {
    API: LowLevelApi;
    broadcast: (event: PitcherEvent) => Promise<any>;
    enterFullscreen: () => Promise<any>;
    exitFullscreen: () => Promise<any>;
    getRequestTypes: () => Promise<any>;
    isFullscreen: () => Promise<any>;
    logout: () => Promise<any>;
    off: (type: string, callback: (payload: PitcherEvent) => void) => void;
    on: (type: string, callback: (payload: PitcherEvent) => void) => void;
    quitInstance: () => Promise<any>;
    subscribe: () => Promise<any>;
    unsubscribe: () => Promise<any>;
    assignCanvasTheme(
        payload: { canvas_id: string; theme_id: string },
    ): Promise<{ canvas_id: string; theme_id: string }>;
    close(): Promise<any>;
    createCanvas(
        payload: Omit<CanvasCreateRequest, "instance_id">,
    ): Promise<CanvasRetrieve>;
    createEvent(payload: EventRequest): Promise<Event>;
    createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>;
    createFile(
        payload: Omit<AllFileCreateRequest, "instance_id">,
    ): Promise<FileRetrieve>;
    createFolder(
        payload: Omit<FolderCreateRequest, "instance_id">,
    ): Promise<FolderRetrieve>;
    crmQuery(payload: CRMQueryPayload): Promise<any>;
    deleteCanvas(payload: { id: string }): Promise<CanvasRetrieve>;
    deleteEvent(payload: Partial<Event>): Promise<void>;
    deleteFavorite(payload: { favorite_id: string }): Promise<void>;
    deleteFile(payload: { file_id: string }): Promise<string>;
    deleteFolder(payload: { folder_id: string }): Promise<void>;
    downloadFile(payload: { file_id: string }): Promise<null>;
    fetchDocumentInfo(
        payload: { fileId: string },
    ): Promise<{ pageCount: number; [key: string]: unknown }>;
    getAppConfig(payload: { app_name: string }): Promise<Record<string, any>>;
    getCanvas(
        payload: { fields?: string; id: string },
    ): Promise<CanvasRetrieve>;
    getCanvases(
        payload: GetCanvasesParams & {
            fields?: string;
            filters?: Record<string, any>;
        },
    ): Promise<PaginatedData<CanvasRetrieve>>;
    getCanvasRecommendedFiles(
        payload: { canvas_id: string; match?: ("metadata" | "tags")[] },
    ): Promise<CanvasRecommendedFiles>;
    getCanvasTheme(
        payload: { canvas_id: string },
    ): Promise<CanvasThemeRetrieve>;
    getCoreFolders(
        payload: {
            entity: CoreFolderEntityType;
            instance_id: string;
            parent_id?: null | string;
        },
    ): Promise<CoreFolderContentsRetrieve>;
    getEnv(): Promise<PitcherEnv>;
    getEvents(payload: Partial<EventRequest>): Promise<PaginatedData<Event>>;
    getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>;
    getFile(payload: { file_id?: string; id?: string }): Promise<FileRetrieve>;
    getFileRevisionData(
        payload: { file_id: string; revision_id: string },
    ): Promise<FileRetrieve>;
    getFileRevisions(
        payload: { file_id?: string; id?: string },
    ): Promise<FileRevision[]>;
    getFiles(
        payload: Partial<Omit<File, "type">> & {
            content_type?: FileContentTypeEnum | FileContentTypeEnum[];
            created_at__range?: string;
            expires_at__range?: string;
            id__in?: string;
            type?: FileTypeEnum | FileTypeEnum[];
            updated_at__range?: string;
        } & { fields?: string; filters?: Record<string, any> },
    ): Promise<PaginatedFileList>;
    getFolder(payload?: { id: string }): Promise<FolderRetrieve>;
    getFolders(payload: FolderListRequest): Promise<PaginatedFolderList>;
    getInstanceMetadataTemplates(
        payload?: GetInstanceMetadataTemplatesPayload,
    ): Promise<PaginatedMetadataTemplateList>;
    getLanguages(): Promise<Language[]>;
    getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>;
    getThemes(
        payload: Partial<CanvasThemeRetrieve>,
    ): Promise<CanvasThemeRetrieve[]>;
    getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>;
    moveFolderItems(
        payload: {
            items: { id: string; type: "folder" | "file" }[];
            target_folder_id: string;
        },
    ): Promise<FolderRetrieve>;
    notify(payload: NotificationPayload): Promise<void>;
    open(payload?: OpenRequestPayload): Promise<string>;
    openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>;
    openWebViewAlwaysOnTop(payload: OpenWebViewAlwaysOnTop): Promise<void>;
    patchCoreFolder(
        id: string,
        payload: Partial<CoreFolderRetrieve>,
    ): Promise<CoreFolderContentsRetrieve>;
    query(payload: QueryPayload): Promise<any>;
    refreshAccessToken(): any;
    refreshServiceToken(
        payload?: RefreshServiceTokenRequest,
    ): Promise<RefreshServiceTokenResponse>;
    renderPageAsImage(
        payload: {
            documentId?: string;
            fileId: string;
            pageIndex: number;
            params: { width: number } | { height: number };
        },
    ): Promise<ArrayBuffer>;
    search(payload: { includeExpired?: boolean; query: string }): Promise<any>;
    selectDeviceFile(): Promise<DeviceFile>;
    share(payload: SharePayload): Promise<ShareResponse>;
    shareCanvas(payload: { id: string }): Promise<SharedLink>;
    submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>;
    toast(payload: { message: string; type: string }): Promise<void>;
    track(payload: { event_name: string; payload: any }): Promise<any>;
    triggerNonFilesSync(): Promise<void>;
    unassignCanvasTheme(payload: { canvas_id: string }): Promise<void>;
    updateCanvas(
        payload: PatchedCanvasUpdateRequest & {
            fields?: string;
            id: string;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>;
    updateCanvasIndicators(
        payload: {
            id: string;
            indicators: Record<string, CanvasIndicator>;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>;
    updateEvent(payload: PatchedEventRequest): Promise<Event>;
    updateFile(
        payload: FileUpdateRequest & { id: string },
    ): Promise<FileRetrieve>;
    updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>;
    updateMyUser(payload: UpdateEnvParams): Promise<User>;
}
Check out the returned object documentation for the list of available methods.
Parameters
- Optionaloptions: ApiOptions
Returns {
    API: LowLevelApi;
    broadcast: (event: PitcherEvent) => Promise<any>;
    enterFullscreen: () => Promise<any>;
    exitFullscreen: () => Promise<any>;
    getRequestTypes: () => Promise<any>;
    isFullscreen: () => Promise<any>;
    logout: () => Promise<any>;
    off: (type: string, callback: (payload: PitcherEvent) => void) => void;
    on: (type: string, callback: (payload: PitcherEvent) => void) => void;
    quitInstance: () => Promise<any>;
    subscribe: () => Promise<any>;
    unsubscribe: () => Promise<any>;
    assignCanvasTheme(
        payload: { canvas_id: string; theme_id: string },
    ): Promise<{ canvas_id: string; theme_id: string }>;
    close(): Promise<any>;
    createCanvas(
        payload: Omit<CanvasCreateRequest, "instance_id">,
    ): Promise<CanvasRetrieve>;
    createEvent(payload: EventRequest): Promise<Event>;
    createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>;
    createFile(
        payload: Omit<AllFileCreateRequest, "instance_id">,
    ): Promise<FileRetrieve>;
    createFolder(
        payload: Omit<FolderCreateRequest, "instance_id">,
    ): Promise<FolderRetrieve>;
    crmQuery(payload: CRMQueryPayload): Promise<any>;
    deleteCanvas(payload: { id: string }): Promise<CanvasRetrieve>;
    deleteEvent(payload: Partial<Event>): Promise<void>;
    deleteFavorite(payload: { favorite_id: string }): Promise<void>;
    deleteFile(payload: { file_id: string }): Promise<string>;
    deleteFolder(payload: { folder_id: string }): Promise<void>;
    downloadFile(payload: { file_id: string }): Promise<null>;
    fetchDocumentInfo(
        payload: { fileId: string },
    ): Promise<{ pageCount: number; [key: string]: unknown }>;
    getAppConfig(payload: { app_name: string }): Promise<Record<string, any>>;
    getCanvas(
        payload: { fields?: string; id: string },
    ): Promise<CanvasRetrieve>;
    getCanvases(
        payload: GetCanvasesParams & {
            fields?: string;
            filters?: Record<string, any>;
        },
    ): Promise<PaginatedData<CanvasRetrieve>>;
    getCanvasRecommendedFiles(
        payload: { canvas_id: string; match?: ("metadata" | "tags")[] },
    ): Promise<CanvasRecommendedFiles>;
    getCanvasTheme(
        payload: { canvas_id: string },
    ): Promise<CanvasThemeRetrieve>;
    getCoreFolders(
        payload: {
            entity: CoreFolderEntityType;
            instance_id: string;
            parent_id?: null | string;
        },
    ): Promise<CoreFolderContentsRetrieve>;
    getEnv(): Promise<PitcherEnv>;
    getEvents(payload: Partial<EventRequest>): Promise<PaginatedData<Event>>;
    getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>;
    getFile(payload: { file_id?: string; id?: string }): Promise<FileRetrieve>;
    getFileRevisionData(
        payload: { file_id: string; revision_id: string },
    ): Promise<FileRetrieve>;
    getFileRevisions(
        payload: { file_id?: string; id?: string },
    ): Promise<FileRevision[]>;
    getFiles(
        payload: Partial<Omit<File, "type">> & {
            content_type?: FileContentTypeEnum | FileContentTypeEnum[];
            created_at__range?: string;
            expires_at__range?: string;
            id__in?: string;
            type?: FileTypeEnum | FileTypeEnum[];
            updated_at__range?: string;
        } & { fields?: string; filters?: Record<string, any> },
    ): Promise<PaginatedFileList>;
    getFolder(payload?: { id: string }): Promise<FolderRetrieve>;
    getFolders(payload: FolderListRequest): Promise<PaginatedFolderList>;
    getInstanceMetadataTemplates(
        payload?: GetInstanceMetadataTemplatesPayload,
    ): Promise<PaginatedMetadataTemplateList>;
    getLanguages(): Promise<Language[]>;
    getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>;
    getThemes(
        payload: Partial<CanvasThemeRetrieve>,
    ): Promise<CanvasThemeRetrieve[]>;
    getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>;
    moveFolderItems(
        payload: {
            items: { id: string; type: "folder" | "file" }[];
            target_folder_id: string;
        },
    ): Promise<FolderRetrieve>;
    notify(payload: NotificationPayload): Promise<void>;
    open(payload?: OpenRequestPayload): Promise<string>;
    openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>;
    openWebViewAlwaysOnTop(payload: OpenWebViewAlwaysOnTop): Promise<void>;
    patchCoreFolder(
        id: string,
        payload: Partial<CoreFolderRetrieve>,
    ): Promise<CoreFolderContentsRetrieve>;
    query(payload: QueryPayload): Promise<any>;
    refreshAccessToken(): any;
    refreshServiceToken(
        payload?: RefreshServiceTokenRequest,
    ): Promise<RefreshServiceTokenResponse>;
    renderPageAsImage(
        payload: {
            documentId?: string;
            fileId: string;
            pageIndex: number;
            params: { width: number } | { height: number };
        },
    ): Promise<ArrayBuffer>;
    search(payload: { includeExpired?: boolean; query: string }): Promise<any>;
    selectDeviceFile(): Promise<DeviceFile>;
    share(payload: SharePayload): Promise<ShareResponse>;
    shareCanvas(payload: { id: string }): Promise<SharedLink>;
    submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>;
    toast(payload: { message: string; type: string }): Promise<void>;
    track(payload: { event_name: string; payload: any }): Promise<any>;
    triggerNonFilesSync(): Promise<void>;
    unassignCanvasTheme(payload: { canvas_id: string }): Promise<void>;
    updateCanvas(
        payload: PatchedCanvasUpdateRequest & {
            fields?: string;
            id: string;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>;
    updateCanvasIndicators(
        payload: {
            id: string;
            indicators: Record<string, CanvasIndicator>;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>;
    updateEvent(payload: PatchedEventRequest): Promise<Event>;
    updateFile(
        payload: FileUpdateRequest & { id: string },
    ): Promise<FileRetrieve>;
    updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>;
    updateMyUser(payload: UpdateEnvParams): Promise<User>;
}
- API: LowLevelApi
- broadcast: (event: PitcherEvent) => Promise<any>
  Broadcast an event to CatalogIQ.
  Example
  usePitcherApi() .broadcast({ type: "canvas_updated", body: { context: { myContextProperty: 'test' } }, }) .then(function (result) { useUi().toast({ message: "Canvas Populated.", type: "info", }) })
- enterFullscreen: () => Promise<any>
  Make the entire CatalogIQ fullscreen.
  Example
  usePitcherApi().enterFullscreen()
- exitFullscreen: () => Promise<any>
  Exit fullscreen mode.
  Example
  usePitcherApi().exitFullscreen()
- getRequestTypes: () => Promise<any>
  Get the request types.
- isFullscreen: () => Promise<any>
  Return is CatalogIQ in fullscreen.
  Example
  usePitcherApi().isFullscreen()
- logout: () => Promise<any>
  Log out the current user.
  Example
  usePitcherApi().logout()
- off: (type: string, callback: (payload: PitcherEvent) => void) => void
  Unsubscribe from a given event type by its key and the attached callback reference.
  Example
  const callback = (event: object) => { // handle event } usePitcherApi().on('entered_fullscreen', callback) // later usePitcherApi().off('entered_fullscreen', callback)
- on: (type: string, callback: (payload: PitcherEvent) => void) => void
  Subscribe to a given event type by its key.
  Example
  Example
  const unsubscribeFromSectionListUpdate = usePitcherApi().on('entered_fullscreen', (event: object) => { // handle event }) // later unsubscribeFromSectionListUpdate()
- quitInstance: () => Promise<any>
  Quit the current instance and go to the instance selection screen.
  Example
  usePitcherApi().quitInstance()
- subscribe: () => Promise<any>
  Subscribe to updates.
- unsubscribe: () => Promise<any>
  Unsubscribe from updates.
- assignCanvasTheme:function
  - assignCanvasTheme(
    payload: { canvas_id: string; theme_id: string },
    ): Promise<{ canvas_id: string; theme_id: string }>
    Parameters
    payload: { canvas_id: string; theme_id: string }
    Returns Promise<{ canvas_id: string; theme_id: string }>
    Defined in src/lib/sdk/api/modules/theme.ts:8
- close:function
  - close(): Promise<any>
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/webView.ts:4
- createCanvas:function
  - createCanvas(
    payload: Omit<CanvasCreateRequest, "instance_id">,
    ): Promise<CanvasRetrieve>
    Parameters
    payload: Omit<CanvasCreateRequest, "instance_id">
    Returns Promise<CanvasRetrieve>
    Defined in src/lib/sdk/api/modules/canvas.ts:33
- createEvent:function
  - createEvent(payload: EventRequest): Promise<Event>
    Parameters
    payload: EventRequest
    Returns Promise<Event>
    Defined in src/lib/sdk/api/modules/events.ts:9
- createFavorite:function
  - createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>
    Create a favorite
    
    Parameters
    payload: FavoriteCreateRequest
    Returns Promise<Favorite>
    Defined in src/lib/sdk/api/modules/favorites.ts:14
- createFile:function
  - createFile(
    payload: Omit<AllFileCreateRequest, "instance_id">,
    ): Promise<FileRetrieve>
    Parameters
    payload: Omit<AllFileCreateRequest, "instance_id">
    Returns Promise<FileRetrieve>
    Defined in src/lib/sdk/api/modules/files.ts:55
- createFolder:function
  - createFolder(
    payload: Omit<FolderCreateRequest, "instance_id">,
    ): Promise<FolderRetrieve>
    Creates a new folder.
    
    Parameters
    payload: Omit<FolderCreateRequest, "instance_id">
    The folder creation request payload, excluding the instance_id.
    
    Returns Promise<FolderRetrieve>
    A promise that resolves to the created folder.
    
    Defined in src/lib/sdk/api/modules/folders.ts:35
- crmQuery:function
  - crmQuery(payload: CRMQueryPayload): Promise<any>
    Parameters
    payload: CRMQueryPayload
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/query.ts:8
- deleteCanvas:function
  - deleteCanvas(payload: { id: string }): Promise<CanvasRetrieve>
    Parameters
    payload: { id: string }
    Returns Promise<CanvasRetrieve>
    Defined in src/lib/sdk/api/modules/canvas.ts:37
- deleteEvent:function
  - deleteEvent(payload: Partial<Event>): Promise<void>
    Parameters
    payload: Partial<Event>
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/events.ts:17
- deleteFavorite:function
  - deleteFavorite(payload: { favorite_id: string }): Promise<void>
    Delete a favorite
    
    Parameters
    payload: { favorite_id: string }
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/favorites.ts:21
- deleteFile:function
  - deleteFile(payload: { file_id: string }): Promise<string>
    Parameters
    payload: { file_id: string }
    Returns Promise<string>
    Defined in src/lib/sdk/api/modules/files.ts:51
- deleteFolder:function
  - deleteFolder(payload: { folder_id: string }): Promise<void>
    Deletes a folder.
    
    Parameters
    payload: { folder_id: string }
    An object containing the ID of the folder to delete.
    
    folder_id: string
    The ID of the folder to delete.
    
    Returns Promise<void>
    A promise that resolves when the folder is deleted.
    
    Defined in src/lib/sdk/api/modules/folders.ts:56
- downloadFile:function
  - downloadFile(payload: { file_id: string }): Promise<null>
    Parameters
    payload: { file_id: string }
    Returns Promise<null>
    Defined in src/lib/sdk/api/modules/files.ts:27
- fetchDocumentInfo:function
  - fetchDocumentInfo(
    payload: { fileId: string },
    ): Promise<{ pageCount: number; [key: string]: unknown }>
    Parameters
    payload: { fileId: string }
    Returns Promise<{ pageCount: number; [key: string]: unknown }>
    Deprecated
    
    not used anymore
    
    Defined in src/lib/sdk/api/modules/pspdfkit.ts:6
- getAppConfig:function
  - getAppConfig(payload: { app_name: string }): Promise<Record<string, any>>
    Parameters
    payload: { app_name: string }
    Returns Promise<Record<string, any>>
    Defined in src/lib/sdk/api/modules/files.ts:31
- getCanvas:function
  - getCanvas(payload: { fields?: string; id: string }): Promise<CanvasRetrieve>
    Parameters
    payload: { fields?: string; id: string }
    Returns Promise<CanvasRetrieve>
    Defined in src/lib/sdk/api/modules/canvas.ts:100
- getCanvases:function
  - getCanvases(
        payload: GetCanvasesParams & {
            fields?: string;
            filters?: Record<string, any>;
        },
    ): Promise<PaginatedData<CanvasRetrieve>>
    Fetches a list of canvases to use in your app.
    
    Parameters
    payload: GetCanvasesParams & { fields?: string; filters?: Record<string, any> }
    Returns Promise<PaginatedData<CanvasRetrieve>>
    Example
    // The `filters` object is a reserved payload key to transfer the metadata dict over the wire. api.getCanvases({ search: 'my search query', ordering: '-created_at', filters: { metadata__mydaterangefiltername__range: ['2023-12-10', '2023-12-22'], metadata__mymultiselectfiltername: ['optionAValue', 'optionCValue'], }, fields: 'id,name,metadata', })
    
    Defined in src/lib/sdk/api/modules/canvas.ts:27
- getCanvasRecommendedFiles:function
  - getCanvasRecommendedFiles(
    payload: { canvas_id: string; match?: ("metadata" | "tags")[] },
    ): Promise<CanvasRecommendedFiles>
    Parameters
    payload: { canvas_id: string; match?: ("metadata" | "tags")[] }
    Returns Promise<CanvasRecommendedFiles>
    Defined in src/lib/sdk/api/modules/canvas.ts:108
- getCanvasTheme:function
  - getCanvasTheme(payload: { canvas_id: string }): Promise<CanvasThemeRetrieve>
    Parameters
    payload: { canvas_id: string }
    Returns Promise<CanvasThemeRetrieve>
    Defined in src/lib/sdk/api/modules/canvas.ts:115
- getCoreFolders:function
  - getCoreFolders(
        payload: {
            entity: CoreFolderEntityType;
            instance_id: string;
            parent_id?: null | string;
        },
    ): Promise<CoreFolderContentsRetrieve>
    Parameters
    payload: { entity: CoreFolderEntityType; instance_id: string; parent_id?: null | string }
    Returns Promise<CoreFolderContentsRetrieve>
    Defined in src/lib/sdk/api/modules/folders.core.ts:3
- getEnv:function
  - getEnv(): Promise<PitcherEnv>
    Fetches the necessary info for the app to know where it is embedded.
    
    It contains information about:
    
    user
    
    instance
    
    organization
    
    security token to query Pitcher REST API
    
    Salesforce connection information (if connected) including security token to query Salesforce REST API
    
    Auth0 token information
    
    Returns Promise<PitcherEnv>
    Example
    const env = usePitcherApi().getEnv().then((env) => { console.log(env.pitcher.user.name) })
    
    Defined in src/lib/sdk/api/modules/env.ts:22
- getEvents:function
  - getEvents(payload: Partial<EventRequest>): Promise<PaginatedData<Event>>
    Parameters
    payload: Partial<EventRequest>
    Returns Promise<PaginatedData<Event>>
    Defined in src/lib/sdk/api/modules/events.ts:5
- getFavorites:function
  - getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>
    Get a list of favorites
    
    Parameters
    Optionalpayload: GetFavoritesParams
    Returns Promise<PaginatedFavoriteList>
    Defined in src/lib/sdk/api/modules/favorites.ts:7
- getFile:function
  - getFile(payload: { file_id?: string; id?: string }): Promise<FileRetrieve>
    Parameters
    payload: { file_id?: string; id?: string }
    Returns Promise<FileRetrieve>
    Defined in src/lib/sdk/api/modules/files.ts:35
- getFileRevisionData:function
  - getFileRevisionData(
    payload: { file_id: string; revision_id: string },
    ): Promise<FileRetrieve>
    Parameters
    payload: { file_id: string; revision_id: string }
    Returns Promise<FileRetrieve>
    Defined in src/lib/sdk/api/modules/files.ts:40
- getFileRevisions:function
  - getFileRevisions(
    payload: { file_id?: string; id?: string },
    ): Promise<FileRevision[]>
    Parameters
    payload: { file_id?: string; id?: string }
    Returns Promise<FileRevision[]>
    Defined in src/lib/sdk/api/modules/filesRevisions.ts:3
- getFiles:function
  - getFiles(
        payload: Partial<Omit<File, "type">> & {
            content_type?: FileContentTypeEnum | FileContentTypeEnum[];
            created_at__range?: string;
            expires_at__range?: string;
            id__in?: string;
            type?: FileTypeEnum | FileTypeEnum[];
            updated_at__range?: string;
        } & { fields?: string; filters?: Record<string, any> },
    ): Promise<PaginatedFileList>
    Parameters
    payload: Partial<Omit<File, "type">> & {
        content_type?: FileContentTypeEnum | FileContentTypeEnum[];
        created_at__range?: string;
        expires_at__range?: string;
        id__in?: string;
        type?: FileTypeEnum | FileTypeEnum[];
        updated_at__range?: string;
    } & { fields?: string; filters?: Record<string, any> }
    Optionalcontent_type?: FileContentTypeEnum | FileContentTypeEnum[]
    Filter for content types.
    
    Optionalcreated_at__range?: string
    Range filter for creation date.
    
    Optionalexpires_at__range?: string
    Range filter for expiration date.
    
    Optionalid__in?: string
    Filter for file IDs.
    
    Optionaltype?: FileTypeEnum | FileTypeEnum[]
    Filter for file types.
    
    Optionalupdated_at__range?: string
    Range filter for update date.
    
    Optionalfields?: string
    Optionalfilters?: Record<string, any>
    Returns Promise<PaginatedFileList>
    Defined in src/lib/sdk/api/modules/files.ts:5
- getFolder:function
  - getFolder(payload?: { id: string }): Promise<FolderRetrieve>
    Retrieves a folder by its ID.
    
    Parameters
    payload: { id: string } = ...
    An object containing the folder ID.
    
    id: string
    The ID of the folder to retrieve. Defaults to 'root'.
    
    Returns Promise<FolderRetrieve>
    A promise that resolves to the retrieved folder.
    
    Defined in src/lib/sdk/api/modules/folders.ts:26
- getFolders:function
  - getFolders(payload: FolderListRequest): Promise<PaginatedFolderList>
    Retrieves a list of folders.
    
    Parameters
    payload: FolderListRequest
    The payload containing the search, ordering, filters, fields, name, page, and page_size.
    
    Returns Promise<PaginatedFolderList>
    A promise that resolves to the list of folders.
    
    Defined in src/lib/sdk/api/modules/folders.ts:16
- getInstanceMetadataTemplates:function
  - getInstanceMetadataTemplates(
    payload?: GetInstanceMetadataTemplatesPayload,
    ): Promise<PaginatedMetadataTemplateList>
    Parameters
    Optionalpayload: GetInstanceMetadataTemplatesPayload
    Returns Promise<PaginatedMetadataTemplateList>
    Defined in src/lib/sdk/api/modules/metadataTemplates.ts:4
- getLanguages:function
  - getLanguages(): Promise<Language[]>
    Fetches available languages for the logged-in user
    
    Returns Promise<Language[]>
    Defined in src/lib/sdk/api/modules/languages.ts:9
- getRecentFiles:function
  - getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>
    Parameters
    Optionalpayload: GetRecentFilesPayload
    Returns Promise<File[]>
    Defined in src/lib/sdk/api/modules/files.ts:23
- getThemes:function
  - getThemes(payload: Partial<CanvasThemeRetrieve>): Promise<CanvasThemeRetrieve[]>
    Parameters
    payload: Partial<CanvasThemeRetrieve>
    Returns Promise<CanvasThemeRetrieve[]>
    Defined in src/lib/sdk/api/modules/theme.ts:4
- getUsers:function
  - getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>
    Parameters
    Optionalpayload: GetUsersParams
    Returns Promise<PaginatedData<User>>
    Defined in src/lib/sdk/api/modules/users.ts:5
- moveFolderItems:function
  - moveFolderItems(
        payload: {
            items: { id: string; type: "folder" | "file" }[];
            target_folder_id: string;
        },
    ): Promise<FolderRetrieve>
    Moves items (files or folders) to a target folder.
    
    Parameters
    payload: { items: { id: string; type: "folder" | "file" }[]; target_folder_id: string }
    The payload containing the target folder ID and items to move.
    
    items: { id: string; type: "folder" | "file" }[]
    An array of items to move, each with an ID and type.
    
    target_folder_id: string
    The ID of the target folder.
    
    Returns Promise<FolderRetrieve>
    A promise that resolves to the updated target folder.
    
    Defined in src/lib/sdk/api/modules/folders.ts:67
- notify:function
  - notify(payload: NotificationPayload): Promise<void>
    Parameters
    payload: NotificationPayload
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/notifications.ts:4
- open:function
  - open(payload?: OpenRequestPayload): Promise<string>
    Open a file in the CatalogIQ instance.
    
    Parameters
    payload: OpenRequestPayload = {}
    Returns Promise<string>
    Defined in src/lib/sdk/api/modules/open.ts:6
- openExternalUrl:function
  - openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>
    Open external URL in a new tab. Works on both web and mobile.
    
    Parameters
    payload: OpenExternalUrlRequestPayload
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/open.ts:13
- openWebViewAlwaysOnTop:function
  - openWebViewAlwaysOnTop(payload: OpenWebViewAlwaysOnTop): Promise<void>
    Parameters
    payload: OpenWebViewAlwaysOnTop
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/webView.ts:8
- patchCoreFolder:function
  - patchCoreFolder(
    id: string,
    payload: Partial<CoreFolderRetrieve>,
    ): Promise<CoreFolderContentsRetrieve>
    Parameters
    id: string
    payload: Partial<CoreFolderRetrieve>
    Returns Promise<CoreFolderContentsRetrieve>
    Defined in src/lib/sdk/api/modules/folders.core.ts:11
- query:function
  - query(payload: QueryPayload): Promise<any>
    Parameters
    payload: QueryPayload
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/query.ts:4
- refreshAccessToken:function
  - refreshAccessToken(): any
    Returns any
    Defined in src/lib/sdk/api/modules/users.ts:17
- refreshServiceToken:function
  - refreshServiceToken(
    payload?: RefreshServiceTokenRequest,
    ): Promise<RefreshServiceTokenResponse>
    Ask for a refreshed Salesforce token. In case the token hasn't expired yet, this method will return the same token as the current one found in the (getEnv)[#getenv] result.
    
    Parameters
    Optionalpayload: RefreshServiceTokenRequest
    Returns Promise<RefreshServiceTokenResponse>
    Promise resolving to an object containing the token
    
    Defined in src/lib/sdk/api/modules/users.ts:13
- renderPageAsImage:function
  - renderPageAsImage(
        payload: {
            documentId?: string;
            fileId: string;
            pageIndex: number;
            params: { width: number } | { height: number };
        },
    ): Promise<ArrayBuffer>
    Renders a page from a file together with annotations.
    
    Parameters
    payload: {
        documentId?: string;
        fileId: string;
        pageIndex: number;
        params: { width: number } | { height: number };
    }
    OptionaldocumentId?: string
    The ID of the document to render (optional). If not provided the fileId will be used.
    
    fileId: string
    The ID of the file to render. Used when the documentId is not available.
    
    pageIndex: number
    The index of the page to render.
    
    params: { width: number } | { height: number }
    The parameters to use for rendering the page.
    
    Returns Promise<ArrayBuffer>
    A promise that resolves with the image as an ArrayBuffer.
    
    Example
    api.renderPageAsImage({ fileId: '123456', documentId: '654321', pageIndex: 0, params: { width: 1920 }, })
    
    Defined in src/lib/sdk/api/modules/pspdfkit.ts:26
- search:function
  - search(payload: { includeExpired?: boolean; query: string }): Promise<any>
    Parameters
    payload: { includeExpired?: boolean; query: string }
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/search.ts:1
- selectDeviceFile:function
  - selectDeviceFile(): Promise<DeviceFile>
    Dispatches iOS native file selector and returns the selected file.
    
    Returns Promise<DeviceFile>
    Example
    // iOS only method to select a file from the device. api.selectDeviceFile()
    
    Defined in src/lib/sdk/api/modules/files.ts:66
- share:function
  - share(payload: SharePayload): Promise<ShareResponse>
    Dispatch iOS sharing dialog.
    
    Parameters
    payload: SharePayload
    Returns Promise<ShareResponse>
    Example
    api.share({text: "example text", subject: "example subject"})
    
    Defined in src/lib/sdk/api/modules/share.ts:9
- shareCanvas:function
  - shareCanvas(payload: { id: string }): Promise<SharedLink>
    Parameters
    payload: { id: string }
    Returns Promise<SharedLink>
    Defined in src/lib/sdk/api/modules/canvas.ts:104
- submitUserFeedback:function
  - submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>
    Submit user feedback
    
    Parameters
    payload: SubmitUserFeedbackPayload
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/feedback.ts:8
- toast:function
  - toast(payload: { message: string; type: string }): Promise<void>
    Parameters
    payload: { message: string; type: string }
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/toast.ts:1
- track:function
  - track(payload: { event_name: string; payload: any }): Promise<any>
    Parameters
    payload: { event_name: string; payload: any }
    Returns Promise<any>
    Defined in src/lib/sdk/api/modules/track.ts:3
- triggerNonFilesSync:function
  - triggerNonFilesSync(): Promise<void>
    Dispatches iOS only sync method for non-files.
    
    Returns Promise<void>
    Example
    // iOS only method to sync non-files from the server. api.triggerNonFilesSync()
    
    Defined in src/lib/sdk/api/modules/sync.ts:8
- unassignCanvasTheme:function
  - unassignCanvasTheme(payload: { canvas_id: string }): Promise<void>
    Parameters
    payload: { canvas_id: string }
    Returns Promise<void>
    Defined in src/lib/sdk/api/modules/canvas.ts:119
- updateCanvas:function
  - updateCanvas(
        payload: PatchedCanvasUpdateRequest & {
            fields?: string;
            id: string;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>
    Updates a canvas by ID
    
    Parameters
    payload: PatchedCanvasUpdateRequest & {
        fields?: string;
        id: string;
        instance_id?: string;
    }
    Returns Promise<CanvasRetrieve>
    Example
    // The fields param is appended to the URL as a query param. onMounted(() => { PitcherAPI.updateCanvas({ id: '01HH4RCBH631K4JDHWAQB0RPR6', fields: 'id,name', name: 'To 3!', }).then((res) => { console.log(res) // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' } }) })
    
    Defined in src/lib/sdk/api/modules/canvas.ts:56
- updateCanvasIndicators:function
  - updateCanvasIndicators(
        payload: {
            id: string;
            indicators: Record<string, CanvasIndicator>;
            instance_id?: string;
        },
    ): Promise<CanvasRetrieve>
    Updates canvas indicators by canvas ID. It merges the passed object into existing canvas indicators adding new keys if they were empty and overriding pre-existing keys.
    
    Indicators can also be updated using updateCanvas API but in this case passed object fully replaces existing indicators.
    
    Parameters
    payload: {
        id: string;
        indicators: Record<string, CanvasIndicator>;
        instance_id?: string;
    }
    Returns Promise<CanvasRetrieve>
    Example
    // The fields param is appended to the URL as a query param. onMounted(() => { PitcherAPI.updateCanvasIndicators({ id: '01J9XT0WVXRTETF4CQZP42CPZP', indicators: { existing: { type: 'info', label: 'new label' }, // will be overriden new: { type: 'info', label: 'INFO' }, // will be added removeExisting: null // will be set to null and ignored, it is the same as removal } }).then((res) => { console.log(res) // entire canvas object, including indicators field }) })
    
    Defined in src/lib/sdk/api/modules/canvas.ts:92
- updateEvent:function
  - updateEvent(payload: PatchedEventRequest): Promise<Event>
    Parameters
    payload: PatchedEventRequest
    Returns Promise<Event>
    Defined in src/lib/sdk/api/modules/events.ts:13
- updateFile:function
  - updateFile(payload: FileUpdateRequest & { id: string }): Promise<FileRetrieve>
    Parameters
    payload: FileUpdateRequest & { id: string }
    Returns Promise<FileRetrieve>
    Defined in src/lib/sdk/api/modules/files.ts:47
- updateFolder:function
  - updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>
    Updates an existing folder.
    
    Parameters
    payload: UpdateFolderPayload
    The folder update payload, including the folder ID and update data.
    
    Returns Promise<FolderRetrieve>
    A promise that resolves to the updated folder.
    
    Defined in src/lib/sdk/api/modules/folders.ts:46
- updateMyUser:function
  - updateMyUser(payload: UpdateEnvParams): Promise<User>
    Parameters
    payload: UpdateEnvParams
    Returns Promise<User>
    Defined in src/lib/sdk/api/modules/env.ts:28
- Defined in src/lib/sdk/main.ts:22

Function usePitcherApi

Parameters

API: LowLevelApi

broadcast: (event: PitcherEvent) => Promise<any>

Example

enterFullscreen: () => Promise<any>

Example

exitFullscreen: () => Promise<any>

Example

getRequestTypes: () => Promise<any>

isFullscreen: () => Promise<any>

Example

logout: () => Promise<any>

Example

off: (type: string, callback: (payload: PitcherEvent) => void) => void

Example

on: (type: string, callback: (payload: PitcherEvent) => void) => void

Example

Example

quitInstance: () => Promise<any>

Example

subscribe: () => Promise<any>

unsubscribe: () => Promise<any>

assignCanvasTheme:function

Parameters

Returns Promise<{ canvas_id: string; theme_id: string }>

close:function

Returns Promise<any>

createCanvas:function

Parameters

Returns Promise<CanvasRetrieve>

createEvent:function

Parameters

Returns Promise<Event>

createFavorite:function

Parameters

Returns Promise<Favorite>

createFile:function

Parameters

Returns Promise<FileRetrieve>

createFolder:function

Parameters

Returns Promise<FolderRetrieve>

crmQuery:function

Parameters

Returns Promise<any>

deleteCanvas:function

Parameters

Returns Promise<CanvasRetrieve>

deleteEvent:function

Parameters

Returns Promise<void>

deleteFavorite:function

Parameters

Returns Promise<void>

deleteFile:function

Parameters

Returns Promise<string>

deleteFolder:function

Parameters

folder_id: string

Returns Promise<void>

downloadFile:function

Parameters

Returns Promise<null>

fetchDocumentInfo:function

Parameters

Returns Promise<{ pageCount: number; [key: string]: unknown }>

Deprecated

getAppConfig:function

Parameters

Returns Promise<Record<string, any>>

getCanvas:function

Parameters

Returns Promise<CanvasRetrieve>

getCanvases:function

Parameters

Returns Promise<PaginatedData<CanvasRetrieve>>

Example

getCanvasRecommendedFiles:function

`Optional`content_type?: FileContentTypeEnum | FileContentTypeEnum[]

`Optional`created_at__range?: string

`Optional`expires_at__range?: string

`Optional`id__in?: string

`Optional`type?: FileTypeEnum | FileTypeEnum[]

`Optional`updated_at__range?: string

`Optional`fields?: string

`Optional`filters?: Record<string, any>