weapp - v1.0.8

wechat/network

network module provides network request bindings details in wechat document

Types

TCPSocket

</>

Socket APIs

TCPSocket type

pub type TCPSocket

UDPSocket

</>

UDPSocket type

pub type UDPSocket

Values

close_socket

</> 
pub fn close_socket(
  code c: Int,
  reason r: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.closeSocket Close WebSocket connection

connect_socket

</> 
pub fn connect_socket(
  url u: String,
  header h: object.JsObject,
  protocols p: List(String),
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.connectSocket Create a WebSocket connection

create_tcp_socket

</> 
pub fn create_tcp_socket(options o: object.JsObject) -> TCPSocket

wx.createTCPSocket Create a TCP Socket instance

create_udp_socket

</> 
pub fn create_udp_socket(options o: object.JsObject) -> UDPSocket

wx.createUDPSocket Create a UDP Socket instance

download_file

</> 
pub fn download_file(
  url u: String,
  header h: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.downloadFile Download a file from the network

download_task_abort

</> 
pub fn download_task_abort(task: object.JsObject) -> Nil

DownloadTask.abort Abort the download task

download_task_off_headers_received

</> 
pub fn download_task_off_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

DownloadTask.offHeadersReceived Cancel listening for headers received event

download_task_off_progress_update

</> 
pub fn download_task_off_progress_update(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

DownloadTask.offProgressUpdate Cancel listening for progress update event

download_task_on_headers_received

</> 
pub fn download_task_on_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

DownloadTask.onHeadersReceived Listen for headers received event

download_task_on_progress_update

</> 
pub fn download_task_on_progress_update(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

DownloadTask.onProgressUpdate Listen for progress update event

exit_voip_chat

</> 
pub fn exit_voip_chat(
  config c: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.exitVoIPChat Exit VoIP chat

get_local_ip_address

</> 
pub fn get_local_ip_address(
  options o: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getLocalIPAddress Get local IP address

get_network_type

</> 
pub fn get_network_type(
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

Advanced Network

wx.getNetworkType Get network type

join_1v1_chat

</> 
pub fn join_1v1_chat(
  config c: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.join1v1Chat Join 1v1 VoIP chat

join_voip_chat

</> 
pub fn join_voip_chat(
  config c: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.joinVoIPChat Join VoIP chat room

off_local_service_discovery_stop

</> 
pub fn off_local_service_discovery_stop(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offLocalServiceDiscoveryStop Remove mDNS service discovery stop event listener

off_local_service_found

</> 
pub fn off_local_service_found(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offLocalServiceFound Remove mDNS service found event listener

off_local_service_lost

</> 
pub fn off_local_service_lost(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offLocalServiceLost Remove mDNS service lost event listener

off_local_service_resolve_fail

</> 
pub fn off_local_service_resolve_fail(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offLocalServiceResolveFail Remove mDNS service resolve fail event listener

off_network_status_change

</> 
pub fn off_network_status_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offNetworkStatusChange Cancel listening for network status change events

off_network_weak_change

</> 
pub fn off_network_weak_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offNetworkWeakChange Remove network weak change event listener

off_socket_close

</> 
pub fn off_socket_close(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offSocketClose Remove WebSocket close event listener

off_socket_error

</> 
pub fn off_socket_error(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offSocketError Remove WebSocket error event listener

off_socket_message

</> 
pub fn off_socket_message(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offSocketMessage Remove WebSocket message event listener

off_socket_open

</> 
pub fn off_socket_open(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offSocketOpen Remove WebSocket connection open event listener

off_voip_chat_interrupted

</> 
pub fn off_voip_chat_interrupted(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offVoIPChatInterrupted Remove VoIP chat interrupted event listener

off_voip_chat_members_changed

</> 
pub fn off_voip_chat_members_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offVoIPChatMembersChanged Remove VoIP chat members changed event listener

off_voip_chat_speakers_changed

</> 
pub fn off_voip_chat_speakers_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offVoIPChatSpeakersChanged Remove VoIP chat speakers changed event listener

off_voip_chat_state_changed

</> 
pub fn off_voip_chat_state_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offVoIPChatStateChanged Remove VoIP chat state changed event listener

off_voip_video_members_changed

</> 
pub fn off_voip_video_members_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.offVoIPVideoMembersChanged Remove VoIP video members changed event listener

on_local_service_discovery_stop

</> 
pub fn on_local_service_discovery_stop(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onLocalServiceDiscoveryStop Listen for mDNS service discovery stop event

on_local_service_found

</> 
pub fn on_local_service_found(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onLocalServiceFound Listen for mDNS service found event

on_local_service_lost

</> 
pub fn on_local_service_lost(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onLocalServiceLost Listen for mDNS service lost event

on_local_service_resolve_fail

</> 
pub fn on_local_service_resolve_fail(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onLocalServiceResolveFail Listen for mDNS service resolve fail event

on_network_status_change

</> 
pub fn on_network_status_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onNetworkStatusChange Listen for network status change events

on_network_weak_change

</> 
pub fn on_network_weak_change(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onNetworkWeakChange Listen for network weak change event

on_socket_close

</> 
pub fn on_socket_close(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onSocketClose Listen for WebSocket connection closing events

on_socket_error

</> 
pub fn on_socket_error(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onSocketError Listen for WebSocket error events

on_socket_message

</> 
pub fn on_socket_message(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onSocketMessage Listen for WebSocket message events

on_socket_open

</> 
pub fn on_socket_open(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onSocketOpen Listen for WebSocket connection opening events

on_voip_chat_interrupted

</> 
pub fn on_voip_chat_interrupted(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onVoIPChatInterrupted Listen for VoIP chat interrupted event

on_voip_chat_members_changed

</> 
pub fn on_voip_chat_members_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onVoIPChatMembersChanged Listen for VoIP chat members changed event

on_voip_chat_speakers_changed

</> 
pub fn on_voip_chat_speakers_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onVoIPChatSpeakersChanged Listen for VoIP chat speakers changed event

on_voip_chat_state_changed

</> 
pub fn on_voip_chat_state_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onVoIPChatStateChanged Listen for VoIP chat state changed event

on_voip_video_members_changed

</> 
pub fn on_voip_video_members_changed(
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

wx.onVoIPVideoMembersChanged Listen for VoIP video members changed event

request

</> 
pub fn request(
  url u: String,
  method m: String,
  data d: object.JsObject,
  header h: object.JsObject,
  timeout t: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.request Initiate an HTTP request

request_task_abort

</> 
pub fn request_task_abort(task: object.JsObject) -> Nil

RequestTask.abort Abort the request

request_task_off_headers_received

</> 
pub fn request_task_off_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

RequestTask.offHeadersReceived Cancel listening for headers received event

request_task_on_chunk_received

</> 
pub fn request_task_on_chunk_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

RequestTask.onChunkReceived Listen for chunk received event

request_task_on_headers_received

</> 
pub fn request_task_on_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

RequestTask.onHeadersReceived Listen for headers received event

send_socket_message

</> 
pub fn send_socket_message(
  data d: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.sendSocketMessage Send data through WebSocket connection

set_enable_1v1_chat

</> 
pub fn set_enable_1v1_chat(config c: object.JsObject) -> Nil

wx.setEnable1v1Chat Enable 1v1 chat

start_local_service_discovery

</> 
pub fn start_local_service_discovery(
  options o: object.JsObject,
) -> Nil

mDNS Service Discovery

wx.startLocalServiceDiscovery Start searching for mDNS services

stop_local_service_discovery

</> 
pub fn stop_local_service_discovery() -> Nil

wx.stopLocalServiceDiscovery Stop searching for mDNS services

subscribe_voip_video_members

</> 
pub fn subscribe_voip_video_members(
  config c: object.JsObject,
) -> Nil

wx.subscribeVoIPVideoMembers Subscribe to VoIP video members

tcp_socket_bind_wifi

</> 
pub fn tcp_socket_bind_wifi(socket: TCPSocket) -> Nil

TCPSocket.bindWifi Bind TCP Socket to current wifi network

tcp_socket_close

</> 
pub fn tcp_socket_close(socket: TCPSocket) -> Nil

TCPSocket.close Close connection

tcp_socket_connect

</> 
pub fn tcp_socket_connect(
  socket: TCPSocket,
  address a: String,
  port p: Int,
) -> Nil

TCPSocket.connect Connect to specified address

tcp_socket_off_bind_wifi

</> 
pub fn tcp_socket_off_bind_wifi(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.offBindWifi Remove bind wifi event listener

tcp_socket_off_close

</> 
pub fn tcp_socket_off_close(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.offClose Remove close event listener

tcp_socket_off_connect

</> 
pub fn tcp_socket_off_connect(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.offConnect Remove connect event listener

tcp_socket_off_error

</> 
pub fn tcp_socket_off_error(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.offError Remove error event listener

tcp_socket_off_message

</> 
pub fn tcp_socket_off_message(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.offMessage Remove message event listener

tcp_socket_on_bind_wifi

</> 
pub fn tcp_socket_on_bind_wifi(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.onBindWifi Listen for bind wifi event

tcp_socket_on_close

</> 
pub fn tcp_socket_on_close(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.onClose Listen for close event

tcp_socket_on_connect

</> 
pub fn tcp_socket_on_connect(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.onConnect Listen for connect event

tcp_socket_on_error

</> 
pub fn tcp_socket_on_error(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.onError Listen for error event

tcp_socket_on_message

</> 
pub fn tcp_socket_on_message(
  socket: TCPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

TCPSocket.onMessage Listen for message event

tcp_socket_write

</> 
pub fn tcp_socket_write(
  socket: TCPSocket,
  data d: object.JsObject,
) -> Nil

TCPSocket.write Write data

udp_socket_bind

</> 
pub fn udp_socket_bind(socket: UDPSocket, port p: Int) -> Nil

UDPSocket.bind Bind to a random port or specified port

udp_socket_close

</> 
pub fn udp_socket_close(socket: UDPSocket) -> Nil

UDPSocket.close Close UDP Socket

udp_socket_connect

</> 
pub fn udp_socket_connect(
  socket: UDPSocket,
  address a: String,
  port p: Int,
) -> Nil

UDPSocket.connect Pre-connect to specified IP and port

udp_socket_off_close

</> 
pub fn udp_socket_off_close(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.offClose Remove close event listener

udp_socket_off_error

</> 
pub fn udp_socket_off_error(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.offError Remove error event listener

udp_socket_off_listened

</> 
pub fn udp_socket_off_listened(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.offListening Remove listening event listener

udp_socket_off_message

</> 
pub fn udp_socket_off_message(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.offMessage Remove message event listener

udp_socket_on_close

</> 
pub fn udp_socket_on_close(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.onClose Listen for close event

udp_socket_on_error

</> 
pub fn udp_socket_on_error(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.onError Listen for error event

udp_socket_on_listening

</> 
pub fn udp_socket_on_listening(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.onListening Listen for listening event

udp_socket_on_message

</> 
pub fn udp_socket_on_message(
  socket: UDPSocket,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UDPSocket.onMessage Listen for message event

udp_socket_send

</> 
pub fn udp_socket_send(
  socket: UDPSocket,
  address a: String,
  port p: Int,
  message m: object.JsObject,
) -> Nil

UDPSocket.send Send message to specified IP and port

udp_socket_set_ttl

</> 
pub fn udp_socket_set_ttl(socket: UDPSocket, ttl t: Int) -> Nil

UDPSocket.setTTL Set IP_TTL socket option

udp_socket_write

</> 
pub fn udp_socket_write(
  socket: UDPSocket,
  data d: object.JsObject,
) -> Nil

UDPSocket.write Write data

update_voip_chat_mute_config

</> 
pub fn update_voip_chat_mute_config(
  config c: object.JsObject,
) -> Nil

VoIP Real-time Voice

wx.updateVoIPChatMuteConfig Update VoIP mute configuration

upload_task_abort

</> 
pub fn upload_task_abort(task: object.JsObject) -> Nil

UploadTask.abort Abort the upload task

upload_task_off_headers_received

</> 
pub fn upload_task_off_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UploadTask.offHeadersReceived Cancel listening for headers received event

upload_task_off_progress_update

</> 
pub fn upload_task_off_progress_update(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UploadTask.offProgressUpdate Cancel listening for progress update event

upload_task_on_headers_received

</> 
pub fn upload_task_on_headers_received(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UploadTask.onHeadersReceived Listen for headers received event

upload_task_on_progress_update

</> 
pub fn upload_task_on_progress_update(
  task: object.JsObject,
  callback cb: fn(object.JsObject) -> Nil,
) -> Nil

UploadTask.onProgressUpdate Listen for progress update event

✨ Search Document