prepare for publication

Author: Allow2CEO

Allow2/Allow2CheckResult.cs

@@ -82,12 +82,20 @@ namespace Allow2
         //{
         //}
 
+        /// <summary>
+        /// Convenience method.
+        /// </summary>
+        /// <value>The activities.</value>
         public JSONNode Activities {
             get {
                 return this["activities"];
             }
         }
 
+        /// <summary>
+        /// Convenience method.
+        /// </summary>
+        /// <value>The subscription.</value>
         public JSONNode Subscription
         {
             get
@@ -96,6 +104,10 @@ public JSONNode Subscription
             }
         }
 
+        /// <summary>
+        /// When does the validity of this result expire? (cache expiry).
+        /// </summary>
+        /// <value>The expiry Date/Time</value>
         public DateTime Expires {
             get {
                 int unixTimeStamp = ((Activities != null) && (Activities[0] != null)) ?
@@ -104,6 +116,10 @@ public DateTime Expires {
             }
         }
 
+        /// <summary>
+        /// Returns <see langword="null"/> if the user is financial or within free usage tier, otherwise returns a message indicating they need a subscription
+        /// </summary>
+        /// <value>The need subscription.</value>
         public string NeedSubscription {
             get {
                 if (!Subscription["financial"].AsBool) {
@@ -123,12 +139,20 @@ public string NeedSubscription {
             }
         }
 
+        /// <summary>
+        /// A simple top level result, the child is currently allowed or not based on the activity time and quotas.
+        /// </summary>
+        /// <value><c>true</c> if is allowed; otherwise, <c>false</c>.</value>
         public bool IsAllowed {
             get {
                 return this["allowed"].AsBool;
             }
         }
 
+        /// <summary>
+        /// A Summary explanation of the current reasons they may not be allowed at this time.
+        /// </summary>
+        /// <value>The explanation.</value>
         public string Explanation {
             get {
                 List<string> reasons = new List<string>();
@@ -158,6 +182,10 @@ public string Explanation {
             }
         }
 
+        /// <summary>
+        /// A list of the current bans in place for this child.
+        /// </summary>
+        /// <value>The current bans.</value>
         public Allow2Ban[] CurrentBans {
             get {
                 List<Allow2Ban> bans = new List<Allow2Ban>();
@@ -184,6 +212,10 @@ public Allow2Ban[] CurrentBans {
             }
         }
 
+        /// <summary>
+        /// The type of day it is today.
+        /// </summary>
+        /// <value>The day type.</value>
         public Allow2Day Today
         {
             get
@@ -193,6 +225,10 @@ public Allow2Day Today
             }
         }
 
+        /// <summary>
+        /// The type of day it will be tomorrow.
+        /// </summary>
+        /// <value>The day type.</value>
         public Allow2Day Tomorrow
         {
             get
@@ -202,6 +238,10 @@ public Allow2Day Tomorrow
             }
         }
 
+        /// <summary>
+        /// All Day Types the parent has set on their account that the child should be aware of or can choose from for a request.
+        /// </summary>
+        /// <value>All day types.</value>
         public Allow2Day[] AllDayTypes
         {
             get

Allow2/Examples/CheckButton.cs

@@ -27,6 +27,9 @@ public class CheckButton : MonoBehaviour
             (int)Activity.Computer
         };
 
+        /// <summary>
+        /// Check once and log activity for the given child and activities.
+        /// </summary>
         public void Check()
         {
             Debug.Log("Check");
@@ -50,6 +53,9 @@ public void Check()
                true);
         }
 
+        /// <summary>
+        /// Start a continuous check (and logging usage) for the given child and activities.
+        /// </summary>
         public void StartChecking()
         {
             Debug.Log("Start Checking");
@@ -73,6 +79,9 @@ public void StartChecking()
                 true);
         }
 
+        /// <summary>
+        /// Stop checking and logging.
+        /// </summary>
         public void StopChecking()
         {
             Debug.Log("Stop Checking");

Allow2/Examples/DeviceNameInput.cs

@@ -23,18 +23,26 @@ public class DeviceNameInput : MonoBehaviour
     {
 
         public InputField inputField;
-        public Image qrImage;
+        public RawImage qrImage;
 
+        /// <summary>
+        /// On creating the field, we pre-populate it with the system device name.
+        /// This will auto-trigger the "InputValueChanged" and update the QR Code for pairing.
+        /// </summary>
         void Awake()
         {
             inputField.text = SystemInfo.deviceName;
         }
 
+        /// <summary>
+        /// When the input value changes, generate a new QR Code, so the user can interactively edit the name and the pairing process uses that name.
+        /// </summary>
+        /// <param name="input">Input.</param>
         public void InputValueChanged(string input)
         {
             Allow2.GetQR(this, input, delegate (string err, Texture2D qrCode)
             {
-                Debug.Log("qrcode error: " + (err ?? "No Error") + " : " + (qrCode != null ? qrCode.dimension.ToString()  : "no"));
+                Debug.Log("Input Value qrcode error: " + (err ?? "No Error") + " : " + (qrCode != null ? qrCode.width.ToString() + "," + qrCode.height.ToString() : "no"));
                 qrImage.GetComponent<RawImage>().texture = qrCode;
             });
         }

Allow2/Examples/PairButton.cs

@@ -21,14 +21,22 @@ namespace Allow2.Allow2Examples
 
     public class PairButton : MonoBehaviour
     {
+
+        public InputField UsernameField;
+        public InputField PasswordField;
+        public InputField DeviceNameField;
+
+        /// <summary>
+        /// Manually pair with Allow2 by providing the username and password entered by the user in your pairing interface.
+        /// </summary>
         public void Pair()
         {
             Debug.Log("Start Pairing");
             Allow2.Pair(
                 this,
-                "andrew@imagineit.com.au",
-                "2}LJA84$3y88H]o",
-                "Unity Test",
+                UsernameField.text,
+                PasswordField.text,
+                DeviceNameField.text,
                 delegate (string err, Allow2CheckResult result)
                 {
                     Debug.Log("Stop Pairing");

Allow2/Examples/RequestButton.cs

@@ -24,6 +24,9 @@ public class RequestButton : MonoBehaviour
         public int dayTypeId = 23;
         public int[] bansToLift = {};
 
+        /// <summary>
+        /// Send a request on behalf of the child.
+        /// </summary>
         public void Request()
         {
             Debug.Log("Request");

Allow2/Examples/SceneClass.cs

@@ -22,7 +22,7 @@ namespace Allow2.Allow2Examples
     public class SceneClass : MonoBehaviour
     {
 
-        public Image qrImage;
+        public RawImage qrImage;
 
         void Awake()
         {
@@ -41,12 +41,27 @@ void Awake()
             Debug.Log("isPaired: " + Allow2.IsPaired);
             Debug.Log("Children: " + Allow2.Children);
 
+            // Not Required if the textfield sets the name on display, it will also trigger an update of the QR Code
             // and in the pairing interface, we need a QR code to make the process simple for our users
-            Allow2.GetQR(this, SystemInfo.deviceName, delegate (string err, Texture2D qrCode)
-            {
-                Debug.Log("qrcode error: " + (err ?? "No Error") + " : " + (qrCode ? "yes" : "no"));
-                Debug.Log(qrImage.GetComponent<RawImage>());
-                qrImage.GetComponent<RawImage>().texture = qrCode;
+            //Allow2.GetQR(this, SystemInfo.deviceName, delegate (string err, Texture2D qrCode)
+            //{
+            //    Debug.Log("qrcode error: " + (err ?? "No Error") + " : " + (qrCode ? "yes" : "no"));
+            //    Debug.Log(qrImage.GetComponent<RawImage>());
+            //    qrImage.GetComponent<RawImage>().texture = qrCode;
+            //});
+
+            // usually start the pairing background process here,
+            // unless you have opted to not allow pairing with QR Code (but this is highly recommended for a better user experience)
+            Allow2.StartPairing(this, delegate (string err, Allow2CheckResult result) {
+                // this may be called several times with errors
+                if (err != null) {
+                    Debug.Log(err);
+                    return;
+                }
+                // once paired, the pairing process will automatically stop itself
+                // you should close off the pairing interface here and display success to the end user
+                Debug.Log("isPaired: " + Allow2.IsPaired);
+                Debug.Log("Children: " + Allow2.Children);
             });
         }
     }