ivschat/aws.sdk.kotlin.services.ivschat

Package-level declarations

Types

IvschatClient

interface IvschatClient : SdkClient

Introduction

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createChatToken

inline suspend fun IvschatClient.createChatToken(crossinline block: CreateChatTokenRequest.Builder.() -> Unit): CreateChatTokenResponse

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.

createLoggingConfiguration

inline suspend fun IvschatClient.createLoggingConfiguration(crossinline block: CreateLoggingConfigurationRequest.Builder.() -> Unit): CreateLoggingConfigurationResponse

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

createRoom

inline suspend fun IvschatClient.createRoom(crossinline block: CreateRoomRequest.Builder.() -> Unit): CreateRoomResponse

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

deleteLoggingConfiguration

inline suspend fun IvschatClient.deleteLoggingConfiguration(crossinline block: DeleteLoggingConfigurationRequest.Builder.() -> Unit): DeleteLoggingConfigurationResponse

Deletes the specified logging configuration.

deleteMessage

inline suspend fun IvschatClient.deleteMessage(crossinline block: DeleteMessageRequest.Builder.() -> Unit): DeleteMessageResponse

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

inline suspend fun IvschatClient.deleteRoom(crossinline block: DeleteRoomRequest.Builder.() -> Unit): DeleteRoomResponse

Deletes the specified room.

disconnectUser

inline suspend fun IvschatClient.disconnectUser(crossinline block: DisconnectUserRequest.Builder.() -> Unit): DisconnectUserResponse

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

inline suspend fun IvschatClient.getLoggingConfiguration(crossinline block: GetLoggingConfigurationRequest.Builder.() -> Unit): GetLoggingConfigurationResponse

Gets the specified logging configuration.

getRoom

inline suspend fun IvschatClient.getRoom(crossinline block: GetRoomRequest.Builder.() -> Unit): GetRoomResponse

Gets the specified room.

listLoggingConfigurations

inline suspend fun IvschatClient.listLoggingConfigurations(crossinline block: ListLoggingConfigurationsRequest.Builder.() -> Unit): ListLoggingConfigurationsResponse

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

listRooms

inline suspend fun IvschatClient.listRooms(crossinline block: ListRoomsRequest.Builder.() -> Unit): ListRoomsResponse

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

inline suspend fun IvschatClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Gets information about AWS tags for the specified ARN.

sendEvent

inline suspend fun IvschatClient.sendEvent(crossinline block: SendEventRequest.Builder.() -> Unit): SendEventResponse

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

inline suspend fun IvschatClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun IvschatClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the resource with the specified ARN.

updateLoggingConfiguration

inline suspend fun IvschatClient.updateLoggingConfiguration(crossinline block: UpdateLoggingConfigurationRequest.Builder.() -> Unit): UpdateLoggingConfigurationResponse

Updates a specified logging configuration.

updateRoom

inline suspend fun IvschatClient.updateRoom(crossinline block: UpdateRoomRequest.Builder.() -> Unit): UpdateRoomResponse

Updates a room’s configuration.

withConfig

fun IvschatClient.withConfig(block: IvschatClient.Config.Builder.() -> Unit): IvschatClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.