Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Const getLeaderboard

  • Gets leaderboard detail from leaderboardId.

    async
    since

    1.26.0

    example
    LiveLike.getLeaderboard({leaderboardId: string}).then(leaderboard => console.log(leaderboard))
    

    Parameters

    Returns Promise<ILeaderboardPayload>

Const getLeaderboardEntries

Const getLeaderboardProfileRank

  • 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

    Returns Promise<ILeaderboardRankPayload>

Const getLeaderboards

  • 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>>
  • Gets leaderboard entries list from leaderboardId.

    async
    since

    1.26.0

    example
    LiveLike.getLeaderboardEntries({programId: string}).then(response => console.log(response))
    

    Parameters

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

    Promise

Const getProfileLeaderboardViews

  • 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

    2.33.0

    example
    LiveLike.getProfileLeaderboardViews({profileId: "<profile-id>"})
    .then(leaderboardviews => console.log(leaderboardviews))

    Parameters

    Returns Promise<IPaginatedResponse<IProfileLeaderboardView>>

Const getProfileLeaderboards

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

    async
    since

    2.33.0

    example
    LiveLike.getProfileLeaderboards({profileId: "<profile-id>"})
    .then(leaderboards => console.log(leaderboards))

    Parameters

    Returns Promise<IPaginatedResponse<IProfileLeaderboard>>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc