$RoomClient class

Constructors

$RoomClient.new($Client _rootClient)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addParticipantToRoom({required String newParticipant, required String token, RoomAddParticipantToRoomSource? source, RoomAddParticipantToRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomAddParticipantToRoomResponseApplicationJson, void>>
Add a participant to a room.
addParticipantToRoomRaw({required String newParticipant, required String token, RoomAddParticipantToRoomSource? source, RoomAddParticipantToRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomAddParticipantToRoomResponseApplicationJson, void>
Add a participant to a room.
addToFavorites({required String token, RoomAddToFavoritesApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomAddToFavoritesResponseApplicationJson, void>>
Add a room to the favorites.
addToFavoritesRaw({required String token, RoomAddToFavoritesApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomAddToFavoritesResponseApplicationJson, void>
Add a room to the favorites.
createRoom({required int roomType, String? invite, String? roomName, String? source, String? objectType, String? objectId, RoomCreateRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomCreateRoomResponseApplicationJson, void>>
Create a room with a user, a group or a circle.
createRoomRaw({required int roomType, String? invite, String? roomName, String? source, String? objectType, String? objectId, RoomCreateRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomCreateRoomResponseApplicationJson, void>
Create a room with a user, a group or a circle.
deleteRoom({required String token, RoomDeleteRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomDeleteRoomResponseApplicationJson, void>>
Delete a room.
deleteRoomRaw({required String token, RoomDeleteRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomDeleteRoomResponseApplicationJson, void>
Delete a room.
demoteModerator({required int attendeeId, required String token, RoomDemoteModeratorApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomDemoteModeratorResponseApplicationJson, void>>
Demote an attendee from moderator.
demoteModeratorRaw({required int attendeeId, required String token, RoomDemoteModeratorApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomDemoteModeratorResponseApplicationJson, void>
Demote an attendee from moderator.
getBreakoutRoomParticipants({required String token, int? includeStatus, RoomGetBreakoutRoomParticipantsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson, RoomRoomGetBreakoutRoomParticipantsHeaders>>
Get the breakout room participants for a room.
getBreakoutRoomParticipantsRaw({required String token, int? includeStatus, RoomGetBreakoutRoomParticipantsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetBreakoutRoomParticipantsResponseApplicationJson, RoomRoomGetBreakoutRoomParticipantsHeaders>
Get the breakout room participants for a room.
getBreakoutRooms({required String token, RoomGetBreakoutRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetBreakoutRoomsResponseApplicationJson, void>>
Get breakout rooms.
getBreakoutRoomsRaw({required String token, RoomGetBreakoutRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetBreakoutRoomsResponseApplicationJson, void>
Get breakout rooms.
getListedRooms({String? searchTerm, RoomGetListedRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>>
Get listed rooms with optional search term.
getListedRoomsRaw({String? searchTerm, RoomGetListedRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetListedRoomsResponseApplicationJson, void>
Get listed rooms with optional search term.
getNoteToSelfConversation({RoomGetNoteToSelfConversationApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetNoteToSelfConversationResponseApplicationJson, RoomRoomGetNoteToSelfConversationHeaders>>
Get the "Note to self" conversation for the user.
getNoteToSelfConversationRaw({RoomGetNoteToSelfConversationApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetNoteToSelfConversationResponseApplicationJson, RoomRoomGetNoteToSelfConversationHeaders>
Get the "Note to self" conversation for the user.
getParticipants({required String token, int? includeStatus, RoomGetParticipantsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>>
Get a list of participants for a room.
getParticipantsRaw({required String token, int? includeStatus, RoomGetParticipantsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetParticipantsResponseApplicationJson, RoomRoomGetParticipantsHeaders>
Get a list of participants for a room.
getRooms({RoomGetRoomsNoStatusUpdate? noStatusUpdate, int? includeStatus, int? modifiedSince, RoomGetRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>>
Get all currently existent rooms which the user has joined.
getRoomsRaw({RoomGetRoomsNoStatusUpdate? noStatusUpdate, int? includeStatus, int? modifiedSince, RoomGetRoomsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>
Get all currently existent rooms which the user has joined.
getSingleRoom({required String token, RoomGetSingleRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomGetSingleRoomResponseApplicationJson, RoomRoomGetSingleRoomHeaders>>
Get a room.
getSingleRoomRaw({required String token, RoomGetSingleRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomGetSingleRoomResponseApplicationJson, RoomRoomGetSingleRoomHeaders>
Get a room.
joinRoom({required String token, String? password, int? force, RoomJoinRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomJoinRoomResponseApplicationJson, void>>
Join a room.
joinRoomRaw({required String token, String? password, int? force, RoomJoinRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomJoinRoomResponseApplicationJson, void>
Join a room.
leaveRoom({required String token, RoomLeaveRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomLeaveRoomResponseApplicationJson, void>>
Leave a room.
leaveRoomRaw({required String token, RoomLeaveRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomLeaveRoomResponseApplicationJson, void>
Leave a room.
makePrivate({required String token, RoomMakePrivateApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomMakePrivateResponseApplicationJson, void>>
Disallowed guests to join conversation.
makePrivateRaw({required String token, RoomMakePrivateApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomMakePrivateResponseApplicationJson, void>
Disallowed guests to join conversation.
makePublic({required String token, RoomMakePublicApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomMakePublicResponseApplicationJson, void>>
Allowed guests to join conversation.
makePublicRaw({required String token, RoomMakePublicApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomMakePublicResponseApplicationJson, void>
Allowed guests to join conversation.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
promoteModerator({required int attendeeId, required String token, RoomPromoteModeratorApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomPromoteModeratorResponseApplicationJson, void>>
Promote an attendee to moderator.
promoteModeratorRaw({required int attendeeId, required String token, RoomPromoteModeratorApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomPromoteModeratorResponseApplicationJson, void>
Promote an attendee to moderator.
removeAttendeeFromRoom({required int attendeeId, required String token, RoomRemoveAttendeeFromRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomRemoveAttendeeFromRoomResponseApplicationJson, void>>
Remove an attendee from a room.
removeAttendeeFromRoomRaw({required int attendeeId, required String token, RoomRemoveAttendeeFromRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomRemoveAttendeeFromRoomResponseApplicationJson, void>
Remove an attendee from a room.
removeFromFavorites({required String token, RoomRemoveFromFavoritesApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomRemoveFromFavoritesResponseApplicationJson, void>>
Remove a room from the favorites.
removeFromFavoritesRaw({required String token, RoomRemoveFromFavoritesApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomRemoveFromFavoritesResponseApplicationJson, void>
Remove a room from the favorites.
removeSelfFromRoom({required String token, RoomRemoveSelfFromRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomRemoveSelfFromRoomResponseApplicationJson, void>>
Remove the current user from a room.
removeSelfFromRoomRaw({required String token, RoomRemoveSelfFromRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomRemoveSelfFromRoomResponseApplicationJson, void>
Remove the current user from a room.
renameRoom({required String roomName, required String token, RoomRenameRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomRenameRoomResponseApplicationJson, void>>
Rename a room.
renameRoomRaw({required String roomName, required String token, RoomRenameRoomApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomRenameRoomResponseApplicationJson, void>
Rename a room.
resendInvitations({required String token, int? attendeeId, RoomResendInvitationsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomResendInvitationsResponseApplicationJson, void>>
Resend invitations.
resendInvitationsRaw({required String token, int? attendeeId, RoomResendInvitationsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomResendInvitationsResponseApplicationJson, void>
Resend invitations.
setAllAttendeesPermissions({required RoomSetAllAttendeesPermissionsMethod method, required RoomSetAllAttendeesPermissionsPermissions permissions, required String token, RoomSetAllAttendeesPermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetAllAttendeesPermissionsResponseApplicationJson, void>>
Update the permissions of all attendees.
setAllAttendeesPermissionsRaw({required RoomSetAllAttendeesPermissionsMethod method, required RoomSetAllAttendeesPermissionsPermissions permissions, required String token, RoomSetAllAttendeesPermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetAllAttendeesPermissionsResponseApplicationJson, void>
Update the permissions of all attendees.
setAttendeePermissions({required int attendeeId, required RoomSetAttendeePermissionsMethod method, required RoomSetAttendeePermissionsPermissions permissions, required String token, RoomSetAttendeePermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetAttendeePermissionsResponseApplicationJson, void>>
Update the permissions of an attendee.
setAttendeePermissionsRaw({required int attendeeId, required RoomSetAttendeePermissionsMethod method, required RoomSetAttendeePermissionsPermissions permissions, required String token, RoomSetAttendeePermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetAttendeePermissionsResponseApplicationJson, void>
Update the permissions of an attendee.
setDescription({required String description, required String token, RoomSetDescriptionApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetDescriptionResponseApplicationJson, void>>
Update the description of a room.
setDescriptionRaw({required String description, required String token, RoomSetDescriptionApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetDescriptionResponseApplicationJson, void>
Update the description of a room.
setListable({required RoomSetListableScope scope, required String token, RoomSetListableApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetListableResponseApplicationJson, void>>
Make a room listable.
setListableRaw({required RoomSetListableScope scope, required String token, RoomSetListableApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetListableResponseApplicationJson, void>
Make a room listable.
setLobby({required int state, required String token, int? timer, RoomSetLobbyApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetLobbyResponseApplicationJson, void>>
Update the lobby state for a room.
setLobbyRaw({required int state, required String token, int? timer, RoomSetLobbyApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetLobbyResponseApplicationJson, void>
Update the lobby state for a room.
setMessageExpiration({required int seconds, required String token, RoomSetMessageExpirationApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetMessageExpirationResponseApplicationJson, void>>
Update message expiration time.
setMessageExpirationRaw({required int seconds, required String token, RoomSetMessageExpirationApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetMessageExpirationResponseApplicationJson, void>
Update message expiration time.
setNotificationCalls({required int level, required String token, RoomSetNotificationCallsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetNotificationCallsResponseApplicationJson, void>>
Update call notifications.
setNotificationCallsRaw({required int level, required String token, RoomSetNotificationCallsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetNotificationCallsResponseApplicationJson, void>
Update call notifications.
setNotificationLevel({required int level, required String token, RoomSetNotificationLevelApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetNotificationLevelResponseApplicationJson, void>>
Update the notification level for a room.
setNotificationLevelRaw({required int level, required String token, RoomSetNotificationLevelApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetNotificationLevelResponseApplicationJson, void>
Update the notification level for a room.
setPassword({required String password, required String token, RoomSetPasswordApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetPasswordResponseApplicationJson, void>>
Set a password for a room.
setPasswordRaw({required String password, required String token, RoomSetPasswordApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetPasswordResponseApplicationJson, void>
Set a password for a room.
setPermissions({required RoomSetPermissionsPermissions permissions, required String token, required RoomSetPermissionsMode mode, RoomSetPermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetPermissionsResponseApplicationJson, void>>
Update the permissions of a room.
setPermissionsRaw({required RoomSetPermissionsPermissions permissions, required String token, required RoomSetPermissionsMode mode, RoomSetPermissionsApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetPermissionsResponseApplicationJson, void>
Update the permissions of a room.
setReadOnly({required RoomSetReadOnlyState state, required String token, RoomSetReadOnlyApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetReadOnlyResponseApplicationJson, void>>
Set read-only state of a room.
setReadOnlyRaw({required RoomSetReadOnlyState state, required String token, RoomSetReadOnlyApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetReadOnlyResponseApplicationJson, void>
Set read-only state of a room.
setRecordingConsent({required int recordingConsent, required String token, RoomSetRecordingConsentApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetRecordingConsentResponseApplicationJson, void>>
Set recording consent requirement for this conversation.
setRecordingConsentRaw({required int recordingConsent, required String token, RoomSetRecordingConsentApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetRecordingConsentResponseApplicationJson, void>
Set recording consent requirement for this conversation.
setSessionState({required RoomSetSessionStateState state, required String token, RoomSetSessionStateApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetSessionStateResponseApplicationJson, void>>
Set active state for a session.
setSessionStateRaw({required RoomSetSessionStateState state, required String token, RoomSetSessionStateApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetSessionStateResponseApplicationJson, void>
Set active state for a session.
setsipEnabled({required RoomSetsipEnabledState state, required String token, RoomSetsipEnabledApiVersion? apiVersion, bool? oCSAPIRequest}) → Future<DynamiteResponse<RoomSetsipEnabledResponseApplicationJson, void>>
Update SIP enabled state.
setsipEnabledRaw({required RoomSetsipEnabledState state, required String token, RoomSetsipEnabledApiVersion? apiVersion, bool? oCSAPIRequest}) → DynamiteRawResponse<RoomSetsipEnabledResponseApplicationJson, void>
Update SIP enabled state.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited