Function PushNotificationsApiFactory

PushNotificationsApi - factory interface export

  • PushNotificationsApiFactory(configuration?, basePath?, axios?): {
        apiPushNotificationsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiPushNotificationsIdPut(id: string, deviceRegistration?: DeviceRegistration, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiPushNotificationsPost(pns?: string, toTag?: string, body?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        usernameUserNameDelete(userName: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiPushNotificationsIdDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiPushNotificationsIdPut(id: string, deviceRegistration?: DeviceRegistration, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiPushNotificationsPost(pns?: string, toTag?: string, body?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        usernameUserNameDelete(userName: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiPushNotificationsIdDelete:function
      • apiPushNotificationsIdDelete(id, options?): AxiosPromise<void>

      • summary delete device registration

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiPushNotificationsIdPut:function
      • apiPushNotificationsIdPut(id, deviceRegistration?, options?): AxiosPromise<void>

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

        Parameters

        • id: string
        • OptionaldeviceRegistration: DeviceRegistration
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiPushNotificationsPost:function
      • apiPushNotificationsPost(pns?, toTag?, body?, options?): AxiosPromise<void>

      • summary Push notification to device

        Parameters

        • Optionalpns: string
        • OptionaltoTag: string
        • Optionalbody: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • usernameUserNameDelete:function
      • usernameUserNameDelete(userName, options?): AxiosPromise<void>

      • summary

        Parameters

        • userName: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

Settings

Member Visibility