Class PushNotificationsApi

PushNotificationsApi - object-oriented interface export PushNotificationsApi

Hierarchy (view full)

BaseAPI
- PushNotificationsApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiPushNotificationsIdDelete apiPushNotificationsIdPut apiPushNotificationsPost apiPushNotificationsUsernameUserNameDelete

Constructors

constructor

new PushNotificationsApi(configuration?, basePath?, axios?): PushNotificationsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PushNotificationsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiPushNotificationsIdDelete

apiPushNotificationsIdDelete(id, options?): Promise<AxiosResponse<void, any>>
summary Delete device registration
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof PushNotificationsApi
- Defined in src/api/api.ts:28790

apiPushNotificationsIdPut

apiPushNotificationsIdPut(id, deviceRegistration?, options?): Promise<AxiosResponse<void, any>>
summary This creates or updates a registration (with provided channelURI) at the specified id
Parameters
- id: string
  This is the registration id optional field, used for update
- OptionaldeviceRegistration: DeviceRegistration
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof PushNotificationsApi
- Defined in src/api/api.ts:28803

apiPushNotificationsPost

apiPushNotificationsPost(pns?, toTag?, body?, options?): Promise<AxiosResponse<void, any>>
summary Push notification to device
Parameters
- Optionalpns: string
- OptionaltoTag: string
- Optionalbody: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof PushNotificationsApi
- Defined in src/api/api.ts:28817

apiPushNotificationsUsernameUserNameDelete

apiPushNotificationsUsernameUserNameDelete(userName, options?): Promise<AxiosResponse<void, any>>
summary Delete by username
Parameters
- userName: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof PushNotificationsApi
- Defined in src/api/api.ts:28829