Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IotShadowClient

Index

Constructors

constructor

IotShadow Methods

publishDeleteNamedShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic Publish DeleteNamedShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: DeleteNamedShadowRequest

      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.

publishDeleteShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic Publish DeleteShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: DeleteShadowRequest

      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.

publishGetNamedShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic Publish GetNamedShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: GetNamedShadowRequest

      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.

publishGetShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic Publish GetShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: GetShadowRequest

      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.

publishUpdateNamedShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic Publish UpdateNamedShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: UpdateNamedShadowRequest

      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.

publishUpdateShadow

  • API Documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic Publish UpdateShadow message If the device is offline, the PUBLISH packet will be sent once the connection resumes.

    Parameters

    • request: UpdateShadowRequest

      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.

subscribeToDeleteNamedShadowAccepted

  • Subscribe to DeleteNamedShadowAccepted messages

    subscribeToDeleteNamedShadowAccepted 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.

subscribeToDeleteNamedShadowRejected

  • Subscribe to DeleteNamedShadowRejected messages

    subscribeToDeleteNamedShadowRejected 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.

subscribeToDeleteShadowAccepted

  • Subscribe to DeleteShadowAccepted messages

    subscribeToDeleteShadowAccepted 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.

subscribeToDeleteShadowRejected

  • Subscribe to DeleteShadowRejected messages

    subscribeToDeleteShadowRejected 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.

subscribeToGetNamedShadowAccepted

  • Subscribe to GetNamedShadowAccepted messages

    subscribeToGetNamedShadowAccepted 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.

subscribeToGetNamedShadowRejected

  • Subscribe to GetNamedShadowRejected messages

    subscribeToGetNamedShadowRejected 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.

subscribeToGetShadowAccepted

  • Subscribe to GetShadowAccepted messages

    subscribeToGetShadowAccepted 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.

subscribeToGetShadowRejected

  • Subscribe to GetShadowRejected messages

    subscribeToGetShadowRejected 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.

subscribeToNamedShadowDeltaUpdatedEvents

  • Subscribe to NamedShadowDeltaUpdatedEvents messages

    subscribeToNamedShadowDeltaUpdatedEvents 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.

subscribeToNamedShadowUpdatedEvents

  • Subscribe to NamedShadowUpdatedEvents messages

    subscribeToNamedShadowUpdatedEvents 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.

subscribeToShadowDeltaUpdatedEvents

  • Subscribe to ShadowDeltaUpdatedEvents messages

    subscribeToShadowDeltaUpdatedEvents 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.

subscribeToShadowUpdatedEvents

  • Subscribe to ShadowUpdatedEvents messages

    subscribeToShadowUpdatedEvents 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.

subscribeToUpdateNamedShadowAccepted

  • Subscribe to UpdateNamedShadowAccepted messages

    subscribeToUpdateNamedShadowAccepted 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.

subscribeToUpdateNamedShadowRejected

  • Subscribe to UpdateNamedShadowRejected messages

    subscribeToUpdateNamedShadowRejected 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.

subscribeToUpdateShadowAccepted

  • Subscribe to UpdateShadowAccepted messages

    subscribeToUpdateShadowAccepted 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.

subscribeToUpdateShadowRejected

  • Subscribe to UpdateShadowRejected messages

    subscribeToUpdateShadowRejected 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