feat(ios): added new error constant and updated doc for local network…

… privacy (#11896) Fixes TIMOB-28077
tidev · Aug 28, 2020 · f8de8c0 · f8de8c0
1 parent dbdb869
commit f8de8c0
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 0 deletions.
diff --git a/apidoc/Titanium/Network/BonjourBrowser.yml b/apidoc/Titanium/Network/BonjourBrowser.yml
@@ -14,6 +14,35 @@ description: |
     services list, but you should not rely on it being delivered before user input.  When 
     a window which uses Bonjour browsing is closed, if you do not want to continue searching, 
     you must call the stop() method.
+
+    In iOS 14.0+, to browse services add key `NSLocalNetworkUsageDescription` and `NSBonjourServices` to the `ios plist` section of the tiapp.xml file.
+
+    Example:
+
+    ``` xml
+    <ti:app>
+      <!-- ... -->
+      <ios>
+        <plist>
+          <dict>
+            <!-- Reason to access local network-->
+            <key>NSLocalNetworkUsageDescription</key>
+            <string>
+                Specify the reason for accessing the local network.
+                This appears in the alert dialog when asking the user 
+                for permission to access local network.
+            </string>
+            <!-- List of bonjour service type-->
+            <key>NSBonjourServices</key>
+            <array>
+              <string>_test._tcp</string>
+            <array/>
+          </dict>
+        </plist>
+      </ios>
+      <!-- ... -->
+    </ti:app>
+    ```
 extends: Titanium.Proxy
 since: "1.2.0"
 platforms: [iphone, ipad]

diff --git a/apidoc/Titanium/Network/BonjourService.yml b/apidoc/Titanium/Network/BonjourService.yml
@@ -12,6 +12,35 @@ description: |
     the service first.  When a window which publishes a Bonjour service is closed, you must 
     stop the service if the associated socket is also to be closed, or if it is no longer 
     necessary to publish.  Bonjour service resolution and publishing is asynchronous.
+
+    In iOS 14.0+, to publish service add key `NSLocalNetworkUsageDescription` and `NSBonjourServices` in tiapp.xml file.
+    
+    Example:
+
+    ``` xml
+    <ti:app>
+      <!-- ... -->
+      <ios>
+        <plist>
+          <dict>
+            <!-- Reason to access local network-->
+            <key>NSLocalNetworkUsageDescription</key>
+            <string>
+                Specify the reason for accessing the local network.
+                This appears in the alert dialog when asking the user 
+                for permission to access local network.
+            </string>
+            <!-- List of bonjour service type-->
+            <key>NSBonjourServices</key>
+            <array>
+              <string>_test._tcp</string>
+            <array/>
+          </dict>
+        </plist>
+      </ios>
+      <!-- ... -->
+    </ti:app>
+    ```
 extends: Titanium.Proxy
 since: "1.2.0"
 platforms: [iphone, ipad]

diff --git a/iphone/Classes/TiNetworkBonjourServiceProxy.m b/iphone/Classes/TiNetworkBonjourServiceProxy.m
@@ -113,6 +113,11 @@ + (NSString *)stringForErrorCode:(NSNetServicesError)code
   case NSNetServicesTimeoutError:
     return @"TimeoutError";
     break;
+#if IS_SDK_IOS_14
+  case NSNetServicesMissingRequiredConfigurationError:
+    return @"MissingRequiredConfigurationError";
+    break;
+#endif
   }
 
   return @"";