TFrameFilter

Filter and pagination parameters for the file list in SDKMode.Manager mode. Passed via TFrameConfig.filter and accepted by SDKInstance.getRooms.

type TFrameFilter = object;

Examples

sdk.init({
  mode: "manager",
  filter: { count: "50", sortBy: "AZ", sortOrder: "ascending" },
  ...
});

Only the rooms of one room group, e.g. the rooms attached to a CRM deal.

sdk.initManager({
  frameId: "ds-frame",
  src: "https://portal.example.com",
  rootPath: "/rooms/shared/",
  filter: { groupId: "42" },
});

Properties

Property	Type	Description
count	string	Items per page. Default: "100".
folder	string	Target folder ID. Set automatically when TFrameConfig.id is provided in manager mode.
groupId	string	Room group ID (GET /api/2.0/files/group). On the rooms list of SDKMode.Manager (rootPath /rooms/shared/) only the rooms of that group are shown, and the group is pinned: search and filters inside the frame stay within it and the group chips are hidden. Also narrows SDKInstance.getRooms. Requires ONLYOFFICE Apps 4.0. Unset by default.
page	string	Page number (1-based). Default: "1".
search	string	Search query. Empty string = no search. Default: "".
sortBy	TFilterSortBy	Sort criterion. See FilterSortBy. Default: FilterSortBy.ModifiedDate.
sortOrder	TFilterSortOrder	Sort direction. See FilterSortOrder. Default: FilterSortOrder.Descending.
withSubfolders	boolean	Include sub-folder contents in search results. Default: false.