Ivschat

import { Ivschat } from "https://aws-api.deno.dev/v0.4/services/ivschat.ts?docs=full";

class Ivschat {

constructor(apiFactory: client.ApiFactory);

async createChatToken(params: CreateChatTokenRequest, opts?: client.RequestOptions): Promise<CreateChatTokenResponse>;

async createLoggingConfiguration(params: CreateLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateLoggingConfigurationResponse>;

async createRoom(params?: CreateRoomRequest, opts?: client.RequestOptions): Promise<CreateRoomResponse>;

async deleteLoggingConfiguration(params: DeleteLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteMessage(params: DeleteMessageRequest, opts?: client.RequestOptions): Promise<DeleteMessageResponse>;

async deleteRoom(params: DeleteRoomRequest, opts?: client.RequestOptions): Promise<void>;

async disconnectUser(params: DisconnectUserRequest, opts?: client.RequestOptions): Promise<void>;

async getLoggingConfiguration(params: GetLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<GetLoggingConfigurationResponse>;

async getRoom(params: GetRoomRequest, opts?: client.RequestOptions): Promise<GetRoomResponse>;

async listLoggingConfigurations(params?: ListLoggingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListLoggingConfigurationsResponse>;

async listRooms(params?: ListRoomsRequest, opts?: client.RequestOptions): Promise<ListRoomsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async sendEvent(params: SendEventRequest, opts?: client.RequestOptions): Promise<SendEventResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateLoggingConfiguration(params: UpdateLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateLoggingConfigurationResponse>;

async updateRoom(params: UpdateRoomRequest, opts?: client.RequestOptions): Promise<UpdateRoomResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Ivschat(apiFactory: client.ApiFactory)

[src]

§Methods

createChatToken(params: CreateChatTokenRequest, opts?: client.RequestOptions): Promise<CreateChatTokenResponse>

[src]

Creates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response.

Use the capabilities field to permit an end user to send messages or moderate a room.

The attributes field securely attaches structured data to the chat session; the data is included within each message sent by the end user and received by other participants in the room. Common use cases for attributes include passing end-user profile data like an icon, display name, colors, badges, and other display features.

Encryption keys are owned by Amazon IVS Chat and never used directly by your application.

createLoggingConfiguration(params: CreateLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<CreateLoggingConfigurationResponse>

[src]

Creates a logging configuration that allows clients to store and record sent messages.

createRoom(params?: CreateRoomRequest, opts?: client.RequestOptions): Promise<CreateRoomResponse>

[src]

Creates a room that allows clients to connect and pass messages.

deleteLoggingConfiguration(params: DeleteLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified logging configuration.

deleteMessage(params: DeleteMessageRequest, opts?: client.RequestOptions): Promise<DeleteMessageResponse>

[src]

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

deleteRoom(params: DeleteRoomRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the specified room.

disconnectUser(params: DisconnectUserRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

getLoggingConfiguration(params: GetLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<GetLoggingConfigurationResponse>

[src]

Gets the specified logging configuration.

getRoom(params: GetRoomRequest, opts?: client.RequestOptions): Promise<GetRoomResponse>

[src]

Gets the specified room.

listLoggingConfigurations(params?: ListLoggingConfigurationsRequest, opts?: client.RequestOptions): Promise<ListLoggingConfigurationsResponse>

[src]

Gets summary information about all your logging configurations in the AWS region where the API request is processed.

listRooms(params?: ListRoomsRequest, opts?: client.RequestOptions): Promise<ListRoomsResponse>

[src]

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Gets information about AWS tags for the specified ARN.

sendEvent(params: SendEventRequest, opts?: client.RequestOptions): Promise<SendEventResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds or updates tags for the AWS resource with the specified ARN.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from the resource with the specified ARN.

updateLoggingConfiguration(params: UpdateLoggingConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateLoggingConfigurationResponse>

[src]

Updates a specified logging configuration.

updateRoom(params: UpdateRoomRequest, opts?: client.RequestOptions): Promise<UpdateRoomResponse>

[src]

Updates a room’s configuration.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]