Interface FFCListVideoRoomsQuery

Represents a query object for fetching a list of video rooms with optional filters. Extends FFCQuery to include additional filtering options.

interface FFCListVideoRoomsQuery {
    accessLevel?: PUBLIC;
    appUserId?: string;
    keyword?: string;
    page?: number;
    pageSize?: number;
    sortBy?: FFCVideoRoomsSortOption;
    type?: FFCVideoRoomType;
    videoRoomState?: FFCVideoRoomState;
}

Hierarchy (View Summary)

Properties

accessLevel? appUserId? keyword? page? pageSize? sortBy? type? videoRoomState?

Properties

OptionalaccessLevel

accessLevel?: PUBLIC

The access level of the video room. Determines if the room is public, private, or has restricted access. Uses FFCAccessLevel.

OptionalappUserId

appUserId?: string

Filter results by application user ID. If provided, the query will return only video rooms associated with this user.

Optionalkeyword

keyword?: string

Keyword used for searching video rooms by name or other relevant fields. If provided, only rooms matching the keyword will be returned.

Optionalpage

page?: number

The page number for pagination (1-based index). If not provided, defaults to the first page.

OptionalpageSize

pageSize?: number

The number of items per page. Determines the maximum number of results per query.

OptionalsortBy

sortBy?: FFCVideoRoomsSortOption

Sorting criteria for the query.

Optionaltype

type?: FFCVideoRoomType

The type of video room. Specifies whether the room is a one-on-one call, a group call, etc. Uses FFCVideoRoomType.

OptionalvideoRoomState

videoRoomState?: FFCVideoRoomState

The state of the video room. Defines whether the room is active, inactive, or in another state. Uses FFCVideoRoomState.

Settings

Member Visibility

On This Page

Properties