com.quickblox.chat

Class QBRestChatService

java.lang.Object

com.quickblox.auth.session.BaseService

com.quickblox.chat.QBRestChatService

public class QBRestChatService
extends BaseService

QBRestChatService used for perform REST queries associated with chat

Since:

3.0

Method Summary

Modifier and Type	Method and Description
static Performer<java.lang.Boolean>	checkIsDialogNotificationEnabled(java.lang.String dialogId) Checks if Push Notification enabled for offline messages in dialog.
static Performer<QBChatDialog>	createChatDialog(QBChatDialog dialog) Creates the chat dialog.
static Performer<QBChatMessage>	createMessage(QBChatMessage message, boolean sendToDialog) Create the message
static Performer<java.lang.Void>	deleteDialog(java.lang.String dialogID, boolean forceDelete) Delete the dialog.
static Performer<java.util.ArrayList<java.lang.String>>	deleteDialogs(<any> dialogIDs, boolean forceDelete, Bundle bundle) Delete the dialog.
static Performer<java.lang.Void>	deleteMessage(java.lang.String messageId, boolean forceDelete) Delete the chat message.
static Performer<java.lang.Void>	deleteMessages(java.util.Set<java.lang.String> messageIDs, boolean forceDelete) Delete list of messages.
static Performer<QBChatDialog>	getChatDialogById(java.lang.String dialogId) Retrieves chat dialog by dialog ID.
static Performer<java.util.ArrayList<QBChatDialog>>	getChatDialogs(QBDialogType type, QBRequestGetBuilder requestBuilder) Retrieves chat dialogs associated with the current currentUser.
static Performer<java.lang.Integer>	getChatDialogsCount(QBRequestGetBuilder requestBuilder, Bundle returnedBundle) Retrieves amount of chat dialogs.
static Performer<java.util.ArrayList<QBChatMessage>>	getDialogMessages(QBChatDialog dialog, QBRequestGetBuilder requestBuilder) Retrieves chat messages associated with a dialog.
static Performer<java.lang.Integer>	getDialogMessagesCount(java.lang.String dialogID) Retrieves chat messages count associated with a dialog.
static Performer<java.lang.Integer>	getDialogMessagesCount(java.lang.String dialogID, QBRequestGetBuilder requestGetBuilder) Retrieves chat messages count associated with a dialog.
static Performer<java.lang.Integer>	getTotalUnreadMessagesCount(java.util.Set<java.lang.String> dialogIDs, Bundle returnedBundle) Retrieves total chat messages count.
static Performer<java.lang.Void>	markMessagesAsRead(java.lang.String dialogId, <any> messageIds) Mark chat messages as read.
static Performer<QBChatDialog>	updateChatDialog(QBChatDialog dialog, QBRequestUpdateBuilder requestBuilder) Updates the chat dialog.
static Performer<java.lang.Boolean>	updateDialogNotificationSending(java.lang.String dialogId, boolean sendingNotificationEnable) Disables or Enables Push Notification for offline messages in dialog.
static Performer<QBChatDialog>	updateGroupChatDialog(QBChatDialog dialog, QBRequestUpdateBuilder requestBuilder) Deprecated. since 3.8.0, use updateChatDialog(QBChatDialog, QBRequestUpdateBuilder) instead of
static Performer<java.lang.Void>	updateMessage(java.lang.String messageId, java.lang.String dialogId, QBMessageUpdateBuilder messageUpdateBuilder) Update message.

Methods inherited from class com.quickblox.auth.session.BaseService

createBaseService, createFromExistentToken, getBaseService, getToken, getTokenExpirationDate, resetCredentials, setToken, setTokenExpirationDate

Methods inherited from class java.lang.Object

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

Method Detail

createChatDialog

public static Performer<QBChatDialog> createChatDialog(QBChatDialog dialog)

Creates the chat dialog. For creating new QBDialog with parameters you can use DialogUtils.buildDialog(String, QBDialogType, List) For creating new private QBDialog with occupant you can use DialogUtils.buildPrivateDialog(int) For creating new QBDialog with type according to number of users you can use DialogUtils.buildDialog(QBUser...)

Parameters:

dialog - The dialog entity to create.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getChatDialogById

public static Performer<QBChatDialog> getChatDialogById(java.lang.String dialogId)

Retrieves chat dialog by dialog ID.

Parameters:

dialogId - The dialog's ID for getting

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

See Also:

QBRequestGetBuilder

getChatDialogs

public static Performer<java.util.ArrayList<QBChatDialog>> getChatDialogs(QBDialogType type,
                                                                          QBRequestGetBuilder requestBuilder)

Retrieves chat dialogs associated with the current currentUser.

Parameters:

type - The type of a dialog to retrieve. Pass null to retrieve all types.

requestBuilder - The builder to set of additional search parameters

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

See Also:

QBRequestGetBuilder

getChatDialogsCount

public static Performer<java.lang.Integer> getChatDialogsCount(QBRequestGetBuilder requestBuilder,
                                                               Bundle returnedBundle)

Retrieves amount of chat dialogs.

Parameters:

requestBuilder - The builder to set of additional search parameters

returnedBundle - The bundle with response additional information.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

See Also:

QBRequestGetBuilder

updateGroupChatDialog

@Deprecated
public static Performer<QBChatDialog> updateGroupChatDialog(QBChatDialog dialog,
                                                                        QBRequestUpdateBuilder requestBuilder)

Deprecated. since 3.8.0, use updateChatDialog(QBChatDialog, QBRequestUpdateBuilder) instead of

Updates the group chat dialog.

Only dialog's owner can update dialogs with type QBDialogType.PUBLIC_GROUP.

Parameters:

dialog - The dialog entity to update.

requestBuilder - The additional update parameters.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateChatDialog

public static Performer<QBChatDialog> updateChatDialog(QBChatDialog dialog,
                                                       QBRequestUpdateBuilder requestBuilder)

Updates the chat dialog.

Only dialog's owner can update dialogs with type QBDialogType.PUBLIC_GROUP. For QBDialogType.PRIVATE possible for update only custom data field.

Parameters:

dialog - The dialog entity to update.

requestBuilder - The additional update parameters.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.8.0

deleteDialogs

public static Performer<java.util.ArrayList<java.lang.String>> deleteDialogs(<any> dialogIDs,
                                                                             boolean forceDelete,
                                                                             Bundle bundle)

Delete the dialog.

Parameters:

dialogIDs - Array list of IDs of dialogs to be removed.

forceDelete - Whether completely remove dialogs. Only dialog's owner can completely remove the dialog.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

deleteDialog

public static Performer<java.lang.Void> deleteDialog(java.lang.String dialogID,
                                                     boolean forceDelete)

Delete the dialog.

Parameters:

dialogID - The dialog ID to delete.

forceDelete - Whether completely remove a dialog. Only dialog's owner can completely remove the dialog.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateDialogNotificationSending

public static Performer<java.lang.Boolean> updateDialogNotificationSending(java.lang.String dialogId,
                                                                           boolean sendingNotificationEnable)

Disables or Enables Push Notification for offline messages in dialog. By default when a user is offline and other user sent a message to him then he will receive a push notification. It is possible to disable this feature. Set sendingNotificationEnable=false to disable sending Push Notification for offline messages or set sendingNotificationEnable=true to enable sending Push Notification for offline messages

Parameters:

dialogId - dialog's id for changing settings

sendingNotificationEnable - true - enables notifications, false - disables notifications

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.8.0

checkIsDialogNotificationEnabled

public static Performer<java.lang.Boolean> checkIsDialogNotificationEnabled(java.lang.String dialogId)

Checks if Push Notification enabled for offline messages in dialog.

Parameters:

dialogId - dialog's id for check

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.8.0

createMessage

public static Performer<QBChatMessage> createMessage(QBChatMessage message,
                                                     boolean sendToDialog)

Create the message

Parameters:

message - The message to create.

sendToDialog - Sends a message to chat or just create it.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getDialogMessages

public static Performer<java.util.ArrayList<QBChatMessage>> getDialogMessages(QBChatDialog dialog,
                                                                              QBRequestGetBuilder requestBuilder)

Retrieves chat messages associated with a dialog. All retrieved chat messages will be marked as read after this request.

Parameters:

dialog - The dialog which chat messages history you would like to retrieve. The QBDialog entity has to contain filled dialogId field.

requestBuilder - The builder to set additional search parameters

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

See Also:

QBRequestGetBuilder

getDialogMessagesCount

public static Performer<java.lang.Integer> getDialogMessagesCount(java.lang.String dialogID)

Retrieves chat messages count associated with a dialog.

Parameters:

dialogID - The dialog ID which chat messages you would like to count.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

getDialogMessagesCount

public static Performer<java.lang.Integer> getDialogMessagesCount(java.lang.String dialogID,
                                                                  QBRequestGetBuilder requestGetBuilder)

Retrieves chat messages count associated with a dialog.

Parameters:

dialogID - The dialog ID which chat messages you would like to count.

requestGetBuilder - The builder to set additional search parameters.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.5.1

getTotalUnreadMessagesCount

public static Performer<java.lang.Integer> getTotalUnreadMessagesCount(java.util.Set<java.lang.String> dialogIDs,
                                                                       Bundle returnedBundle)

Retrieves total chat messages count.

Parameters:

dialogIDs - Array of dialogs ids to get a count of unread messages for. You also can omit this parameter to receive just a total count of all unread messages

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

markMessagesAsRead

public static Performer<java.lang.Void> markMessagesAsRead(java.lang.String dialogId,
                                                           <any> messageIds)

Mark chat messages as read.

Parameters:

dialogId - The dialog ID which chat messages you would like to mark as read.

messageIds - The array of messages IDs to mark as read.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

updateMessage

public static Performer<java.lang.Void> updateMessage(java.lang.String messageId,
                                                      java.lang.String dialogId,
                                                      QBMessageUpdateBuilder messageUpdateBuilder)

Update message.

Parameters:

messageId - message ID to update.

messageUpdateBuilder - builder to perform updating operations.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

See Also:

QBMessageUpdateBuilder

deleteMessage

public static Performer<java.lang.Void> deleteMessage(java.lang.String messageId,
                                                      boolean forceDelete)

Delete the chat message.

Parameters:

messageId - The message ID to delete.

forceDelete - Flag for completely remove a message by owner. Set true if you want completely remove your own message.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0

deleteMessages

public static Performer<java.lang.Void> deleteMessages(java.util.Set<java.lang.String> messageIDs,
                                                       boolean forceDelete)

Delete list of messages.

Parameters:

messageIDs - The set of messages IDs to delete.

forceDelete - Flag for completely remove a messages by owner. Set true if you want completely remove your own messages.

Returns:

An instance of Performer interface which can perform request synchronously or asynchronously.

Since:

3.0