@livelike/engagementsdk

Index

Enumerations

Interfaces

Variables

Functions

Type aliases

ChatRoomApiStreamEventDetails

ChatRoomApiStreamEventDetails: IApiStreamEventDetails<ChatRoomApiStreamCategory, IChatMessageResponsePayload>

DateTime

DateTime: Date | string | number

IMessageListIteratorResult

IMessageListIteratorResult: Promise<IteratorResult<{ messages: IChatMessageResponsePayload[] }, { messages: IChatMessageResponsePayload[] }>>

IQuoteMessagePropType

IQuoteMessagePropType: IMessageResponsePayload | Omit<IQuoteMessageResponsePayload, "quote_message" | "reactions">

IQuoteMessageRequestPayload

IQuoteMessageRequestPayload: IQuoteMessagePayload & IMessageRequestPayload

IQuoteMessageResponsePayload

IQuoteMessageResponsePayload: IQuoteMessagePayload & IMessageResponsePayload

ListenerFn

ListenerFn<TEvent, TMessage>: (msg: ListenerEventMessage<TEvent, TMessage>) => void

Type parameters

TEvent = any
TMessage = any

Type declaration

- (msg: ListenerEventMessage<TEvent, TMessage>): void
- Parameters
  - msg: ListenerEventMessage<TEvent, TMessage>
  Returns void

MessageListenerCallback

MessageListenerCallback: (args: IMessageListenerCallbackArgs) => unknown

Type declaration

- (args: IMessageListenerCallbackArgs): unknown
- Parameters
  - args: IMessageListenerCallbackArgs
  Returns unknown

MessagePreparationCallback

MessagePreparationCallback: (message: IMessageResponse) => IMessageResponse

Type declaration

- (message: IMessageResponse): IMessageResponse
- Parameters
  - message: IMessageResponse
  Returns IMessageResponse

ReactionSpaceEventListenerMap

ReactionSpaceEventListenerMap: { reaction-space-updated: ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>; user-reaction-added: ListenerFn<ADD_REACTION, IUserReaction>; user-reaction-removed: ListenerFn<REMOVE_REACTION, IUserReaction> }

Type declaration

reaction-space-updated: ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>
user-reaction-added: ListenerFn<ADD_REACTION, IUserReaction>
user-reaction-removed: ListenerFn<REMOVE_REACTION, IUserReaction>

SdkEventListenerMap

SdkEventListenerMap: { INITIALISED: any }

Type declaration

INITIALISED:function
- INITIALISED(userProfile: IUserProfile): void
- Parameters
  - userProfile: IUserProfile
  Returns void

SubscriptionEvent

SubscriptionEvent: { [ k in keyof SubscriptionEventEnums]: SubscriptionEventValuesOf<SubscriptionEventEnums[k]> }[keyof SubscriptionEventEnums]

SubscriptionEventEnums

SubscriptionEventEnums: typeof Events

SubscriptionEventListenerFn

SubscriptionEventListenerFn: ListenerFn<SubscriptionEvent, any>

SubscriptionEventValuesOf

SubscriptionEventValuesOf<E>: E[keyof E]

Type parameters

VideoRoomEventListenerMap

VideoRoomEventListenerMap<ListenerArgs>: { ERROR: any; PARTICIPANT_JOIN: any; PARTICIPANT_LEFT: any; RECONNECTING: any }

Type parameters

ListenerArgs: IEventListenerArgs = IEventListenerArgs

Type declaration

ERROR:function
- ERROR(errorDetails: ListenerArgs["errorDetails"]): void
- Parameters
  - errorDetails: ListenerArgs["errorDetails"]
  Returns void
PARTICIPANT_JOIN:function
- PARTICIPANT_JOIN(participant: ListenerArgs["participant"]): void
- Parameters
  - participant: ListenerArgs["participant"]
  Returns void
PARTICIPANT_LEFT:function
- PARTICIPANT_LEFT(participant: ListenerArgs["participant"]): void
- Parameters
  - participant: ListenerArgs["participant"]
  Returns void
RECONNECTING:function
- RECONNECTING(): void
- Returns void

Variables

ChatUserMessageEventType

ChatUserMessageEventType: readonly [MESSAGE_CREATED, IMAGE_CREATED, MESSAGE_DELETED, IMAGE_DELETED, CHATROOM_UPDATED] = ...

Events

Events: { ADDED: "reactionadded"; DELETED: "messagedeleted"; FAILED: "messagefailed"; MESSAGES: "messagehistory"; RECEIVED: "messagereceived"; REMOVED: "reactionremoved"; ROOMENTER: "roomentered"; ROOMEXIT: "roomexited"; SENT: "messagesent"; UPDATED: "messageupdated" } = ...

Type declaration

ADDED: "reactionadded"
DELETED: "messagedeleted"
FAILED: "messagefailed"
MESSAGES: "messagehistory"
RECEIVED: "messagereceived"
REMOVED: "reactionremoved"
ROOMENTER: "roomentered"
ROOMEXIT: "roomexited"
SENT: "messagesent"
UPDATED: "messageupdated"

MessageEvents

MessageEvents: { added: "reactionadded"; chatroom-updated: "chatroom-updated"; custom-message-created: "messagereceived"; image-created: "messagereceived"; image-deleted: "messagedeleted"; message-created: "messagereceived"; message-deleted: "messagedeleted"; message-sent: "messagesent"; message-updated: "messageupdated"; removed: "reactionremoved" } = ...

Type declaration

added: "reactionadded"
chatroom-updated: "chatroom-updated"
custom-message-created: "messagereceived"
image-created: "messagereceived"
image-deleted: "messagedeleted"
message-created: "messagereceived"
message-deleted: "messagedeleted"
message-sent: "messagesent"
message-updated: "messageupdated"
removed: "reactionremoved"

_$$

_$$: IApiGlobal = ...

_config

_config: { apiDocVersion: string; ready: boolean; version: string } = ...

Type declaration

apiDocVersion: string
ready: boolean
version: string

chatUserMessageEvents

chatUserMessageEvents: ChatMessageEvent[] = ...

subscriptionCoordinator

subscriptionCoordinator: { addListener: (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent) => void; initialisePubnub: (pnConfig: IPubnubConfig) => void; listeners: Record<string, SubscriptionEventListenerFn[]>; removeAllListenersForEvent: (channel: string, event: SubscriptionEvent) => Record<string, SubscriptionEventListenerFn[]>; removeListener: (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent) => Record<string, SubscriptionEventListenerFn[]>; subscribe: (channel: any) => void; unsubscribe: (channel: any) => void } = ...

Type declaration

addListener: (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent) => void
- - (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent): void
  - Parameters
    - channel: string
    - callback: SubscriptionEventListenerFn
    - Optional event: SubscriptionEvent
    Returns void
initialisePubnub: (pnConfig: IPubnubConfig) => void
- - (pnConfig: IPubnubConfig): void
  - Parameters
    - pnConfig: IPubnubConfig
    Returns void
listeners: Record<string, SubscriptionEventListenerFn[]>
removeAllListenersForEvent: (channel: string, event: SubscriptionEvent) => Record<string, SubscriptionEventListenerFn[]>
- - (channel: string, event: SubscriptionEvent): Record<string, SubscriptionEventListenerFn[]>
  - Parameters
    - channel: string
    - event: SubscriptionEvent
    Returns Record<string, SubscriptionEventListenerFn[]>
removeListener: (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent) => Record<string, SubscriptionEventListenerFn[]>
- - (channel: string, callback: SubscriptionEventListenerFn, event?: SubscriptionEvent): Record<string, SubscriptionEventListenerFn[]>
  - Parameters
    - channel: string
    - callback: SubscriptionEventListenerFn
    - Optional event: SubscriptionEvent
    Returns Record<string, SubscriptionEventListenerFn[]>
subscribe: (channel: any) => void
- - (channel: any): void
  - Parameters
    - channel: any
    Returns void
unsubscribe: (channel: any) => void
- - (channel: any): void
  - Parameters
    - channel: any
    Returns void

userProfile

userProfile: IUserProfile = ...

Functions

addChatRoomEventListener

addChatRoomEventListener<_Event, _EventListener>(chatRoomEvent: _Event, listenerFn: _EventListener, options: IChatRoomEventListenerOptions): Promise<void>

description

Add listener for the given ChatRoomEvent, pass options based on the events

since

0.1.0

example

addChatRoomEventListener(ChatRoomEvent.INVITE_NEW_MEMBER, function onReceieveChatRoomInvitationListener(invitationEvent){
 console.log(invitation);
})
// for adding Invite new member event listener
addChatRoomEventListener(ChatRoomEvent.INVITE_NEW_MEMBER, function onReceieveChatRoomInvitationListener(invitationEvent){
 console.log(invitation);
})
// for adding pin message event listener
addChatRoomEventListener(
   ChatRoomEvent.PIN_MESSAGE,
   function onReceivedPinMessageListener (pinMessageInfoEvent) { console.log(pinMessageInfoEvent)},
   { roomId: "695ea6f4-fe7b-47cc-817c-2d73fdba264a" }
);

Type parameters

_Event: ChatRoomEvent
_EventListener: ListenerFn<ADD_NEW_MEMBER, IChatRoomMembership> | ListenerFn<INVITE_NEW_MEMBER, IChatRoomInvitation> | ListenerFn<PIN_MESSAGE, IPinMessageInfo> | ListenerFn<UNPIN_MESSAGE, IUnpinEventMessageType> | ListenerFn<CHATROOM_UPDATED, IChatRoomPayload>

Parameters

chatRoomEvent: _Event
listenerFn: _EventListener
options: IChatRoomEventListenerOptions

Returns Promise<void>

Const addMessageListener

addMessageListener(arg: { roomId: string }, callback: MessageListenerCallback): Promise<void>

Adds a listener to a chatroom that calls passed callback function when event fires.
since
0.1.0

example
```
addMessageListener({roomId: string}, function(e){console.log(e)})
```
Parameters
- arg: { roomId: string }
  - roomId: string
- callback: MessageListenerCallback
Returns Promise<void>

addNewMemberToChatRoom

addNewMemberToChatRoom(chatRoomAddMember: IChatRoomAddMemberArgs): Promise<IChatRoomMembership>

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

async
since
0.1.0

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

addReactionSpaceEventListener

addReactionSpaceEventListener<_Event, _EventListener>(eventArg: IReactionEventArg<_Event>, listenerFn: _EventListener): Promise<void>

description
Add listener for a given event type occuring in a reactionSpaceId

async
since
0.1.0

example
```
 function onUserReaction(eventDetail){
  console.log(eventDetail);
 }
addReactionSpaceEventListener({
   event: ReactionSpaceEvent.ADD_REACTION,
   reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
 },
onUserReaction
)
```
Type parameters
- _Event: ReactionSpaceEvent
- _EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>
Parameters
- eventArg: IReactionEventArg<_Event>
- listenerFn: _EventListener
Returns Promise<void>

addSdkEventListener

addSdkEventListener<_Event, ListenerFn>(sdkEvent: _Event, listenerFn: ListenerFn): void

description
Add listener for a given SdkEvent

since
0.1.0

example
```
addSdkEventListener(SdkEvent.INITIALISED, function onSdkInitialisation(userProfile){
 console.log(userProfile);
})
```
Type parameters
- _Event: INITIALISED
- ListenerFn: (userProfile: IUserProfile) => void
Parameters
- sdkEvent: _Event
- listenerFn: ListenerFn
Returns void

addUserProfileEventListener

addUserProfileEventListener(userProfileEvent: UserProfileEvent, listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>): void

description
Add listener for the given UserProfileEvent

since
0.1.0

example
```
addUserProfileEventListener(UserProfileEvent.BLOCK_PROFILE, function onBlockProfileListener(blockInfo){
 console.log(blockInfo);
})
```
Parameters
- userProfileEvent: UserProfileEvent
- listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void

addUserReaction

addUserReaction(arg: IAddUserReactionArg): Promise<IUserReaction>

description

Add a user reaction

async

since

0.1.0

example

addUserReaction({
 targetId: "target-1",
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 reactionId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
}).then(reaction => console.log(reaction))

Parameters

arg: IAddUserReactionArg

Returns Promise<IUserReaction>

blockProfile

blockProfile(args: IBlockProfileArgs): Promise<IBlockInfo>

description
Block profile using profile Id

async
since
0.1.0

example
```
blockProfile({profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(blockInfo => console.log(blockInfo))
```
Parameters
- args: IBlockProfileArgs
Returns Promise<IBlockInfo>

Const createChatRoom

createChatRoom(args: IChatRoomCreationArgs): Promise<IChatRoomPayload>

description
Creates a new chat room

async
since
0.1.0
- createChatRoom({title: "Chat room name", content_filter: "filtered", visibility: "everyone"})
Parameters
- args: IChatRoomCreationArgs
Returns Promise<IChatRoomPayload>
Promise

createReactionSpace

createReactionSpace(arg: ICreateReactionSpaceArg): Promise<IReactionSpace>

description

Create a reaction space

async

since

0.1.0

example

createReactionSpace({
 targetGroupId: "target-group-1",
 reactionPackIds: ["aa7e03fc-01f0-4a98-a2e0-3fed689632d7", "0fddc166-b8c3-4ce9-990e-848bde12188b"]
}).then(reactionSpace => console.log(reactionSpace))

Parameters

arg: ICreateReactionSpaceArg

Returns Promise<IReactionSpace>

Const createUserProfile

createUserProfile(args: { nickname?: string }): Promise<IUserProfile>

Creates user profile. If no nickname argument is passed, a random nickname will be generated.
async
since
0.1.0

example
```
createUserProfile({ nickname: 'Test Nickname' }).then(profile => console.log(profile))
```
Parameters
- args: { nickname?: string }
  - Optional nickname?: string
    
    Optional nickname
Returns Promise<IUserProfile>

deleteChatRoomInvitation

deleteChatRoomInvitation(args: IDeleteChatRoomInvitationArgs): Promise<void>

description
Delete chat room invitation

params
args of type IDeleteChatRoomInvitation

async
since
0.1.0

example
```
deleteChatRoomInvitation({
 invitationId: "28cc0ceb-8934-48cd-abc5-4d3a3a681c1b",
}).then(res => console.log(res))
```
Parameters
- args: IDeleteChatRoomInvitationArgs
Returns Promise<void>
Promise

Const deleteMessage

deleteMessage(args: IDeleteMessageArgs): Promise<void>

description

Delete a chatroom message using messageId

since

0.1.0

async

example

deleteMessage({
 roomId: "a147f914-d474-4cfb-81c6-4099404c435a",
 messageId: "dd810f9f-09d5-4c6b-a0df-e43dee9b2994"
}).then((res) => console.log(res))

Parameters

args: IDeleteMessageArgs

Returns Promise<void>

deleteReactionSpace

deleteReactionSpace(arg: IReactionSpaceIdArg): Promise<null>

description
Delete a reaction space

async
since
0.1.0

example
```
deleteReactionSpace({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
})
```
Parameters
- arg: IReactionSpaceIdArg
Returns Promise<null>

getBlockInfoList

getBlockInfoList(): Promise<IPaginatedResponse<IBlockInfo>>

description
Get Block Info list containing list of block info of all the blocked profile

async
since
0.1.0

example
```
getBlockInfoList().then(paginatedBlockInfo => console.log(paginatedBlockInfo))
```
Returns Promise<IPaginatedResponse<IBlockInfo>>

getBlockedProfileIds

getBlockedProfileIds(): Promise<IPaginatedResponse<string>>

description
Get list of blocked profile ids, could be used to filter chat messages by blocked profile

async
since
0.1.0

example
```
getBlockedProfileIds().then(profileIds => console.log(profileIds))
```
Returns Promise<IPaginatedResponse<string>>

Const getChatRoom

getChatRoom(args: IChatRoomArgs): Promise<IChatRoomPayload>

description
Gets chat room by roomId

async
since
0.1.0
```
getChatRoom({roomId: 'c1f6082c-f7b9-4d1e-b64e-9071a3860ffc'}).then((res) => console.log(res))
```
Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomPayload>
Promise

Const getChatRoomMemberships

getChatRoomMemberships(args: IChatRoomArgs): Promise<IChatRoomMembershipsResponse>

description
Get list of users that are a 'member' of given chatroom.

async
since
0.1.0

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomMembershipsResponse>
Promise

Const getChatRooms

getChatRooms(): Promise<IPaginatedResponse<IChatRoomPayload>>

description
Get all avaliable chat rooms in an application

async
since
0.1.0

example
```
getChatRooms().then(paginatedResponse => console.log(paginatedResponse))
```
Returns Promise<IPaginatedResponse<IChatRoomPayload>>
paginated response with results as an array of chat room details

Const getChatUserMutedStatus

getChatUserMutedStatus(args: IChatRoomArgs): Promise<IMutedResponse>

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

async
since
0.1.0

Parameters
- args: IChatRoomArgs
Returns Promise<IMutedResponse>
Promise - true if muted else false

getGifs

getGifs(arg: IGetGifArg): Promise<IPaginatedResponse<IGif>>

description
Get list of gifs images

async
since
0.1.0

example
```
getGifs({search: "thank you"}).then(({results}) => console.log(results))
```
Parameters
- arg: IGetGifArg
Returns Promise<IPaginatedResponse<IGif>>
paginated response with results as an array of IGif

Const getMessageCount

getMessageCount(roomId: string, opts?: IMessageCountOptions): Promise<IMessageCount>

getMessageCount Returns number of messages in chat room
since
0.1.0

async
example
```
getMessageCount('c1f6082c-f7b9-4d1e-b64e-9071a3860ffc', {since: "2020-04-16T16:29:39.158Z"}).then(r => console.log(r.count))
```
Parameters
- roomId: string
- Optional opts: IMessageCountOptions
Returns Promise<IMessageCount>

Const getMessageList

getMessageList(roomId: string, opts?: IMessageListOptions): Promise<IMessageListPayload>

getMessageList Returns array of message objects
since
0.1.0

async
example
```
getMessageList(roomId: string).then(list => console.log(list))
```
Parameters
- roomId: string
- opts: IMessageListOptions = {}
Returns Promise<IMessageListPayload>

getProfileBlockInfo

getProfileBlockInfo(args: IProfileBlockInfoArgs): Promise<IBlockInfo | undefined>

description
Get Block Info for given profile id if exists

async
since
0.1.0

example
```
getProfileBlockInfo({profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(blockInfo => console.log(blockInfo))
```
Parameters
- args: IProfileBlockInfoArgs
Returns Promise<IBlockInfo | undefined>

Const getProfileChatRoomMemberships

getProfileChatRoomMemberships(): Promise<IProfileChatRoomMembershipResponse>

description
Get list of chat rooms that the current user is a 'member' of.

async
since
0.1.0

Returns Promise<IProfileChatRoomMembershipResponse>
Promise

getReactionPackDetail

getReactionPackDetail(arg: IGetReactionPackDetailArg): Promise<IReactionPack>

description
Get reaction pack detail with collection of reactions using a reaction pack Id

async
since
0.1.0

example
```
getReactionPackDetail({
 reactionPackId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
}).then(reactionPack => console.log(reactionPack))
```
Parameters
- arg: IGetReactionPackDetailArg
Returns Promise<IReactionPack>

getReactionPacks

getReactionPacks(): Promise<IPaginatedResponse<IReactionPack>>

description
Get list of reaction packs in an application

async
since
0.1.0

example
```
getReactionPacks().then(({results}) => console.log(results))
```
Returns Promise<IPaginatedResponse<IReactionPack>>

getReactionSpaceDetail

getReactionSpaceDetail(arg: IReactionSpaceDetailArg): Promise<IReactionSpace>

description

Get reaction space detail from reactionSpaceId or targetGroupId

async

since

0.1.0

example

getReactionSpaceDetail({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
}).then(reactionSpace => console.log(reactionSpace))

OR

getReactionSpaceDetail({
 targetGroupId: "target-group-1",
}).then(reactionSpace => console.log(reactionSpace))

Parameters

arg: IReactionSpaceDetailArg

Returns Promise<IReactionSpace>

getReactionSpaces

getReactionSpaces(): Promise<IPaginatedResponse<IReactionSpace>>

description
Get list of reaction spaces in an application

async
since
0.1.0

example
```
getReactionSpaces().then(({results}) => console.log(results))
```
Returns Promise<IPaginatedResponse<IReactionSpace>>

getReceivedChatRoomInvitations

getReceivedChatRoomInvitations(args: IGetInvitationsArgs): Promise<IPaginatedResponse<IChatRoomInvitation>>

description
Get list of chat room invitations received by the current user profile

params
args of type IGetInvitationsArgs

async
since
0.1.0

example
```
getReceivedChatRoomInvitations({
 invitationStatus: ChatRoomInvitationStatus.PENDING
}).then(paginatedInvitations => console.log(paginatedInvitations))
```
Parameters
- args: IGetInvitationsArgs
Returns Promise<IPaginatedResponse<IChatRoomInvitation>>
Promise<IPaginatedResponse>

getSentChatRoomInvitations

getSentChatRoomInvitations(args: IGetInvitationsArgs): Promise<IPaginatedResponse<IChatRoomInvitation>>

description
Get list of chat room invitations sent by the current user profile

params
args of type IGetInvitationsArgs

async
since
0.1.0

example
```
getSentChatRoomInvitations({
 invitationStatus: ChatRoomInvitationStatus.PENDING
}).then(paginatedInvitations => console.log(paginatedInvitations))
```
Parameters
- args: IGetInvitationsArgs
Returns Promise<IPaginatedResponse<IChatRoomInvitation>>
Promise<IPaginatedResponse>

getStickerPackDetail

getStickerPackDetail(arg: IGetStickerPackDetailArg): Promise<IStickerPack>

description
Get sticker pack detail with collection of stickers using a stickerPackId

async
since
0.1.0

example
```
getStickerPackDetail({
 stickerPackId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
}).then(stickerPack => console.log(stickerPack))
```
Parameters
- arg: IGetStickerPackDetailArg
Returns Promise<IStickerPack>

getStickerPacks

getStickerPacks(): Promise<IPaginatedResponse<IStickerPack>>

description
Get list of sticker packs in an application

async
since
0.1.0

example
```
getStickerPacks().then(({results}) => console.log(results))
```
Returns Promise<IPaginatedResponse<IStickerPack>>
paginated response with results as an array of IStickerPack

Const getUserProfile

getUserProfile(args: { accessToken?: string; profileId?: string }): Promise<IUserProfile>

Gets userProfile from accessToken.
async
since
0.1.0

example
```
getUserProfile({ accessToken }).then(profile => console.log(profile))
```
Parameters
- args: { accessToken?: string; profileId?: string }
  - Optional accessToken?: string
  - Optional profileId?: string
Returns Promise<IUserProfile>

getUserReactions

getUserReactions(arg: IGetUserReactionsArg): Promise<IPaginatedResponse<IUserReaction>>

description

Get list of user reaction based on argument object filters

async

since

0.1.0

example

getUserReactions({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 targetId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
}).then(paginatedReactions => console.log(paginatedReactions))

Parameters

arg: IGetUserReactionsArg

Returns Promise<IPaginatedResponse<IUserReaction>>

getUserReactionsCount

getUserReactionsCount(arg: IGetUserReactionsCountArg): Promise<IPaginatedResponse<IReactionsCount>>

description
get count of user reactions for a given collection of target in a reaction space

async
since
0.1.0

example
```
getUserReactionsCount({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 targetIds: ["0fddc166-b8c3-4ce9-990e-848bde12188b"],
}).then(reaction => console.log(reaction))
```
Parameters
- arg: IGetUserReactionsCountArg
Returns Promise<IPaginatedResponse<IReactionsCount>>

init

init(args: ICoreInitApiArgs): Promise<IUserProfile>

Parameters
- args: ICoreInitApiArgs
Returns Promise<IUserProfile>

isChatMessageResponsePayload

isChatMessageResponsePayload(message: any): message is IChatMessageResponsePayload

Parameters
- message: any
Returns message is IChatMessageResponsePayload

isChatUserMessageResponsePayload

isChatUserMessageResponsePayload(message: ICustomMessageResponsePayload | IChatUserMessageResponsePayload): message is IChatUserMessageResponsePayload

Parameters
- message: ICustomMessageResponsePayload | IChatUserMessageResponsePayload
Returns message is IChatUserMessageResponsePayload

isCustomMessageResponsePayload

isCustomMessageResponsePayload(message: ICustomMessageResponsePayload | IChatUserMessageResponsePayload): message is ICustomMessageResponsePayload

Parameters
- message: ICustomMessageResponsePayload | IChatUserMessageResponsePayload
Returns message is ICustomMessageResponsePayload

isQuoteMessagePayload

isQuoteMessagePayload(message: IChatMessageResponsePayload | IChatMessageRequestPayload): message is IQuoteMessageResponsePayload | IQuoteMessageRequestPayload

Parameters
- message: IChatMessageResponsePayload | IChatMessageRequestPayload
Returns message is IQuoteMessageResponsePayload | IQuoteMessageRequestPayload

Const joinChatRoom

joinChatRoom(args: IChatRoomArgs): Promise<IChatRoomMembership>

description
Join chat room by roomId, current user becomes 'member' and is available in chatroom membership list

async
since
0.1.0

example
```
joinChatRoom({roomId: 'c1f6082c-f7b9-4d1e-b64e-9071a3860ffc'})
```
Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomMembership>
Promise

Const leaveChatRoom

leaveChatRoom(args: IChatRoomArgs): Promise<boolean>

description
Leave chat room by roomId, current user 'member' status removed from chatroom membership list

async
since
0.1.0

example
```
leaveChatRoom({roomId: 'c1f6082c-f7b9-4d1e-b64e-9071a3860ffc'})
```
Parameters
- args: IChatRoomArgs
Returns Promise<boolean>
Promise - true if leaved else false

Const prepareOutgoingChatMessage

prepareOutgoingChatMessage(roomId: string, preparationCallback: MessagePreparationCallback): MessagePreparationCallback

Parameters
- roomId: string
- preparationCallback: MessagePreparationCallback
Returns MessagePreparationCallback

removeChatRoomEventListener

removeChatRoomEventListener<_Event, _EventListener>(chatRoomEvent: _Event, listenerFn: _EventListener, options: IChatRoomEventListenerOptions): Promise<void>

description
Remove registered listenerFn for the given ChatRoomEvent, pass options based on the events when no listener passed, all registered event listener will be removed

since
0.1.0

example
```
// for removing Invite new member event listener
removeChatRoomEventListener(ChatRoomEvent.INVITE_NEW_MEMBER, onReceieveChatRoomInvitationListener);
// for removing pin message event listener
removeChatRoomEventListener(
   ChatRoomEvent.PIN_MESSAGE,
   onReceivedPinMessageListener,
   { roomId: "695ea6f4-fe7b-47cc-817c-2d73fdba264a" }
);
```
Type parameters
- _Event: ChatRoomEvent
- _EventListener: ListenerFn<ADD_NEW_MEMBER, IChatRoomMembership> | ListenerFn<INVITE_NEW_MEMBER, IChatRoomInvitation> | ListenerFn<PIN_MESSAGE, IPinMessageInfo> | ListenerFn<UNPIN_MESSAGE, IUnpinEventMessageType> | ListenerFn<CHATROOM_UPDATED, IChatRoomPayload>
Parameters
- chatRoomEvent: _Event
- listenerFn: _EventListener
- options: IChatRoomEventListenerOptions
Returns Promise<void>

Const removeMessageListener

removeMessageListener(arg: IChatRoomArgs, callback: MessageListenerCallback): Promise<void>

Removes listener from chatroom
since
0.1.0

example
```
removeMessageListener({roomId: string}, function(e){console.log(e)})
```
Parameters
- arg: IChatRoomArgs
- callback: MessageListenerCallback
Returns Promise<void>

removeReactionSpaceEventListener

removeReactionSpaceEventListener<_Event, _EventListener>(eventArg: IReactionEventArg<_Event>, listenerFn?: _EventListener): Promise<void>

description
Remove listener for a given event type occuring in a reactionSpaceId if no listener function passed, remove all the listeners function for a given event type

async
since
0.1.0

example
```
function onUserReaction(eventDetail){
  console.log(eventDetail);
}
removeReactionSpaceEventListener({
   event: ReactionSpaceEvent.ADD_REACTION,
   reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
 },
onUserReaction
)
```
Type parameters
- _Event: ReactionSpaceEvent
- _EventListener: ListenerFn<ADD_REACTION, IUserReaction> | ListenerFn<REMOVE_REACTION, IUserReaction> | ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>
Parameters
- eventArg: IReactionEventArg<_Event>
- Optional listenerFn: _EventListener
Returns Promise<void>

removeSdkEventListener

removeSdkEventListener<_Event, ListenerFn>(sdkEvent: _Event, listenerFn: ListenerFn): void

description
Remove registered listenerFn for the given SdkEvent, when no listener passed, all registered event listener will be removed

since
0.1.0

example
```
removeSdkEventListener(SdkEvent.INITIALISED, onSdkInitialisation);
```
Type parameters
- _Event: INITIALISED
- ListenerFn: (userProfile: IUserProfile) => void
Parameters
- sdkEvent: _Event
- listenerFn: ListenerFn
Returns void

removeUserProfileEventListener

removeUserProfileEventListener(userProfileEvent: UserProfileEvent, listenerFn?: ListenerFn<UserProfileEvent, IBlockInfo>): void

description
Remove registered listenerFn for the given UserProfileEvent, when no listener passed, all registered event listener will be removed

since
0.1.0

example
```
removeUserProfileEventListener(UserProfileEvent.BLOCK_PROFILE, onBlockProfileListener);
```
Parameters
- userProfileEvent: UserProfileEvent
- Optional listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void

removeUserReaction

removeUserReaction(arg: IRemoveUserReactionArg): Promise<null>

description

Remove a user reaction

async

since

0.1.0

example

removeUserReaction({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 userReactionId: "0fddc166-b8c3-4ce9-990e-848bde12188b"
})

Parameters

arg: IRemoveUserReactionArg

Returns Promise<null>

Const reportMessage

reportMessage(args: IReportChatMessageArgs): Promise<IReportChatMessageResponse>

description

Report Chat Message

since

0.1.0

async

example

reportMessage({
 roomId: "a147f914-d474-4cfb-81c6-4099404c435a",
 profileId: "c1ca9590-81d9-4da2-8d4f-85b24a35f81f",
 nickname: "Jon Doe",
 messageId: "d145e2f1-36df-4c5a-8157-078cbf366297",
}).then((res) => console.log(res));

Parameters

args: IReportChatMessageArgs

Returns Promise<IReportChatMessageResponse>

sendChatRoomInviteToProfile

sendChatRoomInviteToProfile(args: IChatRoomAddMemberArgs): Promise<IChatRoomInvitation>

description

Send chat room invite to profile (user)

params

args of type ISendChatRoomInviteArgs

async

since

0.1.0

example

sendChatRoomInviteToProfile({
 roomId: "9e6f1bc4-9f02-4c57-92b7-7521d0f5b027",
 profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"
}).then(chatRoomInvitation => console.log(chatRoomInvitation))

Parameters

args: IChatRoomAddMemberArgs

Returns Promise<IChatRoomInvitation>

Promise

Const sendCustomMessage

sendCustomMessage(args: ISendCustomMessageArgs): Promise<ICustomMessageResponsePayload>

sendCustomMessage Send custom message to chat room.
since
0.1.0

async
example
```
sendCustomMessage({custom_data: 'Test message', roomId: 'c1f6082c-f7b9-4d1e-b64e-9071a3860ffc'})
```
Parameters
- args: ISendCustomMessageArgs
Returns Promise<ICustomMessageResponsePayload>

Const sendMessage

sendMessage(args: ISendMessageArgs): Promise<IMessageResponsePayload>

sendMessage Send user message to chat room.
async
since
0.1.0

example
```
sendMessage({message: 'Test message', roomId: 'c1f6082c-f7b9-4d1e-b64e-9071a3860ffc'})
```
Parameters
- args: ISendMessageArgs
Returns Promise<IMessageResponsePayload>

unblockProfile

unblockProfile(args: IUnblockProfileArgs): Promise<any>

description
Unblock profile using Block Info id for a given blocked profile, use getProfileBlockInfo or getBlockInfoList to get corresponding profile block info id

async
since
0.1.0

example
```
unblockProfile({blockId: "c327a72c-94e5-4f5a-bcef-16ee84d35077"}).then(response => console.log(response))
```
Parameters
- args: IUnblockProfileArgs
Returns Promise<any>

Const updateChatRoom

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

description

Updates chat room by id

async

since

0.1.0

updateChatRoom("5c9974ba-2180-4640-b949-eb9501d2f2ff", {
  title: "new title",
  content_filter: "none",
  visibility: "everyone",
}).then((res) => console.log(res));

Parameters

roomId: string

a string representing the Chat Room Id
args: IChatRoomCreationArgs

Returns Promise<IChatRoomPayload>

Promise

updateChatRoomInviteStatus

updateChatRoomInviteStatus(args: IUpdateChatRoomInvitationStatusArgs): Promise<IChatRoomInvitation>

description
Updates chat room invitation status

params
args of type IUpdateChatRoomInvitationStatusArgs

async
since
0.1.0

example
```
updateChatRoomInviteStatus({
 invitationId: "28cc0ceb-8934-48cd-abc5-4d3a3a681c1b",
 invitationStatus: ChatRoomInvitationStatus.ACCEPTED
}).then(chatRoomInvitation => console.log(chatRoomInvitation))
```
Parameters
- args: IUpdateChatRoomInvitationStatusArgs
Returns Promise<IChatRoomInvitation>
Promise

updateReactionSpace

updateReactionSpace(arg: IUpdateReactionSpaceArg): Promise<IReactionSpace>

description

Update a reaction space with reaction pack ids or reaction space name

async

since

0.1.0

example

updateReactionSpace({
 reactionSpaceId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 reactionPackIds: ["aa7e03fc-01f0-4a98-a2e0-3fed689632d7", "0fddc166-b8c3-4ce9-990e-848bde12188b"]
}).then(reactionSpace => console.log(reactionSpace))

Parameters

arg: IUpdateReactionSpaceArg

Returns Promise<IReactionSpace>

Const updateUserProfile

updateUserProfile(args: { accessToken: string; options?: { custom_data?: string; nickname?: string } }): Promise<IUserProfile>

Updates profile by accessToken with optional changed nickname or custom_data.
async
since
0.1.0

example
```
const options = {nickname: 'New Nickname'}
updateUserProfile({accessToken, options}).then(profile => console.log(profile))
```
Parameters
- args: { accessToken: string; options?: { custom_data?: string; nickname?: string } }
  - accessToken: string
    
    userProfile access_token
  - Optional options?: { custom_data?: string; nickname?: string }
    - Optional custom_data?: string
      
      Data saved to profile's custom_data property
    - Optional nickname?: string
      
      The nickname to update the userProfile
Returns Promise<IUserProfile>

Const uploadImage

uploadImage(args: IUploadImageArgs): Promise<IUploadImageResponse>

description

Upload a image to get image url for sending image message

since

0.1.0

async

example

// For Web usage
// get the image blob data from image uri, uri could be local file uri
const imageBlob = await fetch(imageUri).then(res => res.blob())
// create formdata and append  "type" and "image" keys
const imageFormData = new FormData();
imageFormData.append('type', 'file')
imageFormData.append('image', imageBlob)

const { image_url } = await uploadImage({
 roomId: "a147f914-d474-4cfb-81c6-4099404c435a",
 imageFormData: imageFormData
});

Parameters

args: IUploadImageArgs

Returns Promise<IUploadImageResponse>

Generated using TypeDoc

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

ChatRoomApiStreamEventDetails

DateTime

IChatMessageRequestPayload

IChatMessageResponsePayload

IChatRoomApiStreamResponse

IChatUserMessageResponsePayload

IMessageListIteratorResult

IQuoteMessagePropType

IQuoteMessageRequestPayload

IQuoteMessageResponsePayload

ListenerFn

Type parameters

TEvent = any

TMessage = any

Type declaration

Parameters

msg: ListenerEventMessage<TEvent, TMessage>

Returns void

MessageListenerCallback

Type declaration

Parameters

args: IMessageListenerCallbackArgs

Returns unknown

MessagePreparationCallback

Type declaration

Parameters

message: IMessageResponse

Returns IMessageResponse

ReactionSpaceEventListenerMap

Type declaration

reaction-space-updated: ListenerFn<UPDATE_REACTION_SPACE, IReactionSpace>

user-reaction-added: ListenerFn<ADD_REACTION, IUserReaction>

user-reaction-removed: ListenerFn<REMOVE_REACTION, IUserReaction>

SdkEventListenerMap

Type declaration

INITIALISED:function

Parameters

userProfile: IUserProfile

Returns void

SubscriptionEvent

SubscriptionEventEnums

SubscriptionEventListenerFn

SubscriptionEventValuesOf

Type parameters

E

VideoRoomEventListenerMap

Type parameters

ListenerArgs: IEventListenerArgs = IEventListenerArgs

Type declaration

ERROR:function

Parameters

errorDetails: ListenerArgs["errorDetails"]

Returns void

PARTICIPANT_JOIN:function

Parameters

participant: ListenerArgs["participant"]

Returns void

PARTICIPANT_LEFT:function

Parameters

participant: ListenerArgs["participant"]

Returns void

RECONNECTING:function

Returns void

Variables

ChatUserMessageEventType

Events

Type declaration

ADDED: "reactionadded"

DELETED: "messagedeleted"

FAILED: "messagefailed"

MESSAGES: "messagehistory"

RECEIVED: "messagereceived"

REMOVED: "reactionremoved"