Fundamentos

env

pz.env

Variáveis ambientais

atributo

string USER_DATA_PATH

Caminho do diretório do usuário no sistema de arquivos (caminho local)

base64ToArrayBuffer

ArrayBuffer pz.base64ToArrayBuffer(string base64)

será o objeto Base64 String ArrayBuffer

parâmetro

string base64

Para traduzir em string de caracteres Base64 do objeto ArrayBuffer

Valor de retorno

ArrayBuffer

Objeto ArrayBuffer

Código de amostra

const base64 = 'CxYh'
const arrayBuffer = pz.base64ToArrayBuffer(base64)

arrayBufferToBase64

string pz.arrayBufferToBase64(ArrayBuffer arrayBuffer)

será a conversão do objeto ArrayBuffer String de caracteres Base64

parâmetro

ArrayBuffer arrayBuffer

Para converter o objeto Base64 String ArrayBuffer

Valor de retorno

string

Sequência de caracteres Base64

Código de amostra

const arrayBuffer = new Uint8Array([11, 22, 33])
const base64 = pz.arrayBufferToBase64(arrayBuffer)

base64ToTempFilePath

Biblioteca básica 1.3.9 é suportada, versão iOS 2.1.23, versão Android 2.1.38

base64ToTempFilePath(Object object)

Salve os dados base64 da imagem na sandbox local e retorne o caminho do cache local.

Propriedade	Tipo	O valor padrão é	Obrigatório	Descrição
x	number	0	Não	A abscissa superior esquerda da área a ser cultivada é
y	number	0	Não	A ordenada superior esquerda da área a ser cortada é
width	number	Canvas width - x	Não	A largura da área a ser cortada
height	number	Canvas height -y	Não	A altura da área a ser cortada é
destWidth	number	width x screen pixel density	Não	A largura da imagem de saída é
destHeight	number	height x screen pixel density	Não	A altura da imagem de saída é
base64Data	string		Sim	A imagem é convertida em uma string do tipo base64
success	function		Não	A interface chama a função de retorno de chamada com sucesso
fail	function		Não	Função de retorno de chamada com falha na chamada de interface
complete	function		Não	A função de retorno de chamada no final da chamada de interface (a chamada é bem-sucedida ou não é executada

object.success callback function

Parâmetro

Object res

Propriedade	Tipo	Descrição
tempFilePath	string	O endereço local da imagem

fileToBase64

fileToBase64(Object object)

o arquivo será convertido em sequência de caracteres Base64

Parâmetro

Object res

Propriedade	Tipo	Descrição
url	string	Endereço do arquivo

Valor de retorno

string

Sequência Base64

System

getSystemInfoSync

Compatível desde a biblioteca base 1.3.9, versão iOS 2.1.23, versão Android 2.1.38

getSystemInfoSync()

A versão síncrona de pz.getSystemInfo

getSystemInfoAsync

pz.getSystemInfoAsync(Object object)

Obtenha informações do sistema de forma assíncrona. Precisa de algum suporte à versão do cliente Phiz, no cliente não suportado, usará a sincronização para retornar.

parâmetro

Object object

atributo	tipo	Valores padrão	Obrigatório	Apresentações
success	function		não	Interface chama a função de retorno de chamada bem-sucedida
fail	function		não	Interface chama funções de retorno de chamada com falha
complete	function		não	Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

object.success callback

parâmetro

Object res

atributo	tipo	Apresentações	Versão mínima
brand	string	Marca do equipamento	1.5.0
model	string	Modelo do dispositivo. Novos modelos serão desconhecidos por um tempo, o Phiz se adaptará o mais rápido possível.
pixelRatio	number	Proporção de pixels do dispositivo
screenWidth	number	Largura da tela, em px	1.1.0
screenHeight	number	Altura da tela, em px	1.1.0
windowWidth	number	Largura de janela disponível, unidade px
windowHeight	number	Altura disponível da janela, em px
statusBarHeight	number	Altura da barra de status em px	1.9.0
language	string	Idioma das configurações do Phiz
version	string	Número da versão do Phiz
system	string	Sistema operacional e versão
platform	string	Plataforma do cliente
fontSizeSetting	number	Tamanho da fonte do usuário em px. Cliente PhizI - Configurações - Universal - Tamanho da fonteAs configurações em	1.5.0
SDKVersion	string	Versão da biblioteca base de clientes	1.1.0
benchmarkLevel	number	Nível de desempenho do equipamento (somente Android）。 Os valores são: -2 ou 0 (o dispositivo não pode rodar jogos), -1 (desempenho desconhecido),>= 1 (Valor de desempenho do dispositivo, maior o valor, melhor desempenho do dispositivo, atualmente até menos de 50)	1.8.0
albumAuthorized	boolean	Permitir que o Phiz use o botão Álbum de fotos (apenas iOS efetivo)	2.6.0
cameraAuthorized	boolean	Switch que permite ao Phiz usar a câmera	2.6.0
locationAuthorized	boolean	Permitir que o Phiz use a troca de localização	2.6.0
microphoneAuthorized	boolean	Alternar permitindo que o Phiz use microfone	2.6.0
notificationAuthorized	boolean	Switch que permite notificações do Phiz	2.6.0
notificationAlertAuthorized	boolean	Permitir que o Phiz notifique interruptores com lembretes (apenas iOS efetivo)	2.6.0
notificationBadgeAuthorized	boolean	Permitir notificações do Phiz com opções marcadas (apenas iOS efetivo)	2.6.0
notificationSoundAuthorized	boolean	Permitir que o Phiz notifique interruptores com som (apenas iOS eficaz)	2.6.0
bluetoothEnabled	boolean	Interruptor do sistema Bluetooth	2.6.0
locationEnabled	boolean	Mudança do sistema de localização geográfica	2.6.0
wifiEnabled	boolean	Interruptor do sistema Wi-Fi	2.6.0
safeArea	Object	Uma área segura na direção positiva da tela vertical	2.7.0
locationReducedAccuracy	boolean	true Representa posicionamento difuso,false Para posicionamento preciso, apenas Suporte iOS
theme	string	Tema atual do sistema, com valor lightoudark, configuração global'darkmode': truePode ser obtido quando indefinido (Jogos pequenos não suportados)	2.11.0
enableDebug	boolean	Se a depuração está ativada. Disponível no menu superior direito ou pz.setEnableDebug Ative a depuração.	2.15.0
bundleId	string	O bundleId do aplicativo host	2.15.0
deviceOrientation	string	Direção de equipamentos

safeArea Structure

atributo	tipo	Apresentações
left	number	Abscissa superior esquerda da área de segurança
right	number	Área de segurança abscissa inferior direita
top	number	Ordenada superior esquerda da área de segurança
bottom	number	Ordenada inferior direita da área de segurança
width	number	Largura da área de segurança, pixels lógicos unitários
height	number	Altura da área segura, pixels lógicos da unidade

theme Legal value

valor	Apresentações	Versão mínima
dark	Tema escuro
light	Tema de cor clara

host Structure

atributo	tipo	Apresentações
appId	string	aplicativo host AppId correspondente

deviceOrientation Legal value

valor	Apresentações	Versão mínima
portrait	Tela vertical
landscape	Tela horizontal

Código de amostra

Pré-visualização com ferramenta de desenvolvedor

pz.getSystemInfoAsync({
  success (res) {
    console.log(res.model)
    console.log(res.pixelRatio)
    console.log(res.windowWidth)
    console.log(res.windowHeight)
    console.log(res.language)
    console.log(res.version)
    console.log(res.platform)
  }
})

getSystemInfo

Compatível desde a biblioteca base 1.3.9, versão iOS 2.1.23, versão Android 2.1.38

getSystemInfo(Object object)

Obtém informações do sistema.

Parâmetros

Object object

Propriedade	Tipo	Padrão	Obrigatório	Descrição
success	function		Não	A função de retorno de chamada para uma chamada de API bem-sucedida
fail	function		Não	A função de retorno de chamada para uma chamada de API com falha
complete	function		Não	A função de retorno de chamada usada quando a chamada de API é concluída (sempre executada independentemente de a chamada ser bem-sucedida ou falhar)

object.success callback function ​ Parâmetros

Object res

Propriedade	Tipo	Descrição
SDKVersion	string	Versão da biblioteca base para o aplicativo Phiz
runtimeSDKVersion	string	Número da versão do SDK do miniaplicativo
brand	string	Marca do dispositivo
model	string	Modelo do dispositivo
pixelRatio	number	Proporção de pixels do dispositivo
screenWidth	number	Largura da tela em px
screenHeight	number	Altura da tela em px
windowWidth	number	Largura da janela disponível em px
windowHeight	number	Altura da janela disponível em px
statusBarHeight	number	Altura da barra de status em px
language	string	Idioma definido no Phiz
version	string	Versão Phiz
bundleId	string	O bundleId do aplicativo host
system	string	Sistema operacional e versão
platform	string	Plataforma do cliente
inFinChat	boolean	Está no ambiente do miniaplicativo finchat
deviceId	string	Identificação do equipamento

Código de amostra

 pz.getSystemInfo({
  success(res) {
    console.log(res.model)
    console.log(res.pixelRatio)
    console.log(res.windowWidth)
    console.log(res.windowHeight)
    console.log(res.language)
    console.log(res.version)
    console.log(res.platform)
  }
})

Updates

getUpdateManager

Compatível desde a biblioteca base 1.5.30, versão iOS 2.5.6, versão Android 2.8.76

ObtenhaGlobalmente exclusivoO gerenciador de atualização de versão para gerenciar atualizações de phizclip. Atualização sobre o mecanismo do phizclip, você pode verMecanismo de operaçãoDocumentação.

Método UpdateManager

UpdateManager.applyUpdate() Força o phizclip a reiniciar e usar a nova versão. Depois que a nova versão do phizclip for baixada (ou seja, recebida onUpdateReady Callback), ligue.

UpdateManager.onCheckForUpdate(function callback) Monitore a solicitação em segundo plano do Phiz para verificar o evento de resultados da atualização. O Phiz verifica automaticamente as atualizações quando o phizclip é inicializado a frio, sem que o desenvolvedor tome a iniciativa de acioná-las.

UpdateManager.onUpdateReady(function callback) O phizclip de escuta tem um evento de atualização de versão. Download de gatilho de cliente ativo (sem gatilho de desenvolvedor), retorno de chamada de sucesso de download

UpdateManager.onUpdateFailed(function callback) Escuta os Miniprogramas para atualizar eventos com falha. O phizclip tem uma nova versão, download do gatilho ativo do cliente (sem gatilho do desenvolvedor), falha no download (pode ser por motivos de rede, etc.) após o retorno de chamada

Código de amostra

const updateManager = pz.getUpdateManager()

updateManager.onCheckForUpdate(function (res) {
// Retorno de chamada após solicitar informações sobre nova versão
  console.log(res.hasUpdate)
})

updateManager.onUpdateReady(function () {
  pz.showModal({
    title: 'Update tip ',
    content: 'The new version is ready, reboot the app? ', 
    success: function (res) {
      if (res.confirm) {
        // A nova versão foi baixada e chama applyUpdate Aplique uma nova versão e reinicie
        updateManager.applyUpdate()
      }
    }
  })
})

updateManager.onUpdateFailed(function () {
//Falha no download da nova versão
})

phizclip

getLaunchOptionsSync

Object pz.getLaunchOptionsSync() Obtém os parâmetros para inicialização dos phizclip. e App.onLaunch Os parâmetros de retorno de chamada de

Valor de retorno

Object

Parâmetro inicial

atributo	tipo	Apresentações
path	string	Caminho para iniciar os phizclip (caminho do pacote de código)
query	Object	Inicie o parâmetro de consulta do phizclip
referrerInfo	Object	Informações de origem. De outro programinha, modelo de mensagem da Conta Oficial ou App Devoluções ao entrar no phizclip. Caso contrário, retorne {}。(veja abaixo para atenção)

referrerInfo Structure

atributo	tipo	Apresentações
appId	string	O appId do phizclip
extraData	Object	Fonte phizclip passou dados

getEnterOptionsSync

Object pz.getEnterOptionsSync()

Obtém os parâmetros deste phizclip quando ele é iniciado. Se a corrente for uma inicialização a frio, o valor de retorno será idêntico ao App.onLaunch Consistente com os parâmetros de retorno de chamadaSe esta for uma inicialização a quente, o valor de retorno será idêntico ao App.onShow Consistente

Valor de retorno

Object

Parâmetro inicial

atributo	tipo	Apresentações
path	string	Caminho para iniciar os phizclip (caminho do pacote de código)
query	Object	Inicie o parâmetro de consulta do phizclip
referrerInfo	Object	Informações de origem. De outro programinha, modelo de mensagem da Conta Oficial ou App Devoluções ao entrar no phizclip. Caso contrário, retorne {}。(veja abaixo para atenção)

Estrutura de informações de referência

atributo	tipo	Apresentações
appId	string	O appId do phizclip
extraData	Object	Fonte phizclip passou dados

onPageNotFound

pz.onPageNotFound(function callback)

Não há eventos na página que o phizclip de escuta queira abrir. Este evento está relacionado a App.onPageNotFound O momento do pullback foi consistente

parâmetro

function callback

A função de retorno de chamada para a página que o phizclip abre não existe

parâmetro

Object res

atributo	tipo	Apresentações
path	string	Nenhum caminho para a página (caminho do pacote de código)
query	Object	Abra uma página que não existe parâmetro de consulta
isEntryPage	boolean	É a primeira página deste lançamento (por exemplo, na entrada Compartilhar, a primeira é a página de compartilhamento de configuração do desenvolvedor)

Tome cuidado

• Os desenvolvedores podem fazer o redirecionamento de página em retornos de chamada, mas apenas em retorno de chamadasincronizaçãoProcessamento, processamento assíncrono como setTimeout Execução assíncrona) é inválido.
• Se o desenvolvedor não ligar pz.onPageNotFound Escuta de ligação, sem declaração App.onPageNotFound, Quando a página de salto não existe, enviará a página nativa do cliente Phiz, não há página de prompt.
• Se o retorno de chamada for redirecionado para outra página que não existe, a página original do cliente Phiz será empurrada para a página que não existe e não haverá um segundo retorno de chamada.

onError

pz.onError(function callback)

Escuta eventos de erro do MiniPrograma. Como um erro de script ou erro de chamada de API, etc. Este evento está relacionado ao tempo de retorno de chamada App.onError do.

parâmetro

function callback

Função de retorno de chamada para evento de erro do phizclip

parâmetro

string error

Mensagem de erro, incluindo pilha

onAppShow

pz.onAppShow(function callback)

Ouça os eventos de primeiro plano cortados pelo phizclip. Este evento está relacionado a App.onShow Os parâmetros de retorno de chamada de

parâmetro

function callback

Função de retorno de chamada para miniprogramas para cortar eventos de primeiro plano

parâmetro

Object res

atributo	tipo	Apresentações
path	string	Miniprogramas cortam o caminho de primeiro plano (caminho do pacote de código)
query	Object	phizclip cortou o parâmetro de consulta da recepção
referrerInfo	Object	Informações de origem. De outro programinha, modelo de mensagem da Conta Oficial ou App Devoluções ao entrar no phizclip. Caso contrário, retorne {}。(Veja abaixo para atenção)

Estrutura de informações de referência

atributo	tipo	Apresentações
appId	corda	O appId do phizclip
extraData	Objeto	Fonte phizclip passou dados

Tome cuidado

Versão parcial NoreferrerInfoRetornará quando undefinedRecomendado para uso options.referrerInfo && options.referrerInfo.appId Para julgar.

onAppHide

pz.onAppHide(function callback)

Ouça os eventos de fundo cortados do phizclip. Este evento está relacionado a App.onHide O momento do pullback foi consistente.

parâmetro

function callback

Função de retorno de chamada para eventos em segundo plano

offPageNotFound

pz.offPageNotFound(function callback)

A página a ser aberta pelo phizclip unlisten não possui evento

parâmetro

function callback

A função de retorno de chamada para a página que o phizclip abre não existe

offError

pz.offError(function callback)

Cancela a escuta de eventos de erro do phizclip

parâmetro

function callback

Função de retorno de chamada para evento de erro do phizclip

offAppShow

pz.offAppShow(function callback)

Cancele o phizclip do monitor para cortar o evento de primeiro plano

parâmetro

function callback

Função de retorno de chamada para miniprogramas para cortar eventos de primeiro plano

offAppHide

pz.offAppHide(function callback)

Cancele a escuta do phizclip para cortar o evento de fundo

parâmetro

function callback

Função de retorno de chamada para eventos em segundo plano

onThemeChange

pz.onThemeChange(function callback)

Ouça eventos de mudança de tópico do sistema

parâmetro

function callback

Função de retorno de chamada para o evento de mudança de tópico do sistema

onUnhandledRejection

pz.onUnhandledRejection(function callback)

Ouça eventos de rejeição de promessa não processados

parâmetro

function callback

Função de retorno de chamada para um evento de rejeição de promessa não tratado

offUnhandledRejection

pz.offUnhandledRejection(function callback)

Cancelar a escuta de eventos de rejeição de promessa não processados

parâmetro

function callback

onUnhandledRejection Função de retorno de chamada de entrada. Se este argumento não for passado, todas as funções de escuta serão removidas.

offThemeChange

pz.offThemeChange(function callback)

Cancela a escuta de eventos de mudança de tópico do sistema

parâmetro

function callback

onThemeChange A função de retorno de chamada transmitida. Se esse parâmetro não for passado, todas as funções de ouvinte serão removidas.

debugging

setEnableDebug

pz.setEnableDebug(Object object)

Define se a opção de depuração está ativada. Esta opção também funciona para a versão oficial

parâmetro

Object object

atributo	tipo	Valores padrão	Obrigatório	Apresentações
enableDebug	boolean		sim	Ative a depuração
success	function		não	Interface chama a função de retorno de chamada bem-sucedida
fail	function		não	Interface chama funções de retorno de chamada com falha
complete	function		não	Função de retorno de chamada no final de uma chamada de interface (são executadas chamadas bem-sucedidas e malsucedidas)

Código de amostra

//Ativa a depuração
pz.setEnableDebug({
  enableDebug: true
})

//Fecha a depuração
pz.setEnableDebug({
  enableDebug: false
})

Pontas

• Na versão oficial para abrir a depuração existe uma maneira que primeiro está na versão de desenvolvimento ou na versão de experiência da depuração aberta, e depois corta para a versão formal pode ver o vConsole.

console

Imprime logs no console de depuração. O “console” é um objeto global e pode ser acessado diretamente. No aplicativo Phiz, os logs são enviados para o vConsole.

console.debug()

Imprime o log de "depuração" no painel de depuração.

console.error()

Imprime o log de "erros" no painel de depuração.

console.group()

Cria um novo grupo no painel de depuração.

console.groupEnd()

Encerra um grupo criado por console.group.

console.info()

Imprime o log "info" no painel de depuração.

console.log()

Imprime o log "log" no painel de depuração.

console.warn()

Imprime o log de "aviso" no painel de depuração.

LogManager

Instância do gerenciador de logs

LogManager.debug()

escrever diário de depuração

LogManager.info()

escrever diário de informações

LogManager.log()

escrever diário de registro

LogManager.warn()

escrever avisar diário

RealtimeLogManager

Instância do gerenciador de log em tempo real

RealtimeLogManager.info()

write info O registro não é suportado em plug-ins

RealtimeLogManager.warn()

write warning O registro não é suportado em plug-ins

RealtimeLogManager.error()

erro de gravação O registro em log não é suportado em plug-ins

RealtimeLogManager.setFilterMsg(string msg)

Definir palavras-chave de filtro, temporariamente não suporta o uso de

RealtimeLogManager.addFilterMsg(string msg)

Adicionar palavras-chave de filtro, temporariamente sem suporte no uso do plugin

Account information

getAccountInfoSync

Obtém as informações da conta atual. O número da versão do phizclip Online está disponível apenas na versão oficial do phizclip, a versão de desenvolvimento e a versão de experiência não podem ser obtidas

Valor de retorno

Object object

atributo	tipo	Valores padrão	Obrigatório	Apresentações
miniProgram	Object		sim	Informações da conta do phizclip

Object miniProgram

atributo	tipo	Apresentações
appId	string	AppId do miniprograma
envVersion	string	Versão do miniprograma