@ftvs/jssdk 1.4.0 → 1.4.3

package/README.md

@@ -1 +1,3 @@
 # 多彩未来电视 JSSDK
+
+[查看文档 →](https://ftv-h5.dcwl.tv/jssdk/docs/guide/index.html)

package/lib/index.d.ts

@@ -268,6 +268,38 @@ interface GetTokenResult {
  */
 declare function getAuthToken(): Promise<GetTokenResult>;
 
+interface GetAuthUserInfoResult {
+    /**
+     * 昵称
+     */
+    username: string;
+    /**
+     * 用户头像
+     */
+    avatar: string;
+    /**
+     * 实名状态
+     * 0-未实名
+     * 1-已实名
+     */
+    authStatus: number;
+}
+/**
+ * 用户基本信息（多彩未来内部使用）。
+ * @category 开放接口 > 用户信息
+ * @example
+ * ```javascript
+ * const res = await ftv.getAuthUserInfo();
+ * // 结果类似：
+ * // {
+ * //   username: '张三’
+ * //   avatar: 'https://www.dcwl.tv/xxxxx.png’
+ * //   username: 1
+ * // }
+ * ```
+ */
+declare function getAuthUserInfo(): Promise<GetAuthUserInfoResult>;
+
 interface Environment {
     /**
      * 是否在未来电视客户端中。
@@ -441,15 +473,21 @@ interface NavigateToPayLoad {
  */
 declare function navigateTo(payload: NavigateToPayLoad): Promise<void>;
 
+interface OpenLoginPagePayLoad {
+    /**
+     * 登录页按返回按键是否关闭当前的web
+     */
+    isCloseCurrentWindow?: boolean;
+}
 /**
  * 去登录页。
  * @category 基础
  * @example
  * ```javascript
- * await ftv.openLoginPage();
+ * await ftv.openLoginPage({isCloseCurrentWindow: true});
  * ```
  */
-declare function openLoginPage(): Promise<void>;
+declare function openLoginPage(payload?: OpenLoginPagePayLoad): Promise<void>;
 
 interface RequestFaceAuthenticationPayload {
     /**
@@ -641,6 +679,8 @@ type _ftv_GetAuthCodeResult = GetAuthCodeResult;
 declare const _ftv_getAuthCode: typeof getAuthCode;
 type _ftv_GetTokenResult = GetTokenResult;
 declare const _ftv_getAuthToken: typeof getAuthToken;
+type _ftv_GetAuthUserInfoResult = GetAuthUserInfoResult;
+declare const _ftv_getAuthUserInfo: typeof getAuthUserInfo;
 declare const _ftv_getEnv: typeof getEnv;
 type _ftv_Environment = Environment;
 declare const _ftv_getEnvSync: typeof getEnvSync;
@@ -650,6 +690,7 @@ declare const _ftv_getUserInfo: typeof getUserInfo;
 declare const _ftv_navigateBack: typeof navigateBack;
 type _ftv_NavigateToPayLoad = NavigateToPayLoad;
 declare const _ftv_navigateTo: typeof navigateTo;
+type _ftv_OpenLoginPagePayLoad = OpenLoginPagePayLoad;
 declare const _ftv_openLoginPage: typeof openLoginPage;
 type _ftv_RequestFaceAuthenticationPayload = RequestFaceAuthenticationPayload;
 type _ftv_RequestFaceAuthenticationResult = RequestFaceAuthenticationResult;
@@ -680,6 +721,8 @@ declare namespace _ftv {
     _ftv_getAuthCode as getAuthCode,
     _ftv_GetTokenResult as GetTokenResult,
     _ftv_getAuthToken as getAuthToken,
+    _ftv_GetAuthUserInfoResult as GetAuthUserInfoResult,
+    _ftv_getAuthUserInfo as getAuthUserInfo,
     _ftv_getEnv as getEnv,
     _ftv_Environment as Environment,
     _ftv_getEnvSync as getEnvSync,
@@ -689,6 +732,7 @@ declare namespace _ftv {
     _ftv_navigateBack as navigateBack,
     _ftv_NavigateToPayLoad as NavigateToPayLoad,
     _ftv_navigateTo as navigateTo,
+    _ftv_OpenLoginPagePayLoad as OpenLoginPagePayLoad,
     _ftv_openLoginPage as openLoginPage,
     _ftv_RequestFaceAuthenticationPayload as RequestFaceAuthenticationPayload,
     _ftv_RequestFaceAuthenticationResult as RequestFaceAuthenticationResult,