Dispositivo
Electric quantity
getBatteryInfoSync
getBatteryInfoSync()
pz.getBatteryInfo A versão síncrona de
Valor de retorno
Object res
| atributo | tipo | Apresentações |
|---|---|---|
| level | string | Potência do equipamento, faixa 1 - 100 |
| isCharging | boolean | Está carregando? |
getBatteryInfo
getBatteryInfo(Object object)
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| level | string | Potência do equipamento, faixa 1 - 100 |
| isCharging | boolean | Está 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 "Conteúdo copiado "Continue 1.5s
parâmetro
Object object
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| data | string | sim | Conteúdo da área de transferência | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| data | string | Conteúdo da área de transferência |
Código de amostra
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
| atributo | tipo | Apresentações |
|---|---|---|
| isConnected | boolean | Você está atualmente conectado a uma rede? |
| networkType | string | Tipo de rede |
res.networkType Legal value
| valor | Apresentações |
|---|---|
| wifi | rede wi-fi |
| 2g | Rede 2g |
| 3g | rede 3g |
| 4g | Rede 4g |
| unknown | rede wi-fi |
| none | none |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| networkType | string | tipo de rede |
res.networkType Legal value
| valor | Apresentações |
|---|---|
| wifi | rede wi-fi |
| 2g | Rede 2g |
| 3g | rede 3g |
| 4g | Rede 4g |
| desconhecido | rede wi-fi |
| nenhum | Sem rede |
Código de amostra
pz.getNetworkType({
success(res) {
const networkType = res.networkType
}
})getRandomValues
Obtenção de números aleatórios criptograficamente seguros
parâmetro
Object object
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| length | number | sim | Inteiro, número de bytes para gerar números aleatórios, máximo 1048576 | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| randomValues | ArrayBuffer | Conteúdo de número aleatório, comprimento é o número de bytes passados |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| visualEffect | string | nenhum | sim | Desempenho de captura/gravação de tela, apenas nenhum/oculto é suportado, passe oculto para ocultar a tela ao fazer capturas de tela/gravação |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| value | number | sim | Valor de brilho da tela, faixa 0 1。0 Mais escuro, 1 Mais claro | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| keepScreenOn | boolean | sim | Mantenha a tela brilhante | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
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
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
| atributo | tipo | Apresentações |
|---|---|---|
| state | string | O valor é iniciar ou parar, iniciar: iniciar a gravação; parar: parar a gravação |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| state | string | Status 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| value | number | Valor 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
| atributo | tipo | Apresentações |
|---|---|---|
| height | number | Altura do teclado |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Apresentações |
|---|---|---|
| start | number | Posição inicial do cursor da caixa de entrada |
| end | number | Posição final do cursor da caixa de entrada |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| phoneNumber | string | sim | O número que você precisa discar | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
pz.stopAccelerometer()startAccelerometer
startAccelerometer(Object object)
Comece a monitorar os dados de aceleração
parâmetro
Object object
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| interval | string | normais | não | Monitore a frequência de execução da função de retorno de chamada de dados de aceleração |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
object.interval Legal value
| valor | Apresentações |
|---|---|
| game | A frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre |
| ui | Inscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre |
| normal | Frequência normal de retorno de chamada, na faixa de 200ms/segundo Sobre |
Código de amostra
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
| atributo | tipo | Apresentações |
|---|---|---|
| x | number | Eixo X |
| y | number | Eixo Y |
| z | number | Eixo Z |
Código de amostra
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
pz.stopCompass()startCompass
startCompass(Object object)
Comece a monitorar os dados da bússola
parâmetro
Object object
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
Código de amostra
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
| atributo | tipo | Apresentações |
|---|---|---|
| direction | number | Grau de direção enfrentado |
| accuracy | number/string | precisão |
Código de amostra
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.
| valor | Apresentações |
|---|---|
| high | alta precisão |
| medium | Precisão média |
| low | Baixa precisão |
| no-contact | Não confiável. Sensor perdeu conexão. |
| unreliable | Nã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| interval | string | normais | não | Monitorar a frequência de execução da função de retorno de chamada de mudança de direção do dispositivo |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
object.interval Legal value
| valor | Apresentações |
|---|---|
| game | A frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre |
| ui | Inscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre |
| normal | Frequê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
| atributo | tipo | Apresentações |
|---|---|---|
| alpha | number | quando 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. |
| beta | number | Quando 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. |
| gamma | number | Quando 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| interval | string | normais | não | Monitore a frequência de execução da função de retorno de chamada de dados do giroscópio |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas) |
object.interval Valor legal
| valor | Apresentações |
|---|---|
| game | A frequência de retorno de chamada para atualização do jogo, em 20ms/segundo. Sobre |
| ui | Inscreva-se para atualizar a frequência de retorno de chamada da UI de 60 ms/segundo Sobre |
| normal | Frequê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
| atributo | tipo | Apresentações |
|---|---|---|
| x | number | x Velocidade angular do eixo |
| y | number | y Velocidade angular do eixo |
| z | number | z 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| onlyFromCamera | boolean | falso | não | Se você só pode escanear o código da câmera, não permite selecionar fotos do álbum |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| complete | function | não | Funçã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
//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:
- o usuário se recusa a autorizar, a mensagem de erro: não autorizado, o usuário não concedeu permissão à câmera
- 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).
- 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
- 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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.
- o usuário se recusa a autorizar, uma mensagem de erro é retornada: usuário não autorizado não recebeu permissão para vibrar
- 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface 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) | |
| complete | function | não | Funçã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.
- o usuário se recusa a autorizar, uma mensagem de erro é retornada: usuário não autorizado não recebeu permissão para vibrar
- 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
error
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| services | Array.string | não | Para 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 | |
| allowDuplicatesKey | boolean | false | não | Se 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. |
| interval | number | 0 | não | Intervalo 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. |
| powerLevel | string | medium | não | Modo de varredura, quanto maior a varredura mais rápida, maior o consumo de energia. Cliente Android Phiz apenas 7.0.12 e suporte superior. |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
object.powerLevel Legal value
| valor | Apresentações | Versão mínima |
|---|---|---|
| low | baixo | |
| medium | em | |
| high | alto |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações | Versão mínima |
|---|---|---|---|---|---|
| mode | string | central | não | Modo Bluetooth, disponível como equipamento master/From, apenas iOS Need | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | ||
| fail | function | não | Interface chama funções de retorno de chamada com falha | ||
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
object.mode Legal value
| valor | Apresentações | Versão mínima |
|---|---|---|
| central | Modo anfitrião | |
| peripheral | Modo escravo (periférico) |
error
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect deviceId está vazio ou formatado incorretamente |
object.fail Callback function returns state Parameters only iOS)
| Código de estado | Apresentações |
|---|---|
| 0 | Desconhecido |
| 1 | Redefinir |
| 2 | Não suportado |
| 3 | Não autorizado |
| 4 | Nã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):
- 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
| atributo | tipo | Apresentações |
|---|---|---|
| devices | Array.Object | Lista de dispositivos recentemente pesquisados |
res.devices Structure
| atributo | tipo | Apresentações |
|---|---|---|
| name | string | Nome do dispositivo Bluetooth, que alguns dispositivos podem não ter |
| deviceId | string | ID do dispositivo Bluetooth |
| RSSI | number | Intensidade atual do sinal do dispositivo Bluetooth, unidade dBm |
| advertisData | ArrayBuffer | No segmento de dados de transmissão do dispositivo Bluetooth atual Segmento de dados do fabricante |
| advertisServiceUUIDs | Array.string | No segmento de dados de transmissão do segmento de dados ServiceUUIDs do dispositivo Bluetooth atual |
| localName | string | No segmento de dados de transmissão do segmento de dados LocalName do dispositivo Bluetooth atual |
| serviceData | Object | No 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
| atributo | tipo | Apresentações |
|---|---|---|
| available | boolean | O adaptador Bluetooth está disponível? |
| discovering | boolean | O 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| pin | string | sim | jardas de pinos, Base 64. Formato. | |
| timeout | number | 20000 | não | Tempo limite, unidades ms |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| services | Array.string | sim | Lista UUID de serviço mestre de dispositivo Bluetooth suporta UUID de posição 16/32/128) | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| devices | Array.Object | Lista de dispositivos encontrados |
res.devices Structure
| atributo | tipo | Apresentações |
|---|---|---|
| name | string | Nome do dispositivo Bluetooth, que alguns dispositivos podem não ter |
| deviceId | string | Usado para distinguir a identificação do equipamento |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| devices | Array.Object | UUID Lista de dispositivos conectados |
res.devices Structure
| atributo | tipo | Apresentações |
|---|---|---|
| name | string | Nome do dispositivo Bluetooth, que alguns dispositivos podem não ter |
| deviceId | string | ID do dispositivo Bluetooth |
| RSSI | number | Intensidade atual do sinal do dispositivo Bluetooth, unidade dBm |
| advertisData | ArrayBuffer | No segmento de dados de transmissão do dispositivo Bluetooth atual Segmento de dados do fabricante |
| advertisServiceUUIDs | Array.string | No segmento de dados de transmissão do segmento de dados ServiceUUIDs do dispositivo Bluetooth atual |
| localName | string | No segmento de dados de transmissão do segmento de dados LocalName do dispositivo Bluetooth atual |
| serviceData | Object | No segmento de dados de transmissão do segmento de dados ServiceData do dispositivo Bluetooth atual |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| discovering | boolean | Você está procurando dispositivos? |
| available | boolean | O adaptador Bluetooth está disponível? |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| serviceId | string | sim | UUID de serviço correspondente do recurso Bluetooth | |
| characteristicId | string | sim | Característica Bluetooth UUID | |
| value | ArrayBuffer | sim | Valores binários para recursos de dispositivos Bluetooth | |
| writeType | string | sim | Configuraçã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 | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| completo | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
writeType
| Valor jurídico | tipo |
|---|---|
| write | Escrita de resposta forçada, relatório de erros não suportado |
| writeNoResponse | Escrita forçada sem resposta, sem suporte para relatório de erros |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| mtu | number | sim | Unidade máxima de transmissão. Defina o escopo como (22.512) Intervalo, bytes unitários | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| mtu | number | Valor 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
| atributo | tipo | Apresentações |
|---|---|---|
| mtu | number | Valor 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| serviceId | string | sim | UUID de serviço correspondente do recurso Bluetooth | |
| characteristicId | string | sim | Característica Bluetooth UUID | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Apresentações |
|---|---|---|
| deviceId | string | ID do dispositivo Bluetooth |
| connected | boolean | Você 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
| atributo | tipo | Apresentações |
|---|---|---|
| deviceId | string | ID do dispositivo Bluetooth |
| serviceId | string | UUID de serviço correspondente do recurso Bluetooth |
| characteristicId | string | Característica Bluetooth UUID |
| value | ArrayBuffer | Valor 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| serviceId | string | sim | UUID de serviço correspondente do recurso Bluetooth | |
| characteristicId | string | sim | Característica Bluetooth UUID | |
| state | boolean | sim | Habilitar notificação | |
| type | string | indication | não | Define o tipo de assinatura característico com um valor válido de notificação e indicação |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (o sucesso ou falha da chamada será executado) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth。 A necessidade passou pz.createBLEConnection Estabelecer uma conexão | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| services | Array.Object | Lista de serviços de dispositivos |
| Atributo | tipo | Apresentações |
|---|---|---|
| uuid | string | UUID de serviço de dispositivo Bluetooth |
| isPrimary | boolean | Se este serviço é um serviço mestre |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| RSSI | Number | Intensidade 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth。 A necessidade passou pz.createBLEConnection Estabelecer uma conexão | |
| serviceId | string | sim | Serviço Bluetooth UUID。 Precisa chamar primeiro pz.getBLEDeviceServices Obter | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| characteristics | Array.Object | Lista de recursos do equipamento |
características
| Atributo de estrutura | tipo | Apresentações |
|---|---|---|
| uuid | string | Recurso de dispositivo Bluetooth UUID |
| properties | Object | Tipo de operação suportada por este recurso |
propriedades
| Atributo de estrutura | tipo | Apresentações |
|---|---|---|
| read | boolean | Este recurso suporta operação de leitura |
| write | boolean | Este recurso oferece suporte à operação de gravação |
| notify | boolean | Este recurso oferece suporte à operação de notificação |
| indicate | boolean | Este recurso suporta indicação de operação |
| writeNoResponse | boolean | O recurso oferece suporte a operações de gravação sem resposta |
| writeDefault | boolean | O recurso oferece suporte a operações de gravação sem resposta |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| timeout | number | não | Tempo limite, unidades Ms, sem preenchimento significa que não há tempo limite | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| deviceId | string | sim | ID do dispositivo Bluetooth | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| -1 | already connet | Conectado |
| 10000 | not init | Adaptador Bluetooth não inicializado |
| 10001 | not available | O adaptador Bluetooth atual não está disponível |
| 10002 | no device | Dispositivo especificado não encontrado |
| 10003 | connection fail | Falha na conexão |
| 10004 | no service | Serviço especificado não encontrado |
| 10005 | no characteristic | Não foi encontrada a assinatura especificada. |
| 10006 | no connection | Conexão atual desconectada |
| 10007 | property not support | O recurso atual não suporta esta operação |
| 10008 | system error | Todos os outros sistemas comunicaram anomalias |
| 10009 | system not support | Específico do sistema Android, versão do sistema abaixo de 4.3 Não suportado WAS |
| 10012 | operate time out | Tempo limite de conexão |
| 10013 | invalid_data | Connect 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
| atributo | tipo | Apresentações |
|---|---|---|
| deviceId | String | Dispositivo com estado alterado de ID de conexão |
| serverId | String | servidor de UUID |
| connected | Boolean | Status 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| server | BLEPeripheralServer | O 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| service | Object | sim | Serviço de descrição de objeto | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
object.service Structure
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| uuid | String | sim | UUID do serviço Bluetooth | |
| characteristics | Array.Object | sim | Lista de características |
características Estrutura
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| uuid | String | sim | característica do UUID | |
| properties | Object | não | Operação com suporte de recurso | |
| permission | Object | não | Permissão de recurso | |
| value | ArrayBuffer | não | Valor binário correspondente ao recurso | |
| descriptors | Array.Object | não | Dados do descritor |
Estrutura de propriedades
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| write | Boolean | false | não | escrever |
| writeNoResponse | Boolean | false | não | Sem resposta Escrever |
| read | Boolean | false | não | leia |
| notify | Boolean | false | não | Assine |
| indicate | Boolean | false | não | Pacote |
Estrutura de permissão
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| readable | Boolean | false | não | Legível |
| writeable | Boolean | false | não | Gravável |
| readEncryptionRequired | Boolean | false | não | Solicitação de leitura criptografada |
| writeEncryptionRequired | Boolean | false | não | Solicitação de gravação criptografada |
Estrutura dos descritores
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| uuid | String | sim | Descritor de UUID | |
| permission | Object | não | Permissões do descritor | |
| value | ArrayBuffer | não | Dados do descritor |
Estrutura de permissão
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| write | Boolean | false | não | escrever |
| read | Boolean | false | não | leia |
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| serviceId | String | UUID de serviço correspondente do recurso Bluetooth |
| characteristicId | String | Característica Bluetooth UUID |
| callbackId | Number | Identificador 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
| atributo | tipo | Apresentações |
|---|---|---|
| serviceId | String | UUID de serviço correspondente do recurso Bluetooth |
| characteristicId | String | Caracterí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
| atributo | tipo | Apresentações |
|---|---|---|
| serviceId | String | UUID de serviço correspondente do recurso Bluetooth |
| characteristicId | String | Caracterí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
| atributo | tipo | Apresentações |
|---|---|---|
| serviceId | String | UUID de serviço correspondente do recurso Bluetooth |
| characteristicId | String | Caracterí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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| serviceId | String | sim | serviço de UUID | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| advertiseRequest | Object | sim | Parâmetros personalizados de transmissão | |
| powerLevel | String | medium | não | Poder de transmissão |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
Estrutura Object.advertiseRequest
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| connectable | Boolean | true | não | Se o dispositivo atual pode ser conectado |
| deviceName | String | não | No rádio. campo deviceName, padrão vazio | |
| serviceUuids | Array.String | não | Serviço a ser transmitido Lista UUID. use UUID de posição 16/32 Consulte os pontos de atenção | |
| manufacturerData | Array.Object | não | Informaçõ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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| manufacturerId | String | sim | ID do fabricante, 0x Início hexadecimal | |
| manufacturerSpecificData | ArrayBuffer | não | Informações do fabricante |
Object.powerLevel Legal value
| valor | Apresentações | Versão mínima |
|---|---|---|
| low | Baixo consumo de energia | |
| medium | Potência moderada | |
| high | Alta 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| serviceId | String | sim | UUID de serviço correspondente do recurso Bluetooth | |
| characteristicId | String | sim | Característica Bluetooth UUID | |
| value | ArrayBuffer | sim | característica Valor binário correspondente | |
| needNotify | Boolean | sim | Você precisa notificar o valor do host Atualizado | |
| callbackId | Number | não | Opcionalmente, use o | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| 11000 | unsupport | Sistema ou dispositivo não suporta |
| 11001 | bluetooth service unavailable | Serviço Bluetooth não disponível |
| 11002 | location service unavailable | Serviço de localização indisponível |
| 11003 | already start | A busca começou. |
| 11004 | not startBeaconDiscovery | A pesquisa ainda não começou. |
| 11005 | system error | Erro de sistema |
| 11006 | invalid data | Parâ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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| uuids | Array.<string> | sim | Lista UUID de transmissão de dispositivo Beacon | |
| ignoreBluetoothAvailable | boolean | false | não | Verifique 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. |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A interface chama o final da função de retorno de chamada (a chamada será executada com sucesso ou falha) |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| 11000 | unsupport | Sistema ou dispositivo não suporta |
| 11001 | bluetooth service unavailable | Serviço Bluetooth não disponível |
| 11002 | location service unavailable | Serviço de localização indisponível |
| 11003 | already start | A busca começou. |
| 11004 | not startBeaconDiscovery | A pesquisa ainda não começou. |
| 11005 | system error | Erro de sistema |
| 11006 | invalid data | Parâmetros incorretos |
Nota
- Falha de autorização de interface (iOS):
- 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
| atributo | tipo | Apresentações |
|---|---|---|
| faróis | Array.BeaconInfo | Lista 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
| atributo | tipo | Apresentações |
|---|---|---|
| available | boolean | O serviço está disponível atualmente |
| discovering | boolean | O 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| beacons | Array.BeaconInfo | Lista de faróis |
erro
| Código de erro | Mensagem de erro | Apresentações |
|---|---|---|
| 0 | ok | normais |
| 11000 | unsupport | Sistema ou dispositivo não suporta |
| 11001 | bluetooth service unavailable | Serviço Bluetooth não disponível |
| 11002 | location service unavailable | Serviço de localização indisponível |
| 11003 | already start | A busca começou. |
| 11004 | not startBeaconDiscovery | A pesquisa ainda não começou. |
| 11005 | system error | Erro de sistema |
| 11006 | invalid data | Parâ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
| valor | Apresentações | Versão mínima |
|---|---|---|
| 0 | Sinal muito fraco para calcular distância ou não equipamento iOS | |
| 1 | Muito perto | |
| 2 | Relativamente recente | |
| 3 | longe |
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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| firstName | string | sim | nome | |
| photoFilePath | string | não | Caminho do arquivo local do avatar | |
| nickName | string | não | apelido | |
| lastName | string | não | Sobrenome | |
| middleName | string | não | nome do meio | |
| remark | string | não | Observações | |
| mobilePhoneNumber | string | não | Número de telefone. | |
| weChatNumber | string | não | Conta Phiz | |
| addressCountry | string | não | Endereço de contato país | |
| addressState | string | não | Contato Endereço Província | |
| addressCity | string | não | Endereço de contato Cidade | |
| addressStreet | string | não | Endereço de contato Rua | |
| addressPostalCode | string | não | Endereço de contacto código postal | |
| organization | string | não | empresa | |
| title | string | não | posição | |
| workFaxNumber | string | não | Fax de trabalho | |
| workPhoneNumber | string | não | Telefone comercial | |
| hostNumber | string | não | Telefone da empresa | |
| string | não | |||
| url | string | não | site | |
| workAddressCountry | string | não | Endereço do país de trabalho | |
| workAddressState | string | não | Endereço de trabalho Província | |
| workAddressCity | string | não | Endereço de trabalho Cidade | |
| workAddressStreet | string | não | Endereço de trabalho Rua | |
| workAddressPostalCode | string | não | Endereço do código postal do trabalho | |
| homeFaxNumber | string | não | Fac-símile residencial | |
| homePhoneNumber | string | não | Telefone residencial | |
| homeAddressCountry | string | não | Endereço residencial país | |
| homeAddressState | string | não | Endereço residencial províncias | |
| homeAddressCity | string | não | Endereço residencial cidade | |
| homeAddressStreet | string | não | Endereço residencial rua | |
| homeAddressPostalCode | string | não | Código postal do endereço residencial | |
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | Funçã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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| phoneNumber | string | Número de telefone. |
| displayName | string | Nome do contato |
| phoneNumberList | string | Todos 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
| atributo | tipo | Valores padrão | Obrigatório | Apresentações |
|---|---|---|---|---|
| success | function | não | Interface chama a função de retorno de chamada bem-sucedida | |
| fail | function | não | Interface chama funções de retorno de chamada com falha | |
| complete | function | não | A 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
| atributo | tipo | Apresentações |
|---|---|---|
| open | Boolean | iOS Ative a função auxiliar de narração no talkback do Android Retornar quando verdadeiro |