This is an automated email from the ASF dual-hosted git repository. orpiske pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit b4bec897f3e70597abcf035529dd5ad6ca2a640f Author: Otavio Rodolfo Piske <[email protected]> AuthorDate: Wed Feb 21 16:04:14 2024 +0100 CAMEL-20410: documentation fixes for camel-pubnub - Fixed samples - Fixed grammar and typos - Fixed punctuation - Added and/or fixed links - Converted to use tabs --- .../src/main/docs/pubnub-component.adoc | 28 ++++++++++++---------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/components/camel-pubnub/src/main/docs/pubnub-component.adoc b/components/camel-pubnub/src/main/docs/pubnub-component.adoc index c2ab5958f95..3844f1fb407 100644 --- a/components/camel-pubnub/src/main/docs/pubnub-component.adoc +++ b/components/camel-pubnub/src/main/docs/pubnub-component.adoc @@ -65,18 +65,22 @@ include::partial$component-endpoint-headers.adoc[] == Message body -The message body can contain any JSON serializable data, including: Objects, Arrays, Ints and Strings. Message data should not contain special Java V4 classes or functions as these will not serialize. String content can include any single-byte or multi-byte UTF-8 +The message body can contain any JSON serializable data, including Objects, Arrays, Integers, and Strings. +Message data should not contain special Java V4 classes or functions as these will not serialize. +String content can include any single-byte or multibyte UTF-8. -Object serialization when sending is done automatically. Just pass the full object as the message payload. PubNub will takes care of object serialization. +Object serialization when sending is done automatically. +Pass the full object as the message payload. +PubNub will take care of object serialization. -When receiving the message body utilize objects provided by the PubNub API. +When receiving the message body uses objects provided by the PubNub API. == Examples === Publishing events Default operation when producing. -The following snippet publish the event generated by PojoBean to the channel iot. +The following snippet publishes the event generated by PojoBean to the channel iot. [source,java] ---- @@ -88,7 +92,7 @@ from("timer:mytimer") === Fire events aka BLOCKS Event Handlers -See https://www.pubnub.com/blocks-catalog/ for all kind of serverless functions that can be invoked. +See https://www.pubnub.com/blocks-catalog/[blocks catalog] for all kinds of serverless functions that can be invoked. Example of geolocation lookup [source,java] @@ -117,7 +121,7 @@ from("pubnub:iot?subscribeKey=mySubscribeKey") === Performing operations -herenow : Obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count of the channel +- `herenow`: obtain information about the current state of a channel including a list of unique user-ids currently subscribed to the channel and the total occupancy count of the channel: [source,java] ---- @@ -126,7 +130,7 @@ from("direct:control") .to("mock:result"); ---- -wherenow : Obtain information about the current list of channels to which a uuid is subscribed +- `wherenow`: obtain information about the current list of channels to which a uuid is subscribed: [source,java] ---- @@ -135,7 +139,7 @@ from("direct:control") .to("mock:result"); ---- -setstate : Used to set key/value pairs specific to a subscriber uuid. +- `setstate`: used to set key/value pairs specific to a subscriber uuid: [source,java] ---- @@ -144,7 +148,7 @@ from("direct:control") .to("pubnub:myChannel?publishKey=mypublishKey&subscribeKey=mySubscribeKey&operation=setstate&uuid=myuuid"); ---- -gethistory : Fetches historical messages of a channel. +- `gethistory`: Fetches historical messages of a channel: [source,java] ---- @@ -152,11 +156,11 @@ from("direct:control") .to("pubnub:myChannel?publishKey=mypublishKey&subscribeKey=mySubscribeKey&operation=gethistory"); ---- -There is a couple of examples in test directory that shows some of the PubNub features. +There are a couple of examples in the test directory that show some of the PubNub features. They require a PubNub account, from where you can obtain a publish- and subscribe key. -The example PubNubSensorExample already contains a subscribe key provided by PubNub, so this is ready to run without a account. -The example illustrates the PubNub component subscribing to a infinite stream of sensor data. +The example PubNubSensorExample already contains a subscribe key provided by PubNub, so this is ready to run without an account. +The example illustrates the PubNub component subscribing to an infinite stream of sensor data.
