Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Signaling Page Content Navigation Bar #1501

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ 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 <Vpl k="CLIENT" /> with <Vg k="MESS" /> using <Vpd k="SDK" />:

1. **Retrieve an RTM token from the server**
### **Retrieve an RTM token from the server**

<RTMToken/>

2. **Use the token to login into the <Vg k="MESS_ENGINE" />**
### **Use the token to login into the <Vg k="MESS_ENGINE" />**

Call `fetchToken` to get a fresh RTM token. Use the token in the config to initiate the <Vg k="MESS_ENGINE" />.

<Login/>

<PlatformWrapper notAllowed={['ios','macos']}>

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

Expand All @@ -32,33 +32,33 @@ To retrieve tokens from the token server and use them to authenticate your <Vpl
</PlatformWrapper>

<PlatformWrapper notAllowed={['ios','macos']}>
4. **Use the Stream Channel token to join a stream channel**
### **Use the Stream Channel token to join a stream channel**

<JoinStreamChannel/>
</PlatformWrapper>
<PlatformWrapper platform={['ios','macos']}>
3. **Use the Stream Channel token to join a stream channel**
### **Use the Stream Channel token to join a stream channel**

<JoinStreamChannel/>
</PlatformWrapper>

<PlatformWrapper notAllowed={['ios','macos']}>
5. **Handle the event triggered by <Vg k="AGORA_BACKEND" /> when the token is about to expire**
### **Handle the event triggered by <Vg k="AGORA_BACKEND" /> when the token is about to expire**

<ExpireEvent/>
</PlatformWrapper>
<PlatformWrapper platform={['ios','macos']}>
4. **Handle the event triggered by <Vg k="AGORA_BACKEND" /> when the token is about to expire**
### **Handle the event triggered by <Vg k="AGORA_BACKEND" /> when the token is about to expire**
<ExpireEvent/>
</PlatformWrapper>

<PlatformWrapper notAllowed={['ios','macos']}>
6. **Renew the token**
### **Renew the token**

<RenewToken/>
</PlatformWrapper>
<PlatformWrapper platform={['ios','macos']}>
4. **Renew the token**
### **Renew the token**

<RenewToken/>
</PlatformWrapper>
Expand Down
4 changes: 2 additions & 2 deletions shared/signaling/cloud-proxy/project-implementation/poc3.mdx
Original file line number Diff line number Diff line change
@@ -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**

<ProxyConfig/>

2. **Apply the configuration to the <Vg k="MESS_ENGINE" />**
### **Apply the configuration to the <Vg k="MESS_ENGINE" />**

<ApplyConfig/>
Original file line number Diff line number Diff line change
@@ -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**

<EncryptionConfig/>

1. **Apply the configuration to the <Vg k="MESS_ENGINE" />**
### **Apply the configuration to the <Vg k="MESS_ENGINE" />**

<ApplyConfig/>
4 changes: 2 additions & 2 deletions shared/signaling/geofencing/project-implement/poc3.mdx
Original file line number Diff line number Diff line change
@@ -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**

<GeofencingConfig/>

<PlatformWrapper notAllowed="web">

2. **Apply the configuration to the <Vg k="MESS_ENGINE" />**
### **Apply the configuration to the <Vg k="MESS_ENGINE" />**

<ApplyConfig/>

Expand Down
14 changes: 7 additions & 7 deletions shared/signaling/get-started-sdk/implementation/poc3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Vg k="MESS_ENGINE" /> instance**
### **Declare the variable to hold a <Vg k="MESS_ENGINE" /> instance**

You use these objects to communicate with <Vg k="SIG" />.

<EngineInstance />

1. **Define configuration parameters**
### **Define configuration parameters**

Best practice is to keep these variables separate from your code. For example, in the <Vg k="SIG" /> reference app, we use the following `JSON` configuration file.

Expand All @@ -31,33 +31,33 @@ import Logout from '@docs/assets/code/signaling/get-started-sdk/logout.mdx'

<RespondToEvents/>

1. **Login to <Vg k="SIG" />**
### **Login to <Vg k="SIG" />**

In <Vg k="SIG" />, each token is specific to a user ID. If `uid` and `token` do not match, your user cannot initiate <Vg k="MESS_ENGINE" />.

<Login/>

1. **Subscribe to a channel**
### **Subscribe to a channel**

To start receiving messages and event notifications from a channel, you call `subscribe`.

<Subscribe/>

1. **Send a message**
### **Send a message**

Messages are published directly to a channel.

<Publish/>

You setup the event handlers for messages received from other users during <Vg k="MESS_ENGINE" /> initiation.

1. **Unsubscribe from a channel**
### **Unsubscribe from a channel**

When you no longer need to receive channel notifications, call `unsubscribe`.

<Unsubscribe/>

1. **Logout of <Vg k="SIG" />**
### **Logout of <Vg k="SIG" />**

Had enough of the conversation? Just logout.

Expand Down
10 changes: 5 additions & 5 deletions shared/signaling/presence/project-implementation/poc3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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**

<EventListener/>

1. **Enable presence notifications when you subscribe to a channel**
### **Enable presence notifications when you subscribe to a channel**

<EnableNotifications/>

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()`:

<ListUsers/>

1. **Set local user status**
### **Set local user status**

To set the local user status, call `setState`.

<SetUserStatus/>

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

Expand Down
16 changes: 8 additions & 8 deletions shared/signaling/storage/project-implementation/poc3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<SetUserMetadata/>

1. **Update local user metadata**
### **Update local user metadata**

To update a value in the local user's metadata:

<UpdateUserMetadata/>

1. **Retrieve a user's metadata**
### **Retrieve a user's metadata**

To get all the key-value pairs stored in a user's metadata:

<GetUserMetadata/>

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:

<SubscribeUserMetadata/>

1. **Set channel metadata**
### **Set channel metadata**

To store a key-value pair in the channel's metadata:

<SetChannelMetadata/>

1. **Retrieve channel metadata**
### **Retrieve channel metadata**

To get all the key-value pairs stored in a channels's metadata:

<GetChannelMetadata/>

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:

<HandleMetadataEvents/>

<a id="manage-locks"></a>
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:

Expand Down
10 changes: 5 additions & 5 deletions shared/signaling/stream-channel/project-implementation/poc3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,33 @@ 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.

<JoinLeaveChannel/>

<a id="topics"></a>

1. **Join and leave a topic** <a name='topic'></a>
### **Join and leave a topic** <a name='topic'></a>

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, <Vg k="MESS"/> 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:

<JoinLeaveTopic/>

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:

<PublishMessage/>

1. **Subscribe to a topic**
### **Subscribe to a topic**

To receive messages published to a topic, you subscribe to the topic. To subscribe:

Expand Down
Loading