Collaboration Extensions - CometChat Docs

This page contains Android SDK code examples for Collaboration extensions. For feature documentation, setup instructions, and extension settings, see Collaboration Extensions.

How to Use Extensions with SDK

Enable in Dashboard

Implement SDK methods

Use the code examples below to initiate collaboration sessions and extract URLs from messages.

Build your UI

Create UI components to display the collaboration interface (e.g., embed the whiteboard/document URL in a WebView).

Collaborative Document

Co-edit documents in real-time with other users.

Initiating the Session

Kotlin
Java

val body = JSONObject()
body.put("receiverType", "user/group")
body.put("receiver", "uid/guid")

CometChat.callExtension("document", "POST", "/v1/create", body,
    object : CometChat.CallbackListener<JSONObject>() {
        override fun onSuccess(responseObject: JSONObject) {
            // The document link to join as an initiator.
        }
        override fun onError(e: CometChatException) {
            // Some error occurred.
        }
    }
)

JSONObject body = new JSONObject();
body.put("receiverType", "user/group");
body.put("receiver", "uid/guid");

CometChat.callExtension("document", "POST", "/v1/create", body,
  new CometChat.CallbackListener<JSONObject>() {
    @Override
    public void onSuccess(JSONObject responseObject) {
        // The document link to join as an initiator.
    }
    @Override
    public void onError(CometChatException e) {
        // Some error occured.
    }
});

Extracting the URL from Received Message

Kotlin
Java

val metadata = message.metadata
if (metadata != null) {
    val injectedObject = metadata.getJSONObject("@injected")
    if (injectedObject != null && injectedObject.has("extensions")) {
        val extensionsObject = injectedObject.getJSONObject("extensions")
        if (extensionsObject != null && extensionsObject.has("document")) {
            val documentExtension = extensionsObject.getJSONObject("document")
            val documentUrl = documentExtension.getString("document_url")
            // Use the document URL
        }
    }
}

JSONObject metadata = message.getMetadata();
if (metadata != null) {
    JSONObject injectedObject = metadata.getJSONObject("@injected");
    if (injectedObject != null && injectedObject.has("extensions")) {
        JSONObject extensionsObject = injectedObject.getJSONObject("extensions");
        if (extensionsObject != null && extensionsObject.has("document")) {
            JSONObject documentExtension = extensionsObject.getJSONObject("document");
            String documentUrl = documentExtension.getString("document_url");
            // Use the document URL
        }
    }
}

Collaborative Whiteboard

Draw and brainstorm together on a shared whiteboard.

Initiating the Session

Kotlin
Java

val body = JSONObject()
body.put("receiverType", "user/group")
body.put("receiver", "uid/guid")

CometChat.callExtension("whiteboard", "POST", "/v1/create", body,
    object : CometChat.CallbackListener<JSONObject>() {
        override fun onSuccess(responseObject: JSONObject) {
            // The whiteboard link to join as an initiator.
        }
        override fun onError(e: CometChatException) {
            // Some error occurred.
        }
    }
)

JSONObject body = new JSONObject();
body.put("receiverType", "user/group");
body.put("receiver", "uid/guid");

CometChat.callExtension("whiteboard", "POST", "/v1/create", body,
  new CometChat.CallbackListener<JSONObject>() {
    @Override
    public void onSuccess(JSONObject responseObject) {
        // The whiteboard link to join as an initiator.
    }
    @Override
    public void onError(CometChatException e) {
        // Some error occured.
    }
});

Extracting the URL from Received Message

Kotlin
Java

val metadata = message.metadata
if (metadata != null) {
    val injectedObject = metadata.getJSONObject("@injected")
    if (injectedObject != null && injectedObject.has("extensions")) {
        val extensionsObject = injectedObject.getJSONObject("extensions")
        if (extensionsObject != null && extensionsObject.has("whiteboard")) {
            val whiteboardObject = extensionsObject.getJSONObject("whiteboard")
            val boardUrl = whiteboardObject.getString("board_url")
            // Use the whiteboard URL
        }
    }
}

JSONObject metadata = message.getMetadata();
if (metadata != null) {
    JSONObject injectedObject = metadata.getJSONObject("@injected");
    if (injectedObject != null && injectedObject.has("extensions")) {
        JSONObject extensionsObject = injectedObject.getJSONObject("extensions");
        if (extensionsObject != null && extensionsObject.has("whiteboard")) {
            JSONObject whiteboardObject = extensionsObject.getJSONObject("whiteboard");
            String boardUrl = whiteboardObject.getString("board_url");
            // Use the whiteboard URL
        }
    }
}

Append Username to the Whiteboard URL

Kotlin
Java

CometChat.getLoggedInUser(object : CometChat.CallbackListener<User>() {
    override fun onSuccess(user: User) {
        // Replace spaces with underscore
        val username = user.name.replace(" ", "_")
        // Append the username to the board_url
        val finalUrl = "$boardUrl&username=$username"
        // Use the final URL
    }

    override fun onError(e: CometChatException) {
        // Error getting user
    }
})

CometChat.getLoggedInUser(new CometChat.CallbackListener<User>() {
    @Override
    public void onSuccess(User user) {
        // Replace spaces with underscore
        String username = user.getName().replace(" ", "_");
        // Append the username to the board_url
        String finalUrl = boardUrl + "&username=" + username;
        // Use the final URL
    }

    @Override
    public void onError(CometChatException e) {
        // Error getting user
    }
});

​How to Use Extensions with SDK

​Collaborative Document

​Initiating the Session

​Extracting the URL from Received Message

​Collaborative Whiteboard

​Initiating the Session

​Extracting the URL from Received Message

​Append Username to the Whiteboard URL

How to Use Extensions with SDK

Collaborative Document

Initiating the Session

Extracting the URL from Received Message

Collaborative Whiteboard

Initiating the Session

Extracting the URL from Received Message

Append Username to the Whiteboard URL