【小程序】基础API之系统API接口汇总

ty.env

环境变量

属性

USER_DATA_PATH string

文件系统中的用户目录路径 (本地路径)，当操作文件时需使用此目录。

// 写入一个文件
const fileManager = await ty.getFileSystemManager();
const fileRoot = ty.env.USER_DATA_PATH;
const filePath = `${fileRoot}/test.json`
await fileManager.writeFile({filePath: filePath,data: `{"test": "test"}`,
});// 分享该文件
ty.share({title: '分享一个文件',message: '这是一个 JSON 文件，调用系统分享',type: 'More',filePath: filePath,contentType: 'file',success() {console.log('分享成功');},fail(err) {console.log('分享失败', err);},
});

其他文件操作方法请参考 FileSystemManager。

ty.getSystemInfo

获取系统信息

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
is24Hourboolean
systemstring
brandstring
modelstring
platformstring
timezoneIdstring
pixelRationumber
screenWidthnumber
screenHeightnumber
windowWidthnumber
windowHeightnumber
statusBarHeightnumber
languagestring
safeAreaSafeArea
albumAuthorizedboolean
cameraAuthorizedboolean
locationAuthorizedboolean
microphoneAuthorizedboolean
notificationAuthorizedboolean
notificationAlertAuthorizedboolean
notificationBadgeAuthorizedboolean
notificationSoundAuthorizedboolean
bluetoothEnabledboolean
locationEnabledboolean
wifiEnabledboolean
themeThemes
deviceOrientationOrientation

SafeArea

属性类型说明
leftnumber安全区域左上角横坐标
rightnumber安全区域右下角横坐标
topnumber安全区域左上角纵坐标
bottomnumber安全区域右下角纵坐标
widthnumber安全区域的宽度，单位逻辑像素
heightnumber安全区域的高度，单位逻辑像素

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 获取系统信息*/
export function getSystemInfo(params?: {complete?: () => void;success?: (params: {is24Hour: boolean;system: string;brand: string;model: string;platform: string;timezoneId: string;pixelRatio: number;screenWidth: number;screenHeight: number;windowWidth: number;windowHeight: number;statusBarHeight: number;language: string;safeArea: SafeArea;albumAuthorized: boolean;cameraAuthorized: boolean;locationAuthorized: boolean;microphoneAuthorized: boolean;notificationAuthorized: boolean;notificationAlertAuthorized: boolean;notificationBadgeAuthorized: boolean;notificationSoundAuthorized: boolean;bluetoothEnabled: boolean;locationEnabled: boolean;wifiEnabled: boolean;theme?: Themes;deviceOrientation?: Orientation;}) => void;fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.getSystemInfoSync

获取系统信息同步方法

需引入BaseKit，且在>=1.2.10版本才可使用

ty.getSystemInfo 的同步版本

返回值

属性类型说明
is24Hourboolean
systemstring
brandstring
modelstring
platformstring
timezoneIdstring
pixelRationumber
screenWidthnumber
screenHeightnumber
windowWidthnumber
windowHeightnumber
statusBarHeightnumber
languagestring
safeAreaSafeArea
albumAuthorizedboolean
cameraAuthorizedboolean
locationAuthorizedboolean
microphoneAuthorizedboolean
notificationAuthorizedboolean
notificationAlertAuthorizedboolean
notificationBadgeAuthorizedboolean
notificationSoundAuthorizedboolean
bluetoothEnabledboolean
locationEnabledboolean
wifiEnabledboolean
themeThemes
deviceOrientationOrientation

SafeArea

属性类型说明
leftnumber安全区域左上角横坐标
rightnumber安全区域右下角横坐标
topnumber安全区域左上角纵坐标
bottomnumber安全区域右下角纵坐标
widthnumber安全区域的宽度，单位逻辑像素
heightnumber安全区域的高度，单位逻辑像素

函数定义示例

/*** 获取系统信息*/
export function getSystemInfoSync(): {is24Hour: boolean;system: string;brand: string;model: string;platform: string;timezoneId: string;pixelRatio: number;screenWidth: number;screenHeight: number;windowWidth: number;windowHeight: number;statusBarHeight: number;language: string;safeArea: SafeArea;albumAuthorized: boolean;cameraAuthorized: boolean;locationAuthorized: boolean;microphoneAuthorized: boolean;notificationAuthorized: boolean;notificationAlertAuthorized: boolean;notificationBadgeAuthorized: boolean;notificationSoundAuthorized: boolean;bluetoothEnabled: boolean;locationEnabled: boolean;wifiEnabled: boolean;theme?: Themes;deviceOrientation?: Orientation;
};

ty.getSystemSetting

获取设备设置

需引入BaseKit，且在>=2.5.0版本才可使用

参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
bluetoothEnabledboolean蓝牙的系统开关，默认 false
locationEnabledboolean地理位置的系统开关，默认 false
wifiEnabledbooleanWi-Fi 的系统开关，默认 false
deviceOrientationstring设备方向, 默认竖屏 竖屏 = "portrait"， 横屏 = "landscape"

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 获取设备设置*/
export function getSystemSetting(params?: {complete?: () => void;success?: (params: {/** 蓝牙的系统开关，默认false */bluetoothEnabled?: boolean;/** 地理位置的系统开关，默认false */locationEnabled?: boolean;/** Wi-Fi 的系统开关，默认false */wifiEnabled?: boolean;/*** 设备方向, 默认竖屏* 竖屏 = "portrait"， 横屏 = "landscape"*/deviceOrientation?: string;}) => void;fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.getDeviceInfo

获取设备基础信息

需引入BaseKit，且在>=2.4.3版本才可使用

参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
abistring应用二进制接口类型（仅 Android 支持）
brandstring设备品牌
modelstring设备型号。新机型刚推出一段时间会显示 unknown。
systemstring操作系统及版本
platformstring客户端平台

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 获取设备基础信息*/
export function getDeviceInfo(params?: {complete?: () => void;success?: (params: {/** 应用二进制接口类型（仅 Android 支持） */abi: string;/** 设备品牌 */brand: string;/** 设备型号。新机型刚推出一段时间会显示unknown。 */model: string;/** 操作系统及版本 */system: string;/** 客户端平台 */platform: string;}) => void;fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.openSystemBluetoothSetting

跳转系统蓝牙设置页 (仅 Android)

需引入BaseKit，且在>=2.4.3版本才可使用

参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

函数定义示例

/*** 跳转系统蓝牙设置页 (仅Android)*/
export function openSystemBluetoothSetting(params?: {complete?: () => void;success?: (params: null) => void;fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.updateVolume

设置系统音量

错误码标注 入参值范围超出 errorCode = 6， The volume value is invalid, it should be [0 - 1]

需引入BaseKit，且在>=2.4.3版本才可使用

参数

Object object

属性类型默认值必填说明
valuenumber是音量，阈值【0 - 1】
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

函数定义示例

/*** 设置系统音量**错误码标注*入参值范围超出 errorCode = 6， The volume value is invalid, it should be [0 - 1]*/
export function updateVolume(params: {/** 音量，阈值【0 - 1】 */value: number;complete?: () => void;success?: (params: null) => void;fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.handleShortcut

操作快捷方式，包括添加和移除, 仅 iOS

需引入BizKit，且在>=3.1.1版本才可使用。

参数

Object object

属性类型默认值必填说明
typenumber是操作类型。0-添加、1-移除
sceneIdstring是场景 ID
namestring是场景名称
iconUrlstring否场景 Logo
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
operationStepnumber操作步骤，0-添加、1-移除、2-更新、3-取消
operationStatusboolean操作状态，YES，表示成功；NO，表示失败

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 操作快捷方式，包括添加和移除, 仅 iOS*/
export function handleShortcut(params: {/** 操作类型。0-添加、1-移除 */type: number;/** 场景 ID */sceneId: string;/** 场景名称 */name: string;/** 场景 Logo */iconUrl?: string;/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: {/** 操作步骤，0-添加、1-移除、2-更新、3-取消 */operationStep: number;/** 操作状态，YES，表示成功；NO，表示失败 */operationStatus: boolean;}) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.isAssociatedShortcut

获取是否关联 siri 状态, 仅 iOS

需引入BizKit，且在>=3.1.1版本才可使用。

参数

Object object

属性类型默认值必填说明
sceneIdstring是场景 ID
namestring否场景名称
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
isAssociatedboolean是否已关联

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 获取是否关联 Siri 状态, 仅 iOS*/
export function isAssociatedShortcut(params: {/** 场景 ID */sceneId: string;/** 场景名称 */name?: string;/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: {/** 是否已关联 */isAssociated: boolean;}) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

ty.isSupportedShortcut

是否支持 Siri, 仅 iOS

需引入BizKit，且在>=3.1.1版本才可使用。

参数

Object object

属性类型默认值必填说明
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
isSupportedboolean是否支持

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/*** 是否支持 Siri, 仅 iOS*/
export function isSupportedShortcut(params?: {/** 接口调用结束的回调函数（调用成功、失败都会执行） */complete?: () => void;/** 接口调用成功的回调函数 */success?: (params: {/** 是否支持 */isSupported: boolean;}) => void;/** 接口调用失败的回调函数 */fail?: (params: {errorMsg: string;errorCode: string | number;innerError: {errorCode: string | number;errorMsg: string;};}) => void;
}): void;

 👉 立即开发。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/674369.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

探索C语言中的联合体与枚举：数据多面手的完美组合！

探索C语言中的联合体与枚举：数据多面手的完美组合！

​ ✨✨ 欢迎大家来到贝蒂大讲堂✨✨ 🎈🎈养成好习惯，先赞后看哦~🎈🎈 所属专栏：C语言学习 贝蒂的主页：Betty‘s blog 1. 联合体的定义 联合体又叫共用体，它是一种特殊的数据类型&…
阅读更多...
2024智慧城市新纪元：引领未来，重塑都市生活

2024智慧城市新纪元：引领未来，重塑都市生活

随着科技的飞速发展和数字化转型的不断深入，2024年智慧城市领域迎来了全新的发展格局。 这一年，智慧城市的建设更加注重人性化、可持续性和创新性，为城市居民带来了前所未有的便捷与舒适。以下将重点关注智慧城市的几个核心内容，…
阅读更多...
《幻兽帕鲁》攻略：0基础入门及游戏基础操作 幻兽帕鲁基础设施 幻兽帕鲁基础攻击力 Mac苹果电脑玩幻兽帕鲁 幻兽帕鲁加班加点

《幻兽帕鲁》攻略：0基础入门及游戏基础操作 幻兽帕鲁基础设施 幻兽帕鲁基础攻击力 Mac苹果电脑玩幻兽帕鲁 幻兽帕鲁加班加点

今天就跟大家聊聊《幻兽帕鲁》攻略：0基础入门及游戏基础操作。 如果想在苹果电脑玩《幻兽帕鲁》记得安装CrossOver哦。 以下纯干货： CrossOver正版安装包（免费试用）：https://souurl.cn/Y1gDao 一、基础操作 二、界面…
阅读更多...
Logback - 日志框架

Logback - 日志框架

引言 在当今的企业级应用开发中，日志管理是一个不可或缺的部分。它不仅帮助我们进行错误跟踪，还能有效监控应用程序的运行状态，为性能优化提供数据支撑。Spring Boot作为一个简化Spring应用开发的框架，自带了强大的日志管理功能。…
阅读更多...
雾计算：去中心化计算的未来之旅

雾计算：去中心化计算的未来之旅

雾计算是去中心化计算的基石，它将重塑我们的数字格局。通过使计算和存储更接近数据源，它改变了我们处理物联网生成数据的方式。通过雾计算探索未来，揭示了减少延迟、增强隐私和高效网络利用等好处。 随着传感器和可穿戴设备等物联网设备的数…
阅读更多...
【jQuery——详细讲解】

【jQuery——详细讲解】

jQuery讲解 jQuery介绍 jQuery介绍 jQuery是一个快速、小巧且功能丰富的JavaScript库，它使得HTML文档遍历和操作、事件处理、动画和Ajax操作变得更简单，都是通过一个简洁的API来实现的，这个API在多种浏览器上都能正常工作。它的口号是“writ…
阅读更多...
Unity UGUI实现点击事件穿透

Unity UGUI实现点击事件穿透

代码很简单如下 将此代码挂载到上层节点上即可 using System.Collections.Generic; using UnityEngine; using UnityEngine.EventSystems;public class ClickEventPenetration : MonoBehaviour, IPointerClickHandler {public void OnPointerClick(PointerEventData eventData…
阅读更多...
PCIe学习笔记（1）Hot-Plug机制

PCIe学习笔记（1）Hot-Plug机制

文章目录 Hot-Plug InitHot Add FlowSurprise Remove FlowNPEM Flow Hot-Plug Init PCIe hot-plug是一种支持在不关机情况下从支持的插槽添加或删除设备的功能，PCIe架构定义了一些寄存器以支持原生热插拔。相关寄存器主要分布在Device Capabilities, Slot Capabili…
阅读更多...
网站被攻击有什么办法呢？

网站被攻击有什么办法呢？

最近，德迅云安全遇到不少网站用户遇到攻击问题，来咨询安全解决方案。目前在所有的网络攻击方式中，DDoS是最常见，也是最高频的攻击方式之一。不少用户网站上线后，经常会遭受到攻击的困扰。有些攻击持续时间比较短影响较…
阅读更多...
MCU+SFU视频会议一体化，视频监控，指挥调度（AR远程协助）媒体中心解决方案。

MCU+SFU视频会议一体化，视频监控，指挥调度（AR远程协助）媒体中心解决方案。

视频互动应用已经是政务和协同办公必备系统，早期的分模块，分散的视频应该不能满足业务需要，需要把视频监控，会议，录存一体把视频资源整合起来，根据客户需求，需要能够多方视频互动，直…
阅读更多...
cmake安装LAMMPS增加MOLECULE等package

cmake安装LAMMPS增加MOLECULE等package

使用cmake可以较make更加快捷的安装LAMMPS,关于官网上已有Cmake安装的详细教程： https://docs.lammps.org/Build_cmake.html 可是经过使用，发现默认的安装方式里只有最基础的包，甚至没有MOLECULE包 因此为了使用cmake来增加想要安装的包&a…
阅读更多...
代码随想录算法训练营第29天|491.递增子序列 * * 46.全排列 * 47.全排列 II

代码随想录算法训练营第29天|491.递增子序列 * * 46.全排列 * 47.全排列 II

文章目录 491.递增子序列思路：代码 思路：优化代码： 46.全排列思路代码一：使用used数组代码二：使用path判断元素 47.全排列 II思路一：层节点和路径都是用used数组做记录思路二：层通过排序后是否重…
阅读更多...
学习Vue3的第一天

学习Vue3的第一天

目录 简介 什么是 Vue？ 创建Vue3工程 前提条件 基于 vue-cli 创建（不推荐） 基于 vite 创建（推荐） 通过 CDN 使用 Vue 代码示例 简介 什么是 Vue？ Vue.js 是一个流行的前端 JavaScript 框架&#…
阅读更多...
c# DataTable 帮助类

c# DataTable 帮助类

public class DataTableHelper { #region DataTable转IList /// <summary> /// DataTable转IList集合 /// </summary> /// <typeparam name"T"></typeparam> /// <param name"dataTabl…
阅读更多...
linux查看公网地址

linux查看公网地址

curl ifconfig.mewget -qO- ifconfig.me
阅读更多...
用keytool 生成JWT的RSA非对称密钥

用keytool 生成JWT的RSA非对称密钥

写在前面 JWT 令牌 可以由 X.509 证书或 256 位非对称密钥签名来充当&#xff0c;为了获得合法的JWT 令牌&#xff0c;我们可以使用JDK中的keytool.exe工具来生成。 本例的操作环境是Windows系统&#xff0c;操作的前置条件需要先安装好JDK&#xff0c;并配置好环境变量&…
阅读更多...
C#的Char 结构的像IsLetterOrDigit(Char)等常见的方法

C#的Char 结构的像IsLetterOrDigit(Char)等常见的方法

目录 一、Char 结构的方法 二、Char.IsLetterOrDigit 方法 1.Char.IsLetterOrDigit(Char)用法 2.IsLetterOrDigit(String, Int32)方法 三、Char.IsLetter 方法 1.IsLetter(Char) 2.IsLetter(String, Int32) 四、Char.IsDigit 方法 1. IsDigit(String, Int32) 2.IsDig…
阅读更多...
Vue 学习随笔系列九 -- 表格中插入图片、背景、自定义表头

Vue 学习随笔系列九 -- 表格中插入图片、背景、自定义表头

表格中插入图片和icon 文章目录 表格中插入图片和icon一、如何插入图片1、代码2、效果 二、文字添加背景1、代码2、效果 三、表头悬浮提示语四、表头添加图标 一、如何插入图片 1、代码 <template><div><el-tablesize"small"borderv-loading"l…
阅读更多...
K8S部署Harbor镜像仓库（含离线安装包harbor-offline-installer国内下载链接）

K8S部署Harbor镜像仓库（含离线安装包harbor-offline-installer国内下载链接）

天行健&#xff0c;君子以自强不息&#xff1b;地势坤&#xff0c;君子以厚德载物。 每个人都有惰性&#xff0c;但不断学习是好好生活的根本&#xff0c;共勉&#xff01; 文章均为学习整理笔记&#xff0c;分享记录为主&#xff0c;如有错误请指正&#xff0c;共同学习进步。…
阅读更多...
互联网摸鱼日报(2024-02-05)

互联网摸鱼日报(2024-02-05)

互联网摸鱼日报(2024-02-05) 博客园新闻 巨人网络大模型GiantGPT完成备案 有传闻称京东紧急制定主播招聘计划 不考核GMV和毛利等 实测百度文心一言APP生成“专属数字分身”免费功能 小米要退出印度笔记本市场&#xff1f;产品均售罄、官网导航条移除相关栏目 高德、百度地…
阅读更多...
最新文章

Copyright @ 2022~2023