ivschat_disconnect_user: Disconnects all connections using a specified user ID from a...

View source: R/ivschat_operations.R

ivschat_disconnect_userR 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.

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

Usage

ivschat_disconnect_user(reason = NULL, roomIdentifier, userId)

Arguments

reason

Reason for disconnecting the user.

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.


paws.end.user.computing documentation built on Sept. 12, 2023, 1:17 a.m.