diff --git a/shared/signaling/authentication-workflow/project-implementation/poc3.mdx b/shared/signaling/authentication-workflow/project-implementation/poc3.mdx index c1ef9c311..a8dbba24a 100644 --- a/shared/signaling/authentication-workflow/project-implementation/poc3.mdx +++ b/shared/signaling/authentication-workflow/project-implementation/poc3.mdx @@ -11,11 +11,11 @@ In order to make HTTPS calls to a token server and interpret the JSON return par To retrieve tokens from the token server and use them to authenticate your with using : -1. **Retrieve an RTM token from the server** +### **Retrieve an RTM token from the server** -2. **Use the token to login into the ** +### **Use the token to login into the ** Call `fetchToken` to get a fresh RTM token. Use the token in the config to initiate the . @@ -23,7 +23,7 @@ To retrieve tokens from the token server and use them to authenticate your -3. **Retrieve a Stream Channel token** +### **Retrieve a Stream Channel token** To join a stream channel you retrieve an RTC token from the token server by specifying the `uid` and `channelName`. @@ -32,33 +32,33 @@ To retrieve tokens from the token server and use them to authenticate your -4. **Use the Stream Channel token to join a stream channel** +### **Use the Stream Channel token to join a stream channel** -3. **Use the Stream Channel token to join a stream channel** +### **Use the Stream Channel token to join a stream channel** -5. **Handle the event triggered by when the token is about to expire** +### **Handle the event triggered by when the token is about to expire** -4. **Handle the event triggered by when the token is about to expire** +### **Handle the event triggered by when the token is about to expire** -6. **Renew the token** +### **Renew the token** -4. **Renew the token** +### **Renew the token** diff --git a/shared/signaling/cloud-proxy/project-implementation/poc3.mdx b/shared/signaling/cloud-proxy/project-implementation/poc3.mdx index d5dfdf3d5..ca8bfd293 100644 --- a/shared/signaling/cloud-proxy/project-implementation/poc3.mdx +++ b/shared/signaling/cloud-proxy/project-implementation/poc3.mdx @@ -1,10 +1,10 @@ import ApplyConfig from '@docs/assets/code/signaling/engine-config/apply-proxy-config.mdx' import ProxyConfig from '@docs/assets/code/signaling/engine-config/cloud-proxy.mdx' -1. **Set cloud proxy configuration** +### **Set cloud proxy configuration** -2. **Apply the configuration to the ** +### **Apply the configuration to the ** diff --git a/shared/signaling/data-encryption/project-implementation/poc3.mdx b/shared/signaling/data-encryption/project-implementation/poc3.mdx index 089ef3f3c..0fd403cdf 100644 --- a/shared/signaling/data-encryption/project-implementation/poc3.mdx +++ b/shared/signaling/data-encryption/project-implementation/poc3.mdx @@ -1,10 +1,10 @@ import ApplyConfig from '@docs/assets/code/signaling/engine-config/apply-encryption-config.mdx' import EncryptionConfig from '@docs/assets/code/signaling/engine-config/encryption-config.mdx' -1. **Set encryption configuration** +### **Set encryption configuration** -1. **Apply the configuration to the ** +### **Apply the configuration to the ** diff --git a/shared/signaling/geofencing/project-implement/poc3.mdx b/shared/signaling/geofencing/project-implement/poc3.mdx index 0372e6693..5612b8cb9 100644 --- a/shared/signaling/geofencing/project-implement/poc3.mdx +++ b/shared/signaling/geofencing/project-implement/poc3.mdx @@ -1,13 +1,13 @@ import ApplyConfig from '@docs/assets/code/signaling/engine-config/apply-geofencing-config.mdx' import GeofencingConfig from '@docs/assets/code/signaling/engine-config/set-area.mdx' -1. **Set the geofencing configuration** +### **Set the geofencing configuration** -2. **Apply the configuration to the ** +### **Apply the configuration to the ** diff --git a/shared/signaling/get-started-sdk/implementation/poc3.mdx b/shared/signaling/get-started-sdk/implementation/poc3.mdx index 8f0eaafe6..6bcd34f65 100644 --- a/shared/signaling/get-started-sdk/implementation/poc3.mdx +++ b/shared/signaling/get-started-sdk/implementation/poc3.mdx @@ -8,13 +8,13 @@ import Publish from '@docs/assets/code/signaling/get-started-sdk/publish.mdx' import Unsubscribe from '@docs/assets/code/signaling/get-started-sdk/unsubscribe.mdx' import Logout from '@docs/assets/code/signaling/get-started-sdk/logout.mdx' -1. **Declare the variable to hold a instance** +### **Declare the variable to hold a instance** You use these objects to communicate with . -1. **Define configuration parameters** +### **Define configuration parameters** Best practice is to keep these variables separate from your code. For example, in the reference app, we use the following `JSON` configuration file. @@ -31,19 +31,19 @@ import Logout from '@docs/assets/code/signaling/get-started-sdk/logout.mdx' -1. **Login to ** +### **Login to ** In , each token is specific to a user ID. If `uid` and `token` do not match, your user cannot initiate . -1. **Subscribe to a channel** +### **Subscribe to a channel** To start receiving messages and event notifications from a channel, you call `subscribe`. -1. **Send a message** +### **Send a message** Messages are published directly to a channel. @@ -51,13 +51,13 @@ import Logout from '@docs/assets/code/signaling/get-started-sdk/logout.mdx' You setup the event handlers for messages received from other users during initiation. -1. **Unsubscribe from a channel** +### **Unsubscribe from a channel** When you no longer need to receive channel notifications, call `unsubscribe`. -1. **Logout of ** +### **Logout of ** Had enough of the conversation? Just logout. diff --git a/shared/signaling/presence/project-implementation/poc3.mdx b/shared/signaling/presence/project-implementation/poc3.mdx index 148cdcca1..722052237 100644 --- a/shared/signaling/presence/project-implementation/poc3.mdx +++ b/shared/signaling/presence/project-implementation/poc3.mdx @@ -5,27 +5,27 @@ import ListUsers from '@docs/assets/code/signaling/presence/list-users.mdx' import SetUserStatus from '@docs/assets/code/signaling/presence/set-user-status.mdx' import GetUserStatus from '@docs/assets/code/signaling/presence/get-user-status.mdx' -1. **Add the presence event listener** +### **Add the presence event listener** -1. **Enable presence notifications when you subscribe to a channel** +### **Enable presence notifications when you subscribe to a channel** -1. **Obtain a list of users in the channel** +### **Obtain a list of users in the channel** To get a list of users in a channel, call `getOnlineUsers()`: -1. **Set local user status** +### **Set local user status** To set the local user status, call `setState`. -1. **Get the status of a remote user** +### **Get the status of a remote user** To read the status of a remote user, call `getState`. diff --git a/shared/signaling/storage/project-implementation/poc3.mdx b/shared/signaling/storage/project-implementation/poc3.mdx index 3ae64e71a..e54a6b702 100644 --- a/shared/signaling/storage/project-implementation/poc3.mdx +++ b/shared/signaling/storage/project-implementation/poc3.mdx @@ -8,50 +8,50 @@ import HandleMetadataEvents from '@docs/assets/code/signaling/storage/handle-met import ManageLocks from '@docs/assets/code/signaling/storage/manage-locks.mdx' -1. **Set local user metadata** +### **Set local user metadata** To set a key-value pair for the local user's metadata: -1. **Update local user metadata** +### **Update local user metadata** To update a value in the local user's metadata: -1. **Retrieve a user's metadata** +### **Retrieve a user's metadata** To get all the key-value pairs stored in a user's metadata: -1. **Subscribe to a user's metadata** +### **Subscribe to a user's metadata** To receive notifications of modifications to a user's data, you subscribe to the users metadata: -1. **Set channel metadata** +### **Set channel metadata** To store a key-value pair in the channel's metadata: -1. **Retrieve channel metadata** +### **Retrieve channel metadata** To get all the key-value pairs stored in a channels's metadata: -1. **Receive notification when a user's metadata is updated** +### **Receive notification when a user's metadata is updated** To get notified of changes in a user's metadata, handle the event callback: -1. **Manage Locks** +### **Manage Locks** Locks enable you to safely share critical resources between different users and processes in a distributed system. To set, acquire, release, remove, revoke locks, and get locks information: diff --git a/shared/signaling/stream-channel/project-implementation/poc3.mdx b/shared/signaling/stream-channel/project-implementation/poc3.mdx index d8195eb58..9382e070c 100644 --- a/shared/signaling/stream-channel/project-implementation/poc3.mdx +++ b/shared/signaling/stream-channel/project-implementation/poc3.mdx @@ -3,11 +3,11 @@ import JoinLeaveTopic from '@docs/assets/code/signaling/stream-channel/join-leav import PublishMessage from '@docs/assets/code/signaling/stream-channel/publish-message.mdx' import SubscribeTopic from '@docs/assets/code/signaling/stream-channel/subscribe-topic.mdx' -1. **Setup an event listener** +### **Setup an event listener** Keep track of the users who join and leave topics, and events in the topic. In this implementation, we use the event listener we implemented in the [SDK quickstart](/en/signaling/get-started/get-started-sdk#handle-events). -1. **Join and leave a stream channel** +### **Join and leave a stream channel** To create a new stream channel, call `createStreamChannel`. When you join the channel, you configure the features you will use. @@ -15,7 +15,7 @@ import SubscribeTopic from '@docs/assets/code/signaling/stream-channel/subscribe -1. **Join and leave a topic** +### **Join and leave a topic** A topic is a data stream management mechanism in stream channels. Users join, leave, subscribe, and unsubscribe to topics. You join a topic to publish and receive messages sent to all users in the topic. You subscribe to listen to messages sent by publishers only. When a user joins or leaves a topic, triggers an topic event notification. Users in the channel receive the notifications in real time. You use topic events to track changes in topic status. To join a topic: @@ -23,13 +23,13 @@ import SubscribeTopic from '@docs/assets/code/signaling/stream-channel/subscribe There is no limit to the number of subscribers and publishers in each topic. However, there are limitations to the [number of topics and messages a user can subscribe to](/en/signaling/reference/limitations). -1. **Publish messages to a topic** +### **Publish messages to a topic** Messages are transmitted through the topic. After your user has joined a topic in a channel, you publish messages to the topic. Publishers and subscribers receive the messages. To send a message: -1. **Subscribe to a topic** +### **Subscribe to a topic** To receive messages published to a topic, you subscribe to the topic. To subscribe: