T Comm

Appearance

引入 ​

ts
import {
  TENCENT_DOC_URL_PREFIX,
  TENCENT_DOC_MP_APP_ID,
  TENCENT_DOC_MP_DETAIL_PATH,
  isTencentDocLink,
  openTencentDocLink,
  getTencentDocUserInfo
} from 't-comm';

// 不支持 tree-shaking 的项目
import {
  TENCENT_DOC_URL_PREFIX,
  TENCENT_DOC_MP_APP_ID,
  TENCENT_DOC_MP_DETAIL_PATH,
  isTencentDocLink,
  openTencentDocLink,
  getTencentDocUserInfo
} from 't-comm/lib/tencent-doc/index';

// 只支持 ESM 的项目
import {
  TENCENT_DOC_URL_PREFIX,
  TENCENT_DOC_MP_APP_ID,
  TENCENT_DOC_MP_DETAIL_PATH,
  isTencentDocLink,
  openTencentDocLink,
  getTencentDocUserInfo
} from 't-comm/es/tencent-doc/index';

TENCENT_DOC_URL_PREFIX ​

描述：腾讯文档链接前缀

参数：

TENCENT_DOC_MP_APP_ID ​

描述：腾讯文档小程序 AppId

参数：

TENCENT_DOC_MP_DETAIL_PATH ​

描述：腾讯文档小程序详情页路径

参数：

描述：判断是否为腾讯文档链接

参数：

参数名描述
url待判断的链接

示例

ts
isTencentDocLink('https://docs.qq.com/doc/xxx'); // true
isTencentDocLink('https://example.com'); // false

描述：打开腾讯文档链接

  • H5 环境下：直接 window.location.href 跳转
  • 小程序环境下：跳转到腾讯文档小程序详情页

参数：

参数名描述
jumpUrl腾讯文档链接（必须以 https://docs.qq.com/doc 开头）

返回: 是否为腾讯文档链接（仅当链接合法时执行跳转并返回 true）

示例

ts
openTencentDocLink('https://docs.qq.com/doc/xxx');

getTencentDocUserInfo() ​

描述：用于获取用户信息，同时也可以用来校验 AccessToken 的有效性。

参数：

示例

ts
const info = await getTencentDocUserInfo({ accessToken: 'xxx' });
console.log(info);
// { ret: 0, msg: 'ok', data: { user_name: '...', avatar_url: '...' } }