feat(example): add getOnlineUsers and getUserChannels (#4)

AgoraIO-Extensions · Nov 23, 2023 · 2bc1363 · 2bc1363
1 parent 4e08fcb
commit 2bc1363
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 2 deletions.
diff --git a/example/src/advanced/Presence/index.tsx b/example/src/advanced/Presence/index.tsx
@@ -29,6 +29,8 @@ export default function Presence() {
   const [loginSuccess, setLoginSuccess] = useState(false);
   const [subscribeSuccess, setSubscribeSuccess] = useState(false);
   const whoNowRequestId = useRef<number>();
+  const getOnlineRequestId = useRef<number>();
+  const getUserChannelsRequestId = useRef<number>();
   const whereNowRequestId = useRef<number>();
   const setStateRequestId = useRef<number>();
   const getStateRequestId = useRef<number>();
@@ -89,6 +91,40 @@ export default function Presence() {
     [cName]
   );
 
+  const onGetOnlineUsersResult = useCallback(
+    (
+      requestId: number,
+      userStateList: UserState[],
+      count: number,
+      nextPage: string,
+      errorCode: RTM_ERROR_CODE
+    ) => {
+      log.log(
+        'onGetOnlineUsersResult',
+        'requestId',
+        requestId,
+        'userStateList',
+        userStateList,
+        'count',
+        count,
+        'nextPage',
+        nextPage,
+        'errorCode',
+        errorCode
+      );
+      if (
+        requestId === getOnlineRequestId.current &&
+        errorCode === RTM_ERROR_CODE.RTM_ERROR_OK
+      ) {
+        log.alert(
+          `channel: ${cName} status`,
+          `${JSON.stringify(userStateList)}`
+        );
+      }
+    },
+    [cName]
+  );
+
   const onWhereNowResult = useCallback(
     (
       requestId: number,
@@ -117,6 +153,34 @@ export default function Presence() {
     [searchUid]
   );
 
+  const onGetUserChannelsResult = useCallback(
+    (
+      requestId: number,
+      channels: ChannelInfo[],
+      count: number,
+      errorCode: RTM_ERROR_CODE
+    ) => {
+      log.log(
+        'onGetUserChannelsResult',
+        'requestId',
+        requestId,
+        'channels',
+        channels,
+        'count',
+        count,
+        'errorCode',
+        errorCode
+      );
+      if (
+        requestId === getUserChannelsRequestId.current &&
+        errorCode === RTM_ERROR_CODE.RTM_ERROR_OK
+      ) {
+        log.alert(`${searchUid} is at`, `${JSON.stringify(channels)}`);
+      }
+    },
+    [searchUid]
+  );
+
   const onPresenceSetStateResult = useCallback(
     (requestId: number, errorCode: RTM_ERROR_CODE) => {
       log.log(
@@ -212,13 +276,35 @@ export default function Presence() {
       );
   };
 
+  /**
+   * Step 2-1 : getOnlineUsers
+   */
+  const getOnlineUsers = () => {
+    getOnlineRequestId.current = client
+      .getPresence()
+      .getOnlineUsers(
+        cName,
+        RTM_CHANNEL_TYPE.RTM_CHANNEL_TYPE_MESSAGE,
+        new PresenceOptions({ includeState: true, includeUserId: true })
+      );
+  };
+
   /**
    * Step 3 : whereNow
    */
   const whereNow = () => {
     whereNowRequestId.current = client.getPresence().whereNow(searchUid);
   };
 
+  /**
+   * Step 3-1 : getUserChannels
+   */
+  const getUserChannels = () => {
+    getUserChannelsRequestId.current = client
+      .getPresence()
+      .getUserChannels(searchUid);
+  };
+
   /**
    * Step 4 : setState
    */
@@ -262,6 +348,8 @@ export default function Presence() {
   useEffect(() => {
     client.addEventListener('onSubscribeResult', onSubscribeResult);
     client.addEventListener('onWhoNowResult', onWhoNowResult);
+    client.addEventListener('onGetOnlineUsersResult', onGetOnlineUsersResult);
+    client.addEventListener('onGetUserChannelsResult', onGetUserChannelsResult);
     client.addEventListener('onWhereNowResult', onWhereNowResult);
     client.addEventListener(
       'onPresenceSetStateResult',
@@ -280,6 +368,14 @@ export default function Presence() {
     return () => {
       client.removeEventListener('onSubscribeResult', onSubscribeResult);
       client.removeEventListener('onWhoNowResult', onWhoNowResult);
+      client.removeEventListener(
+        'onGetOnlineUsersResult',
+        onGetOnlineUsersResult
+      );
+      client.removeEventListener(
+        'onGetUserChannelsResult',
+        onGetUserChannelsResult
+      );
       client.removeEventListener('onWhereNowResult', onWhereNowResult);
       client.removeEventListener(
         'onPresenceSetStateResult',
@@ -300,7 +396,9 @@ export default function Presence() {
     uid,
     onSubscribeResult,
     onWhoNowResult,
+    onGetOnlineUsersResult,
     onWhereNowResult,
+    onGetUserChannelsResult,
     onPresenceSetStateResult,
     onPresenceGetStateResult,
     onPresenceRemoveStateResult,
@@ -372,6 +470,12 @@ export default function Presence() {
             whoNow();
           }}
         />
+        <AgoraButton
+          title={`getOnlineUsers`}
+          onPress={() => {
+            getOnlineUsers();
+          }}
+        />
         <AgoraTextInput
           onChangeText={(text) => {
             setSearchUid(text);
@@ -385,6 +489,12 @@ export default function Presence() {
             whereNow();
           }}
         />
+        <AgoraButton
+          title={`getUserChannels`}
+          onPress={() => {
+            getUserChannels();
+          }}
+        />
 
         <AgoraDropdown
           titleStyle={AgoraStyle.dropdownTitle}

diff --git a/scripts/terra/config/impl_special_return_list.json b/scripts/terra/config/impl_special_return_list.json
@@ -4,6 +4,8 @@
   "agora::rtm::IRtmPresence.setState": "requestId",
   "agora::rtm::IRtmPresence.removeState": "requestId",
   "agora::rtm::IRtmPresence.getState": "requestId",
+  "agora::rtm::IRtmPresence.getOnlineUsers": "requestId",
+  "agora::rtm::IRtmPresence.getUserChannels": "requestId",
   "agora::rtm::IRtmLock.setLock": "requestId",
   "agora::rtm::IRtmLock.getLocks": "requestId",
   "agora::rtm::IRtmLock.removeLock": "requestId",

diff --git a/src/impl/IAgoraRtmPresenceImpl.ts b/src/impl/IAgoraRtmPresenceImpl.ts
@@ -175,7 +175,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromGetOnlineUsers(): string {
@@ -195,7 +195,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromGetUserChannels(): string {