Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KiiPushInstallation

Represents a KiiPushInstallation object

Hierarchy

  • KiiPushInstallation

Index

Methods

Methods

getMqttEndpoint

  • Get MQTT endpoint.
    If the MQTT endpoint is not ready, this method retries request up to three times.

    Note that only MQTT over tls is supported currently.
    Don't use portSSL, portWS or portWSS until we support it.

    Parameters

    • installationID: string

      The ID of the installation in the platform.

    Returns Promise<MQTTEndpointResponse>

    return promise object.

    • fulfill callback function: function(response).
      • response.installationID is ID of the installation in the platform.
      • response.username is username to use for connecting to the MQTT broker.
      • response.password is assword to use for connecting to the MQTT broker.
      • response.mqttTopic is topic to subscribe in the MQTT broker.
      • response.host is hostname of the MQTT broker.
      • response.X-MQTT-TTL is the amount of time in seconds that specifies how long the mqttTopic will be valid, after that the client needs to request new MQTT endpoint info.
      • response.portTCP is port to connect using plain TCP.
      • response.portSSL is port to connect using SSL/TLS.
    • reject callback function: function(error). error is an Error instance.
      • error.target is a KiiPushSubscription instance.
      • error.message

installApns

  • Register the id issued by APNS to the Kii cloud for current logged in user.

    Parameters

    • deviceToken: string

      The ID of registration that identifies the installation externally.

    • development: boolean

      Indicates if the installation is for development or production environment.

    Returns Promise<KiiPushInstallationResponse>

    return promise object.

    • fulfill callback function: function(response).
      • response.installationID is ID of the installation in the platform.
    • reject callback function: function(error). error is an Error instance.
      • error.message

installGcm

  • Register the id issued by GCM to the Kii cloud for current logged in user.

    Parameters

    • installationRegistrationID: string

      The ID of registration that identifies the installation externally.

    • development: boolean

      Indicates if the installation is for development or production environment.

    Returns Promise<KiiPushInstallationResponse>

    return promise object.

    • fulfill callback function: function(response).
      • response.installationID is ID of the installation in the platform.
    • reject callback function: function(error). error is an Error instance.
      • error.message

installMqtt

  • Register a MQTT installation to the Kii cloud for current logged in user.

    Parameters

    • development: boolean

      Indicates if the installation is for development or production environment.

    Returns Promise<KiiPushInstallationResponse>

    return promise object.

    • fulfill callback function: function(response).
      • response.installationID is ID of the installation in the platform.
      • response.installationRegistrationID is ID of registration that identifies the installation externally.
    • reject callback function: function(error). error is an Error instance.
      • error.message

uninstall

  • uninstall(installationRegistrationID: string, deviceType: DeviceType): Promise<void>

  • Unregister the push settings by the id(issued by push provider) that is used for installation.

    Parameters

    • installationRegistrationID: string

      The ID of registration that identifies the installation externally.

    • deviceType: DeviceType

      The type of the installation.

    Returns Promise<void>

    return promise object.

    • fulfill callback function: function().
    • reject callback function: function(error). error is an Error instance.
      • error.target is a KiiPushSubscription instance.
      • error.message

uninstallByInstallationID

  • uninstallByInstallationID(installationID: string): Promise<void>

  • Unregister the push settings by the id(issued by KiiCloud) that is used for installation.

    Parameters

    • installationID: string

      The ID of the installation issued by KiiCloud.

    Returns Promise<void>

    return promise object.

    • fulfill callback function: function().
    • reject callback function: function(error). error is an Error instance.
      • error.target is a KiiPushSubscription instance.
      • error.message

Generated using TypeDoc