packages/api-client/PlayerSystemNotificationAPIApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| create2 | POST /player/notification/create | Create Notification |
| delete4 | POST /player/notification/delete | Delete Notification |
| list2 | GET /player/notification/list | Get Notification Detail List |
| page | GET /player/notification/page | Get Notification Page Info |
| read | POST /player/notification/read | Mark Notification Read |
| statistics1 | GET /player/notification/statistics | Get Notification' Statistics |
ResponseDataVoid create2(notificationCreateRo)
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:.PlayerSystemNotificationAPIApiCreate2Request = {
// Array<NotificationCreateRo>
notificationCreateRo: [
{
toUserId: [
"toUserId_example",
],
toMemberId: [
"toMemberId_example",
],
toUnitId: [
"toUnitId_example",
],
fromUserId: "1261273764218",
nodeId: "nod10",
spaceId: "spcHKrd0liUcl",
templateId: "tplxx",
body:
key: {},
,
version: "v0.12.1.release",
expireAt: "1614587900000",
notifyId: "1614587900000",
},
],
};
apiInstance.create2(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationCreateRo | Array<NotificationCreateRo> |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataBoolean delete4(notificationReadRo)
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:.PlayerSystemNotificationAPIApiDelete4Request = {
// NotificationReadRo
notificationReadRo: {
id: ["124324324","243242"],
isAll: false,
},
};
apiInstance.delete4(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationReadRo | NotificationReadRo |
ResponseDataBoolean
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataListNotificationDetailVo list2()
Default: System Notification
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:.PlayerSystemNotificationAPIApiList2Request = {
// NotificationListRo
notificationListRo: {
isRead: false,
notifyType: "system",
},
};
apiInstance.list2(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationListRo | NotificationListRo | defaults to undefined |
ResponseDataListNotificationDetailVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataListNotificationDetailVo page()
Description of Paging: pageNo: number of paging pageSize: size of paging。 order: order in current page。 sort: sorting in current page。 simple usage example:{"pageNo":1,"pageSize":20} complex usage example:{"pageNo":1,"pageSize":20,"order":"createTime,updateTime","sort":"asc,desc"}
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:.PlayerSystemNotificationAPIApiPageRequest = {
// NotificationPageRo
notificationPageRo: {
isRead: false,
notifyType: "system",
rowNo: 10,
pageSize: 20,
},
};
apiInstance.page(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationPageRo | NotificationPageRo | defaults to undefined |
ResponseDataListNotificationDetailVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataBoolean read(notificationReadRo)
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:.PlayerSystemNotificationAPIApiReadRequest = {
// NotificationReadRo
notificationReadRo: {
id: ["124324324","243242"],
isAll: false,
},
};
apiInstance.read(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
| Name | Type | Description | Notes |
|---|---|---|---|
| notificationReadRo | NotificationReadRo |
ResponseDataBoolean
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataNotificationStatisticsVo statistics1()
import { } from '';
import * as fs from 'fs';
const configuration = .createConfiguration();
const apiInstance = new .PlayerSystemNotificationAPIApi(configuration);
let body:any = {};
apiInstance.statistics1(body).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
This endpoint does not need any parameter.
ResponseDataNotificationStatisticsVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]