FLUT-251: Added one to one callkit app (#1745)

* Added one to one callkit app

* Update README.md

* Update README.md

* Update README.md

* Updated readme

* Update README.md

* Update README.md

* Update README.md

* Added new changes regarding notifications

---------

Co-authored-by: ygit <[email protected]>

sample apps/one_to_one_callkit/.gitignore

@@ -0,0 +1,53 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
+/android/app/google-services.json
+
+# ios files
+/ios/Runner/GoogleService-Info.plist
+
+# firebase files
+lib/firebase_options.dart
+.firebaserc
+/ios/firebase_app_id_file.json

sample apps/one_to_one_callkit/.metadata

@@ -0,0 +1,45 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: "12fccda598477eddd19f93040a1dba24f915b9be"
+  channel: "stable"
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: android
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: ios
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: linux
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: macos
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: web
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+    - platform: windows
+      create_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+      base_revision: 12fccda598477eddd19f93040a1dba24f915b9be
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

sample apps/one_to_one_callkit/README.md

@@ -0,0 +1,87 @@
+# Flutter One To One Audio/Video Calling Application
+![Flutter 1-1](https://github.com/100mslive/100ms-flutter/assets/93931528/41816a5b-a3f4-4ed9-b16c-1b3caf91670f)
+
+
+Welcome to our One-to-One Audio-Video Calling Flutter app named Blitz 100ms.
+
+
+This application leverages the open source `hms_room_kit` package for efficient audio/video calls, integrates with CallKit for seamless Android/iOS call functionalities, and utilizes Firebase for push notifications.
+
+## Features
+Audio and video calling using `hms_room_kit`.
+CallKit integration for iOS to handle audio/video calls natively.
+Firebase notifications to alert users of incoming calls, even when the app is in the background.
+
+## Getting Started
+
+### Installation
+
+1. Clone the repository
+
+```bash
+git clone https://github.com/100mslive/100ms-flutter.git
+```
+
+2. Navigate to the project directory
+
+```bash
+cd 100ms-flutter/sample apps/one_to_one_callkit
+```
+
+3. Install dependencies
+
+```bash
+flutter pub get
+```
+
+> Note 🔑: The app utilizes the `callkit-ui` branch from the `hms_room_kit` repository instead of the published package to integrate a customized calling interface.
+
+4. Set up Firebase for Push Notifications, Google Sign-in, and Cloud functions. Add `GoogleService-Info.plist` to the `ios/Runner` directory and `google-services.json` to `android/app` directory.
+
+5. Create a 100ms account, and setup below templates:
+
+    - Audio Room Template 
+    - Video Room Template
+
+    In the above templates, ensure two roles are `speaker` and `listener` with permissions to `publish` and `subscribe` to each other. Also, ensure both roles have `end room` and `room state` permissions.
+
+| Listener | Speaker |
+|----------|---------|
+|  <img width="494" alt="Screenshot 2024-04-01 at 6 11 46 PM" src="https://github.com/100mslive/100ms-flutter/assets/93931528/c3cfaa68-1872-44a5-91fe-37af8a7232ca"> | <img width="494" alt="Screenshot 2024-04-01 at 6 12 03 PM" src="https://github.com/100mslive/100ms-flutter/assets/93931528/90f24e52-a83c-488f-b753-9bc9bc47ba0f"> |
+
+For room state permissions enable the room state from `Advanced Settings`
+
+
+<img width="989" alt="Screenshot 2024-04-01 at 12 12 38 AM" src="https://github.com/100mslive/100ms-flutter/assets/93931528/cde6f46e-bc5b-4c06-bc08-edc461871b04">
+
+
+6. Add the following fields in the below files:
+
+  - Update `CFBundleURLSchemes` in `Info.plist` with your client ID from `GoogleService-Info.plist`
+  - Update management token from 100ms dashboard, `Developer section` in `functions/index.js`
+  - Add Audio and video template IDs in `createRoom` method in `lib/services/app_utilities.dart`
+  - Add authentication client id in `loginUser` method from `GoogleService-Info.plist` file in `lib/services/app_utilities.dart`
+
+7. Deploy cloud functions
+
+```bash
+firebase deploy --only functions
+```
+
+That's it! You're ready to run the application.
+
+### Running the application
+
+```bash
+flutter run
+```
+
+## Usage
+
+Upon launching the app, users can initiate audio or video calls to other users through the interface provided by hms_room_kit.
+
+Incoming calls will trigger Firebase notifications, prompting the receiver to accept or decline the call. 
+
+On iOS devices, CallKit integration ensures that the call UI is consistent with the native call experience.
+
+///Add video here

sample apps/one_to_one_callkit/analysis_options.yaml

@@ -0,0 +1,28 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at https://dart.dev/lints.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

sample apps/one_to_one_callkit/android/.gitignore

@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks

sample apps/one_to_one_callkit/android/app/build.gradle

@@ -0,0 +1,72 @@
+plugins {
+    id "com.android.application"
+    id "kotlin-android"
+    id "dev.flutter.flutter-gradle-plugin"
+    id("com.google.gms.google-services")
+}
+
+def localProperties = new Properties()
+def localPropertiesFile = rootProject.file('local.properties')
+if (localPropertiesFile.exists()) {
+    localPropertiesFile.withReader('UTF-8') { reader ->
+        localProperties.load(reader)
+    }
+}
+
+def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
+if (flutterVersionCode == null) {
+    flutterVersionCode = '1'
+}
+
+def flutterVersionName = localProperties.getProperty('flutter.versionName')
+if (flutterVersionName == null) {
+    flutterVersionName = '1.0'
+}
+
+android {
+    namespace "com.example.one_to_one_callkit"
+    compileSdkVersion 33
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+        applicationId "com.example.one_to_one_callkit"
+        // You can update the following values to match your application needs.
+        // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
+        minSdkVersion 21
+        targetSdkVersion 33
+        versionCode 4
+        versionName "1.0.4"
+        multiDexEnabled true
+    }
+
+    buildTypes {
+        release {
+            // TODO: Add your own signing config for the release build.
+            // Signing with the debug keys for now, so `flutter run --release` works.
+            signingConfig signingConfigs.debug
+        }
+    }
+}
+
+flutter {
+    source '../..'
+}
+
+dependencies {
+    implementation(platform("com.google.firebase:firebase-bom:32.7.3"))
+    implementation("com.google.firebase:firebase-messaging")
+    implementation 'com.android.support:multidex:1.0.3'
+}

sample apps/one_to_one_callkit/android/app/proguard-rules.pro

@@ -0,0 +1 @@
+-keep class com.hiennv.flutter_callkit_incoming.** { *; }

sample apps/one_to_one_callkit/android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <!-- The INTERNET permission is required for development. Specifically,
+         the Flutter tool needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

sample apps/one_to_one_callkit/android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,36 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <uses-permission android:name="android.permission.INTERNET"/>
+
+    <application
+        android:label="Blitz 100ms"
+        android:name="${applicationName}"
+        android:icon="@mipmap/ic_launcher">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:launchMode="singleInstance"
+            android:theme="@style/LaunchTheme"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
+            <!-- Specifies an Android theme to apply to this Activity as soon as
+                 the Android process has started. This theme is visible to the user
+                 while the Flutter UI initializes. After that, this theme continues
+                 to determine the Window background behind the Flutter UI. -->
+            <meta-data
+              android:name="io.flutter.embedding.android.NormalTheme"
+              android:resource="@style/NormalTheme"
+              />
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN"/>
+                <category android:name="android.intent.category.LAUNCHER"/>
+            </intent-filter>
+        </activity>
+        <!-- Don't delete the meta-data below.
+             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+        <meta-data
+            android:name="flutterEmbedding"
+            android:value="2" />
+    </application>
+</manifest>

sample apps/one_to_one_callkit/android/app/src/main/kotlin/com/example/one_to_one_callkit/MainActivity.kt

@@ -0,0 +1,18 @@
+package com.example.one_to_one_callkit
+
+import io.flutter.embedding.android.FlutterActivity
+import android.content.Intent
+import live.hms.hmssdk_flutter.Constants
+import android.app.Activity
+
+class MainActivity: FlutterActivity() {
+
+    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
+        super.onActivityResult(requestCode, resultCode, data)
+
+            if (requestCode == Constants.SCREEN_SHARE_INTENT_REQUEST_CODE && resultCode == Activity.RESULT_OK) {
+                data?.action = Constants.HMSSDK_RECEIVER
+                activity.sendBroadcast(data?.putExtra(Constants.METHOD_CALL, Constants.SCREEN_SHARE_REQUEST))
+            }
+        }
+}

sample apps/one_to_one_callkit/android/app/src/main/res/drawable-v21/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="?android:colorBackground" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>

sample apps/one_to_one_callkit/android/app/src/main/res/drawable/launch_background.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Modify this file to customize your launch splash screen -->
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:drawable="@android:color/white" />
+
+    <!-- You can insert your own image assets here -->
+    <!-- <item>
+        <bitmap
+            android:gravity="center"
+            android:src="@mipmap/launch_image" />
+    </item> -->
+</layer-list>