Type Aliases

Configuration, event, filter and data shapes exchanged with the embedded frame. Most integrations only need TFrameConfig and TFrameEvents; the remaining types describe what the instance methods accept and return.

Overview

The following types are available:

Type	Description
TAppReadyPayload	Payload of TFrameEvents.onAppReady.
TAuthError	Payload of TFrameEvents.onAuthError.
TAuthErrorCode	Failure categories reported through TFrameEvents.onAuthError in OAuth mode.
TBannerDisplaying	String literal union of all HeaderBannerDisplaying values.
TCreatedBy	User reference in file/folder/room metadata.
TCreateRoomOptions	Optional settings for SDKInstance.createRoom.
TCustomActionEvent	Payload of TFrameEvents.onCustomAction.
TCustomActionsConfig	Custom actions of a frame, set with TFrameConfig.customActions or SDKInstance.setCustomActions.
TCustomActionSection	A section a custom action can be limited to: a TManagerSection, a TPersonalSection or a TFormsSection, matched against the mode the frame runs in.
TCustomContextMenuAction	A custom context menu item.
TCustomContextMenuActions	Custom context menu actions grouped by the entity type they apply to.
TCustomCreateAction	A custom item of the create ("+") menu.
TEditorAction	Editor action the manager requests when it opens a file: "view" read-only, "fill" form filling, "edit" editing.
TEditorAnonymous	Anonymous user settings for the editor, passed via TEditorCustomization.anonymous.
TEditorCustomization	Editor customization options passed via TFrameConfig.editorCustomization.
TEditorOpenPayload	Payload of TFrameEvents.onEditorOpen: the file the frame is about to open plus the requested action.
TEditorType	String literal union of all EditorType values.
TEntityBase	Common fields shared by file, folder, and room metadata.
TFileInfo	File information returned by SDK methods.
TFilesResponse	Response wrapper for file/folder listing methods.
TFilterSearchPayload	Payload of TFrameEvents.onFilterSearch.
TFilterSortBy	String literal union of all FilterSortBy values.
TFilterSortOrder	String literal union of all FilterSortOrder values.
TFolderInfo	Folder information returned by SDK methods.
TFormsSection	Navigation sections available in SDKMode.Forms mode.
TFrameConfig	The main configuration object for initializing an ONLYOFFICE Apps frame.
TFrameEvents	Event handler map for the ONLYOFFICE Apps iframe.
TFrameFilter	Filter and pagination parameters for the file list in SDKMode.Manager mode.
TFrameMode	String literal union of all SDKMode values.
TGetExternalDataRequest	Payload the ONLYOFFICE Apps iframe sends when it asks the host to read a value from external storage.
THashSettings	Password hash settings returned by SDKInstance.getHashSettings.
TInitConfig	Configuration accepted by the mode-specific SDK.init* wrappers (SDK.initManager, SDK.initPersonal, ...): a TFrameConfig whose mode is optional because the wrapper sets it.
TListResponse<TFolder>	Response wrapper for paginated listing methods.
TLoginResult	Result of SDKInstance.login.
TLogo	Room logo information.
TManagerSection	Sections of SDKMode.Manager a custom action can be limited to, named after the root folder the user is in: rooms, archive, my-documents, recent, favorites, shared (shared with me) and trash.
TManagerViewMode	String literal union of all ManagerViewMode values.
TNavigatePayload	Payload of TFrameEvents.onNavigate.
TPathParts	Breadcrumb path segment in file/room listing responses.
TPersonalSection	Navigation sections available in SDKMode.Personal mode.
TRejectedFile	A file the SDKMode.Uploader dialog refused before uploading.
TRequestTokenInfo	One external link of a selected room or file, attached to selector payloads.
TRoomInfo	Room information returned by SDK methods.
TRoomsResponse	Response wrapper for room listing methods.
TSDKErrorDetails	Extra details attached to an SDKError.
TSelectedFile	The SDKMode.FileSelector payload of TFrameEvents.onSelectCallback: a single object, not an array.
TSelectedRoom	One selected room in the SDKMode.RoomSelector payload.
TSelectorType	String literal union of all SelectorFilterType values.
TSetExternalDataPayload	Payload the ONLYOFFICE Apps iframe sends when it asks the host to persist a value in external storage.
TTheme	String literal union of all Theme values.
TUploadedFile	A file stored by the SDKMode.Uploader dialog: the upload session response of the portal.
TUploadError	Payload of TFrameEvents.onUploadError in SDKMode.Forms and SDKMode.Personal: the file transferred with SDKInstance.upload that the frame could not store.
TUploaderUploadError	Payload of TFrameEvents.onUploadError in SDKMode.Uploader: the batch failed or some files were refused.
TUploaderUploadResult	One element of the TFrameEvents.onUploadSuccess payload in SDKMode.Uploader: the portal's API envelope around the stored file.
TUploadProgress	Payload of TFrameEvents.onUploadProgress in SDKMode.Uploader: one event per uploaded chunk of each file.
TUploadRejection	One reason a file was rejected by the SDKMode.Uploader dialog.
TUploadResult	Payload of TFrameEvents.onUploadSuccess in SDKMode.Forms and SDKMode.Personal: one object per file transferred with SDKInstance.upload.
TUserGroup	A group the user belongs to, as listed in TUserInfo.groups.
TUserInfo	User information returned by SDKInstance.getUserInfo.