diff --git a/shared/video-sdk/reference/_error-codes.mdx b/shared/video-sdk/reference/_error-codes.mdx index 6dd796103..1f532f6f4 100644 --- a/shared/video-sdk/reference/_error-codes.mdx +++ b/shared/video-sdk/reference/_error-codes.mdx @@ -1,5 +1,4 @@ -import ErrorCodeReturnedWays from '@docs/shared/video-sdk/reference/error-codes/error-code-returned-ways/index.mdx'; -import ErrorCodes from '@docs/shared/video-sdk/reference/error-codes/codes/index.mdx'; +import ErrorCodes from '@docs/shared/video-sdk/reference/error-codes/index.mdx'; When interacting with the Agora API, the may return an error code. Receiving an error code indicates that the SDK has encountered an unrecoverable error that necessitates intervention from your . @@ -14,6 +13,19 @@ The error codes listed in this section apply to Agora RTC v4.x SDK on the follow During the operation of Agora SDK, error codes may be returned in the following ways: - + +- For asynchronous methods, the SDK returns a Promise to notify the result of the asynchronous operation, and the SDK throws the appropriate error code when the Promise is rejected. +- When a synchronous method call fails, the SDK throws an error code directly. + The SDK may also throw some network related error codes during internal operation. + +The SDK's error object `AgoraRTCError` inherits from the browser's [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object. Print out the error code on the console via `AgoraRTCError.code` since directly printing the `AgoraRTCError` object will only show the error message. + + + +- In the return value of a failed method call. +- Through the `onError` callback. + +
  • When the SDK returns an error code, it may return a negative number. This negative number corresponds to the positive integer in the error code. For example, a returned value of `-2` corresponds to the error code `2`.
  • The API names on this page are based on C++. The API names of other platforms may be different. Please refer to the API documentation of the corresponding platform.
 + diff --git a/shared/video-sdk/reference/error-codes/codes/android.mdx b/shared/video-sdk/reference/error-codes/codes/android.mdx deleted file mode 100644 index 32f76dd58..000000000 --- a/shared/video-sdk/reference/error-codes/codes/android.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/blueprint.mdx b/shared/video-sdk/reference/error-codes/codes/blueprint.mdx deleted file mode 100644 index baba50bf9..000000000 --- a/shared/video-sdk/reference/error-codes/codes/blueprint.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/electron.mdx b/shared/video-sdk/reference/error-codes/codes/electron.mdx deleted file mode 100644 index 7fb009448..000000000 --- a/shared/video-sdk/reference/error-codes/codes/electron.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/flutter.mdx b/shared/video-sdk/reference/error-codes/codes/flutter.mdx deleted file mode 100644 index c4c619d4b..000000000 --- a/shared/video-sdk/reference/error-codes/codes/flutter.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/index.mdx b/shared/video-sdk/reference/error-codes/codes/index.mdx deleted file mode 100644 index b7092aeb1..000000000 --- a/shared/video-sdk/reference/error-codes/codes/index.mdx +++ /dev/null @@ -1,25 +0,0 @@ -import Android from './android.mdx'; -import Ios from './ios.mdx'; -import Web from './web.mdx'; -import ReactNative from './react-native.mdx'; -import Electron from './electron.mdx'; -import Flutter from './flutter.mdx'; -import Unity from './unity.mdx'; -import MacOS from './macos.mdx'; -import Windows from './windows.mdx'; -import ReactJS from './react-js.mdx'; -import Unreal from './unreal.mdx'; -import UnrealBlueprint from './blueprint.mdx'; - - - - - - - - - - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/ios.mdx b/shared/video-sdk/reference/error-codes/codes/ios.mdx deleted file mode 100644 index 42624549d..000000000 --- a/shared/video-sdk/reference/error-codes/codes/ios.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import Swift from './swift.mdx'; - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/macos.mdx b/shared/video-sdk/reference/error-codes/codes/macos.mdx deleted file mode 100644 index 3a203936e..000000000 --- a/shared/video-sdk/reference/error-codes/codes/macos.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import Swift from './swift.mdx'; - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/react-js.mdx b/shared/video-sdk/reference/error-codes/codes/react-js.mdx deleted file mode 100644 index 12dcd3e04..000000000 --- a/shared/video-sdk/reference/error-codes/codes/react-js.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/react-native.mdx b/shared/video-sdk/reference/error-codes/codes/react-native.mdx deleted file mode 100644 index 6dc772982..000000000 --- a/shared/video-sdk/reference/error-codes/codes/react-native.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/swift.mdx b/shared/video-sdk/reference/error-codes/codes/swift.mdx deleted file mode 100644 index 35434264e..000000000 --- a/shared/video-sdk/reference/error-codes/codes/swift.mdx +++ /dev/null @@ -1,3 +0,0 @@ -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/unity.mdx b/shared/video-sdk/reference/error-codes/codes/unity.mdx deleted file mode 100644 index 03dd035a8..000000000 --- a/shared/video-sdk/reference/error-codes/codes/unity.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/unreal.mdx b/shared/video-sdk/reference/error-codes/codes/unreal.mdx deleted file mode 100644 index 4c80fb682..000000000 --- a/shared/video-sdk/reference/error-codes/codes/unreal.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/web.mdx b/shared/video-sdk/reference/error-codes/codes/web.mdx deleted file mode 100644 index 930bf3cae..000000000 --- a/shared/video-sdk/reference/error-codes/codes/web.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import WebErrorCodes from './web-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/codes/windows.mdx b/shared/video-sdk/reference/error-codes/codes/windows.mdx deleted file mode 100644 index c98d5d622..000000000 --- a/shared/video-sdk/reference/error-codes/codes/windows.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import NonWebCommonErrorCodes from './non-web-common-error-codes.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/android.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/android.mdx deleted file mode 100644 index b994ab7f4..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/android.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/blueprint.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/blueprint.mdx deleted file mode 100644 index cafe03dd1..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/blueprint.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/electron.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/electron.mdx deleted file mode 100644 index ad7b81ed9..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/electron.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/flutter.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/flutter.mdx deleted file mode 100644 index 0b3fa5623..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/flutter.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/index.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/index.mdx deleted file mode 100644 index b7092aeb1..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/index.mdx +++ /dev/null @@ -1,25 +0,0 @@ -import Android from './android.mdx'; -import Ios from './ios.mdx'; -import Web from './web.mdx'; -import ReactNative from './react-native.mdx'; -import Electron from './electron.mdx'; -import Flutter from './flutter.mdx'; -import Unity from './unity.mdx'; -import MacOS from './macos.mdx'; -import Windows from './windows.mdx'; -import ReactJS from './react-js.mdx'; -import Unreal from './unreal.mdx'; -import UnrealBlueprint from './blueprint.mdx'; - - - - - - - - - - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/ios.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/ios.mdx deleted file mode 100644 index 42624549d..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/ios.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import Swift from './swift.mdx'; - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/macos.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/macos.mdx deleted file mode 100644 index 3a203936e..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/macos.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import Swift from './swift.mdx'; - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/non-web-ways.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/non-web-ways.mdx deleted file mode 100644 index 24dda9594..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/non-web-ways.mdx +++ /dev/null @@ -1,4 +0,0 @@ -- In the return value of a failed method call. -- Through the `onError` callback. - -
  • When the SDK returns an error code, it may return a negative number. This negative number corresponds to the positive integer in the error code. For example, a returned value of `-2` corresponds to the error code `2`.
  • The API names on this page are based on C++. The API names of other platforms may be different. Please refer to the API documentation of the corresponding platform.
 \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-js.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-js.mdx deleted file mode 100644 index 14c091d37..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-js.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-native.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-native.mdx deleted file mode 100644 index ee871983e..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/react-native.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/swift.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/swift.mdx deleted file mode 100644 index 0bd7e84fd..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/swift.mdx +++ /dev/null @@ -1,3 +0,0 @@ -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/unity.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/unity.mdx deleted file mode 100644 index a24693a32..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/unity.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/unreal.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/unreal.mdx deleted file mode 100644 index b08c98b3a..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/unreal.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/web-ways.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/web-ways.mdx deleted file mode 100644 index 1e7541d43..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/web-ways.mdx +++ /dev/null @@ -1,5 +0,0 @@ -- For asynchronous methods, the SDK returns a Promise to notify the result of the asynchronous operation, and the SDK throws the appropriate error code when the Promise is rejected. -- When a synchronous method call fails, the SDK throws an error code directly. - The SDK may also throw some network related error codes during internal operation. - -The SDK's error object `AgoraRTCError` inherits from the browser's [Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) object. Print out the error code on the console via `AgoraRTCError.code` since directly printing the `AgoraRTCError` object will only show the error message. \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/web.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/web.mdx deleted file mode 100644 index 0fd77749e..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/web.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/error-code-returned-ways/windows.mdx b/shared/video-sdk/reference/error-codes/error-code-returned-ways/windows.mdx deleted file mode 100644 index cac41b065..000000000 --- a/shared/video-sdk/reference/error-codes/error-code-returned-ways/windows.mdx +++ /dev/null @@ -1,6 +0,0 @@ - -import ErrorCodeReturnedWays from './non-web-ways.mdx' - - - - \ No newline at end of file diff --git a/shared/video-sdk/reference/error-codes/index.mdx b/shared/video-sdk/reference/error-codes/index.mdx new file mode 100644 index 000000000..29da4af91 --- /dev/null +++ b/shared/video-sdk/reference/error-codes/index.mdx @@ -0,0 +1,10 @@ +import NonWebErrorCodes from './non-web-error-codes.mdx' +import WebErrorCodes from './web-error-codes.mdx' + + + + + + + + diff --git a/shared/video-sdk/reference/error-codes/codes/non-web-common-error-codes.mdx b/shared/video-sdk/reference/error-codes/non-web-error-codes.mdx similarity index 100% rename from shared/video-sdk/reference/error-codes/codes/non-web-common-error-codes.mdx rename to shared/video-sdk/reference/error-codes/non-web-error-codes.mdx diff --git a/shared/video-sdk/reference/error-codes/codes/web-error-codes.mdx b/shared/video-sdk/reference/error-codes/web-error-codes.mdx similarity index 100% rename from shared/video-sdk/reference/error-codes/codes/web-error-codes.mdx rename to shared/video-sdk/reference/error-codes/web-error-codes.mdx