Merge pull request #161 from cybex-dev/fix_name_parameter_resolution

Fix name resolution priority and parameters

Author: cybex-dev

CHANGELOG.md

@@ -38,6 +38,7 @@
 * Fix: [Android] Inconsistent caller/recipient names for inbound calls between ringing & connected states.
 * Fix: [Android] Incorrect call direction for incoming calls
 * Fix: call ringing event always showing `CallDirection.outgoing`
+* Fix: [Android] Updated CallKit incoming/outgoing name parameter resolution
 
 ## 0.0.9
 * Feat: forwarded callInvite custom parameters to flutter

README.md

@@ -332,12 +332,23 @@ Caller is usually referred to as `call.from` or `callInvite.from`. This can eith
 
 The following rules are applied to determine the caller/recipient name, which is shown in the call screen and heads-up notification:
 
-- If the caller is empty/not provided, the default caller name is shown e.g. "Unknown Caller", else
-- if the caller is a number, the plugin will show the number as is, else
-- if the caller is a string, the plugin will interpret the string as follows:
-  - if the `__TWI_CALLER_NAME` parameter is provided, the plugin will show the value of `__TWI_CALLER_NAME` as is, else
-  - if the `__TWI_CALLER_ID` parameter is provided, the plugin will search for a registered client with the same id and show the client name, else
-  - if not found or not provided, the plugin will search for a registered client with the `call.from` value and show the client name, as a last resort
+##### Incoming Calls:
+
+`__TWI_CALLER_NAME` -> `resolve(__TWI_CALLER_ID)` -> (phone number) -> `registered client (from)` -> `defaultCaller name` -> `"Unknown Caller"`
+
+
+##### Outgoing Calls:
+
+`__TWI_RECIPIENT_NAME` -> `resolve(__TWI_RECIPIENT_ID)` -> (phone number) -> `registered client (to)` -> `defaultCaller name` -> `"Unknown Caller"`
+
+**Details explaination:**
+
+- if the call is an CallInvite (incoming), the plugin will interpret the string as follows or if the call is outgoing, the twilio `To` parameter field is used to:
+  - if the `__TWI_CALLER_NAME` (or `__TWI_RECIPIENT_NAME`) parameter is provided, the plugin will show the value of `__TWI_CALLER_NAME` (or `__TWI_RECIPIENT_NAME`) as is, else
+  - if the `__TWI_CALLER_ID` (or `__TWI_RECIPIENT_ID`) parameter is provided, the plugin will search for a registered client with the same id and show the client name,
+- if the caller (`from` or `to` fields) is empty/not provided, the default caller name is shown e.g. "Unknown Caller", else
+- else if the caller (`from` or `to` fields) is a number, the plugin will show the number as is, else
+- else the plugin will search for a registered client with the `callInvite.from` (or call.to) value and show the client name, as a last resort
   - the default caller name is shown e.g. "Unknown Caller"
 
 *Please note: the same approach applies to both caller and recipient name resolution.*

android/src/main/kotlin/com/twilio/twilio_voice/call/TVParametersImpl.kt

@@ -18,34 +18,39 @@ class TVCallInviteParametersImpl(storage: Storage, callInvite: CallInvite) : TVP
 
     override val from: String
         get() {
-            val mFrom = mCallInvite.from ?: ""
-            if (mFrom.isEmpty()) {
-                return mStorage.defaultCaller
-            }
-
-            if (!mFrom.startsWith("client:")) {
-                // we have a number, return as is
-                return mFrom
-            }
-
-            val mToName = mFrom.replace("client:", "")
-            return customParameters[PARAM_RECIPIENT_NAME]
-                ?: customParameters[PARAM_RECIPIENT_ID]?.let { resolveHumanReadableName(it) }
-                ?: resolveHumanReadableName(mToName)
+            return customParameters[PARAM_CALLER_NAME]
+                ?: customParameters[PARAM_CALLER_ID]?.let { resolveHumanReadableName(it) }
+                ?: run {
+                    val mFrom = mCallInvite.from ?: ""
+                    if (mFrom.isEmpty()) {
+                        return mStorage.defaultCaller
+                    }
+
+                    if (!mFrom.startsWith("client:")) {
+                        // we have a number, return as is
+                        return mFrom
+                    }
+
+                    val mToName = mFrom.replace("client:", "")
+                    return resolveHumanReadableName(mToName)
+                }
         }
 
     override val to: String
         get() {
-            val mTo = mCallInvite.to
-            if (!mTo.startsWith("client:")) {
-                // we have a number, return as is
-                return mTo
-            }
-
-            val mToName = mTo.replace("client:", "")
             return customParameters[PARAM_RECIPIENT_NAME]
                 ?: customParameters[PARAM_RECIPIENT_ID]?.let { resolveHumanReadableName(it) }
-                ?: resolveHumanReadableName(mToName)
+                ?: run {
+                    val mTo = mCallInvite.to
+
+                    if (!mTo.startsWith("client:")) {
+                        // we have a number, return as is
+                        return mTo
+                    }
+
+                    val mToName = mTo.replace("client:", "")
+                    return resolveHumanReadableName(mToName)
+                }
         }
 
     override val fromRaw: String
@@ -83,36 +88,40 @@ class TVCallParametersImpl(storage: Storage, call: Call, callTo: String, callFro
 
     override val from: String
         get() {
-            if (mFrom.isEmpty()) {
-                return mStorage.defaultCaller
-            }
-
-            if (!mFrom.startsWith("client:")) {
-                // we have a number, return as is
-                return mFrom
-            }
-
-            val mFromName = mFrom.replace("client:", "")
-            return customParameters[PARAM_RECIPIENT_NAME]
-                ?: customParameters[PARAM_RECIPIENT_ID]?.let { resolveHumanReadableName(it) }
-                ?: resolveHumanReadableName(mFromName)
+            return customParameters[PARAM_CALLER_NAME]
+                ?: customParameters[PARAM_CALLER_ID]?.let { resolveHumanReadableName(it) }
+                ?: run {
+                    if (mFrom.isEmpty()) {
+                        return mStorage.defaultCaller
+                    }
+
+                    if (!mFrom.startsWith("client:")) {
+                        // we have a number, return as is
+                        return mFrom
+                    }
+
+                    val mFromName = mFrom.replace("client:", "")
+                    return resolveHumanReadableName(mFromName)
+                }
         }
 
     override val to: String
         get() {
-            if (mTo.isEmpty()) {
-                return mStorage.defaultCaller
-            }
-
-            if (!mTo.startsWith("client:")) {
-                // we have a number, return as is
-                return mTo
-            }
-
-            val mToName = mTo.replace("client:", "")
             return customParameters[PARAM_RECIPIENT_NAME]
                 ?: customParameters[PARAM_RECIPIENT_ID]?.let { resolveHumanReadableName(it) }
-                ?: resolveHumanReadableName(mToName)
+                ?: run {
+                    if (mTo.isEmpty()) {
+                        return mStorage.defaultCaller
+                    }
+
+                    if (!mTo.startsWith("client:")) {
+                        // we have a number, return as is
+                        return mTo
+                    }
+
+                    val mToName = mTo.replace("client:", "")
+                    return resolveHumanReadableName(mToName)
+                }
         }
 
     override val fromRaw: String