Chat Room and Messages - TapUI

The following methods from the TapUI class can be used to open a chat room when UI implementation type is used.

TapTalk UI Chat Room Method	Description
Open Chat Room With User Model	Opens a chat room using the recipient user model. This method will directly open the chat room activity.
Open Chat Room with TapTalk.io User ID	Opens a chat room using TapTalk.io user ID of the recipient user. This method will directly open the chat room activity.
Open Chat Room with Client User ID	Opens a chat room using client user ID of the recipient user. This method will directly open the chat room activity.
Open Room with Room Model	Opens a chat room using an available room model. This method will directly open the chat room activity.
Open Room with Room Model & Scroll to Selected Message	Opens a chat room using an available room model. This method will directly open the chat room and scroll the view to the selected message.
Open Saved Messages Chat Room	Opens of the active user's Saved Messages chat room. This method will directly open the chat room activity.

Open Chat Room With User Model

Opens a chat room using the recipient user model. This method will directly open the chat room activity.

Java

TapUI.getInstance().openChatRoomWithOtherUser(CONTEXT, RECIPIENT_USER);

Kotlin

TapUI.getInstance().openChatRoomWithOtherUser(CONTEXT, RECIPIENT_USER)

Parameters CONTEXT: (Context) your Application or Activity context RECIPIENT_USER: (TAPUserModel) the recipient user to chat with

Open Chat Room with TapTalk.io User ID

Opens a chat room using client user ID of the recipient user. This method will directly open the chat room activity.

Java

TapUI.getInstance().openChatRoomWithUserID(CONTEXT, USER_ID, PREFILLED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Chat room opened successfully
    }

    @Override
    public void onError(String errorCode, String errorMessage) {

    }
});

Kotlin

TapUI.getInstance().openChatRoomWithUserID(CONTEXT, USER_ID, PREFILLED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO, object : TapCommonListener() {
    override fun onSuccess(successMessage: String?) {
        // Chat room opened successfully
    }

    override fun onError(errorCode: String?, errorMessage: String?) {

    }
})

Parameters CONTEXT: (Context) your Application or Activity context USER_ID: (String) Taptalk.io User ID of the recipient user PREFILLED_TEXT: (String) if not empty, the active user's chat composer will be filled with this predefined message when the chat room is opened (existing draft will be replaced) CUSTOM_QUOTE_TITLE: (String) title of custom quote data CUSTOM_QUOTE_CONTENT: (String) content / subtitle of custom quote data CUSTOM_QUOTE_IMAGE_URL: (String) image URL string of custom quote USER_INFO: (HashMap<String , Object>) client-specified data or details of the custom quote

Open Chat Room with Client User ID

Opens a chat room using client user ID of the recipient user. This method will directly open the chat room activity.

Java

TapUI.getInstance().openChatRoomWithXCUserID(CONTEXT, XC_USER_ID, PREFFILED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Chat room opened successfully
    }

    @Override
    public void onOpenRoomFailed(String errorMessage) {

    }
});

Kotlin

TapUI.getInstance().openChatRoomWithXCUserID(CONTEXT, XC_USER_ID, PREFFILED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO, object : TapCommonListener() {
    override fun onSuccess(successMessage: String?) {
        // Chat room opened successfully
    }

    fun onOpenRoomFailed(errorMessage: String) {

    }
})

Parameters CONTEXT: (Context) your Application or Activity context XC_USER_ID: (String) Client User ID of the recipient user PREFILLED_TEXT: (String) if not empty, the active user's chat composer will be filled with this predefined message when the chat room is opened (existing draft will be replaced) CUSTOM_QUOTE_TITLE: (String) title of custom quote data CUSTOM_QUOTE_CONTENT: (String) content / subtitle of custom quote data CUSTOM_QUOTE_IMAGE_URL: (String) image URL string of custom quote USER_INFO: (HashMap<String , Object>) client-specified data or details of the custom quote

Open Room with Room Model

Opens a chat room using an available room model. This method will directly open the chat room activity.

Java

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM);

Kotlin

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM)

Parameters CONTEXT: (Context) your Application or Activity context ROOM: (TAPRoomModel) existing chat room data to open

The openChatRoomWithRoomModel() method with extra parameters below is used when you wish to set a predefined quote for the user in the opened chat room.

Java

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM, PREFILLED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO);

Kotlin

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM, PREFILLED_TEXT, CUSTOM_QUOTE_TITLE, CUSTOM_QUOTE_CONTENT, CUSTOM_QUOTE_IMAGE_URL, USER_INFO)

Parameters CONTEXT: (Context) your Application or Activity context ROOM: (TAPRoomModel) existing chat room data to open PREFILLED_TEXT: (String) if not empty, the active user's chat composer will be filled with this predefined message when the chat room is opened (existing draft will be replaced) CUSTOM_QUOTE_TITLE: (String) title of custom quote data CUSTOM_QUOTE_CONTENT: (String) content / subtitle of custom quote data CUSTOM_QUOTE_IMAGE_URL_STRING: (String) image URL string of custom quote USER_INFO: (HashMap<String , Object>) client-specified data or details of the custom quote

Open Room with Room Model & Scroll to Selected Message

Opens a chat room using an available room model. This method will directly open the chat room and scroll the view to the selected message.

Java

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM, SCROLL_TO_MESSAGE_WITH_LOCAL_ID);

Kotlin

TapUI.getInstance().openChatRoomWithRoomModel(CONTEXT, ROOM, SCROLL_TO_MESSAGE_WITH_LOCAL_ID)

Parameters CONTEXT: (Context) your Application or Activity context ROOM: (TAPRoomModel) existing chat room data to open SCROLL_TO_MESSAGE_WITH_LOCAL_ID: (String) scrolls the view to the message with the specified local ID when the chat room is opened

Open Saved Messages Chat Room

Opens of the active user's Saved Messages chat room. This method will directly open the chat room activity.

Java

TapUI.getInstance().openSavedMessagesChatRoom(CONTEXT);

Kotlin

TapUI.getInstance().openSavedMessagesChatRoom(CONTEXT)

Parameters CONTEXT: (Context) your Application or Activity context