Skip to content

Commit

Permalink
Merge branch 'milestone-75-signaling-docs-revamp' of https://github.c…
Browse files Browse the repository at this point in the history
…om/AgoraIO/Doc-Source-Private into milestone-75-signaling-docs-revamp
  • Loading branch information
atovpeko committed Jun 17, 2024
2 parents 8ebd313 + 4824b57 commit 479d180
Show file tree
Hide file tree
Showing 5 changed files with 85 additions and 1 deletion.
4 changes: 3 additions & 1 deletion shared/signaling/channel-basics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Conceptually, a channel is a conduit that controls the flow of messages. <Vg k="

## Channel naming

A channel name cannot be empty. It must be a string of up to 64 bytes in length, consisting of letters or numbers from the ASCII character set. <Vg k="SIG" /> uses the App ID as the namespace for the channel. Each channel under the app ID is jointly identified by the channel name and the channel type. If two channels have different channel types or different channel names, <Vg k="SIG" /> treats them as two separate channels. If two channels have the same channel type and channel name, <Vg k="SIG" /> treats them as the same channel.
A channel name cannot be empty. It must be a string of up to 64 bytes in length, consisting of letters or numbers from the ASCII character set. <Vg k="SIG" /> uses the app ID as the namespace for the channel. Each channel under the app ID is jointly identified by the channel name and the channel type. If two channels have different channel types or different channel names, <Vg k="SIG" /> treats them as two separate channels. If two channels have the same channel type and channel name, <Vg k="SIG" /> treats them as the same channel.

### Legal characters

Expand All @@ -31,6 +31,8 @@ The supported legal characters are:
- Space
- `!`, `#`, `$`, `%`, `&`, `(`, `)`, `+`, `,`, `-`, `:`, `;`, `<`, `=`, `>`, `?`, `@`, `[`, `]`, `^`, `_`, `{`, `|`, `}`, `~`, `` ` ``

<Admonition type="caution" title="Note">Channel names cannot be prefixed with an underscore. </Admonition>

### Illegal characters

The use of `.`, `*`, `/`, `\`, `\0` and non-printable ASCII characters in channel names is not allowed.
Expand Down
21 changes: 21 additions & 0 deletions shared/signaling/release-notes/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ import * as presence from '@docs/shared/signaling/reference/api-ref/shared/_pres
import * as storage from '@docs/shared/signaling/reference/api-ref/shared/_storage.mdx'
import * as lock from '@docs/shared/signaling/reference/api-ref/shared/_lock.mdx'

### v2.1.12

v2.1.12 was released on June X, 2024.

#### Improvements

This release includes the following improvements:

- For data synchronization errors caused by network issues, this release introduces a user logout mechanism, which ensures that the SDK automatically logs out of the Signaling system.
- Unsubscribing from a message channel during network disconnection will no longer return an error.

#### Fixed issues

This release fixed the following issues:

- During a disconnection with the Signaling system under poor network conditions, the user experienced errors when unsubscribing from a message channel.
- Under poor network conditions, the user occasionally failed to receive callbacks after a successful login.
- After reconnecting from a disconnection, the user occasionally could not receive the <code>{config.onstorageevent[props .ag_platform]}</code> event notification.
- After reconnecting from a disconnection, the SDK occasionally failed to restore subscription relationships in the stream channel.
- Occasional failure to receive topic messages from web clients.

### v2.1.11

v2.1.11 was released on May 13, 2024.
Expand Down
21 changes: 21 additions & 0 deletions shared/signaling/release-notes/ios.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ import * as presence from '@docs/shared/signaling/reference/api-ref/shared/_pres
import * as storage from '@docs/shared/signaling/reference/api-ref/shared/_storage.mdx'
import * as lock from '@docs/shared/signaling/reference/api-ref/shared/_lock.mdx'

### v2.1.12

v2.1.12 was released on June X, 2024.

#### Improvements

This release includes the following improvements:

- For data synchronization errors caused by network issues, this release introduces a user logout mechanism, which ensures that the SDK automatically logs out of the Signaling system.
- Unsubscribing from a message channel during network disconnection will no longer return an error.

#### Fixed issues

This release fixed the following issues:

- During a disconnection with the Signaling system under poor network conditions, the user experienced errors when unsubscribing from a message channel.
- Under poor network conditions, the user occasionally failed to receive callbacks after a successful login.
- After reconnecting from a disconnection, the user occasionally could not receive the <code>{config.onstorageevent[props.ag_platform]}</code> event notification.
- After reconnecting from a disconnection, the SDK occasionally failed to restore subscription relationships in the stream channel.
- Occasional failure to receive topic messages from web clients.

### v2.1.11

v2.1.11 was released on May 13, 2024.
Expand Down
21 changes: 21 additions & 0 deletions shared/signaling/release-notes/linux-cpp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,27 @@ import * as lock from '@docs/shared/signaling/reference/api-ref/shared/_lock.mdx

<PlatformWrapper platform='linux-cpp'>

### v2.1.12

v2.1.12 was released on June X, 2024.

#### Improvements

This release includes the following improvements:

- For data synchronization errors caused by network issues, this release introduces a user logout mechanism, which ensures that the SDK automatically logs out of the Signaling system.
- Unsubscribing from a message channel during network disconnection will no longer return an error.

#### Fixed issues

This release fixed the following issues:

- During a disconnection with the Signaling system under poor network conditions, the user experienced errors when unsubscribing from a message channel.
- Under poor network conditions, the user occasionally failed to receive callbacks after a successful login.
- After reconnecting from a disconnection, the user occasionally could not receive the <code>{config.onstorageevent[props.ag_platform]}</code> event notification.
- After reconnecting from a disconnection, the SDK occasionally failed to restore subscription relationships in the stream channel.
- Occasional failure to receive topic messages from web clients.

### v2.1.11

v2.1.11 was released on May 13, 2024.
Expand Down
19 changes: 19 additions & 0 deletions shared/signaling/release-notes/web.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ import * as lock from '@docs/shared/signaling/reference/api-ref/shared/_lock.mdx

<PlatformWrapper platform="web">

### v2.1.10

v2.1.10 was released on June X, 2024.

#### Improvements

This release improves the error code prompt for failed `login` method calls. For example, when you enable token authentication but use an app ID for initialization, the `RTM_ERROR_INVALID_TOKEN (-10005)` error code is returned during login.

#### Fixed issues

This release addresses the following issues:

- In scenarios involving frequent setting and retrieving of locks, the user experienced occasional inaccuracies in the `lock` event notification.
- After reconnecting from a disconnection, the SDK occasionally failed to initialize the presence service when calling the `subscribe` method.
- Occasional message reception failure in apps developed using the Vite framework.
- After joining a channel and reconnecting from a disconnection, the user failed to receive the `lock` and `storage` event notifications.
- Occasional duplicate receipt of the `storage` event notifications with the `UPDATE` type when updating the user metadata.
- Occasional duplicate receipt of the `lock` event notifications with the `REMOVED` type when removing locks.

### v2.1.9

v2.1.9 was released on March 12, 2024.
Expand Down

0 comments on commit 479d180

Please sign in to comment.