Visão geral da API
1. Básico
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.env | Variáveis ambientais | 1.0.0 | |
| pz.canIUse | Determine se as APIs, retornos de chamada, parâmetros, componentes, etc. estão disponíveis na versão atual | 1.0.0 | |
| pz.base64ToArrayBuffer | Converter uma string Base64 em um objeto ArrayBuffer | 1.0.0 | |
| pz.arrayBufferToBase64 | Objeto ArrayBuffer | 1.0.0 | |
| pz.base64ToTempFilePath | Salve os dados base64 da imagem na sandbox local e retorne o caminho do cache local | 1.0.0 | |
| pz.fileToBase64 | O arquivo será convertido em sequência de caracteres Base64 | 1.0.0 |
1.1 Sistema
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getSystemInfoSync | Versão síncrona de pz.getSystemInfo | 1.0.0 | |
| pz.getSystemInfoAsync | Informações do sistema de acesso assíncrono | 1.0.0 | |
| pz.getSystemInfo | Acesso às informações do sistema | 1.0.0 |
Por favor, note que：
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.openAppAuthorizeSetting | Ir para a página de gerenciamento de autorização Phiz |
| pz.openSystemBluetoothSetting | Ir para a página Configurações de Bluetooth do sistema |
| pz.getWindowInfo | Obtenha informações da janela |
| pz.getSystemSetting | Obtenha configurações de dispositivo |
| pz.getSkylineInfoSync | A versão síncrona de pz.getskylineinfo |
| pz.getSkylineInfo | Obter o suporte do tempo de execução atual para o mecanismo de renderização Skyline |
| pz.getDeviceInfo | Obtenha informações básicas do dispositivo |
1.2 Atualização
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getUpdateManager | ObtenhaGlobally uniqueVersion Update Manager para gerenciar atualizações do phizclip | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.updateWeChatApp | Atualizar a versão do cliente |
1.2.1 UPDATEMANAGER
| Nome | Função | Versões | Observações |
|---|---|---|---|
| UpdateManager.applyUpdate | Forçar o phizclip para reiniciar e usar a nova versão. | 1.0.0 | |
| UpdateManager.onCheckForUpdate | Monitorar a solicitação em segundo plano do Phiz para verificar o evento de resultados de atualização | 1.0.0 | |
| UpdateManager.onUpdateFailed | Monitorar eventos de falha de atualização | 1.0.0 | |
| UpdateManager.onUpdateReady | Monitorar evento em que o miniaplicativo tem uma atualização da versão | 1.0.0 |
1.3 PhizClip
1.3.1 Ciclo de vida
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getLaunchOptionsSync | Obter os parâmetros da inicialização do phizclip | 1.0.0 | |
| pz.getEnterOptionsSync | Obter os parâmetros no início do phizclip | 1.0.0 |
1.3.2 Evento em nível de aplicativo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.onPageNotFound | Não há eventos na página a serem abertos pelo monitoramento PhizClip | 1.0.0 | |
| pz.onError | Monitoramento de eventos de erro do PhizClip | 1.0.0 | |
| pz.onAppShow | Monitorar evento de corte em foreground do PhizClip | 1.0.0 | |
| pz.onAppHide | Monitorar evento de corte em background do PhizClip | 1.0.0 | |
| pz.offPageNotFound | A página a ser aberta pelo PhizClip não monitorado não possui um evento | 1.0.0 | |
| pz.offError | Cancelar evento de erro de monitaramento do PhizClip | 1.0.0 | |
| pz.offAppShow | Cancelar o monitoramento PhizClip para cortar o evento em foreground | 1.0.0 | |
| pz.offAppHide | Cancelar monitoramento do PhizClip para cortar o evento em background | 1.0.0 | |
| pz.onThemeChange | Monitorar eventos de mudança de tema do sistema | 1.0.0 | |
| pz.onUnhandledRejection | Monitorar eventos de rejeição Promise não processados | 1.0.0 | |
| pz.offUnhandledRejection | Cancelar monitoramento de eventos de rejeição Promise não processados | 1.0.0 | |
| pz.offThemeChange | Cancelar monitoramento de mudanças de tema do sistema | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.onAudioInterruptionEnd | Monitorar eventos de interrupção de áudio |
| pz.onAudioInterruptionBegin | Monitorar eventos de interrupção de áudio devido à ocupação do sistema |
| pz.offAudioInterruptionEnd | Cancelar monitoramento de eventos de interrupção de áudio |
| pz.offAudioInterruptionBegin | Cancelar monitoramento de eventos de interrupção de áudio devido à ocupação do sistema |
| pz.onLazyLoadError | Monitorar chamada falha de retorno ao carregar componente assíncrono do aplicativo |
| pz.offLazyLoadError | Cancelar o monitoramento de chamada falha de retorno ao carregar componente assíncrono do aplicativo |
1.4 Depuração
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.setEnableDebug | Defina se deseja ativar o botão de depuração | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getRealtimeLogManager | Obter o objeto de gerenciador de logs em tempo real |
| pz.getLogManager | Obter o objeto do gerenciador de logs |
1.4.1 Console
| Nome | Função | Versões | Observações |
|---|---|---|---|
| console.debug | Imprimir logs de depuração para o painel de depuração | 1.0.0 | |
| console.error | Imprimir um registro de erro no painel de depuração | 1.0.0 | |
| console.group | Crie um novo grupo no painel de depuração | 1.0.0 | |
| console.groupEnd | Encerrar o grupo criado por console.Group | 1.0.0 | |
| console.info | Imprimir o registro de informações para o painel de depuração | 1.0.0 | |
| console.log | Imprimir log no painel de depuração | 1.0.0 | |
| console.warn | Imprimir um registro de aviso para o painel de depuração | 1.0.0 |
1.4.2 LogManager
| Nome | Função | Versões | Observações |
|---|---|---|---|
| LogManager.debug | Escrever Log de erros | Sim, mas os logs estão apenas no console local | 3.0.36 |
| LogManager.info | Escrever Log de informações | Sim, mas os logs estão apenas no console local | 3.0.36 |
| LogManager.log | Escrever registro de Log | Sim, mas os logs estão apenas no console local | 3.0.36 |
| LogManager.warn | Escrever Log de aviso | Sim, mas os logs estão apenas no console local | 3.0.36 |
1.4.3 RealTimelogManager
| Nome | Função | Versões | Observações |
|---|---|---|---|
| RealtimeLogManager.error | Escrever Log de erros | Sim, mas os logs estão apenas no console local | 3.0.36 |
| RealtimeLogManager.info | Escrever Log de informações | Sim, mas os logs estão apenas no console local | 3.0.36 |
| RealtimeLogManager.warn | Escrever log de aviso | Sim, mas os logs estão apenas no console local | 3.0.36 |
| RealtimeLogManager.setFilterMsg | Definir palavras-chave de filtro | Sim, mas os logs estão apenas no console local | 3.0.36 |
| RealtimeLogManager.addFilterMsg | Adicionar palavras -chave do filtro | Sim, mas os logs estão apenas no console local | 3.0.36 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| RealtimeLogManager.getCurrentState | Os logs em tempo real agregam os logs armazenados em cache por um determinado intervalo de tempo e, se o conteúdo armazenado em cache exceder o limite, ele será descartado. |
| RealtimeLogManager.in | Definir a página onde o parâmetro da página de log em tempo real está localizado. |
| RealtimeLogManager.tag | Obter uma instância do gerenciador de log para a tag fornecida. |
1.4.4 RealtimetagLogManager
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| RealtimeTagLogManager.info | Escrever Log de informações |
| RealtimeTagLogManager.warn | Escrever Log de avisos |
| RealtimeTagLogManager.error | Escrever Log de erros |
| RealtimeTagLogManager.insetFilterMsgfo | Definir palavras-chave de filtro |
| RealtimeTagLogManager.addFilterMsg | Adicionar palavras-chave de filtro |
1.5 Desempenho
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getPerformance | Obter informações sobre o desempenho atual do PhizClip |
| pz.reportPerformance | Relatório de velocidade do PhizClip |
| pz.preloadWebview | Pré-carregar a WebView para a próxima página |
| pz.preloadSkylineView | Pré-carregue o ambiente de execução -Skyline- necessário para a próxima página |
| pz.preloadAssets | Pré-carregar os arquivos de recursos de mídia para a camada de visualização |
1.5.1 Lista de entrada
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| EntryList.getEntries | Este método retorna todos os dados de desempenho na lista atual |
| EntryList.getEntriesByType | Obter todos os dados de desempenho de tipos [entryType] na lista atual |
| EntryList.getEntriesByNome | Obter todos os dados de desempenho de nomes [name] e tipos [entryType] na lista atual |
1.5.2 Desempenho
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| Performance.getEntries | Esse método retorna todos os dados de desempenho ao buffer atual |
| Performance.getEntriesByType | Obter todos os dados de desempenho de tipos [entryType] no buffer atual |
| Performance.getEntriesByNome | Obter todos os dados de desempenho de nomes [name] e tipos [entryType] no buffer atual |
| Performance.createObserver | Criar um monitoramento de eventos de desempenho global |
| Performance.setBufferSize | Definir o tamanho do buffer. O tamanho padrão de buffer é de 30 dados de desempenho. |
| PerformanceEntry | Unidades de dados de desempenho |
1.5.3 PerformanceObserver
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| PerformanceObserver.disconnect | Interromper monitoramento |
| PerformanceObserver.observe | Iniciar monitoramento |
1.6 Carregamento do subcontrato
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.preDownloadSubpackage | Acionar pré-download de subcontrato |
1.6.1 PredownLoadSubpackageTask
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| PreDownloadSubpackageTask.onProgressUpdate | Monitorar os eventos no progresso do carregamento de subcontratos |
1.7 Criptografia
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getUserCryptoManager | Obter módulo de criptografia do usuário |
1.7.1 UserCryptomanager
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| UserCryptoManager.getLatestUserKey | Obter a chave de criptografia do usuário mais recente |
| UserCryptoManager.getRandomValues | Obter um número de segurança criptográfico aleatório |
2. Roteamento
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.switchTab | Pular para a página TabBar e fechar todas as outras páginas | 1.0.0 | |
| pz.reLaunch | Fechar página atual e abrir nova página no aplicativo | 1.0.0 | |
| pz.redirectTo | Fechar página atual e redirecionar para página no aplicativo | 1.0.0 | |
| pz.navigateTo | Manter página atual e navegar para página no aplicativo | 1.0.0 | |
| pz.navigateBack | Fechar página atual e retornar a página anterior ou múltiplas páginas | 1.0.0 |
2.1 EventChannel
| Nome | Função | Versões | Observações |
|---|---|---|---|
| EventChannel.emit | Acionar um evento | 1.0.0 | |
| EventChannel.off | Desativar monitoramento de um evento | 1.0.0 | |
| EventChannel.on | Continuar o monitoramento de um evento | 1.0.0 | |
| EventChannel.once | Monitorar um evento por uma vez e ele expirará após ser acionado | 1.0.0 |
3. Redirecionamento
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.navigateToMiniProgram | Abrir outro MiniApp | 1.0.0 | |
| pz.navigateBackMiniProgram | Redirecionar ao MiniApp anterior | 1.0.0 | |
| pz.exitMiniProgram | Sair do MiniApp atual | 1.0.0 | |
| pz.navigateToWechatMiniProgram | Abrir MiniApp | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.openEmbeddedMiniProgram | Abrir MiniApp em meia tela |
4. Encaminhamento
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.showShareMenu | Exibir botão de encaminhamento da página atual | 1.0.0 | |
| pz.hideShareMenu | Ocultar botão de encaminhamento da página atual | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.updateShareMenu | Atualizar propriedades de encaminhamento |
| pz.showShareImageMenu | Abrir janela pop-up para compartilhar imagens. Você pode enviar a imagem para amigos, coletá-la ou baixá-la |
| pz.shareVideoMessage | Encaminhar video para conversa |
| pz.shareFileMessage | Encaminhar arquivo para conversa |
| pz.onCopyUrl | Monitorar o evento em que o usuário clica no botão “Copiar Link” no menu no canto superior direito |
| pz.offCopyUrl | Cancelar o monitoramento do evento em que o usuário ao clica no botão “Copiar Link” no menu no canto superior direito |
| pz.getShareInfo | Obter detalhes do encaminhamento |
| pz.authPrivateMessage | Autenticar mensagens |
5. Interface
5.1 Interativo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.showToast | Exibir caixa de prompt de mensagem | 1.0.0 | |
| pz.showModal | Exibir caixa de diálogo modal | 1.0.0 | |
| pz.showLoading | Exibir caixa de prompt de carregamento | 1.0.0 | |
| pz.showActionSheet | Exibir menu de ações | 1.0.0 | |
| pz.hideToast | Ocultar caixa de prompt de mensagem | 1.0.0 | |
| pz.hideLoading | Ocultar caixa de prompt de carregamento | 1.0.0 | |
| pz.enableAlertBeforeUnload | Abrir página do MiniApp para retornar à caixa de diálogo | 2.11.5 | |
| pz.disableAlertBeforeUnload | Fechar página do MiniAppp para retornar à caixa de diálogo | 2.11.5 |
5.2 Barra de navegação
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.showNavigationBarLoading | Mostrar progesso do carregamento na barra de navegação da página atual | 1.0.0 | |
| pz.setNavigationBarTitle | Defina dinamicamente o título da página atual | 1.0.0 | |
| pz.setNavigationBarColor | Defina a cor da barra de navegação da página | 1.0.0 | |
| pz.hideNavigationBarLoading | Ocultar o progresso de carregamento na barra de navegação na página atual | 1.0.0 | |
| pz.hideHomeButton | Ocultar botão de voltar à página inicial | 1.0.0 |
5.3 Fundo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.setBackgroundTextStyle | Definir dinamicamente a fonte do plano de fundo e o estilo gráfico do carregamento | 1.0.0 | |
| pz.setBackgroundColor | Definir dinamicamente a cor da janela de fundo | 1.0.0 |
5.4 TabBar
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.showTabBarRedDot | Exibir o ponto vermelho (indicador de notificação) no canto superior direito do item | 1.0.0 | |
| pz.showTabBar | Exibir TabBar | 1.0.0 | |
| pz.setTabBarStyle | Configurar dinamicamente o estilo de TabBar | 1.0.0 | |
| pz.setTabBarItem | Configurar dinamicamente um determinado item do TabBar, 2.7.0 Suporte de imagem Tempoles e arquivos de rede | 1.0.0 | |
| pz.setTabBarBadge | Adicionar texto ao canto superior direito do TabBar | 1.0.0 | |
| pz.removeTabBarBadge | Remover texto no canto superior direito do TabBar | 1.0.0 | |
| pz.hideTabBarRedDot | Ocultar o ponto vermelho (indicador de notificação) no canto superior direito do item | 1.0.0 | |
| pz.hideTabBar | Ocultar Tabbar | 1.0.0 |
5.5 Tipo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.loadFontFace | Carregar dinamicamente fontes da web. O endereço do arquivo precisa ser baixado | 1.0.0 |
5.6 Atualização suspensa
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopPullDownRefresh | Parar atualização da página atual | 1.0.0 | |
| pz.startPullDownRefresh | Iniciar atualização da página | 1.0.0 |
5.7 Rolagem da página
5.7.1 pz.pagescrollto
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.pageScrollTo | Rolar a página para o ponto alvo, suporta o selector e a rolamento distanciarem em duas direções | 1.0.0 |
5.7.2 ScrollViewContext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| ScrollViewContext | A instância de operação do ScrollView pode ser obtida através do método SodesRef.Node de pz.CreateSeSelectorQuery | 3.0.45 | |
| ScrollViewContext.scrollIntoView | Rolar para posição específica | 3.0.45 | |
| ScrollViewContext.scrollTo | Rolar para posição específica | 3.0.45 |
5.8 Animação
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createAnimation | Crie uma animação na instância animation | 1.0.0 |
5.8.1 Animação
| Nome | Função | Versões | Observações |
|---|---|---|---|
| Animation.export | Exportar a fila de animação. | 1.0.0 | |
| Animation.step | Indica que um conjunto de animações está completo. | 1.0.0 | |
| Animation.matrix | Como em transform-function matrix | 1.0.0 | |
| Animation.matrix3d | Como em transform-function matrix | 1.0.0 | |
| Animation.rotate | Rotacionar no sentido horário ao eixo de origem | 1.0.0 | |
| Animation.rotate3d | Rotacionar no sentido horário a partir de um eixo fixo | 1.0.0 | |
| Animation.rotateX | Rotacionar no sentido horário a partir do eixo X | 1.0.0 | |
| Animation.rotateY | Rotacionar no sentido horário a partir do eixo Y | 1.0.0 | |
| Animation.rotateZ | Rotacionar no sentido horário a partir do eixo Z | 1.0.0 | |
| Animation.scale | Escala | 1.0.0 | |
| Animation.scale3d | Escala | 1.0.0 | |
| Animation.scaleX | Escala do eixo X | 1.0.0 | |
| Animation.scaleY | Escala do eixo Y | 1.0.0 | |
| Animation.scaleZ | Escala do eixo Z | 1.0.0 | |
| Animation.skew | Inclinar o eixo x e o eixo y | 1.0.0 | |
| Animation.skewX | Inclinar o eixo x | 1.0.0 | |
| Animation.skewY | Inclinar o eixo y | 1.0.0 | |
| Animation.translate | Transformação de tradução | 1.0.0 | |
| Animation.translate3d | Tradução de coordenadas xyz | 1.0.0 | |
| Animation.translateX | Mude o eixo x | 1.0.0 | |
| Animation.translateY | Mude o eixo y | 1.0.0 | |
| Animation.translateZ | Mude o eixo z | 1.0.0 | |
| Animation.opacity | Definir transparência | 1.0.0 | |
| Animation.backgroundColor | Definir cor de fundo | 1.0.0 | |
| Animation.width | Definir largura | 1.0.0 | |
| Animation.height | Definir altura | 1.0.0 | |
| Animation.left | Configurar valor à esquerda | 1.0.0 | |
| Animation.right | Configurar valor à direita | 1.0.0 | |
| Animation.top | Configurar o valor superior | 1.0.0 | |
| Animation.bottom | Configurar valor inferior | 1.0.0 |
5.9 Fixado no topo
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.setTopBarText | Definir dinamicamente o conteúdo da barra fixada no topo |
5.10 Componentes personalizados
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.nextTick | Atrasar parte de uma operação para o intervalo de tempo seguinte | 1.0.0 |
5.11 Menu
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getMenuButtonBoundingClientRect | Obter informações de posição do layout do botão de menu (botão cápsula no canto superior direito) | 1.0.0 |
5.12 Janela
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.onWindowResize | Monitorar eventos de redimensionamento da janela | 1.0.0 | |
| pz.offWindowResize | Cancelar monitoramento de eventos de redimensionamento da janela | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.setWindowSize | Para definir o tamanho da janela, esta interface se aplica apenas à plataforma, consulte o guia para obter detalhes |
5.13 Animação de Worklet
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.worklet | Obter objeto Worklet |
5.13.1 Worklet
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| worklet.cancelAnimation | Cancelar animação orientada por SharedValue |
| worklet.derived | Derivar valores DerivedValue, podendo gerar outras variáveis compartilhadas com base no SharedValue existente |
| worklet.shared | Variável compartilhada SharedValue, usada para compartilhar dados entre threads e gerar animações |
| worklet.decay | Animação de rolagem |
| worklet.spring | Animação baseada em física |
| worklet.timing | Animação baseada em tempo |
| worklet.delay | Atrasar animação |
| worklet.repeat | Repetir animação |
| worklet.sequence | Combinar sequências de animação, executar as animações recebidas em sequência |
| worklet.runOnJS | Quando a função de worklet é executada na UI thread, as funções externas capturadas podem ser tipos de worklet ou podem ser funções comuns. Para distingui-los mais claramente, é necessário usar runOnJS para voltar as funções comuns do thread JS |
| worklet.runOnUI | Executar função de worklet em UI thread |
6. Rede
6.1 Rede
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.request | Iniciar solicitação de rede HTTPS | 1.0.0 |
6.2 RequestTask
| Nome | Função | Versões | Observações |
|---|---|---|---|
| RequestTask.abort | Interromper tarefa de solicitação | 1.0.0 | |
| RequestTask.offHeadersReceived | Interromper monitoramento do evento cabeçalho de resposta HTTP | 1.0.0 | |
| RequestTask.onHeadersReceived | Para monitorar os eventos do cabeçalho da resposta HTTP. | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| RequestTask.onChunkReceived | Monitorar eventos Chunked Transfer-Encoding |
| RequestTask.offChunkReceived | Remover a função de monitoramento de eventos Chunked Transfer-Encoding |
6.3 Download
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.downloadFile | Baixar recursos de arquivo localmente | 1.0.0 |
6.3.1 Download Trask
| Nome | Função | Versões | Observações |
|---|---|---|---|
| DownloadTask.abort | Interromper download | 1.0.0 | |
| DownloadTask.offHeadersReceived | Interromper o evento de cabeçalho de resposta HTTP | 1.0.0 | |
| DownloadTask.onHeadersReceived | Parar monitoramento de eventos cabeçalho de resposta HTTP. (Ocorrerá antes da conclusão da solicitação) | 1.0.0 | |
| DownloadTask.offProgressUpdate | Interromper monitoramento de eventos de mudança no progresso de download | 1.0.0 | |
| DownloadTask.onProgressUpdate | Monitorar mudança no progesso de download | 1.0.0 |
6.4 Upload
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.uploadFile | Carregue os recursos locais para o servidor | 1.0.0 |
6.4.1 UploadTask
| Nome | Função | Versões | Observações |
|---|---|---|---|
| UploadTask.abort | Interromper tarefa de upload | 1.0.0 | |
| UploadTask.offHeadersReceived | Cancelar o monitoramento de eventos de mudança de progresso de upload | 1.0.0 | |
| UploadTask.onHeadersReceived | Monitar evento cabeçalho de resposta HTTP. (Ocorrerá antes da conclusão da solicitação) | 1.0.0 | |
| UploadTask.offProgressUpdate | Cancelar monitoramento para eventos de mudança de progresso de upload | 1.0.0 | |
| UploadTask.onProgressUpdate | Monitorar mudanças no progesso de upload | 1.0.0 |
6.5 WebSocket
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.sendSocketMessage | Adotar conexão WebSocket para enviar dados | 1.0.0 | |
| pz.onSocketOpen | Monitorar evento de abertura da conexão WebSocket | 1.0.0 | |
| pz.onSocketMessage | Monitorar evento de mensagem do servidor recebida pelo WebSocket | 1.0.0 | |
| pz.onSocketError | Monitorar evento de erro do WebSocket | 1.0.0 | |
| pz.onSocketClose | Monitorar evento de interrupção de conexão do WebSocket | 1.0.0 | |
| pz.connectSocket | Criar conexão WebSocket | 1.0.0 | |
| pz.closeSocket | Interromper conexão WebSocket | 1.0.0 |
6.5.1 Sockettask
| Nome | Função | Versões | Observações |
|---|---|---|---|
| SocketTask.close | Interromper conexão WebSocket | 1.0.0 | |
| SocketTask.onClose | Monitorar evento de interrupção da conexão WebSocket | 1.0.0 | |
| SocketTask.onError | Monitorar evento de erro do WebSocket | 1.0.0 | |
| SocketTask.onMessage | Monitorar evento de mensagem do servidor recebida pelo WebSocket | 1.0.0 | |
| SocketTask.onOpen | Monitorar eventos de abertura de conexão WebSocket | 1.0.0 | |
| SocketTask.send | Envie dados por meio de conexão WebSocket | 1.0.0 |
6.6 mDNS
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.stopLocalServiceDiscovery | Parar busca de serviço mDNS |
| pz.startLocalServiceDiscovery | Iniciar busca de serviços mDNS na rede local (LAN) |
| pz.onLocalServiceResolveFail | Monitorar eventos de falha de resolução do serviço mDNS |
| pz.onLocalServiceLost | Monitrar eventos de saída do serviço mDNS |
| pz.onLocalServiceFound | Monitorar eventos descobertos pelo serviço mDNS |
| pz.onLocalServiceDiscoveryStop | Monitorar eventos onde o serviço de busca mDNS foi interrompido |
| pz.offLocalServiceResolveFail | Cancelar monitoramento de eventos de falha de resolução do serviço mDNS |
| pz.offLocalServiceLost | Cancelar monitoramento de eventos de saída do serviço mDNS |
| pz.offLocalServiceFound | Cancelar monitoramento de eventos de busca do serviço mDNS |
| pz.offLocalServiceDiscoveryStop | Cancelar monitoramento de eventos onde o serviço de busca mDNS foi interrompido |
6.7 Comunicação TCP
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createTCPSocket | Criar uma instância de Socket TCP | 1.0.0 |
6.7.1 TCPSocket
| Nome | Função | Versões | Observações |
|---|---|---|---|
| TCPSocket.onMessage | Monitorar eventos acionados quando dados são recebidos | 1.0.0 | |
| TCPSocket.write | Enviar dados no Socket | 1.0.0 | |
| TCPSocket.close | Interromper conexão | 1.0.0 | |
| TCPSocket.connect | Iniciar uma conexão no Socket determinado | 1.0.0 | |
| TCPSocket.offConnect | Interromper monitoramento de eventos acionados quando a conexão do Socket é estabelecida com sucesso | 1.0.0 | |
| TCPSocket.offClose | Interromper monitoramento de eventos acionados quando o Socket está completamente fechado | 1.0.0 | |
| TCPSocket.offError | Interromper monitoramento de eventos acionados quando ocorre um erro | 1.0.0 | |
| TCPSocket.offMessage | Interromper monitoramento de eventos acionados quando dados são recebidos | 1.0.0 | |
| TCPSocket.onClose | Monitorar eventos acionados quando o Socket está completamente fechado | 1.0.0 | |
| TCPSocket.onConnect | Monitorar eventos acionados quando uma conexão Socket for estabelecida com sucesso | 1.0.0 | |
| TCPSocket.onError | Monitorar eventos acionados quando ocorre um erro | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| TCPSocket.bindWifi | Vincular o Socket TCP à rede Wi-Fi atual. Após conectar, o evento onBindWifi é acionado (suportado apenas por Android) |
| TCPSocket.offBindWifi | Interromper monitamento de eventos acionados quando um Socket é vinculado com sucesso à rede wifi atual |
| TCPSocket.onBindWifi | Monitorar eventos acionados quando um soquete for vinculado com sucesso à rede wifi atual |
6.8 Comunicação do sinal UDP
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createUDPSocket | Criar instância de UDP Socket | 1.0.0 |
6.8.1 UDPSocket
| Nome | Função | Versões | Observações |
|---|---|---|---|
| UDPSocket.bind | Vincular uma entrada disponível atribuída aleatoriamente pelo sistema, ou vincular um número de entrada específico | 1.0.0 | |
| UDPSocket.close | Fechar instância do UDP socket, o que equivale a destruí-la | 1.0.0 | |
| UDPSocket.offClose | Interromper monitoramento de eventos de cancelamento | 1.0.0 | |
| UDPSocket.offError | Interromper monitoramento de eventos de erro | 1.0.0 | |
| UDPSocket.offListening | Cancelar monitoramento de eventos que inciam o monitoramento de notificações de pacote de dados | 1.0.0 | |
| UDPSocket.offMessage | Cancelar monitoramento de eventos de recebimento de notificações | 1.0.0 | |
| UDPSocket.onClose | Monitorar eventos de cancelamento | 1.0.0 | |
| UDPSocket.onError | Monitorar eventos de erro | 1.0.0 | |
| UDPSocket.onListening | Monitorar eventos que inciam o monitoramento de notificações de pacote de dados | 1.0.0 | |
| UDPSocket.onMessage | Monitorar eventos de recebimento de notificações | 1.0.0 | |
| UDPSocket.connect | Pré-conectar ao IP e ao port específico;precisa ser usado junto com o método Write | 1.0.0 | |
| UDPSocket.write | Mesmo uso do método send; não haverá diferença ao usar o método send, se o metódo connect não for utilizado previamente (observe que mesmo que connect seja acionado, os parâmetros de endereço e port precisam ser preenchidos nesta interface | 1.0.0 | |
| UDPSocket.setTTL | Definir a opção de socket IP_TTL, que é usada para definir o número máximo de saltos permitidos para uma transmissão de pacote IP | 1.0.0 | |
| UDPSocket.send | Enviar notificação para um IP e port específico | 1.0.0 |
7. Pagamento
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.requestPayment | Inicializar Phiz Pay | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.requestOrderPayment | Iniciar o pagamento no plug-in |
8. Cache de dados
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.setStorageSync | Versão síncrona de pz.setStorage | 1.0.0 | |
| pz.setStorage | Armazenar os dados no cache local na chave especificada | 1.0.0 | |
| pz.removeStorageSync | Versão síncrona de pz.getStorage | 1.0.0 | |
| pz.removeStorage | Remover chave especificada do cache local | 1.0.0 | |
| pz.getStorageSync | Versão síncrona de pz.getStorage | 1.0.0 | |
| pz.getStorageInfoSync | Versão síncrona de pz.getStorageInfo | 1.0.0 | |
| pz.getStorageInfo | Obtenha informações sobre o armazenamento atual de forma assíncrona | 1.0.0 | |
| pz.getStorage | Obtenha de forma assíncrona o conteúdo da chave específica do cache local | 1.0.0 | |
| pz.clearStorageSync | Versão síncrona de pz.clearStorage | 1.0.0 | |
| pz.clearStorage | Limpar cache de dados locais | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.revokeBufferURL | Destruir dados armazenados de acordo com o URL |
| pz.createBufferURL | Criar URL exclusivo com base no buffer de entrada, e armazenar URL na memória |
| pz.batchSetStorageSync | Armazenar dados em lotes na chave especificada no cache local |
| pz.batchSetStorage | Armazenar dados em lotes na chave especificada no cache local |
| pz.batchGetStorageSync | Obter de forma síncrona o conteúdo da chave especificada do cache local em lotes |
| pz.batchGetStorage | Obter de forma síncrona o conteúdo da chave especificada do cache local em lotes |
8.1 Atualização programada
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.setBackgroundFetchToken | Definir status personalizado de login, e usá-lo ao extrair dados periodicamente, para que o servidor de terceiros possa verificar a legitimidade da solicitação |
| pz.onBackgroundFetchData | Monitorar callback quando dados backgroundFetch são recebidos |
| pz.getBackgroundFetchToken | Obter status personalizados de login que já foram definidos |
| pz.getBackgroundFetchData | Extrair dados backgroundFetch de cache do cliente |
8.2 Gerenciador de cache
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.createCacheManager | Criar gerenciador de cache |
8.2.1 Cachemanager
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| CacheManager.addRule | Adicionar regras |
| CacheManager.addRules | Adicionar regras em lotes (Para referências de como escrever regras, consulte CacheManager.addRule) |
| CacheManager.clearCaches | Limpar todo o cache |
| CacheManager.clearRules | Limpar todas as regras; ao mesmo tempo, todo o cache das regras também será limpo |
| CacheManager.deleteCache | Deletar cache |
| CacheManager.deleteCaches | Deletar cache em lotes |
| CacheManager.deleteRule | Deletar regra; ao mesmo tempo, todo o cache dessa regra também será deletado |
| CacheManager.deleteRules | Deletar regras; ao mesmo tempo, todo o cache dessas regras também será deletado |
| CacheManager.match | Combinar regras de cache; geralmente precisam ser usadas em conjunto com o evento de solicitação |
| CacheManager.off | Cancelar monitoramento de eventos |
| CacheManager.on | Monitorar eventos |
| CacheManager.start | Ativar o cache; só entra em vigor quando 'mode' é 'none'. Após isso, o 'estado' do gerenciador de cache será definido como 1. |
| CacheManager.stop | Desativar cache; só entra em vigor quando 'mode' é 'none'. Após isso, o 'estado' do gerenciador de cache será definido como 0 |
9. Análise de dados
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.reportMonitor | Interface personalizada de monitoramento e relatórios de dados |
| pz.reportEvent | Reportar incidente |
| pz.reportAnalytics | Interface personalizada do relatórios de dados de análise |
| pz.getExptInfoSync | Dada uma série de parâmetros experimentais, obter valores dos parâmetros experimentais correspondentes |
10. Canvas
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createOffscreenCanvas | Criar uma instância Canvas fora da tela | 1.0.0 | |
| pz.createCanvasContext | Criar o objeto 'CanvasContext' do contexto de imagem do Canvas | 1.0.0 | |
| pz.canvasToTempFilePath | Exportar o conteúdo da área especificada da tela atual para gerar uma imagem do tamanho especificado | 1.0.0 | |
| pz.canvasPutImageData | Desenhar dados de pixel na tela | 1.0.0 | |
| pz.canvasGetImageData | Obter os dados de pixel ocultos na área da tela | 1.0.0 |
10.1 Canvas
| Nome | Função | Versões | Observações |
|---|---|---|---|
| Canvas.createImage | Criar um objeto de imagem. Somente o canvas obtido por createSelectorQuery possui esse método | 1.0.0 | |
| Canvas.getContext | Este método retorna o contexto de imagem da tela | 1.0.0 | |
| Canvas.createImageData | Criar um objeto ImageData | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| Canvas.cancelAnimationFrame | Cancelar a solicitação de Animation Frame adicionada à programação por requestAnimationFrame |
| Canvas.createPath2D | Criar objeto Path2D |
| Canvas.requestAnimationFrame | Executar no próximo redesenho (atualização) |
| Canvas.toDataURL | Atribuir uma URI de dados contendo a apresentação da imagem |
10.2 Canvascontext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| CanvasContext.arc | Criar curva | 1.0.0 | |
| CanvasContext.arcTo | Desenhar arco com base nos pontos de controle e no raio | 1.0.0 | |
| CanvasContext.beginPath | Iniciar criação de caminho | 1.0.0 | |
| CanvasContext.clearRect | Remover conteúdo dentro da área retangular na tela | 1.0.0 | |
| CanvasContext.drawImage | Desenhar imagem na tela | 1.0.0 | |
| CanvasContext.createCircularGradient | Crie uma cor de gradiente circular | 1.0.0 | |
| CanvasContext.createLinearGradient | Crie uma cor de gradiente linear | 1.0.0 | |
| CanvasContext.createPattern | Para criar o modo de imagem especificado, o método do RMB pode ser repetido em uma imagem de direção especificada | 1.0.0 | |
| CanvasContext.clip | Cortar forma e tamanho arbitrários do canvas original | 1.0.0 | |
| CanvasContext.bezierCurveTo | Traçar curva cúbica de Bezier | 1.0.0 | |
| CanvasContext.draw | Desenhar na tela a descrição anterior (path, transformação, estilo) no contexto do desenho | 1.0.0 | |
| CanvasContext.fill | Preencher o conteúdo do Path (Caminho) atual | 1.0.0 | |
| CanvasContext.fillRect | Preencher um retângulo | 1.0.0 | |
| CanvasContext.fillText | Desenhar na tela o texto preenchido | 1.0.0 | |
| CanvasContext.lineTo | Adicionar um novo ponto e criar uma linha do último ponto especificado até o ponto alvo | 1.0.0 | |
| CanvasContext.setLineDash | Definir estilo de traço pontilhado | 1.0.0 | |
| CanvasContext.setLineCap | Definir ponto final da linha | 1.0.0 | |
| CanvasContext.setGlobalAlpha | Definir transparência geral do pincel | 1.0.0 | |
| CanvasContext.setFontSize | Defina o tamanho da fonte | 1.0.0 | |
| CanvasContext.setFillStyle | Defina a cor de preenchimento | 1.0.0 | |
| CanvasContext.scale | Após o comando, as coordenadas horizontais e verticais do path (caminho) criado posteriormente serão dimensionadas | 1.0.0 | |
| CanvasContext.save | Salvar o contexto de desenho | 1.0.0 | |
| CanvasContext.rotate | Girar o eixo de coordenadas atual no sentido horário em torno da origem | 1.0.0 | |
| CanvasContext.restore | Restaurar um contexto de desenho salvo anteriormente | 1.0.0 | |
| CanvasContext.rect | Criar path (caminho) retangular | 1.0.0 | |
| CanvasContext.quadraticCurveTo | Criar path (caminho) quadrático de Bézier | 1.0.0 | |
| CanvasContext.moveTo | Movar path (caminho) para o ponto especificado na tela sem criar uma linha | 1.0.0 | |
| CanvasContext.setStrokeStyle | Definir cor do traço | 1.0.0 | |
| CanvasContext.setShadow | Definir estilo de sombra | 1.0.0 | |
| CanvasContext.setMiterLimit | Defina o comprimento máximo da mitra | 1.0.0 | |
| CanvasContext.setLineWidth | Defina a largura da linha | 1.0.0 | |
| CanvasContext.setLineJoin | Definir estilo de interseção das linhas | 1.0.0 | |
| CanvasContext.setTransform | Método para redefinir (sobrepôr) a transformação atual usando uma matriz | 1.0.0 | |
| CanvasContext.setTextBaseline | Definir alinhamento vertical do texto | 1.0.0 | |
| CanvasContext.setTextAlign | Definir alinhamento de texto | 1.0.0 | |
| CanvasContext.measureText | Meça a informação do tamanho do texto | 1.0.0 | |
| CanvasContext.strokeRect | Desenhe um retângulo (não preenchido) | 1.0.0 | |
| CanvasContext.strokeText | Método para desenhar um traço de texto em uma determinada posição (x, y) | 1.0.0 | |
| CanvasContext.transform | Método para sobrepor a transformação atual diversas vezes usando as matrizes | 1.0.0 | |
| CanvasContext.translate | Transformar origem (0, 0) do sistema de coordenadas atual | 1.0.0 | |
| CanvasContext.stroke | Desenhar borda no Path (caminho) atual | 1.0.0 |
10.3 Canvasgradiente
| Nome | Função |
|---|---|
| CanvasGradient.addColorStop | Adicionar ponto gradiente à cor |
| Color | Cor |
| Image | Imagem |
| ImageData | Objeto ImageData |
10.4 OffScreencanvas
| Nome | Função | Versões | Observações |
|---|---|---|---|
| OffscreenCanvas.createImage | Criar objeto de imagem | 1.0.0 | |
| OffscreenCanvas.getContext | Este método retorna o contexto de desenho do OffscreenCanvas | 1.0.0 |
11. Mídia
11.1 Mapa
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createMapContext | Criar no contexto do mapa um objeto MapContext | 1.0.0 |
11.1.1 MapContext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| MapContext.addArc | Um arco, um ponto de passagem e um ângulo devem ser definidos | 1.0.0 | |
| MapContext.addCustomLayer | Adicionar camada de personalização | 1.0.0 | |
| MapContext.addGroundOverlay | Criar uma camada de imagem personalizada (a imagem será dimensionada conforme o zoom do mapa) | 1.0.0 | |
| MapContext.addMarkers | Adicionar marcador | 1.0.0 | |
| MapContext.fromScreenLocation | Obter a latitude e longitude correspondente ao ponto na tela (origem das coordenadas sendo o canto superior esquerdo do mapa) | 1.0.0 | |
| MapContext.getCenterLocation | Obter latitude e longitude do centro do mapa atual | 1.0.0 | |
| MapContext.getRegion | Obter campo de visão do mapa atual | 1.0.0 | |
| MapContext.getRotate | Obter ângulo de rotação do mapa atual | 1.0.0 | |
| MapContext.getSkew | Obter ângulo de inclinação do mapa atual | 1.0.0 | |
| MapContext.getScale | Obter escala de zoom do mapa atual | 1.0.0 | |
| MapContext.includePoints | Abrir zoom em uma escala que mostre todas as latitudes e longitudes | 1.0.0 | |
| MapContext.initMarkerCluster | Incializar configuração de agregação de pontos (quando não for acionado, a configuração padrão é usada) | 1.0.0 | |
| MapContext.moveAlong | Mover marcador ao longo do path (caminho) especificado para cenários como reprodução de trajetória | 1.0.0 | |
| MapContext.moveToLocation | Mover o centro do mapa para o ponto de ancoragem atual. Ao mover, é preciso definir o componente do mapa show-location como verdadeiro (true) | 1.0.0 | |
| MapContext.openMapApp | Abra aplicativo de mapas para selecionar a navegação | 1.0.0 | |
| MapContext.removeCustomLayer | Remover uma camada personalizada | 1.0.0 | |
| MapContext.removeGroundOverlay | Remover camada de imagem personalizada | 1.0.0 | |
| MapContext.removeMarkers | Remover marcador (marker) | 1.0.0 | |
| MapContext.setBoundary | Limitar área de exibição do mapa | 1.0.0 | |
| MapContext.setCenterOffset | Definir deslocamento do ponto central do mapa crescendo para trás e para baixo, com uma faixa de escala de tela de 0,25 a 0,75. (O deslocamento padrão é [0,5, 0,5]) | 1.0.0 | |
| MapContext.setLocMarkerIcon | Definir ícone de ponto de ancoragem, path (caminho) de rede de suporte, path (caminho) local, path (caminho) de pacote de código | 1.0.0 | |
| MapContext.toScreenLocation | Obter coordenadas da tela correspondentes à longitude e à latitude. (A origem das coordenadas é o canto superior esquerdo do mapa.) | 1.0.0 | |
| MapContext.translateMarker | Marcador panorâmico com animação | 1.0.0 | |
| MapContext.updateGroundOverlay | Atualizar camadas de imagem personalizadas | 1.0.0 | |
| MapContext.on | Monitorar eventos do mapa | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MapContext.addVisualLayer | Adicionar camada de visualização |
| MapContext.removeVisualLayer | Remover camada de visualização |
| MapContext.removeArc | Deletar arco |
11.2 Imagem
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.saveImageToPhotosAlbum | Salvar fotos no álbum do sistema | 1.0.0 | |
| pz.previewMedia | Visualizar fotos e vídeos | 1.0.0 | |
| pz.previewImage | Visualizar imagem em tela cheia em nova página | 1.0.0 | |
| pz.getImageInfo | Obter informações da imagem | 1.0.0 | |
| pz.compressImage | Comprimir interface da imagem (Qualidade de compressão opcional) | 1.0.0 | |
| pz.chooseFile | Selecionar um arquivo no seletor de arquivos | 2.0.32 | |
| pz.chooseImage | Selecionar imagem do álbum de fotos ou tirar foto com a camêra | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.cropImage | Editar interface da imagem |
| pz.editImage | Cortar interface da imagem |
| pz.chooseMessageFile | Selecionar arquivos da sessão do cliente |
11.3 Vídeo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.saveVideoToPhotosAlbum | Salvar vídeo no álbum do sistema | 1.0.0 | |
| pz.createVideoContext | Criar um objeto VideoContext no contexto de vídeo | 1.0.0 | |
| pz.compressVideo | Comprimir interface do vídeo | 1.0.0 | |
| pz.chooseVideo | Gravar vídeo ou selecionar vídeo do álbum | 1.0.0 | |
| pz.chooseMedia | Tirar ou selecionar fotos ou vídeos do álbum | 1.0.0 | |
| pz.previewVideo | Pré-visualizar vídeo | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.openVideoEditor | Abrir editor de vídeo |
| pz.getVideoInfo | Obter detalhes de vídeo |
11.3.1 Videocontext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| videoContext.exitBackgroundPlayback | Sair do modo de reprodução de áudio do back-end | 1.0.0 | |
| videoContext.exitFullScreen | Sair do modo de tela cheia | 1.0.0 | |
| videoContext.exitPictureInPicture | Sair de janela (pode ser acionado em qualquer página) | 1.0.0 | |
| videoContext.hideStatusBar | Ocultar barra de status (disponível apenas para iOS em modo de tela cheia) | 1.0.0 | |
| videoContext.pause | Pausar vídeo | 1.0.0 | |
| videoContext.play | Reproduzir vídeo | 1.0.0 | |
| videoContext.playbackRate | Definir velocidade de reprodução | 1.0.0 | |
| videoContext.requestBackgroundPlayback | Entrar no modo de reprodução de áudio do back-end | 1.0.0 | |
| videoContext.requestFullScreen | Entrar em modo de tela cheia | 1.0.0 | |
| videoContext.seek | Ir para o local especificado | 1.0.0 | |
| videoContext.sendDanmu | Enviar bullet screen comments (comentários em tempo real) | 1.0.0 | |
| videoContext.showStatusBar | Exibir barra de status (disponível apenas para iOS em modo de tela cheia) | 1.0.0 | |
| videoContext.stop | Parar vídeo | 1.0.0 |
11.4 Áudio
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopVoice | Parar reprodução de áudio | 1.0.0 | |
| pz.setInnerAudioOption | Definir opções de reprodução para InnerAudioContext | 1.0.0 | |
| pz.playVoice | Iniciar reprodução de áudio | 1.0.0 | |
| pz.pauseVoice | Pausar áudio em reprodução | 1.0.0 | |
| pz.createInnerAudioContext | Criar objeto InnerAudioContext no contexto do áudio interno | 1.0.0 | |
| pz.createAudioContext | Criar objeto AudioContext no contexto de áudio | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getAvailableAudioSources | Obtenha fontes de entrada de áudio atualmente suportadas |
| pz.createWebAudioContext | Criar contexto WebAudio |
| pz.createMediaAudioPlayer | Criar objeto de reprodutor de áudio de mídia MediaAudioPlayer (pode ser usado para reproduzir a saída de áudio pelo decodificador de vídeo VideoDecoder) |
11.4.1 AudioBuffer
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| AudioBuffer.copyFromChannel | Copiar do canal especificado do AudioBuffer para o terminal do array |
| AudioBuffer.copyToChannel | Copiar amostras de um array especificado para um canal específico no audioBuffer |
| AudioBuffer.getChannelData | Retornar Float32Array, incluindo dados PCM com canais - definidos por parâmetros de canal (0 representa o primeiro canal) |
11.4.2 Audiocontext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| audiocontext.setSrc | Definir endereço de áudio | 1.0.0 | |
| audiocontext.play | Reproduzir áudio | 1.0.0 | |
| audiocontext.pause | Pausar áudio | 1.0.0 | |
| audiocontext.seek | Ir para local especificado | 1.0.0 |
11.4.3 Ineraudiocontext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| InnerAudioContext.destroy | Destruir instância atual | 1.0.0 | |
| InnerAudioContext.offCanplay | Cancelar monitoramento caso o áudio entre em estado reproduzível | 1.0.0 | |
| InnerAudioContext.offEnded | Cancelar monitoramento de eventos de áudio que são reproduzidos naturalmente até o final | 1.0.0 | |
| InnerAudioContext.offError | Cancelar monitoramento de eventos de erro de reprodução de áudio | 1.0.0 | |
| InnerAudioContext.offTimeUpdate | Cancelar monitoramento de eventos de atualização do progresso da reprodução de áudio | 1.0.0 | |
| InnerAudioContext.offSeeking | Cancelar monitoramento do evento da operação de pular de áudio | 1.0.0 | |
| InnerAudioContext.offWaiting | Cancelar monitoramento do evento de carregamento de áudio | 1.0.0 | |
| InnerAudioContext.onEnded | Monitorar evento o qual o áudio é reproduzido naturalmente até o final | 1.0.0 | |
| InnerAudioContext.offPlay | Cancelar monitoramento de eventos de reprodução de áudio | 1.0.0 | |
| InnerAudioContext.onCanplay | Monitore evento o qual o áudio entra em estado reproduzível | 1.0.0 | |
| InnerAudioContext.onPause | Monitorar eventos de pausa de áudio | 1.0.0 | |
| InnerAudioContext.offPause | Cancelar monitoramento de eventos de pausa de áudio | 1.0.0 | |
| InnerAudioContext.offSeeked | Cancelar monitoramento do evento de pular após completar a reprodução do áudio | 1.0.0 | |
| InnerAudioContext.offStop | Cancelar monitoramento de eventos de interrupção de áudio | 1.0.0 | |
| InnerAudioContext.onError | Monitorar eventos de erro de reprodução de áudio | 1.0.0 | |
| InnerAudioContext.onPlay | Monitorar eventos de reprodução de áudio | 1.0.0 | |
| InnerAudioContext.onSeeked | Monitorar evento em que o áudio conclui a operação de pular | 1.0.0 | |
| InnerAudioContext.onSeeking | Monitorar eventos de operação de salto de áudio | 1.0.0 | |
| InnerAudioContext.onStop | Monitorar eventos de interrupção de áudio | 1.0.0 | |
| InnerAudioContext.onTimeUpdate | Monitorar eventos de atualização do progresso da reprodução de áudio | 1.0.0 | |
| InnerAudioContext.onWaiting | Monitorar evento de carregamento de áudio | 1.0.0 | |
| InnerAudioContext.pause | Pausar | 1.0.0 | |
| InnerAudioContext.play | Reproduzir | 1.0.0 | |
| InnerAudioContext.seek | Pule para o local especificado | 1.0.0 | |
| InnerAudioContext.stop | Parar | 1.0.0 |
11.4.4 MediaudiPlayer
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MediaAudioPlayer.addAudioSource | Adicionar fonte de áudio |
| MediaAudioPlayer.destroy | Destruir reprodutor de mídia |
| MediaAudioPlayer.removeAudioSource | Remover fonte de áudio |
| MediaAudioPlayer.start | Iniciar reprodutor de mídia |
| MediaAudioPlayer.stop | Parar reprodutor de mídia |
11.4.5 WebAudiocontext
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| WebAudioContext.close | Fechar contexto de áudio web |
| WebAudioContext.createAnalyser | Criar AnalyserNode |
| WebAudioContext.createBiquadFilter | Criar BiquadFilterNode |
| WebAudioContext.createBuffer | Criar AudioBuffer representando um pequeno segmento de áudio da memória |
| WebAudioContext.createBufferSource | Criar uma instância BufferSource para reproduzir dados de áudio por meio do objeto AudioBuffer |
| WebAudioContext.createChannelMerger | Criar canal Channel MergerNode |
| WebAudioContext.createChannelSplitter | Criar canal SplitterNode |
| WebAudioContext.createConstantSource | Criar ConstantSourceNode |
| WebAudioContext.createDelay | Criar DelayNode |
| WebAudioContext.createDynamicsCompressor | Criar a DynamicsCompressorNode |
| WebAudioContext.createGain | Criar a GainNode |
| WebAudioContext.createIIRFilter | Criar an IIRFilterNode |
| WebAudioContext.createOscillator | Criar a OscillatorNode |
| WebAudioContext.createPanner | Criar a PannerNode |
| WebAudioContext.createPeriodicWave | Criar a PeriodicWaveNode |
| WebAudioContext.createScriptProcessor | Criar a ScriptProcessorNode |
| WebAudioContext.createWaveShaper | Criar a WaveShaperNode |
| WebAudioContext.decodeAudioData | Decodificar de forma assíncrona um segmento de recurso como AudioBuffer |
| WebAudioContext.resume | Restaurar de forma síncrona o contexto WebAudioContext pausado |
| WebAudioContext.suspend | Pausar de forma síncrona o contexto WebAudioContext |
| WebAudioContextNode | Tipo de módulo de processamento de áudio, onde diferentes nodes possuem funções diferentes, como GainNode (ajuste de volume), etc. |
11.5 Áudio de fundo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopBackgroundAudio | Parar reprodução de música | 1.0.0 | |
| pz.seekBackgroundAudio | Controlar progresso de reprodução da música | 1.0.0 | |
| pz.playBackgroundAudio | Usar reprodutor de mídia back-end para reproduzir música | 1.0.0 | |
| pz.pauseBackgroundAudio | Pausar música | 1.0.0 | |
| pz.onBackgroundAudioStop | Monitorar evento de interrrupção da música | 1.0.0 | |
| pz.onBackgroundAudioPlay | Monitorar eventos de reprodução da música | 1.0.0 | |
| pz.onBackgroundAudioPause | Monitorar evento de pausa de reprodução da música | 1.0.0 | |
| pz.getBackgroundAudioPlayerState | Obter status de reprodução da música de fundo | 1.0.0 | |
| pz.getBackgroundAudioManager | Obter situação geral do gerenciador de áudio exclusivo no back end. O miniaplicativo muda para o back-end; se o áudio estiver sendo reproduzido, ele poderá continuar a ser reproduzido. No entanto, o estado do back-end não pode manipular o estado de reprodução de áudio chamando a API. | 2.12.12 |
11.5.1 BackgroundAudiomanager
| Nome | Função | Versões | Observações |
|---|---|---|---|
| backgroundaudiomanager.onCanplay | Monitorar o evento em que o áudio em segundo entra em estado reproduzível | 1.0.0 | |
| backgroundaudiomanager.onEnded | Monitorar evento de reprodução de áudio em segundo plano | 1.0.0 | |
| BackgroundAudioManager.onError | Monitorar evento de erros de reprodução de áudio em segundo plano | 1.0.0 | |
| backgroundaudiomanager.onNext | Monitorar evento o qual usuário clica na próxima música no painel de reprodução de música do sistema | 1.0.0 | |
| backgroundaudiomanager.onPause | Monitorar evento de pausa de áudio em segundo plano | 1.0.0 | |
| backgroundaudiomanager.onPlay | Monitorar evento de reprodução de áudio em segundo plano | 1.0.0 | |
| backgroundaudiomanager.onPrev | Monitorar eventos de cliques do usuário no painel de reprodução de música do sistema para a ação 'anterior' - isso é, para a música anterior (apenas iOS) | 1.0.0 | |
| backgroundaudiomanager.onSeeked | Monitorar evento o qual o áudio de fundo inicia operação de pular áudio | 1.0.0 | |
| backgroundaudiomanager.onSeeking | Monitorar eventos de ações de navegação quando a reprodução de áudio em segundo plano é iniciada | 1.0.0 | |
| backgroundaudiomanager.onStop | Monitorar evento de interrupção de áudio em segundo plano | 1.0.0 | |
| backgroundaudiomanager.onTimeUpdate | Monitorar evento de atualização do progresso da reprodução de áudio em segundo plano. (Somente o miniprograma retornará a chamada quando estiver em primeiro plano) | 1.0.0 | |
| backgroundaudiomanager.onWaiting | Monitorar evento de carregamento de áudio | 1.0.0 | |
| backgroundaudiomanager.pause | Pausar música | 1.0.0 | |
| backgroundaudiomanager.play | Reproduzir música | 1.0.0 | |
| backgroundaudiomanager.seek | Pular para local especificado | 1.0.0 | |
| backgroundaudiomanager.stop | Parar música | 1.0.0 |
11.6 Áudio e vídeo em tempo real
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createLivePusherContext | Criar objeto LivePusherContext no contexto live-pusher | 1.0.0 | |
| pz.createLivePlayerContext | Criar objeto LivePlayer context no contexto live-player | 1.0.0 |
11.6.1 LivePlayerContext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| LivePlayerContext.exitFullScreen | Sair do modo de tela cheia | 1.0.0 | |
| LivePlayerContext.exitPictureInPicture | Sair da janela (pode ser aberta em qualquer outra página) | 1.0.0 | |
| LivePlayerContext.mute | Mutar | 1.0.0 | |
| LivePlayerContext.pause | Pausar | 1.0.0 | |
| LivePlayerContext.play | Reproduzir | 1.0.0 | |
| LivePlayerContext.requestFullScreen | Abrir em modo de tela cheia | 1.0.0 | |
| LivePlayerContext.requestPictureInPicture | Abrir janela | 1.0.0 | |
| LivePlayerContext.resume | Restaurar | 1.0.0 | |
| LivePlayerContext.snapshot | Capturar tela | 1.0.0 | |
| LivePlayerContext.stop | Parar | 1.0.0 |
11.6.2 LivePusherContext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| LivePusherContext.exitPictureInPicture | Sair da janela (pode ser aberta em qualquer outra página) | 1.0.0 | |
| LivePusherContext.pause | Pausar transmissão | 1.0.0 | |
| LivePusherContext.pauseBGM | Pausar som de fundo | 1.0.0 | |
| LivePusherContext.playBGM | Reproduzir som de fundo | 1.0.0 | |
| LivePusherContext.resume | Restaurar transmissão | 1.0.0 | |
| LivePusherContext.resumeBGM | Restaurar som de fundo | 1.0.0 | |
| LivePusherContext.sendMessage | Enviar mensagem SEI | 1.0.0 | |
| LivePusherContext.setBGMVolume | Definir volume de fundo | 1.0.0 | |
| LivePusherContext.setMICVolume | Definir volume de microfone | 1.0.0 | |
| LivePusherContext.snapshot | Snapshot (imagem instantânea) | 1.0.0 | |
| LivePusherContext.start | Começar transmissão enquanto ativa a visualização da câmera | 1.0.0 | |
| LivePusherContext.startPreview | Ativar visualização da câmera | 1.0.0 | |
| LivePusherContext.stop | Interromper transmissão enquanto interrompe visualização da câmera | 1.0.0 | |
| LivePusherContext.stopBGM | Parar som de fundo | 1.0.0 | |
| LivePusherContext.stopPreview | Desativar visualização da câmera | 1.0.0 | |
| LivePusherContext.switchCamera Câmera | Alternar câmeras frontal e traseira | 1.0.0 | |
| LivePusherContext.toggleTorch | Alternar laternas | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| LivePusherContext.createOffscreenCanvas | Criar Canvas fora da tela que possa aceitar a coleção de texturas do LivePusher |
| LivePusherContext.onCustomRendererEvent | Ao ativar a renderização personalizada, os desenvolvedores podem assinar eventos relacionados por meio deste método |
11.7 Gravação de som
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopRecord | Parar gravação | 1.0.0 | |
| pz.startRecord | Iniciar gravação | 1.0.0 | |
| pz.getRecorderManager | Obter gerenciador de gravação exclusivo global RecorderManager | 1.0.0 |
11.7.1 RecorderManager
| Nome | Função | Versões | Observações |
|---|---|---|---|
| RecorderManager.onError | Monitorar eventos de erro de gravação | 1.0.0 | |
| RecorderManager.onFrameRecorded | Monitorar eventos que finalizaram a gravação de um tamanho especificado de arquivo | 1.0.0 | |
| RecorderManager.onInterruptionBegin | Monitorar evento o qual a gravação foi interrompida devido à ocupação do sistema | 1.0.0 | |
| RecorderManager.onInterruptionEnd | Monitar evento de término da interrupção da gravação | 1.0.0 | |
| RecorderManager.onPause | Monitorar evento de pausa | 1.0.0 | |
| RecorderManager.onResume | Monitorar evento o qual a gravação continua | 1.0.0 | |
| RecorderManager.onStop | Monitorar evento de término da gravação | 1.0.0 | |
| RecorderManager.pause | Pausar gravação | 1.0.0 | |
| RecorderManager.resume | Continuar reprodução | 1.0.0 | |
| RecorderManager.onStart | Monitorar evento de iniciação da gravação | 1.0.0 | |
| RecorderManager.stop | Parar gravação | 1.0.0 | |
| RecorderManager.start | Iniciar gravação | 1.0.0 |
11.8 Câmera
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createCameraContext | Criar objeto CameraContext no contexto da câmera | 1.0.0 |
11.8.1 CAMERACONTEXT
| Nome | Função | Versões | Observações |
|---|---|---|---|
| CameraContext.onCameraFrame | Obter dados da câmera em tempo real | 1.0.0 | |
| CameraContext.setZoom | Definir ampliação do zoom | 1.0.0 | |
| CameraContext.startRecord | Iniciar gravação | 1.0.0 | |
| CameraContext.stopRecord | Finalizar vídeo | 1.0.0 | |
| CameraContext.takePhoto | Tirar fotos | 1.0.0 |
11.8.2 Cameraframelistener
| Nome | Função | Versões | Observações |
|---|---|---|---|
| CameraFrameListener.start | Iniciar monitoramento do quadro de dados | 1.0.0 | |
| CameraFrameListener.stop | Interromper monitoramento do quadro de dados | 1.0.0 |
11.9 Rich Text
11.9.1 EditorContext
| Nome | Função | Versões | Observações |
|---|---|---|---|
| EditorContext.blur | Desfocar editor enquanto retrai teclado | 1.0.0 | |
| EditorContext.clear | Limpar conteúdo do editor | 1.0.0 | |
| EditorContext.format | Modificar formato | 1.0.0 | |
| EditorContext.getContents | Obter conteúdo do editor | 1.0.0 | |
| EditorContext.getSelectionText | Obter conteúdo de texto simples na área selecionada do editor | 1.0.0 | |
| EditorContext.insertDivider | Inserir linha de divisão | 1.0.0 | |
| EditorContext.insertImage | Inserir imagem | 1.0.0 | |
| EditorContext.insertText | Substituir seleção atual e definir um texto | 1.0.0 | |
| EditorContext.redo | Restaurar | 1.0.0 | |
| EditorContext.removeFormat | Limpar formato da seleção atual | 1.0.0 | |
| EditorContext.scrollIntoView | Arrastar cursor do editor para dentro da área da janela | 1.0.0 | |
| EditorContext.setContents | Inicializar conteúdo do editor, delta entra em vigor somente quando HTML e delta coexistem | 1.0.0 | |
| EditorContext.undo | Desfazer | 1.0.0 |
11.10 Síntese de áudio e vídeo
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.createMediaContainer | Criar container de processamento de áudio e vídeo, o qual pode combinar as faixas do container em um vídeo |
11.10.1 MediaContainer
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MediaContainer.addTrack | Adicionar faixa de áudio ou vídeo ao container |
| MediaContainer.destroy | Destruir contêiner e liberar recursos |
| MediaContainer.export | Mesclar faixas dentro do container e exportar arquivo de vídeo |
| MediaContainer.extractDataSource | Desanexar da faixa os rescursos do vídeo recebido |
| MediaContainer.removeTrack | Remover áudio ou vídeo do container |
| MediaTrack | Pode ser retornado via MediaContainer.extractDataSource |
11.11 Chamada de voz em tempo real
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.updateVoIPChatMuteConfig | Atualizar configurações de mutar chamada de voz em tempo real |
| pz.subscribeVoIPVideoMembers | Inscrever-se como membro de vídeo |
| pz.setEnable1v1Chat | Iniciar chamada individual (duas pessoas) |
| pz.onVoIPVideoMembersChanged | Monitorar evento de alterações do estado da chamada de voz ao vivo do membro de vídeo |
| pz.onVoIPChatStateChanged | Monitorar evento de mudança de estado da sala |
| pz.onVoIPChatSpeakersChanged | Monitorar alterações do status da chamada dos membros de chamada de voz em tempo real |
| pz.onVoIPChatMembersChanged | Monitorar evento de alterações do status de membros de chamada de voz online |
| pz.offVoIPChatSpeakersChanged | Remover monitoramento do evento de mudança de status na chamada de membros de chamada de voz em tempo real |
| pz.onVoIPChatInterrupted | Monitorar evento de desconexão passiva de chamadas de voz em tempo real |
| pz.offVoIPVideoMembersChanged | Cancelar monitoramento do evento de alterações da chamada de voz de membros do vídeo |
| pz.offVoIPChatStateChanged | Cancelar monitoramento de alterações do status da sala |
| pz.offVoIPChatMembersChanged | Cancelar monitoramento de alterações de status on-line do membro da chamada de voz em tempo real |
| pz.offVoIPChatInterrupted | Cancelar monitoramento da desconexão passiva de chamadas de voz em tempo real |
| pz.joinVoIPChat | Entrar (criar) chamadas de voz em tempo real. Mais informações podem ser encontradas no guia de chamada de voz em tempo real |
| pz.exitVoIPChat | Sair (destruir) chamada de voz em tempo real |
| pz.join1v1Chat | Entrar (criar) chamada individual (duas pessoas) |
11.12 Gravador de tela
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createMediaRecorder | Criar gravador de tela WebGL, pode ser gravado frame por frame de imagens renderizadas em WebGL e exportar arquivos de vídeo | 1.0.0 |
11.12.1 Mediarecorder
| Nome | Função | Versões | Observações |
|---|---|---|---|
| MediaRecorder.pause | Pausar gravação | 1.0.0 | |
| MediaRecorder.resume | Retomar gravação | 1.0.0 | |
| MediaRecorder.start | Iniciar gravação | 1.0.0 | |
| MediaRecorder.stop | Parar gravação | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MediaRecorder.destroy | Destruir gravador |
| MediaRecorder.off | Cancelar monitoramento de eventos de gravação |
| MediaRecorder.on | Registers callback functions for listening to recorded events |
| MediaRecorder.requestFrame | Solicitar gravação do frame seguinte e começar a gravar o frame atual após concluir a renderização de um frame no retorno de chamada |
11.13 Decodificador de vídeo
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.createVideoDecoder | Crie um decodificador de vídeo (pode recuperar dados decodificados frame por frame) |
11.13.1 Videodecoder
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| VideoDecoder.getFrameData | Obter dados do decodificador para o frame seguinte |
| VideoDecoder.off | Cancelar monitoramento de eventos de gravação |
| VideoDecoder.on | Registrar |
| VideoDecoder.remove | Remover decodificador |
| VideoDecoder.seek | Salte para um determinado momento para decodificar |
| VideoDecoder.start | Iniciar decodificação |
| VideoDecoder.stop | Parar decodificação |
12. Localização
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.openLocation | Verificar localização usando mapa interno | 1.0.0 | |
| pz.startLocationUpdate | Receber mensagens de localização ao abrir o miniprograma e entrar no front-end | 1.0.0 | |
| pz.getLocation | Obtenha localização geográfica atual e velocidade | 1.0.0 | |
| pz.choosePoi | Abra lista POI para selecionar local; suporta posicionamento difuso (preciso para cidade) e posicionamento preciso | 2.12.1 | |
| pz.chooseLocation | Abrir mapa e selecionar local | 1.0.0 | |
| pz.stopLocationUpdate | Parar monitoramento de alterações de localização em tempo real, ambos front-end e back-end param de receber notificação | 3.0.18 | |
| pz.startLocationUpdateBackground | Ao abrir o miniprograma, tanto front-end quanto back-end recebem mensagens de localização e os usuários precisam ser orientados para habilitar a autorização | 3.0.18 | |
| pz.onLocationChange | Monitorar eventos de alteração de localização geográfica em tempo real, usar em conjunto com pz.startLocationUpdateBackground e pz.startLocationUpdate | 3.0.18 | |
| pz.offLocationChange | Cancelar monitoramento | 3.0.18 | |
| pz.onLocationChangeError | Monitorar evento disparado quando a interface de localização contínua retorna uma falha | 3.0.18 | |
| pz.offLocationChangeError | Parar monitoramento de evento disparado quando a interface de localização contínua retorna uma falha | 3.0.18 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| getFuzzyLocation | Obter atual localização geográfica estimada |
13. Arquivo
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.saveFile | Salvar arquivos localmente | 1.0.0 | |
| pz.removeSavedFile | Excluir cache local do arquivo | 1.0.0 | |
| pz.openDocument | Abrir documento em nova página | 1.0.0 | |
| pz.getSavedFileList | Obter lista de arquivos de cache local salvos no MiniApp (PhizClip) | 1.0.0 | |
| pz.getSavedFileInfo | Obter arquivo de informações de arquivos locais | 1.0.0 | |
| pz.getFileSystemManager | Obter gerenciador de arquivos global exclusivo | 1.0.0 | |
| pz.getFileInfo | Obter informações de arquivo | 1.0.0 | |
| pz.saveFileToDisk | Salvar arquivos do sistema de arquivos no disco local do usuário, suportado apenas na interface do PC | 1.0.0 |
13.1 FileSystemManager
| Nome | Função | Versões | Observações |
|---|---|---|---|
| FileSystemManager.accessSync | Determinar se o arquivo/diretório existe | 1.0.0 | |
| FileSystemManager.access | Determinar se o arquivo/diretório existe | 1.0.0 | |
| FileSystemManager.appendFile | Anexar conteúdo ao final do arquivo | 1.0.0 | |
| FileSystemManager.appendFileSync | Versão síncrona de FileSystemManager.appendFile | 1.0.0 | |
| FileSystemManager.close | Fechar arquivo | 1.0.0 | |
| FileSystemManager.closeSync | Fechar arquivos de forma síncrona | 1.0.0 | |
| FileSystemManager.copyFile | Copiar arquivo | 1.0.0 | |
| FileSystemManager.copyFileSync | Versão síncrona de FileSystemManager.copyFile | 1.0.0 | |
| FileSystemManager.getFileInfo | Obter informações de arquivos temporários locais ou cache local do MiniApp (PhizClip) | 1.0.0 | |
| FileSystemManager.getSavedFileList | Obter lista de arquivos de cache local salvos no MiniApp (PhizClip) | 1.0.0 | |
| FileSystemManager.mkdir | Criar diretório | 1.0.0 | |
| FileSystemManager.mkdirSync | Versão síncrona de FileSystemManager.mkdir | 1.0.0 | |
| FileSystemManager.readdir | Ler lista de arquivos do diretório | 1.0.0 | |
| FileSystemManager.readdirSync | Versão síncrona de FileSystemManager.readdir | 1.0.0 | |
| FileSystemManager.readFile | Ler conteúdo de arquivo local | 1.0.0 | |
| FileSystemManager.readFileSync | Versão síncrona de FileSystemManager.readFile | 1.0.0 | |
| FileSystemManager.removeSavedFile | Excluir arquivo de cache salvo no MiniApp (PhizClip) | 1.0.0 | |
| FileSystemManager.reNome | Renomear arquivo | 1.0.0 | |
| FileSystemManager.reNomeSync | Versão síncrona de FileSystemManager.rename | 1.0.0 | |
| FileSystemManager.rmdir | Excluir diretório | 1.0.0 | |
| FileSystemManager.rmdirSync | Versão síncrona de FileSystemManager.rmdir | 1.0.0 | |
| FileSystemManager.saveFile | Salvar arquivos temporários localmente | 1.0.0 | |
| FileSystemManager.saveFileSync | Versão síncrona de FileSystemManager.saveFile | 1.0.0 | |
| FileSystemManager.state | Obter objeto Stats do arquivo | 1.0.0 | |
| FileSystemManager.statSync | Versão síncrona de FileSystemManager.State | 1.0.0 | |
| FileSystemManager.unlink | Excluir arquivo | 1.0.0 | |
| FileSystemManager.unlinkSync | Versão síncrona de FileSystemManager.unlink | 1.0.0 | |
| FileSystemManager.unzip | Descompactar arquivo | 1.0.0 | |
| FileSystemManager.writeFile | Escrever arquivo | 1.0.0 | |
| FileSystemManager.writeFileSync | Versão síncrona FileSystemManager.writeFile | 1.0.0 | |
| FileSystemManager.write | Escrever arquivo | 1.0.0 | |
| FileSystemManager.writeSync | Versão síncrona de FileSystemManager.writeFile | 1.0.0 | |
| FileSystemManager.fstat | Obter informações de status do arquivo | 1.0.0 | |
| FileSystemManager.fstatSync | Obter informações de status de arquivos de forma síncrona | 1.0.0 | |
| FileSystemManager.ftruncate | Truncar conteúdo do arquivo | 1.0.0 | |
| FileSystemManager.ftruncateSync | Truncar conteúdo do arquivo | 1.0.0 | |
| FileSystemManager.open | Abrir arquivo e retonar ao descritor de arquivo | 1.0.0 | |
| FileSystemManager.openSync | Abrir arquivo de forma síncrona e retornar ao descritor do arquivo | 1.0.0 | |
| FileSystemManager.read | Ler arquivos | 1.0.0 | |
| FileSystemManager.readCompressedFile | Ler conteúdo do arquivo local com tipo de compactação especificado | 1.0.0 | |
| FileSystemManager.readCompressedFileSync | Ler sincronamente o conteúdo de um arquivo local de um tipo de compressão específico | 1.0.0 | |
| FileSystemManager.readSync | Ler arquivo | 1.0.0 | |
| FileSystemManager.readZipEntry | Ler arquivo do zip | 1.0.0 | |
| FileSystemManager.truncate | Realizar uma operação de truncamento no conteúdo do arquivo | 1.0.0 | |
| FileSystemManager.truncateSync | Realizar operação de truncamento no conteúdo do arquivo (versão síncrona de Truncate) | 1.0.0 | |
| ReadResult | Resultado da leitura do arquivo | 1.0.0 |
13.2 Estatísticas
| Nome | Função | Versões | Observações |
|---|---|---|---|
| Stats.isDirectory | Verificar se o arquivo atual é um diretório | 1.0.0 | |
| Stats.isFile | Verificar se o arquivo atual é um arquivo comum | 1.0.0 | |
| WriteResult | Resultado de gravação do arquivo. | 1.0.0 |
14. API
14.1 Login
Por favor, note que:
- As APIs a seguir requerem integração com a extensão SDK ou exigem que o aplicativo implemente os métodos de proxy correspondentes.
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.login | Invocar interface para obter credenciais de login (code) | 1.0.0 | |
| pz.checkSession | Verificar se o status de login expirou | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.pluginLogin | Esta interface só pode ser invocada em plug-ins de miniprogramas；invocar a interface para obter credenciais de identidade do usuário do plug-in (code) |
14.2 Informações da conta
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getAccountInfoSync | Obter informações sobre a conta atual | 1.0.0 |
14.3 Informações do usuário
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getUserProfile | Obter informações do usuário | 1.0.0 | Observe que o uso desta API requer a integração do SDK de extensão Phiz |
| pz.getUserInfo | Acessar informações do usuário | 1.0.0 | Observe que o uso desta API requer que o aplicativo implemente um método de proxy |
| UserInfo | Informações do usuário | 1.0.0 |
14.4 Autorizações
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.authorize | Solicitar autorização do usuário antecipadamente | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.authorizeForMiniProgram | Somente invocar essa interface dentro de um plug-in de miniaplicativo；uso é semelhante ao pz.authorize |
14.5 Configurações
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.openSetting | Iniciar a interface de configurações do miniaplicativo do cliente e retornar o resultado das configurações do usuário | 1.0.0 | |
| pz.getSetting | Obter configurações atuais do usuário | 1.0.0 | |
| AuthSetting | Informações de autorização do usuário；consulte permissões para obter detalhes | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| SubscriptionsSetting | Configurações de informações de inscrições |
14.6 Endereço de entrega
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.chooseAddress | Obter endereço de entrega do usuário |
14.7 Cupons
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.openCard | Visualizar cupons do pacote de cartões do Phiz |
| pz.addCard | Adicionar cupons em lote |
14.8 Fatura
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.chooseInvoiceTitle | Selecionar cabeçalho da nota fiscal do usuário |
| pz.chooseInvoice | Selecionar notas fiscais existentes do usuário |
14.9 Verificação biométrica
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.startSoterAuthentication | Iniciar verificação biométrica SOTER |
| pz.checkIsSupportSoterAuthentication | Obter métodos de autenticação biométrica SOTER suportados pela máquina |
| pz.checkIsSoterEnrolledInDevice | Interface que obtem notificações se informações biométricas, como impressões digitais, foram inseridas no dispositivo |
14.10 Phiz Run
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.shareToWeRun | Compartilhar dados com o PhizRun |
| pz.getWeRunData | Obter o número de passos do PhizRun do usuário nos últimos 30 dias |
14.11 Mensagem de assinatura
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.requestSubscribeMessage | Iniciar a interface de subscrição de mensagens do miniprograma (PhizClip) cliente, e retornar resultado das ações de subscrição do usuário |
| pz.requestSubscribeDeviceMessage | Inscrever a interface de notificações do dispositivo, e após invocar, será exibida uma caixa de autorização |
14.12 envelopes vermelhos do Phiz
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.showRedPackage | Utilizar H5 para receber capa do envelope vermelho (red packet) |
14.13 Coleção
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.addVideoToFavorites | Favoritar vídeos |
| pz.addFileToFavorites | Favoritar documentos |
14.14 Placa
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.chooseLicensePlate | Selecionar número da placa |
14.15 Canais
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.reserveChannelsLive | Programar Canais (Channels) para transmissão ao vivo |
| pz.openChannelsUserProfile | Abrir página inicial do Canais (Channels) |
| pz.openChannelsEvent | Abrir página de atividades do Canais (Channels) |
| pz.openChannelsLive | Abrir transmissão ao vivo do Canais (Channels) |
| pz.getChannelsShareKey | Obter fonte de compartilhamento do cartão de transmissão ao vivo/cartão de vídeo do Canais (Channels) |
| pz.openChannelsActivity | Abrir vídeo do Canais (Channels) |
| pz.getChannelsLiveNoticeInfo | Obter informações de visualizações de transmissão ao vivo do Canais |
| pz.getChannelsLiveInfo | Obter informações de transmissão ao vivo do Canais (Channels) |
14.16 Grupo Phiz
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getGroupEnterInfo | Obter informações de aberturar de miniprogramas dentro de bate-papos em grupo |
14.17 Atendimento ao cliente do Phiz
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.openCustomerServiceChat | Abrir atendimento ao cliente do Phiz |
15. Equipamento
15.1 Bluetooth- Universal
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopBluetoothDevicesDiscovery | Pare de procurar periféricos de Bluetooth nas proximidades | 1.0.0 | |
| pz.startBluetoothDevicesDiscovery | Comece a procurar periféricos Bluetooth nas proximidades | 1.0.0 | |
| pz.openBluetoothAdapter | Inicializando o módulo Bluetooth | 1.0.0 | |
| pz.onBluetoothDeviceFound | Ouça eventos que pesquisem novos dispositivos | 1.0.0 | |
| pz.onBluetoothAdapterStateChange | Monitore o evento de mudança de estado do adaptador Bluetooth | 1.0.0 | |
| pz.offBluetoothDeviceFound | Cancelar ouvindo eventos que encontram novos dispositivos | 1.0.0 | |
| pz.offBluetoothAdapterStateChange | UNLISTEN para eventos do estado do adaptador Bluetooth | 1.0.0 | |
| pz.makeBluetoothPair | Interface de emparelhamento Bluetooth, apenas Android | 1.0.0 | |
| pz.getConnectedBluetoothDevices | De acordo com o serviço mestre uuid, obtenha dispositivos Bluetooth conectados | 1.0.0 | |
| pz.getBluetoothDevices | Obtenha todos os dispositivos Bluetooth Searchd durante o módulo Bluetooth ativo | 1.0.0 | |
| pz.getBluetoothAdapterState | Obter o estado do adaptador Bluetooth do dispositivo atual | 1.0.0 | |
| pz.closeBluetoothAdapter | Fechar módulo Bluetooth | 1.0.0 |
15.2 Dispositivos centrais BLE
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.writeBLECharacteristicValue | Escrever dados binários no autovalor do dispositivo BLE | 1.0.0 | |
| pz.setBLEMTU | Negociar definição da Unidade Máxima de Transmissão (MTU) do BLE | 1.0.0 | |
| pz.readBLECharacteristicValue | Ler dados binários no autovalor do dispositivo BLE | 1.0.0 | |
| pz.onBLEConnectionStateChange | Monitorar eventos de mudança no estado de conexão em dispositivos BLE | 1.0.0 | |
| pz.onBLECharacteristicValueChange | Monitorar evento de mudança no autovalor do BLE | 1.0.0 | |
| pz.offBLEConnectionStateChange | Cancelar monitoramento de eventos de mudança no estado de conexão BLE | 1.0.0 | |
| pz.offBLECharacteristicValueChange | Cancelar monitoramento de eventos de mudança no autovalor do BLE | 1.0.0 | |
| pz.notifyBLECharacteristicValueChange | Habilitar função de notificação para mudanças no autovalor do BLE e subscrever propriedades (características) | 1.0.0 | |
| pz.getBLEDeviceServices | Obter todos os serviços de dipositivos BLE (service) | 1.0.0 | |
| pz.getBLEDeviceRSSI | Obter intensidade do sinal (RSSI) de dispositivos BLE | 1.0.0 | |
| pz.getBLEDeviceCharacteristics | Obter todas as características de um serviço de dispositivo BLE | 1.0.0 | |
| pz.createBLEConnection | Conectar dispositivo BLE | 1.0.0 | |
| pz.closeBLEConnection | Desconectar dispositivo BLE | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.isBluetoothDevicePaired | Usado para verificar se o dispositivo Bluetooth foi pareado (suportado apenas por Android) |
| pz.onBLEMTUChange | Monitorar eventos de mudança na Unidade Máxima de Transmissão (MTU) do BLE (apenas Android) |
| pz.offBLEMTUChange | Remover função de monitoramento da Unidade Máxima de Transmissão (MTU) do BLE |
| pz.getBLEMTU | Obter Unidade Máxima de Transmissão (MTU) do BLE |
15.3 Bluetooth- Periférico de baixa potência
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.onBLEPeripheralConnectionStateChanged | Obter eventos de conexão ou desconexão de dispositivos próximos | 1.0.0 | |
| pz.offBLEPeripheralConnectionStateChanged | Cancelar monitoramento de eventos de conexão ou desconexão de dispositivos próximos | 1.0.0 | |
| pz.createBLEPeripheralServer | Configurar servidor de dispositivos BLE locais próximos (podem ser criados mais de um) | 1.0.0 |
15.3.1 BlePeriferalver
| Nome | Função | Versões | Observações |
|---|---|---|---|
| BLEPeripheralServer.addService | Adicionar serviço. | 1.0.0 | |
| BLEPeripheralServer.close | Fechar o servidor atual | 1.0.0 | |
| BLEPeripheralServer.offCharacteristicReadRequest | Cancelar monitoramento de eventos de solicitações de dispositivos conectados para ler os autovalores do dispositivo periférico atual | 1.0.0 | |
| BLEPeripheralServer.offCharacteristicSubscribed | Cancelar monitoramento de eventos de subscrição de autovalores | 1.0.0 | |
| BLEPeripheralServer.offcharacteristicUnsubscribed | Cancelar monitoramento de solicitações de dispositivos conectados para escrever autovalores dos dispositivos próximos | 1.0.0 | |
| BLEPeripheralServer.offCharacteristicWriteRequest | Cancelar monitoramento eventos de solicitações de dispositivos conectados para escrever autovalor de dispositivos próximos | 1.0.0 | |
| BLEPeripheralServer.onCharacteristicReadRequest | Monitorar eventos de solicitações de dispositivos conectados para leitura do autovalor de dispositivos próximos | 1.0.0 | |
| BLEPeripheralServer.onCharacteristicSubscribed | Monitorar eventos de inscrição de autovalor (suportado apenas por iOS) | 1.0.0 | |
| BLEPeripheralServer.onCharacteristicUnsubscribed | Monitorar eventos de cancelamento da inscrição do autovalor (suportado apenas por iOS) | 1.0.0 | |
| BLEPeripheralServer.onCharacteristicWriteRequest | Cancelar monitoramento eventos de solicitações de dispositivos conectados para escrever autovalor de dispositivos próximos | 1.0.0 | |
| BLEPeripheralServer.removeService | Remover serviço | 1.0.0 | |
| BLEPeripheralServer.startAdvertising | Iniciar transmissão de dispositivos periféricos criados localmente | 1.0.0 | |
| BLEPeripheralServer.stopAdvertising | Interromper transmissão | 1.0.0 | |
| BLEPeripheralServer.writeCharacteristicValue | Escrever dados em um valor de característica específico e notificar o host conectado que o valor da característica do cliente foi alterado. A interface lidará com o uso da resposta de pacote ou assinatura. | 1.0.0 |
15.4 Bluetooth-Beacons (Beacon)
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopBeaconDiscovery | Parar de buscar dispositivos Beacon próximos | 1.0.0 | |
| pz.startBeaconDiscovery | Iniciar busca de dispositivos Beacon próximos | 1.0.0 | |
| pz.onBeaconUpdate | Monitorar atualização de dispositivo Beacon (pode ser registrada apenas uma escuta do monitoramento) | 1.0.0 | |
| pz.onBeaconServiceChange | Monitorar eventos de mudança no estado do serviço Beacon (service) | 1.0.0 | |
| pz.offBeaconUpdate | Parar monitoramento de atualizações de dispositivos Beacon | 1.0.0 | |
| pz.offBeaconServiceChange | Parar monitoramento de eventos de mudança no estado do serviço Beacon (service) | 1.0.0 | |
| pz.getBeacons | Obter todos os dispositivos Beacon já encontrados | 1.0.0 | |
| BeaconInfo | Dispositivos Beacon | 1.0.0 |
15.5 NFC
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.stopHCE | Parar módulo NCF |
| pz.startHCE | Inicializar módulo |
| pz.sendHCEMessage | Enviar mensagem NFC |
| pz.onHCEMessage | Monitorar evento de recebimento de mensagens de dipositivos NFC, cancelar monitoramento do evento |
| pz.offHCEMessage | Receber eventos de mensagens de dispositivos NFC, pode ser registrado apenas um monitorador |
| pz.getNFCAdapter | Criar instância NFC |
| pz.getHCEState | Determinar se o dispositivo atual suporta a capacidade HCE |
15.5.1 ISODEP
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| IsoDep.close | Desconectar |
| IsoDep.connect | Conectar tag NCF |
| IsoDep.getHistoricalBytes | Obter informações de reset |
| IsoDep.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| IsoDep.isConnected | Checar se já foi conectado |
| IsoDep.setTimeout | Configurar tempo limite |
| IsoDep.transceive | Enviar dados |
15.5.2 Mifareclassic
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MifareClassic.close | Desconectar |
| MifareClassic.connect | Conectar tag NFC |
| MifareClassic.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| MifareClassic.isConnected | Checar se já foi conectado |
| MifareClassic.setTimeout | Configurar tempo limite |
| MifareClassic.transceive | Enviar dados |
15.5.2 Mifareultralight
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| MifareUltralight.close | Desconectar |
| MifareUltralight.connect | Conectar tag NFC |
| MifareUltralight.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| MifareUltralight.isConnected | Checar se já foi conectado |
| MifareUltralight.setTimeout | Configurar tempo limite |
| MifareUltralight.transceive | Enviar dados |
15.5.3 Ndef
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| Ndef.close | Desconectar |
| Ndef.connect | Conectar tag NFC |
| Ndef.isConnected | Checar se já foi conectado |
| Ndef.offNdefMessage | Parar monitoramento de messagens Ndef |
| Ndef.onNdefMessage | Monitorar messagens Ndef |
| Ndef.setTimeout | Configurar tempo limite |
| Ndef.writeNdefMessage | Reescrever conteúdo da tag Ndef |
15.5.4 NFCA
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| NfcA.close | Desconectar |
| NfcA.connect | Conectar tag NFC |
| NfcA.getAtqa | Obter informações de ATQA |
| NfcA.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| NfcA.getSak | Obter informações SAK |
| NfcA.isConnected | Checar se já foi conectado |
| NfcA.setTimeout | Configurar tempo limite |
| NfcA.transceive | Enviar dados |
15.5.5 NFCADAPTER
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| NFCAdapter.getIsoDep | Obter instância IsoDep (a instância suporta gravação (escrita) e leitura em ISO-DEP (ISO 14443-4)) |
| NFCAdapter.getMifareClassic | Obter instância MIfareClassic (a instância suporta gravação (escrita) e leitura em tag MIFARE Classic) |
| NFCAdapter.getMifareUltralight | Obter instância MifareClassic (a instância suporta gravação (escrita) e leitura em MIFARE Ultralight) |
| NFCAdapter.getNdef | Obter instância Ndef (a instância suporta gravação (escrita) e leitura de dados NDF em tags NFC com formato NDEF) |
| NFCAdapter.getNfcA | Obter instância NfcA (a instância suporta gravação (escrita) e leitura no padrão NFC-A (ISO 14443-3A)) |
| NFCAdapter.getNfcB | Obter instância NfcB (a instância suporta gravação (escrita) e leitura no padrão NFC-B (ISO 14443-3B)) |
| NFCAdapter.getNfcF | Obter instância NfcF (a instância suporta gravação (escrita) e leitura no padrão NFC-F (JIS 6319-4)) |
| NFCAdapter.getNfcV | Obter instância NfcF (a instância suporta gravação (escrita) e leitura no padrão NFC-F (JIS 6319-4)) |
| NFCAdapter.offDiscovered | Cancelar monitoramento da tag NFC |
| NFCAdapter.onDiscovered | Monitorar tag NFC |
| NFCAdapter.startDiscovery | |
| NFCAdapter.stopDiscovery |
15.5.6 NFCB
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| NfcB.close | Desconectar |
| NfcB.connect | Conectar tag NFC |
| NfcB.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| NfcB.isConnected | Checar se já foi conectado |
| NfcB.setTimeout | Configurar tempo limite |
| NfcB.transceive | Enviar dados |
15.5.7 NFCF
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| NfcF.close | Desconectar |
| NfcF.connect | Conectar tag NCF |
| NfcF.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| NfcF.isConnected | Checar se já foi conectado |
| NfcF.setTimeout | Configurar tempo limite |
| NfcF.transceive | Enviar dados |
15.5.7 NFCV
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| NfcV.close | Desconectar |
| NfcV.connect | Conectar tag NCF |
| NfcV.getMaxTransceiveLength | Obter Unidade Máxima de Transmissão (MTU) |
| NfcV.isConnected | Checar se já foi conectado |
| NfcV.setTimeout | Configurar tempo limite |
| NfcV.transceive | Enviar dados |
15.6 Wi-Fi
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.stopWifi | Desativar módulo Wi-Fi |
| pz.startWifi | Inicializar módulo Wi-Fi |
| pz.setWifiList | Configurar informações relacionadas ao AP (Ponto de Acesso) da lista de Wi-Fi |
| pz.onWifiConnected | Monitorar eventos de conexão de Wi-Fi |
| pz.onGetWifiList | Monitorar eventos de obtenção de dados da lista Wi-Fi |
| pz.getWifiList | Solicitar obtenção de lista Wi-Fi |
| pz.getConnectedWifi | Obter informações do Wi-Fi conectado |
| pz.connectWifi | Conectar Wi-Fi |
| pz.onWifiConnectedWithPartialInfo | Monitorar evento de conexão do Wi-fi |
| pz.offWifiConnectedWithPartialInfo | Remover função de monitoramento do evento de conexão do Wi-Fi |
| pz.offWifiConnected | Cancelar monitoramento de eventos de conexão Wi-Fi |
| pz.offGetWifiList | Cancelar monitoramento de eventos de obtenção de dados da lista Wi-Fi |
| WifiInfo | Informações de Wi-Fi |
15.7 Calendário
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.addPhoneRepeatCalendar | Adicionar eventos recorrentes ao calendário do sistema |
| pz.addPhoneCalendar | Adicionar evento ao calendário |
15.8 Contatos
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.addPhoneContact | Adiconar contato da agenda telefônica | 1.0.0 | |
| pz.chooseContact | Abrir lista de contatos do telefone e escolher contato | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.searchContacts | Buscar nos contatos e combinar números de telefones semelhantes |
15.9 Acessibilidade
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.checkIsOpenAccessibility | Verificar se função de acessibilidade visual está ativada | 2.12.1 |
15.10 Bateria
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getBatteryInfoSync | Versão síncrona de pz.getBatteryInfo | 1.0.0 | |
| pz.getBatteryInfo | Obter nível de bateria do dispositivo | 1.0.0 |
15.11 Área de transferência
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.setClipboardData | Definir conteúdo da área de transferência do sistema | 1.0.0 | |
| pz.getClipboardData | Obter conteúdo da área de transferência do sistema | 1.0.0 |
15.12 Rede
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.onNetworkStatusChange | Monitorar evento de mudança de estado da rede | 1.0.0 | |
| pz.offNetworkStatusChange | Cancelar monitoramento de eventos de mudança no estado da internet；se o parâmetro estiver vazio, todos os monitoramentos de eventos são cancelados | 1.0.0 | |
| pz.getNetworkType | Obter tipo de rede | 1.0.0 |
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.onNetworkWeakChange | Monitorar eventos de mudança de estado em sinal Wi-Fi fraco |
| pz.getLocalIPAddress | Obter endereço IP da rede local (LAN) |
| pz.offNetworkWeakChange | Remover função de monitoramento em eventos de mudança de estado de sinal Wi-Fi fraco |
15.13 Criptografia
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.getRandomValues | Obter números aleatórios criptografados | 1.0.0 |
15.14 Tela
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.setVisualEffectOnCapture | Definir desempenho da tela durante captura/gravação da tela (suportada chamada somente em Android) | 2.12.16 | |
| pz.setScreenBrightness | Definir brilho da tela | 1.0.0 | |
| pz.setKeepScreenOn | Definir se brilho da tela nunca apaga | 1.3.9 | |
| pz.onUserCaptureScreen | Monitorar evento de capturas de tela feitas pelo usuário | 1.0.0 | |
| pz.onScreenRecordingStateChanged | Monitorar eventos de gravação de tela feitas pelo usuário (somente iOS) | 2.12.16 | |
| pz.offUserCaptureScreen | Eventos de gravação de tela feita pelo usuário | 1.0.0 | |
| pz.offScreenRecordingStateChanged | Remover função de monitoramento em eventos de gravação de tela do usuário | 2.12.16 | |
| pz.getScreenRecordingState | Checar se o usuário está gravando a tela | 2.12.16 | |
| pz.getScreenBrightness | Obter nível de brilho da tela | 1.0.0 |
15.15 Teclado
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.onKeyboardHeightChange | Monitorar alterações de altura do teclado | 1.0.0 | |
| pz.offKeyboardHeightChange | Cancelar monitoramento de eventos de mudança da altura do teclado | 1.0.0 | |
| pz.hideKeyboard | Depois de abrir o teclado com foco em input, textarea, etc, chamar manualmente a interface para fechar o teclado | 1.0.0 | |
| pz.getSelectedTextRange | Depois do foco em em input, textarea, etc, obter a posição do cursor na caixa de entrada de texto | 1.0.0 |
15.16 Telefone
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.makePhoneCall | Discar número | 1.0.0 |
15.17 Acelerômetro
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopAccelerometer | Parar monitoramento de dados de aceleração | 1.0.0 | |
| pz.startAccelerometer | Iniciar monitoramento de dados de aceleração | 1.0.0 | |
| pz.onAccelerometerChange | Monitorar dados de eventos de aceleração | 1.0.0 | |
| pz.offAccelerometerChange | Cancelar monitoramento de dados de eventos de aceleração；se o parâmetro estiver vazio, todos os monitoramentos de eventos são cancelados | 1.0.0 |
15.18 Bússola
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.stopCompass | Parar monitoramento de dados da bússola | 1.0.0 | |
| pz.startCompass | Iniciar monitoramento de dados da bússola | 1.0.0 | |
| pz.onCompassChange | Monitorar evento de mudança de dados da bússola | 1.0.0 | |
| pz.offCompassChange | Cancelar monitoramento de eventos de mudança nos dados da bússola；se o parâmetro estiver vazio, todos os monitoramentos de eventos são cancelados | 1.0.0 |
15.19 Orientação do dispositivo
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.stopDeviceMotionListening | Parar monitoramentp de mudanças de direção do dispositivo |
| pz.startDeviceMotionListening | Iniciar monitoramento de mudanças na orientação do dispositivo |
| pz.onDeviceMotionChange | Monitorar eventos de mudança de direção do dispositivo |
| pz.offDeviceMotionChange | Cancelar monitoramento de eventos de mudança na direção do dispositivo；se o parâmetro estiver vazio, todos os monitoramentos de eventos são cancelados |
15.20 Giroscópio
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.stopGyroscope | Parar monitoramento de dados do giroscópio |
| pz.startGyroscope | Iniciar monitoramento de dados do giscópio |
| pz.onGyroscopeChange | Monitorar eventos mudança de dados do giroscópio |
| pz.offGyroscopeChange | Cancelar monitoramento de eventos de mudança nos dados do giroscópio |
15.21 Memória
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.onMemoryWarning | Monitorar evento de alerta de armazenamento insuficiente |
| pz.offMemoryWarning | Cancelar monitoramento evento de alerta de armazenamento insuficiente |
15.22 Código QR
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.scanCode | Iniciar interface de leitura de código QR para realizar leitura do código | 1.0.0 |
15.23 Vibração
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.vibrateShort | Ativar vibração de curta duração (15 ms) | 1.0.0 | |
| pz.vibrateLong | Ativar vibração de longa duração (400 ms) | 1.0.0 |
15.24 SMS
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.sendSms | Iniciar interface de envio de mensagens SMS do dispostivo |
16. Ai
16.1 Algoritmo visual
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.isVKSupport | Verificar versão suportada |
| pz.createVKSession | Criar objeto da sessão Vision Kit |
| VKBodyAnchor | Anchor do corpo |
16.2 Vkcamera
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| VKCamera.getProjectionMatrix | Obter matriz da projeção |
| VKFaceAnchor | Anchor do rosto |
16.3 VKFrame
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| VKFrame.getCameraBuffer | Obter buffer RGBA do frame atual |
| VKFrame.getCameraTexture | Obter a textura do frame atual |
| VKFrame.getDisplayTransform | Obter matriz de ajuste da textura |
| VKMarkerAnchor | Anchor do marcador |
| VKOSDAnchor | OSD anchor |
| VKHandAnchor | Anchor de gestos |
| VKPlaneAnchor | Plano anchor, suportado apenas pela versão v2 |
16.4 VkSession
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| VKSession.addMarker | Adicionar um marcador, necessário que o parâmetro track.marker seja verdadeiro ao chamar pz.createVKSession |
| VKSession.addOSDMarker | Adicionar marcador OSD (one-shot detection marker), necessário que o parâmetro track.OSD seja verdadeiro ao chamar pz.createVKSession |
| VKSession.cancelAnimationFrame | Cancelar solicitações de quadro de animações agendadas por requestAnimotionFrame |
| VKSession.destroy | Destruir sessão |
| VKSession.detectFace | Detectar ponto-chave facial de imagem estática |
| VKSession.getAllMarker | Obter todos os marcadores, necessário que o parâmetro track.marker seja verdadeiro ao chamar pz.createVKSession |
| VKSession.getAllOSDMarker | Obter todos os marcadores OSD, necessário que o parâmetro track.OSD seja verdadeiro ao chamar pz.createVKSession |
| VKSession.getVKFrame | Obter frame do objeto, e cada chamada aciona um processo de análise de quadro |
| VKSession.hitTest | Detecção de toque, versão v1 suporta apenas um plano, (após a geração de plano pelo hitTest, os que vierem em sequência não gerarão novos planos, mas realizarão detecções baseadas nos planos gerados anteriormente) |
| VKSession.detectHand | Detectar pontos-chave de gestos em imagens estáticas (disponível quando o parâmetro pz.createVKSession é configurado como {track: {hand: {mode: 2}}} ) |
| VKSession.detectBody | Detectar pontos-chave de corpos em imagens estáticas (disponível quando o parâmetro pz.createVKSession é configurado como {track: {hand: {mode: 2}}} ) |
| VKSession.off | Cancelar monitoramento de eventos de sessão |
| VKSession.on | Monitorar eventos de sessão |
| VKSession.runOCR | Detectar OCR em imagens estáticas (disponível quando o parâmetro pz.createVKSession é configurado como {track: {OCR: {mode: 2}}} ) |
| VKSession.removeMarker | Remover um marcador, necessário que o parâmetro track.marker seja verdadeiro ao chamar pz.createVKSession |
| VKSession.removeOSDMarker | Remover um marcador OSD, necessário que o parâmetro track.OSD seja verdadeiro ao chamar pz.createVKSession |
| VKSession.requestAnimationFrame | Executar na próxima vez em que ocorrer redesenho |
| VKSession.start | Iniciar uma sessão |
| VKSession.stop | Finalizar uma sessão |
| VKSession.updateOSDThreshold | Atualizar a precisão de reconhecimento do OSD, necessário que o parâmetro track.OSD seja verdadeiro ao chamar pz.createVKSession |
16.5 Reconhecimento facial
Por favor, note que:
As APIs a seguir não são suportadas neste momento, mas você pode verificar o PhizClip Financial Scenarios API Para informação.
| Nome | Função |
|---|---|
| pz.stopFaceDetect | Parar reconhecimento facial |
| pz.initFaceDetect | Inicializar reconhecimento facial |
| pz.faceDetect | Reconhecimento facial requer uma inicialização usando pz.initFaceDetect antes de ser utilizado. Recomenda-se utilizar os dados de quadros retornados pela interface da câmera |
17. Worker
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.createWorker | Criar uma thread Worker |
17.1 Worker
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| Worker.getCameraFrameData | Obter imagem do frame da câmera atual, retornar aos dados ArrayBuffer |
| Worker.onMessage | Monitorar evento da thread principal/thread Worker enviando mensagem para a thread atual |
| Worker.onProcessKilled | Monitorar evento em que a thread Worker é reciclada pelo sistema (quando o recurso do sistema iOS está apertado, a thread Worker deve ser reciclada pelo sistema, o desenvolver pode monitorar esse evento e criar uma nova thread Worker) |
| Worker.postMessage | Enviar mensagem para a thread principal/thread Worker |
| Worker.terminate | Finalizar thread Worker atual |
| Worker.testOnProcessKilled | Usar para simular o evento de reciclagem do sistema da thread ExperimentalWorker no iOS, facilitando depurar. A interface só está disponível dentro da thread Worker |
18. FXML
| Nome | Função | Versões | Observações |
|---|---|---|---|
| pz.createSelectorQuery | Retornar instância de objeto SelectorQuery | 1.0.0 | |
| pz.createIntersectionObserver | Criar e retornar uma instância de objeto IntersectionObserver | 1.0.0 |
18.1 Internetbserver
| Nome | Função | Versões | Observações |
|---|---|---|---|
| IntersectionObserver.disconnect | Parar monitoramento | 1.0.0 | |
| IntersectionObserver.observe | Especificar Node alvo e iniciar monitoramento de mudanças no estado de interseção | 1.0.0 | |
| IntersectionObserver.relativeTo | Usar seletor para especificar um node (nó) como uma das áreas de referência | 1.0.0 | |
| IntersectionObserver.relativeToViewport | Especificar área de exibição da página como uma das áreas de referência | 1.0.0 |
18.2 MediaQueryobserver
| Nome | Função | Versões | Observações |
|---|---|---|---|
| MediaQueryObserver.disconnect | Parar monitoramento | 1.0.0 | |
| MediaQueryObserver.observe | Iniciar monitoramento de mudanças na página de media query | 1.0.0 |
18.3 NodesRef
| Nome | Função | Versões | Observações |
|---|---|---|---|
| NodesRef.boundingClientRect | Adicionar pedido de verificação da posição do layout de um node | 1.0.0 | |
| NodesRef.context | Adicionar pedido de verificação do objeto Context de um node | 1.0.0 | |
| NodesRef.fields | Obter informações relacionadas ao node | 1.0.0 | |
| NodesRef.scrollOffset | Solicitar pedido de verificação da posição de rolagem de um node | 1.0.0 | |
| NodesRef.node | Obter instância Node dos nodes (nós) | 2.12.12 |
18.4 SelectorQuery
| Nome | Função | Versões | Observações |
|---|---|---|---|
| SelectorQuery.exec | Executar todas as solicitações | 1.0.0 | |
| SelectorQuery.in | Altere o intervalo de seleção do seletor para dentro do componente ‘component’ personalizado | 1.0.0 | |
| SelectorQuery.select | Selecione o primeiro seletor de correspondência no nó de seletor de página atual | 1.0.0 | |
| SelectorQuery.selectAll | Selecionar o primeiro node que corresponde ao seletor ‘selector’ na página atual | 1.0.0 | |
| SelectorQuery.selectViewport | Selecionar node que corresponde ao seletor ‘selector’ na página atual | 1.0.0 |
19. Plataforma de terceiros
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.getExtConfigSync | Versão síncrona de pz.getExtConfig |
| pz.getExtConfig | Obter dados personalizados da plataforma de terceiros |
20. Publicidade
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| pz.createRewardedVideoAd | Criar componente de anúncio em vídeo de recompensa |
| pz.createInterstitialAd | Criar um componente de anúncio de inserção na tela (intersticial) |
20.1 InterstitialAd
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| InterstitialAd.destroy | Destruir instância de anúncio de inserção na tela (intersticial) |
| InterstitialAd.load | Carregar anúncio intersticial |
| InterstitialAd.offClose | Remover função de monitoramento de eventos de fechamento de anúncio intersticial |
| InterstitialAd.offError | Remover função de monitoramento de eventos de erro de anúncio intersticial |
| InterstitialAd.offLoad | Remover função de monitoramento de eventos de carregamento de anúncio intersticial |
| InterstitialAd.onClose | Monitorar eventos de fechamento de anúncio intersticial |
| InterstitialAd.onError | Monitorar eventos de erro de anúncio intersticial |
| InterstitialAd.onLoad | Monitorar eventos de carregamento de anúncio intersticial |
| InterstitialAd.show | Exibir anúncio intersticial |
20.2 RewardedVideoAd
Por favor, note que:
As seguintes APIs não são suportadas neste momento
| Nome | Função |
|---|---|
| RewardedVideoAd.destroy | Destruir instância do anúncio em vídeo de recompensa |
| RewardedVideoAd.load | Carregar anúncio em vídeo de recompensa |
| RewardedVideoAd.offClose | Remover função de monitoramento de eventos de cliques de usuário no botão de fechar anúncio de recompensa |
| RewardedVideoAd.offError | Remover função de monitoramento de eventos de erro de anúncio de recompensa |
| RewardedVideoAd.offLoad | Remover função de monitoramento de eventos de carregamento do anúncio em vídeo de recompensa |
| RewardedVideoAd.onClose | Monitorar evento de cliques de usuário no botão de fechar anúncio de recompensa |
| RewardedVideoAd.onError | Monitorar eventos de erros nos anúncios em vídeo de recompensa |
| RewardedVideoAd.onLoad | Monitorar eventos de carregamento de anúncios em vídeo de recompensa |
| RewardedVideoAd.show | Exibir anúncio de vídeo de recompensa |
21. Outros
| Nome | Função |
|---|---|
| pz.onCustomEvent | Monitorar eventos onCustomimEvent distribuídos nativamente |
| pz.offCustomEvent | Cancelar monitoramento de eventos onCustomimEvent distribuídos nativamente |
| pz.addCustomEventListener | Monitorar eventos distribuídos nativamente |
| pz.removeCustomEventListener | Cancelar monitoramento de eventos distribuídos nativamente |
| pz.getSuperviseInfo | Obter informações de controle e monitoramento |
| pz.sendWebviewEvent | O miniprograma envia eventos para o H5 |
| pz.reportEvent | Relatório de eventos |
| pz.loadExtApi | Carregar configurações personalizadas da API |