reward | @livelike/engagementsdk - v2.53.0-alpha.0

API
Elements

Index

Namespaces

<internal>

Functions

Functions

addRewardEventListener

addRewardEventListener(rewardEvent: REWARD_ITEM_TRANSFER_RECEIVED, listenerFn: ListenerFn<REWARD_ITEM_TRANSFER_RECEIVED, IRewardItemTransferPayload>): void

description
Add listener for the RewardEvent

since
2.12.0

example
```
addRewardEventListener(RewardEvent.REWARD_ITEM_TRANSFER_RECEIVED, function onReceiveNewRewardItemTransfer(rewardItemTransfer){
 console.log(rewardItemTransfer);
})
```
Parameters
- rewardEvent: REWARD_ITEM_TRANSFER_RECEIVED
- listenerFn: ListenerFn<REWARD_ITEM_TRANSFER_RECEIVED, IRewardItemTransferPayload>
Returns void

getApplicationRewardItems

getApplicationRewardItems(args: IRewardItemArgs): Promise<IPaginatedResponse<IRewardItem>>

Gets Application Reward Items.
async
since
2.9.0

example
```
getApplicationRewardItems().then(padinatedResponse => console.log(padinatedResponse))
```
Parameters
- args: IRewardItemArgs
Returns Promise<IPaginatedResponse<IRewardItem>>

getRewardItemBalances

getRewardItemBalances(args: { rewardItemIds: string[] }): Promise<IPaginatedResponse<IRewardItemBalancePayload>>

Gets userProfile Reward Item Balance.
async
since
2.9.0

example
```
getRewardItemBalances({ rewardItemIds: ["xxx", "xxx"] }).then(res => console.log(res))
```
Parameters
- args: { rewardItemIds: string[] }
  - rewardItemIds: string[]
Returns Promise<IPaginatedResponse<IRewardItemBalancePayload>>

getRewardItemTransfers

getRewardItemTransfers(args: IRewardItemTransferArgs): Promise<IPaginatedResponse<IRewardItemTransferPayload>>

Gets user's Reward Item Transfers.
async
since
2.9.0

example
```
getRewardItemTransfers({transferType: "sent"}).then(res => console.log(res))
```
Parameters
- args: IRewardItemTransferArgs
  
  arguments to filter user's Reward Item Transfers
Returns Promise<IPaginatedResponse<IRewardItemTransferPayload>>

getRewardTransactions

getRewardTransactions(args: IRewardTransactionArgs): Promise<IPaginatedResponse<IRewardTransaction>>

description
Fetch paginated List of Reward Transactions filtered by widget_id and kind

since
2.13.0

example
```
getRewardTransactions({
  widgetIds: ["xx", "yy"],
  widgetKinds: ["text-poll", "text-prediction"]
}).then(res => console.log(res));
```
Parameters
- args: IRewardTransactionArgs
Returns Promise<IPaginatedResponse<IRewardTransaction>>

removeRewardEventListener

removeRewardEventListener(rewardEvent: REWARD_ITEM_TRANSFER_RECEIVED, listenerFn?: ListenerFn<REWARD_ITEM_TRANSFER_RECEIVED, IRewardItemTransferPayload>): void

description
Remove registered listenerFn for the RewardEvent. If no listenerFn is passed, it removes all the listeners attached to that event

since
2.12.0

example
```
removeRewardEventListener(RewardEvent.REWARD_ITEM_TRANSFER_RECEIVED);
```
Parameters
- rewardEvent: REWARD_ITEM_TRANSFER_RECEIVED
- Optional listenerFn: ListenerFn<REWARD_ITEM_TRANSFER_RECEIVED, IRewardItemTransferPayload>
Returns void

transferRewardItemAmount

transferRewardItemAmount(args: { amount: number; recipientProfileId: string; rewardItemId: string }): Promise<IRewardItemTransferPayload>

Transfer Reward Item Balance to another profile.
async
since
2.9.0

example
```
transferRewardItemAmount({ rewardItemId: "xxxx", amount: 10, recipientProfileId: "xxxx" }).then(res => console.log(res))
```
Parameters
- args: { amount: number; recipientProfileId: string; rewardItemId: string }
  - amount: number
  - recipientProfileId: string
  - rewardItemId: string
Returns Promise<IRewardItemTransferPayload>

Generated using TypeDoc