Amazon IVS Chat Messaging SDK for Android/com.amazonaws.ivs.chat.messaging

Package com.amazonaws.ivs.chat.messaging

Types

Link copied to clipboard
object ChatErrorCodes
Content copied to clipboard

Error codes returned by chat room.

Link copied to clipboard
class ChatRoom @JvmOverloads constructor(    regionOrUrl: String,     tokenProvider: (ChatTokenCallback) -> Unit,     maxReconnectAttempts: Int = 3,     val id: String = UUID.randomUUID().toString())
Content copied to clipboard

Represents IVS chat room connection.

Link copied to clipboard
interface ChatRoomListener
Content copied to clipboard

Interface for delivering chat room lifecycle events as well as received messages and events.

Link copied to clipboard
data class ChatToken(    val token: String,     val sessionExpirationTime: Date?,     val tokenExpirationTime: Date?)
Content copied to clipboard

Represents IVS chat token to be used to establish room connection. This should be fetched through your backend for security purposes from IVS Chat API.

Link copied to clipboard
interface ChatTokenCallback
Content copied to clipboard

Callback interface used to pass the result of chat token request.

Link copied to clipboard
typealias DeleteMessageCallback = RequestCallback<DeleteMessageRequest, DeleteMessageEvent>
Content copied to clipboard

Interface for reporting delete message request result.

Successful completion of the request is confirmed by receiving a delete message event with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.

Link copied to clipboard
enum DisconnectReason : Enum<DisconnectReason>
Content copied to clipboard

Reason why room transitions to disconnected state.

Link copied to clipboard
typealias DisconnectUserCallback = RequestCallback<DisconnectUserRequest, DisconnectUserEvent>
Content copied to clipboard

Interface for reporting disconnect user request result.

Successful completion of the request is confirmed by receiving a disconnect user event with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.

Link copied to clipboard
interface RequestCallback<Request, Response>
Content copied to clipboard

Generic interface for reporting user request completion or rejection by the IVS service.

Link copied to clipboard
typealias SendMessageCallback = RequestCallback<SendMessageRequest, ChatMessage>
Content copied to clipboard

Interface for reporting send message request result.

Successful completion of the request is confirmed by receiving a chat message with matching request id.

Failure of the request is confirmed by receiving a chat error with a matching request id.