omikit-plugin 0.3.1 → 1.0.1

package/README.md

@@ -11,20 +11,20 @@ The most important part of the framework is :
 
 ## Status
 
-Currently active maintained
+Currently active maintainance and improve performance
 
 ## Running
 
 Install via npm:
 
 ```sh
-npm install omikit-plugin
+npm install omikit-plugin@latest
 ```
 
 Install via yarn:
 
 ```sh
-yarn add omikit-plugin
+yarn add omikit-plugin --latest
 ```
 
 ### Configuration
@@ -32,67 +32,155 @@ yarn add omikit-plugin
 #### Android:
 
 - Add this setting in `build.gradle`:
-
 ```
-jcenter() // Warning: this repository is going to shut down soon
+jcenter() 
 maven {
-    url("https://vihat.jfrog.io/artifactory/vihat-local-repo")
+    url("https://vihatgroup.jfrog.io/artifactory/omi-voice/")
     credentials {
-        username = "anonymous"
+        username = "downloader"
+        password = "Omi@2022"
     }
 }
 ```
-
 ```
-classpath 'com.google.gms:google-services:4.3.13' //in dependencies
+//in dependencies
+classpath 'com.google.gms:google-services:4.3.13'
+```
+```
+//under buildscript
+allprojects {
+      repositories {
+        maven {
+            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+            url("$rootDir/../node_modules/react-native/android")
+        }
+        maven {
+            // Android JSC is installed from npm
+            url("$rootDir/../node_modules/jsc-android/dist")
+        }
+        mavenCentral {
+            // We don't want to fetch react-native from Maven Central as there are
+            // older versions over there.
+            content {
+                excludeGroup "com.facebook.react"
+            }
+        }
+        google()
+        maven { url 'https://www.jitpack.io' }
+        maven {
+          url("https://vihatgroup.jfrog.io/artifactory/omi-voice/")
+          credentials {
+            username = "downloader"
+            password = "Omi@2022"
+          }
+        }
+      }
+}
 ```
 
-- Add this setting In `app/build.gradle`:
+You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blob/main/example/android/build.gradle">android/build.gradle</a> to know more informations.
 
+- Add this setting In `app/build.gradle`:
 ```
 apply plugin: 'com.android.application'
 apply plugin: 'kotlin-android'
 apply plugin: 'com.google.gms.google-services'
 ```
 
-Push Notification:
+You can refer <a href="https://github.com/VIHATTeam/OMICALL-React-Native-SDK/blob/main/example/android/app/build.gradle">android/app/build.gradle</a> to know more informations.
 
-- Add `google-service.json` in `android/app` (For more information, you can refer <a href="https://rnfirebase.io/">Firebase core</a>)
+- Update AndroidManifest.xml:
+```
+//need request this permission
+<uses-permission android:name="android.permission.INTERNET" />
+//add this 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>
+<service
+    android:name="vn.vihat.omicall.omisdk.service.FMService"
+    android:enabled="true"
+    android:exported="false">
+    <intent-filter>
+        <action android:name="com.google.firebase.MESSAGING_EVENT" />
+    </intent-filter>
+</service>
+```
 
-- For more setting information, please refer <a href="https://api.omicall.com/web-sdk/mobile-sdk/android-sdk/cau-hinh-push-notification">Omicall Config Push for Android</a>
+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.
 
-#### iOS: Set up environment and library:
+- We registered permissions into my plugin:
+```
+<uses-permission android:name="android.permission.BROADCAST_CLOSE_SYSTEM_DIALOGS"
+    tools:ignore="ProtectedPermissions" />
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.USE_SIP" />
+<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
+<uses-permission android:name="android.permission.WAKE_LOCK" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+<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"/>
+```
 
-- AppDelete.h
+- 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 Fire Messaging to receive `fcm_token` (You can refer <a href="https://pub.dev/packages/firebase_messaging">Cloud Messaging</a> to setup notification for Flutter)
 
-```
-#import <OmiKit/OmiKit-umbrella.h>
-#import <UserNotifications/UserNotifications.h>
+  - For more setting information, please refer <a href="https://rnfirebase.io/messaging/usage">Config Push for Android</a>
+
+#### iOS:
+----
 
-@interface AppDelegate : UIResponder <UIApplicationDelegate, RCTBridgeDelegate>
+We support both Object-C and Swift. But we only support documents for Object-C. We will write for Swift language later. Thank you.
 
-@property (nonatomic, strong) UIWindow *window;
-@property (nonatomic, strong) PushKitManager *pushkitManager;
-@property (nonatomic, strong) CallKitProviderDelegate * provider;
-@property (nonatomic, strong) PKPushRegistry * voipRegistry;
+---
 
-@end
+- Add variables in Appdelegate.h:
+
+```
+#import <UIKit/UIKit.h>
+#import <UserNotifications/UserNotifications.h>
+#import <OmiKit/OmiKit-umbrella.h>
+#import <OmiKit/Constants.h>
+#import <UserNotifications/UserNotifications.h>
 
+PushKitManager *pushkitManager;
+CallKitProviderDelegate * provider;
+PKPushRegistry * voipRegistry;
 ```
 
-- AppDelete.m
+- Edit AppDelegate.m:
 
 ```
 #import <OmiKit/OmiKit.h>
+#import <omicall_flutter_plugin/omicall_flutter_plugin-Swift.h>
 
 [OmiClient setEnviroment:KEY_OMI_APP_ENVIROMENT_SANDBOX];
-self.provider = [[CallKitProviderDelegate alloc] initWithCallManager: [OMISIPLib sharedInstance].callManager];
-self.voipRegistry = [[PKPushRegistry alloc] initWithQueue:dispatch_get_main_queue()];
-self.pushkitManager = [[PushKitManager alloc] initWithVoipRegistry: self.voipRegistry];
-//Add into `didFinishLaunchingWithOptions` function
+provider = [[CallKitProviderDelegate alloc] initWithCallManager: [OMISIPLib sharedInstance].callManager];
+voipRegistry = [[PKPushRegistry alloc] initWithQueue:dispatch_get_main_queue()];
+pushkitManager = [[PushKitManager alloc] initWithVoipRegistry:voipRegistry];
 ```
 
-- Save token for `OmiClient`, if you don't use `Messaging` for iOS:
+-  Add this lines into `Info.plist`:
+
+```
+<key>NSMicrophoneUsageDescription</key>
+<string>Need microphone access for make Call</string>
+//If you implement video call
+<key>NSCameraUsageDescription</key>
+<string>Need camera access for video call functions</string>
+```
+
+- Save token for `OmiClient`: You use `Cloud Messaging` into your project so you don't need add this lines.
 
 ```
 - (void)application:(UIApplication*)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)devToken
@@ -104,40 +192,102 @@ self.pushkitManager = [[PushKitManager alloc] initWithVoipRegistry: self.voipReg
     {
         [token appendFormat:@"%02.2hhX", data[i]];
     }
-
+    
     // print the token in the console.
     NSLog(@"Push Notification Token: %@", [token copy]);
     [OmiClient setUserPushNotificationToken:[token copy]];
 }
 
 ```
+*** Only use under lines when add `Cloud Messaging` plugin ***
+- 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)
 
-Push Notification:
-Omicall need two certificates: VOIP Push Certificate & User Push Notification Certificate
-
-- For more information, please refer <a href="https://api.omicall.com/web-sdk/mobile-sdk/ios-sdk/cau-hinh-push-notification">Omicall Push Notification for iOS</a>
+  - 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>
 
 ## Implement
 
-- Set up Firebase Messaging: <a href="https://rnfirebase.io/messaging/usage">messaging</a> plugin.
+- Set up <a href="https://rnfirebase.io/messaging/usage">Cloud Messaging</a> plugin:
 
 ```
 //if you use only on Android. you only implement for Android.
 //because we use APNS to push notification on iOS so you don't need add Firebase for iOS.
 //But you can use firebase-messaging to get APNS token for iOS.
 ```
-
-- Call actions:
-
-  * `initCall` : register and init OmiCall. You need send Object value with `userName`, `password` and `realm`.
-  * `updateToken` : update token for sdk. You need send `fcmToken` for Android and send `apnsToken` for iOS.
-  * `startCall` : start Call.
-  * `endCall` : end Call.
-  * `toggleMute` : toggle the microphone status.
-  * `toggleSpeaker` : toggle the voice status. You need send Object value with `useSpeaker`.
-  * `sendDTMF` : send DTMF for call server. You need send Object value with `character` value.
-
-* Event listener:
+- Important function.
+  - Create OmiKit: OmiKit need userName, password, realm, host to init enviroment. ViHAT Group will provide informations for you. Please contact for my sale:
+```
+    import { initCall } from 'omikit-plugin';
+    
+    const loginInfo = {
+      userName: userName, //string
+      password: password, //string
+      realm: realm, //string
+      isVideo: isVideo, //boolean: true/false
+      host: host, //string
+    };
+    const result = await initCall(loginInfo);
+```
+- 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>
+  ```
+  import { updateToken } from 'omikit-plugin';
+  
+  const fcmToken = await fcm;
+  const apnsToken = await apns;
+  const deviceId = DeviceInfo.getDeviceId();
+  const appId = DeviceInfo.getBundleId();
+  updateToken({
+    apnsToken: apnsToken,
+    fcmToken: fcmToken,
+    deviceId: deviceId,
+    appId: appId,
+  });
+  ```
+- Other functions:
+  -  Call with phone number (mobile phone or internal number):
+    ```
+    import {startCall} from 'omikit-plugin';
+    
+    const result = await startCall({ 
+        phoneNumber: phone, //phone number
+        isVideo: false //allow video call: true/false
+    });
+    ```
+  - Accept a call:
+    ```
+    import {joinCall} from 'omikit-plugin';
+    
+    await joinCall();
+    ```
+  - End a call: We will push a event `endCall` for you.
+    ```
+    import {endCall} from 'omikit-plugin';
+    
+    await endCall();
+    ```
+  - Toggle the audio: On/off audio a call
+    ```
+    import {toggleMute} from 'omikit-plugin';
+    
+    toggleMute();
+    ```
+  - Toggle the speaker: On/off the phone speaker
+    ```
+    import {toggleSpeak} from 'omikit-plugin';
+    
+    toggleSpeak();
+    ```
+  - Send character: We only support `1 to 9` and `* #`.
+    ```
+    import {sendDTMF} from 'omikit-plugin';
+    
+    sendDTMF({
+        character: text,
+    });
+    ```
+
+- Event listener:
 
 ```
 useEffect(() => {
@@ -145,21 +295,17 @@ useEffect(() => {
     omiEmitter.addListener('onCallEstablished', onCallEstablished);
     omiEmitter.addListener('onCallEnd', onCallEnd);
     omiEmitter.addListener('onMuted', onMuted);
-    omiEmitter.addListener('onRinging', onRinging);
     return () => {
         omiEmitter.removeAllListeners('incomingReceived');
         omiEmitter.removeAllListeners('onCallEstablished');
         omiEmitter.removeAllListeners('onCallEnd');
         omiEmitter.removeAllListeners('onMuted');
-        omiEmitter.removeAllListeners('onRinging');
     };
 }, []);
-
 ```
-
-* Event List: `We support 5 events`
-  * `onCallEnd`: Trigger when end the call.
-  * `onCallEstablished`: Trigger when we created the call.
-  * `onRinging`: Trigger when the phone is ringing.
-  * `onHold`: Trigger when user hold the call. From parameters, you can reviceved correct status from server through `isHold`
-  * `onMuted`: Trigger when user muted the call. From parameters, you can reviceved correct status from server through `isMuted`
+- Action Name value: 
+    - `incomingReceived`: Have a incoming call. On Android this event work only foreground
+    - `onCallEstablished`: Connected a call.
+    - `onCallEnd`: End a call.
+    - `onMuted`: Audio changed.
+- Data value: We return `callerNumber`, `isVideo: true/false` information

package/android/build.gradle

@@ -70,19 +70,6 @@ android {
 
 }
 
-repositories {
-  mavenCentral()
-  google()
-  jcenter() // Warning: this repository is going to shut down soon
-  maven {
-    url("https://vihatgroup.jfrog.io/artifactory/omi-voice/")
-    credentials {
-      username = "downloader"
-      password = "Omi@2022"
-    }
-  }
-}
-
 allprojects {
   repositories {
     google()
@@ -109,7 +96,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:0.9.12'
+  api 'vn.vihat.omicall:omi-sdk:1.0.10'
 
   implementation 'androidx.core:core-ktx:1.7.0'
   implementation 'androidx.fragment:fragment-ktx:1.4.0'
@@ -124,6 +111,14 @@ dependencies {
   implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycle_version"
   implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.2'
   implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.4.0"
+  implementation 'androidx.databinding:viewbinding:7.1.2'
+  implementation("com.squareup.retrofit2:retrofit:2.9.0") {
+    exclude module: 'okhttp'
+  }
+  implementation "com.squareup.retrofit2:converter-gson:2.9.0"
+  implementation "com.squareup.okhttp3:okhttp:4.9.1"
+  implementation "com.squareup.okhttp3:okhttp-urlconnection:4.9.1"
+  implementation "com.squareup.okhttp3:logging-interceptor:4.9.1"
 }
 
 if (isNewArchitectureEnabled()) {