@livelike/engagementsdk

Index

Namespaces

<internal>

Interfaces

Functions

Type aliases

ChatRoomApiStreamEventDetails

ChatRoomApiStreamEventDetails: IApiStreamEventDetails<ChatRoomApiStreamCategory, IChatMessageResponsePayload>

CreateWidgetInteractionItemProp

CreateWidgetInteractionItemProp: IWidgetOptionItem | IWidgetChoiceItem | ITextAskInteractionItem | ISliderInteractionItem | INumberPredictionItem

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

InteractiveWidgetKind

InteractiveWidgetKind: typeof interactiveWidgets[number]

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

ProgramListenerCallback

ProgramListenerCallback: (args: IProgramListenerCallbackArgs) => unknown

Type declaration

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

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

WidgetListenerCallback

WidgetListenerCallback: (args: IWidgetListenerCallbackArgs) => unknown

Type declaration

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

Variables

CHOICE_WIDGET_KIND

CHOICE_WIDGET_KIND: WidgetKind[] = ...

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"

InteractableWidgetKind

InteractableWidgetKind: readonly [TEXT_ASK, EMOJI_SLIDER, CHEER_METER, TEXT_POLL, IMAGE_POLL, TEXT_QUIZ, IMAGE_QUIZ, TEXT_PREDICTION, IMAGE_PREDICTION, TEXT_NUMBER_PREDICTION, IMAGE_NUMBER_PREDICTION] = ...

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"

PREDICTION_FOLLOW_UP_TO_PREDICTION

PREDICTION_FOLLOW_UP_TO_PREDICTION: { image-number-prediction-follow-up: WidgetKind; image-prediction-follow-up: WidgetKind; text-prediction-follow-up: WidgetKind } = ...

Type declaration

image-number-prediction-follow-up: WidgetKind
image-prediction-follow-up: WidgetKind
text-prediction-follow-up: WidgetKind

PREDICTION_FOLLOW_UP_WIDGET_KIND

PREDICTION_FOLLOW_UP_WIDGET_KIND: WidgetKind[] = ...

PREDICTION_ID_PROP

PREDICTION_ID_PROP: { image-number-prediction-follow-up: string; image-prediction-follow-up: string; text-prediction-follow-up: string } = ...

Type declaration

image-number-prediction-follow-up: string
image-prediction-follow-up: string
text-prediction-follow-up: string

PREDICTION_WIDGET_KIND

PREDICTION_WIDGET_KIND: WidgetKind[] = ...

UNSUPPORTED_UPDATE_INTERACTION_WIDGET_KINDS

UNSUPPORTED_UPDATE_INTERACTION_WIDGET_KINDS: WidgetKind[] = ...

WIDGET_RESULTS

WIDGET_RESULTS: { CHEER_METER: "cheer-meter-results"; EMOJI_SLIDER: "emoji-slider-results"; IMAGE_POLL: "image-poll-results"; IMAGE_QUIZ: "image-quiz-results"; TEXT_POLL: "text-poll-results"; TEXT_QUIZ: "text-quiz-results" } = ...

Type declaration

CHEER_METER: "cheer-meter-results"
EMOJI_SLIDER: "emoji-slider-results"
IMAGE_POLL: "image-poll-results"
IMAGE_QUIZ: "image-quiz-results"
TEXT_POLL: "text-poll-results"
TEXT_QUIZ: "text-quiz-results"

WidgetResults

_$$

_$$: IApiGlobal = ...

_config

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

Type declaration

apiDocVersion: string
ready: boolean
version: string

chatUserMessageEvents

chatUserMessageEvents: ChatMessageEvent[] = ...

interactiveWidgets

interactiveWidgets: readonly [CHEER_METER, EMOJI_SLIDER, TEXT_POLL, IMAGE_POLL, TEXT_QUIZ, IMAGE_QUIZ, TEXT_PREDICTION, TEXT_PREDICTION_FOLLOW_UP, IMAGE_PREDICTION, IMAGE_PREDICTION_FOLLOW_UP, TEXT_ASK, TEXT_NUMBER_PREDICTION, TEXT_NUMBER_PREDICTION_FOLLOW_UP, IMAGE_NUMBER_PREDICTION, IMAGE_NUMBER_PREDICTION_FOLLOW_UP] = ...

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 = ...

widgetEndPhase

widgetEndPhase: WidgetPhase[] = ...

widgetKindVote

widgetKindVote: { cheer-meter: string; emoji-slider: string; image-number-prediction: string; image-poll: string; image-prediction: string; image-quiz: string; text-ask: string; text-number-prediction: string; text-poll: string; text-prediction: string; text-quiz: string } = ...

Type declaration

cheer-meter: string
emoji-slider: string
image-number-prediction: string
image-poll: string
image-prediction: string
image-quiz: string
text-ask: string
text-number-prediction: string
text-poll: string
text-prediction: string
text-quiz: string

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

Const addProgramListener

addProgramListener(arg: { programId: string }, listenerFn: ProgramListenerCallback): Promise<void>

Add a program listener to get program updates including widgets published from produce suite
since
0.1.0

example
```
function programListener({event, message}){
   // your custom logic
}
addProgramListener({
 programId: "<Your program Id>"
}, programListener)
```
Parameters
- arg: { programId: string }
  - programId: string
- listenerFn: ProgramListenerCallback
Returns Promise<void>

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>

Const addWidgetListener

addWidgetListener(arg: IWidgetResourceArgs, listenerFn: WidgetListenerCallback): Promise<void>

Add a widget listener

since

0.1.0

example

function widgetListener({event, message}){
   // your custom logic
}
addWidgetListener({
 widgetId: "<Your widget Id>",
 widgetKind: "<Your widget kind>"
}, widgetListener)

Parameters

arg: IWidgetResourceArgs
listenerFn: WidgetListenerCallback

Returns Promise<void>

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 claimPredictionWidgetRewards

claimPredictionWidgetRewards(arg: IClaimPredictionRewardArg): Promise<IPredictionClaim>

Claim prediction widget reward for the prediction submitted by the user. This could be used when prediction followup widget is published/rendered
since
0.1.0

async
example
```
claimPredictionWidgetRewards({
  widgetId: "xxxx",
  widgetKind: "<widget kind>"
}).then(predictionClaim => console.log(predictionClaim))
```
Parameters
- arg: IClaimPredictionRewardArg
Returns Promise<IPredictionClaim>

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

createCommentBoard

createCommentBoard(arg: ICreateCommentBoardArg): Promise<ICommentBoard>

description

Create comment board

async

since

2.38.0

example

 createCommentBoard({'title': 'sd','customId':'postid1','repliesDepth':2,'allowComments':true,'description': 'desc','customData':'abc'}).then(commentBoard => console.log(commentBoard));

Parameters

arg: ICreateCommentBoardArg

Returns Promise<ICommentBoard>

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>

Const createWidgetImpression

createWidgetImpression(arg: IWidgetResourceArgs): Promise<IWidgetImpression>

Create widget impression used for analytics purposes for eg: analyse how many total users a given widget has reached
since
0.1.0

example
```
createWidgetImpression({
 widgetId: "<Your widget Id>",
 widgetKind: "<Your widget kind>"
})
```
Parameters
- arg: IWidgetResourceArgs
Returns Promise<IWidgetImpression>

Const createWidgetInteraction

createWidgetInteraction(arg: ICreateWidgetInteractionArg): Promise<IWidgetInteraction>

Create a widget interaction

since

0.1.0

example

createWidgetInteraction({
 widgetId: "<Your widget Id>",
 widgetKind: "<widget kind>",
 interactionItem: selectedPollOptionItem
})

Parameters

arg: ICreateWidgetInteractionArg

Returns Promise<IWidgetInteraction>

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

deleteCommentBoard

deleteCommentBoard(arg: IDeleteCommentBoardArg): Promise<null>

description
Delete a comment board

async
since
2.38.0

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

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>

Const getApplicationBadges

getApplicationBadges(): Promise<IPaginatedResponse<IBadge>>

description
Get Application Badges.

async
since
0.1.0

example
```
getApplicationBadges().then(padinatedResponse => console.log(padinatedResponse.results))
```
Returns Promise<IPaginatedResponse<IBadge>>

Const getApplicationSponsors

getApplicationSponsors(): Promise<IPaginatedResponse<ISponsorPayload>>

description
Get sponsors list for a given application.

async
since
0.1.0

example
```
getApplicationSponsors().then(paginatedSponsors => console.log(paginatedSponsors.results))
```
Returns Promise<IPaginatedResponse<ISponsorPayload>>

getBadgeProfiles

getBadgeProfiles(args: { badgeId: string }): Promise<IPaginatedResponse<IBadgeProfile>>

description
Get profiles for a given badge.

async
since
0.1.0

example
```
getBadgeProfiles({
  badgeId: "dd810f9f-09d5-4c6b-a0df-e43dee9b2994"
}).then(res => console.log(res))
```
Parameters
- args: { badgeId: string }
  - badgeId: string
Returns Promise<IPaginatedResponse<IBadgeProfile>>

Const getBadgeProgress

getBadgeProgress(args: { badgeIds: string[]; profileId: string }): Promise<IBadgeProgress[]>

description
Get Progress of Badges for a given profileId.

async
since
0.1.0

example
```
getBadgeProgress({
 profileId: "xxxxx",
 badgeIds: [ "yyyyy", "zzzzz" ]
}).then(res => console.log(res))
```
Parameters
- args: { badgeIds: string[]; profileId: string }
  - badgeIds: string[]
  - profileId: string
Returns Promise<IBadgeProgress[]>

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 getChatRoomSponsors

getChatRoomSponsors(args: { roomId: string }): Promise<IPaginatedResponse<ISponsorPayload>>

description
Get sponsors list for a given chatroom.

async
since
0.1.0

example
```
getChatRoomSponsors({
 roomId: string
}).then(paginatedSponsors => console.log(paginatedSponsors.results))
```
Parameters
- args: { roomId: string }
  - roomId: string
Returns Promise<IPaginatedResponse<ISponsorPayload>>

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

getCommentBoardDetails

getCommentBoardDetails(arg: IGetCommentBoardDetailsArg): Promise<ICommentBoard>

description

Get comment board details

async

since

2.38.0

example

getCommentBoardDetails({ commentBoardId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(({results}) => console.log(results))

Parameters

arg: IGetCommentBoardDetailsArg

Returns Promise<ICommentBoard>

getCommentBoards

getCommentBoards(): Promise<IPaginatedResponse<ICommentBoard>>

description
Get list of comment boards in an application

async
since
2.38.0

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

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 getLeaderboard

getLeaderboard(args: ILeaderboardArgs): Promise<ILeaderboardPayload>

description
Gets leaderboard detail from leaderboardId.

async
since
0.1.0

example
```
getLeaderboard({ leaderboardId: "xxxxxx" }).then(leaderboard => console.log(leaderboard))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<ILeaderboardPayload>

Const getLeaderboardEntries

getLeaderboardEntries(args: ILeaderboardArgs): Promise<IPaginatedResponse<ILeaderboardRankPayload>>

description
Gets list of leaderboard entries from leaderboardId.

async
since
0.1.0

example
```
getLeaderboardEntries({
 programId: "xxxxx"
}).then(paginatedResponse => console.log(paginatedResponse.results))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<IPaginatedResponse<ILeaderboardRankPayload>>

Const getLeaderboardProfileRank

getLeaderboardProfileRank(args: ILeaderboardRankArgs): Promise<ILeaderboardRankPayload>

description
Gets leaderboard entry for a given profile in a given leaderboard.

async
since
0.1.0

example
```
getLeaderboardProfileRank({
   leaderboardId: "xxxxx",
   profileId: "yyyyy"
}).then(leaderboardEntry => console.log(leaderboardEntry))
```
Parameters
- args: ILeaderboardRankArgs
Returns Promise<ILeaderboardRankPayload>

Const getLeaderboards

getLeaderboards(args: { programId: string }): Promise<ILeaderboardPayload[]>

description
Gets leaderboard list for a given program.

async
since
0.1.0

example
```
getLeaderboards({ programId: "xxxxx" }).then(leaderboards => console.log(leaderboards))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<ILeaderboardPayload[]>

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>

Const getMilliseconds

getMilliseconds(duration: any): number

Converts ISO8601 format duration into milliseconds (PYYYYMMDDThhmmss) Example of duration - P3Y6M4DT12H30M5S

Parameters
- duration: any
  
  Time duration in ISO8601 format
Returns number
duration in milliseconds

Const getPostedWidgets

getPostedWidgets(args: { programId: string }): Promise<IPostedWidgetsPayload>

Get list of widgets that have already been posted.
async
since
0.1.0

example
```
getPostedWidgets({
  programId: "<your program id>"
}).then((res) => console.log(res))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<IPostedWidgetsPayload>

Const getProfileBadges

getProfileBadges(args: { profileId: string }): Promise<IPaginatedResponse<IProfileBadge>>

description
Get badges for a given userProfile.

async
since
0.1.0

example
```
getProfileBadges({
 profileId: "xxxxxx"
}).then(paginatedResponse => console.log(paginatedResponse.results))
```
Parameters
- args: { profileId: string }
  - profileId: string
    
    userProfile ID
Returns Promise<IPaginatedResponse<IProfileBadge>>

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

Const getProfileLeaderboardViews

getProfileLeaderboardViews(args: IProfileLeaderboardArg): Promise<IPaginatedResponse<IProfileLeaderboardView>>

description
Get list of leaderboard views in which a given profile is part of. If no profileId is passed, get current profile leaderboard views.

async
since
0.1.0

example
```
getProfileLeaderboardViews({
 profileId: "<profile-id>"
}).then(paginatedLeaderboardviews => console.log(paginatedLeaderboardviews))
```
Parameters
- args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboardView>>

Const getProfileLeaderboards

getProfileLeaderboards(args?: IProfileLeaderboardArg): Promise<IPaginatedResponse<IProfileLeaderboard>>

description
Get list of leaderboard in which a given profile is part of. If no profileId is passed, get current profile leaderboards.

async
since
0.1.0

example
```
getProfileLeaderboards({
 profileId: "<profile-id>"
}).then(paginatedLeaderboards => console.log(paginatedLeaderboards.results))
```
Parameters
- Optional args: IProfileLeaderboardArg
Returns Promise<IPaginatedResponse<IProfileLeaderboard>>

Const getProgramSponsors

getProgramSponsors(args: { programId: string }): Promise<IPaginatedResponse<ISponsorPayload>>

description
Get sponsors list for a given program.

async
since
0.1.0

example
```
getProgramSponsors({
 programId: string
}).then(paginatedSponsors => console.log(paginatedSponsors.results))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<IPaginatedResponse<ISponsorPayload>>

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 getUnclaimedWidgetInteractionsRewards

getUnclaimedWidgetInteractionsRewards(args: { programId: string }): Promise<IPaginatedResponse<IUnclaimedWidgetInteraction>>

description
Get unclamed widget interaction rewards for a given program

since
0.1.0

async
example
```
getUnclaimedWidgetInteractionsRewards({
   programId: "xxxxxx"
}).then(res => console.log(res))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<IPaginatedResponse<IUnclaimedWidgetInteraction>>

getUpdatedWidgetInteraction

getUpdatedWidgetInteraction(newWidgetInteraction: IWidgetInteraction, interactions?: IWidgetInteraction[]): IWidgetInteraction[]

Parameters
- newWidgetInteraction: IWidgetInteraction
- interactions: IWidgetInteraction[] = []
Returns IWidgetInteraction[]

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>>

Const getWidget

getWidget(args: IWidgetResourceArgs): Promise<IWidgetPayload>

Get a widget based on widget kind and widget id

async

since

0.1.0

example

getWidget({
 widgetId: "<Your widget Id>",
 widgetKind: "<Your widget kind>"
}).then(widgetPayload => console.log(widgetPayload))

Parameters

args: IWidgetResourceArgs

Returns Promise<IWidgetPayload>

Const getWidgetInteractions

getWidgetInteractions(args: IWidgetResourceArgs & { programId: string }): Promise<IWidgetInteraction[]>

Get widget interactions based on programId, widgetId & widgetKind
since
0.1.0

async
example
```
getWidgetInteractions({
  programId: "<your program Id>",
  widgetId: "xxxx",
  widgetKind: WidgetKind.TEXT_POLL,
}).then(interactions => console.log(interactions))
```
Parameters
- args: IWidgetResourceArgs & { programId: string }
Returns Promise<IWidgetInteraction[]>

Const getWidgets

getWidgets(args: IWidgetArgs): Promise<IPaginatedResponse<IWidgetPayload>>

description

Get paginated list of widgets filtered by widget status and kind

since

0.1.0

example

getWidgets({
  programId: "xxxx",
  status: "pending",
  widgetKinds: ["text-poll"],
  ordering: "recent",
  interactive: true,
  since: "2022-05-26T12:41:27.463Z"
}).then(res => console.log(res));

Parameters

args: IWidgetArgs

Returns Promise<IPaginatedResponse<IWidgetPayload>>

Const getWidgetsInteractions

getWidgetsInteractions(args: IWidgetInteractionArgs): Promise<IWidgetKindInteractionsMap>

Get collection of widget interactions based on interaction url or an array of widget id or an array of widget kinds

since

0.1.0

async

example

getWidgetsInteractions({
   interactionUrl: "<url>"
}).then(interactions => console.log(interactions))

// OR
getWidgetsInteractions({
   programId: "<program-id>",
   widgets: [{
     kind: WidgetKind.TEXT_POLL,
     id: "<widget-id>"
  }]
}).then(interactions => console.log(interactions))

// OR
getWidgetsInteractions({
   programId: "<program-id>",
   widgetKinds: [ WidgetKind.TEXT_POLL, WidgetKind.TEXT_PREDICTION ]
}).then(interactions => console.log(interactions))

Parameters

args: IWidgetInteractionArgs

Returns Promise<IWidgetKindInteractionsMap>

hasDebugLogger

hasDebugLogger(): boolean

Returns boolean

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

isNumberPredictionItem

isNumberPredictionItem(interactionItem: CreateWidgetInteractionItemProp): interactionItem is INumberPredictionItem

Parameters
- interactionItem: CreateWidgetInteractionItemProp
Returns interactionItem is INumberPredictionItem

isQuoteMessagePayload

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

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

isSliderInteractionItem

isSliderInteractionItem(interactionItem: CreateWidgetInteractionItemProp): interactionItem is ISliderInteractionItem

Parameters
- interactionItem: CreateWidgetInteractionItemProp
Returns interactionItem is ISliderInteractionItem

isTextAskInteractionItem

isTextAskInteractionItem(interactionItem: CreateWidgetInteractionItemProp): interactionItem is ITextAskInteractionItem

Parameters
- interactionItem: CreateWidgetInteractionItemProp
Returns interactionItem is ITextAskInteractionItem

isWidgetChoiceItem

isWidgetChoiceItem(interactionItem: CreateWidgetInteractionItemProp): interactionItem is IWidgetChoiceItem

Parameters
- interactionItem: CreateWidgetInteractionItemProp
Returns interactionItem is IWidgetChoiceItem

isWidgetOptionItem

isWidgetOptionItem(interactionItem: CreateWidgetInteractionItemProp): interactionItem is IWidgetOptionItem

Parameters
- interactionItem: CreateWidgetInteractionItemProp
Returns interactionItem is IWidgetOptionItem

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>

Const removeProgramListener

removeProgramListener(arg: { programId: string }, listenerFn: ProgramListenerCallback): Promise<void>

Remove a program listenerFn

since

0.1.0

example

function programListener({event, message}){
   // your custom logic
}
removeProgramListener({
 programId: "<Your program Id>"
}, programListener)

Parameters

arg: { programId: string }
- programId: string
listenerFn: ProgramListenerCallback

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 removeWidgetListener

removeWidgetListener(arg: IWidgetResourceArgs, listenerFn: WidgetListenerCallback): Promise<void>

Remove widget listener

since

0.1.0

example

function widgetListener({event, message}){
   // your custom logic
}
removeWidgetListener({
 widgetId: "<Your widget Id>",
 widgetKind: "<Your widget kind>"
}, widgetListener)

Parameters

arg: IWidgetResourceArgs
listenerFn: WidgetListenerCallback

Returns Promise<void>

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

updateCommentBoard

updateCommentBoard(arg: IUpdateCommentBoardArg): Promise<ICommentBoard>

description

Update comment board

async

since

2.38.0

example

updateCommentBoard({
commentBoardId: '5f5fea99-569b-42f3-875d-5b3943b64ba0',
title: "title",
customId: "postID431",
repliesDepth: 1,
allowComments: true,
description: 'abc',
customData: 'custom data' 
}).then(commentBoard => console.log(commentBoard))
``

Parameters

arg: IUpdateCommentBoardArg

Returns Promise<ICommentBoard>

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 updateWidgetInteraction

updateWidgetInteraction(arg: IUpdateWidgetInteractionArg): Promise<IWidgetInteraction>

Update a widget interaction

since

0.1.0

example

updateWidgetInteraction({
 widgetId: "<Your widget Id>",
 widgetKind: "<widget kind>",
 interactionItem: selectedPollOptionItem
})

Parameters

arg: IUpdateWidgetInteractionArg

Returns Promise<IWidgetInteraction>

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

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

ChatRoomApiStreamEventDetails

CreateWidgetInteractionItemProp

DateTime

IChatMessageRequestPayload

IChatMessageResponsePayload

IChatRoomApiStreamResponse

IChatUserMessageResponsePayload

IMessageListIteratorResult

IQuoteMessagePropType

IQuoteMessageRequestPayload

IQuoteMessageResponsePayload

InteractiveWidgetKind

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

ProgramListenerCallback

Type declaration

Parameters

args: IProgramListenerCallbackArgs

Returns unknown

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

WidgetListenerCallback

Type declaration