Room List
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 |
Get Updated Room List | Call this method to fetch the latest room list data from the server and update to the local cache |
Get Room List by XC User ID | Call this method to get room list by XC User ID |
Get Personal Chat Room with User Model | Call this method to get personal chat room model with user model. |
Get User by ID | Call this method to get user data by ID |
Remove Chat Room by Room ID | Call this method to remove single room from room list |
Call this method to retrieve the latest room list data from the server.
JavaScript
tapCoreRoomListManager.getUpdatedRoomList({
onSuccess: (roomLists) => {
// do action here
},
})
Call this method to get room list by XC User ID
JavaScript
tapCoreRoomListManager.getRoomByXcID(xcRoomID, {
onSuccess: (response) => {
// do action here
},
onError: (errorCode, errorMessage) => {
// do action here
}
})
Call this method to get personal chat room model with user model.
JavaScript
var roomModel = tapCoreRoomListManager.getPersonalChatRoomWithUser(userModel)
Call this method to get user data by ID
JavaScript
tapCoreRoomListManager.getUserByIdFromApi(userID, {
onSuccess: (response) => {
// do action here
},
onError: (errorCode, errorMessage) => {
// do action here
}
})
Call this method to remove single room from room list
JavaScript
tapCoreRoomListManager.removeChatRoomByRoomID(roomID)
Fetch all muted rooms
JavaScript
tapCoreRoomListManager.getMutedRooms((res) =>
// do action here
})
Parameters
CALLBACK: (Method) callback methodSet mute rooms
JavaScript
tapCoreRoomListManager.setMutedRooms(ROOM_ID, EXPIRED_AT, (res) =>
// do action here
})
Parameters
ROOM_ID
: (Array) array of roomID
EXPIRED_AT : (Number) timestamp of expired time
CALLBACK: (Method) callback methodUnset muted rooms
JavaScript
tapCoreRoomListManager.unsetMutedRooms(ROOM_ID, (res) =>
// do action here
})
Parameters
ROOM_ID
: (Array) array of roomID
CALLBACK: (Method) callback methodFetch all pinned rooms
JavaScript
tapCoreRoomListManager.getPinnedRoomID((res) =>
// do action here
})
Parameters
CALLBACK: (Method) callback methodSet pin rooms
JavaScript
tapCoreRoomListManager.pinRoom(ROOM_ID, (res) =>
// do action here
})
Parameters
ROOM_ID
: (Array) array of roomID
CALLBACK: (Method) callback methodUnset pinned rooms
JavaScript
tapCoreRoomListManager.unpinRoom(ROOM_ID, (res) =>
// do action here
})
Parameters
ROOM_ID
: (Array) array of roomID
CALLBACK: (Method) callback methodLast modified 7mo ago