EngagementSDK

class EngagementSDK

Use this class to initialize the EngagementSDK. This is the entry point for SDK usage. This creates an instance of EngagementSDK.

Fields

Name	Description
`var userProfileDelegate: UserProfileDelegate?`
`var leaderBoardDelegate: LeaderBoardDelegate?`
`var analyticService: Stream<AnalyticsService>`	The analytics services
`val userStream: Stream<LiveLikeUserApi>`	Returns public user stream.
`val userAccessToken: String?`	Returns access token associated with user to be used for future sdk initialization. This access token acts as a unique identifier for a user profile in LiveLike system. Null value means sdk initialization process not completed.

Constructors

<init>

constructor(clientId: String, applicationContext: Context, errorDelegate: ErrorDelegate?, originURL: String?, accessTokenDelegate: AccessTokenDelegate?)

Use this class to initialize the EngagementSDK. This is the entry point for SDK usage. This creates an instance of EngagementSDK.

Parameters

Name	Description
`clientId: String`	Client's id
`applicationContext: Context`	The application context
`errorDelegate: ErrorDelegate?`
`originURL: String?`
`accessTokenDelegate: AccessTokenDelegate?`

Methods

updateChatNickname

fun updateChatNickname(nickname: String)

Override the default auto-generated chat nickname

Parameters

Name	Description
`nickname: String`

ReturnValue

Name	Description
`Unit`

updateChatUserPic

fun updateChatUserPic(url: String?)

Override the default auto-generated chat userpic

Parameters

Name	Description
`url: String?`

ReturnValue

Name	Description
`Unit`

createChatRoom

fun createChatRoom(title: String?, visibility: Visibility?, liveLikeCallback: LiveLikeCallback<ChatRoomInfo>)

Parameters

Name	Description
`title: String?`
`visibility: Visibility?`
`liveLikeCallback: LiveLikeCallback<ChatRoomInfo>`

ReturnValue

Name	Description
`Unit`

updateChatRoom

fun updateChatRoom(chatRoomId: String, title: String?, visibility: Visibility?, liveLikeCallback: LiveLikeCallback<ChatRoomInfo>)

Parameters

Name	Description
`chatRoomId: String`
`title: String?`
`visibility: Visibility?`
`liveLikeCallback: LiveLikeCallback<ChatRoomInfo>`

ReturnValue

Name	Description
`Unit`

getChatRoom

fun getChatRoom(id: String, liveLikeCallback: LiveLikeCallback<ChatRoomInfo>)

Parameters

Name	Description
`id: String`
`liveLikeCallback: LiveLikeCallback<ChatRoomInfo>`

ReturnValue

Name	Description
`Unit`

addCurrentUserToChatRoom

fun addCurrentUserToChatRoom(chatRoomId: String, liveLikeCallback: LiveLikeCallback<ChatRoomMembership>)

Parameters

Name	Description
`chatRoomId: String`
`liveLikeCallback: LiveLikeCallback<ChatRoomMembership>`

ReturnValue

Name	Description
`Unit`

getCurrentUserChatRoomList

fun getCurrentUserChatRoomList(liveLikePagination: LiveLikePagination, liveLikeCallback: LiveLikeCallback<List<ChatRoomInfo>>)

Parameters

Name	Description
`liveLikePagination: LiveLikePagination`
`liveLikeCallback: LiveLikeCallback<List<ChatRoomInfo>>`

ReturnValue

Name	Description
`Unit`

getMembersOfChatRoom

fun getMembersOfChatRoom(chatRoomId: String, liveLikePagination: LiveLikePagination, liveLikeCallback: LiveLikeCallback<List<LiveLikeUser>>)

Parameters

Name	Description
`chatRoomId: String`
`liveLikePagination: LiveLikePagination`
`liveLikeCallback: LiveLikeCallback<List<LiveLikeUser>>`

ReturnValue

Name	Description
`Unit`

deleteCurrentUserFromChatRoom

fun deleteCurrentUserFromChatRoom(chatRoomId: String, liveLikeCallback: LiveLikeCallback<Boolean>)

Parameters

Name	Description
`chatRoomId: String`
`liveLikeCallback: LiveLikeCallback<Boolean>`

ReturnValue

Name	Description
`Unit`

getLeaderBoardsForProgram

fun getLeaderBoardsForProgram(programId: String, liveLikeCallback: LiveLikeCallback<List<LeaderBoard>>)

Parameters

Name	Description
`programId: String`
`liveLikeCallback: LiveLikeCallback<List<LeaderBoard>>`

ReturnValue

Name	Description
`Unit`

getLeaderBoardDetails

fun getLeaderBoardDetails(leaderBoardId: String, liveLikeCallback: LiveLikeCallback<LeaderBoard>)

Parameters

Name	Description
`leaderBoardId: String`
`liveLikeCallback: LiveLikeCallback<LeaderBoard>`

ReturnValue

Name	Description
`Unit`

getLeaderboardClients

fun getLeaderboardClients(leaderBoardId: List<String>, liveLikeCallback: LiveLikeCallback<LeaderboardClient>)

Parameters

Name	Description
`leaderBoardId: List<String>`
`liveLikeCallback: LiveLikeCallback<LeaderboardClient>`

ReturnValue

Name	Description
`Unit`

getEntriesForLeaderBoard

fun getEntriesForLeaderBoard(leaderBoardId: String, liveLikePagination: LiveLikePagination, liveLikeCallback: LiveLikeCallback<LeaderBoardEntryPaginationResult>)

Parameters

Name	Description
`leaderBoardId: String`
`liveLikePagination: LiveLikePagination`
`liveLikeCallback: LiveLikeCallback<LeaderBoardEntryPaginationResult>`

ReturnValue

Name	Description
`Unit`

getLeaderBoardEntryForProfile

fun getLeaderBoardEntryForProfile(leaderBoardId: String, profileId: String, liveLikeCallback: LiveLikeCallback<LeaderBoardEntry>)

Parameters

Name	Description
`leaderBoardId: String`
`profileId: String`
`liveLikeCallback: LiveLikeCallback<LeaderBoardEntry>`

ReturnValue

Name	Description
`Unit`

getLeaderBoardEntryForCurrentUserProfile

fun getLeaderBoardEntryForCurrentUserProfile(leaderBoardId: String, liveLikeCallback: LiveLikeCallback<LeaderBoardEntry>)

Parameters

Name	Description
`leaderBoardId: String`
`liveLikeCallback: LiveLikeCallback<LeaderBoardEntry>`

ReturnValue

Name	Description
`Unit`

fetchWidgetDetails

fun fetchWidgetDetails(widgetId: String, widgetKind: String, liveLikeCallback: LiveLikeCallback<LiveLikeWidget>)

Parameters

Name	Description
`widgetId: String`
`widgetKind: String`
`liveLikeCallback: LiveLikeCallback<LiveLikeWidget>`

ReturnValue

Name	Description
`Unit`

createContentSession

fun createContentSession(programId: String, errorDelegate: ErrorDelegate?): LiveLikeContentSession

Creates a content session without sync.

Parameters

Name	Description
`programId: String`	Backend generated unique identifier for current program
`errorDelegate: ErrorDelegate?`

ReturnValue

Name	Description
`LiveLikeContentSession`

createContentSession

fun createContentSession(programId: String, timecodeGetter: TimecodeGetter, errorDelegate: ErrorDelegate?): LiveLikeContentSession

Creates a content session with sync.

Parameters

Name	Description
`programId: String`	Backend generated identifier for current program
`timecodeGetter: TimecodeGetter`	returns the video timecode
`errorDelegate: ErrorDelegate?`

ReturnValue

Name	Description
`LiveLikeContentSession`

createChatSession

fun createChatSession(timecodeGetter: TimecodeGetter, errorDelegate: ErrorDelegate?): LiveLikeChatSession

Creates a chat session.

Parameters

Name	Description
`timecodeGetter: TimecodeGetter`	returns the video timecode
`errorDelegate: ErrorDelegate?`

ReturnValue

Name	Description
`LiveLikeChatSession`

CompanionObject

EngagementSDK

class EngagementSDK

Use this class to initialize the EngagementSDK. This is the entry point for SDK usage. This creates an instance of EngagementSDK.

Fields

Name	Description
`var enableDebug: Boolean`
`var predictionWidgetVoteRepository: PredictionWidgetVoteRepository`