Skip to content

接入使用

前置条件

因 JSSDK 依赖 UGOS Pro 系统前端桌面环境,因此仅支持应用前端页面在 UGOS Pro 系统桌面内以独立窗口方式打开时使用,即应用配置中打开方式 open_type 需要配置为 inner

引入方式

同时支持 ESM 和 CJS 两种模块引入方式,具体引入文件如下:

shell
index.js    --- ESM (ECMAScript Modules)  使用 import 和 export 语句
index.d.ts  --- 类型文件 具体导出内容
index.cjs   --- CJS (CommonJS) 使用 require 和 module.exports 语句

接口说明

  • getUgInfo: 获取当前登录用户设置信息,参数为回调函数,回调函数接收一个对象,包含以下属性:
    • third_token: 登录用户的第三方认证 token,调用后端服务时进行登录认证。
    • lang: 前端界面使用的语言,如 zh-CNen-US 等,用于前端界面的国际化展示。
  • openAppDetail: 打开应用中心指定应用的详情页,参数为应用 ID,例如 com.mycompany.myapp

使用示例

  • info error 类型说明
typescript
type errCodeType = {
  code: errCode;
  message: string;
};
declare enum errCode {
  NETWORK_ERR = 6704,
  TEMP_TOKEN_ERROR = 6703,
  REPEAT_REQUEST_ERROR = 6702,
  CLIENT_LOW = 6701,
}
type ugSdkType = {
  getUgInfo: (
    callback: (err: errCodeType | null, res: ugInfoType) => void,
  ) => void;
  ugFetch: {
    get(
      url: string,
      params?: Record<any, any>,
      headers?: Record<any, any>,
    ): Promise<any>;
    post(
      url: string,
      data?: Record<any, any>,
      headers?: Record<any, any>,
    ): Promise<any>;
  };
  LOGIN_FAILED_CODE: number[];
  openAppDetail: (appId: string) => void;
};
type __ugInfoType = {
  dateFormat?: string;
  timeFormat?: string;
  temperatureUnit?: number;
  third_token?: string;
  lang?: string;
};
type ugInfoType = null | __ugInfoType;
declare const ugSdk: ugSdkType;

export { ugInfoType, ugSdk };
  • 示例:获取 info 信息、打开应用详情
js
import { ugSdk } from './index.js?v=1';
let ugToken = null;
//回调
const callback = (error, _info) => {
   if (!error) {
       console.log(_info);
       if (_info && _info.third_token) {
           ugToken = _info.third_token;
       }
       fetchAPI();
   }
};
// 获取登录认证token
ugSdk.getUgInfo(callback);

// 打开应用详情页
const appId = 'com.mycompany.myapp' // 应用ID
ugSdk.openAppDetail(appId)

jssdk 下载

文件名大小下载链接MD5
jssdk25 KBjssdk.zipE67990E18C8834D7CBBE6CDB5F3E6D87