Class RoomsResource

Rooms API — create and manage rooms (meetings).

Index

Constructors

Methods

create end get list validate

Constructors

constructor

new RoomsResource(http: HttpClient): RoomsResource
Parameters
- http: HttpClient
Returns RoomsResource

Methods

create

create(options?: CreateRoomOptions): Promise<Room>
Create a room. Idempotent when customRoomId is supplied.
Parameters
- options: CreateRoomOptions = {}
Returns Promise<Room>

end

end(roomId: string): Promise<Room>
End (deactivate/disable) a room. Returns the now-disabled room.

Note: unlike RoomsResource.get/RoomsResource.validate, this resolves only the VideoSDK roomId — a customRoomId is rejected with 402.
Parameters
- roomId: string
Returns Promise<Room>

get

get(roomId: string): Promise<Room>
Fetch a room by id, roomId, or customRoomId.
Parameters
- roomId: string
Returns Promise<Room>

list

list(params?: ListRoomsParams): Promise<Page<Room>>
List rooms (paginated, async-iterable).
Parameters
- params: ListRoomsParams = {}
Returns Promise<Page<Room>>

validate

validate(roomId: string): Promise<RoomValidation>
Validate that a room id belongs to the caller. Returns { valid, roomId } (with the resolved room when valid) instead of throwing on an unknown id.
Parameters
- roomId: string
Returns Promise<RoomValidation>