[ECO-5268] Add Kotlin getting started to pubsub #2540
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
ttypic
force-pushed
the
ECO-5268/pubsub-kotlin-start
branch
from
ce1199c to
f06750a
Compare
ttypic
force-pushed
the
ECO-5268/pubsub-kotlin-start
branch
from
f06750a to
26d0eb7
Compare
|
|
||
| * Open up the "dev console":https://ably.com/accounts/any/apps/any/console of your first app before instantiating your client so that you can see what happens. | ||
|
|
||
| * Create an @Main.kt@ file in your project and add the following function to instantiate the SDK and establish a connection to Ably. At the minimum you need to provide an authentication mechanism. Use an API key for simplicity, but you should use token authentication in a production app. A @clientId@ ensures the client is identified, which is required to use certain features, such as presence: |
There was a problem hiding this comment.
| * Create an @Main.kt@ file in your project and add the following function to instantiate the SDK and establish a connection to Ably. At the minimum you need to provide an authentication mechanism. Use an API key for simplicity, but you should use token authentication in a production app. A @clientId@ ensures the client is identified, which is required to use certain features, such as presence: | |
| * Create a @Main.kt@ file in your project and add the following function to instantiate the SDK and establish a connection to Ably. At the minimum you need to provide an authentication mechanism. Use an API key for simplicity, but you should use token authentication in a production app. A @clientId@ ensures the client is identified, which is required to use certain features, such as presence: |
| } | ||
| ``` | ||
|
|
||
| You can monitor the lifecycle of clients' connections, but for now just log a message to the console to know that the connection attempt was successful. You'll see the message printed to your console, and you can also inspect the connection event in the dev console of your app. |
There was a problem hiding this comment.
This text changed slightly in the JS version. I think we should be including some info on how to run the file... I'm assuming we recommend kotlinc ?
For reference in JS:
You can monitor the lifecycle of clients’ connections by registering a listener that will emit an event every time the connection state changes. For now, run the function with
node index.jsto log a message to the console to know that the connection attempt was successful. You’ll see the message printed to your console, and you can also inspect the connection event in the dev console of your app.
|
|
||
| Messages contain the data that a client is communicating, such as a short 'hello' from a colleague, or a financial update being broadcast to subscribers from a server. Ably uses channels to separate messages into different topics, so that clients only ever receive messages on the channels they are subscribed to. | ||
|
|
||
| * Add the following lines to your @getStarted()@ function to create a channel instance and register a listener to subscribe to the channel. Then run it: |
There was a problem hiding this comment.
Same here - we need to update all instances of "Then run it with..." please to include the 'how'.
|
|
||
| * In the "dev console":https://ably.com/accounts/any/apps/any/console of your first app, attach to @my-first-channel@. Enter a @clientId@, such as @my-dev-console@, and then join the presence set of the channel. You'll see that @my-first-client@ is already present in the channel. In the console of your IDE you'll see that an event was received when the dev console client joined the channel. | ||
|
|
||
| * You can have another client join the presence set using the Ably CLI: @ably channels presence enter my-first-channel --client-id "my-cli" --data '{"status":"online"}'@. |
There was a problem hiding this comment.
Can we split the command out into a fenced block to improve the readability? Also change the status message:
ably channels presence enter my-first-channel --client-id "my-cli" --data '{"status":"learning about Ably!"}'.
|
|
||
| If more than 2 minutes has passed since you published a regular message (excluding the presence events), then you can publish some more before trying out history. You can use the Pub/Sub SDK, Ably CLI or the dev console to do this. | ||
|
|
||
| For example, using the Ably CLI to publish 5 messages: @ably channels publish --count 5 my-first-channel "Message number {{.Count}}"@ |
There was a problem hiding this comment.
Split out the CLI command onto its own line again please.
Description
Add Kotlin getting started to pubsub
Checklist