Class SendEventCommandProtected

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

Example

Use a bare-bones client and the command you need to make an API call.

import { IvschatClient, SendEventCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, SendEventCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // SendEventRequest
  roomIdentifier: "STRING_VALUE", // required
  eventName: "STRING_VALUE", // required
  attributes: { // EventAttributes
    "<keys>": "STRING_VALUE",
  },
};
const command = new SendEventCommand(input);
const response = await client.send(command);
// { // SendEventResponse
//   id: "STRING_VALUE",
// };

Param

SendEventCommandInput

Returns

SendEventCommandOutput

See

• SendEventCommandInput for command's input shape.
• SendEventCommandOutput for command's response shape.
• config for IvschatClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

PendingVerification (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ThrottlingException (client fault)

Throws

ValidationException (client fault)

Throws

IvschatServiceException

Base exception class for all service exceptions from Ivschat service.