feat(example): Presence (#2)

* feat(example): Presence
AgoraIO-Extensions · Nov 21, 2023 · 0f347b3 · 0f347b3
1 parent dc256f3
commit 0f347b3
Show file tree

Hide file tree

Showing 18 changed files with 386 additions and 160 deletions.
diff --git a/example/src/advanced/Presence/index.tsx b/example/src/advanced/Presence/index.tsx
diff --git a/example/src/advanced/index.ts b/example/src/advanced/index.ts
@@ -1,3 +1,4 @@
+import Presence from './Presence';
 import PublishMessage from './publishMessage';
 import PublishTopicMessage from './publishTopicMessage';
 
@@ -12,6 +13,10 @@ const Advanced = {
       name: 'PublishTopicMessage',
       component: PublishTopicMessage,
     },
+    {
+      name: 'Presence',
+      component: Presence,
+    },
   ],
 };
 export default Advanced;
diff --git a/example/src/basic/Login/index.tsx b/example/src/basic/Login/index.tsx
@@ -6,14 +6,13 @@ import {
 } from 'agora-react-native-rtm';
 import React, { useCallback, useEffect, useState } from 'react';
 
-import { KeyboardAvoidingView, Platform } from 'react-native';
+import { KeyboardAvoidingView, Platform, ScrollView } from 'react-native';
 
 import {
   AgoraButton,
   AgoraStyle,
   AgoraText,
   AgoraTextInput,
-  AgoraView,
 } from '../../components/ui';
 import Config from '../../config/agora.config';
 import { useRtmClient } from '../../hooks/useRtmClient';
@@ -110,7 +109,7 @@ export default function Login() {
       style={AgoraStyle.fullSize}
       behavior={Platform.OS === 'ios' ? 'padding' : 'height'}
     >
-      <AgoraView style={AgoraStyle.fullWidth}>
+      <ScrollView style={AgoraStyle.fullSize}>
         {loginSuccess ? (
           <AgoraText>{`current login userId:\n${uid}`}</AgoraText>
         ) : (
@@ -129,7 +128,7 @@ export default function Login() {
             loginSuccess ? logout() : login();
           }}
         />
-      </AgoraView>
+      </ScrollView>
     </KeyboardAvoidingView>
   );
 }
diff --git a/example/src/basic/createStreamChannel/index.tsx b/example/src/basic/createStreamChannel/index.tsx
@@ -7,7 +7,7 @@ import {
 } from 'agora-react-native-rtm';
 import React, { useCallback, useEffect, useState } from 'react';
 
-import { KeyboardAvoidingView, Platform } from 'react-native';
+import { KeyboardAvoidingView, Platform, ScrollView } from 'react-native';
 
 import BaseComponent from '../../components/BaseComponent';
 import { AgoraButton, AgoraStyle, AgoraView } from '../../components/ui';
@@ -178,7 +178,7 @@ export default function CreateStreamChannel() {
       style={AgoraStyle.fullSize}
       behavior={Platform.OS === 'ios' ? 'padding' : 'height'}
     >
-      <AgoraView style={AgoraStyle.fullWidth}>
+      <ScrollView style={AgoraStyle.fullSize}>
         <BaseComponent
           onChannelNameChanged={(v) => setCName(v)}
           onUidChanged={(v) => setUid(v)}
@@ -208,7 +208,7 @@ export default function CreateStreamChannel() {
             }
           }}
         />
-      </AgoraView>
+      </ScrollView>
     </KeyboardAvoidingView>
   );
 }
diff --git a/example/src/components/BaseComponent.tsx b/example/src/components/BaseComponent.tsx
@@ -1,4 +1,4 @@
-import { RTM_ERROR_CODE } from 'agora-react-native-rtm';
+import { RTM_ERROR_CODE, RtmConfig } from 'agora-react-native-rtm';
 import React, { useCallback, useEffect, useState } from 'react';
 
 import Config from '../config/agora.config';
@@ -37,10 +37,12 @@ export default function BaseComponent({
     if (!uid || uid.length === 0) {
       return;
     }
-    client.initialize({
-      userId: uid,
-      appId: Config.appId,
-    });
+    client.initialize(
+      new RtmConfig({
+        userId: uid,
+        appId: Config.appId,
+      })
+    );
 
     return () => {
       setLoginSuccess(false);

diff --git a/example/src/components/ui/index.tsx b/example/src/components/ui/index.tsx
@@ -66,7 +66,7 @@ export const AgoraButton = (props: ButtonProps) => {
 export const AgoraDivider = (props: DividerProps) => {
   return (
     <>
-      <Divider width={1} color={'grey'} {...props} />
+      <Divider width={10} color={'transparent'} {...props} />
     </>
   );
 };
@@ -197,7 +197,8 @@ export const AgoraCard = (
 export interface AgoraDropdownItem extends Item {}
 
 export const AgoraDropdown = (
-  props: PickerSelectProps & PickerProps & { title: string }
+  props: PickerSelectProps &
+    PickerProps & { title: string; titleStyle?: TextProps['style'] }
 ) => {
   const [value, setValue] = useState(props.value);
 
@@ -207,7 +208,7 @@ export const AgoraDropdown = (
 
   return (
     <AgoraView style={AgoraStyle.fullWidth}>
-      <AgoraText children={props.title} />
+      <AgoraText style={props.titleStyle} children={props.title} />
       <PickerSelect
         {...props}
         pickerProps={{
@@ -290,4 +291,11 @@ export const AgoraStyle = StyleSheet.create({
     width: '100%',
     height: 200,
   },
+  dropdownTitle: {
+    fontWeight: 'bold',
+    fontSize: 16,
+    color: '#86939e',
+    paddingHorizontal: 10,
+    marginVertical: 10,
+  },
 });
diff --git a/scripts/terra/config/impl_special_return_list.json b/scripts/terra/config/impl_special_return_list.json
@@ -0,0 +1,28 @@
+{
+  "agora::rtm::IRtmPresence.whoNow": "requestId",
+  "agora::rtm::IRtmPresence.whereNow": "requestId",
+  "agora::rtm::IRtmPresence.setState": "requestId",
+  "agora::rtm::IRtmPresence.removeState": "requestId",
+  "agora::rtm::IRtmPresence.getState": "requestId",
+  "agora::rtm::IRtmLock.setLock": "requestId",
+  "agora::rtm::IRtmLock.getLocks": "requestId",
+  "agora::rtm::IRtmLock.removeLock": "requestId",
+  "agora::rtm::IRtmLock.acquireLock": "requestId",
+  "agora::rtm::IRtmLock.releaseLock": "requestId",
+  "agora::rtm::IRtmLock.revokeLock": "requestId",
+  "agora::rtm::IRtmStorage.setChannelMetadata": "requestId",
+  "agora::rtm::IRtmStorage.updateChannelMetadata": "requestId",
+  "agora::rtm::IRtmStorage.removeChannelMetadata": "requestId",
+  "agora::rtm::IRtmStorage.getChannelMetadata": "requestId",
+  "agora::rtm::IRtmStorage.setUserMetadata": "requestId",
+  "agora::rtm::IRtmStorage.updateUserMetadata": "requestId",
+  "agora::rtm::IRtmStorage.removeUserMetadata": "requestId",
+  "agora::rtm::IRtmStorage.getUserMetadata": "requestId",
+  "agora::rtm::IRtmStorage.subscribeUserMetadata": "requestId",
+  "agora::rtm::IStreamChannel.join": "requestId",
+  "agora::rtm::IStreamChannel.leave": "requestId",
+  "agora::rtm::IStreamChannel.joinTopic": "requestId",
+  "agora::rtm::IStreamChannel.leaveTopic": "requestId",
+  "agora::rtm::IRtmClient.publish": "requestId",
+  "agora::rtm::IRtmClient.subscribe": "requestId"
+}
diff --git a/scripts/terra/config/param_type_list.json b/scripts/terra/config/param_type_list.json
@@ -2,6 +2,7 @@
   "agora::rtm::IMetadata.getMetadataItems.items@type": "MetadataItem*",
   "agora::rtm::IChannelMember\\*": "IChannelMember",
   "agora::rtm::IRtmClient.createStreamChannel@return_type": "IStreamChannel",
+  "agora::rtm::IRtmClient.getPresence@return_type": "IRtmPresence",
   "^Optional<(.*)>": "$1",
   "^util::(.*)": "$1",
   "^agora::(.*)": "$1",

diff --git a/scripts/terra/impl.ts b/scripts/terra/impl.ts
@@ -12,6 +12,7 @@ import {
   isMatch,
 } from './utils';
 
+const implSpecialReturnList = require('./config/impl_special_return_list.json');
 const paramOptionalList = require('./config/param_optional_list.json');
 
 interface CXXFileUserData {
@@ -31,6 +32,7 @@ interface ClazzMethodUserData {
   hasParameters: boolean;
   bindingFunctionName?: string;
   bindingIrisKey?: string;
+  returnParamName?: string;
 }
 
 export function impl(parseResult: ParseResult) {
@@ -65,6 +67,12 @@ export function impl(parseResult: ParseResult) {
           bindingFunctionName: `getApiTypeFrom${
             method.name.charAt(0).toUpperCase() + method.name.slice(1)
           }`,
+          returnParamName:
+            method.parameters.filter((param) => {
+              return param.name === implSpecialReturnList[method.fullName];
+            }).length > 0
+              ? implSpecialReturnList[method.fullName]
+              : 'result',
           bindingIrisKey: `${node.asClazz().name.slice(1)}_${method.name}`,
         };
         method.user_data = clazzMethodUserData;

diff --git a/scripts/terra/templates/impl/file_content.mustache b/scripts/terra/templates/impl/file_content.mustache
@@ -43,7 +43,7 @@ export class {{name}}Impl implements {{name}}{
       {{/user_data.hasParameters}}
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.{{user_data.returnParamName}};
   }
 
   protected {{user_data.bindingFunctionName}}(): string {

diff --git a/src/IAgoraRtmClient.ts b/src/IAgoraRtmClient.ts
@@ -415,7 +415,7 @@ export abstract class IRtmClient {
   abstract logout(): number;
   abstract getStorage(): IRtmStorage[];
   abstract getLock(): IRtmLock[];
-  abstract getPresence(): IRtmPresence[];
+  abstract getPresence(): IRtmPresence;
   abstract renewToken(token: string): number;
   abstract publish(
     channelName: string,

diff --git a/src/impl/IAgoraRtmClientImpl.ts b/src/impl/IAgoraRtmClientImpl.ts
@@ -436,7 +436,7 @@ export class IRtmClientImpl implements IRtmClient {
     return 'RtmClient_getLock';
   }
 
-  getPresence(): IRtmPresence[] {
+  getPresence(): IRtmPresence {
     const apiType = this.getApiTypeFromGetPresence();
     const jsonParams = {};
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
@@ -490,7 +490,7 @@ export class IRtmClientImpl implements IRtmClient {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromPublish(): string {
@@ -516,7 +516,7 @@ export class IRtmClientImpl implements IRtmClient {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromSubscribe(): string {

diff --git a/src/impl/IAgoraRtmLockImpl.ts b/src/impl/IAgoraRtmLockImpl.ts
@@ -31,7 +31,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromSetLock(): string {
@@ -57,7 +57,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromGetLocks(): string {
@@ -86,7 +86,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromRemoveLock(): string {
@@ -118,7 +118,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromAcquireLock(): string {
@@ -147,7 +147,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromReleaseLock(): string {
@@ -179,7 +179,7 @@ export class IRtmLockImpl implements IRtmLock {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromRevokeLock(): string {

diff --git a/src/impl/IAgoraRtmPresenceImpl.ts b/src/impl/IAgoraRtmPresenceImpl.ts
@@ -33,7 +33,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromWhoNow(): string {
@@ -53,7 +53,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromWhereNow(): string {
@@ -85,7 +85,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromSetState(): string {
@@ -117,7 +117,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromRemoveState(): string {
@@ -146,7 +146,7 @@ export class IRtmPresenceImpl implements IRtmPresence {
       },
     };
     const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
+    return jsonResults.requestId;
   }
 
   protected getApiTypeFromGetState(): string {