com.azure.android.communication.chat

Class ChatClient

java.lang.Object

com.azure.android.communication.chat.ChatClient

public final class ChatClient
extends java.lang.Object

Sync Client that supports chat operations.

Method Summary

Modifier and Type	Method and Description
void	addEventHandler(ChatEventType chatEventType, RealTimeNotificationCallback listener) Add handler for a chat event for realtime notifications.
void	addPushNotificationHandler(ChatEventType chatEventType, java9.util.function.Consumer<ChatEvent> listener) Add handler for a chat event for push notifications.
CreateChatThreadResult	createChatThread(CreateChatThreadOptions options) Creates a chat thread.
com.azure.android.core.rest.Response<CreateChatThreadResult>	createChatThreadWithResponse(CreateChatThreadOptions options, com.azure.android.core.util.RequestContext requestContext) Creates a chat thread.
void	deleteChatThread(java.lang.String chatThreadId) Deletes a chat thread.
com.azure.android.core.rest.Response<java.lang.Void>	deleteChatThreadWithResponse(java.lang.String chatThreadId, com.azure.android.core.util.RequestContext requestContext) Deletes a chat thread.
ChatThreadClient	getChatThreadClient(java.lang.String chatThreadId) Creates a chat thread client.
boolean	handlePushNotification(ChatPushNotification pushNotification) Handle incoming push notification.
com.azure.android.core.rest.util.paging.PagedIterable<ChatThreadItem>	listChatThreads() Gets the list of chat threads of a user.
com.azure.android.core.rest.util.paging.PagedIterable<ChatThreadItem>	listChatThreads(ListChatThreadsOptions listThreadsOptions, com.azure.android.core.util.RequestContext requestContext) Gets the list of chat threads of a user.
void	removeEventHandler(ChatEventType chatEventType, RealTimeNotificationCallback listener) Remove handler from a chat event for realtime notifications.
void	removePushNotificationHandler(ChatEventType chatEventType, java9.util.function.Consumer<ChatEvent> listener) Remove handler from a chat event for push notifications.
void	startPushNotifications(java.lang.String deviceRegistrationToken, java9.util.function.Consumer<java.lang.Throwable> errorHandler) Register current device for receiving incoming push notifications via FCM.
void	startRealtimeNotifications(android.content.Context context, java9.util.function.Consumer<java.lang.Throwable> errorHandler) Start receiving realtime notifications.
void	startRealtimeNotifications(java.lang.String skypeUserToken, android.content.Context context) Deprecated. Use startRealtimeNotifications(Context, Consumer) instead.
void	stopPushNotifications() Unregister current device from receiving incoming push notifications.
void	stopRealtimeNotifications() Stop receiving realtime notifications.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getChatThreadClient

public ChatThreadClient getChatThreadClient(java.lang.String chatThreadId)

Creates a chat thread client.

Parameters:

chatThreadId - The id of the chat thread.

Returns:

the client.

Throws:

java.lang.NullPointerException - if chatThreadId is null

createChatThread

public CreateChatThreadResult createChatThread(CreateChatThreadOptions options)

Creates a chat thread.

Parameters:

options - Options for creating a chat thread.

Returns:

the thread created.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createChatThreadWithResponse

public com.azure.android.core.rest.Response<CreateChatThreadResult> createChatThreadWithResponse(CreateChatThreadOptions options,
                                                                                                 com.azure.android.core.util.RequestContext requestContext)

Creates a chat thread.

Parameters:

options - Options for creating a chat thread.

requestContext - The context to associate with this operation.

Returns:

the response containing the thread created.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteChatThread

public void deleteChatThread(java.lang.String chatThreadId)

Deletes a chat thread.

Parameters:

chatThreadId - the id of the Chat thread to delete.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteChatThreadWithResponse

public com.azure.android.core.rest.Response<java.lang.Void> deleteChatThreadWithResponse(java.lang.String chatThreadId,
                                                                                         com.azure.android.core.util.RequestContext requestContext)

Deletes a chat thread.

Parameters:

chatThreadId - the id of the Chat thread to delete.

requestContext - The context to associate with this operation.

Returns:

the response of the delete request.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listChatThreads

public com.azure.android.core.rest.util.paging.PagedIterable<ChatThreadItem> listChatThreads()

Gets the list of chat threads of a user.

Returns:

the paged list of chat threads of a user.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listChatThreads

public com.azure.android.core.rest.util.paging.PagedIterable<ChatThreadItem> listChatThreads(ListChatThreadsOptions listThreadsOptions,
                                                                                             com.azure.android.core.util.RequestContext requestContext)

Gets the list of chat threads of a user.

Parameters:

listThreadsOptions - The request options.

requestContext - The context to associate with this operation.

Returns:

the paged list of chat threads of a user.

Throws:

ChatErrorResponseException - if the request is rejected by server.

java.lang.RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

startRealtimeNotifications

public void startRealtimeNotifications(android.content.Context context,
                                       java9.util.function.Consumer<java.lang.Throwable> errorHandler)

Start receiving realtime notifications. Until stopRealtimeNotifications() is called, realtime notifications will be enabled and the corresponding registration will auto-renew. If there's an error during registration initialization or renewal, realtime notifications will be disabled and errorHandler will be called.

Parameters:

context - the Android app context

errorHandler - error handler callback for registration failures

Throws:

java.lang.RuntimeException - if realtime notifications failed to start.

startRealtimeNotifications

@Deprecated
public void startRealtimeNotifications(java.lang.String skypeUserToken,
                                                   android.content.Context context)

Deprecated. Use startRealtimeNotifications(Context, Consumer) instead.

Start receiving realtime notifications. Until stopRealtimeNotifications() is called, realtime notifications will be enabled and the corresponding registration will auto-renew. If there's an error during registration initialization or renewal, realtime notifications will be disabled.

Parameters:

skypeUserToken - the skype user token

context - the Android app context

Throws:

java.lang.RuntimeException - if realtime notifications failed to start.

stopRealtimeNotifications

public void stopRealtimeNotifications()

Stop receiving realtime notifications. All registered handlers will be removed.

startPushNotifications

public void startPushNotifications(java.lang.String deviceRegistrationToken,
                                   java9.util.function.Consumer<java.lang.Throwable> errorHandler)

Register current device for receiving incoming push notifications via FCM. Until stopPushNotifications() is called, push notifications will be enabled and the corresponding registration will auto-renew. If there's an error during registration initialization or renewal, push notifications will be disabled and errorHandler will be called.

Parameters:

deviceRegistrationToken - Device registration token obtained from the FCM SDK.

errorHandler - error handler callback for registration failures

Throws:

java.lang.RuntimeException - if push notifications failed to start.

stopPushNotifications

public void stopPushNotifications()

Unregister current device from receiving incoming push notifications. All registered handlers will be removed.

handlePushNotification

public boolean handlePushNotification(ChatPushNotification pushNotification)

Handle incoming push notification. Invoke corresponding chat event handle if registered.

Parameters:

pushNotification - Incoming push notification payload from the FCM SDK.

Returns:

True if there's registered handler(s) for incoming push notification; otherwise, false.

Throws:

java.lang.IllegalStateException - if the push notification could not be handled.

addPushNotificationHandler

public void addPushNotificationHandler(ChatEventType chatEventType,
                                       java9.util.function.Consumer<ChatEvent> listener)

Add handler for a chat event for push notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function

Throws:

java.lang.IllegalStateException - if push notifications has not started yet.

removePushNotificationHandler

public void removePushNotificationHandler(ChatEventType chatEventType,
                                          java9.util.function.Consumer<ChatEvent> listener)

Remove handler from a chat event for push notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function

addEventHandler

public void addEventHandler(ChatEventType chatEventType,
                            RealTimeNotificationCallback listener)

Add handler for a chat event for realtime notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function

Throws:

java.lang.IllegalStateException - if realtime notifications has not started yet.

removeEventHandler

public void removeEventHandler(ChatEventType chatEventType,
                               RealTimeNotificationCallback listener)

Remove handler from a chat event for realtime notifications.

Parameters:

chatEventType - the chat event type

listener - the listener callback function