AXP Messaging/com.avaya.axp.omni.sdk.messaging

Package-level declarations

Types

Action

interface Action

Attachment

interface Attachment

AttachmentMessage

data class AttachmentMessage(val file: File, val captionText: String? = null) : AttachmentMessageBody

Represents an attachment message.

AxpMessaging

object AxpMessaging

Facade for the AXP Messaging module.

ElementText

interface ElementText

The text of the message body

ElementType

enum ElementType : Enum<ElementType>

EventState

enum EventState : Enum<EventState>

Enumerates the possible states of a messaging stream event.

IdleTimeout

data class IdleTimeout(val date: OffsetDateTime, val gracePeriod: Int)

IdleTimeoutCallbackListener

typealias IdleTimeoutCallbackListener = FieldChangedListener<IdleTimeout>

IllegalMessageBodyException

class IllegalMessageBodyException(val code: MessageBodyErrorCode, message: String) : IllegalArgumentException

represent illegal or appropriate message body arguments

Item

interface Item

LocationCoordinates

interface LocationCoordinates

LocationDetails

interface LocationDetails

LocationMessage

data class LocationMessage(val lat: Double, val long: Double, val address: String? = null, val name: String? = null) : MessageBody

Represents a location message.

Message

interface Message

Represents a message in a conversation.

MessageBody

sealed interface MessageBody

Definition of the body element such as the type of element, the message text and format

MessageBodyErrorCode

enum MessageBodyErrorCode : Enum<MessageBodyErrorCode>

MessagingStreamState

data class MessagingStreamState(val state: EventState, val reason: String? = null, val updatedAt: OffsetDateTime = OffsetDateTime.now())

Represents the state of a messaging stream.

NotificationPayload

data class NotificationPayload(val eventDate: OffsetDateTime, val eventId: String, val conversationId: ConversationId, val sessionId: SessionId)

Data class representing the payload of a notification from Notification Server.

NotificationResult

data class NotificationResult(val eventDate: OffsetDateTime?, val participant: Participant?, val message: Message?, val type: NotificationType)

Data class representing the result of a push notification.

NotificationType

enum NotificationType : Enum<NotificationType>

Enum representing the type of a notification.

PostbackMessage

data class PostbackMessage(val text: String, val payload: String) : MessageBody

Represents a postback message.

ReplyMessage

data class ReplyMessage(val text: String, val payload: String, val iconUrl: URI? = null) : MessageBody

Represents a reply message.

RichMediaPayload

interface RichMediaPayload

TextType

enum TextType : Enum<TextType>

TypingStartedListener

typealias TypingStartedListener = FieldChangedListener<Participant>

TypingStoppedListener

typealias TypingStoppedListener = FieldChangedListener<Participant>

UploadedAttachment

data class UploadedAttachment(val attachmentId: String, val name: String, val type: String, val size: Long)

Properties

messageArrivedFlow

val Conversation.messageArrivedFlow: SharedFlow<Message>

A SharedFlow that emits Message objects when a new message arrives from the server.

messageDeliveredFlow

val Conversation.messageDeliveredFlow: SharedFlow<Message>

A SharedFlow that emits Message objects when a message is delivered on the server.

typingParticipantsFlow

val Conversation.typingParticipantsFlow: StateFlow<Set<Participant>>

A StateFlow that emits the set of Participants who are currently typing in the conversation.

Functions

addMessageArrivedListener

fun Conversation.addMessageArrivedListener(listener: MessageChangedListener)

Adds a listener for new messages arriving from the server.

addMessageDeliveredListener

fun Conversation.addMessageDeliveredListener(listener: MessageChangedListener)

Adds a listener for messages being successfully delivered to the server.

addTypingStartedListener

fun Conversation.addTypingStartedListener(listener: TypingStartedListener)

Adds a listener for typing started events.

addTypingStoppedListener

fun Conversation.addTypingStoppedListener(listener: TypingStoppedListener)

Adds a listener for typing stopped events.

getMessages

suspend fun Conversation.getMessages(pageSize: Int = 10): AxpResult<out PageIterator<Message>>

Retrieves messages in the chat session.

fun Conversation.getMessages(pageSize: Int = 10, responseHandler: ResponseHandler<PageIterator<Message>>)

Retrieves messages in the chat session asynchronously with a response handler.

notifyUserTyping

fun Conversation.notifyUserTyping()

Notify the server that the local user is typing.

removeMessageArrivedListener

fun Conversation.removeMessageArrivedListener(listener: MessageChangedListener)

Removes a listener for new messages arriving from the server.

removeMessageDeliveredListener

fun Conversation.removeMessageDeliveredListener(listener: MessageChangedListener)

Removes a listener for messages being successfully delivered to the server.

removeTypingStartedListener

fun Conversation.removeTypingStartedListener(listener: TypingStartedListener)

Removes a listener for typing started events.

removeTypingStoppedListener

fun Conversation.removeTypingStoppedListener(listener: TypingStoppedListener)

Removes a listener for typing stopped events.

sendMessage

suspend fun Conversation.sendMessage(message: MessageBody, parentMessageId: MessageId? = null): AxpResult<Message>

Sends a message in the conversation.

suspend fun Conversation.sendMessage(message: String, parentMessageId: MessageId? = null): AxpResult<Message>

Sends a message in the session.

fun Conversation.sendMessage(message: MessageBody, responseHandler: ResponseHandler<Message>, parentMessageId: MessageId? = null)

Sends a message in the conversation asynchronously.

fun Conversation.sendMessage(message: String, parentMessageId: MessageId? = null, responseHandler: ResponseHandler<Message>)

Sends a message in the session asynchronously with a response handler.