chatRoom | @livelike/engagementsdk - v2.53.0-alpha.0

API
Elements

Index

Interfaces

IMutedResponse

Functions

Functions

addNewMemberToChatRoom

addNewMemberToChatRoom(chatRoomAddMember: IChatRoomAddMemberArgs): Promise<IChatRoomMembership>

description
Add new member to the chat room (requires roomId and profileId)

example
```
addNewMemberToChatRoom({
 roomId: "9e6f1bc4-9f02-4c57-92b7-7521d0f5b027",
 profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
}).then(membership => console.log(membership))
```
Parameters
- chatRoomAddMember: IChatRoomAddMemberArgs
  
  args of type IChatRoomAddMemberArgs
Returns Promise<IChatRoomMembership>
Promise

createChatRoom

createChatRoom(args: IChatRoomCreationArgs): Promise<IChatRoomPayload>

Creates a new chat room

async
since
1.20

Parameters
- args: IChatRoomCreationArgs
Returns Promise<IChatRoomPayload>

getChatRoom

getChatRoom(args: IChatRoomArgs): Promise<IChatRoomPayload>

Gets chat room by roomId

async
since
1.20

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomPayload>

getChatRoomMemberships

getChatRoomMemberships(args: IGetChatRoomMembershipsArgs): Promise<IChatRoomMembershipsResponse>

description
Get list of chatroom memberships corresponding to each profile who are member of a chatroom.

async
since
1.20

Parameters
- args: IGetChatRoomMembershipsArgs
Returns Promise<IChatRoomMembershipsResponse>

getChatUserMutedStatus

getChatUserMutedStatus(args: IChatRoomArgs): Promise<IMutedResponse>

Gets the muted status of the current user for a given chat room

async
since
2.2.0

Parameters
- args: IChatRoomArgs
Returns Promise<IMutedResponse>

getProfileChatRoomMemberships

getProfileChatRoomMemberships(args: IGetProfileChatRoomMembershipsArgs): Promise<IPaginatedResponse<IProfileChatRoomMembership>>

description
Get list of chatroom memberships for current profile, if profileIds are passed, it returns memberships corresponding to common chatroom(s) among all given profileIds.

async
since
1.20

Parameters
- args: IGetProfileChatRoomMembershipsArgs
Returns Promise<IPaginatedResponse<IProfileChatRoomMembership>>

getTokenGatedChatRoomAccessDetails

getTokenGatedChatRoomAccessDetails(GatedChatRoomAccessDetailsArgs: IGetTokenGatedChatRoomAccessDetailsArgs): Promise<ITokenGatedChatRoomAccessDetails>

description
Get token-gated chat room access details

since
2.42.0

Parameters
- GatedChatRoomAccessDetailsArgs: IGetTokenGatedChatRoomAccessDetailsArgs
  
  args of type IGetTokenGatedChatRoomAccessDetailsArgs
Returns Promise<ITokenGatedChatRoomAccessDetails>
Promise

joinChatRoom

joinChatRoom(args: IChatRoomArgs): Promise<IChatRoomMembership>

Join chat room by roomId, current user becomes 'member' and is available in chatroom membership list through LiveLike.getChatRoomMemberships().

async
since
1.20

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomMembership>

leaveChatRoom

leaveChatRoom(args: IChatRoomArgs): Promise<boolean>

Leave chat room by roomId, current user 'member' status removed from chatroom membership list through LiveLike.getChatRoomMemberships().

async
since
1.20

Parameters
- args: IChatRoomArgs
Returns Promise<boolean>

updateChatRoom

updateChatRoom(roomId: string, args: IChatRoomCreationArgs): Promise<IChatRoomPayload>

Updates chat room by id

async
since
1.20

Parameters
- roomId: string
- args: IChatRoomCreationArgs
Returns Promise<IChatRoomPayload>

Generated using TypeDoc