Added Windows SDK: Open SoftKeyboard feature

JordiFB · facebook-github-bot · commit 31ea00ff33c5 · 2022-07-22T04:49:42.000-07:00
Summary:
Added open softkeyboard feature on Windows platform inside UnitySDK.

This feature will open the virtual keyboard in mobile devices,

Reviewed By: SergioGuerreroFB

Differential Revision: D37788930

fbshipit-source-id: b6c08cd93b021d9ed49c69d5d050e445fd9ba999
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [14.1.0]
 
+### Added
+- Windows platform methods
+    - FB.Windows.SetSoftKeyboardOpen
+
 ### Fixed
 - Issue with new Unity Input System and UnitySDK Example.
 - Issue with misconfiguration of each DLL when Unity import the package.
diff --git a/Facebook.Unity.Windows/WindowsWrapper.cs b/Facebook.Unity.Windows/WindowsWrapper.cs
@@ -664,5 +664,22 @@ public void GetUserLocale(string callbackId, CallbackManager callbackManager)
                 callbackManager.OnFacebookResponse(new LocaleResult(new ResultContainer(result)));
             }
         }
+
+        public void SetSoftKeyboardOpen(bool open, string callbackId, CallbackManager callbackManager)
+        {
+            fbg.Softkeyboard.setSoftKeyboardOpen(open,
+                (fbg.SoftkeyboardAction success) =>
+                {
+                    Dictionary<string, object> resultDict = new Dictionary<string, object>() {
+                        { Constants.CallbackIdKey, callbackId },
+                        { "success", success },
+                    };
+                    callbackManager.OnFacebookResponse(new SoftKeyboardOpenResult(new ResultContainer(resultDict)));
+                }, (fbg.Error error) =>
+                {
+                    SoftKeyboardOpenResult result = new SoftKeyboardOpenResult(WindowsParserBase.SetError(error, callbackId));
+                    callbackManager.OnFacebookResponse(result);
+                });
+        }
     }
 }
diff --git a/Facebook.Unity/CallbackManager.cs b/Facebook.Unity/CallbackManager.cs
@@ -98,7 +98,8 @@ private static void CallCallback(object callback, IResult result)
                 CallbackManager.TryCallCallback<IFriendFinderInvitationResult>(callback, result) ||
                 CallbackManager.TryCallCallback<IVirtualGamepadLayoutResult>(callback, result) ||
                 CallbackManager.TryCallCallback<IDialogResult>(callback, result) ||
-                CallbackManager.TryCallCallback<ILocaleResult>(callback, result))
+                CallbackManager.TryCallCallback<ILocaleResult>(callback, result) ||
+                CallbackManager.TryCallCallback<ISoftKeyboardOpenResult>(callback, result))
             {
                 return;
             }
diff --git a/Facebook.Unity/FB.cs b/Facebook.Unity/FB.cs
@@ -1403,6 +1403,16 @@ public static void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirt
             {
                 Windows.WindowsFacebookImpl.SetVirtualGamepadLayout(layout, callback);
             }
+
+            /// <summary>
+            /// Open Virtual Keyboard in mobile devices.
+            /// </summary>
+            /// <param name="open"> true if you want to open the keyboard</param>
+            /// <param name="callback">Callback to be called when request completes.</param>
+            public static void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback)
+            {
+                Windows.WindowsFacebookImpl.SetSoftKeyboardOpen(open, callback);
+            }
         }
 
         internal abstract class CompiledFacebookLoader : MonoBehaviour
diff --git a/Facebook.Unity/Facebook.Unity.csproj b/Facebook.Unity/Facebook.Unity.csproj
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+﻿<?xml version="1.0" encoding="utf-8"?>
 <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
@@ -142,6 +142,7 @@
     <Compile Include="Results\IRewardedVideoResult.cs" />
     <Compile Include="Results\IScheduleAppToUserNotificationResult.cs" />
     <Compile Include="Results\IShareResult.cs" />
+    <Compile Include="Results\ISoftKeyboardOpenResult.cs" />
     <Compile Include="Results\IVirtualGamepadLayoutResult.cs" />
     <Compile Include="Results\LocaleResult.cs" />
     <Compile Include="Results\LoginResult.cs" />
@@ -157,6 +158,7 @@
     <Compile Include="Results\RewardedVideoResult.cs" />
     <Compile Include="Results\ScheduleAppToUserNotificationResult.cs" />
     <Compile Include="Results\ShareResult.cs" />
+    <Compile Include="Results\SoftKeyboardOpenResult.cs" />
     <Compile Include="Results\VirtualGamepadLayoutResult.cs" />
     <Compile Include="Utils\AsyncRequestString.cs" />
     <Compile Include="Utils\FacebookLogger.cs" />
diff --git a/Facebook.Unity/Results/ISoftKeyboardOpenResult.cs b/Facebook.Unity/Results/ISoftKeyboardOpenResult.cs
@@ -0,0 +1,27 @@
+﻿/*As with any software that integrates with the Facebook platform, your use of
+ * this software is subject to the Facebook Developer Principles and Policies
+ * [http://developers.facebook.com/policy/]. This copyright notice shall be
+ * included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace Facebook.Unity
+{
+    /// <summary>
+    /// The result of a soft keyboard open
+    /// </summary>
+    public interface ISoftKeyboardOpenResult : IResult
+    {
+        /// <summary>
+        /// Gets the soft keyboard open result.
+        /// </summary>
+        /// <value>A string that specifies if the soft keyboard has open action was successful.</value>
+        string Success { get; }
+    }
+}
diff --git a/Facebook.Unity/Results/SoftKeyboardOpenResult.cs b/Facebook.Unity/Results/SoftKeyboardOpenResult.cs
@@ -0,0 +1,39 @@
+﻿/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
+ * copy, modify, and distribute this software in source code or binary form for use
+ * in connection with the web services and APIs provided by Facebook.
+ *
+ * As with any software that integrates with the Facebook platform, your use of
+ * this software is subject to the Facebook Developer Principles and Policies
+ * [http://developers.facebook.com/policy/]. This copyright notice shall be
+ * included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+namespace Facebook.Unity
+{
+    internal class SoftKeyboardOpenResult : ResultBase, ISoftKeyboardOpenResult
+    {
+        internal SoftKeyboardOpenResult(ResultContainer resultContainer) : base(resultContainer)
+        {
+            if (this.ResultDictionary != null)
+            {
+                string success;
+                if (this.ResultDictionary.TryGetValue("success", out success))
+                {
+                    this.Success = success;
+                }
+            }
+        }
+
+        public string Success { get; private set; }
+    }
+}
diff --git a/Facebook.Unity/Windows/IWindowsFacebook.cs b/Facebook.Unity/Windows/IWindowsFacebook.cs
@@ -23,5 +23,7 @@ namespace Facebook.Unity.Windows
     internal interface IWindowsFacebook : IPayFacebook, IFacebook
     {
         void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirtualGamepadLayoutResult> callback);
+
+        void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback);
     }
 }
diff --git a/Facebook.Unity/Windows/IWindowsWrapper.cs b/Facebook.Unity/Windows/IWindowsWrapper.cs
@@ -80,5 +80,7 @@ internal interface IWindowsWrapper
         void SetVirtualGamepadLayout(string layout, string callbackId, CallbackManager callbackManager);
 
         void GetUserLocale(string callbackId, CallbackManager callbackManager);
+
+        void SetSoftKeyboardOpen(bool open, string callbackId, CallbackManager callbackManager);
     }
 }
diff --git a/Facebook.Unity/Windows/WindowsFacebook.cs b/Facebook.Unity/Windows/WindowsFacebook.cs
@@ -281,6 +281,11 @@ public void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirtualGame
             this.windowsWrapper.SetVirtualGamepadLayout(layout, this.CallbackManager.AddFacebookDelegate(callback), this.CallbackManager);
         }
 
+        public void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback)
+        {
+            this.windowsWrapper.SetSoftKeyboardOpen(open, this.CallbackManager.AddFacebookDelegate(callback), this.CallbackManager);
+        }
+
         // Not supported by Windows SDK
         public override void AppRequest(string message, OGActionType? actionType, string objectId, IEnumerable<string> to, IEnumerable<object> filters, IEnumerable<string> excludeIds, int? maxRecipients, string data, string title, FacebookDelegate<IAppRequestResult> callback)
         {
diff --git a/UnitySDK/Assembly-CSharp.csproj b/UnitySDK/Assembly-CSharp.csproj
@@ -65,6 +65,7 @@
      <Compile Include="Assets\FacebookSDK\Examples\Windows\FBWindowsLogsManager.cs" />
      <Compile Include="Assets\FacebookSDK\Examples\Windows\FBWindowsPurchaseManager.cs" />
      <Compile Include="Assets\FacebookSDK\Examples\Windows\FBWindowsShareManager.cs" />
+     <Compile Include="Assets\FacebookSDK\Examples\Windows\FBWindowsSoftKeyboardManager.cs" />
      <Compile Include="Assets\FacebookSDK\Examples\Windows\FBWindowsTournamentsManager.cs" />
      <None Include="Assets\FacebookSDK\link.xml" />
      <None Include="Assets\Plugins\Android\AndroidManifest.xml" />
diff --git a/UnitySDK/Assets/FacebookSDK/Examples/Windows/FBWindowsSoftKeyboardManager.cs b/UnitySDK/Assets/FacebookSDK/Examples/Windows/FBWindowsSoftKeyboardManager.cs
@@ -0,0 +1,28 @@
+﻿using Facebook.Unity;
+using System;
+using UnityEngine;
+using UnityEngine.UI;
+
+public class FBWindowsSoftKeyboardManager : MonoBehaviour
+{
+    public FBWindowsLogsManager Logger;
+
+    public void SetSoftKeyboardOpenButton()
+    {
+        Logger.DebugLog("Setting Soft Keyboard Open");
+        FB.Windows.SetSoftKeyboardOpen(true, CallbackSetSoftKeyboardOpen);
+    }
+
+    private void CallbackSetSoftKeyboardOpen(ISoftKeyboardOpenResult result)
+    {
+        if (result.Error != null)
+        {
+            Logger.DebugErrorLog("Error setting Soft Keyboard Open: " + result.RawResult);
+            Logger.DebugErrorLog(result.Error);
+        }
+        else
+        {
+            Logger.DebugLog("Soft Keyboard Open set: " + result.Success);
+        }
+    }
+}
diff --git a/UnitySDK/Assets/FacebookSDK/Examples/Windows/FBWindowsSoftKeyboardManager.cs.meta b/UnitySDK/Assets/FacebookSDK/Examples/Windows/FBWindowsSoftKeyboardManager.cs.meta
diff --git a/UnitySDK/Assets/FacebookSDK/Examples/Windows/WindowsExample.unity b/UnitySDK/Assets/FacebookSDK/Examples/Windows/WindowsExample.unity

Original file line number	Diff line number	Diff line change
`@@ -664,5 +664,22 @@ public void GetUserLocale(string callbackId, CallbackManager callbackManager)`
`664`	`664`	`callbackManager.OnFacebookResponse(new LocaleResult(new ResultContainer(result)));`
`665`	`665`	`}`
`666`	`666`	`}`
	`667`	`+`
	`668`	`+ public void SetSoftKeyboardOpen(bool open, string callbackId, CallbackManager callbackManager)`
	`669`	`+ {`
	`670`	`+ fbg.Softkeyboard.setSoftKeyboardOpen(open,`
	`671`	`+ (fbg.SoftkeyboardAction success) =>`
	`672`	`+ {`
	`673`	`+ Dictionary<string, object> resultDict = new Dictionary<string, object>() {`
	`674`	`+ { Constants.CallbackIdKey, callbackId },`
	`675`	`+ { "success", success },`
	`676`	`+ };`
	`677`	`+ callbackManager.OnFacebookResponse(new SoftKeyboardOpenResult(new ResultContainer(resultDict)));`
	`678`	`+ }, (fbg.Error error) =>`
	`679`	`+ {`
	`680`	`+ SoftKeyboardOpenResult result = new SoftKeyboardOpenResult(WindowsParserBase.SetError(error, callbackId));`
	`681`	`+ callbackManager.OnFacebookResponse(result);`
	`682`	`+ });`
	`683`	`+ }`
`667`	`684`	`}`
`668`	`685`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,8 @@ private static void CallCallback(object callback, IResult result)`
`98`	`98`	`CallbackManager.TryCallCallback<IFriendFinderInvitationResult>(callback, result) \|\|`
`99`	`99`	`CallbackManager.TryCallCallback<IVirtualGamepadLayoutResult>(callback, result) \|\|`
`100`	`100`	`CallbackManager.TryCallCallback<IDialogResult>(callback, result) \|\|`
`101`		`- CallbackManager.TryCallCallback<ILocaleResult>(callback, result))`
	`101`	`+ CallbackManager.TryCallCallback<ILocaleResult>(callback, result) \|\|`
	`102`	`+ CallbackManager.TryCallCallback<ISoftKeyboardOpenResult>(callback, result))`
`102`	`103`	`{`
`103`	`104`	`return;`
`104`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1403,6 +1403,16 @@ public static void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirt`
`1403`	`1403`	`{`
`1404`	`1404`	`Windows.WindowsFacebookImpl.SetVirtualGamepadLayout(layout, callback);`
`1405`	`1405`	`}`
	`1406`	`+`
	`1407`	`+ /// <summary>`
	`1408`	`+ /// Open Virtual Keyboard in mobile devices.`
	`1409`	`+ /// </summary>`
	`1410`	`+ /// <param name="open"> true if you want to open the keyboard</param>`
	`1411`	`+ /// <param name="callback">Callback to be called when request completes.</param>`
	`1412`	`+ public static void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback)`
	`1413`	`+ {`
	`1414`	`+ Windows.WindowsFacebookImpl.SetSoftKeyboardOpen(open, callback);`
	`1415`	`+ }`
`1406`	`1416`	`}`
`1407`	`1417`
`1408`	`1418`	`internal abstract class CompiledFacebookLoader : MonoBehaviour`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,7 @@ namespace Facebook.Unity.Windows`
`23`	`23`	`internal interface IWindowsFacebook : IPayFacebook, IFacebook`
`24`	`24`	`{`
`25`	`25`	`void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirtualGamepadLayoutResult> callback);`
	`26`	`+`
	`27`	`+ void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback);`
`26`	`28`	`}`
`27`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,5 +80,7 @@ internal interface IWindowsWrapper`
`80`	`80`	`void SetVirtualGamepadLayout(string layout, string callbackId, CallbackManager callbackManager);`
`81`	`81`
`82`	`82`	`void GetUserLocale(string callbackId, CallbackManager callbackManager);`
	`83`	`+`
	`84`	`+ void SetSoftKeyboardOpen(bool open, string callbackId, CallbackManager callbackManager);`
`83`	`85`	`}`
`84`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -281,6 +281,11 @@ public void SetVirtualGamepadLayout(string layout, FacebookDelegate<IVirtualGame`
`281`	`281`	`this.windowsWrapper.SetVirtualGamepadLayout(layout, this.CallbackManager.AddFacebookDelegate(callback), this.CallbackManager);`
`282`	`282`	`}`
`283`	`283`
	`284`	`+ public void SetSoftKeyboardOpen(bool open, FacebookDelegate<ISoftKeyboardOpenResult> callback)`
	`285`	`+ {`
	`286`	`+ this.windowsWrapper.SetSoftKeyboardOpen(open, this.CallbackManager.AddFacebookDelegate(callback), this.CallbackManager);`
	`287`	`+ }`
	`288`	`+`
`284`	`289`	`// Not supported by Windows SDK`
`285`	`290`	`public override void AppRequest(string message, OGActionType? actionType, string objectId, IEnumerable<string> to, IEnumerable<object> filters, IEnumerable<string> excludeIds, int? maxRecipients, string data, string title, FacebookDelegate<IAppRequestResult> callback)`
`286`	`291`	`{`