Merge pull request #283753 from raosanat/master

Documentation update PR

Author: ShannonLeavitt

articles/communication-services/concepts/voice-video-calling/known-issues-native.md

@@ -11,29 +11,12 @@ ms.topic: conceptual
 ms.service: azure-communication-services
 ---
 
-# Known issues associated with the Azure Communication Services Calling Native and Native UI SDKs.
+# Known issues associated with the Azure Communication Services Calling Native and Native UI SDKs
 This article provides known issues related to using the Azure Communication Services native calling SDKs.
 
 ## Issues with Android API emulators
 
-When utilizing Android API emulators on Android 5.0 (API level 21) and Android 5.1 (API level 22), some crashes are expected.  
-
-## Android chat and calling conflicts
-
-You can't use Azure Communication Services chat and calling Android SDK at the same time, the chat real-time notifications feature doesn't work. You might get a dependency resolving issue.
-
-To resolve this issue, you can turn off real-time notifications by adding the following dependency information in your app's build.gradle file and instead poll the GetMessages API to display incoming messages to end users.
-
-**Java**
-```java
- implementation ("com.azure.android:azure-communication-chat:1.0.0") {
-     exclude group: 'com.microsoft', module: 'trouter-client-android'
- }
- implementation 'com.azure.android:azure-communication-calling:1.0.0'
- ```
- 
-> [!NOTE]
-> If your application uses the notification APIs like `chatAsyncClient.startRealtimeNotifications()` or `chatAsyncClient.addEventHandler()`, you will see a runtime error.
+When utilizing Android API emulators on Android 5.0 (API level 21) and Android 5.1 (API level 22), some crashes are expected.
 
 ## iOS ongoing video Picture in Picture (PiP)
 

articles/communication-services/how-tos/calling-sdk/includes/push-notifications/push-notifications-android.md

@@ -1,9 +1,9 @@
 ---
-author: probableprime
+author: sanathr
 ms.service: azure-communication-services
 ms.topic: include
-ms.date: 09/08/2021
-ms.author: rifox
+ms.date: 08/06/2024
+ms.author: sanathr
 ---
 > [!IMPORTANT]
 > On June 20, 2023, Google announced that it [deprecated sending messages using the FCM legacy APIs](https://firebase.google.com/docs/cloud-messaging). Google is removing the legacy FCM from service in June 2024. Google recommends [migrating from legacy FCM APIs to FCM HTTP v1](https://firebase.google.com/docs/cloud-messaging/migrate-v1).
@@ -25,10 +25,10 @@ A set of permissions is required for the Android application in order to be able
 ```
 
 ## Overview
-Mobile push notifications are the pop-up notifications you see on mobile devices. For calling, we'll be focusing on VoIP (Voice over Internet Protocol) push notifications. We'll register for push notifications, handle push notifications, and then un-register push notifications.
+Mobile push notifications are the pop-up notifications you see on mobile devices. For calling, we'll be focusing on VoIP (Voice over Internet Protocol) push notifications. We register for push notifications, handle push notifications, and then unregister push notifications.
 
 > [!NOTE]
-> To Register for Push Notifications and handling of the Push Notifications for a Custom Teams Endpoint (CTE) the API's are the same. The API's described below can also be invoked on the `CommonCallAgent` or `TeamsCallAgent` class for Custom Teams Endpoint (CTE).
+> Registering for Push Notifications and handling of the incoming Push Notifications for a Teams user, the APIs are the same. The APIs described here can also be invoked on the `CommonCallAgent` or `TeamsCallAgent` classes.
 
 ## Register for push notifications
 
@@ -42,7 +42,7 @@ implementation 'com.google.firebase:firebase-core:16.0.8'
 implementation 'com.google.firebase:firebase-messaging:20.2.4'
 ```
 
-In your project level's *build.gradle* file, add the following in the `dependencies` section if it's not already there:
+In your project level's *build.gradle* file, add the following line in the `dependencies` section if it's not already there:
 
 ```groovy
 classpath 'com.google.gms:google-services:4.3.3'
@@ -54,7 +54,7 @@ Add the following plugin to the beginning of the file if it's not already there:
 apply plugin: 'com.google.gms.google-services'
 ```
 
-Select *Sync Now* in the toolbar. Add the following code snippet to get the device registration token generated by the Firebase Cloud Messaging SDK for the client application instance Be sure to add the below imports to the header of the main Activity for the instance. They're required for the snippet to retrieve the token:
+Select *Sync Now* in the toolbar. Add the following code snippet to get the device registration token generated by the Firebase Cloud Messaging SDK for the client application instance. Be sure to add the below imports to the header of the main Activity for the instance to retrieve the token.
 
 ```java
 import com.google.android.gms.tasks.OnCompleteListener;
@@ -128,7 +128,7 @@ Add the following service definition to the `AndroidManifest.xml` file, inside t
 </service>
 ```
 
-- Once the payload is retrieved, it can be passed to the *Communication Services* SDK to be parsed out into an internal *IncomingCallInformation* object that will be handled by calling the *handlePushNotification* method on a *CallAgent* instance. A `CallAgent` instance is created by calling the `createCallAgent(...)` method on the `CallClient` class.
+Once the payload is retrieved, it can be passed to the *Communication Services* SDK to be parsed out into an internal *IncomingCallInformation* object that will handle calling the *handlePushNotification* method on a *CallAgent* instance. A `CallAgent` instance is created by calling the `createCallAgent(...)` method on the `CallClient` class.
 
 ```java
 try {
@@ -140,7 +140,7 @@ catch(Exception e) {
 }
 ```
 
-When the handling of the Push notification message is successful, and the all events handlers are registered properly, the application will ring.
+When the handling of the Push notification message is successful, and the all events handlers are registered properly, the application rings.
 
 ## Unregister push notifications
 
@@ -154,3 +154,16 @@ catch(Exception e) {
     System.out.println("Something went wrong while un-registering for all Incoming Calls Push Notifications.")
 }
 ```
+
+## Disable internal push for incoming call
+
+There are two ways that a push payload of an incoming call can be delivered to the callee.
+   - Using FCM and registering the device token with the API mentioned above, `registerPushNotification` on `CallAgent` or `TeamsCallAgent`.
+   - When a `CallAgent` or `TeamsCallAgent` is created, SDK also registers with an internal service to get the push payload delivered.
+
+Using the property `setDisableInternalPushForIncomingCall` in `CallAgentOptions` or `TeamsCallAgentOptions` it's possible to instruct the SDK to disable the delivery of the push payload using the internal push service.
+
+```java
+CallAgentOptions callAgentOptions = new CallAgentOptions();
+callAgentOptions.setDisableInternalPushForIncomingCall(true);
+```

articles/communication-services/how-tos/calling-sdk/includes/push-notifications/push-notifications-ios.md

@@ -11,7 +11,7 @@ ms.author: rifox
 Mobile push notifications are the pop-up notifications you see on mobile devices. For calling, we'll be focusing on VoIP (Voice over Internet Protocol) push notifications. We'll register for push notifications, handle push notifications, and then un-register push notifications. For a guide on CallKit integration in your iOS application, refer here, [CallKit integration with iOS ACS SDK](../../callkit-integration.md).
 
 > [!NOTE]
-> To Register for Push Notifications and handling of the Push Notifications for a Custom Teams Endpoint (CTE) the APIs are the same. The APIs described can also be invoked on the `CommonCallAgent` or `TeamsCallAgent` class for Custom Teams Endpoint (CTE).
+> Registering for Push Notifications and handling of the incoming Push Notifications for a Teams user, the APIs are the same. The APIs described here can also be invoked on the `CommonCallAgent` or `TeamsCallAgent` classes.
 
 ## Set up push notifications
 
@@ -72,3 +72,16 @@ callAgent.unregisterPushNotification { (error) in
     }
 }
 ```
+
+## Disable internal push for incoming call
+
+There are 2 ways that a push payload of an incoming call can be delivered to the callee.
+  - Using APNS and registering the device token with the API mentioned above, `registerPushNotification` on `CallAgent` or `TeamsCallAgent`.
+  - When a `CallAgent` or `TeamsCallAgent` is created, SDK also registers with an internal service to get the push payload delivered.
+
+Using the property `disableInternalPushForIncomingCall` in `CallAgentOptions` or `TeamsCallAgentOptions` it's possible to instruct the SDK to disable the delivery of the push payload using the internal push service.
+
+```swift
+let options = CallAgentOptions()
+options.disableInternalPushForIncomingCall = true
+```

articles/communication-services/how-tos/calling-sdk/push-notifications.md

@@ -11,7 +11,7 @@ ms.date: 08/10/2021
 ms.custom: template-how-to
 zone_pivot_groups: acs-plat-web-ios-android-windows
 
-#Customer intent: As a developer, I want to enable push notifications with the Azure Communication Services sdks so that I can create a calling application that provides push notifications to its users.
+#Customer intent: As a developer, I want to enable push notifications with the Azure Communication Services SDKs so that I can create a calling application that provides push notifications to its users.
 ---
 
 # Enable push notifications for calls
@@ -35,7 +35,7 @@ Once the register push notification API is called when the device token informat
 In case that you want to revoke an identity you need to follow [this process](../../concepts/identity-model.md#revoke-or-update-access-token), once the identity is revoked the Registrar entry should be deleted.
 
 >[!Note]
->For CTE (Custom Teams Endpoint) the max TTL value is **24 hrs (86,400 seconds)** there's no way to increase this value.
+>For a Teams user the max TTL value is **24 hrs (86,400 seconds)**. There's no way to increase this value. Contoso should wake up the application every 24 hours in the background and perform the registration of the device token. In iOS platform please follow the instructions [here](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/using_background_tasks_to_update_your_app) and for Android [here](https://developer.android.com/develop/background-work/background-tasks) to wake up the application, fetch the new token and perform the registration.
 
 ## Prerequisites
 

articles/communication-services/quickstarts/voice-video-calling/get-started-android-calling-chat-sdk.md

@@ -0,0 +1,44 @@
+---
+ms.date: 08/08/2024
+ms.topic: quickstart
+titleSuffix: Azure Communication Services Calling and Chat SDK
+author: sanathr
+title: Calling and Chat SDK in an Android application
+ms.author: sanathr
+ms.service: azure-communication-services
+description: How to use both Calling and Chat SDK together in an Android application.
+---
+# Add Calling and Chat SDK in an Android application
+
+This tutorial describes how Contoso can integrate both Calling and Chat SDK in an Android application.
+
+## Current limitation
+
+With Android Calling SDK versions earlier than `2.11.0`, building an Android application with both the Calling and Chat SDK's resulted in the following errors:
+
+```
+Duplicate class com.skype.rt.XXX found in modules jetified-azure-communication-calling-1.2.0-runtime (com.azure.android:azure-communication-calling:1.2.0) and jetified-trouter-client-android-0.1.1-runtime (com.microsoft:trouter-client-android:0.1.1)
+
+2 files found with path 'lib/x86/libc++_shared.so' from inputs: - …\.gradle\...-azure-communication-calling-1.2.0\jni\x86\libc++_shared.so - …\.gradle\...-trouter-client-android-9.1.1\jni\x86\libc++_shared.so
+```
+
+This issue was caused because of the conflicting `.jar` and `.so` files included in the Calling SDK package `com.azure.android:azure-communication-calling` and a transitive dependency package that the Chat SDK package `com.azure.android:azure-communication-chat` imports, `com.microsoft:trouter-client-android`.
+
+## Solution
+From Android Calling SDK version 2.11.0 onwards, Contoso can integrate both the Calling and Chat SDKs within the same Android application. This was accomplished by making the Calling SDK rely on com.microsoft:trouter-client-android, similar to the Chat SDK’s dependency on the Trouter package, and eliminating the conflicting .jar and .so files previously included in the Calling SDK.
+
+## Implementation steps
+
+Specify the version of the Android Calling and Chat SDK in your application's Gradle build file as shown in the example:
+
+   ```gradle
+    implementation ('com.azure.android:azure-communication-calling:2.11.0')
+    implementation ('com.azure.android:azure-communication-chat:2.0.3') {
+        exclude group: 'com.microsoft', module: 'trouter-client-android'
+    }
+   ```
+
+The version of `com.azure.android:azure-communication-chat` can be any version. The latest release version is used here as an example. However, the version of the Trouter package `com.microsoft:trouter-client-android` included with the Chat SDK `com.azure.android:azure-communication-chat` needs to be excluded. When the application is built, the Trouter package version included by the Calling SDK package `com.azure.android:azure-communication-calling` will be used.
+
+## Next steps
+Quickstart sample is available in GitHub [Android QuickStarts](https://github.com/Azure-Samples/communication-services-android-quickstarts.git) under `Add-Chat-Calling` folder and follow the `README.md` on instructions how to run the sample.

articles/communication-services/toc.yml

@@ -289,6 +289,8 @@ items:
       href: tutorials/building-app-start.md
     - name: Build an authentication service using Azure Functions
       href: tutorials/trusted-service-tutorial.md
+    - name: Add Calling and Chat SDK in an Android application
+      href: quickstarts/voice-video-calling/get-started-android-calling-chat-sdk.md
     - name: Adding audio quality enhancements
       items:
         - name: Enabling audio effects