@livelike/engagementsdk

Index

Functions

applyTheme

Functions

Const applyTheme

applyTheme(t: ITheme): Promise<void>

- Defined in applyTheme.ts:12
applyTheme Dynamically change the theme

async

since

1.24.0

Parameters
- t: ITheme
Returns Promise<void>

Index

Functions

applyLocalization

Functions

Const applyLocalization

applyLocalization(localizedStrings: any): Promise<boolean>

- Defined in applyLocalization.ts:10
applyLocalization Dynamically add localization Languages

async

since

2.1.2

Parameters
- localizedStrings: any
Returns Promise<boolean>

Index

Functions

init

Functions

Const init

init(args: InitArgs): Promise<unknown>

- Defined in init.ts:194
Parameters
- args: InitArgs
Returns Promise<unknown>

Index

Functions

Const getApplicationBadges

getApplicationBadges(): Promise<IApplicationBadges>

- Defined in badge.ts:59
Gets Application Badges.
async

since

2.7.0

example
```
getApplicationBadges().then(padinatedResponse => console.log(padinatedResponse))
```
Returns Promise<IApplicationBadges>

Const getBadgeProgress

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

- Defined in badge.ts:73
Gets Progress of Badges.
async

since

2.7.0

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

Const getPaginatedProfileBadges

getPaginatedProfileBadges(args: { profileId: string }): Promise<AsyncIterator<Object, Function, Function>>

- Defined in badge.ts:24
Parameters
- args: { profileId: string }
  - profileId: string
Returns Promise<AsyncIterator<Object, Function, Function>>

Const getProfileBadges

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

- Defined in badge.ts:38
Gets userProfile Badges.
async

since

2.7.0

example
```
getProfileBadges({ profileId }).then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: { profileId: string }
  - profileId: string
    
    userProfile ID
Returns Promise<IProfileBadges>

Index

Functions

blockProfile

blockProfile(args: IBlockProfileArgs): Promise<IBlockInfo>

- Defined in blockProfile.ts:21
description

Block profile using profile Id

async

since

2.13.0

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

getBlockInfoList

getBlockInfoList(): Promise<IPaginatedResponse<IBlockInfo>>

- Defined in blockProfile.ts:56
description

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

async

since

2.13.0

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

getProfileBlockInfo

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

- Defined in blockProfile.ts:69
description

Get Block Info for given profile id if exists

async

since

2.13.0

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

unblockProfile

unblockProfile(args: IUnblockProfileArgs): Promise<any>

- Defined in blockProfile.ts:41
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

2.13.0

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

Index

Interfaces

IMutedResponse

Functions

addNewMemberToChatRoom

addNewMemberToChatRoom(__namedParameters: { profileId: string; roomId: string }): Promise<IChatRoomMembership>

- Defined in chatRoom.ts:139
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
- __namedParameters: { profileId: string; roomId: string }
  - profileId: string
  - roomId: string
Returns Promise<IChatRoomMembership>

Promise

Const createChatRoom

createChatRoom(args: IChatRoomCreationArgs): Promise<IChatRoomPayload>

- Defined in chatRoom.ts:42
Creates a new chat room

async

since

1.20

Parameters
- args: IChatRoomCreationArgs
Returns Promise<IChatRoomPayload>

Const getChatRoom

getChatRoom(args: IChatRoomArgs): Promise<IChatRoomPayload>

- Defined in chatRoom.ts:72
Gets chat room by roomId

async

since

1.20

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomPayload>

Const getChatRoomMemberships

getChatRoomMemberships(args: IChatRoomArgs): Promise<IChatRoomMembershipsResponse>

- Defined in chatRoom.ts:97
Get list of users that are a 'member' of given chatroom.

async

since

1.20

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomMembershipsResponse>

Const getChatUserMutedStatus

getChatUserMutedStatus(args: IChatRoomArgs): Promise<IMutedResponse>

- Defined in chatRoom.ts:118
Gets the muted status of the current user for a given chat room

async

since

2.2.0

Parameters
- args: IChatRoomArgs
Returns Promise<IMutedResponse>

Const getProfileChatRoomMemberships

getProfileChatRoomMemberships(): Promise<IProfileChatRoomMembershipResponse>

- Defined in chatRoom.ts:106
Get list of chat rooms that the current user is a 'member' of.

async

since

1.20

Returns Promise<IProfileChatRoomMembershipResponse>

Const joinChatRoom

joinChatRoom(args: IChatRoomArgs): Promise<IChatRoomMembership>

- Defined in chatRoom.ts:80
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>

Const leaveChatRoom

leaveChatRoom(args: IChatRoomArgs): Promise<boolean>

- Defined in chatRoom.ts:89
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>

Const updateChatRoom

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

- Defined in chatRoom.ts:59
Updates chat room by id

async

since

1.20

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

Index

Functions

addChatRoomEventListener

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

- Defined in chatRoomEventListener.ts:42
description

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

since

2.12.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: IChatRoomEventListenerFnMap[_Event]
Parameters
- chatRoomEvent: _Event
- listenerFn: _EventListener
- options: IChatRoomEventListenerOptions
Returns Promise<void>

removeChatRoomEventListener

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

- Defined in chatRoomEventListener.ts:70
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

2.12.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: IChatRoomEventListenerFnMap[_Event]
Parameters
- chatRoomEvent: _Event
- listenerFn: _EventListener
- options: IChatRoomEventListenerOptions
Returns Promise<void>

Index

Functions

getReceivedChatRoomInvitations

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

- Defined in chatRoomInvitation.ts:130
description

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

params

args of type IGetInvitationsArgs

async

since

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

- Defined in chatRoomInvitation.ts:94
description

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

params

args of type IGetInvitationsArgs

async

since

2.12.0

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

Promise<IPaginatedResponse>

sendChatRoomInviteToProfile

sendChatRoomInviteToProfile(args: IChatRoomAddMemberArgs): Promise<IChatRoomInvitation>

- Defined in chatRoomInvitation.ts:32
description

Send chat room invite to profile (user)

params

args of type ISendChatRoomInviteArgs

async

since

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

updateChatRoomInviteStatus

updateChatRoomInviteStatus(args: IUpdateChatRoomInvitationStatusArgs): Promise<IChatRoomInvitation>

- Defined in chatRoomInvitation.ts:64
description

Updates chat room invitation status

params

args of type IUpdateChatRoomInvitationStatusArgs

async

since

2.12.0

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

Promise

Index

Functions

Const getLeaderboard

getLeaderboard(args: ILeaderboardArgs): Promise<ILeaderboardPayload>

- Defined in leaderboard.ts:25
Gets leaderboard detail from leaderboardId.
async

since

1.26.0

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

Const getLeaderboardEntries

getLeaderboardEntries(args: ILeaderboardArgs): Promise<ILeaderboardEntries>

- Defined in leaderboard.ts:73
Parameters
- args: ILeaderboardArgs
Returns Promise<ILeaderboardEntries>

Const getLeaderboardProfileRank

getLeaderboardProfileRank(args: ILeaderboardRankArgs): Promise<ILeaderboardRankPayload>

- Defined in leaderboard.ts:89
Gets leaderboard entry for a given profile in a given leaderboard.
async

since

1.26.0

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

Const getLeaderboards

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

- Defined in leaderboard.ts:41
Gets leaderboard list for a given program.
async

since

1.26.0

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

Const getPaginatedLeaderboardEntries

getPaginatedLeaderboardEntries(args: ILeaderboardArgs): Promise<AsyncIterator<Object, Function, Function>>

- Defined in leaderboard.ts:58
Gets leaderboard entries list from leaderboardId.
async

since

1.26.0

example
```
LiveLike.getLeaderboardEntries({programId: string}).then(response => console.log(response))
```
Parameters
- args: ILeaderboardArgs
Returns Promise<AsyncIterator<Object, Function, Function>>

Promise

Index

Functions

Const addMessageListener

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

- Defined in messages.ts:143
Adds a listener to a chatroom that calls passed callback function when event fires.
since

1.18.0

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

Const getMessageCount

getMessageCount(roomId: string, time?: { since: string | number | Date }): Promise<IMessageCount>

- Defined in messages.ts:90
getMessageCount Returns number of messages in chat room
async

example
```
messageCount('c1f6082c-f7b9-4d1e-b64e-9071a3860ffc', {since: "2020-04-16T16:29:39.158Z"}).then(r => console.log(r.count))
```
Parameters
- roomId: string
- Optional time: { since: string | number | Date }
  - since: string | number | Date
    
    Time to get messages since
Returns Promise<IMessageCount>

Const getMessageList

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

- Defined in messages.ts:43
getMessageList Returns array of message objects
async

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

Const prepareOutgoingChatMessage

prepareOutgoingChatMessage(roomId: string, preparationCallback: MessagePreparationCallback): (message: IMessageResponse) => IMessageResponse

- Defined in messages.ts:284
Parameters
- roomId: string
- preparationCallback: MessagePreparationCallback
Returns (message: IMessageResponse) => IMessageResponse
- - (message: IMessageResponse): IMessageResponse
  - Parameters
    - message: IMessageResponse
    Returns IMessageResponse

Const removeMessageListener

removeMessageListener(arg: IChatRoomArgs, callback: MessageListenerCallback): void

- Defined in messages.ts:172
Removes listener from chatroom
since

1.18.0

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

Const sendCustomMessage

sendCustomMessage(args: ISendCustomMessageArgs): Promise<any>

- Defined in messages.ts:269
sendCustomMessage Send custom message to chat room.
async

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

Const sendMessage

sendMessage(args: ISendMessageArgs): Promise<any>

- Defined in messages.ts:191
sendMessage Send user message to chat room.
async

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

Index

Functions

getPinMessageInfoList

getPinMessageInfoList(args: IPinMessageInfoListArgs): Promise<IPaginatedResponse<IPinMessageInfo>>

- Defined in pinMessage.ts:80
description

Get list of pin message info

async

since

2.14.0

example
```
getPinMessageInfoList({
 roomId: "37e1720a-fc7b-4962-b216-6be9ed69dc96",
 orderBy: "desc"
}).then(pinMessageInfoList => console.log(pinMessageInfoList))
```
Parameters
- args: IPinMessageInfoListArgs
Returns Promise<IPaginatedResponse<IPinMessageInfo>>

pinMessage

pinMessage(args: IPinMessageArgs): Promise<IPinMessageInfo>

description

Pin a chat message

async

since

2.14.0

example

pinMessage({
 roomId: "9e6f1bc4-9f02-4c57-92b7-7521d0f5b027",
 messageId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7",
 messagePayload: { // messagePayload of type IMessagePayload
    message: "test Message"
 }
}).then(pinMessageInfo => console.log(pinMessageInfo))

Parameters

args: IPinMessageArgs

Returns Promise<IPinMessageInfo>

unpinMessage

unpinMessage(args: IUnpinMessageArgs): Promise<null>

- Defined in pinMessage.ts:60
description

Unpin a chat message

async

since

2.14.0

example
```
unpinMessage({
 pinMessageInfoId: "3f81ccb0-ec95-4e71-a0b7-462889699f75"
}).then(res => console.log(res))
```
Parameters
- args: IUnpinMessageArgs
Returns Promise<null>

Index

Functions

addRewardEventListener

addRewardEventListener(rewardEvent: RewardEvent, listenerFn: ListenerFn<RewardEvent, IRewardItemTransferPayload>): void

- Defined in reward.ts:134
description

Add listener for the RewardEvent

since

2.12.0

example

addRewardEventListener(RewardEvent.REWARD_ITEM_TRANSFER_RECEIVED, function onReceiveNewRewardItemTransfer(rewardItemTransfer){ console.log(rewardItemTransfer); })

Parameters
- rewardEvent: RewardEvent
- listenerFn: ListenerFn<RewardEvent, IRewardItemTransferPayload>
Returns void

Const getApplicationRewardItems

getApplicationRewardItems(): Promise<IPaginatedResponse<IRewardItem>>

- Defined in reward.ts:31
Gets Application Reward Items.
async

since

2.9.0

example
```
getApplicationRewardItems().then(padinatedResponse => console.log(padinatedResponse))
```
Returns Promise<IPaginatedResponse<IRewardItem>>

Const getRewardItemBalances

getRewardItemBalances(args: { rewardItemIds: string[] }): Promise<IPaginatedResponse<IRewardItemBalancePayload>>

- Defined in reward.ts:54
Gets userProfile Reward Item Balance.
async

since

2.9.0

example
```
getRewardItemBalances({ rewardItemIds: ["xxx", "xxx"] }).then(res => console.log(res))
```
Parameters
- args: { rewardItemIds: string[] }
  - rewardItemIds: string[]
Returns Promise<IPaginatedResponse<IRewardItemBalancePayload>>

Const getRewardItemTransfers

getRewardItemTransfers(args: IRewardItemTransferArgs): Promise<IPaginatedResponse<IRewardItemTransferPayload>>

- Defined in reward.ts:109
Gets user's Reward Item Transfers.
async

since

2.9.0

example
```
getRewardItemTransfers({transferType: "sent"}).then(res => console.log(res))
```
Parameters
- args: IRewardItemTransferArgs
  
  arguments to filter user's Reward Item Transfers
Returns Promise<IPaginatedResponse<IRewardItemTransferPayload>>

Const getRewardTransactions

getRewardTransactions(args: IRewardTransactionArgs): Promise<IPaginatedResponse<IRewardTransaction>>

- Defined in reward.ts:178
description

Fetch paginated List of Reward Transactions filtered by widget_id and kind

since

2.13.0

example

getRewardTransactions({ widgetIds: ["xx", "yy"], widgetKinds: ["text-poll", "text-prediction"] }).then(res => console.log(res));

Parameters
- args: IRewardTransactionArgs
Returns Promise<IPaginatedResponse<IRewardTransaction>>

removeRewardEventListener

removeRewardEventListener(rewardEvent: RewardEvent, listenerFn?: ListenerFn<RewardEvent, IRewardItemTransferPayload>): void

- Defined in reward.ts:152
description

Remove registered listenerFn for the RewardEvent. If no listenerFn is passed, it removes all the listeners attached to that event

since

2.12.0

example

removeRewardEventListener(RewardEvent.REWARD_ITEM_TRANSFER_RECEIVED);

Parameters
- rewardEvent: RewardEvent
- Optional listenerFn: ListenerFn<RewardEvent, IRewardItemTransferPayload>
Returns void

Const transferRewardItemAmount

transferRewardItemAmount(args: { amount: number; recipientProfileId: string; rewardItemId: string }): Promise<IRewardItemTransferPayload>

- Defined in reward.ts:75
Transfer Reward Item Balance to another profile.
async

since

2.9.0

example
```
transferRewardItemAmount({ rewardItemId: "xxxx", amount: 10, recipientProfileId: "xxxx" }).then(res => console.log(res))
```
Parameters
- args: { amount: number; recipientProfileId: string; rewardItemId: string }
  - amount: number
  - recipientProfileId: string
  - rewardItemId: string
Returns Promise<IRewardItemTransferPayload>

Index

Functions

getSponsors

Functions

Const getSponsors

getSponsors(args: { programId: string }): Promise<ISponsorPayload[]>

- Defined in sponsor.ts:18
Gets sponsors list for a given program.
async

since

2.5.1

example
```
LiveLike.getSponsors({programId: string}).then(sponsors => console.log(sponsors))
```
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<ISponsorPayload[]>

Index

Functions

addUserProfileEventListener

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

- Defined in userProfile.ts:116
description

Add listener for the given UserProfileEvent

since

2.13.0

example

addUserProfileEventListener(UserProfileEvent.BLOCK_PROFILE, function onBlockProfileListener(blockInfo){ console.log(blockInfo); })

Parameters
- userProfileEvent: UserProfileEvent
- listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void

Const createUserProfile

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

- Defined in userProfile.ts:58
Creates user profile. If no nickname argument is passed, a random nickname will be generated.
async

since

1.18.0

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

Const getUserProfile

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

- Defined in userProfile.ts:28
Gets userProfile from accessToken.
async

since

1.18.0

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

removeUserProfileEventListener

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

- Defined in userProfile.ts:135
description

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

since

2.13.0

example

removeUserProfileEventListener(UserProfileEvent.BLOCK_PROFILE, onBlockProfileListener);

Parameters
- userProfileEvent: UserProfileEvent
- Optional listenerFn: ListenerFn<UserProfileEvent, IBlockInfo>
Returns void

Const updateUserProfile

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

- Defined in userProfile.ts:82
Updates profile by accessToken with optional changed nickname or custom_data.
async

since

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

Index

Functions

Const addWidgetListener

addWidgetListener(arg: { programId: string }, callback: WidgetListenerCallback): any

- Defined in widgets.ts:139
since

2.4.0

Parameters
- arg: { programId: string }
  - programId: string
- callback: WidgetListenerCallback
Returns any

Const getPaginatedUnclaimedRewards

getPaginatedUnclaimedRewards(args: { programId: string }): Promise<AsyncIterator<Object, Function, Function>>

- Defined in widgets.ts:196
Parameters
- args: { programId: string }
  - programId: string
Returns Promise<AsyncIterator<Object, Function, Function>>

Const getPaginatedWidgets

getPaginatedWidgets(__namedParameters: { programId: any }): Promise<PaginationIterator>

- Defined in widgets.ts:29
Parameters
- __namedParameters: { programId: any }
  - programId: any
Returns Promise<PaginationIterator>

Const getPostedWidgets

getPostedWidgets(__namedParameters: { programId: any }): Promise<IPostedWidgetsPayload>

- Defined in widgets.ts:106
Get list of widgets that have already been posted.

async

since

1.18.2

Parameters
- __namedParameters: { programId: any }
  - programId: any
Returns Promise<IPostedWidgetsPayload>

Const getWidget

getWidget(args: IWidgetCreationArgs): Promise<IWidgetPayload>

- Defined in widgets.ts:118
Gets widget object from passed kind and id

async

since

1.18.0

Parameters
- args: IWidgetCreationArgs
Returns Promise<IWidgetPayload>

Const getWidgetInteractions

getWidgetInteractions(args: IWidgetInteractionArgs): Promise<any>

- Defined in widgets.ts:164
Parameters
- args: IWidgetInteractionArgs
Returns Promise<any>

Const getWidgets

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

- Defined in widgets.ts:220
description

Fetch paginated List of Widgets filtered by widget status and kind

since

2.13.0

example

getWidgets({ programId: "xxxx", status: "pending", widgetKinds: ["text-poll"], ordering: "recent" }).then(res => console.log(res));

Parameters
- args: IWidgetArgs
Returns Promise<IPaginatedResponse<IWidgetPayload>>

Const registerWidgetMode

registerWidgetMode(name: string, mode: WidgetMode): any

- Defined in widgets.ts:132
Registers a custom widget state transition mode. The name argument is used to pass to one of the widget instantiation methods to choose

since

1.18.0

Parameters
- name: string
- mode: WidgetMode
Returns any

Const removeWidgetListener

removeWidgetListener(arg: { programId: string }, callback: WidgetListenerCallback): void

- Defined in widgets.ts:159
since

2.4.0

Parameters
- arg: { programId: string }
  - programId: string
- callback: WidgetListenerCallback
Returns void

Index

Enumerations

Interfaces

Type aliases

CustomWidgetRenderer

CustomWidgetRenderer: (__namedParameters: { IWidgetPayload: any }) => HTMLElement | Node

Type declaration

- (__namedParameters: { IWidgetPayload: any }): HTMLElement | Node
- Parameters
  - __namedParameters: { IWidgetPayload: any }
    - IWidgetPayload: any
  Returns HTMLElement | Node

ListenerFn

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

Type parameters

TEvent
TMessage

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

RegisterMenuArgs

RegisterMenuArgs: (message?: any) => IMessageMenuItem[]

Type declaration

- (message?: any): IMessageMenuItem[]
- Parameters
  - Optional message: any
  Returns IMessageMenuItem[]

WidgetKind

WidgetListenerCallback

WidgetListenerCallback: (args: IWidgetListenerCallbackArgs) => unknown

Type declaration

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

WidgetListenerEvents

WidgetMode

WidgetMode: (args: IWidgetModeArgs) => void

Type declaration

- (args: IWidgetModeArgs): void
- Parameters
  - args: IWidgetModeArgs
  Returns void

customMessageRenderer

customMessageRenderer: (__namedParameters: { IMessagePayload: any }) => HTMLElement | Node

Type declaration

- (__namedParameters: { IMessagePayload: any }): HTMLElement | Node
- Parameters
  - __namedParameters: { IMessagePayload: any }
    - IMessagePayload: any
  Returns HTMLElement | Node

Index

Functions

Functions

Const applyTheme

Parameters

t: ITheme

Returns Promise<void>

Index

Functions

Functions

Const applyLocalization

Parameters

localizedStrings: any

Returns Promise<boolean>

Index

Functions

Functions

Const init

Parameters

args: InitArgs

Returns Promise<unknown>

Index

Functions

Functions

Const getApplicationBadges

Returns Promise<IApplicationBadges>

Const getBadgeProgress

Parameters

args: { badgeIds: string[]; profileId: string }

badgeIds: string[]

profileId: string

Returns Promise<IBadgeProgress[]>

Const getPaginatedProfileBadges

Parameters

args: { profileId: string }

profileId: string

Returns Promise<AsyncIterator<Object, Function, Function>>

Const getProfileBadges

Parameters

args: { profileId: string }

profileId: string

Returns Promise<IProfileBadges>

Index

Functions

Functions

blockProfile

Parameters

args: IBlockProfileArgs

Returns Promise<IBlockInfo>

getBlockInfoList

Returns Promise<IPaginatedResponse<IBlockInfo>>

getProfileBlockInfo

Parameters

args: IProfileBlockInfoArgs

Returns Promise<IBlockInfo | undefined>

unblockProfile

Parameters

args: IUnblockProfileArgs

Returns Promise<any>

Index

Interfaces

Functions

Functions

addNewMemberToChatRoom

Parameters

__namedParameters: { profileId: string; roomId: string }

profileId: string

roomId: string

Returns Promise<IChatRoomMembership>

Const createChatRoom

Parameters

args: IChatRoomCreationArgs

Returns Promise<IChatRoomPayload>

Const getChatRoom

Parameters

args: IChatRoomArgs

Returns Promise<IChatRoomPayload>

Const getChatRoomMemberships

Parameters

args: IChatRoomArgs