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

AxpMessaging

object AxpMessaging

Facade for the AXP Messaging module.

Properties

eventFlow

val eventFlow: StateFlow<MessagingStreamState>

idleTimeoutFlow

val idleTimeoutFlow: Flow<IdleTimeout>

A Flow that emits IdleTimeout objects when an idle timeout event occurs.

Functions

addIdleTimeOutInvokedListener

fun addIdleTimeOutInvokedListener(listener: IdleTimeoutCallbackListener): Boolean

Adds a listener for idle timeout events. This is useful for monitoring when the user session becomes idle. This is an alternative to using the idleTimeoutFlow for developers who prefer callback-based APIs over Kotlin's Flow API.

getNotificationData

suspend fun getNotificationData(notificationPayload: NotificationPayload): AxpResult<out List<NotificationResult>>

This function is a suspending function that fetches notification data.

fun getNotificationData(notificationPayload: NotificationPayload, responseHandler: ResponseHandler<List<NotificationResult>>)

Fetches notification data asynchronously.

reconnect

suspend fun reconnect()

This function is used to reconnect the session to fetch latest events.

removeIdleTimeOutInvokedListener

fun removeIdleTimeOutInvokedListener(listener: IdleTimeoutCallbackListener): Boolean

Removes a listener for idle timeout events.

resetIdleTimeout

fun resetIdleTimeout()

Reset the idleTimeout to indicate the SDK that the user session is still active. The SDK already resets the timeout when it receives a request to sendMessage. Invoke this method only when client want to indicate a user's activity visible only to the client (apart from the above mentioned activity)