IEngagement

IEngagement

interface IEngagement

Fields

Name Description
abstract analyticService: Stream<AnalyticsService>

The analytics services

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

abstract userStream: Stream<LiveLikeUserApi>

Returns public user stream.

abstract var userProfileDelegate: UserProfileDelegate?
abstract var leaderBoardDelegate: LeaderBoardDelegate?

Methods

updateChatNickname

abstract fun updateChatNickname(nickname: String)

Override the default auto-generated chat nickname

Parameters

Name Description
nickname: String

ReturnValue

Name Description
Unit

updateChatUserPic

abstract fun updateChatUserPic(url: String?)

Override the default auto-generated chat userpic

Parameters

Name Description
url: String?

ReturnValue

Name Description
Unit

createChatRoom

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

Parameters

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

ReturnValue

Name Description
Unit

updateChatRoom

abstract 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

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

Parameters

Name Description
id: String
liveLikeCallback: LiveLikeCallback<ChatRoomInfo>

ReturnValue

Name Description
Unit

addCurrentUserToChatRoom

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

Parameters

Name Description
chatRoomId: String
liveLikeCallback: LiveLikeCallback<ChatRoomMembership>

ReturnValue

Name Description
Unit

getCurrentUserChatRoomList

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

Parameters

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

ReturnValue

Name Description
Unit

getMembersOfChatRoom

abstract 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

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

Parameters

Name Description
chatRoomId: String
liveLikeCallback: LiveLikeCallback<Boolean>

ReturnValue

Name Description
Unit

getLeaderBoardsForProgram

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

Parameters

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

ReturnValue

Name Description
Unit

getLeaderBoardDetails

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

Parameters

Name Description
leaderBoardId: String
liveLikeCallback: LiveLikeCallback<LeaderBoard>

ReturnValue

Name Description
Unit

getEntriesForLeaderBoard

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

Parameters

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

ReturnValue

Name Description
Unit

getLeaderBoardEntryForProfile

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

Parameters

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

ReturnValue

Name Description
Unit

getLeaderBoardEntryForCurrentUserProfile

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

Parameters

Name Description
leaderBoardId: String
liveLikeCallback: LiveLikeCallback<LeaderBoardEntry>

ReturnValue

Name Description
Unit

getLeaderboardClients

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

Parameters

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

ReturnValue

Name Description
Unit