使用方式
一、開始抽獎活動
Api 方法: startLuckyLottery(activityId: number): Promise<CommonResult<string, Object>>
參數說明:
- activityId:活動ID,
number類型,必傳
回傳值說明: Promise<CommonResult<string, Object>> 類型
範例:
const result = await luckyLotteryTarget.startLuckyLottery(123);
if (result.success) {
console.log('抽奖成功', result.data);
} else {
console.error('抽奖失败', result.failReason);
}
二、取得幸運抽獎活動列表
Api 方法: getLuckyLotteryActivityList(options?: PageOptions): Promise<PageContent<LuckyLotteryActivityItem>>
參數說明:
- options:分頁參數,
PageOptions類型,選傳,預設{},詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
pageNumber |
頁數 | number |
否 | - |
pageSize |
頁碼 | number |
否 | - |
回傳值說明: 分頁資料,Promise<PageContent<LuckyLotteryActivityItem>> 類型,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
pageNumber |
目前頁數 | number |
pageSize |
每頁數量 | number |
totalItems |
總記錄數 | number |
totalPages |
總頁數 | number |
contents |
內容列表 | I[] |
範例:
const data = await luckyLotteryTarget.getLuckyLotteryActivityList({ pageNumber: 1, pageSize: 10 });
console.log('幸运抽奖活动列表', data.contents);
三、取得幸運抽獎活動詳情
Api 方法: getLuckyLotteryActivityById(activityId: number): Promise<LuckyLotteryActivityDetailData>
參數說明:
- activityId:活動ID,
number類型,必傳
回傳值說明: Promise<LuckyLotteryActivityDetailData> 類型,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
taskId |
活動 ID | number |
lotteryStyle |
活動模板 | string |
activityName |
活動名稱 | string |
startTime |
活動開始時間,單位:毫秒 | number |
endTime |
活動結束時間,單位:毫秒 | number |
drawFrequency |
抽獎頻率 | string |
drawTimes |
抽獎次數 | number |
winLimit |
中獎限制 | string |
maxWins |
最大中獎人數 | number |
showWinners |
是否顯示中獎名單 | boolean |
rules |
活動規則 | string |
noWinSetting |
未中獎設定 | LuckyLotteryMissSetting |
channelIds |
頻道 ID 列表 | Channel[] |
prizes |
獎品列表 | LuckyLotteryPrize[] |
status |
活動狀態 | string |
reachMaxDrawTimes |
是否到達最大抽獎次數 | boolean |
reachMaxWinTimes |
是否到達最大中獎次數 | boolean |
範例:
const data = await luckyLotteryTarget.getLuckyLotteryActivityById(123);
console.log('幸运抽奖活动详情', data);
四、取得中獎者列表
Api 方法: getLuckyLotteryWinnersList(options: PageOptions & Object): Promise<PageContent<LuckyLotteryWinnersItem>>
參數說明:
- options:分頁參數,包含分頁資訊和活動ID,
PageOptions & Object類型,必傳
回傳值說明: 分頁資料,Promise<PageContent<LuckyLotteryWinnersItem>> 類型,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
pageNumber |
目前頁數 | number |
pageSize |
每頁數量 | number |
totalItems |
總記錄數 | number |
totalPages |
總頁數 | number |
contents |
內容列表 | I[] |
範例:
const data = await luckyLotteryTarget.getLuckyLotteryWinnersList({
pageNumber: 1,
pageSize: 10,
taskId: 123
});
console.log('中奖者列表', data.contents);
五、取得幸運抽獎中獎記錄
Api 方法: getLuckyLotteryPrizeList(options?: PageOptions): Promise<PageContent<LuckyLotteryPrizeItem>>
參數說明:
- options:取得參數,包含分頁資訊,
PageOptions類型,選傳,預設{},詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
pageNumber |
頁數 | number |
否 | - |
pageSize |
頁碼 | number |
否 | - |
回傳值說明: 分頁資料,Promise<PageContent<LuckyLotteryPrizeItem>> 類型,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
pageNumber |
目前頁數 | number |
pageSize |
每頁數量 | number |
totalItems |
總記錄數 | number |
totalPages |
總頁數 | number |
contents |
內容列表 | I[] |
範例:
const data = await luckyLotteryTarget.getLuckyLotteryPrizeList({
pageNumber: 1,
pageSize: 10
});
console.log('奖品列表', data.contents);
六、取得中獎領取資訊
Api 方法: getLuckyLotteryReceive(recordId: number): Promise<LuckyLotteryReceiveData>
參數說明:
- recordId:中獎記錄行 ID,
number類型,必傳
回傳值說明: Promise<LuckyLotteryReceiveData> 類型,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
receiveType |
領取方式 | PrizeAcceptType |
isReceived |
是否已領取 | boolean |
formList |
表單列表 | LuckyLotteryReceiveFormItem[] |
recordId |
獎品行 ID | number |
taskId |
活動 ID | number |
範例:
const data = await luckyLotteryTarget.getLuckyLotteryReceive(123);
console.log('中奖领取信息', data);
七、提交中獎領取資訊
Api 方法: submitLuckyLotteryReceive(options: LuckyLotterySubmitReceiveOptions): Promise<unknown>
參數說明:
- options:提交參數,
LuckyLotterySubmitReceiveOptions類型,必傳,詳細類型說明如下
| 參數名 | 說明 | 類型 | 必須 | 預設值 |
|---|---|---|---|---|
taskId |
活動 ID | number |
是 | - |
recordId |
獎品行 ID | number |
是 | - |
collectItems |
領取資訊 | LuckyLotterySubmitReceiveItem[] |
是 | - |
回傳值說明: Promise<unknown> 類型
範例:
await luckyLotteryTarget.submitLuckyLotteryReceive({
taskId: 123,
recordId: 123,
collectItems: [{ field: '姓名', type: 'text', tips: '请输入姓名', required: true, value: '张三' }],
});
toast('提交成功');
