undefined

Messaging

ConnectyCube Chat (messaging) API is built on top of Real-time(XMPP) protocol. In order to use it you need to setup real-time connection with ConnectyCube Chat server and use it to exchange data.

By default Real-time Chat works over secure TLS connection.

Get started with SDK

Follow the Getting Started guide on how to connect ConnectyCube SDK and start building your first app.

Code samples

There are ready-to-go FREE code samples to help you better understand how to integrate messaging capabilities in your apps:

Connect to chat

// Provide chat connection configuration
ConnectycubeChatService.ConfigurationBuilder chatServiceConfigurationBuilder = new ConnectycubeChatService.ConfigurationBuilder();
chatServiceConfigurationBuilder.setSocketTimeout(60);
chatServiceConfigurationBuilder.setKeepAlive(true);
chatServiceConfigurationBuilder.setUseTls(true); //By default TLS is disabled.
ConnectycubeChatService.setConfigurationBuilder(chatServiceConfigurationBuilder);

ConnectycubeChatService chatService = ConnectycubeChatService.getInstance();

final ConnectycubeUser user = new ConnectycubeUser();
user.setId(21);
user.setPassword("supersecurepwd");

chatService.login(user, new EntityCallback() {
    @Override
    public void onSuccess() {

    }

    @Override
    public void onError(ResponseException errors) {

    }
});
// Provide chat connection configuration
val chatServiceConfigurationBuilder = ConfigurationBuilder().apply {
    socketTimeout = 60
    isKeepAlive = true
    isUseTls = true //By default TLS is disabled.
}

ConnectycubeChatService.setConnectionFabric(TcpChatConnectionFabric(chatServiceConfigurationBuilder))

val chatService = ConnectycubeChatService.getInstance()

val user = ConnectycubeUser().apply {
    id = 21
    password = "supersecurepwd"
}

chatService.login(user, object : EntityCallback<Void?> {
    override fun onError(error: ResponseException) {

    }

    override fun onSuccess(result: Void?, args: Bundle) {

    }
})

Use ConnectionListener to handle different connection states:

ConnectionListener connectionListener = new ConnectionListener() {
    @Override
    public void connected(XMPPConnection connection) {

    }

    @Override
    public void authenticated(XMPPConnection connection) {

    }

    @Override
    public void connectionClosed() {

    }

    @Override
    public void connectionClosedOnError(Exception e) {

    }

    @Override
    public void reconnectingIn(int seconds) {

    }

    @Override
    public void reconnectionSuccessful() {

    }

    @Override
    public void reconnectionFailed(Exception e) {

    }
};

ConnectycubeChatService.getInstance().addConnectionListener(connectionListener);
val connectionListener: ConnectionListener = object : ConnectionListener {
    override fun connected(connection: XMPPConnection) {

    }

    override fun connectionClosed() {

    }

    override fun connectionClosedOnError(e: Exception) {

    }

    override fun reconnectingIn(seconds: Int) {

    }

    override fun reconnectionSuccessful() {

    }

    override fun authenticated(connection: XMPPConnection, resumed: Boolean) {

    }

    override fun reconnectionFailed(e: Exception) {

    }
}

ConnectycubeChatService.getInstance().addConnectionListener(connectionListener)

Connect to chat using custom authentication providers

In some cases we don't have a user's password, for example when login via:

  • Facebook
  • Twitter
  • Firebase phone authorization
  • Custom identity authentication
  • etc.

In such cases ConnectyCube API provides possibility to use ConnectyCube session token as a password for chat connection:

// get current ConnectyCube session token and set as user's password
String token = ConnectycubeSessionManager.getInstance().getToken();

final ConnectycubeUser user = new ConnectycubeUser();
user.setId(21);
user.setPassword(token);
// get current ConnectyCube session token and set as user's password
val token = ConnectycubeSessionManager.getInstance().token

val user = ConnectycubeUser().apply {
    id = 21
    password = token
}

Disconnect

To logout from chat connection use method chatService.logout:

boolean isLoggedIn = chatService.isLoggedIn();
if(!isLoggedIn){
    return;
}

chatService.logout(new EntityCallback() {
    @Override
    public void onSuccess() {

    }

    @Override
    public void onError(ResponseException errors) {

    }
});
val isLoggedIn = chatService.isLoggedIn
if (!isLoggedIn) {
    return
}

chatService.logout(object : EntityCallback<Void?> {
    override fun onError(error: ResponseException) {

    }

    override fun onSuccess(result: Void?, args: Bundle) {

    }
})

To fully destroy chat connection use chatService.destroy:

chatService.destroy();
chatService.destroy()

Reconnection

The SDK reconnects automatically when connection to Chat server is lost.

There is a way to disable it and then manage it manually:

ConnectycubeChatService.getInstance().setReconnectionAllowed(false);
ConnectycubeChatService.getInstance().isReconnectionAllowed = false

Dialogs

All chats between users are organized in dialogs. The are 3 types of dialogs:

  • 1-1 chat - a conversation between 2 users.
  • group chat - a conversation between specified list of users.
  • public chat - an open conversation. Any user from your app can subscribe to it.

You need to create a new dialog and then use it to chat with other users. You also can obtain a list of your existing dialogs.

Create new dialog

Create 1-1 chat

You need to pass ConnectycubeDialogType.PRIVATE as a type and an id of an opponent you want to create a chat with:

ArrayList<Integer> occupantIds = new ArrayList<Integer>();
occupantIds.add(34);

ConnectycubeChatDialog dialog = new ConnectycubeChatDialog();
dialog.setType(ConnectycubeDialogType.PRIVATE);
dialog.setOccupantsIds(occupantIds);

//or just use DialogUtils
//ConnectycubeChatDialog dialog = DialogUtils.buildPrivateDialog(recipientId);

ConnectycubeRestChatService.createChatDialog(dialog).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog createdDialog, Bundle params) {

    }

    @Override
    public void onError(ResponseException exception) {

    }
});
val occupantIds = ArrayList<Int>().apply {
    add(34)
}

val dialog = ConnectycubeChatDialog().apply {
    type = ConnectycubeDialogType.PRIVATE
    setOccupantsIds(occupantIds)
}

// or just use DialogUtils
// val dialog = DialogUtils.buildPrivateDialog(34)

ConnectycubeRestChatService.createChatDialog(dialog)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(createdDialog: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(exception: ResponseException) {

        }
    })

Create group chat

You need to pass ConnectycubeDialogType.GROUP as a type and ids of opponents you want to create a chat with:

ArrayList<Integer> occupantIds = new ArrayList<Integer>();
occupantIds.add(34);
occupantIds.add(35);
occupantIds.add(36);

ConnectycubeChatDialog dialog = new ConnectycubeChatDialog();
dialog.setType(ConnectycubeDialogType.GROUP);
dialog.setOccupantsIds(occupantIds);
dialog.setName("Hawaii party");
//dialog.setPhoto("...");
//dialog.setDescription("...");

//or just use DialogUtils
//ConnectycubeChatDialog dialog = DialogUtils.buildDialog("Hawaii party", ConnectycubeDialogType.GROUP, occupantIds);

ConnectycubeRestChatService.createChatDialog(dialog).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog createdDialog, Bundle params) {

    }

    @Override
    public void onError(ResponseException exception) {

    }
});
val occupantIds = ArrayList<Int>().apply {
    add(34)
    add(35)
    add(36)
}

val dialog = ConnectycubeChatDialog().apply {
    type = ConnectycubeDialogType.GROUP
    name = "Hawaii party"
//  photo = "..."
//  description = "..."
    setOccupantsIds(occupantIds)
}

//or just use DialogUtils
//val dialog = DialogUtils.buildDialog("Hawaii party", ConnectycubeDialogType.GROUP, occupantIds).apply {
//    photo = "..."
//    description = "..."
//}

ConnectycubeRestChatService.createChatDialog(dialog)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(createdDialog: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(exception: ResponseException) {

        }
    })

Create public chat

It's possible to create a public chat, so any user from your application can subscribe to it. You need to pass ConnectycubeDialogType.PUBLIC as a type to create a chat with:

ConnectycubeChatDialog dialog = new ConnectycubeChatDialog();
dialog.setType(ConnectycubeDialogType.PUBLIC);
dialog.setName("Blockchain trends");
//dialog.setPhoto("...");
//dialog.setDescription("...");

ConnectycubeRestChatService.createChatDialog(dialog).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog createdDialog, Bundle params) {

    }

    @Override
    public void onError(ResponseException exception) {

    }
});
val dialog = ConnectycubeChatDialog().apply {
    type = ConnectycubeDialogType.PUBLIC
    name = "Blockchain trends"
//  photo = "..."
//  description = "..."
}

ConnectycubeRestChatService.createChatDialog(dialog)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(createdDialog: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(exception: ResponseException) {

        }
    })

With public dialog ID any a user can subscribe to the public dialog via the following code:

ConnectycubeRestChatService.subscribePublicDialog(dialogID).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog dialog, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
ConnectycubeRestChatService.subscribePublicDialog(dialogID)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(dialog: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

After dialog subscription, this dialog will be listed in retrieve dialogs request and you also will be able to chat in it.

You also can unsubscribe if you do not want to be in this public dialog anymore:

ConnectycubeRestChatService.unsubscribePublicDialog(dialogID).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
ConnectycubeRestChatService.unsubscribePublicDialog(dialogID)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(result: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

Retrieve list of dialogs

It's common to request all your conversations on every app login:

RequestGetBuilder requestBuilder = new RequestGetBuilder();
requestBuilder.setLimit(50);
requestBuilder.setSkip(100);
//requestBuilder.sortAsc(Consts.DIALOG_LAST_MESSAGE_DATE_SENT_FIELD_NAME);

ConnectycubeRestChatService.getChatDialogs((ConnectycubeDialogType)null, requestBuilder).performAsync(new EntityCallback<ArrayList<ConnectycubeChatDialog>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeChatDialog> dialogs, Bundle params) {
        int totalEntries = params.getInt(Consts.TOTAL_ENTRIES);
    }

    @Override
    public void onError(ResponseException exception) {

    }
});
val requestBuilder = RequestGetBuilder().apply {
    limit = 50
    skip = 100
//  sortAsc(Consts.DIALOG_LAST_MESSAGE_DATE_SENT_FIELD_NAME)
}

ConnectycubeRestChatService.getChatDialogs(null as ConnectycubeDialogType, requestBuilder)
    .performAsync(object : EntityCallback<ArrayList<ConnectycubeChatDialog>> {
        override fun onSuccess(dialogs: ArrayList<ConnectycubeChatDialog>, params: Bundle) {
            val totalEntries = params.getInt(Consts.TOTAL_ENTRIES)
        }

        override fun onError(exception: ResponseException) {

        }
    })

It will return all your 1-1 dialogs, group dialog and also public dialogs your are subscribed to.

If you want to retrieve only conversations updated after some specific date time, you can use requestBuilder.gt("updated_at", "1455098137"); filter. This is useful if you cache conversations somehow and do not want to obtain the whole list of your conversations on every app start.

Update dialog’s name, description, photo

User can update group chat name, description, photo:

ConnectycubeChatDialog dialog = new ConnectycubeChatDialog();
dialog.setDialogId("5356c64ab35c12bd3b108a41");
dialog.setName("Hawaii party");
dialog.setPhoto("https://new_photo_url"); // or it can be an ID to some file in Storage module
dialog.setDescription("New dialog description");

ConnectycubeRestChatService.updateChatDialog(dialog, null).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog updatedDialog, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});
val dialog = ConnectycubeChatDialog().apply {
    dialogId = "5356c64ab35c12bd3b108a41"
    name = "Hawaii party"
    photo = "https://new_photo_url" // or it can be an ID to some file in Storage module
    description = "New dialog description"
}    

ConnectycubeRestChatService.updateChatDialog(dialog, null)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(updatedDialog: ConnectycubeChatDialog, bundle: Bundle) {

        }

        override fun onError(error: ResponseException) {

        }
    })

Add/Remove occupants

You can add/remove occupants in group and public dialogs:

DialogRequestBuilder requestBuilder = new DialogRequestBuilder();
requestBuilder.addUsers(378);
// requestBuilder.removeUsers(22);

ConnectycubeChatDialog dialog = new ConnectycubeChatDialog();
dialog.setDialogId("5356c64ab35c12bd3b108a41");

ConnectycubeRestChatService.updateChatDialog(dialog, requestBuilder).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog updatedDialog, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});
val requestBuilder = DialogRequestBuilder().apply {
    addUsers(378)
//  removeUsers(22)
}

val dialog = ConnectycubeChatDialog("5356c64ab35c12bd3b108a41")

ConnectycubeRestChatService.updateChatDialog(dialog, requestBuilder)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(updatedDialog: ConnectycubeChatDialog, bundle: Bundle) {

        }

        override fun onError(error: ResponseException) {

        }
    })

Important note: Only group chat owner and admins can remove other users from group chat.

Add/Remove admins

Admins it's a special role in chats. They have the same permissions as a dialog's creator except add/remove other admins and remove dialog.

Owner of the group chat dialog can add admins:

DialogRequestBuilder updateBuilder = new DialogRequestBuilder();
updateBuilder.addAdminsIds(17616, 17617);
ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
val updateBuilder = DialogRequestBuilder().apply {
    addAdminsIds(17616, 17617)
}

ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(result: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

and remove:

DialogRequestBuilder updateBuilder = new DialogRequestBuilder();
updateBuilder.removeAdminsIds(17616, 17617);
ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
val updateBuilder = DialogRequestBuilder().apply {
    removeAdminsIds(17616, 17617)
}

ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(result: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

Pin messages

Pinning a message allows group owner or chat admins to easily store messages which are important, so that all users in chat have a quick access to them. The following code pins some messages to a particular group dialog:

DialogRequestBuilder updateBuilder = new DialogRequestBuilder();
updateBuilder.addPinnedMessagesIds("5356c64ab35c12bd3b10ba32", "5356c64ab35c12bd3b10wa65");
//updateBuilder.removePinnedMessagesIds("5356c64ab35c12bd3b10ba32", "5356c64ab35c12bd3b10wa65");
ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder).performAsync(new EntityCallback<ConnectycubeChatDialog>() {
    @Override
    public void onSuccess(ConnectycubeChatDialog result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
val updateBuilder = DialogRequestBuilder().apply {
    addPinnedMessagesIds(
        "5356c64ab35c12bd3b10ba32",
        "5356c64ab35c12bd3b10wa65"
    )
//    removePinnedMessagesIds(
//        "5356c64ab35c12bd3b10ba32",
//        "5356c64ab35c12bd3b10wa65"
//    )
}

ConnectycubeRestChatService.updateChatDialog(groupDialog, updateBuilder)
    .performAsync(object : EntityCallback<ConnectycubeChatDialog> {
        override fun onSuccess(result: ConnectycubeChatDialog, params: Bundle) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

Remove dialog

The following snippet is used to delete a conversation:

String dialogId = "5356c64ab35c12bd3b108a41";
boolean forceDelete = false;

ConnectycubeRestChatService.deleteDialog(dialogId, forceDelete).performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void aVoid, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});
val dialogId = "5356c64ab35c12bd3b108a41"
val forceDelete = false

ConnectycubeRestChatService.deleteDialog(dialogId, forceDelete)
    .performAsync(object : EntityCallback<Void?> {
        override fun onSuccess(aVoid: Void?, bundle: Bundle) {

        }

        override fun onError(error: ResponseException) {

        }
    })

This request will remove this conversation for current user, but other users still will be able to chat there. The forceDelete parameter is used to completely remove the dialog. Only group chat owner can remove the group conversation for all users.

You can also delete multiple conversations in a single request.

Chat history

Every chat conversation stores its chat history which you can retrieve:

ConnectycubeChatDialog chatDialog = new ConnectycubeChatDialog("5356c64ab35c12bd3b108a41");

MessageGetBuilder messageGetBuilder = new MessageGetBuilder();
messageGetBuilder.setLimit(100);
// messageGetBuilder.gt("date_sent", "1455098137");

ConnectycubeRestChatService.getDialogMessages(chatDialog, messageGetBuilder).performAsync(new EntityCallback<ArrayList<ConnectycubeChatMessage>>() {
    @Override
    public void onSuccess(ArrayList<ConnectycubeChatMessage> messages, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException error) {

    }
});
val chatDialog = ConnectycubeChatDialog("5356c64ab35c12bd3b108a41")

val messageGetBuilder = MessageGetBuilder().apply {
    limit = 100
//  gt(Consts.MESSAGE_DATE_SENT, "1455098137")
}

ConnectycubeRestChatService.getDialogMessages(chatDialog, messageGetBuilder)
    .performAsync(object : EntityCallback<ArrayList<ConnectycubeChatMessage>> {
        override fun onSuccess(messages: ArrayList<ConnectycubeChatMessage>, bundle: Bundle) {

        }

        override fun onError(error: ResponseException) {

        }
    })

If you want to retrieve chat messages that were sent after or before specific date time only, you can use messageGetBuilder.gt("date_sent", "1455098137") or messageGetBuilder.lt("date_sent", "1455098137") filter. This is useful if you implement pagination for loading messages in your app.

Important note: All retrieved chat messages will be marked as read after the request. If you decided not to mark chat messages as read, then add the following parameter to your request: messageGetBuilder.markAsRead(false);

Send/Receive chat messages

Receive messages

There is IncomingMessagesManager to listen for all incoming messages from all dialogs.

IncomingMessagesManager incomingMessagesManager = chatService.getIncomingMessagesManager();

incomingMessagesManager.addDialogMessageListener(new ChatDialogMessageListener() {
    @Override
    public void processMessage(String dialogId, ConnectycubeChatMessage message, Integer senderId) {

    }

    @Override
    public void processError(String dialogId, ChatException exception, ConnectycubeChatMessage message, Integer senderId) {

    }
});
val incomingMessagesManager = chatService.incomingMessagesManager

incomingMessagesManager.addDialogMessageListener(object : ChatDialogMessageListener {
    override fun processMessage(dialogId: String,
                                message: ConnectycubeChatMessage,
                                senderId: Int)
    {

    }

    override fun processError(dialogId: String,
                              exception: ChatException,
                              message: ConnectycubeChatMessage,
                              senderId: Int)
    {

    }
})

Pay attention, messages from group & public chat dialogs will be received in this callback only after you join the dialogs.

Pay attention, before using dialog you need to init it for ConnectycubeChatService. Call this once you've got dialog - chatDialog.initForChat(ConnectycubeChatService.getInstance()).

1-1 chat

try {
    ConnectycubeChatDialog privateDialog = ...;

    ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
    chatMessage.setBody("How are you today?");
    chatMessage.setSaveToHistory(true);

    privateDialog.sendMessage(chatMessage);
} catch (SmackException.NotConnectedException e) {

}

privateDialog.addMessageListener(new ChatDialogMessageListener() {
    @Override
    public void processMessage(String dialogId, ConnectycubeChatMessage message, Integer senderId) {

    }

    @Override
    public void processError(String dialogId, ChatException exception, ConnectycubeChatMessage message, Integer senderId) {

    }
});
val privateDialog = ...

val chatMessage = ConnectycubeChatMessage().apply {
    body = "How are you today?"
    setSaveToHistory(true)
}

privateDialog.sendMessage(chatMessage)

privateDialog.addMessageListener(object: ChatDialogMessageListener {
    override fun processMessage(dialogId: String,
                                message: ConnectycubeChatMessage,
                                senderId: Int
    ) {

    }

    override fun processError(dialogId: String,
                              exception: ChatException,
                              message: ConnectycubeChatMessage,
                              senderId: Int?
    ) {

    }
})

Group/Public chat

Before you start chatting in a group/public conversation, you need to join it by calling join method:

ConnectycubeChatDialog groupChatDialog = ...;

groupChatDialog.join(new EntityCallback() {
    @Override
    public void onSuccess(Object o, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException e) {

    }
});
val groupChatDialog = ...

groupChatDialog.join(object : EntityCallback<Void?> {
    override fun onSuccess(result: Void?, args: Bundle?) {

    }

    override fun onError(exception: ResponseException) {

    }
})

Then you are able to send/receive messages:

try {
    ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
    chatMessage.setBody("How are you today?");
    chatMessage.setSaveToHistory(true);

    groupChatDialog.sendMessage(chatMessage);
} catch (SmackException.NotConnectedException e) {

}

groupChatDialog.addMessageListener(new ChatDialogMessageListener() {
    @Override
    public void processMessage(String dialogId, ConnectycubeChatMessage message, Integer senderId) {

    }

    @Override
    public void processError(String dialogId, ChatException exception, ConnectycubeChatMessage message, Integer senderId) {

    }
});
val chatMessage = ConnectycubeChatMessage().apply {
    body = "How are you today?"
    setSaveToHistory(true)
}

groupChatDialog.sendMessage(chatMessage)

groupChatDialog.addMessageListener(object : ChatDialogMessageListener {
    override fun processMessage(dialogId: String,
                                message: ConnectycubeChatMessage,
                                senderId: Int
    ) {

    }

    override fun processError(dialogId: String,
                              exception: ChatException,
                              message: ConnectycubeChatMessage,
                              senderId: Int
    ) {

    }
})

When it's done, you can leave the group conversation by calling leave method:

try {
    groupChatDialog.leave();
    groupChatDialog = null;
} catch (XMPPException | SmackException.NotConnectedException e) {

}
groupChatDialog.leave()

'Sent' status

There is a 'sent' status to ensure that message is delivered to the server.

In order to use the feature you need to enable it:

ConnectycubeChatService chatService = ConnectycubeChatService.getInstance();

chatService.setUseStreamManagement(true);

chatService.login(user);
val chatService = ConnectycubeChatService.getInstance()

chatService.setUseStreamManagement(true)

chatService.login(user)

Pay attention: you should enable Stream Management before logging into the chat. Stream Management is initialized only during chat login step.

The Stream Management defines an extension for active management of a stream between client and server, including features for stanza acknowledgements.

The following callback is used to track the status:

ChatDialogMessageSentListener messageSentListener = new ChatDialogMessageSentListener() {
    @Override
    public void processMessageSent(String dialogId, ConnectycubeChatMessage message) {

    }

    @Override
    public void processMessageFailed(String dialogId, ConnectycubeChatMessage message) {

    }
};

ConnectycubeChatDialog chatDialog = ...;
chatDialog.addMessageSentListener(messageSentListener);
val messageSentListener = object : ChatDialogMessageSentListener {
    override fun processMessageSent(dialogId: String,
                                    message: ConnectycubeChatMessage
    ) {
    }

    override fun processMessageFailed(dialogId: String,
                                      message: ConnectycubeChatMessage
    ) {
    }
}

val chatDialog = ...
chatDialog.addMessageSentListener(messageSentListener)

'Delivered' status

The following callback is used to track the 'delivered' status:

private MessageStatusesManager messageStatusesManager;
private MessageStatusListener messageStatusListener;

// call it after chat login
messageStatusesManager = ConnectycubeChatService.getInstance().getMessageStatusesManager();

messageStatusListener = new MessageStatusListener() {
    @Override
    public void processMessageDelivered(String messageId, String dialogId, Integer userId) {

    }

    @Override
    public void processMessageRead(String messageId, String dialogId, Integer userId) {

    }
};

messageStatusesManager.addMessageStatusListener(messageStatusListener);
// call it after chat login
val messageStatusesManager: MessageStatusesManager = ConnectycubeChatService.getInstance().messageStatusesManager

val messageStatusListener = object : MessageStatusListener {
    override fun processMessageDelivered(messageId: String,
                                         dialogId: String,
                                         userId: Int
    ) {
    }

    override fun processMessageRead(messageId: String,
                                    dialogId: String,
                                    userId: Int
    ) {
    }
}

messageStatusesManager.addMessageStatusListener(messageStatusListener)

The SDK sends the 'delivered' status automatically when the message is received by the recipient. This is controlled by chatMessage.setMarkable(true) parameter when you send a message.

If markable is false or omitted, then you can send the delivered status manually via Chat:

ConnectycubeChatMessage message = ...;

try {
    chatDialog.deliverMessage(message);
} catch (XMPPException | SmackException.NotConnectedException e) {

}
val chatDialog = ...
val message = ...

chatDialog.deliverMessage(message)

and via REST

MessageUpdateBuilder messageUpdateBuilder = new MessageUpdateBuilder();
messageUpdateBuilder.markDelivered();

ConnectycubeRestChatService.updateMessage(messageId, dialogId, messageUpdateBuilder).performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void result, Bundle params) {

    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
val messageUpdateBuilder = MessageUpdateBuilder().apply {
    markDelivered()
}

ConnectycubeRestChatService.updateMessage(messageId, dialogId, messageUpdateBuilder)
    .performAsync(object : EntityCallback<Void?> {
        override fun onSuccess(result: Void?, params: Bundle?) {

        }

        override fun onError(responseException: ResponseException) {

        }
    })

'Read' status

Send the 'read' status:

try {
    chatDialog.readMessage(chatMessage);
} catch (XMPPException | SmackException.NotConnectedException e) {

}
chatDialog.readMessage(chatMessage)

Receive the 'read' status callback:

private MessageStatusesManager messageStatusesManager;
private MessageStatusListener messageStatusListener;

// call it after chat login
messageStatusesManager = ConnectycubeChatService.getInstance().getMessageStatusesManager();

messageStatusListener = new MessageStatusListener() {
    @Override
    public void processMessageDelivered(String messageId, String dialogId, Integer userId) {

    }

    @Override
    public void processMessageRead(String messageId, String dialogId, Integer userId) {

    }
};

messageStatusesManager.addMessageStatusListener(messageStatusListener);
// call it after chat login
val messageStatusesManager = ConnectycubeChatService.getInstance().messageStatusesManager

val messageStatusListener = object : MessageStatusListener {
    override fun processMessageDelivered(messageId: String,
                                         dialogId: String,
                                         userId: Int
    ) {
    }

    override fun processMessageRead(messageId: String,
                                    dialogId: String,
                                    userId: Int
    ) {
    }
}

messageStatusesManager.addMessageStatusListener(messageStatusListener)

'Is typing' status

The following 'typing' notifications are supported:

  • typing: The user is composing a message. The user is actively interacting with a message input interface specific to this chat session (e.g., by typing in the input area of a chat window)
  • stopped: The user had been composing but now has stopped. The user has been composing but has not interacted with the message input interface for a short period of time (e.g., 30 seconds)

Send the 'is typing' status:

try {
    chatDialog.sendIsTypingNotification();
} catch (XMPPException | SmackException.NotConnectedException e) {
    e.printStackTrace();
}

...

try {
    chatDialog.sendStopTypingNotification();
} catch (XMPPException | SmackException.NotConnectedException e) {
    e.printStackTrace();
}
chatDialog.sendIsTypingNotification()

...

chatDialog.sendStopTypingNotification()

Receive the 'is typing' status callback:

ChatDialogTypingListener typingListener = new ChatDialogTypingListener() {
    @Override
    public void processUserIsTyping(String dialogId, Integer senderId) {

    }

    @Override
    public void processUserStopTyping(String dialogId, Integer senderId) {

    }
};

chatDialog.addIsTypingListener(typingListener);
val typingListener = object : ChatDialogTypingListener {
    override fun processUserIsTyping(dialogId: String, senderId: Int) {

    }

    override fun processUserStopTyping(dialogId: String, senderId: Int) {

    }
}

chatDialog.addIsTypingListener(typingListener)

Edit Message

The following snippet is used to edit chat message:

try {
    dialog.editMessageWithId("5356c64ab35c12bd3b10wa64", "Updated message body", true);
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
}
chatDialog.editMessageWithId("5356c64ab35c12bd3b10wa64", "Updated message body", true)

Other users will receive the 'update' status callback:

MessageUpdateListener messageUpdateListener = new MessageUpdateListener() {
    @Override
    public void processMessageUpdated(String messageID, String dialogId, String newBody, boolean isLastMessage) {

    }
};
ConnectycubeChatService.getInstance().getMessageStatusesManager().addMessageUpdateListener(messageUpdateListener);
val messageUpdateListener = MessageUpdateListener { messageID, dialogId, newBody, isLastMessage ->

}

ConnectycubeChatService.getInstance().messageStatusesManager.addMessageUpdateListener(messageUpdateListener)

Delete chat messages

The following snippet is used to remove chat message via REST:

Set<String> messagesIds = new HashSet<String>() {{
    add("546cc3240eda8f2dd7ee2291");
    add("546cc3230eda8f2dd7ee2292");
}};

boolean forceDelete = false;

ConnectycubeRestChatService.deleteMessages(messagesIds, forceDelete).performAsync(new EntityCallback<Void>() {
    @Override
    public void onSuccess(Void aVoid, Bundle bundle) {

    }

    @Override
    public void onError(ResponseException e) {

    }
});
val messagesIds = HashSet<String>().apply {
    add("546cc3240eda8f2dd7ee2291")
    add("546cc3230eda8f2dd7ee2292")
}

val forceDelete = false

ConnectycubeRestChatService.deleteMessages(messagesIds, forceDelete)
    .performAsync(object : EntityCallback<Void?> {
        override fun onSuccess(aVoid: Void?, bundle: Bundle?) {

        }

        override fun onError(e: ResponseException) {

        }
})

This request will remove the messages from current user history only, without affecting the history of other users. The forceDelete parameter is used to completely remove messages.

The following snippet is used to remove chat message in a real time:

try {
    dialog.removeMessageWithId("5356c64ab35c12bd3b10wa64");
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
}
chatDialog.removeMessageWithId("5356c64ab35c12bd3b10wa64")

Other users will receive the 'delete' status callback:

MessageDeleteListener messageDeleteListener = new MessageDeleteListener() {
    @Override
    public void processMessageDeleted(String messageID, String dialogId) {
        //actions after success deleting message
    }
};
ConnectycubeChatService.getInstance().getMessageStatusesManager().addMessageDeleteListener(messageDeleteListener);
val messageDeleteListener = MessageDeleteListener { messageID, dialogId ->
    //actions after success deleting message
}
ConnectycubeChatService.getInstance().messageStatusesManager.addMessageDeleteListener(messageDeleteListener)

Self-destroy message

Self-destroy messages is used if you want to implement some sort of Secret Chat where messages are visible only for some limited amount of time.

It's your responsibility to setup a timer in your app and remove messages from the client side.

Self-destroy messages are not stored in server history.

ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
chatMessage.setBody("Self destroy message");
chatMessage.setDestroyAfter(10);
try {
    chatDialog.sendMessage(chatMessage);
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
}

chatDialog.addMessageListener(new ChatDialogMessageListener() {
    @Override
    public void processMessage(String dialogId, ConnectycubeChatMessage message, Integer senderId) {
        if (message.getDestroyAfter() > 0) {
            // setup a timer
        }
     }
});
val chatMessage = ConnectycubeChatMessage().apply {
    body = "Self destroy message"
    destroyAfter = 10
}

chatDialog.sendMessage(chatMessage)

chatDialog.addMessageListener(object : ChatDialogMessageListener {
    override fun processMessage(dialogId: String,
                                message: ConnectycubeChatMessage,
                                senderId: Int
    ) {
        if (message.destroyAfter > 0) {
            // setup a timer
        }
    }

    override fun processError(dialogId: String,
                              exception: ChatException,
                              message: ConnectycubeChatMessage,
                              senderId: Int
    ) {

    }
})

Attachments

Image/Video

Chat attachments are supported with the cloud storage API. In order to send a chat attachment you need to upload the file to ConnectyCube cloud storage and obtain a link to the file (file UID). Then you need to include this UID into chat message and send it.

File messageAttachment = new File("some_image.png");
Boolean fileIsPublic = false;

ConnectycubeStorage.uploadFileTask(messageAttachment, fileIsPublic, new ConnectycubeProgressCallback() {
    @Override
    public void onProgressUpdate(int progressPercentages) {

    }
}).performAsync(new EntityCallback<ConnectycubeFile>() {
    @Override
    public void onSuccess(ConnectycubeFile storageFile, Bundle bundle) {
        // create a message
        ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
        chatMessage.setSaveToHistory(true);
        // attach a photo
        ConnectycubeAttachment attachment = new ConnectycubeAttachment("photo");
        attachment.setId(file.getId().toString());
        chatMessage.addAttachment(attachment);

        // send a chat message
        // ...
    }

    @Override
    public void onError(ResponseException e) {

    }
});
val messageAttachment = File("some_image.png")
val fileIsPublic = false

ConnectycubeStorage.uploadFileTask(
    messageAttachment,
    fileIsPublic
) { progress ->

}.performAsync(object : EntityCallback<ConnectycubeFile> {
        override fun onSuccess(storageFile: ConnectycubeFile,
                               bundle: Bundle?
        ) {
            // create a message
            val chatMessage = ConnectycubeChatMessage()
            chatMessage.setSaveToHistory(true)
            // attach a photo
            val attachment = ConnectycubeAttachment("photo")
            attachment.id = storageFile.id.toString()
            chatMessage.addAttachment(attachment)
            // send a chat message
            // ...
        }

        override fun onError(e: ResponseException) {

        }
})

The same flow is supported on the receiver's side. When you receive a message, you need to get the file UID and then download the file from the cloud storage.

// ChatDialogMessageListener

...

@Override
public void processMessage(String dialogId, ConnectycubeChatMessage chatMessage, Integer senderId) {
    for (ConnectycubeAttachment attachment : chatMessage.getAttachments()){
        String fileId = attachment.getId();

        // download a file
        ConnectycubeStorage.downloadFile(fileId).performAsync(new EntityCallback<InputStream>(){
            @Override
            public void onSuccess(InputStream inputStream, Bundle params) {
                // process file
            }

            @Override
            public void onError(ResponseException errors) {

            }
        });
    }
}
// ChatDialogMessageListener

...

override fun processMessage(dialogId: String,
                   chatMessage: ConnectycubeChatMessage,
                   senderId: Int
) {
    for (attachment in chatMessage.attachments) {
        val fileId = attachment.id
        // download a file
        ConnectycubeStorage.downloadFile(fileId).performAsync(object : EntityCallback<InputStream> {
            override fun onSuccess(inputStream: InputStream,
                                   params: Bundle
            ) {
                // process file
            }

            override fun onError(errors: ResponseException) {

            }
        })
    }
}

Contact

A contact profile can be send via chat attachments as well:

// create a message
ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
chatMessage.setSaveToHistory(true);

// build a contact representation
JsonObject jc = new JsonObject();
jc.add("phone", new JsonPrimitive("180032323223"));
jc.add("name", new JsonPrimitive("Samuel Johnson"));

// attach a contact
ConnectycubeAttachment attachment = new ConnectycubeAttachment("contact");
attachment.setData(jc.toString());
chatMessage.addAttachment(attachment);

// send a chat message
// ...
// create a message
val chatMessage = ConnectycubeChatMessage().apply {
    setSaveToHistory(true)
}

// build a contact representation
val jc = JsonObject().apply {
    add("phone", JsonPrimitive("180032323223"))
    add("name", JsonPrimitive("Samuel Johnson"))
}

// attach a contact
val attachment = ConnectycubeAttachment("contact").apply {
    data = jc.toString()
}

chatMessage.addAttachment(attachment)

// send a chat message
// ...
// ChatDialogMessageListener

...

@Override
public void processMessage(String dialogId, ConnectycubeChatMessage chatMessage, Integer senderId) {
    for (ConnectycubeAttachment attachment : chatMessage.getAttachments()){
        String data = attachment.getData();
        JsonObject obj = new JsonParser().parse(data).getAsJsonObject();
        String phone = obj.getAsJsonPrimitive("phone").getAsString();
        String name = obj.getAsJsonPrimitive("name").getAsString();
    }
}
// ChatDialogMessageListener

...

override fun processMessage(dialogId: String,
                           chatMessage: ConnectycubeChatMessage,
                           senderId: Int
) {
    for (attachment in chatMessage.attachments) {
        val data = attachment.data
        val obj = JsonParser().parse(data).asJsonObject
        val phone = obj.getAsJsonPrimitive("phone").asString
        val name = obj.getAsJsonPrimitive("name").asString
    }
}

On the receiver's side, when you receive a message, you need to get a contact data from an attachment:

Unread messages count

You can request total unread messages count and unread count for particular conversation:

Set<String> dialogsIds = new HashSet<String>();
    dialogsIds.add("546cc3240eda8f2dd7ee2291");
    dialogsIds.add("546cc3230eda8f2dd7ee2292");

ConnectycubeRestChatService.getTotalUnreadMessagesCount(dialogsIds, new Bundle()).performAsync(new EntityCallback<Integer>() {
    @Override
    public void onSuccess(Integer total, Bundle params) {
        Log.i(TAG, "total unread messages: " + total);
        Log.i(TAG, "dialog Unread1: " + params.getInt("546cc3240eda8f2dd7ee2291"));
        Log.i(TAG, "dialog Unread2: " + params.getInt("546cc3230eda8f2dd7ee2292"));
    }

    @Override
    public void onError(ResponseException e) {

    }
});
val dialogsIds: MutableSet<String> = HashSet<String>().apply {
    add("546cc3240eda8f2dd7ee2291")
    add("546cc3230eda8f2dd7ee2292")
}

val returnBundle = Bundle()
ConnectycubeRestChatService.getTotalUnreadMessagesCount(dialogsIds, returnBundle)
    .performAsync(object : EntityCallback<Int> {
        override fun onSuccess(total: Int, params: Bundle) {
            Log.i(TAG, "total unread messages: $total")
            Log.i(TAG, "dialog Unread1: ${params?.getInt("546cc3240eda8f2dd7ee2291")}")
            Log.i(TAG, "dialog Unread2: ${params?.getInt("546cc3230eda8f2dd7ee2292")}")
        }

        override fun onError(e: ResponseException) {

        }
    })

Global search feature was developed to simplify search of dialogs, messages and users at the same time. Similar functionality is used in most popular messengers and you can implement it in your app using Connectycube SDK. Just use request from snippet below. SearchRequestBuilder is optional parameter and it can be null if you don't need additional configs for search request.

String searchText;                              // String or word. Should be longer than 4 symbols. Performs 'or' search.
                                                // For an exact search, you need to wrap the search phrase in quotes.

SearchRequestBuilder searchRequestBuilder = new SearchRequestBuilder();
searchRequestBuilder.setDialogsIds(dialogsIds); // List of dialog ids. Max cam include 10 items. Optional parameter.
searchRequestBuilder.setStartDate(startDate);   // Closest date to now. Uses lte comparison. Optional parameter.
searchRequestBuilder.setEndDate(endDate);       // Shouldn't differ by more than 3 months from the start_date. Uses gte comparison. Optional parameter.
searchRequestBuilder.setLimit(3);               // Maximum number of items returned from the server in the search results. Max value - 100. Optional parameter.

ConnectycubeRestChatService.searchByText(searchText, searchRequestBuilder).performAsync(new EntityCallback<SearchChatEntity>() {
    @Override
    public void onSuccess(SearchChatEntity result, Bundle params) {
        ArrayList<ConnectycubeChatDialog> dialogs   = result.getDialogs();  // found dialogs
        ArrayList<ConnectycubeChatMessage> messages = result.getMessages(); // found messages
        ArrayList<ConnectycubeUser> users           = result.getUsers();    // found users
    }

    @Override
    public void onError(ResponseException responseException) {

    }
});
val searchText                  // String or word. Should be longer than 4 symbols. Performs 'or' search.
                                // For an exact search, you need to wrap the search phrase in quotes.

val searchRequestBuilder = SearchRequestBuilder().apply {
    setDialogsIds(dialogsIds)   // List of dialog ids. Max cam include 10 items. Optional parameter.
    setStartDate(startDate)     // Closest date to now. Uses lte comparison. Optional parameter.
    setEndDate(endDate)         // Shouldn't differ by more than 3 months from the start_date. Uses gte comparison. Optional parameter.
    limit = 3                   // Maximum number of items returned from the server in the search results. Max value - 100. Optional parameter.
}

ConnectycubeRestChatService.searchByText(searchText, searchRequestBuilder).performAsync(object : EntityCallback<SearchChatEntity> {
    override fun onSuccess(result: SearchChatEntity, params: Bundle) {
        val dialogs     = result.dialogs  // found dialogs
        val messages    = result.messages // found messages
        val users       = result.users    // found users
    }

    override fun onError(e: ResponseException) {

    }
})

Chat alerts

When you send a chat message and the recipient/recipients is offline, then automatic push notification will be fired.

In order to receive push notifications you need to subscribe for it. Please refer to Push Notifications guide.

To configure push template which users receive - go to Dashboard Console, Chat Alerts page

Note that currently push notifications are supported on mobile environment only.

Chat notifications settings

Update notifications settings

A user can turn on/off push notifications for offline messages in a dialog. By default push notification are turned ON, so offline user receives push notifications for new messages in a chat.

String dialogId = "5356c64ab35c12bd3b108a41";
boolean enabled = false; //false - to disable push notification, true - to enable

ConnectycubeRestChatService.updateDialogNotificationSending(dialogId, enabled).performAsync(new EntityCallback<Boolean>() {
    @Override
    public void onSuccess(Boolean result, Bundle params) {
        //if result == false - push notifications was disabled, otherwise - enabled    
    }

    @Override
    public void onError(ResponseException e) {

    }
});
val dialogId = "5356c64ab35c12bd3b108a41"
val enabled = false  //false - to disable push notification, true - to enable

ConnectycubeRestChatService.updateDialogNotificationSending(dialogId, enabled).performAsync(object : EntityCallback<Boolean> {
    override fun onSuccess(result: Boolean, params: Bundle) {
        //if result == false - push notifications was disabled, otherwise - enabled
    }

    override fun onError(e: ResponseException) {

    }
})

Get notifications settings

Check a status of notifications setting - either it is ON or OFF for a particular chat.

String dialogId = "5356c64ab35c12bd3b108a41";

ConnectycubeRestChatService.checkIsDialogNotificationEnabled(dialogId).performAsync(new EntityCallback<Boolean>() {
    @Override
    public void onSuccess(Boolean result, Bundle params) {
        //result == false - push notifications are disabled,
        //result == true - push notifications are enabled
    }

    @Override
    public void onError(ResponseException e) {

    }
});
val dialogId = "5356c64ab35c12bd3b108a41"

ConnectycubeRestChatService.checkIsDialogNotificationEnabled(dialogId).performAsync(object : EntityCallback<Boolean> {
    override fun onSuccess(result: Boolean, params: Bundle) {
        //result == false - push notifications are disabled,
        //result == true - push notifications are enabled
    }

    override fun onError(e: ResponseException) {

    }
})

Contact list

The Contact List API is rather straightforward. User A sends a request to become "friends" with user B. User B accepts the friend request. And now user A and B appear in each other's roster.

Setup Contact List

To access contact list you have to obtain it and set all needed listeners:

RosterListener rosterListener = new RosterListener() {
    @Override
    public void entriesDeleted(Collection<Integer> userIds) {

    }

    @Override
    public void entriesAdded(Collection<Integer> userIds) {

    }

    @Override
    public void entriesUpdated(Collection<Integer> userIds) {

    }

    @Override
    public void presenceChanged(ConnectycubePresence presence) {

    }
};

SubscriptionListener subscriptionListener = new SubscriptionListener() {
    @Override
    public void subscriptionRequested(int userId) {

    }
};

// Do this after success Chat login
ConnectycubeRoster chatRoster = ConnectycubeChatService.getInstance().getRoster(ConnectycubeRoster.SubscriptionMode.mutual, subscriptionListener);
chatRoster.addRosterListener(rosterListener);
val rosterListener: RosterListener = object : RosterListener {
    override fun entriesDeleted(userIds: Collection<Int?>?) {

    }

    override fun entriesAdded(userIds: Collection<Int?>?) {

    }

    override fun entriesUpdated(userIds: Collection<Int?>?) {

    }

    override fun presenceChanged(presence: ConnectycubePresence?) {

    }
}

val subscriptionListener = SubscriptionListener { }

// Do this after success Chat login
val chatRoster = ConnectycubeChatService.getInstance()
    .getRoster(ConnectycubeRoster.SubscriptionMode.mutual, subscriptionListener)

chatRoster.addRosterListener(rosterListener)

RosterListener is a listener that is fired any time a contact list is changed or the presence of a user in the contact list is changed (user becomes online/offline)

SubscriptionListener is a listener that is fired on "subscribe" (add to contact list) request from any user.

Access to the Contact list

Then you can access all contact list items:

Collection<ConnectycubeRosterEntry> entries = сhatRoster.getEntries();
val entries = chatRoster.entries

A ConnectycubeRosterEntry describes a user entity in your contact list. To get a user ID of an entry - use getUserId() method.

Then, you can get a user's status:

int userID = 34;

ConnectycubePresence presence = chatRoster.getPresence(userID);

if (presence == null) {
    // No user in your roster
    return;
}

if (presence.getType() == ConnectycubePresence.Type.online) {
    // User is online
}else{
    // User is offline
}
val userID = 34

val presence: ConnectycubePresence = chatRoster.getPresence(userID)
    ?: // No user in your roster
    return

if (presence.type == ConnectycubePresence.Type.online) {
    // User is online
} else {
    // User is offline
}

Add user to your contact list

To add user to the contact list use the following snippet:

int userID = 34;

if (chatRoster.contains(userID)) {
    try {
        chatRoster.subscribe(userID);
    } catch (Exception e) {

    }
} else {
    try {
        chatRoster.createEntry(userID, null);
    } catch (Exception e) {

    }
}
val userID = 34

if (chatRoster.contains(userID)) {
    chatRoster.subscribe(userID)
} else {
    chatRoster.createEntry(userID, null)
}

Note

Maximum number of contacts is 300.

Other user will receive the request to be added to the contact list:

// SubscriptionListener

@Override
public void subscriptionRequested(int userId) {

}
// SubscriptionListener

override fun subscriptionRequested(userId: Int) {

}

Confirm the contact request

To confirm the request use the following method:

try {
    chatRoster.confirmSubscription(userID);
} catch (Exception e) {

}
val userID = 67

chatRoster.confirmSubscription(userID)

Reject the contact request

To reject the request use the following method:

try {
    chatRoster.reject(userID);
} catch (Exception e) {

}
val userID = 67

chatRoster.reject(userID)

Remove user from the contact list

To remove a previously added user from the contact list use the following method:

int userID = 67;

try {
    chatRoster.unsubscribe(userID);
} catch (Exception e) {

}
val userID = 67

chatRoster.unsubscribe(userID)

Contact list updates

So the above RosterListener listener will give you all the updates regarding contact list changes and users' statuses updates.

Privacy (black) list

Privacy list API allows enabling or disabling communication with other users in a chat. You can create, modify, or delete privacy lists, define a default list.

The user can have multiple privacy lists, but only one can be active.

Create privacy list

A privacy list must have at least one element in order to be created. If no elements specified, then the list with given name will be deleted.

ConnectycubePrivacyList list = new ConnectycubePrivacyList();
list.setName("myList");

ArrayList<ConnectycubePrivacyListItem> items = new ArrayList<ConnectycubePrivacyListItem>();

ConnectycubePrivacyListItem item1 = new ConnectycubePrivacyListItem();
item1.setAllow(false);
item1.setType(ConnectycubePrivacyListItem.Type.USER_ID);
item1.setValueForType(String.valueOf(3678));
item1.setMutualBlock(true);

items.add(item1);

list.setItems(items);

PrivacyListsManager privacyListsManager = chatService.getPrivacyListsManager();
try {
    privacyListsManager.createPrivacyList(list);
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
val list = ConnectycubePrivacyList().apply {
    name = "myList"
}

val items = ArrayList<ConnectycubePrivacyListItem>()

val item1 = ConnectycubePrivacyListItem().apply {
    isAllow = false
    type = ConnectycubePrivacyListItem.Type.USER_ID
    valueForType = 3678.toString()
    isMutualBlock = true
}

items.add(item1)

list.items = items

val privacyListsManager = chatService.privacyListsManager
privacyListsManager.createPrivacyList(list)

The ConnectycubePrivacyListItem class takes 4 arguments:

  • type - use USER_ID to block a user in 1-1 chat or GROUP_USER_ID to block in a group chat.
  • valueForType - ID of a user to apply an action
  • allow - can be true/false.
  • mutualBlock - can be true/false - to block user's message in both directions or not.

In order to be used the privacy list should be not only set, but also activated(set as default).

Activate privacy list

In order to activate rules from a privacy list you should set it as default:

try {
    privacyListsManager.applyPrivacyList("myList");
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
privacyListsManager.applyPrivacyList("myList")

Update privacy list

There are some rules you should follow to update a privacy list:

  • Include all of the desired items (not a "delta").
  • If you want to update or set new privacy list instead of current one, you should decline current default list first.
// Deactivate active list
try {
    privacyListsManager.declinePrivacyList();
} catch (SmackException|XMPPException.XMPPErrorException e) {

}

// Create new list
// ...

// Activate again active list
try {
    privacyListsManager.applyPrivacyList("myList");
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
// Deactivate active list
privacyListsManager.declinePrivacyList()

// Create new list
// ...

// Activate again active list
privacyListsManager.applyPrivacyList("myList")

Retrieve privacy lists

To get a list of all your privacy lists use the following request:

PrivacyListsManager privacyListsManager = ConnectycubeChatService.getInstance().getPrivacyListsManager()

List<ConnectycubePrivacyList> lists = null;
try {
    lists = privacyListsManager.getPrivacyLists();
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
val privacyListsManager = ConnectycubeChatService.getInstance().privacyListsManager

val lists = privacyListsManager.privacyLists

Retrieve privacy list with name

To get the privacy list by name you should use the following method:

ConnectycubePrivacyList list = null;
try {
    list = privacyListsManager.getPrivacyList("myList");
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
var list = privacyListsManager.getPrivacyList("myList")

Remove privacy list

Note: Before deleting privacy list you should decline it.

try {
    privacyListsManager.declinePrivacyList();
    privacyListsManager.deletePrivacyList("myList");
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
} catch (XMPPException.XMPPErrorException e) {
    e.printStackTrace();
} catch (SmackException.NoResponseException e) {
    e.printStackTrace();
}
privacyListsManager.declinePrivacyList()
privacyListsManager.deletePrivacyList("myList")

Blocked user attempts to communicate with user

Blocked users will be receiving an error when trying to chat with a user in a 1-1 chat and will be receiving nothing in a group chat:

ConnectycubeChatMessage chatMessage = new ConnectycubeChatMessage();
chatMessage.setBody("How is going on?");

ConnectycubeChatDialog chatDialog = ...;

chatDialog.sendMessage(chatMessage);

...

privateDialog.addMessageListener(new ChatDialogMessageListener() {
    @Override
    public void processMessage(String dialogId, ConnectycubeChatMessage message, Integer senderId) {

    }

    @Override
    public void processError(String dialogId, ChatException exception, ConnectycubeChatMessage message, Integer senderId) {
      log("processError: " + exception.getLocalizedMessage());
    }
});
val chatMessage = ConnectycubeChatMessage().apply {
    body = "How is going on?"
}

val chatDialog = ...
chatDialog.sendMessage(chatMessage)

...

chatDialog.addMessageListener(object : ChatDialogMessageListener {
    override fun processMessage(dialogId: String,
                                message: ConnectycubeChatMessage,
                                senderId: Int
    ) {}

    override fun processError(dialogId: String,
                              exception: ChatException,
                              message: ConnectycubeChatMessage,
                              senderId: Int
    ) {
        Log.e(TAG, "processError: " + exception.localizedMessage)
    }
})
Log output:
processError: Service not available.

Last activity

There is a way to get an info when a user was active last time, in seconds.

This is a modern approach for messengers apps, e.g. to display this info on a Contacts screen or on a User Profile screen.

int userId = 12345;

double seconds = ConnectycubeChatService.getInstance().getLastUserActivity(userId);
// seconds - the difference in seconds from current time to last user activity in the chat or 0 if user is online.
val userId = 12345

val seconds = ConnectycubeChatService.getInstance().getLastUserActivity(userId)
// seconds - the difference in seconds from current time to last user activity in the chat or 0 if user is online.

System messages

There is a way to send system messages to other users about some events. System messages work on a separate channel and are not mixed with regular chat messages:

System messages are not stored on a server. It means messages will be delivered only to online users.

SystemMessagesManager systemMessagesManager = ConnectycubeChatService.getInstance().getSystemMessagesManager();
SystemMessageListener systemMessageListener = new SystemMessageListener() {
    @Override
    public void processMessage(ConnectycubeChatMessage message) {
    }

    @Override
    public void processError(ChatException exception, ConnectycubeChatMessage message) {
    }
};
systemMessagesManager.addSystemMessageListener(systemMessageListener);

ConnectycubeChatMessage systemMessage = new ConnectycubeChatMessage();
systemMessage.setRecipientId(58672);
systemMessage.setProperty("param1", "value1");
systemMessage.setProperty("param2", "value2");
systemMessage.setBody("some text");

try {
    systemMessagesManager.sendSystemMessage(systemMessage);
} catch (SmackException.NotConnectedException e) {
    e.printStackTrace();
}
val systemMessagesManager = ConnectycubeChatService.getInstance().systemMessagesManager
val systemMessageListener = object : SystemMessageListener {
    override fun processMessage(message: ConnectycubeChatMessage) {

    }

    override fun processError(exception: ChatException,
                              message: ConnectycubeChatMessage
    ) {

    }
}

systemMessagesManager.addSystemMessageListener(systemMessageListener)

val systemMessage = ConnectycubeChatMessage().apply {
    recipientId = 58672
    setProperty("param1", "value1")
    setProperty("param2", "value2")
    body = "some text"
}

systemMessagesManager.sendSystemMessage(systemMessage)