com.typhoon.unitysdk 1.0.37 → 1.0.39

package/Runtime/TyphoonSdk.cs

@@ -95,7 +95,9 @@ namespace TyphoonUnitySDK
         #region 初始化SDK
 
         /// <summary>
-        /// 初始化sdk
+        /// 初始化sdk（必接）<para></para>
+        /// 在成功回调后再执行登录<para></para>
+        /// 登录API:<seealso cref="Login"/>
         /// </summary>
         public void InitSdk(Action success, Action<string> fail)
         {
@@ -114,7 +116,9 @@ namespace TyphoonUnitySDK
         #region 登录
 
         /// <summary>
-        /// 登录
+        /// 登录（必接）<para></para>
+        /// 请完成初始化并且成功后再调用<para></para>
+        /// 初始化API:<seealso cref="InitSdk"/>
         /// </summary>
         public void Login(Action success, Action<string> fail)
         {
@@ -179,7 +183,9 @@ namespace TyphoonUnitySDK
         #region 视频广告
 
         /// <summary>
-        /// 获取视频广告加载标记
+        /// 获取视频广告加载标记<para/>
+        /// true:视频广告完成加载<para/>
+        /// false:视频广告未完成加载<para/>
         /// </summary>
         public bool GetVideoFlag()
         {
@@ -193,7 +199,7 @@ namespace TyphoonUnitySDK
         }
 
         /// <summary>
-        /// 视频广告
+        /// 展示视频广告
         /// </summary>
         /// <param name="scene">广告场景</param>
         /// <param name="success">成功回调，发放奖励</param>
@@ -229,7 +235,7 @@ namespace TyphoonUnitySDK
         #region 插页广告
 
         /// <summary>
-        /// 插页广告
+        /// 展示插页广告
         /// </summary>
         /// <param name="scene">广告场景</param>
         public void ShowInters(string scene)
@@ -373,9 +379,9 @@ namespace TyphoonUnitySDK
         #region 发布版本号
 
         /// <summary>
-        /// 发布版本号
+        /// 获取发布版本号<para/>
+        /// 此为内部维护版本号，在发布窗口中进行设置，可显示在loading页中，方便区分包体内容所属什么迭代版本的阶段，避免传错包等问题
         /// </summary>
-        /*获取发布版本号信息*/
         public virtual string GetPublishVersion()
         {
             var result = AppConfig.Version;
@@ -472,67 +478,68 @@ namespace TyphoonUnitySDK
         #region 录屏分享
 
         /// <summary>
-        /// 是否支持录屏分享
+        /// 是否支持录屏分享（抖音小游戏）
         /// </summary>
-        public bool CanRecordGame()
+        public bool IsSupportGameRecord()
         {
 #if UNITY_EDITOR
             return SimulateRecordGame.Instance.CanRecord();
 #endif
-            return _sdk.CanRecordGame();
+            return _sdk.IsSupportGameRecord();
         }
 
         /// <summary>
-        /// 开启录屏
+        /// 开启游戏录屏（抖音小游戏）
         /// </summary>
         /// <param name="isRecordAudio">包含音频</param>
         /// <param name="maxRecordTimeSec">最大录屏时长</param>
         /// <param name="onStart">开始回调</param>
         /// <param name="onError">错误回调</param>
         /// <param name="onComplete">完成回调</param>
-        public void StartRecordGame(bool isRecordAudio = true, int maxRecordTimeSec = 600, Action onStart = null,
+        public void StartGameRecord(bool isRecordAudio = true, int maxRecordTimeSec = 600, Action onStart = null,
             Action<string> onError = null, Action<string> onComplete = null)
         {
 #if UNITY_EDITOR
             SimulateRecordGame.Instance.StartRecord(onStart);
             return;
 #endif
-            _sdk.StartRecordGame(isRecordAudio, maxRecordTimeSec, onStart, onError, onComplete);
+            _sdk.StartGameRecord(isRecordAudio, maxRecordTimeSec, onStart, onError, onComplete);
         }
 
         /// <summary>
-        /// 停止录制
+        /// 结束游戏录制（抖音小游戏）
         /// </summary>
         /// <param name="complete">完成回调，返回videopath</param>
         /// <param name="onError">错误回调</param>
         /// <param name="clips">自定义剪辑片段，单位毫秒</param>
         /// <param name="autoMerge">自动合并</param>
-        public void StopRecordGame(Action<string> complete = null, Action<string> onError = null,
+        public void StopGameRecord(Action<string> complete = null, Action<string> onError = null,
             List<TimeClip> clips = null, bool autoMerge = true)
         {
 #if UNITY_EDITOR
             SimulateRecordGame.Instance.StopRecord(complete);
             return;
 #endif
-            _sdk.StopRecordGame(complete, onError, clips, autoMerge);
+            _sdk.StopGameRecord(complete, onError, clips, autoMerge);
         }
 
         /// <summary>
-        /// 获取录屏时长
+        /// 获取录屏时长（抖音小游戏）
         /// </summary>
-        public float GetRecordDuration()
+        public float GetGameRecordDuration()
         {
 #if UNITY_EDITOR
             return SimulateRecordGame.Instance.GetDuration();
 #endif
-            return _sdk.GetRecordDuration();
+            return _sdk.GetGameRecordDuration();
         }
 
 
         /// <summary>
-        /// 是否可以分享录屏
+        /// 是否可以分享录屏（抖音小游戏）<para/>
+        /// 当为true可以激活分享按钮
         /// </summary>
-        public bool CanShareRecordGame()
+        public bool CanShareGameRecord()
         {
 #if UNITY_EDITOR
             return SimulateRecordGame.Instance.CanShare();
@@ -545,10 +552,10 @@ namespace TyphoonUnitySDK
         /// </summary>
         /// <param name="title">标题</param>
         /// <param name="topics">话题</param>
-        /// <param name="success">成功回调</param>
+        /// <param name="success">成功回调，可以下发奖励</param>
         /// <param name="fail">失败回调</param>
         /// <param name="cancel">取消回调</param>
-        public void ShareRecordGame(string title, List<string> topics, Action success, Action<string> fail = null,
+        public void ShareGameRecord(string title, List<string> topics, Action success, Action<string> fail = null,
             Action cancel = null)
         {
 #if UNITY_EDITOR
@@ -558,10 +565,32 @@ namespace TyphoonUnitySDK
             _sdk.ShareRecordGame(title, topics, success, fail, cancel);
         }
 
+
+        /// <summary>
+        /// 清理游戏录屏（抖音小游戏）
+        /// </summary>
+        public void ClearGameRecord()
+        {
+#if UNITY_EDITOR
+            SimulateRecordGame.Instance.ClearRecord();
+            return;
+#endif
+            _sdk.ClearGameRecord();
+        }
+
         #endregion
 
         #region Http请求
 
+        /// <summary>
+        /// http post 请求
+        /// </summary>
+        /// <param name="url">地址</param>
+        /// <param name="data">传输的数据</param>
+        /// <param name="success">成功回调</param>
+        /// <param name="fail">失败回调</param>
+        /// <param name="header">请求头</param>
+        /// <param name="timeOut">超时时间</param>
         public virtual void HttpPost(string url, string data, Action<HttpPostSuccessResult> success,
             Action<string> fail,
             Dictionary<string, string> header = null, int timeOut = 60)
@@ -573,7 +602,14 @@ namespace TyphoonUnitySDK
             _sdk?.HttpPost(url, data, success, fail, header, timeOut);
         }
 
-
+        /// <summary>
+        /// http get 请求
+        /// </summary>
+        /// <param name="url">地址</param>
+        /// <param name="success">成功回调</param>
+        /// <param name="fail">失败回调</param>
+        /// <param name="header">请求头</param>
+        /// <param name="timeOut">超时时间</param>
         public virtual void HttpGet(string url, Action<HttpGetSuccessResult> success, Action<string> fail,
             Dictionary<string, string> header = null, int timeOut = 60)
         {
@@ -585,5 +621,124 @@ namespace TyphoonUnitySDK
         }
 
         #endregion
+
+        #region 侧边栏（抖音小游戏）
+
+        /// <summary>
+        /// 判断是否支持侧边栏，可以通过此接口判断是否开启侧边栏奖励入口
+        /// </summary>
+        /// <param name="success">成功回调，表示支持该功能，可以显示入口</param>
+        /// <param name="fail">失败回调，表示不支持该功能，可以显示入口</param>
+        public virtual void IsSupportSideBar(Action success, Action<string> fail)
+        {
+#if UNITY_EDITOR
+            switch (AppConfig.Channel)
+            {
+                case AppChannel.DouyinAndroid:
+                case AppChannel.DouyinIOS:
+                    break;
+                default:
+                    fail?.Invoke($"[{AppConfig.Channel}]渠道不支持侧边栏功能");
+                    return;
+            }
+
+            if (SdkTestInUnity.Instance.IsSupportSideBarResult)
+            {
+                success?.Invoke();
+            }
+            else
+            {
+                fail?.Invoke("not support");
+                Debug.Log("<color=#e53e30> [SDK模拟] 是否支持侧边栏-回调结果==false,可从'TyphoonSDK/模拟测试'修改</color>");
+            }
+
+            return;
+#endif
+            _sdk.IsSupportSideBar(success, fail);
+        }
+
+        /// <summary>
+        /// 帮用户跳转到侧边栏
+        /// </summary>
+        /// <param name="success">跳转成功回调</param>
+        /// <param name="fail">跳转失败回调,内部会做提示</param>
+        public virtual void NavigateToSideBar(Action success, Action<string> fail, bool showFailToast = true)
+        {
+#if UNITY_EDITOR
+            switch (AppConfig.Channel)
+            {
+                case AppChannel.DouyinAndroid:
+                case AppChannel.DouyinIOS:
+                    break;
+                default:
+                    fail?.Invoke($"[{AppConfig.Channel}]渠道不支持侧边栏功能");
+                    return;
+            }
+
+            if (SdkTestInUnity.Instance.NavigateToSideBarResult)
+            {
+                success?.Invoke();
+            }
+            else
+            {
+                if (showFailToast)
+                {
+                    ShowToast("跳转失败，可主动从侧边栏访问本游戏后领奖");
+                }
+
+                fail?.Invoke("not support");
+                Debug.Log("<color=#e53e30> [SDK模拟] 导航到侧边栏-回调结果==false,可从'TyphoonSDK/模拟测试'修改</color>");
+            }
+
+            return;
+#endif
+            _sdk.NavigateToSideBar(success, fail);
+        }
+
+        /// <summary>
+        /// 是否从侧边栏进入
+        /// 当为true，满足侧边栏奖励下发条件,激活领取奖励按钮
+        /// </summary>
+        public virtual bool IsEnterFromSideBar()
+        {
+#if UNITY_EDITOR
+            switch (AppConfig.Channel)
+            {
+                case AppChannel.DouyinAndroid:
+                case AppChannel.DouyinIOS:
+                {
+                    if (!SdkTestInUnity.Instance.IsEnterFromSideBar)
+                    {
+                        Debug.Log("<color=#e53e30> [SDK模拟] 侧边栏进入标记==false,可从'TyphoonSDK/模拟测试'修改</color>");
+                    }
+
+                    return SdkTestInUnity.Instance.IsEnterFromSideBar;
+                }
+            }
+
+            return false;
+#endif
+            return _sdk.IsEnterFromSideBar();
+        }
+
+        #endregion
+
+        #region Toast
+
+        /// <summary>
+        /// 显示Toast，类似于android的toast
+        /// 根据渠道不同显示的形式不同，请规避显示长文本，主要用于简短提示
+        /// </summary>
+        /// <param name="message">信息</param>
+        public virtual void ShowToast(string message)
+        {
+#if UNITY_EDITOR
+            Toast.Instance.Show(message);
+            return;
+#endif
+            _sdk.ShowToast(message);
+        }
+
+        #endregion
     }
 }

package/package.json

@@ -1 +1 @@
-{"name":"com.typhoon.unitysdk","displayName":"typhoon unity sdk","version":"1.0.37","description":"","unity":"2018.1","type":"tool","hideInEditor":false,"author":{"name":"Jan Zhang","email":"","url":""},"changelogUrl":"","documentationUrl":"","keywords":["typhoon"],"license":"","licensesUrl":"","customDependencies":[{"PackageName":"com.unity.nuget.newtonsoft-json","Value":"2.0.0"}],"dependencies":{"com.unity.nuget.newtonsoft-json":"2.0.0"}}
+{"name":"com.typhoon.unitysdk","displayName":"typhoon unity sdk","version":"1.0.39","description":"","unity":"2018.1","type":"tool","hideInEditor":false,"author":{"name":"Jan Zhang","email":"","url":""},"changelogUrl":"","documentationUrl":"","keywords":["typhoon"],"license":"","licensesUrl":"","customDependencies":[{"PackageName":"com.unity.nuget.newtonsoft-json","Value":"2.0.0"}],"dependencies":{"com.unity.nuget.newtonsoft-json":"2.0.0"}}