Back to Apitable

.PlayerSystemNotificationAPIApi

packages/api-client/PlayerSystemNotificationAPIApi.md

1.13.0-beta.19.0 KB
Original Source

.PlayerSystemNotificationAPIApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
create2POST /player/notification/createCreate Notification
delete4POST /player/notification/deleteDelete Notification
list2GET /player/notification/listGet Notification Detail List
pageGET /player/notification/pageGet Notification Page Info
readPOST /player/notification/readMark Notification Read
statistics1GET /player/notification/statisticsGet Notification' Statistics

create2

ResponseDataVoid create2(notificationCreateRo)

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
notificationCreateRoArray<NotificationCreateRo>

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete4

ResponseDataBoolean delete4(notificationReadRo)

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
notificationReadRoNotificationReadRo

Return type

ResponseDataBoolean

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list2

ResponseDataListNotificationDetailVo list2()

Default: System Notification

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
notificationListRoNotificationListRodefaults to undefined

Return type

ResponseDataListNotificationDetailVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

page

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"}

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
notificationPageRoNotificationPageRodefaults to undefined

Return type

ResponseDataListNotificationDetailVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

ResponseDataBoolean read(notificationReadRo)

Example

typescript
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));

Parameters

NameTypeDescriptionNotes
notificationReadRoNotificationReadRo

Return type

ResponseDataBoolean

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

statistics1

ResponseDataNotificationStatisticsVo statistics1()

Example

typescript
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));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataNotificationStatisticsVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]