/** * 国际化语言,支持英文、中文简体、中文繁体 * */ export type TLocale = 'en_US' | 'zh_CN' | 'zh_TW'; /** * 网关Token信息 * * @param { string } access_token - Token信息 * @param { string } signSecret - 当前签名 * @param { string } refresh_token - 可选,刷新Token信息 * @param { string } domain - 可选,域名 * @param { number } expires_in - 可选,失效时间 * @param { string } openid - 可选,OpenID * @param { string } scope - 可选,范围 * @param { string } token_type - 可选,Token类型 */ export interface IToken { access_token: string; signSecret: string; refresh_token?: string; domain?: string; expires_in?: number; openid?: string; scope?: string; token_type?: string; } export declare type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'link' | 'LINK' | 'unlink' | 'UNLINK'; /** * API网关 签名参数 * * @property { Method } method 请求方法 * @property { string } url 请求url, 包含query参数 * @property { string } body 请求体, 需进行json转换, 无请求体,则传入"" * @property { string } clientId * @property { string } clienttype * @property { string } clientSecret 签名秘钥: 此密钥为网关平台颁发的ClientSecret. 未登录时,需传入此值 * @property { string } token 需进行token校验的,必须传入此值 * @property { string } signSecret 需进行token校验的,必须传入此值 */ export interface ISignParams { method: string; url: string; body: string; clientId: string; clienttype: string; clientSecret: string; token: string; signSecret: string; } /** * 返回结果内容 * * @property { string } code - 错误码 * @property { string } msg - 错误码描述 * @property { any } detail - 数据内容 */ export interface IReturnResult { code: string; msg: string; detail: any; } export type Key = string | number; /** * localStorage Key * * @param { ABILITY } - 能力结果 * @param { LOG_SERVER } - 日志服务 * @param { ERROR_CODE } - 错误码 * @param { I18N_CODE } - 国际化 * @param { TIMESTAMP } - 时间戳 */ export declare enum XY_STORAGE_KEY { ABILITY = "XY_ABILITY", LOG_SERVER = "XY_LOG_SERVER", ERROR_CODE = "XY_ERROR_CODE", I18N_CODE = "XY_I18N_CODE", TIMESTAMP = "XY_TIMESTAMP" } /** * 可支持的编解码 * * @param { string[] } video - 视频支持的编解码器 * @param { string[] } audio - 音频支持的编解码器 */ export interface XYSupportedCodec { video: string[]; audio: string[]; } /** * 内外网探测服务器信息 * * @property { string } enterpriseId - 企业ID * @property { string } innerIp - 内网IP * @property { string } node - 服务节点 * @property { string } serverName - 服务名称 */ export interface XYLocatorServerInfo { enterpriseId: string; innerIp: string; node: string; serverName: string; } /** * XYError 接口定义 * 此接口用于描述错误对象的结构,包含错误的基本信息。 * * @interface XYError * @property { string } name - 可选,错误名称 * @property { string } message - 可选,错误消息 * @property { string } stack - 可选,错误堆栈信息 * @property { string | number } code - 可选,错误代码 * @property { string | number } errorCode - 可选,错误代码 * @property { any } detail - 可选,自定义详情 * @property { string } msg - 错误信息 * @property { string } doc - 可选,文档链接 */ export interface XYError { name?: string; message?: string; stack?: string; code?: string | number; errorCode?: string | number; detail?: any; msg?: string; doc?: string; } /** * SDK版本信息 * * @property { string } version - 版本号 * @property { string } createTime - 发版时间 */ export interface XYVersion { version: string; createTime: string; } /** * 通用状态枚举 * * @property { CLOSE } CLOSE - 关闭 * @property { OPEN } OPEN - 开启 */ export declare enum XYCommonState { NONE = -1, CLOSE = 0, OPEN = 1 }