diff --git a/shared/signaling/get-started-sdk/setup/android.mdx b/shared/signaling/get-started-sdk/setup/android.mdx index 17fa687a8..734b101b9 100644 --- a/shared/signaling/get-started-sdk/setup/android.mdx +++ b/shared/signaling/get-started-sdk/setup/android.mdx @@ -114,7 +114,7 @@ Use either of the following methods to integrate into your proje }`} - Replace `x.y.z` with the specific SDK version number, such as 2.1.10. To get the latest version number, check the [Release notes](../overview/release-notes). + Replace `x.y.z` with the specific SDK version number, such as 2.2.1. To get the latest version number, check the [Release notes](../overview/release-notes). diff --git a/shared/signaling/get-started-sdk/setup/web.mdx b/shared/signaling/get-started-sdk/setup/web.mdx index 023b10e9f..466372975 100644 --- a/shared/signaling/get-started-sdk/setup/web.mdx +++ b/shared/signaling/get-started-sdk/setup/web.mdx @@ -28,7 +28,7 @@ Use either of the following methods to integrate into your proje {``} - Replace `x.y.z` with the specific SDK version number, such as 2.1.9. To get the latest version number, check the [Release notes](../overview/release-notes). + Replace `x.y.z` with the specific SDK version number, such as 2.2.0. To get the latest version number, check the [Release notes](../overview/release-notes). diff --git a/shared/signaling/migration-guide/web.mdx b/shared/signaling/migration-guide/web.mdx index f2a5908a8..c613011f6 100644 --- a/shared/signaling/migration-guide/web.mdx +++ b/shared/signaling/migration-guide/web.mdx @@ -19,46 +19,27 @@ The SDK package names for `2.x` and `1.x` are different. Both ver To use CDN, directly add the following code to your web application or download the SDK file for local reference. - - `1.x` integration: - ```javascript - // Replace x.y.z with the specific SDK version number, such as 1.5.1 - - ``` + `2.x` integration: - - `2.x` integration: ```javascript // Replace x.y.z with the specific SDK version number, such as 2.2.0 ``` - - - `1.x` usage: + + 1. Install the SDK via npm package manager in your terminal. `npm install agora-rtm-sdk` - 2. Import it into your `app.js`: - - `import AgoraRTM from 'agora-rtm-sdk';` - - - `2.x` usage: - - 1. Install the SDK via npm package manager in your terminal. - - `npm install agora-rtm` - 2. Import it into your `app.js`. - `import AgoraRTM from 'agora-rtm';` + `import AgoraRTM from 'agora-rtm-sdk';` - -The package name for the `2.x` SDK is `agora-rtm`, whereas the package name for the `1.x` SDK is `agora-rtm-sdk`. - - ## Initialize a client instance Compared to `1.x`, `2.x` makes significant adjustments to the initialization parameters, adding many new features such as client-side encryption and cloud proxy. For details, see the [API Reference](../reference/api/). Additionally, `2.x` optimizes error handling within the `try {...} catch {...}` programming model by categorizing potential errors and using the `ErrorInfo` data structure for callbacks, helping you troubleshoot issues more efficiently. By referencing the [Error Codes](../reference/api#error-codes-table) table, you can quickly find the cause of an error and its solution. diff --git a/shared/signaling/reference/api-ref/web/_configuration-en.javascript.mdx b/shared/signaling/reference/api-ref/web/_configuration-en.javascript.mdx index 65a7a3638..58787bc8e 100644 --- a/shared/signaling/reference/api-ref/web/_configuration-en.javascript.mdx +++ b/shared/signaling/reference/api-ref/web/_configuration-en.javascript.mdx @@ -7,7 +7,7 @@ The Signaling SDK API Reference lists the description, methods, basic usage, sam Before initializing a Signaling client instance, you need to import the Signaling Javascript SDK into your project first: ```js - + ``` ### Initialization