デバイス（Device）

Device API は、端末のハードウェアやシステム情報にアクセスします。

オンラインで試す

getSystemInfogetNetworkTypegetLocation

短い振動長い振動scanCode

ボタンを押すと JSON やメッセージが表示されます

デバイス API のデモ

システム情報、ネットワーク、位置、振動、スキャン。振動などは右下の SDK ログにも表示されます。

Vue

<script setup>
import { ref, onMounted } from 'vue'
import woo from 'mini-sdk'

const sysInfo = ref(null)
const location = ref(null)

onMounted(async () => {
  sysInfo.value = await woo.getSystemInfo()
})

async function locate() {
  location.value = await woo.getLocation()
}
</script>

<template>
  <pre v-if="sysInfo">{{ sysInfo }}</pre>
  <button @click="locate">获取位置</button>
  <button @click="woo.vibrateShort()">短振</button>
</template>

React

import { useState, useEffect } from 'react'
import woo from 'mini-sdk'

function DeviceDemo() {
  const [sysInfo, setSysInfo] = useState(null)
  const [location, setLocation] = useState(null)

  useEffect(() => {
    woo.getSystemInfo().then(setSysInfo)
  }, [])

  return (
    <>
      {sysInfo && <pre>{JSON.stringify(sysInfo, null, 2)}</pre>}
      <button onClick={() => woo.getLocation().then(setLocation)}>获取位置</button>
      <button onClick={() => woo.vibrateShort()}>短振</button>
    </>
  )
}

インポート

import woo from 'mini-sdk'
// 或
import { device } from 'mini-sdk'

端末情報

getSystemInfo

システム情報を取得します。

const info = await woo.getSystemInfo()

戻り値 GetSystemInfoResult：

フィールド	型	説明
platform	string	OS（ios / android / simulator）
system	string	OS バージョン
brand	string	端末ブランド
model	string	端末型番
screenWidth	number	画面幅（px）
screenHeight	number	画面高さ（px）
windowWidth	number	利用可能なウィンドウ幅
windowHeight	number	利用可能なウィンドウ高さ
statusBarHeight	number	ステータスバー高さ
language	string	システム言語
version	string	ホストアプリのバージョン
SDKVersion	string	SDK バージョン

getDeviceId

端末の一意識別子を取得します。

const { deviceId } = await woo.getDeviceId()

getDeviceInfo

端末の基本情報を取得します。

const info = await woo.getDeviceInfo()

getAppInfo

現在のミニプログラムの情報を取得します。

const info = await woo.getAppInfo()
// { appId, appName, env: 'simulator' | 'production', ... }

位置

getLocation

現在の位置を取得します。

const location = await woo.getLocation()
console.log(location.latitude, location.longitude)

権限

getLocation では位置情報の利用許可を求めます。ユーザーが拒否すると BridgeErrorCode.PermissionDenied が投げられます。

振動

vibrateShort / vibrateLong

端末のバイブレーションを行います。

await woo.vibrateShort()  // 短振（15ms）
await woo.vibrateLong()   // 长振（400ms）

ネットワーク

getNetworkType

現在の接続種別を取得します。

const { networkType } = await woo.getNetworkType()
// 'wifi' | '4g' | '3g' | '2g' | 'none' | 'unknown'

スキャン

scanCode

スキャン画面を起動します。

const result = await woo.scanCode({
  scanType: ['qrCode', 'barCode'],
})
console.log(result.result) // 扫码结果
console.log(result.scanType) // 码类型

画像

chooseImage

アルバムから画像を選びます。

const result = await woo.chooseImage({
  count: 3,       // 最多选择 3 张
  sourceType: ['album', 'camera'],
})
console.log(result.tempFilePaths) // 临时文件路径数组

takePhoto

写真を撮影します。

const result = await woo.takePhoto({
  quality: 'high',
})
console.log(result.tempFilePath) // 照片临时路径

ファイルアップロード

uploadFile

ファイルをサーバーにアップロードします。

const result = await woo.uploadFile({
  url: 'https://api.example.com/upload',
  filePath: tempFilePath,
  name: 'file',
  header: { Authorization: 'Bearer xxx' },
  formData: { type: 'avatar' },
})

地図

openMap

システムの地図ナビを開きます。

await woo.openMap({
  latitude: 39.908860,
  longitude: 116.397390,
  name: '天安门',
  address: '北京市东城区',
})

通信

makePhoneCall

電話をかけます。

await woo.makePhoneCall({ phoneNumber: '10086' })

画面

setScreenOrientation / getScreenOrientation

画面の向きを設定・取得します。

await woo.setScreenOrientation({ orientation: 'landscape' })

const { orientation } = await woo.getScreenOrientation()

onScreenOrientationChange

向きの変化を監視します。

woo.onScreenOrientationChange((result) => {
  console.log('屏幕方向：', result.orientation)
})

setScreenBrightness / getScreenBrightness

明るさを設定・取得します。

await woo.setScreenBrightness({ value: 0.8 }) // 0~1

const { value } = await woo.getScreenBrightness()

keepScreenOn

画面常時点灯を行います。

await woo.keepScreenOn({ keepScreenOn: true })

アプリ間

navigateToMiniApp

別のミニプログラムへ遷移します。

await woo.navigateToMiniApp({
  appId: 'target-app-id',
  path: '/pages/index/index',
  extraData: { from: 'my-app' },
})

openWallet

ウォレットを開きます。

await woo.openWallet({ type: 'payment' })

API 早見表

メソッド	説明	シグネチャ
getSystemInfo	システム情報	() → Promise<SystemInfo>
getSystemInfoSync	同期で取得	() → SystemInfo
getNetworkType	ネット種別	() → Promise<{ networkType }>
onNetworkStatusChange	接続の変化	(callback) → void
makePhoneCall	電話をかける	({ phoneNumber }) → Promise<void>
scanCode	コードスキャン	({ scanType? }) → Promise<{ result, scanType }>
getLocation	位置を取得	({ type? }) → Promise<{ latitude, longitude, ... }>
vibrateLong / vibrateShort	長/短の振動	() → Promise<void>
getBatteryInfo	バッテリー	() → Promise<{ level, isCharging }>
getScreenBrightness	明るさ取得	() → Promise<{ value }>
setScreenBrightness	明るさ設定	({ value }) → Promise<void>
openWallet	ウォレット起動	({ type }) → Promise<void>