@livelike/engagementsdk

Index

Functions

applyTheme

Functions

Const applyTheme

applyTheme(t: IThemeObject): Promise<void>

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

async

since

1.24.0

Parameters
- t: IThemeObject
Returns Promise<void>

Index

Functions

init

Functions

Const init

init(args: { accessToken?: string; clientId: string; endpoint?: string; logger?: boolean; nickName?: string; publishKey?: string; storageStrategy?: IStorageStrategy; syncStrategy?: Object; theme?: Object }): Promise<unknown>

- Defined in init.ts:141
Init function arguments

Parameters
- args: { accessToken?: string; clientId: string; endpoint?: string; logger?: boolean; nickName?: string; publishKey?: string; storageStrategy?: IStorageStrategy; syncStrategy?: Object; theme?: Object }
  - Optional accessToken?: string
    
    The accessToken of a userProfile that is already saved to instantiate the application with
  - clientId: string
    
    clientId to instantiate the application with
  - Optional endpoint?: string
  - Optional logger?: boolean
    
    Set true to enable debug console logs
  - Optional nickName?: string
    
    If userProfile is not already saved, pass a nickName that you want the new userProfile top be instantiated with
  - Optional publishKey?: string
    
    Key used to enable message sending
  - Optional storageStrategy?: IStorageStrategy
    
    The storageStrategy is used to get/set accessToken, profile and other objects inside the application. This defaults to local Storage
  - Optional syncStrategy?: Object
  - Optional theme?: Object
Returns Promise<unknown>

Index

Functions

Const createChatRoom

createChatRoom(args: IChatRoomCreationArgs): Promise<IChatRoomPayload>

- Defined in chatRoom.ts:40
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:70
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:94
Get list of users that are a 'member' of given chatroom.

async

since

1.20

Parameters
- args: IChatRoomArgs
Returns Promise<IChatRoomMembershipsResponse>

Const getProfileChatRoomMemberships

getProfileChatRoomMemberships(): Promise<IProfileChatRoomMembershipResponse>

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

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

Const leaveChatRoom

leaveChatRoom(args: IChatRoomArgs): Promise<boolean>

- Defined in chatRoom.ts:86
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:57
Updates chat room by id

async

since

1.20

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

Index

Functions

Const getLeaderboard

getLeaderboard(args: ILeaderboardArgs): Promise<ILeaderboardPayload>

- Defined in leaderboard.ts:27
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: ILeaderboardEntriesArgs): Promise<ILeaderboardEntries>

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

since

1.26.0

example
```
LiveLike.getLeaderboardEntries({programId: string}).then(response => console.log(response))
```
Parameters
- args: ILeaderboardEntriesArgs
Returns Promise<ILeaderboardEntries>

Promise

Const getLeaderboardProfileRank

getLeaderboardProfileRank(args: ILeaderboardRankArgs): Promise<ILeaderboardRankPayload>

- Defined in leaderboard.ts:96
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:43
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[]>

Index

Functions

Const addMessageListener

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

- Defined in messages.ts:199
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: IChatRoomArgs
- callback: MessageListenerCallback
Returns Promise<void>

Const getMessageCount

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

- Defined in messages.ts:88
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:41
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: IMessageObject) => IMessageObject

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

Const removeMessageListener

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

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

1.18.0

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

Const sendMessage

sendMessage(args: ISendMessageArgs): Promise<any>

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

fires

messagesent

fires

messagefailed

see

https://docs.livelike.com/docs/web-custom-analytics

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

Index

Functions

Const createUserProfile

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

- Defined in userProfile.ts:47
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 }): Promise<IUserProfile>

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

since

1.18.0

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

Const updateUserProfile

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

- Defined in userProfile.ts:73
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 getPostedWidgets

getPostedWidgets(args: IPostedWidgetsArgs): Promise<IPostedWidgetsPayload>

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

async

since

1.18.2

Parameters
- args: IPostedWidgetsArgs
Returns Promise<IPostedWidgetsPayload>

Const getWidget

getWidget(args: IWidgetCreationArgs): Promise<IWidgetPayload>

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

async

since

1.18.0

Parameters
- args: IWidgetCreationArgs
Returns Promise<IWidgetPayload>

Const registerWidgetMode

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

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

Index

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

MessageListenerCallback

MessageListenerCallback: (args: IMessageListenerCallbackArgs) => unknown

Type declaration

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

MessagePreparationCallback

MessagePreparationCallback: (message: IMessageObject) => IMessageObject

Type declaration

- (message: IMessageObject): IMessageObject
- Parameters
  - message: IMessageObject
  Returns IMessageObject

RegisterMenuArgs

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

Type declaration

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

Rewards

Rewards: IRewardsItem[]

WidgetKind

WidgetMode

WidgetMode: (args: IWidgetModeArgs) => void

Type declaration

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

Index

Functions

Functions

Const applyTheme

Parameters

t: IThemeObject

Returns Promise<void>

Index

Functions

Functions

Const init

Parameters

args: { accessToken?: string; clientId: string; endpoint?: string; logger?: boolean; nickName?: string; publishKey?: string; storageStrategy?: IStorageStrategy; syncStrategy?: Object; theme?: Object }

Optional accessToken?: string

clientId: string

Optional endpoint?: string

Optional logger?: boolean

Optional nickName?: string

Optional publishKey?: string

Optional storageStrategy?: IStorageStrategy

Optional syncStrategy?: Object

Optional theme?: Object

Returns Promise<unknown>

Index

Functions

Functions

Const createChatRoom

Parameters

args: IChatRoomCreationArgs

Returns Promise<IChatRoomPayload>

Const getChatRoom

Parameters

args: IChatRoomArgs

Returns Promise<IChatRoomPayload>

Const getChatRoomMemberships

Parameters

args: IChatRoomArgs

Returns Promise<IChatRoomMembershipsResponse>

Const getProfileChatRoomMemberships

Returns Promise<IProfileChatRoomMembershipResponse>

Const joinChatRoom

Parameters

args: IChatRoomArgs

Returns Promise<boolean>

Const leaveChatRoom

Parameters

args: IChatRoomArgs

Returns Promise<boolean>

Const updateChatRoom

Parameters

roomId: string

args: IChatRoomCreationArgs

Returns Promise<IChatRoomPayload>

Index

Functions

Functions

Const getLeaderboard

Parameters

args: ILeaderboardArgs

Returns Promise<ILeaderboardPayload>

Const getLeaderboardEntries

Parameters

args: ILeaderboardEntriesArgs

Returns Promise<ILeaderboardEntries>

Const getLeaderboardProfileRank

Parameters

args: ILeaderboardRankArgs

Returns Promise<ILeaderboardRankPayload>

Const getLeaderboards

Parameters

args: { programId: string }

programId: string

Returns Promise<ILeaderboardPayload[]>

Index

Functions

Functions

Const addMessageListener

Parameters

arg: IChatRoomArgs

callback: MessageListenerCallback