855 signaling v2.2.6 native + web 2.2.3 (#1524)

* 2.2.6 rtm release-notes+api-ref

* review-update

Author: saudsami

shared/signaling/reference/api-ref/android/_configuration-en.android.mdx

@@ -27,7 +27,9 @@ RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId")
     .protocolType(protocolType)
     .presenceTimeout(300)
     .heartbeatInterval(5)
+    .reconnectTimeout(60)
     .useStringUserId(true)
+    .ispPolicyEnabled(false)
     .proxyConfig(proxyConfig)
     .logConfig(logConfig)
     .encryptionConfig(encryptionConfig)
@@ -44,7 +46,9 @@ RtmConfig rtmConfig = new RtmConfig.Builder("appid", "userId")
 | `protocolType` | <code>{enumv.protocoltype[props.ag_platform]}</code> | Optional | <code>{enumv.protocoltypeall[props.ag_platform]}</code> | Protocol types for message transmission. By default, Signaling utilizes one-way TCP and one-way UDP protocols for transmission. You have the flexibility to modify the protocol types based on your requirements. See <a href="#enumvprotocoltypepropsag_platform"><code>{enumv.protocoltype[props.ag_platform]}</code></a>. |
 | `presenceTimeout` | int | Optional | `300` | Presence timeout in seconds, and the value range is [5,300]. This parameter refers the delay imposed by the Signaling server before sending a <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other users once it determines that a client has timed out. If the client reconnects and returns to the channel within the specified time, the Signaling server does not send the <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other participants or delete the temporary user data associated with the user. |
 | `heartbeatInterval` | int | Optional | `5` | Heartbeat interval in seconds, and the value range is [5,1800]. This parameter refers to the time interval at which the client sends heartbeat packets to the Signaling server. If the client fails to send heartbeat packets to the Signaling server within the specified time, the Signaling server determines that the client has timed out. Please note that this parameter affects the PCU count, which in turn affects billing.|
+|  `reconnectTimeout` | int | Optional | `0` | SDK connection timeout in seconds. The value range is [15,3600]. The default value is `0` which means no timeout; the SDK keeps retrying until successful. This parameter applies to both the initial login to thee Signaling service and reconnection after disconnection: <ul><li>If the initial login times out, the SDK triggers the `onFailure` callback with `errorInfo` as `LOGIN_TIMEOUT`, and also triggers the `onLinkStateChanged` callback with `currentState` as `FAILED` and `reason` as `LOGIN_TIMEOUT`.</li><li>If reconnection times out, the SDK triggers the `onLinkStateChanged` callback with `currentState` as `FAILED` and `reason` as `RECONNECT_TIMEOUT`.</li></ul> |
 | `useStringUserId` | Bool | Optional | `true` | Whether to use string-type user IDs:<ul><li>`true`: Use string-type user IDs.</li><li>`false`: Use number-type user IDs. The SDK automatically converts string-type user IDs to number-type ones. In this case, the `userId` parameter must be a numeric string (for example, `"123456"`), otherwise initialization fails.</li> </ul>When using Agora RTC and Signaling products at the same time, it is necessary to ensure that the `userId` parameter is consistent. |
+| `ispPolicyEnabled` | Bool | Optional | `false` | Whether to enable the ISP domain policy restriction. In IoT scenarios, devices may be restricted by Internet Service Providers (ISPs). Use this field to set the SDK's connection mode to connect to servers with domains registered with the operator or those in the IP whitelist: <ul><li>`true`: Enable the ISP domain policy restriction. This setting applies to scenarios where IoT devices use IoT SIM cards for network access. The SDK will only connect to servers with domains registered with the operator or those in the IP whitelist.</li><li>`false`: (Default) Disable the ISP domain policy restriction. This setting applies to most common scenarios.</li></ul> |
 | `logConfig` | <code>{config.log[props.ag_platform]}</code> | Optional | - | Log configuration properties such as the log storage size, storage path, and level. |
 | `proxyConfig` | <code>{config.proxy[props.ag_platform]}</code> | Optional | - | When using the Proxy feature of Signaling, you need to configure this parameter. |
 | `encryptionConfig` | <code>{config.encryption[props.ag_platform]}</code> | Optional | - | When using the client-side encryption feature of Signaling, you need to configure this parameter. |

shared/signaling/reference/api-ref/linux-cpp/_configuration-en.cpp.mdx

@@ -30,7 +30,9 @@ config.areaCode = RTM_AREA_CODE_CN | RTM_AREA_CODE_AS;
 config.protocolType = RTM_PROTOCOL_TYPE_TCP_UDP;
 config.presenceTimeout = 300;
 config.heartbeatInterval = 5;
+config.reconnectTimeout = 60;
 config.useStringUserId = true;
+config.ispPolicyEnabled = false;
 config.proxyConfig = proxyConfig;
 config.logConfig = logConfig;
 config.encryptionConfig = encryptionConfig;
@@ -45,8 +47,10 @@ config.privateConfig = privateConfig;
 | `protocolType` | <code>{enumv.protocoltype[props.ag_platform]}</code> | Optional | <code>{enumv.protocoltypeall[props.ag_platform]}</code> | Protocol types for message transmission. Signaling by default utilizes one-way TCP and one-way UDP protocols for transmission, but you have the flexibility to modify the protocol types based on your requirements. See <a href="#enumvprotocoltypepropsag_platform"><code>{enumv.protocoltype[props.ag_platform]}</code></a>. |
 | `presenceTimeout` | uint32_t | Optional | `300` | Presence timeout in seconds, and the value range is [5,300]. This parameter refers the delay imposed by the Signaling server before sending a <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other users once it determines that a client has timed out. If the client reconnects and returns to the channel within the specified time, the Signaling server does not send the <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other participants or delete the temporary user data associated with the user. |
 | `heartbeatInterval` | int | Optional | `5` | Heartbeat interval in seconds, and the value range is [5,1800]. This parameter refers to the time interval at which the client sends heartbeat packets to the Signaling server. If the client fails to send heartbeat packets to the Signaling server within the specified time, the Signaling server determines that the client has timed out. Please note that this parameter affects the PCU count, which in turn affects billing.|
+|  `reconnectTimeout` | uint32_t | Optional | `0` | SDK connection timeout in seconds. The value range is [15,3600]. The default value is `0` which means no timeout; the SDK keeps retrying until successful. This parameter applies to both the initial login to the Signaling service and reconnection after disconnection: <ul><li>If the initial login times out, the SDK triggers the `onLoginResult` callback with `errorCode` as `RTM_ERROR_LOGIN_TIMEOUT`, and also triggers the `onLinkStateChanged` callback with `currentState` as `RTM_LINK_STATE_FAILED` and `reason` as `RTM_LINK_CHANGE_REASON_LOGIN_TIMEOUT`.</li><li>If reconnection times out, the SDK triggers the `onLinkStateChanged` callback with `currentState` as `RTM_LINK_STATE_FAILED` and `reason` as `RTM_LINK_CHANGE_REASON_RECONNECT_TIMEOUT`.</li></ul> |
 | `context` | void* | Optional | `NULL` | <ul><li>For Android, it is the context of Android Activity.</li><li>For Windows, it is the window handle of the app. Once set, this parameter enables you to connect or disconnect the video devices while they are powered.</li></ul> |
 | `useStringUserId` | bool | Optional | `true` | Whether to use string-type user IDs:<ul><li>`true`: Use string-type user IDs.</li><li>`false`: Use number-type user IDs. The SDK automatically converts string-type user IDs to number-type ones. In this case, the `userId` parameter must be a numeric string (for example, `"123457"`), otherwise initialization fails.</li> </ul>When using Agora RTC and Signaling products at the same time, it is necessary to ensure that the `userId` parameter is consistent. |
+| `ispPolicyEnabled` | Bool | Optional | `false` | Whether to enable the ISP domain policy restriction. In IoT scenarios, devices may be restricted by Internet Service Providers (ISPs). Use this field to set the SDK's connection mode to connect to servers with domains registered with the operator or those in the IP whitelist: <ul><li>`true`: Enable the ISP domain policy restriction. This setting applies to scenarios where IoT devices use IoT SIM cards for network access. The SDK will only connect to servers with domains registered with the operator or those in the IP whitelist.</li><li>`false`: (Default) Disable the ISP domain policy restriction. This setting applies to most common scenarios.</li></ul> |
 | `eventHandler` | `IRtmEventHandler` | Required | - | Signaling event notification listener settings. See [Event listeners](#event-listeners). |
 | `logConfig` | <code>{config.log[props.ag_platform]}</code> | Optional | - | Log configuration properties such as the log storage size, storage path, and level. |
 | `proxyConfig` | <code>{config.proxy[props.ag_platform]}</code> | Optional | - | When using the Proxy feature of Signaling, you need to configure this parameter. |

shared/signaling/reference/api-ref/obj-c/_configuration-en.ios.mdx

@@ -21,7 +21,28 @@ The API reference for the Signaling SDK documents interface descriptions, method
 You can create <code>{config.rtm[props.ag_platform]}</code> instances as follows:
 
 ```objc 
-AgoraRtmClientConfig* rtm_cfg = [[AgoraRtmClientConfig alloc] initWithAppId:@"your_appid" userId:@"your_userid"];
+__attribute__((visibility("default"))) @interface AgoraRtmClientConfig: NSObject
+
+- (instancetype _Nullable)init NS_UNAVAILABLE;
+
+- (instancetype _Nonnull) initWithAppId:(NSString * _Nonnull)appId
+                                 userId:(NSString * _Nonnull)userId;
+
+@property (nonatomic, assign) AgoraRtmAreaCode areaCode;
+@property (nonatomic, assign)  AgoraRtmProtocolType protocolType;
+@property (nonatomic, assign) unsigned int presenceTimeout;
+@property (nonatomic, assign) unsigned int heartbeatInterval;
+@property (nonatomic, assign) unsigned int reconnectTimeout;
+@property (nonatomic, copy, nonnull) NSString *appId;
+@property (nonatomic, copy, nonnull) NSString *userId;
+@property (nonatomic, assign) BOOL useStringUserId;
+@property (nonatomic, assign) BOOL multipath;
+@property (nonatomic, assign) BOOL ispPolicyEnabled;
+@property (nonatomic, copy, nullable) AgoraRtmLogConfig * logConfig;
+@property (nonatomic, copy, nullable) AgoraRtmProxyConfig * proxyConfig;
+@property (nonatomic, copy, nullable) AgoraRtmEncryptionConfig * encryptionConfig;
+@property (nonatomic, copy, nullable) AgoraRtmPrivateConfig * privateConfig;
+@end
 ```
 
 | Methods |  Description |
@@ -37,7 +58,9 @@ AgoraRtmClientConfig* rtm_cfg = [[AgoraRtmClientConfig alloc] initWithAppId:@"yo
 | `protocolType` | <code>{enumv.protocoltype[props.ag_platform]}</code> | Optional | <code>{enumv.protocoltypeall[props.ag_platform]}</code> | Protocol types for message transmission. Signaling by default utilizes one-way TCP and one-way UDP protocols for transmission, but you have the flexibility to modify the protocol types based on your requirements. See <a href="#enumvprotocoltypepropsag_platform"><code>{enumv.protocoltype[props.ag_platform]}</code></a>. |
 | `presenceTimeout` | unsigned int | Optional | `300` | Presence timeout in seconds, and the value range is [5,300]. This parameter refers the delay imposed by the Signaling server before sending a <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other users once it determines that a client has timed out. If the client reconnects and returns to the channel within the specified time, the Signaling server does not send the <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other participants or delete the temporary user data associated with the user. |
 | `heartbeatInterval` | unsigned int | Optional | `5` | Heartbeat interval in seconds, and the value range is [5,1800]. This parameter refers to the time interval at which the client sends heartbeat packets to the Signaling server. If the client fails to send heartbeat packets to the Signaling server within the specified time, the Signaling server determines that the client has timed out. Please note that this parameter affects the PCU count, which in turn affects billing.|
+|  `reconnectTimeout` | uint32_t | Optional | `0` | SDK connection timeout in seconds. The value range is [15,3600]. The default value is `0` which means no timeout; the SDK keeps retrying until successful. This parameter applies to both the initial login to the Signaling service and reconnection after disconnection: <ul><li>If the initial login times out, the SDK triggers the `completion` callback with `errorInfo` as `AgoraRtmErrorLoginTimeout`, and also triggers the `didReceiveLinkStateEvent` callback with `currentState` as `AgoraRtmLinkStateFailed` and `reasonCode` as `AgoraRtmLinkStateChangeReasonLoginTimeout`.</li><li>If reconnection times out, the SDK triggers the `didReceiveLinkStateEvent` callback with `currentState` as `AgoraRtmLinkStateFailed` and `reasonCode` as `AgoraRtmLinkStateChangeReasonReconnectTimeout`.</li></ul> |
 | `useStringUserId` | BOOL | Optional | `true` | Whether to use string-type user IDs:<ul><li>`true`: Use string-type user IDs.</li><li>`false`: Use number-type user IDs. The SDK automatically converts string-type user IDs to number-type ones. ones. In this case, the `userId` parameter must be a numeric string (for example, `"123456"`), otherwise initialization fails.</li> </ul>When using Agora RTC and Signaling products at the same time, it is necessary to ensure that the userId parameter is consistent. |
+| `ispPolicyEnabled` | Bool | Optional | `false` | Whether to enable the ISP domain policy restriction. In IoT scenarios, devices may be restricted by Internet Service Providers (ISPs). Use this field to set the SDK's connection mode to connect to servers with domains registered with the operator or those in the IP whitelist: <ul><li>`true`: Enable the ISP domain policy restriction. This setting applies to scenarios where IoT devices use IoT SIM cards for network access. The SDK will only connect to servers with domains registered with the operator or those in the IP whitelist.</li><li>`false`: (Default) Disable the ISP domain policy restriction. This setting applies to most common scenarios.</li></ul> |
 | `logConfig` | <code>{config.log[props.ag_platform]}</code> | Optional | - | Log configuration properties such as the log storage size, storage path, and level. |
 | `proxyConfig` | <code>{config.proxy[props.ag_platform]}</code> | Optional | - | When using the Proxy feature of Signaling, you need to configure this parameter. |
 | `encryptionConfig` | <code>{config.encryption[props.ag_platform]}</code> | Optional | - | When using the client-side encryption feature of Signaling, you need to configure this parameter. |

shared/signaling/reference/api-ref/swift/_configuration-en.swift.mdx

@@ -22,9 +22,11 @@ AgoraRtmClientConfig(
     appId: String,
     userId: String,
     useStringUserId: Bool,
+    ispPolicyEnabled: Bool,
     multipath: Bool,
     presenceTimeout: UInt32,
     heartbeatInterval: UInt32,
+    reconnectTimeout: UInt32,
     areaCode: AgoraRtmAreaCode,
     proxyConfig: AgoraRtmProxyConfig?,
     protocolType: AgoraRtmProtocolType,
@@ -44,7 +46,9 @@ AgoraRtmClientConfig(
 | `protocolType` | <code>{enumv.protocoltype[props.ag_platform]}</code> | Optional | <code>{enumv.protocoltypeall[props.ag_platform]}</code> | Protocol types for message transmission. Signaling by default utilizes one-way TCP and one-way UDP protocols for transmission, but you have the flexibility to modify the protocol types based on your requirements. See <a href="#enumvprotocoltypepropsag_platform"><code>{enumv.protocoltype[props.ag_platform]}</code></a>. |
 | `presenceTimeout` | unsigned int | Optional | `300` | Presence timeout in seconds, and the value range is [5,300]. This parameter refers the delay imposed by the Signaling server before sending a <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other users once it determines that a client has timed out. If the client reconnects and returns to the channel within the specified time, the Signaling server does not send the <code>{enumv.presencetypetimeout[props.ag_platform]}</code> event notification to other participants or delete the temporary user data associated with the user. |
 | `heartbeatInterval` | unsigned int | Optional | `5` | Heartbeat interval in seconds, and the value range is [5,1800]. This parameter refers to the time interval at which the client sends heartbeat packets to the Signaling server. If the client fails to send heartbeat packets to the Signaling server within the specified time, the Signaling server determines that the client has timed out. Please note that this parameter affects the PCU count, which in turn affects billing.|
+|  `reconnectTimeout` | uint32_t | Optional | `0` | SDK connection timeout in seconds. The value range is [15,3600]. The default value is `0` which means no timeout; the SDK keeps retrying until successful. This parameter applies to both the initial login to the Signaling service and reconnection after disconnection: <ul><li>If the initial login times out, the SDK triggers the `completion` callback with `errorInfo` as `AgoraRtmErrorLoginTimeout`, and also triggers the `didReceiveLinkStateEvent` callback with `currentState` as `AgoraRtmLinkStateFailed` and `reasonCode` as `AgoraRtmLinkStateChangeReasonLoginTimeout`.</li><li>If reconnection times out, the SDK triggers the `didReceiveLinkStateEvent` callback with `currentState` as `AgoraRtmLinkStateFailed` and `reasonCode` as `AgoraRtmLinkStateChangeReasonReconnectTimeout`.</li></ul> |
 | `useStringUserId` | BOOL | Optional | `true` | Whether to use string-type user IDs:<ul><li>`true`: Use string-type user IDs.</li><li>`false`: Use number-type user IDs. The SDK automatically converts string-type user IDs to number-type ones. ones. In this case, the `userId` parameter must be a numeric string (for example, `"123456"`), otherwise initialization fails.</li> </ul>When using Agora RTC and Signaling products at the same time, it is necessary to ensure that the userId parameter is consistent. |
+| `ispPolicyEnabled` | Bool | Optional | `false` | Whether to enable the ISP domain policy restriction. In IoT scenarios, devices may be restricted by Internet Service Providers (ISPs). Use this field to set the SDK's connection mode to connect to servers with domains registered with the operator or those in the IP whitelist: <ul><li>`true`: Enable the ISP domain policy restriction. This setting applies to scenarios where IoT devices use IoT SIM cards for network access. The SDK will only connect to servers with domains registered with the operator or those in the IP whitelist.</li><li>`false`: (Default) Disable the ISP domain policy restriction. This setting applies to most common scenarios.</li></ul> |
 | `logConfig` | <code>{config.log[props.ag_platform]}</code> | Optional | - | Log configuration properties such as the log storage size, storage path, and level. |
 | `proxyConfig` | <code>{config.proxy[props.ag_platform]}</code> | Optional | - | When using the Proxy feature of Signaling, you need to configure this parameter. |
 | `encryptionConfig` | <code>{config.encryption[props.ag_platform]}</code> | Optional | - | When using the client-side encryption feature of Signaling, you need to configure this parameter. |