Function PushNotificationsApiAxiosParamCreator

PushNotificationsApi - axios parameter creator export

  • PushNotificationsApiAxiosParamCreator(configuration?): {
        apiPushNotificationsIdDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsIdPut: ((id: string, deviceRegistration?: DeviceRegistration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsPost: ((pns?: string, toTag?: string, body?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsUsernameUserNameDelete: ((userName: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiPushNotificationsIdDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsIdPut: ((id: string, deviceRegistration?: DeviceRegistration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsPost: ((pns?: string, toTag?: string, body?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiPushNotificationsUsernameUserNameDelete: ((userName: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiPushNotificationsIdDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Delete device registration

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiPushNotificationsIdPut: ((id: string, deviceRegistration?: DeviceRegistration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary This creates or updates a registration (with provided channelURI) at the specified id

      Throws

        • (id, deviceRegistration?, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            This is the registration id optional field, used for update

          • OptionaldeviceRegistration: DeviceRegistration
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiPushNotificationsPost: ((pns?: string, toTag?: string, body?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Push notification to device

      Throws

        • (pns?, toTag?, body?, options?): Promise<RequestArgs>

        • Parameters

          • Optionalpns: string
          • OptionaltoTag: string
          • Optionalbody: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiPushNotificationsUsernameUserNameDelete: ((userName: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Delete by username

      Throws

        • (userName, options?): Promise<RequestArgs>

        • Parameters

          • userName: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility