Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IotIdentityClient

Hierarchy

  • IotIdentityClient

Index

Constructors

constructor

IotIdentity Methods

publishCreateCertificateFromCsr

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Publish CreateCertificateFromCsr message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

publishCreateKeysAndCertificate

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Publish CreateKeysAndCertificate message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

publishRegisterThing

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#fleet-provision-api Publish RegisterThing message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: RegisterThingRequest

      Message to be serialized and sent

    • qos: QoS

      Quality of Service for delivering this message

    Returns Promise<MqttRequest>

    Promise which returns a mqtt.MqttRequest which will contain the packet id of the PUBLISH packet.

    • For QoS 0, completes as soon as the packet is sent.
    • For QoS 1, completes when PUBACK is received.
    • QoS 2 is not supported by AWS IoT.

subscribeToCreateCertificateFromCsrAccepted

subscribeToCreateCertificateFromCsrRejected

  • Subscribe to CreateCertificateFromCsrRejected messages

    subscribeToCreateCertificateFromCsrRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.

    Once subscribed, messageHandler is invoked each time a message matching the topic is received. It is possible for such messages to arrive before the SUBACK is received.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise which returns a mqtt.MqttSubscribeRequest which will contain the result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned from the server or is rejected when an exception occurs.

subscribeToCreateKeysAndCertificateAccepted

subscribeToCreateKeysAndCertificateRejected

  • Subscribe to CreateKeysAndCertificateRejected messages

    subscribeToCreateKeysAndCertificateRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.

    Once subscribed, messageHandler is invoked each time a message matching the topic is received. It is possible for such messages to arrive before the SUBACK is received.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise which returns a mqtt.MqttSubscribeRequest which will contain the result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned from the server or is rejected when an exception occurs.

subscribeToRegisterThingAccepted

  • Subscribe to RegisterThingAccepted messages

    subscribeToRegisterThingAccepted may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.

    Once subscribed, messageHandler is invoked each time a message matching the topic is received. It is possible for such messages to arrive before the SUBACK is received.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise which returns a mqtt.MqttSubscribeRequest which will contain the result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned from the server or is rejected when an exception occurs.

subscribeToRegisterThingRejected

  • Subscribe to RegisterThingRejected messages

    subscribeToRegisterThingRejected may be called while the device is offline, though the async operation cannot complete successfully until the connection resumes.

    Once subscribed, messageHandler is invoked each time a message matching the topic is received. It is possible for such messages to arrive before the SUBACK is received.

    Parameters

    Returns Promise<MqttSubscribeRequest>

    Promise which returns a mqtt.MqttSubscribeRequest which will contain the result of the SUBSCRIBE. The Promise resolves when a SUBACK is returned from the server or is rejected when an exception occurs.

Generated using TypeDoc