Disconnect User

ivschat_disconnect_user

R Documentation

Disconnects all connections using a specified user ID from a room¶

Description¶

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.

Usage¶

ivschat_disconnect_user(roomIdentifier, userId, reason)

Arguments¶

roomIdentifier: [required] Identifier of the room from which the user's clients should be disconnected. Currently this must be an ARN.
userId: [required] ID of the user (connection) to disconnect from the room.
reason: Reason for disconnecting the user.

Value¶

An empty list.

Request syntax¶

svc$disconnect_user(
  roomIdentifier = "string",
  userId = "string",
  reason = "string"
)