Skip to main content

SDKMode

The SDK initialization mode. Passed via TFrameConfig.mode. Determines the UI and available functionality of the embedded frame.

Example​

sdk.init({ mode: SDKMode.Manager, frameId: "ds-frame", src: "https://portal.example.com" });

Enumeration Members​

Enumeration MemberValueDescription
Chat"chat"AI chat interface. Full-page conversation UI, bound to an AI agent when TFrameConfig.agentId is set, to the current user otherwise.
Editor"editor"Document editor. Requires TFrameConfig.id — the file identifier to open for editing.
FileSelector"file-selector"File picker dialog. Returns the selected file via TFrameEvents.onSelectCallback. Filterable by TFrameConfig.selectorType.
Forms"forms"Forms gallery. Displays forms for the room specified by TFrameConfig.id. Supports TFrameConfig.showMenu to toggle the side panel.
Manager"manager"File/folder browser. Displays a list of entities at TFrameConfig.rootPath. Supports CRUD operations on rooms, folders, and files. Forces TFrameConfig.noLoader to false.
Personal"personal"Personal files browser. File/folder manager for the user's personal space (My Documents, Favorites, Recent, Shared with me, Trash). Uses TFrameConfig.personalDestination to pick the initial section; has no navigation menu of its own, so the host switches sections with SDKInstance.navigateSection.
PublicRoom"public-room"Public room view. Grants anonymous access to view, edit, comment on, and review documents. Requires TFrameConfig.requestToken.
RoomSelector"room-selector"Room picker dialog. Returns the selected room via TFrameEvents.onSelectCallback.
System"system"Headless mode. Renders a blank page with a loader; used to call session methods (SDKInstance.login, SDKInstance.logout) without UI. Forces TFrameConfig.noLoader to false.
Uploader"uploader"File upload interface. Uploads files to the folder specified by TFrameConfig.id.
Viewer"viewer"Read-only document viewer. Requires TFrameConfig.id — the file identifier to open for viewing.