Interface: RoomsApi

The methods of Talkline.rooms.

Methods

create()

create(body?): Promise<Room>;

POST /v1/rooms.

Parameters

Parameter	Type
body?	CreateRoomRequest

Returns

Promise<Room>

---

end()

end(sid): Promise<void>;

DELETE /v1/rooms/{sid}: everyone in it leaves as evicted; ending an ended room is not an error.

Parameters

Parameter	Type
sid	string

Returns

Promise<void>

---

evict()

evict(sid, identity): Promise<void>;

DELETE /v1/rooms/{sid}/participants/{identity}.

Parameters

Parameter	Type
sid	string
identity	string

Returns

Promise<void>

---

get()

get(sid): Promise<RoomDetail>;

GET /v1/rooms/{sid}: with the participants in it now and their live tracks.

Parameters

Parameter	Type
sid	string

Returns

Promise<RoomDetail>

---

iterate()

iterate(query?): AsyncIterable<Room>;

GET /v1/rooms, every page in turn.

Parameters

Parameter	Type
query?	Pageless<ListRoomsQuery>

Returns

AsyncIterable<Room>

---

iterateParticipants()

iterateParticipants(sid, query?): AsyncIterable<Participant>;

GET /v1/rooms/{sid}/participants, every page in turn.

Parameters

Parameter	Type
sid	string
query?	Pageless<ListParticipantsQuery>

Returns

AsyncIterable<Participant>

---

list()

list(query?): Promise<Page<Room>>;

GET /v1/rooms, one page.

Parameters

Parameter	Type
query?	ListRoomsQuery

Returns

Promise<Page<Room>>

---

listParticipants()

listParticipants(sid, query?): Promise<Page<Participant>>;

GET /v1/rooms/{sid}/participants, one page.

Parameters

Parameter	Type
sid	string
query?	ListParticipantsQuery

Returns

Promise<Page<Participant>>

---

sendData()

sendData(sid, message): Promise<SendDataResult>;

POST /v1/rooms/{sid}/data.

Parameters

Parameter	Type
sid	string
message	SendDataRequest

Returns

Promise<SendDataResult>

---

updateParticipant()

updateParticipant(
   sid, 
   identity, 
   body
): Promise<Participant>;

PATCH /v1/rooms/{sid}/participants/{identity}.

Parameters

Parameter	Type
sid	string
identity	string
body	UpdateParticipantRequest

Returns

Promise<Participant>