badge | @livelike/engagementsdk

Index

Functions

getApplicationBadges

getApplicationBadges(): Promise<IApplicationBadges>

Gets Application Badges.

async

since

2.7.0

example

getApplicationBadges().then(padinatedResponse => console.log(padinatedResponse))

Returns Promise<IApplicationBadges>

getBadgeProfiles

getBadgeProfiles(args: { badgeId: string }): Promise<IPaginatedResponse<IBadgeProfile>>

description
Get profiles for a given badge.

async
since
2.37.0

example
```
getBadgeProfiles({
  badgeId: "dd810f9f-09d5-4c6b-a0df-e43dee9b2994"
}).then(res => console.log(res))
```
Parameters
- args: { badgeId: string }
  - badgeId: string
Returns Promise<IPaginatedResponse<IBadgeProfile>>

getBadgeProgress

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

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[]>

getPaginatedProfileBadges

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

Parameters
- args: { profileId: string }
  - profileId: string
Returns Promise<AsyncIterator<Object, Function, Function>>

getProfileBadges

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

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>

Generated using TypeDoc

Index

Functions

Functions

getApplicationBadges

Returns Promise<IApplicationBadges>

getBadgeProfiles

Parameters

args: { badgeId: string }

badgeId: string

Returns Promise<IPaginatedResponse<IBadgeProfile>>

getBadgeProgress

Parameters

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

badgeIds: string[]

profileId: string

Returns Promise<IBadgeProgress[]>

getPaginatedProfileBadges

Parameters

args: { profileId: string }

profileId: string

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

getProfileBadges

Parameters

args: { profileId: string }

profileId: string

Returns Promise<IProfileBadges>