Room List - TapCore

If you are using core implementation type, the application's chat room list can be managed with the TapCoreRoomListManager class using the following methods:

TapTalk Room List Method

Description

Call this method to fetch the latest room list data from the server and update to the local cache

Call this method to retrieve list of room data obtained from the local cache

Call this method to fetch new/updated messages that have not yet been received by the device

Call this method to search room lists from the device's local storage with a keyword

Add the chat room ID to the marked as unread chat room list

Remove chat room ID from the marked as unread chat room list​

Retrieve the list of chat room IDs that has been marked as unread

Mute selected chat rooms until a specified time

Retrieve the list of muted chat room IDs and their respective mute expiry time

Add or remove the chat room ID to pinned chat room list

Retrieve list of pinned chat room IDs from the server

Get Updated Room List

Call this method to retrieve the latest room list data from the server and update to the local cache.

TapCoreRoomListManager.getInstance().getUpdatedRoomList(new TapCoreGetRoomListListener() {
    @Override
    public void onSuccess(List<TAPRoomListModel> roomLists) {
        // Returns latest updated room lists
    }

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

    }
});

Get Room List From Cache

Call this method to retrieve list of room data obtained from the local cache.

TapCoreRoomListManager.getInstance().getRoomListFromCache(new TapCoreGetRoomListListener() {
    @Override
    public void onSuccess(List<TAPRoomListModel> roomLists) {
        // Returns room lists obtained from cache
    }

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

    }
});

Fetch New Message

Call this method to fetch new/updated messages that have not yet been received by the device. Can be used to retrieve pending messages when the device goes back online after an offline state.

TapCoreRoomListManager.getInstance().fetchNewMessage(new TapCoreGetMessageListener() {
    @Override
    public void onSuccess(List<TAPMessageModel> messages) {
        // Returns list of messages received by the user while the device is offline
    }

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

    }
});

Search Local Room List

Call this method to search room lists from the device's local storage with a keyword. Provided keyword will be used to filter room name in the search result.

TapCoreRoomListManager.getInstance().searchLocalRoomListWithKeyword(KEYWORD, new TapCoreGetRoomListListener() {
    @Override
    public void onSuccess(List<TAPRoomListModel> roomLists) {
        // Returns filtered room lists obtained from cache
    }

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

    }
});

Parameters KEYWORD: (String) search keyword to filter room name

Mark Chat Room as Unread

Call this method to add the selected chat room ID to the marked as unread chat room list.

// Mark single chat room as unread
TapCoreRoomListManager.getInstance().markChatRoomAsUnread(ROOM_ID, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully marked chat room as unread
    }

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

    }
});

// Mark multiple chat rooms as unread
TapCoreRoomListManager.getInstance().markChatRoomsAsUnread(ROOM_IDS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully marked chat rooms as unread
    }

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

    }
});

Parameters ROOM_ID: (String) ID of the target room ROOM_IDS: (List<String>) list containing IDs of target rooms

Remove Unread Mark from Chat Room

Call this method to remove the selected chat room ID from the marked as unread chat room list.

// Remove unread mark from single chat room
TapCoreRoomListManager.getInstance().removeUnreadMarkFromChatRoom(ROOM_ID, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully removed unread mark from chat room
    }

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

    }
});

// Remove unread mark from multiple chat rooms
TapCoreRoomListManager.getInstance().removeUnreadMarkFromChatRooms(ROOM_IDS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully removed unread mark from chat rooms
    }

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

    }
});

Parameters ROOM_ID: (String) ID of the target room ROOM_IDS: (List<String>) list containing IDs of target rooms

Get Marked as Unread Chat Room List

Call this method to retrieve the list of chat room IDs that has been marked as unread.

TapCoreRoomListManager.getInstance().getMarkedAsUnreadChatRoomList(new TapCoreGetStringArrayListener() {
    @Override
    public void onSuccess(ArrayList<String> arrayList) {
        // Returns list of roomID that has been marked as unread
    }

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

    }
});

Mute/Unmute Chat Room

Call these methods to mute the selected chat rooms until a specified time. Active user will not receive notifications from muted chat rooms.

// Mute a single chat room
TapCoreRoomListManager.getInstance().muteChatRoom(ROOM_ID, EXPIRED_AT, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully muted chat room
    }

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

    }
});

// Mute multiple chat rooms
TapCoreRoomListManager.getInstance().muteChatRooms(ROOM_IDS, EXPIRED_AT, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully muted chat rooms
    }

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

    }
});

Parameters ROOM_ID: (String) ID of the target room ROOM_IDS: (List<String>) list containing IDs of target rooms EXPIRED_AT: (Long) chat room will stay muted until this time, fill with 0L to mute the room forever or until the room is unmuted

To return chat rooms to its normal state and continue retrieving notifications, use unmuteChatRoom() method.

// Unmute a single chat room
TapCoreRoomListManager.getInstance().unmuteChatRoom(ROOM_ID, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully unmuted chat room
    }

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

    }
});

// Unmute multiple chat rooms
TapCoreRoomListManager.getInstance().unmuteChatRooms(ROOM_IDS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully unmuted chat rooms
    }

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

    }
});

Parameters ROOM_ID: (String) ID of the target room ROOM_IDS: (List<String>) list containing IDs of target rooms

Get Muted Chat Rooms

Retrieve the list of muted chat room IDs and their respective mute expiry time.

TapCoreRoomListManager.getInstance().getMutedChatRoomList(new TapCoreGetMutedChatRoomListener() {
    @Override
    public void onSuccess(@NonNull ArrayList<TapMutedRoomListModel> mutedRoomList) {
        // Returns list of TapMutedRoomListModel which contains 
        // roomID and expiry time of the muted chat rooms
    }
    
    @Override
    public void onError(String errorCode, String errorMessage) {

    }
});

Pin/Unpin Chat Room

You may call pinChatRoom() to add or remove the chat room ID to pinned chat room list. Chat rooms pinned by the user are generally shown on top of the chat room list. You can later retrieve the list of pinned chat room IDs with getPinnedChatRoomIDs().

// Pin a single chat room
TapCoreRoomListManager.getInstance().pinChatRoom(ROOM_ID, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully pinned chat room
    }

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

    }
});

// Pin multiple chat rooms
TapCoreRoomListManager.getInstance().pinChatRooms(ROOM_IDS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully pinned chat rooms
    }

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

    }
});

Use unpinChatRoom() to remove existing pinned chat room ID from the pinned chat room list.

// Unpin a single chat room
TapCoreRoomListManager.getInstance().unpinChatRoom(ROOM_ID, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully unpinned chat room
    }

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

    }
});

// Unpin multiple chat rooms
TapCoreRoomListManager.getInstance().unpinChatRooms(ROOM_IDS, new TapCommonListener() {
    @Override
    public void onSuccess(String successMessage) {
        // Successfully unpinned chat rooms
    }

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

    }
});

Parameters ROOM_ID: (String) ID of the target room ROOM_IDS: (List<String>) list containing IDs of target rooms

Get Pinned Chat Rooms

You can retrieve the list of the active user's pinned chat room IDs from the server with getPinnedChatRoomIDs().

TapCoreRoomListManager.getInstance().getPinnedChatRoomIDs(new TapCoreGetStringArrayListener() {
    @Override
    public void onSuccess(@NonNull ArrayList<String> pinnedRoomIDs) {
        // Returns list of roomID of the active user's pinned chat rooms
    }
    
    @Override
    public void onError(String errorCode, String errorMessage) {

    }
});
PreviousRoom List - TapUINextChat Room and Messages

Last updated