Skip to content

Updates a room’s configuration

Description

Updates a room’s configuration.

Usage

ivschat_update_room(identifier, name, maximumMessageRatePerSecond,
  maximumMessageLength, messageReviewHandler,
  loggingConfigurationIdentifiers)

Arguments

  • identifier

    [required] Identifier of the room to be updated. Currently this must be an ARN.

  • name

    Room name. The value does not need to be unique.

  • maximumMessageRatePerSecond

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • maximumMessageLength

    The maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • messageReviewHandler

    Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

  • loggingConfigurationIdentifiers

    Array of logging-configuration identifiers attached to the room.

Value

A list with the following syntax:

list(
  arn = "string",
  id = "string",
  name = "string",
  createTime = as.POSIXct(
    "2015-01-01"
  ),
  updateTime = as.POSIXct(
    "2015-01-01"
  ),
  maximumMessageRatePerSecond = 123,
  maximumMessageLength = 123,
  messageReviewHandler = list(
    uri = "string",
    fallbackResult = "ALLOW"|"DENY"
  ),
  tags = list(
    "string"
  ),
  loggingConfigurationIdentifiers = list(
    "string"
  )
)

Request syntax

svc$update_room(
  identifier = "string",
  name = "string",
  maximumMessageRatePerSecond = 123,
  maximumMessageLength = 123,
  messageReviewHandler = list(
    uri = "string",
    fallbackResult = "ALLOW"|"DENY"
  ),
  loggingConfigurationIdentifiers = list(
    "string"
  )
)