Interface OpenRequestPayload

Payload object for opening a file.

interface OpenRequestPayload {
    canvasCorrelationId?: string;
    canvasInView?: boolean;
    context?: Record<string, any>;
    fileId?: string;
    files?: { ids: string[]; strategy: "simultaneous" | "swap" };
    fromCanvasId?: string;
    isInCall?: boolean;
    isOverlayApp?: boolean;
    newTab?: boolean;
    pageIndex?: number;
    search?: string;
    startTime?: number;
    url?: null | string;
    usedInSectionId?: string;
}

Properties

canvasCorrelationId? canvasInView? context? fileId? files? fromCanvasId? isInCall? isOverlayApp? newTab? pageIndex? search? startTime? url? usedInSectionId?

Properties

OptionalcanvasCorrelationId

canvasCorrelationId?: string

Tracking id for the canvas presentation session.

OptionalcanvasInView

canvasInView?: boolean

Indicates if the canvas is in view.

Optionalcontext

context?: Record<string, any>

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

OptionalfileId

fileId?: string

Id of the file to open.

Optionalfiles

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

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

OptionalfromCanvasId

fromCanvasId?: string

Id of the canvas from which the file is opened.

OptionalisInCall

isInCall?: boolean

Indicates if the user is in a call.

OptionalisOverlayApp

isOverlayApp?: boolean

Indicates if the app should be opened as overlay.

OptionalnewTab

newTab?: boolean

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

OptionalpageIndex

pageIndex?: number

Optional, page index to open. Default is null.

Optionalsearch

search?: string

Search query string within the file.

OptionalstartTime

startTime?: number

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

Optionalurl

url?: null | string

URL of the file content.

OptionalusedInSectionId

usedInSectionId?: string

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

Settings

Member Visibility

On This Page

Properties