Skip to content

Commit 6ee31da

Browse files
yasminetalbyTalby
and
Talby
authored
Fix documentation of the on_publish_received argument. (#505)
* Fix documentation of the on_publish_received argument reported in #503 --------- Co-authored-by: Talby <[email protected]>
1 parent d4fbc28 commit 6ee31da

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

awsiot/mqtt5_client_builder.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,10 @@
112112
**on_publish_received** (`Callable`): Callback invoked for all publish packets received by client.
113113
The function should take the following arguments and return nothing:
114114
115-
* `publish_packet` (:class:`awscrt.mqtt5.PublishPacket`): Publish Packet received from the server.
115+
* `publish_received_data` (:class:`awscrt.mqtt5.PublishReceivedData`): Dataclass
116+
containing the following:
117+
118+
* `publish_packet`: (:class:`awscrt.mqtt5.PublishPacket`): Data model of an `MQTT5 PUBLISH <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901100>` _ packet.
116119
117120
**on_lifecycle_stopped** (`Callable`): Callback invoked for Lifecycle Event Stopped.
118121
The function should take the following arguments and return nothing:

0 commit comments

Comments
 (0)