Skip to content

Dispositivo

Electric quantity

getBatteryInfoSync

getBatteryInfoSync()

pz.getBatteryInfo A versão síncrona de

Valor de retorno

Object res

atributotipoApresentações
levelstringPotência do equipamento, faixa 1 - 100
isChargingbooleanEstá carregando?

getBatteryInfo

getBatteryInfo(Object object)

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object object

atributotipoApresentações
levelstringPotência do equipamento, faixa 1 - 100
isChargingbooleanEstá carregando?

clipboard

setClipboardData

Compatível com a biblioteca base 1.3.9, iOS versão 2.1.23, Android versão 2.1.38, extensão de dependência SDK Desde a versão 2.35.13 do iOS, versão 2.35.9 do Android, esta API exige que o aplicativo host seja injetado na implementação e foi removida do SDK.

setClipboardData(Object object)

Define o conteúdo da área de transferência do sistema. Quando chamado com sucesso, aparece um brinde Cue &#34Conteúdo copiado &#34Continue 1.5s

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
datastringsimConteúdo da área de transferência
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.setClipboardData({
  data: 'data',
  success(res) {
    pz.getClipboardData({
      success(res) {
        console.log(res.data) // data
      }
    })
  }
})

getClipboardData

Compatível com a biblioteca base 1.3.9, iOS versão 2.1.23, Android versão 2.1.38, extensão de dependência SDK Desde a versão 2.35.13 do iOS, versão 2.35.9 do Android, esta API exige que o aplicativo host seja injetado na implementação e foi removida do SDK.

getClipboardData(Object object)

Obtenha o conteúdo da área de transferência do sistema

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object object

atributotipoApresentações
datastringConteúdo da área de transferência

Código de amostra

javascript
pz.getClipboardData({
  success(res) {
    console.log(res.data)
  }
})

network

onNetworkStatusChange

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

onNetworkStatusChange(function callback)

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

parâmetro

function callback

Função de retorno de chamada para eventos de mudança de estado da rede

parâmetro

Object res

atributotipoApresentações
isConnectedbooleanVocê está atualmente conectado a uma rede?
networkTypestringTipo de rede

res.networkType Legal value

valorApresentações
wifirede wi-fi
2gRede 2g
3grede 3g
4gRede 4g
unknownrede wi-fi
nonenone

Código de amostra

javascript
pz.onNetworkStatusChange(function (res) {
  console.log(res.isConnected)
  console.log(res.networkType)
})

offNetworkStatusChange

offNetworkStatusChange(function callback)

Cancele o monitoramento de alterações de estado da rede. Se o parâmetro for nulo, cancele todo o monitoramento de eventos

parâmetro

function callback

Função de retorno de chamada para eventos de mudança de estado da rede

getNetworkType

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

getNetworkType(Object object)

Obtenha o tipo de rede

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributotipoApresentações
networkTypestringtipo de rede

res.networkType Legal value

valorApresentações
wifirede wi-fi
2gRede 2g
3grede 3g
4gRede 4g
desconhecidorede wi-fi
nenhumSem rede

Código de amostra

javascript
pz.getNetworkType({
  success(res) {
    const networkType = res.networkType
  }
})

getRandomValues

Obtenção de números aleatórios criptograficamente seguros

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
lengthnumbersimInteiro, número de bytes para gerar números aleatórios, máximo 1048576
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributotipoApresentações
randomValuesArrayBufferConteúdo de número aleatório, comprimento é o número de bytes passados

Código de amostra

javascript
pz.getRandomValues({
  length: 6 // Generation 6 A random number of bytes in length,
  success: res => {
    console.log(pz.arrayBufferToBase64(res.randomValues)) // Convert to base64 Print after string
  }
})

screen

setVisualEffectOnCapture

Suporte à biblioteca base de 2.12.16, versão Android 2.37.1

setVisualEffectOnCapture(Object object)

Defina o desempenho da tela durante a captura/gravação de tela (somente Android)

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
visualEffectstringnenhumsimDesempenho de captura/gravação de tela, apenas nenhum/oculto é suportado, passe oculto para ocultar a tela ao fazer capturas de tela/gravação
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

setScreenBrightness

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

setScreenBrightness(Object object)

Defina o brilho da tela.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
valuenumbersimValor de brilho da tela, faixa 0 1。0 Mais escuro, 1 Mais claro
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

setKeepScreenOn

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

setKeepScreenOn(Object object)

Define se deve ou não acender sempre. Somente o phizclip atual está em vigor e as configurações são desativadas após sair do phizclip

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
keepScreenOnbooleansimMantenha a tela brilhante
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.setKeepScreenOn({
  keepScreenOn: true
})

onUserCaptureScreen

onUserCaptureScreen(function callback)

Monitore o evento de captura de tela ativa do usuário. Os usuários usam a captura de tela do sistema quando a captura de tela do acionador, só pode registrar um monitor

parâmetro

function callback

Função de retorno de chamada para evento de captura de tela ativa do usuário

Código de amostra

javascript
pz.onUserCaptureScreen(function (res) {
  console.log('User screenshot taken')
})

onScreenRecordingStateChanged

onScreenRecordingStateChanged(function callback)

Ouvindo eventos de gravação do usuário, acionados quando o usuário grava a tela (somente iOS)

parâmetro

function callback

Função de retorno de chamada para eventos de gravação de tela iniciados pelo usuário

parâmetro

Object res

atributotipoApresentações
statestringO valor é iniciar ou parar, iniciar: iniciar a gravação; parar: parar a gravação

Código de amostra

javascript
pz.onScreenRecordingStateChanged(function (res) {
  console.log(res.state)
})

offUserCaptureScreen

offUserCaptureScreen(function callback)

Evento de captura de tela ativa do usuário. Cancelar escuta de evento

parâmetro

function callback

Função de retorno de chamada para evento de captura de tela ativa do usuário

offScreenRecordingStateChanged

offScreenRecordingStateChanged(function callback)

Remover a escuta de eventos de gravação do usuário

parâmetro

function callback

Retorno de chamada para eventos de captura de tela iniciados pelo usuário

parâmetro é a função de ouvinte passada por onScreenRecordingStateChanged, se nenhum parâmetro for passado, todos os ouvintes serão removidos

getScreenRecordingState

Suporte à biblioteca base de 2.12.16, iOS versão 2.37.1, Android versão 2.37.1

getScreenRecordingState(Object object)

Verifique se o usuário está gravando

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributotipoApresentações
statestringStatus de gravação de tela, valor ativado ou desativado

getScreenBrightness

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

getScreenBrightness(Object object)

Obtenha o brilho da tela.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributotipoApresentações
valuenumberValor de brilho da tela, faixa 0 ~ 1, 0 mais escuro, 1 mais claro

keyboard

onKeyboardHeightChange

onKeyboardHeightChange(function callback)

Monitore as mudanças de altura do teclado

parâmetro

function callback

parâmetro

object res

atributotipoApresentações
heightnumberAltura do teclado

Código de amostra

javascript
pz.onKeyboardHeightChange(res => {
  console.log(res.height)
})

offKeyboardHeightChange

offKeyboardHeightChange(function callback)

Não ouvir eventos de mudança de altura do teclado

parâmetro

function callback

Função de retorno de chamada para eventos de mudança de altura do teclado

hideKeyboard

hideKeyboard(Object object)

Após a entrada, textarea, etc., o foco abre o teclado, invoque manualmente esta interface para fechar o teclado

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.hideKeyboard({
  complete: res => {
    console.log('hideKeyboard res', res)
  }
})

getSelectedTextRange

getSelectedTextRange(Object object)

Após a entrada, área de texto e assim por diante, obtenha a posição do cursor da caixa de entrada. Nota: Esta interface só é válida quando chamada com foco.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributotipoApresentações
startnumberPosição inicial do cursor da caixa de entrada
endnumberPosição final do cursor da caixa de entrada

Código de amostra

javascript
pz.getSelectedTextRange({
  complete: res => {
    console.log('getSelectedTextRange res', res.start, res.end)
  }
})

telephone

makePhoneCall

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

makePhoneCall(Object object)

Faça uma ligação

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
phoneNumberstringsimO número que você precisa discar
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.makePhoneCall({
  phoneNumber: '1340000' // Apenas exemplo, não é um número de telefone real
})

Accelerometer

stopAccelerometer

stopAccelerometer(Object object)

Pare de ouvir dados de aceleração

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.stopAccelerometer()

startAccelerometer

startAccelerometer(Object object)

Comece a monitorar os dados de aceleração

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
intervalstringnormaisnãoMonitore a frequência de execução da função de retorno de chamada de dados de aceleração
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.interval Legal value

valorApresentações
gameA frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre
uiInscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre
normalFrequência normal de retorno de chamada, na faixa de 200ms/segundo Sobre

Código de amostra

javascript
pz.startAccelerometer({
  interval: 'game'
})

onAccelerometerChange

onAccelerometerChange(function callback)

Ouça eventos de dados de aceleração. Base de frequência pz.startAccelerometer() dos parâmetros de intervalo, as chamadas de interface começam a ouvir automaticamente

parâmetro

function callback

Função de retorno de chamada de evento de dados de aceleração

parâmetro

Object res

atributotipoApresentações
xnumberEixo X
ynumberEixo Y
znumberEixo Z

Código de amostra

javascript
pz.onAccelerometerChange(callback)

offAccelerometerChange

offAccelerometerChange(function callback)

Cancele o monitoramento de eventos de dados de aceleração. Se o parâmetro for nulo, cancele todo o monitoramento de eventos

parâmetro

function callback

Função de retorno de chamada de evento de dados de aceleração

Compass

stopCompass

stopCompass(Object object)

Pare de ouvir os dados da bússola

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.stopCompass()

startCompass

startCompass(Object object)

Comece a monitorar os dados da bússola

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

javascript
pz.startCompass()

onCompassChange

onCompassChange(function callback)

Monitore as alterações nos dados da bússola. Frequência: 5 segundos/segundos, a interface começará a ouvir automaticamente após a chamada, você pode usar o pz.stopCompass Pare de ouvir

parâmetro

function callback

Função de retorno de chamada para eventos de alteração de dados da bússola

parâmetro

Object object

atributotipoApresentações
directionnumberGrau de direção enfrentado
accuracynumber/stringprecisão

Código de amostra

javascript
pz.onCompassChange(callback)

precisão na diferença iOS/Android

Devido às diferenças de plataforma, a precisão no iOS/Android tem valores diferentes.

  • iOS: precisão É um... número Representa um desvio do pólo norte magnético. 0 Indica dispositivo apontando para o norte magnético, 90 Aponta para o leste, 180. Aponta para o sul e assim por diante.

  • Android: precisão É um... string É um valor enumerado de.

valorApresentações
highalta precisão
mediumPrecisão média
lowBaixa precisão
no-contactNão confiável. Sensor perdeu conexão.
unreliableNão é credível, razão desconhecida
unknow $Um valor de enumeração de precisão desconhecido, ou seja, o valor Android que representa a precisão retornada pelo sistema neste momento não é um valor de enumeração de precisão padrão

offCompassChange

offCompassChange(function callback)

Cancele a escuta do evento de alteração de dados da bússola, o parâmetro está vazio e, em seguida, cancele toda a escuta do evento.

parâmetro

function callback

Função de retorno de chamada para eventos de alteração de dados da bússola

Equipment direction

stopDeviceMotionListening

stopDeviceMotionListening(Object object)

Pare de ouvir mudanças na direção do dispositivo

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

startDeviceMotionListening

startDeviceMotionListening(Object object)

Comece a ouvir as mudanças na orientação do dispositivo

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
intervalstringnormaisnãoMonitorar a frequência de execução da função de retorno de chamada de mudança de direção do dispositivo
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.interval Legal value

valorApresentações
gameA frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre
uiInscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre
normalFrequência normal de retorno de chamada, na faixa de 200ms/segundo Sobre

onDeviceMotionChange

onDeviceMotionChange(function callback)

Ouça eventos de mudança de direção do dispositivo. Base de frequência pz.startDeviceMotionListening() dos parâmetros de intervalo. Pode ser usado pz.stopDeviceMotionListening() Parar de ouvir

parâmetro

function callback

Função de retorno de chamada para evento de mudança de orientação do dispositivo

parâmetro

Object res

atributotipoApresentações
alphanumberquando o telefone celular coordena X/E e Terra X/E Quando sobrepostos, ao redor. Com O ângulo no qual o eixo gira é Alfa, com um valor de intervalo de [0, 2*PI). Girar no sentido anti-horário é positivo.
betanumberQuando o telefone coordena E/ComE a Terra E/Com Quando sobreposto, ao redor. X O ângulo no qual o eixo gira é beta. Os valores do intervalo são [-1PI, PI) O topo fica positivo em direção à superfície da Terra. Também é possível ser positivo com o usuário.
gammanumberQuando o telefone X/Z coincide com o X/Z da Terra, o ângulo de rotação em torno do eixo Y é gama. o intervalo de valores é [-1*PI/2, PI/2). A rotação do lado direito em direção à superfície da Terra é positiva.

offDeviceMotionChange

offDeviceMotionChange(function callback)

Cancela o evento de mudança de direção do dispositivo de escuta, o parâmetro é nulo e, em seguida, cancela todo o monitoramento de eventos

parâmetro

function callback

Função de retorno de chamada para evento de mudança de orientação do dispositivo

gyroscope

stopGyroscope

stopGyroscope(Object object)

Pare de monitorar os dados do giroscópio

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

startGyroscope

startGyroscope(Object object)

Comece a monitorar os dados do giroscópio.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
intervalstringnormaisnãoMonitore a frequência de execução da função de retorno de chamada de dados do giroscópio
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.interval Valor legal

valorApresentações
gameA frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre
uiInscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre
normalFrequência normal de retorno de chamada, na faixa de 200ms/segundo Sobre

onGyroscopeChange

onGyroscopeChange(function callback)

Monitore eventos de alteração de dados do giroscópio. Base de frequência pz.startGyroscope() dos parâmetros de intervalo. Pode ser usado pz.stopGyroscope() Pare de ouvir

parâmetro

function callback

Uma função de retorno de chamada para eventos de alteração de dados do giroscópio

parâmetro

Object res

atributotipoApresentações
xnumberx Velocidade angular do eixo
ynumbery Velocidade angular do eixo
znumberz Velocidade angular do eixo

offGyroscopeChange

offGyroscopeChange(function callback)

Não ouça eventos de alteração de dados do giroscópio.

parâmetro

function callback

Uma função de retorno de chamada para eventos de alteração de dados do giroscópio

Scan code

scanCode

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

scanCode(Object object)

Configure a interface de verificação do cliente para verificar o código

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
onlyFromCamerabooleanfalsonãoSe você só pode escanear o código da câmera, não permite selecionar fotos do álbum
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

Código de amostra

javascript
//Permitir digitalização da câmera e do álbum de fotos
pz.scanCode({
  success(res) {
    console.log(res)
  }
})

// Digitaliza o código apenas da câmera
pz.scanCode({
  onlyFromCamera: true,
  success(res) {
    console.log(res)
  }
})

Nota

  • Falha de autorização de interface (iOS). 1:
  1. o usuário se recusa a autorizar, a mensagem de erro: não autorizado, o usuário não concedeu permissão à câmera
  2. O aplicativo host desabilita o miniaplicativo de solicitar permissões ativamente, uma mensagem de erro é retornada: desabilitação não autorizada autorizada, o SDK está desabilitado para solicitar permissões de câmera.
  • Falha de autorização de interface (Android).
  1. o usuário se recusa a autorizar, uma mensagem de erro é retornada: falha não autorizada, o usuário não concedeu privilégios de câmera
  2. o aplicativo host proíbe o miniaplicativo de iniciar solicitações de permissão, a mensagem de erro é retornada: SDK não autorizado desativado autorizado é proibido de iniciar solicitações de permissão

vibration

vibrateShort

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

vibrateShort(Object object)

Faça o celular vibrar por um curto período de tempo (15 ms)。 Somente no iPhone 7/7 Mais Acima e Modelo Android entra em vigor

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Nota

  • Falha de autorização de interface (Android): 1.
  1. o usuário se recusa a autorizar, uma mensagem de erro é retornada: usuário não autorizado não recebeu permissão para vibrar
  2. o aplicativo host proíbe o miniaplicativo de iniciar solicitações de permissão, a mensagem de erro é retornada: SDK não autorizado desativado autorizado é proibido de iniciar solicitações de permissão

vibrateLong

Suporte à biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38

vibrateLong(Object object)

Faça o telefone vibrar por mais tempo (400 ms)

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha (Quando a autorização falha, uma mensagem de erro é retornada: falha ao usuário não autorizado não recebeu permissão de vibração)
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Nota

  • Falha de autorização de interface (Android): 1.
  1. o usuário se recusa a autorizar, uma mensagem de erro é retornada: usuário não autorizado não recebeu permissão para vibrar
  2. o aplicativo host proíbe o miniaplicativo de iniciar solicitações de permissão, a mensagem de erro é retornada: SDK não autorizado desativado autorizado é proibido de iniciar solicitações de permissão

Bluetooth - Universal

stopBluetoothDevicesDiscovery

Compatível com a biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, dependência da extensão SDK. A partir da versão 2.35.7, o módulo Bluetooth é independente e requer uma dependência separada do PhizClipBluetoothSDK

stopBluetoothDevicesDiscovery(Object object)

Pare de procurar periféricos Bluetooth próximos. Se você encontrou o dispositivo Bluetooth e não precisa continuar a busca, é recomendável chamar a interface para interromper a busca por Bluetooth

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

error

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

startBluetoothDevicesDiscovery

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

startBluetoothDevicesDiscovery(Object object)

Comece a procurar periféricos Bluetooth próximos.

Esta operação é mais cara para recursos do sistema, procure o equipamento necessário após a chamada oportuna pz.stopBluetoothDevicesDiscovery Pare a pesquisa

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
servicesArray.stringnãoPara procurar o serviço mestre do dispositivo Bluetooth UUID List suporta UUID de posição 16/32/128)。 Alguns dispositivos Bluetooth transmitem seu próprio serviço host de UUID。 Se este parâmetro for definido, apenas os pacotes de transmissão serão pesquisados para UUID O serviço principal do Dispositivo Bluetooth. Este parâmetro é recomendado para filtrar outros dispositivos Bluetooth que não precisam ser manipulados
allowDuplicatesKeybooleanfalsenãoSe são permitidos relatórios duplicados do mesmo dispositivo. Se relatórios duplicados forem permitidos, o método pz.onBlueToothDeviceFound reportará ao mesmo dispositivo várias vezes, mas os valores RSSI variarão.
intervalnumber0nãoIntervalo de equipamento de relatório, unidade ms。 0 Indica que o novo dispositivo é relatado assim que é encontrado e outros valores são relatados de acordo com o intervalo de entrada.
powerLevelstringmediumnãoModo de varredura, quanto maior a varredura mais rápida, maior o consumo de energia. Cliente Android Phiz apenas 7.0.12 e suporte superior.
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.powerLevel Legal value

valorApresentaçõesVersão mínima
lowbaixo
mediumem
highalto

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

openBluetoothAdapter

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

openBluetoothAdapter(Object object)

Inicialize o módulo Bluetooth. Host iOS Up-on/É chamado sempre no modo escravo (periférico) e no modo correspondente。

parâmetro


Object object

atributotipoValores padrãoObrigatórioApresentaçõesVersão mínima
modestringcentralnãoModo Bluetooth, disponível como equipamento master/From, apenas iOS Need
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.mode Legal value

valorApresentaçõesVersão mínima
centralModo anfitrião
peripheralModo escravo (periférico)

error


Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

object.fail Callback function returns state Parameters only iOS)


Código de estadoApresentações
0Desconhecido
1Redefinir
2Não suportado
3Não autorizado
4Não aberto

Tome cuidado


  • Outra API relacionada ao Bluetooth deve ser pz.openBluetoothAdapter usada após a chamada. caso contrário, a API retornará um erro (errCode = 10000).
  • Quando a chave Bluetooth do usuário não estiver ligada ou o telefone não suportar Bluetooth, ligue para pz.openBluetoothAdapter. Um erro é retornado (errCode = 10001) indicando que o recurso Bluetooth do telefone não está disponível. Neste momento, o módulo bluetooth do phizclip foi inicializado, você pode usar pz.onBluetoothAdapterStateChange Monitore a mudança de status do Bluetooth do telefone, você também pode chamar toda a API do módulo Bluetooth

Nota

  • Falha de autorização de interface (iOS):
  1. O aplicativo host desativa o miniaplicativo de solicitar permissões ativamente e retorna a mensagem de erro: desabilitação não autorizada autorizada, o SDK está desabilitado para solicitar permissões de Bluetooth

onBluetoothDeviceFound

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK onBluetoothDeviceFound(function callback) Ouça eventos que procuram novos dispositivos

parâmetro


function callback

Uma função de retorno de chamada que procura eventos em um novo dispositivo

parâmetro

object res

atributotipoApresentações
devicesArray.ObjectLista de dispositivos recentemente pesquisados

res.devices Structure

atributotipoApresentações
namestringNome do dispositivo Bluetooth, que alguns dispositivos podem não ter
deviceIdstringID do dispositivo Bluetooth
RSSInumberIntensidade atual do sinal do dispositivo Bluetooth, unidade dBm
advertisDataArrayBufferNo segmento de dados de transmissão do dispositivo Bluetooth atual Segmento de dados do fabricante
advertisServiceUUIDsArray.stringNo segmento de dados de transmissão do segmento de dados ServiceUUIDs do dispositivo Bluetooth atual
localNamestringNo segmento de dados de transmissão do segmento de dados LocalName do dispositivo Bluetooth atual
serviceDataObjectNo segmento de dados de transmissão do segmento de dados ServiceData do dispositivo Bluetooth atual

Tome cuidado


  • Se um dispositivo for chamado no retorno de chamada onBluetoothDeviceFound, ele será adicionado ao array obtido na interface getBluetoothDevices.
  • Alguns modelos Android exigem permissão de localização para pesquisar dispositivos, portanto, observe que sim não está ativado.
  • Chamadas repetidas substituirão os retornos de chamada anteriores.

onBluetoothAdapterStateChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK onBluetoothAdapterStateChange(function callback)

Monitorar evento de mudança de estado do adaptador Bluetooth

parâmetro

function callback

Função de retorno de chamada para evento de mudança de estado do adaptador Bluetooth

parâmetro

Object res

atributotipoApresentações
availablebooleanO adaptador Bluetooth está disponível?
discoveringbooleanO adaptador Bluetooth está em estado de pesquisa?

Tome cuidado Chamadas repetidas substituirão retornos de chamada anteriores

offBluetoothDeviceFound

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

Cancelar a escuta de eventos que encontram novos dispositivos

offBluetoothAdapterStateChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

Função de retorno de chamada para encontrar eventos para novos dispositivos

makeBluetoothPair

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

makeBluetoothPair(Object object)

Interface de emparelhamento Bluetooth, suporte apenas para Android.

Normalmente, você precisa especificar o PIN. O sistema assume o processo de emparelhamento e chama o pz.createBLEConnection Você pode. Esta interface deve ser usada apenas quando o desenvolvedor não deseja que o usuário insira manualmente o código PIN e a confirmação de verificação da máquina real pode ser usada em condições normais de trabalho

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
pinstringsimjardas de pinos, Base 64. Formato.
timeoutnumber20000nãoTempo limite, unidades ms
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

getConnectedBluetoothDevices

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

getConnectedBluetoothDevices(Object object)

De acordo com o Master Service UUID Obtém o dispositivo Bluetooth conectado

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
servicesArray.stringsimLista UUID de serviço mestre de dispositivo Bluetooth suporta UUID de posição 16/32/128)
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
devicesArray.ObjectLista de dispositivos encontrados

res.devices Structure

atributotipoApresentações
namestringNome do dispositivo Bluetooth, que alguns dispositivos podem não ter
deviceIdstringUsado para distinguir a identificação do equipamento

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

getBluetoothDevices

getBluetoothDevices(Object object)

Obtém todos os dispositivos Bluetooth pesquisados enquanto o módulo Bluetooth está ativo. Inclui dispositivos que já estão conectados à máquina

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
devicesArray.ObjectUUID Lista de dispositivos conectados

res.devices Structure

atributotipoApresentações
namestringNome do dispositivo Bluetooth, que alguns dispositivos podem não ter
deviceIdstringID do dispositivo Bluetooth
RSSInumberIntensidade atual do sinal do dispositivo Bluetooth, unidade dBm
advertisDataArrayBufferNo segmento de dados de transmissão do dispositivo Bluetooth atual Segmento de dados do fabricante
advertisServiceUUIDsArray.stringNo segmento de dados de transmissão do segmento de dados ServiceUUIDs do dispositivo Bluetooth atual
localNamestringNo segmento de dados de transmissão do segmento de dados LocalName do dispositivo Bluetooth atual
serviceDataObjectNo segmento de dados de transmissão do segmento de dados ServiceData do dispositivo Bluetooth atual

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

getBluetoothAdapterState

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

getBluetoothAdapterState(Object object)

Obtém o status do adaptador Bluetooth nativo

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
discoveringbooleanVocê está procurando dispositivos?
availablebooleanO adaptador Bluetooth está disponível?

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

closeBluetoothAdapter

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

closeBluetoothAdapter(Object object)

Desligue o módulo Bluetooth. Chamar esse método desconecta todas as conexões estabelecidas e libera recursos do sistema. Recomenda-se que após usar o processo Bluetooth, o pz.openBluetoothAdapter ligue em pares

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

Bluetooth-Low-Power Central Device

writeBLECharacteristicValue

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

writeBLECharacteristicValue(Object object)

Grava dados binários em um valor característico de dispositivo Bluetooth de baixa potência. Nota: Os recursos do dispositivo devem suportar gravação antes que ele possa ser invocado com sucesso

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
serviceIdstringsimUUID de serviço correspondente do recurso Bluetooth
characteristicIdstringsimCaracterística Bluetooth UUID
valueArrayBuffersimValores binários para recursos de dispositivos Bluetooth
writeTypestringsimConfiguração do modo de gravação do valor do recurso Bluetooth, existem dois modos, gravação prioritária do iOS, gravação prioritária do AndroidNoResponse
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completofunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

writeType

Valor jurídicotipo
writeEscrita de resposta forçada, relatório de erros não suportado
writeNoResponseEscrita forçada sem resposta, sem suporte para relatório de erros

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

setBLEMTU

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

setBLEMTU(Object object)

Negociando a unidade de transmissão máxima de baixa potência do Bluetooth (Unidade de transmissão máxima, MAN)Necessário. pz.createBLEConnection Chamado após uma invocação bem-sucedida. Apenas Android 5.1 A versão acima é válida, iOS Não suportado devido a limitações do sistema

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
mtunumbersimUnidade máxima de transmissão. Defina o escopo como (22.512) Intervalo, bytes unitários
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
mtunumberValor MAN final negociado, consistente com o parâmetro passado. Cliente Android 8.0.9 Comece a oferecer suporte

object.fail callback

parâmetro

Object res

atributotipoApresentações
mtunumberValor final negociado da MAN. Este parâmetro não estará disponível se a negociação falhar. Cliente Android 8.0.9 Comece a oferecer suporte

readBLECharacteristicValue

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

readBLECharacteristicValue(Object object)

Lê os dados binários do valor característico de um dispositivo Bluetooth de baixa potência. Nota: Os recursos do dispositivo devem suportar leitura antes que ele possa ser invocado com êxito

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
serviceIdstringsimUUID de serviço correspondente do recurso Bluetooth
characteristicIdstringsimCaracterística Bluetooth UUID
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

Tome cuidado

  • Múltiplas chamadas paralelas têm a possibilidade de falha de leitura.
  • As informações lidas pela interface precisam ser armazenadas no método pz.onBLECharacteristicValueChange para obter o retorno de chamada registrado no

onBLEConnectionStateChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

onBLEConnectionStateChange(function callback)

Escuta eventos de mudança de estado de conexão de baixo consumo de energia Bluetooth. Incluindo conexão ou desconexão ativa de desenvolvedores, perda de dispositivo, desconexão anormal de conexão, etc.

parâmetro

function callback

Função de retorno de chamada para evento de mudança de estado de conexão de baixa energia Bluetooth

parâmetro

Resposta do objeto

atributotipoApresentações
deviceIdstringID do dispositivo Bluetooth
connectedbooleanVocê está conectado?

Tome cuidado

Chamadas repetidas substituirão o retorno de chamada original

onBLECharacteristicValueChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

onBLECharacteristicValueChange(function callback)

Monitore eventos de alteração de autovalor para dispositivos Bluetooth de baixo consumo de energia. Deve ser invocado primeiro a interface pz.notifyBLECharacteristicValueChange para receber a notificação push do dispositivo

parâmetro

function callback

Funções de retorno de chamada para eventos de alteração de valor próprio de dispositivos Bluetooth de baixo consumo de energia

parâmetro

Object res

atributotipoApresentações
deviceIdstringID do dispositivo Bluetooth
serviceIdstringUUID de serviço correspondente do recurso Bluetooth
characteristicIdstringCaracterística Bluetooth UUID
valueArrayBufferValor mais recente da característica

Tome cuidado

Chamadas repetidas substituirão o retorno de chamada original

offBLEConnectionStateChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

Cancelar a escuta de eventos de mudança de estado de conexão de baixo consumo de energia Bluetooth

offBLECharacteristicValueChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

Cancela a escuta de eventos de alteração de autovalor em dispositivos Bluetooth de baixo consumo de energia.

notifyBLECharacteristicValueChange

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

notifyBLECharacteristicValueChange(Object object)

Ativa um dispositivo Bluetooth de baixo consumo de energia quando seu valor próprio muda, notifica Recursos, recursos de assinatura. Nota: Os recursos do dispositivo devem suportar notificação ou indicação antes que ele possa ser invocado com êxito.

Além disso, você deve primeiro habilitar pz.notifyBLECharacteristicValueChange para ouvir o dispositivo. evento característicoValueChange

parâmetro

Object res

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
serviceIdstringsimUUID de serviço correspondente do recurso Bluetooth
characteristicIdstringsimCaracterística Bluetooth UUID
statebooleansimHabilitar notificação
typestringindicationnãoDefine o tipo de assinatura característico com um valor válido de notificação e indicação
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (o sucesso ou falha da chamada será executado)

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

Tome cuidado

  • Requer que o dispositivo atualize ativamente os recursos após uma operação de assinatura bem-sucedida. O valor acionará o retorno de chamada pz.onBLECharacteristicValueChange.
  • Na plataforma Android, chame imediatamente após esta interface ser invocada com sucesso pz.writeBLECharacteristicValue Interface, o que ocorre em alguns modelos 10008 Erro de sistema

getBLEDeviceServices

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

getBLEDeviceServices(Object object)

Obtenha todos os serviços de dispositivos Bluetooth de baixo consumo de energia (serviço)

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth。 A necessidade passou pz.createBLEConnection Estabelecer uma conexão
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

retorno de chamada object.success

parâmetro

Object res

atributotipoApresentações
servicesArray.ObjectLista de serviços de dispositivos
AtributotipoApresentações
uuidstringUUID de serviço de dispositivo Bluetooth
isPrimarybooleanSe este serviço é um serviço mestre

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

getBLEDeviceRSSI

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

getBLEDeviceRSSI(Object object)

Obtenha a intensidade do sinal de um dispositivo Bluetooth de baixa potência (Indicação de intensidade do sinal recebido, RSSI)

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
RSSINumberIntensidade do sinal, unidade dBm

getBLEDeviceCharacteristics

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

getBLEDeviceCharacteristics(Object object)

Obtenha todos os recursos de um serviço em um dispositivo Bluetooth de baixo consumo de energia (característica)

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth。 A necessidade passou pz.createBLEConnection Estabelecer uma conexão
serviceIdstringsimServiço Bluetooth UUID。 Precisa chamar primeiro pz.getBLEDeviceServices Obter
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
characteristicsArray.ObjectLista de recursos do equipamento

características

Atributo de estruturatipoApresentações
uuidstringRecurso de dispositivo Bluetooth UUID
propertiesObjectTipo de operação suportada por este recurso

propriedades

Atributo de estruturatipoApresentações
readbooleanEste recurso suporta operação de leitura
writebooleanEste recurso oferece suporte à operação de gravação
notifybooleanEste recurso oferece suporte à operação de notificação
indicatebooleanEste recurso suporta indicação de operação
writeNoResponsebooleanO recurso oferece suporte a operações de gravação sem resposta
writeDefaultbooleanO recurso oferece suporte a operações de gravação sem resposta

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

createBLEConnection

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

createBLEConnection(Object object)

Conecte-se a um dispositivo Bluetooth de baixo consumo de energia.

Se o phizclip na pesquisa anterior foi um dispositivo Bluetooth e estabeleceu uma conexão com sucesso, pode ser passado diretamente antes da pesquisa acessar deviceId Tente conectar o dispositivo diretamente sem a necessidade de pesquisar novamente

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
timeoutnumbernãoTempo limite, unidades Ms, sem preenchimento significa que não há tempo limite
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

Tome cuidado

  • Certifique-se de chamar tantos pares quanto possível pz.createBLEConnection e pz.closeBLEConnection Interface. Android, se repetido pz.createBLEConnection Cria conexões que podem fazer com que o sistema mantenha múltiplas instâncias de conexões no mesmo dispositivo, causando uma chamada para closeBLEConnection Quando o dispositivo realmente não se desconecta da conexão.
  • A conexão Bluetooth pode ser desconectada a qualquer momento. Monitor aconselhado. Evento de retorno de chamada pz.onBLEConnectionStateChange para executar a reconexão sob demanda quando o dispositivo Bluetooth for desconectado
  • Para invocar uma interface para uma operação de leitura ou gravação de dados em um dispositivo desconectado ou desconectado, o Erro 10006, a reconexão é recomendada

fecharBLEConexão

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

closeBLEConnection(Object object)

Desconecte-se do dispositivo Bluetooth de baixa potência

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
deviceIdstringsimID do dispositivo Bluetooth
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
-1already connetConectado
10000not initAdaptador Bluetooth não inicializado
10001not availableO adaptador Bluetooth atual não está disponível
10002no deviceDispositivo especificado não encontrado
10003connection failFalha na conexão
10004no serviceServiço especificado não encontrado
10005no characteristicNão foi encontrada a assinatura especificada.
10006no connectionConexão atual desconectada
10007property not supportO recurso atual não suporta esta operação
10008system errorTodos os outros sistemas comunicaram anomalias
10009system not supportEspecífico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS
10012operate time outTempo limite de conexão
10013invalid_dataConnect deviceId está vazio ou formatado incorretamente

Bluetooth - periférico de baixo consumo de energia

onBLEPeripheralConnectionStateChanged

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

onBLEPeripheralConnectionStateChanged(function callback)

Ouça o evento atual de conexão ou desconexão do dispositivo periférico

parâmetro

Object object

Função de retorno de chamada para o evento periférico conectado ou desconectado atual

parâmetro

Object res

atributotipoApresentações
deviceIdStringDispositivo com estado alterado de ID de conexão
serverIdStringservidor de UUID
connectedBooleanStatus atual da conexão

offBLEPeripheralConnectionStateChanged

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

Não escuta eventos atuais de conexão ou desconexão de periféricos

createBLEPeripheralServer

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

createBLEPeripheralServer(Object object)

Configure localmente como um servidor periférico Bluetooth de baixo consumo de energia, pode criar vários

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
serverBLEPeripheralServerO lado do servidor de um dispositivo periférico

BLEPeripheralServer.addService

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.addService(Object object)

Servidor Periférico

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
serviceObjectsimServiço de descrição de objeto
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.service Structure

atributotipoValores padrãoObrigatórioApresentações
uuidStringsimUUID do serviço Bluetooth
characteristicsArray.ObjectsimLista de características

características Estrutura

atributotipoValores padrãoObrigatórioApresentações
uuidStringsimcaracterística do UUID
propertiesObjectnãoOperação com suporte de recurso
permissionObjectnãoPermissão de recurso
valueArrayBuffernãoValor binário correspondente ao recurso
descriptorsArray.ObjectnãoDados do descritor

Estrutura de propriedades

atributotipoValores padrãoObrigatórioApresentações
writeBooleanfalsenãoescrever
writeNoResponseBooleanfalsenãoSem resposta Escrever
readBooleanfalsenãoleia
notifyBooleanfalsenãoAssine
indicateBooleanfalsenãoPacote

Estrutura de permissão

atributotipoValores padrãoObrigatórioApresentações
readableBooleanfalsenãoLegível
writeableBooleanfalsenãoGravável
readEncryptionRequiredBooleanfalsenãoSolicitação de leitura criptografada
writeEncryptionRequiredBooleanfalsenãoSolicitação de gravação criptografada

Estrutura dos descritores

atributotipoValores padrãoObrigatórioApresentações
uuidStringsimDescritor de UUID
permissionObjectnãoPermissões do descritor
valueArrayBuffernãoDados do descritor

Estrutura de permissão

atributotipoValores padrãoObrigatórioApresentações
writeBooleanfalsenãoescrever
readBooleanfalsenãoleia

BLEPeripheralServer.close

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.close(Object object)

Feche o servidor atual

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

BLEPeripheralServer.offCharacteristicReadRequest

BLEPeripheralServer.offCharacteristicReadRequest()

Cancela a escuta de solicitações de dispositivos conectados para ler eventos de autovalor de dispositivos periféricos atuais

BLEPeripheralServer.offCharacteristicSubscribed

BLEPeripheralServer.offCharacteristicSubscribed()

Cancelar inscrição do recurso de escuta

BLEPeripheralServer.offCharacteristicUnsubscribed

BLEPeripheralServer.offCharacteristicUnsubscribed()

Evento de assinatura incomum sem escuta

BLEPeripheralServer.offCharacteristicWriteRequest

BLEPeripheralServer.offCharacteristicWriteRequest()

Pare de ouvir solicitações de dispositivos conectados para gravar eventos de recursos periféricos atuais

BLEPeripheralServer.onCharacteristicReadRequest

BLEPeripheralServer.onCharacteristicReadRequest(function callback)

parâmetro

function callback

Uma função de retorno de chamada para o evento de autovalor do periférico atual é solicitada pelo dispositivo conectado

parâmetro

Object res

atributotipoApresentações
serviceIdStringUUID de serviço correspondente do recurso Bluetooth
characteristicIdStringCaracterística Bluetooth UUID
callbackIdNumberIdentificador exclusivo, chamando writeCharacteristicValue Use quando

Tome cuidado Chamadas repetidas substituirão o retorno de chamada original

BLEPeripheralServer.onCharacteristicSubscribed

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.onCharacteristicSubscribed(function callback)

Ouça eventos de assinatura de recursos, apenas suporte iOS

parâmetro

function callback

Função de retorno de chamada para eventos de assinatura característicos

parâmetro

Object res

atributotipoApresentações
serviceIdStringUUID de serviço correspondente do recurso Bluetooth
characteristicIdStringCaracterística Bluetooth UUID

Tome cuidado Chamadas repetidas substituirão o retorno de chamada original

BLEPeripheralServer.onCharacteristicUnsubscribed

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.onCharacteristicUnsubscribed(function callback)

Ouça eventos de assinatura incomuns, apenas suporte para iOS

parâmetro

function callback

Função de retorno de chamada para cancelar assinatura de eventos característicos

parâmetro

Object res

atributotipoApresentações
serviceIdStringUUID de serviço correspondente do recurso Bluetooth
characteristicIdStringCaracterística Bluetooth UUID

Tome cuidado Chamadas repetidas substituirão o retorno de chamada original

BLEPeripheralServer.onCharacteristicWriteRequest

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.onCharacteristicWriteRequest(function callback)

Ouça solicitações de dispositivos conectados para gravar o evento de autovalor do periférico atual. Você precisa chamar writeCharacteristicValue Write de volta os dados ou o host não receberá a resposta

parâmetro

function callback

Uma função de retorno de chamada para o evento de autovalor do periférico atual é solicitada pelo dispositivo conectado

parâmetro

Object res

atributotipoApresentações
serviceIdStringUUID de serviço correspondente do recurso Bluetooth
characteristicIdStringCaracterística Bluetooth UUID

Tome cuidado Chamadas repetidas substituirão o retorno de chamada original

BLEPeripheralServer.removeService

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.removeService(Object object)

Remover serviço

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
serviceIdStringsimserviço de UUID
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

BLEPeripheralServer.startAdvertising

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.startAdvertising(Object Object)

Começa a transmitir um periférico criado localmente.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
advertiseRequestObjectsimParâmetros personalizados de transmissão
powerLevelStringmediumnãoPoder de transmissão
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

Estrutura Object.advertiseRequest

atributotipoValores padrãoObrigatórioApresentações
connectableBooleantruenãoSe o dispositivo atual pode ser conectado
deviceNameStringnãoNo rádio. campo deviceName, padrão vazio
serviceUuidsArray.StringnãoServiço a ser transmitido Lista UUID. use UUID de posição 16/32 Consulte os pontos de atenção
manufacturerDataArray.ObjectnãoInformações do fabricante para a transmissão. Suporte apenas para Android, iOS Não é possível personalizar devido a limitações do sistema.

manufacturerData Structure

atributotipoValores padrãoObrigatórioApresentações
manufacturerIdStringsimID do fabricante, 0x Início hexadecimal
manufacturerSpecificDataArrayBuffernãoInformações do fabricante

Object.powerLevel Legal value

valorApresentaçõesVersão mínima
lowBaixo consumo de energia
mediumPotência moderada
highAlta potência

Tome cuidado

  • Android 8.0.9 Start, suporte para uso direto UUID de 16/32/128 posições
  • Android 8.0.9 As versões a seguir suportam apenas UUID de 128 posições, usando UUID de 16/32 bits. O sistema identificará automaticamente se pertence ao intervalo de pré-alocação, você pode consultar o Guia do Bluetooth
  • iOS Deve ser usado diretamente O UUUID de 16 bits não pode ser preenchido para 128 bits, ou o sistema ainda agrupará os pacotes de acordo com a transmissão de 128 bits. iOS Suporte temporário UUID de 32 posições。
  • iOS Apenas uma transmissão pode ser iniciada ao mesmo tempo. O Android oferece suporte a várias transmissões simultaneamente.

BLEPeripheralServer.stopAdvertising

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.stopAdvertising(Object object)

Pare de transmitir

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

BLEPeripheralServer.writeCharacteristicValue

Suporte à biblioteca base 2.11.2, iOS versão 2.34.1, Android versão 2.34.1, extensão de dependência SDK

BLEPeripheralServer.writeCharacteristicValue(Object Object)

Grava um valor de dados binários no recurso especificado, notificando o host conectado de que o valor característico do escravo foi alterado, e a interface trata se deve retornar ao pacote ou assinar

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
serviceIdStringsimUUID de serviço correspondente do recurso Bluetooth
characteristicIdStringsimCaracterística Bluetooth UUID
valueArrayBuffersimcaracterística Valor binário correspondente
needNotifyBooleansimVocê precisa notificar o valor do host Atualizado
callbackIdNumbernãoOpcionalmente, use o
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

Bluetooth-Beacons(Beacon)

stopBeaconDiscovery

O suporte da Biblioteca Base 2.11.2 foi iniciado, iOS versão 2.34.1, depende do Extensions SDK, Android versão 2.35.9, depende do BluetoothSDK> O suporte da Base Library 2.11.2 foi iniciado, iOS versão 2.34.1, depende do Extensions SDK, Android versão 2.35.9, depende de BluetoothSDK> Base Library 2.11.2

stopBeaconDiscovery(Object object)

Pare de procurar na área. Equipamento de farol

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
11000unsupportSistema ou dispositivo não suporta
11001bluetooth service unavailableServiço Bluetooth não disponível
11002location service unavailableServiço de localização indisponível
11003already startA busca começou.
11004not startBeaconDiscoveryA pesquisa ainda não começou.
11005system errorErro de sistema
11006invalid dataParâmetros incorretos

startBeaconDiscovery

O suporte da Biblioteca Base 2.11.2 foi iniciado, iOS versão 2.34.1, depende do Extensions SDK, Android versão 2.35.9, depende do BluetoothSDK> O suporte da Base Library 2.11.2 foi iniciado, iOS versão 2.34.1, depende do Extensions SDK, Android versão 2.35.9, depende de BluetoothSDK> Base Library 2.11.2

startBeaconDiscovery(Object object)

Comece a pesquisar nas proximidades. Equipamento de farol

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
uuidsArray.<string>simLista UUID de transmissão de dispositivo Beacon
ignoreBluetoothAvailablebooleanfalsenãoVerifique a chave do Bluetooth, apenas no iOS Under em vigor. iOS 11 Desligue o bluetooth no painel de controle ou você ainda poderá usá-lo. Serviço de farol.
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

erro

Código de erroMensagem de erroApresentações
0oknormais
11000unsupportSistema ou dispositivo não suporta
11001bluetooth service unavailableServiço Bluetooth não disponível
11002location service unavailableServiço de localização indisponível
11003already startA busca começou.
11004not startBeaconDiscoveryA pesquisa ainda não começou.
11005system errorErro de sistema
11006invalid dataParâmetros incorretos

Nota

  • Falha de autorização de interface (iOS):
  1. O aplicativo host desativa o miniaplicativo de solicitar permissões ativamente e retorna a mensagem de erro: desabilitação não autorizada autorizada, o SDK está desabilitado para solicitar permissões de Bluetooth

onBeaconUpdate

Biblioteca base suportada desde 2.11.2, iOS versão 2.34.1, depende da extensão SDK, interfaces relacionadas ao Beacon ainda não suportadas para Android

onBeaconUpdate(function callback)

para monitorar o evento de atualização do Beacon Device, apenas um ouvinte pode ser registrado

parâmetro

function callback

Função Beacon Callback para evento de atualização de dispositivo

parâmetro

Object res

atributotipoApresentações
faróisArray.BeaconInfoLista de todos os equipamentos Beacon pesquisados atualmente

onBeaconServiceChange

Biblioteca base suportada desde 2.11.2, iOS versão 2.34.1, depende da extensão SDK, interfaces relacionadas ao Beacon ainda não suportadas para Android

onBeaconServiceChange(function callback)

para monitorar eventos de mudança de estado do Beacon Service, apenas um ouvinte pode ser registrado

parâmetro

function callback

Funções de retorno de chamada de beacon para eventos de mudança de estado de serviço

parâmetro

Object res

atributotipoApresentações
availablebooleanO serviço está disponível atualmente
discoveringbooleanO status atual da pesquisa é

offBeaconUpdate

Biblioteca base suportada desde 2.11.2, iOS versão 2.34.1, depende da extensão SDK, interfaces relacionadas ao Beacon ainda não suportadas para Android

Cancele a escuta telefônica. Evento de atualização de dispositivo Beacon

getBeacons

Biblioteca base suportada desde 2.11.2, iOS versão 2.34.1, depende da extensão SDK, interfaces relacionadas ao Beacon ainda não suportadas para Android

getBeacons(Object object)

Obtém todos os equipamentos Beacon pesquisados

parâmetro

Object object

Retorno de chamada para eventos de mudança de estado do serviço Beacon

parâmetro

Object res

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
beaconsArray.BeaconInfoLista de faróis

erro

Código de erroMensagem de erroApresentações
0oknormais
11000unsupportSistema ou dispositivo não suporta
11001bluetooth service unavailableServiço Bluetooth não disponível
11002location service unavailableServiço de localização indisponível
11003already startA busca começou.
11004not startBeaconDiscoveryA pesquisa ainda não começou.
11005system errorErro de sistema
11006invalid dataParâmetros incorretos

BeaconInfo

Equipamento de farol

atributo

string uuid

UUID de transmissão do dispositivo Beacon

number major

Beacon Master do ID do equipamento

number minor

ID de tempos do dispositivo Beacon

number proximity

Valor de enumeração que representa a distância do dispositivo (somente iOS)

proximity Legal value

valorApresentaçõesVersão mínima
0Sinal muito fraco para calcular distância ou não equipamento iOS
1Muito perto
2Relativamente recente
3longe

number accuracy

Beacon Distância do equipamento, unidade m。iOS Ligado, limite para 0 Quando, precisão para -1

number rssi

Intensidade do sinal de um dispositivo, unidade dBm

offBeaconServiceChange

Biblioteca base suportada desde 2.11.2, iOS versão 2.34.1, depende da extensão SDK, interfaces relacionadas ao Beacon ainda não suportadas para Android

Cancelar a escuta de eventos de alteração de status do serviço Beacon

Contact person

addPhoneContact

Adicione contatos do celular.

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
firstNamestringsimnome
photoFilePathstringnãoCaminho do arquivo local do avatar
nickNamestringnãoapelido
lastNamestringnãoSobrenome
middleNamestringnãonome do meio
remarkstringnãoObservações
mobilePhoneNumberstringnãoNúmero de telefone.
weChatNumberstringnãoConta Phiz
addressCountrystringnãoEndereço de contato país
addressStatestringnãoContato Endereço Província
addressCitystringnãoEndereço de contato Cidade
addressStreetstringnãoEndereço de contato Rua
addressPostalCodestringnãoEndereço de contacto código postal
organizationstringnãoempresa
titlestringnãoposição
workFaxNumberstringnãoFax de trabalho
workPhoneNumberstringnãoTelefone comercial
hostNumberstringnãoTelefone da empresa
emailstringnãoe-mail
urlstringnãosite
workAddressCountrystringnãoEndereço do país de trabalho
workAddressStatestringnãoEndereço de trabalho Província
workAddressCitystringnãoEndereço de trabalho Cidade
workAddressStreetstringnãoEndereço de trabalho Rua
workAddressPostalCodestringnãoEndereço do código postal do trabalho
homeFaxNumberstringnãoFac-símile residencial
homePhoneNumberstringnãoTelefone residencial
homeAddressCountrystringnãoEndereço residencial país
homeAddressStatestringnãoEndereço residencial províncias
homeAddressCitystringnãoEndereço residencial cidade
homeAddressStreetstringnãoEndereço residencial rua
homeAddressPostalCodestringnãoCódigo postal do endereço residencial
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoFunção de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

escolhaContato

Abra os contatos do seu telefone e selecione os contatos

parâmetro

Object res

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
phoneNumberstringNúmero de telefone.
displayNamestringNome do contato
phoneNumberListstringTodos os números de celular do contato selecionado Android O sistema só pode selecionar o contato, mas não o número de telefone específico)

Accessibility

checkIsOpenAccessibility

Suporte da Foundation Library a partir de 2.12.1

checkIsOpenAccessibility(Object object)

Detectar se a função de acessibilidade visual está ativada

parâmetro

Object object

atributotipoValores padrãoObrigatórioApresentações
successfunctionnãoInterface chama a função de retorno de chamada bem-sucedida
failfunctionnãoInterface chama funções de retorno de chamada com falha
completefunctionnãoA interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha)

object.success callback

parâmetro

Object res

atributotipoApresentações
openBooleaniOS Ative a função auxiliar de narração no talkback do Android Retornar quando verdadeiro