Skip to contents

Disconnects all connections using a specified user ID from a room

Source: R/ivschat_operations.R
ivschat_disconnect_user.Rd

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

See https://www.paws-r-sdk.com/docs/ivschat_disconnect_user/ for full documentation.

Usage

ivschat_disconnect_user(roomIdentifier, userId, reason = NULL)

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.