omikit-plugin 2.3.4 → 3.0.0

package/README.md

@@ -96,21 +96,26 @@ You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blo
 
 ```
 //need request this permission
+//need request this permission
 <uses-permission android:name="android.permission.INTERNET" />
-//add this lines inside <activity>
+//add these lines inside <activity>
 <intent-filter>
     <action android:name="com.omicall.sdk.CallingActivity"/>
     <category android:name="android.intent.category.DEFAULT" />
 </intent-filter>
-//add this lines outside <activity>
+//add these lines outside <activity>
 <receiver
-  android:name="vn.vihat.omicall.omisdk.receiver.FirebaseMessageReceiver"
-  android:exported="true"
-  android:permission="com.google.android.c2dm.permission.SEND">
-  <intent-filter>
-    <action android:name="com.google.android.c2dm.intent.RECEIVE" />
-  </intent-filter>
+    android:name="vn.vihat.omicall.omisdk.receiver.FirebaseMessageReceiver"
+    android:exported="true"
+    android:permission="com.google.android.c2dm.permission.SEND">
+    <intent-filter>
+        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
+    </intent-filter>
 </receiver>
+<service
+    android:name="vn.vihat.omicall.omisdk.service.NotificationService"
+    android:exported="false">
+</service>
 ```
 
 You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blob/main/example/android/app/src/main/AndroidManifest.xml">AndroidManifest</a> to know more informations.
@@ -130,7 +135,6 @@ You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blo
 <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
 <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
 <uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT" />
-<uses-permission android:name="android.permission.WAKE_LOCK"/>
 <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
 <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
 <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
@@ -139,17 +143,13 @@ You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blo
 - Setup remote push notification: Only support Firebase for remote push notification.
 
   - Add `google-service.json` in `android/app` (For more information, you can refer <a href="https://rnfirebase.io/app/usage">Core/App</a>)
-  - Add Fire Messaging to receive `fcm_token` (You can refer <a href="https://rnfirebase.io/messaging/usage">Cloud Messaging</a> to setup notification for React native)
+  - Add Firebase Messaging to receive `fcm_token` (You can refer <a href="https://rnfirebase.io/messaging/usage">Cloud Messaging</a> to setup notification for React native)
 
   - For more setting information, please refer <a href="https://api.omicall.com/web-sdk/mobile-sdk/android-sdk/cau-hinh-push-notification">Config Push for Android</a>
 
-#### iOS:
-
----
-
-We support both Object-C and Swift. But we only support documents for Object-C. We will write for Swift language later. Thank you.
+#### iOS(Object-C):
 
----
+- Assets: Add `call_image` into assets folder to update callkit image. We only support png style.
 
 - Add variables in Appdelegate.h:
 
@@ -175,7 +175,7 @@ We support both Object-C and Swift. But we only support documents for Object-C.
 #import <OmiKit/OmiKit.h>
 #import <omicall_flutter_plugin/omicall_flutter_plugin-Swift.h>
 
-[OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_SANDBOX];
+[OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_SANDBOX userNameKey:@"full_name" maxCall:2 callKitImage:@"call_image"];
 provider = [[CallKitProviderDelegate alloc] initWithCallManager: [OMISIPLib sharedInstance].callManager];
 voipRegistry = [[PKPushRegistry alloc] initWithQueue:dispatch_get_main_queue()];
 pushkitManager = [[PushKitManager alloc] initWithVoipRegistry:voipRegistry];
@@ -230,7 +230,74 @@ if (@available(iOS 10.0, *)) {
 
 ```
 
-**_ Only use under lines when added `Cloud Messaging` plugin in your project _**
+
+*** Only use under lines when added `Cloud Messaging` plugin in your project ***
+
+- Setup push notification: We only support Firebase for push notification.
+
+  - Add `google-service.json` in `android/app` (For more information, you can refer <a href="https://rnfirebase.io/app/usage">Core/App</a>)
+  - Add Firebase Messaging to receive `fcm_token` (You can refer <a href="https://pub.dev/packages/firebase_messaging">Cloud Messaging</a> to setup notification for React Native)
+
+  - For more setting information, please refer <a href="https://api.omicall.com/web-sdk/mobile-sdk/ios-sdk/cau-hinh-push-notification">Config Push for iOS</a>
+  
+*** Important release note ***
+```
+We support 2 environments. So you need set correct key in Appdelegate.
+- KEY_OMI_APP_ENVIROMENT_SANDBOX support on debug mode
+- KEY_OMI_APP_ENVIROMENT_PRODUCTION support on release mode
+- Visit on web admin to select correct enviroment.   
+```
+  
+#### iOS(Swift):
+- Assets: Add `call_image` into assets folder to update callkit image. We only support png style.
+
+- Add variables in Appdelegate.swift:
+
+```
+import OmiKit
+import PushKit
+import NotificationCenter
+
+var pushkitManager: PushKitManager?
+var provider: CallKitProviderDelegate?
+var voipRegistry: PKPushRegistry?
+```
+
+- Add these lines into `didFinishLaunchingWithOptions`:
+
+```
+OmiClient.setEnviroment(KEY_OMI_APP_ENVIROMENT_SANDBOX, userNameKey: "extension", maxCall: 1, callKitImage: "call_image")
+provider = CallKitProviderDelegate.init(callManager: OMISIPLib.sharedInstance().callManager)
+voipRegistry = PKPushRegistry.init(queue: .main)
+pushkitManager = PushKitManager.init(voipRegistry: voipRegistry)
+```
+
+-  Add these lines into `Info.plist`:
+
+```
+<key>NSCameraUsageDescription</key>
+<string>Need camera access for video call functions</string>
+<key>NSMicrophoneUsageDescription</key>
+<string>Need microphone access for make Call</string>
+```
+
+- Save token for `OmiClient`: if you added `firebase_messaging` in your project so you don't need add these lines.
+
+```
+func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
+    let deviceTokenString = deviceToken.hexString
+    OmiClient.setUserPushNotificationToken(deviceTokenString)
+}
+
+extension Data {
+    var hexString: String {
+        let hexString = map { String(format: "%02.2hhx", $0) }.joined()
+        return hexString
+    }
+}
+```
+
+*** Only use under lines when added `Cloud Messaging` plugin in your project ***
 
 - Setup push notification: We only support Firebase for push notification.
 
@@ -238,6 +305,14 @@ if (@available(iOS 10.0, *)) {
   - Add Firebase Messaging to receive `fcm_token` (You can refer <a href="https://pub.dev/packages/firebase_messaging">Cloud Messaging</a> to setup notification for React Native)
 
   - For more setting information, please refer <a href="https://api.omicall.com/web-sdk/mobile-sdk/ios-sdk/cau-hinh-push-notification">Config Push for iOS</a>
+*** Important release note ***
+```
+We support 2 environments. So you need set correct key in Appdelegate.
+- KEY_OMI_APP_ENVIROMENT_SANDBOX support on debug mode
+- KEY_OMI_APP_ENVIROMENT_PRODUCTION support on release mode
+- Visit on web admin to select correct enviroment.   
+```
+
 
 ## Implement
 
@@ -269,9 +344,9 @@ if (@available(iOS 10.0, *)) {
       usrUuid: usrUuid,
       fullName: fullName,
       apiKey: apiKey,
+      phone: phone,
       isVideo: isVideo,
     };
-    console.log(loginInfo);
     const result = await initCallWithApiKey(loginInfo);
     //result is true then user login successfully.
     ```
@@ -309,22 +384,12 @@ if (@available(iOS 10.0, *)) {
     missedCallTitle: 'Cuộc gọi nhỡ', //config title for the missed call
     userNameKey: 'uuid', //we have 3 values: uuid, full_name, extension.
     channelId: 'com.channel.sample', //your notification channel id
+    audioNotificationDescription: '' //audio description
+    videoNotificationDescription: '' //video descriptipn
   });
   //incomingAcceptButtonImage, incomingDeclineButtonImage, backImage, userImage: Add these into `android/app/src/main/res/drawble`
   ```
 
-- Get call when user open app from killed status(only iOS):
-
-  ```
-  import { getInitialCall } from 'omikit-plugin';
-
-  const callingInfo = await getInitialCall();
-  if (callingInfo !== false) {
-    navigation.navigate('DialCall' as never, callingInfo as never);
-  }
-  //callingInfo != false then user have a calling.
-  ```
-
 - Upload token: OmiKit need FCM for Android and APNS to push notification on user devices. We use more packages: <a href="https://rnfirebase.io/messaging/usage">Cloud Messaging</a> and <a href="https://www.npmjs.com/package/react-native-device-info?activeTab=readme">react-native-device-info</a>
 
   ```
@@ -341,6 +406,18 @@ if (@available(iOS 10.0, *)) {
   });
   ```
 
+- Get call when user open application at first time:
+
+  ```
+  import { getInitialCall } from 'omikit-plugin';
+
+  const callingInfo = await getInitialCall();
+  if (callingInfo !== false) {
+    navigation.navigate('DialCall' as never, callingInfo as never);
+  }
+  //callingInfo != false then user have a calling.
+  ```
+
 - Other functions:
 
   - Call with phone number (mobile phone or internal number):
@@ -351,6 +428,17 @@ if (@available(iOS 10.0, *)) {
       phoneNumber: phone, //phone number
       isVideo: false //allow video call: true/false
   });
+  //we will return OmiStartCallStatus with:
+    - invalidUuid: uuid is invalid (we can not find on my page)
+    - invalidPhoneNumber: sip user is invalid.
+    - samePhoneNumber: Can not call same phone number.
+    - maxRetry: We try to refresh call but we can not start your call.
+    - permissionDenied: Check audio permission.
+    - couldNotFindEndpoint: Please login before make your call.
+    - accountRegisterFailed: We can not register your account.
+    - startCallFailed: We can not start you call.
+    - startCallSuccess: Start call successfully.
+    - haveAnotherCall: We can not start you call because you are joining another call.
   ```
 
   - Call with UUID (only support with Api key):
@@ -361,6 +449,7 @@ if (@available(iOS 10.0, *)) {
       usrUuid: uuid, //phone number
       isVideo: false //allow video call: true/false
   });
+  // Result is the same with startCall
   ```
 
   - Accept a call:
@@ -452,7 +541,7 @@ if (@available(iOS 10.0, *)) {
     }
     ```
 
-  - Logout: Can't receive call.
+  - Logout: logout and remove all information.
 
     ```
     import {logout} from 'omikit-plugin';
@@ -535,9 +624,7 @@ if (@available(iOS 10.0, *)) {
 
 ```
 useEffect(() => {
-    omiEmitter.addListener(OmiCallEvent.incomingReceived, incomingReceived);
-    omiEmitter.addListener(OmiCallEvent.onCallEstablished, onCallEstablished);
-    omiEmitter.addListener(OmiCallEvent.onCallEnd, onCallEnd);
+    omiEmitter.addListener(OmiCallEvent.onCallStateChanged, onCallStateChanged);
     omiEmitter.addListener(OmiCallEvent.onMuted, onMuted);
     omiEmitter.addListener(OmiCallEvent.onSpeaker, onSpeaker);
     omiEmitter.addListener(OmiCallEvent.onClickMissedCall, clickMissedCall);
@@ -551,9 +638,7 @@ useEffect(() => {
       );
     }
     return () => {
-        omiEmitter.removeAllListeners(OmiCallEvent.incomingReceived);
-        omiEmitter.removeAllListeners('onCallEstablished');
-        omiEmitter.removeAllListeners(OmiCallEvent.onCallEnd);
+        omiEmitter.removeAllListeners(OmiCallEvent.onCallStateChanged);
         omiEmitter.removeAllListeners(OmiCallEvent.onMuted);
         omiEmitter.removeAllListeners(OmiCallEvent.onSpeaker);
         omiEmitter.removeAllListeners(OmiCallEvent.onSwitchboardAnswer);
@@ -565,10 +650,13 @@ useEffect(() => {
 }, []);
 ```
 
+  - Important event `onCallStateChanged`: We provide it to listen call state change.
+
+    + It is call state tracking event. We will return status of state. Please refer `OmiCallState`.
+    + Incoming call state lifecycle: incoming(receive on foreround state) -> early -> connecting -> confirmed -> disconnected
+    + Outgoing call state lifecycle: calling -> early (call created) -> connecting -> confirmed -> disconnected
+
 - Action Name value:
-  - `OmiCallEvent.incomingReceived`: Have a incoming call. On Android this event work only foreground
-  - `OmiCallEvent.onCallEstablished`: Connected a call.
-  - `OmiCallEvent.onCallEnd`: End a call and return call information (like endCall)
   - `OmiCallEvent.onMuted`: Audio changed.
   - `OmiCallEvent.onSpeaker`: Audio changed.
   - `OmiCallEvent.onClickMissedCall`: Click missed call notification.

package/android/build.gradle

@@ -68,6 +68,9 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
+  dataBinding {
+    enabled = true
+  }
 }
 
 allprojects {
@@ -96,7 +99,7 @@ dependencies {
   implementation "com.facebook.react:react-native:+" // From node_modules
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
-  api 'vn.vihat.omicall:omi-sdk:1.3.6'
+  api 'vn.vihat.omicall:omi-sdk:1.4.40'
 //    implementation fileTree(include: ['*.jar'], dir: 'libs')
 //    implementation files('OmiSDK.aar')
   implementation 'androidx.appcompat:appcompat:1.5.0'