Rede
Solicitação iniciada
Solicitar
Suporte da biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38
request(Object object)
Solicitação de rede HTTPS iniciada. Leia com cuidado antes dos usuários
parameter
Object object
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| url | string | yes | Endereço da interface do servidor de desenvolvedor | |
| data | string/object/ArrayBuffer | no | Parâmetros solicitados | |
| header | Object | no | Defina o cabeçalho da solicitação, o cabeçalho não pode ser definido. | |
| Contente-Tipo padrão é aplicação/json | ||||
| method | string | GET | no | Método de solicitação HTTP |
| dataType | string | json | no | Formato de dados Returnet |
| responseType | string | text | no | Tipo de resposta de dados |
| success | function | no | Interface chama a função de retorno de chamada bem -sucedida | |
| fail | function | no | Chamadas de interface Funções de retorno de chamada falhas | |
| complete | function | no | Função de retorno de chamada no final de uma chamada de interface (as chamadas bem -sucedidas e pouco sucedidas são executadas) |
object.method Legal value
| value | Introduções |
|---|---|
| OPTIONS | Opções de solicitação HTTP |
| GET | Solicitação http receber |
| HEAD | Chefe de solicitação HTTP |
| POST | Postagem de solicitação HTTP |
| PUT | Solicitação HTTP Put |
| DELETE | Solicitação HTTP Excluir |
| TRACE | Rastreamento de solicitação HTTP |
| CONNECT | HTTP Solicitação Connect |
object.dataType Legal value
| value | Introduções |
|---|---|
| json | O retorno dos dados é JSON, que é retonado uma vez para os dados de retorno JSON.PARS |
| outros | Não é executado no conteúdo retonado json.parse |
object.responseType Legal value
| value | Introduções |
|---|---|
| text | Os dados para a resposta são texto |
| arraybuffer | Os dados da resposta são ArrayBuffer |
object.success callback
parameter
Object res
| attribute | type | Introduções |
|---|---|---|
| data | string/object/ArrayBuffer | Data Returnet pelo servidor de desenvolvedor |
| statusCode | number | Retorno pelo código de status HTTP do servidor de desenvolvedor |
| header | Object | Retornado pelo cabeçalho de resposta HTTP do servidor de desenvolvedor |
sample code
pz.request({
url: 'test.php', // Just an example, not a real interface address
data: {
x: '',
y: ''
},
header: {
'content-type': 'application/json' // Default values
},
success(res) {
console.log(res.data)
}
})Requesttask.abort
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
RequestTask.abort()
Tarefa de solicitação de interrupção
sample code
const task = pz.request({
// some params
})
// Interrupt requests
task.abort()RequestTask.onHeaderSreceived
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
RequestTask.OnHeaderSreceived (retorno de chamada da função)
Para monitorar os eventos do cabeçalho da resposta HTTP. Será mais cedo do que o pedido para concluir o evento
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
callbackparameter
Object res
| attribute | type | Introduções |
|---|---|---|
| header | Object | Retornado pelo cabeçalho de resposta HTTP do servidor de desenvolvedor |
RequestTask.offheadersReceived
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
RequestTask.offHeadersReceived(function callback)
Cancelar o evento de cabeçalho de resposta HTTP
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
baixar
⇬ Fazer download do arquivo
Suporte da biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38
downloadFile(Object object)
Faça o download dos recursos do arquivo para o local. O cliente inicia diretamente uma solicitação https obter, retornar o caminho temporário local para o arquivo (caminho local).
Nota: Clique no cabeçalho especifica um conteúdo razoável-Digite o campo para garantir que o cliente lida com os tipos de arquivo corretamente parameter
Object object
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| url | string | yes | Baixe o URL do recurso | |
| header | Object | no | Http solicitado cabeçalho, o cabeçalho não pode ser definido como consulte | |
| success | function | no | Interface chama a função de retorno de chamada bem -sucedida | |
| fail | function | no | Chamadas de interface Funções de retorno de chamada falhas | |
| complete | function | no | Função de retorno de chamada no final de uma chamada de interface (as chamadas bem -sucedidas e pouco sucedidas são executadas) |
object.success callback
parameter
Object res
| attribute | type | Introduções |
|---|---|---|
| tempFilePath | string | Caminho do arquivo Temporory (caminho local) Sem o FilePath de entrada quando você especifica um caminho de armazenamento de arquivos, o arquivo de download é armazenado em um arquivo tempeal |
| statusCode | number | Retorno pelo código de status HTTP do servidor de desenvolvedor |
sample code
pz.downloadFile({
url: 'https://example.com/audio/123', // Just an example, not a real resource.
success(res) {
// As long as the server has the response data, the response will be written to a file and entered success Callback, the business needs to determine whether to download the desired content
if (res.statusCode === 200) {
pz.playVoice({
filePath: res.tempFilePath
})
}
}
})DownloadTask.abort
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
DownloadTask.abort()
Tarefa de download interrupto
sample code
const task = pz.request({
// some params
})
// Interrupt requests
task.abort()DownloadTask.onHeaderSreceived
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
DownloadTask.onHeadersReceived(function callback)
Para monitorar os eventos do cabeçalho da resposta HTTP. Será mais cedo do que o pedido para concluir o evento
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
callbackparameter
Object res
| attribute | type | Introduções |
|---|---|---|
| header | Object | Retornado pelo cabeçalho de resposta HTTP do servidor de desenvolvedor |
DownloadTask.OffHeadersReceived
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
DownloadTask.offHeadersReceived(function callback)
Cancelar o evento de cabeçalho de resposta HTTP
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
DownloadTask.onProgressUpdate
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
DownloadTask.onProgressUpdate(function callback)
Ouça mudanças no progresso do download
parameter
function callback
Baixe funções de retorno de chamada para eventos de progresso Chang
callbackparameter
Object res
| attribute | type | Introduções |
|---|---|---|
| progress | number | Baixar porcentagem de progresso |
| totalBytesWritten | number | Duração dos dados baixados em bytes de unidades |
| totalBytesExpectedToWrite | number | Duração total dos dados que devem ser baixados, em unidades bytes |
sample code
const task = pz.downloadFile({
// some params
})
// Listening for progress changes
task.onProgressUpdate((res) => {
this.setData({
progress: res.progress
})
})DownloadTask.OffProgressUpdate
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
DownloadTask.offProgressUpdate(function callback)
Cancelar ouvindo os eventos de mudança de programação de download
parameter
function callback
Baixe funções de retorno de chamada para eventos de progresso Chang
carregar
subir arquivo
Suporte da biblioteca base de 1.3.9, iOS versão 2.1.23, Android versão 2.1.38
uploadFile(Object object)
Carrega os recursos locais para o servidor.-Tipo para multipart/formulário-Dados. Leia as notas theleed
parameter
Object object
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| url | string | yes | Endereço do servidor de desenvolvedor | |
| filePath | string | yes | Caminho para fazer upload do recurso de arquivo (caminho local) | |
| name | string | yes | Arquivo correspondente à chave, os desenvolvedores do lado do servidor podem usar essa chave, obtenha o conteúdo binário do arquivo | |
| header | Object | no | Http solicitado cabeçalho, o cabeçalho não pode ser definido como consulte | |
| formData | Object | no | Dados do formulário de solicitações adicionais HTTP | |
| timeout | number | no | Tempo em milissegundos | |
| success | function | no | Interface chama a função de retorno de chamada bem -sucedida | |
| fail | function | no | Chamadas de interface Funções de retorno de chamada falhas | |
| complete | function | no | Função de retorno de chamada no final de uma chamada de interface (as chamadas bem -sucedidas e pouco sucedidas são executadas) |
object.success callback
parameter
Object res
| attribute | type | Introduções |
|---|---|---|
| data | string | Data Returnet pelo servidor de desenvolvedor |
| statusCode | number | Retorno pelo código de status HTTP do servidor de desenvolvedor |
sample code
pz.chooseImage({
success(res) {
const tempFilePaths = res.tempFilePaths
pz.uploadFile({
url: 'https://example.weixin.qq.com/upload', // Example only, not real interface address
filePath: tempFilePaths[0],
name: 'file',
formData: {
user: 'test'
},
success(res) {
const data = res.data
//of the something
}
})
}
})Uploadask.abort
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
UploadTask.abort()
Tarefa de upload interrompida
sample code
const task = pz.request({
// some params
})
// Interrupt requests
task.abort()UPLOPASK.ONHEADERSRECEVED
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
UploadTask.onHeadersReceived(function callback)
Para monitorar os eventos do cabeçalho da resposta HTTP. Será mais cedo do que o pedido para concluir o evento
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
callbackparameter
Object res
| attribute | type | Introduções |
|---|---|---|
| header | Object | Retornado pelo cabeçalho de resposta HTTP do servidor de desenvolvedor |
Uploadask.offheadersReceived
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
UploadTask.offHeadersReceived(function callback)
Cancelar o evento de cabeçalho de resposta HTTP
parameter
function callback
Função de retorno do evento de cabeçalho de resposta HTTP
Uploadask.onProgressUpdate
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
UploadTask.onProgressUpdate(function callback)
Monitorar alterações de progresso de upload
parameter
function callback
Uma função de retorno de chamada para fazer upload de eventos de mudança de cronograma
callbackparameter
Object res
| attribute | type | Introduções |
|---|---|---|
| progress | number | Porcentagem do progresso do upload |
| totalBytesSent | number | A duração dos dados que Ben foi enviada, em unidades bytes |
| totalBytesExpectedToSend | number | Comprimento total dos dados que devem ser carregados, em unidades bytes |
sample code
const task = pz.uploadFile({
// some params
})
// Listening for progress changes
task.onProgressUpdate((res) => {
this.setData({
progress: res.progress
})
})Uploadask.offProgressUpdate
Library Base 2.4.2 Suporte do iOS versão 2.13.59, Android Versão 2.13.34
UploadTask.offProgressUpdate(function callback)
Cancelar o Evento de CHANG de Envie Atualização de Progresso
parameter
function callback Uma função de retorno de chamada para fazer upload de eventos de mudança de cronograma
WebSocket
SendsocketMessage
pz.sendSocketMessage(Object object)
Adote o WebSocket Connection envia dados. Precisa do primeiro pz.ConnectSocket, e o pz.OnsockopeN após o retorno de chamada. pode trazer à tona alguns dos sites que não são explicados
parameter
Object object
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| data | string/ArrayBuffer | yes | O que enviar | |
| success | function | no | Interface chama a função de retorno de chamada bem -sucedida | |
| fail | function | no | Chamadas de interface Funções de retorno de chamada falhas | |
| complete | function | no | Função de retorno de chamada no final de uma chamada de interface (as chamadas bem -sucedidas e pouco sucedidas são executadas) |
sample code
let socketOpen = false
let socketMsgQueue = []
pz.connectSocket({
url: 'test.php'
})
pz.onSocketOpen(function(res) {
socketOpen = true
for (let i = 0; i < socketMsgQueue.length; i++){
sendSocketMessage(socketMsgQueue[i])
}
socketMsgQueue = []
})
function sendSocketMessage(msg) {
if (socketOpen) {
pz.sendSocketMessage({
data:msg
})
} else {
socketMsgQueue.push(msg)
}
}Onsocketopen
pz.onSocketOpen(function callback)
Para monitorar o WebSocket Connect a Open Events. Recompensado Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controlado. Múltiplos websocket simultâneos no caso de links para prefixos WX podem trazer à tona algumas das situações que não são esperadas
parameter
function callback
WebSocket Connect Challback Fun para eventos abertos
parameter
| attribute | type | Introduções |
|---|---|---|
| header | object | Cabeçalho de resposta HTTP para uma conexão bem -sucedida |
OnsocketMessage
pz.onSocketMessage(function callback)
Para monitorar o WebSocket, receba um evento de mensagem no servidor. Recompreido Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controvertível. Existem vários websocket simultâneos no caso de links para prefixos WX podem trazer alguns dos as situações que não são extensas.
parameter
function callback
Função de retorno de chamada do WebSocket para receber eventos de mensagem do servidor
parameter
Object res
| attribute | type | Introduções |
|---|---|---|
| data | string/ArrayBuffer | Mensagem returnet pelo servidor |
OnsocketError
pz.onSocketError(function callback)
Para monitorar o WebSocket Error Event.Recomled Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controlável.
parameter
function callback
Função de retorno de chamada da webSocket para eventos de erro
parameter
Objeto res
| attribute | type | Introduções |
|---|---|---|
| errMsg | string | Mensagem de erro |
OnsocketClose
pz.onSocketClose(function callback)
Para monitorar o fechamento da conexão do websocket eovent.Comeded Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controlado. Os são múltiplos websocket simultâneos no caso de links para prefixos WX podem trazer parte do tamanho que não são esperado
parameter
function callback
Função de retorno de chamada da WebSocket para fechamento de conexão Eovent
parameter
Objeto res
| attribute | type | Introduções |
|---|---|---|
| code | number | Um valor numérico reprime o número do status para o qual a conexão foi fechada e indica por que a conexão está fechada |
| reason | string | Um humano-String legível reprimindo o motivo pelo qual a conexão foi fechada. |
ConnectSocket
SocketTask pz.connectSocket(Object object)
Crie um WebSocket Connect. Por favor, leia cuidadosamente diante dos usuários. Use o Sockettask de Use Sockettask para gerenciar o link do WebSocket, o ciclo de vida do link Ea ea ea é mais controlado. Existem vários websocket simultâneos no caso de links para prefixos WX, meu traga algo que os sitesianos não esperam
parameter
Object object
| attribute | type | Default values | Required | Introductions | Versão mínima |
|---|---|---|---|---|---|
| url | string | yes | Developer Server wss Interface address | ||
| header | Object | no | HTTP Header,Header Can not be set Refer | ||
| protocols | Array.<string> | no | Subprotocol array | 1.4.0 | |
| tcpNoDelay | boolean | false | no | establish TCP At the time of the connection. TCP_NODELAY Set up | 2.4.0 |
| perMessageDeflate | boolean | false | no | Enable compression expansion | 2.8.0 |
| timeout | number | no | Timeout in milliseconds | 2.10.0 | |
| success | function | no | Interface calls the successful callback function | ||
| fail | function | no | Interface calls failed callback functions | ||
| complete | function | no | Callback function at the end of an interface call (both successful and unsuccessful calls are executed) |
Return value
SocketTask
WebSocket Quest
sample code
pz.connectSocket({
url: 'wss://example.qq.com',
header:{
'content-type': 'application/json'
},
protocols: ['protocol1']
})Clocket
pz.closeSocket(Object object)
Stop WebSocket Connect.Recomled Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controlador. AneousBocket no caso de links para prefixos WX pode trazer parte do tamanho do site
parameter
Object object
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| code | number | 1000(indicates normal shutdown connection) | no | Um valor numérico reprime o número do status para o qual a conexão foi fechada e indica por que a conexão está fechada. |
| reason | string | no | Um humano-String legível reprimindo o motivo pelo qual a conexão foi fechada. Essa string não deve ser mais do que 123 byte utf-8 texto (não cartas). | |
| success | function | no | Interface chama a função de retorno de chamada bem -sucedida | |
| fail | function | no | Chamadas de interface Funções de retorno de chamada falhas | |
| complete | function | no | Função de retorno de chamada no final de uma chamada de interface (as chamadas bem -sucedidas e pouco sucedidas são executadas) |
sample code
pz.connectSocket({
url: 'test.php'
})
//Notice there's a timing problem,
//if pz.connectSocket No callback yet. pz.on SocketOpen, and call pz.closeSocket, then can't close WebSocket The purpose of.
//Must be WebSocket Open Period Call pz.closeSocket To shut it down.
pz.onSocketOpen(function() {
pz.closeSocket()
})
pz.onSocketClose(function(res) {
console.log('WebSocket Closed!')
})Sockettask
Tarefa WebSocket, disponível no retorno da criação de interface pz.connectSocket ()
method
SocketTask.send(Object object)
Adote o WebSocket Connect para enviar dadosSocketTask.close(Object object)
Stop WebSocket ConnectSocketTask.onOpen(function callback)
Para monitorar o evento de abertura do WebSocket ConnectionSocketTask.onClose(function callback)
Para monitorar o fechamento da conexão do websocket eovent.Comeded Use Sockettask O caminho para gerenciar o link do WebSocket, o ciclo de vida de cada link é mais controlado. Os são múltiplos websocket simultâneos no caso de links para prefixos WX podem trazer parte do tamanho que não são esperadoSocketTask.onError(function callback)
Para monitorar o evento de erro do WebSocketSocketTask.onMessage(function callback)
Para monitorar o evento de mensagens do WebSocket recebido do servidor
Comunicação do sinal TCP
pz.createtCpSocket
pz.createTCPSocket() Crie uma instância de soquete TCP. Leia com cuidado antes dos usuários
Return value
TCPSocket
Um exemplo de soquete TCP
Connection limit
- Permitido com não- Computadores locais em redes de área local Comunicação IP Signal ?
- Não conectado ao seguinte número da porta:
Abaixo de 102410991433152117191720172320492375312833063389365940455060506154325984637960006566700170028000-81008443888892009300100511008011211270172701827019 - Cada criação máxima de 5 em minutos 20 TCPSocket individual
TCPSocket
Uma instância do soquete TCP, por padrão IPv4 Contrato
method
TCPSocket.connect(Object options)
Inicie uma conexão no soquete fornecido
TCPSocket.write(string|ArrayBuffer data)
No soquete, envie dados em
TCPSocket.close()
Feche a conexão
TCPSocket.onClose(function callback)
Depois que o fio é tocado, o encerramento completo envia o evento
TCPSocket.offClose(function callback)
Depois de cancelar o desligamento do soquete de escutas telefônicas envia o evento
TCPSocket.onConnect(function callback)
Ouça quando um soquete o evento é acionado quando a conexão é estabelecida com sucesso
TCPSocket.offConnect(function callback)
Cancelar a escuta telefônica quando um soquete o evento é acionado quando a conexão é estabelecida com sucesso
TCPSocket.onError(function callback)
Ouça é acionado quando ocorre um erro
TCPSocket.offError(function callback)
Cancelar ouça acionada quando ocorre um erro
TCPSocket.onMessage(function callback)
O monitor desencadeia o evento quando os dados são recebidos
TCPSocket.offMessage(function callback)
Cancelando a escuta para acionar este evento quando os dados são recebidos
error
| Erro de código | Error message | Introductions |
|---|---|---|
| -1 | SErro YSTM | |
| -2 | SErro de interface do OCK, consulte o código de erro do soquete do sistema | |
| -3 | SFalha final, sem permissões de interface | |
| -4 | LA tinta falhou | |
| 1 | SFalha final, erro de parâmetro, endereço ilegal | |
| 2 | SFalha final, erro de parâmetro, porto ilegal |
Comunicação do sinal UDP
pz.createudpSocket
pz.createUDPSocket() Crie uma instância de soquete UDP. Leia com cuidado antes dos usuários
Return value
UDPSocket
Um exemplo de soquete UDP
Udpsocket
Uma instância do soquete UDP, por padrão IPv4 Protocol
method
number UDPSocket.bind(number port)
Vincular um sistema por porta disponível aleatoriamente ou vincular um número de porta espiecificado
UDPSocket.setTTL(number ttl)
Configure a opção de soquete ip_ttl para definir um número máximo de IP de lúpulo permitido para transmissão de pacotes
UDPSocket.send(Object object)
Para o especificar IP e a porta, envie uma mensagem. Base Biblioteca 2.9.0 Transmissão de suporte (o endereço especificado é 255.255.255.255)
| attribute | type | Default values | Required | Introduções |
|---|---|---|---|---|
| address | string | yes | ||
| port | number | yes | ||
| message | string/ArrayBuffer | yes | ||
| offset | number | 0 | no | O deslocamento para enviar dados, válido apenas quando a mensagem é do tipo ArrayBuffer. |
| length | number | message.byteLength | no | O comprimento dos dados enviados, válido apenas quando a mensagem é de tipo de matriz |
| setBroadcast | boolean | false | no | não suportado |
UDPSocket.connect(Object object)
Preconect para o especificar IP e porta, você precisa cooperar.
UDPSocket.write()
O método de uso e envio é o mesmo se a conexão com não envia diferença (observe que, mesmo que a conexão você também precise preencher o endereço e os parâmetros da porta para T. Sua interface
UDPSocket.close()
Pare a instância do soquete UDP, equivalente à destruição. Após o desligamento, a instância do soquete do UDP não pode mais enviar mensagens e cada vez que udpsocket.send Will aciona um evento de erro e mensagem a função de retorno de evento também não é executada novamente. Na instância do UDPSocket Será criado pelas referências fortes nativas, garantindo que elas não sejam GC. No UDPSocket.close Reference a ele, e permite que o UDPSocket instantâneo de conformidade instantânea GC GC
UDPSocket.onClose(function callback)
Ouça o evento de fechamento
UDPSocket.offClose(function callback)
UNLISTEN CHET EVENTO
UDPSocket.onError(function callback)
Ouça eventos de erro
UDPSocket.offError(function callback)
Evento de erro de desconhecimento
UDPSocket.onListening(function callback)
Ouça para começar a ouvir mensagens de pacotes
UDPSocket.offListening(function callback)
O evento que iniciando mensagens de pacotes
UDPSocket.onMessage(function callback)
Ouça os eventos que receptor mensagens
UDPSocket.offMessage(function callback)
UNLISTEN para eventos que receptor mensagens
error
| Erro de código | Error message | Introductions |
|---|---|---|
| -1 | SErro YSTM | |
| -2 | SErro de interface do OCK | |
| -3 | SFalha final, sem permissões de interface | |
| 1 | SFalha final, erro de parâmetro, endereço ilegal | |
| 2 | SFalha final, erro de parâmetro, porto ilegal |