Function useDsr

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

const dsrApi = useDsr()
Copy

Returns {
    on: (
        type: "dsr_env_changed",
        handler: (data: DsrEnv) => Promise<void>,
    ) => Promise<() => void>;
    close(): Promise<void>;
    embeddableReady(): Promise<void>;
    getEnv(): Promise<DsrEnv>;
    getFile(payload: { id: string }): Promise<File>;
}

• on: (
      type: "dsr_env_changed",
      handler: (data: DsrEnv) => Promise<void>,
  ) => Promise<() => void>

• close:function

  • close(): Promise<void>

    Closes the already open file that was opened via api or by the user.

    Returns Promise<void>

    Example

    dsrApi.close()
    Copy

• embeddableReady:function

  • embeddableReady(): Promise<void>

    Signal to DSR that the app is ready to be shown.

    Returns Promise<void>

    Example

    useDsr().embeddableReady()
    Copy

• getEnv:function

  • getEnv(): Promise<DsrEnv>

    Fetches the necessary info for the app to know where it is embedded.

    Check out usePitcherApi().getEnv() for more information.

    Returns Promise<DsrEnv>

    Example

    useDsr().getEnv()
    Copy

• getFile:function

  • getFile(payload: { id: string }): Promise<File>

    Fetches a file by ID.

    Parameters

    • payload: { id: string }

    Returns Promise<File>

    Example

    dsrApi.getFile({ id: 'my-file-id' })
    Copy