API
Class

wx ($UI/wxsys/lib/wx/wx)

使用范围:WX

Contents

class wx ($UI/wxsys/lib/wx/wx)

基础接口

Constructor Top

  wx ()

Static Properties & Enumerations Top

Base64 Base64

Base64

CollectionUtilFn CollectionUtilFn

CollectionUtilFn

CommonUtilFn CommonUtilFn

CommonUtilFn

Date Date

Date

DateTimeUtilFn DateTimeUtilFn

DateTimeUtilFn

Device Device

Device

EncryptUtilFn EncryptUtilFn

EncryptUtilFn

MathUtilFn MathUtilFn

MathUtilFn

Number Number

Number

RandomUtilFn RandomUtilFn

RandomUtilFn

String String

String

StringUtilFn StringUtilFn

StringUtilFn

UrlUtilFn UrlUtilFn

UrlUtilFn

Util Util

Util

Uuid UUID

UUID

Static Methods Top

Success chooseImage (ChooseImageparams args)
Success chooseLocation ()
void chooseVideo (ChooseVideoParams args)
void clearStorage ()
void closeSocket (CloseSocket args)
void connectSocket (ConnectSocket args)
void createAnimation (CreateAnimationParams args)
Wx.AudioContext createAudioContext ()
Wx.VideoContext createVideoContext ()
void downloadFile (DownloadFileParams args)
Success getBackgroundAudioPlayerState ()
Succsee getFileInfo (GetFileInfoParams args)
Success getImageInfo (GetImageInfoParams args)
Sucess getLocation (GetLocationParams args)
Success getNetworkType ()
void getSavedFileInfo (GetSavedFileInfo args)
void getSavedFileList ()
Success getStorage (GetStorageParams args)
Success getSystemInfo ()
void getSystemInfoSync ()
void hideNavigationBarLoading ()
void hideToast ()
void MakePhoneCall (MakePhoneCall args)
void navigateBack (NavigateBackParams args)
$UI/wxsys/JSON navigateBackMiniProgram ($UI/wxsys/JSON args)
void navigateTo (NavigateToParams args)
$UI/wxsys/JSON navigateToMiniProgram ($UI/wxsys/JSON args)
void onSocketError ()
void onSocketOpen ()
void openDocument (OpenDocument args)
void openLocation ($UI/wxsys/lib/wx/wx/openLocation/OpenLocationParams args)
void pauseBackgroundAudio ()
void pauseVoice ()
void playBackgroundAudio (PlayBackgroundAudioParams args)
void playVoice (PlayVoiceParams args)
void previewImage (PreviewImageParams args)
void redirectTo (RedirctToParams args)
void reLaunch (ReLaunchParams args)
void removeSavedFile (RemoveSavedFile args)
void removeStorage (RemoveStorageParams args)
Success request (RequestParams args)
Succsee saveFile (SaveFileParams args)
Success saveImageToPhotosAlbum (SaveImageParams args)
void saveVideoToPhotosAlbum (SaveVideoParams args)
Success scanCode (ScanCodeParams args)
void seekBackgroundAudio (SeekBackgroundAudioParams args)
void sendSocketMessage (SendSocketMessage args)
void setNavigationBarTitle (SetNavigationBarTitleParams args)
void setStorage (SetStorageParams args)
Success showActionSheet (ActionSheetParams args)
Success showModal (ShowModeParams args)
void showNavigationBarLoading ()
void showToast (ShowToastParams args)
void startRecord ()
void stopBackgroundAudio ()
void stopPullDownRefresh ()
void stopRecord ()
void stopVoice ()
void switchTab (SwitchTab args)
void uploadFile (UploadParams args)

Constructor details Top

public wx ()

基础接口

Static Properties & Enumerations Detail Top

static public Base64 Base64

Base64

static public CollectionUtilFn CollectionUtilFn

CollectionUtilFn

static public CommonUtilFn CommonUtilFn

CommonUtilFn

static public Date Date

Date

static public DateTimeUtilFn DateTimeUtilFn

DateTimeUtilFn

static public Device Device

Device

static public EncryptUtilFn EncryptUtilFn

EncryptUtilFn

static public MathUtilFn MathUtilFn

MathUtilFn

static public Number Number

Number

static public RandomUtilFn RandomUtilFn

RandomUtilFn

static public String String

String

static public StringUtilFn StringUtilFn

StringUtilFn

static public UrlUtilFn UrlUtilFn

UrlUtilFn

static public Util Util

Util

static public Uuid UUID

UUID

Static Methods Detail Top

static public Success chooseImage (ChooseImageparams args)

从本地相册选择图片或使用相机拍照

Parameters

ChooseImageparams args

属性值对

Return Value

Success

static public Success chooseLocation ()

​打开地图选择位置。

Return Value

Success

static public void chooseVideo (ChooseVideoParams args)

拍摄视频或从手机相册中选视频

Parameters

ChooseVideoParams args

属性值对

Return Value

void

static public void clearStorage ()

清理本地数据缓存

Return Value

void

static public void closeSocket (CloseSocket args)

关闭WebSocket连接。

Parameters

CloseSocket args

属性值对

Return Value

void

static public void connectSocket (ConnectSocket args)

将本地资源上传到开发者服务器

Parameters

ConnectSocket args

属性值对

Return Value

void

static public void createAnimation (CreateAnimationParams args)

​创建一个动画实例animation。调用实例的方法来描述动画。最后通过动画实例的export方法导出动画数据传递给组件的animation属性。

Parameters

CreateAnimationParams args

属性值对

Return Value

void

static public Wx.AudioContext createAudioContext ()

创建一个音频实例

Return Value

Wx.AudioContext

static public Wx.VideoContext createVideoContext ()

创建一个音频实例

Return Value

Wx.VideoContext

static public void downloadFile (DownloadFileParams args)

下载文件资源到本地

Parameters

DownloadFileParams args

属性值对

Return Value

void

static public Success getBackgroundAudioPlayerState ()

获取后台音乐播放状态

Return Value

Success

static public Succsee getFileInfo (GetFileInfoParams args)

获取文件信息

Parameters

GetFileInfoParams args

属性值对

Return Value

Succsee

static public Success getImageInfo (GetImageInfoParams args)

获取图片信息

Parameters

GetImageInfoParams args

属性值对

Return Value

Success

static public Sucess getLocation (GetLocationParams args)

​获取当前的地理位置、速度。

Parameters

GetLocationParams args

属性值对

Return Value

Sucess

static public Success getNetworkType ()

​获取网络类型

Return Value

Success

static public void getSavedFileInfo (GetSavedFileInfo args)

获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 WX.getFileInfo 接口

Parameters

GetSavedFileInfo args

属性值对

Return Value

void

static public void getSavedFileList ()

获取本地已保存的文件列表

Return Value

void

static public Success getStorage (GetStorageParams args)

从本地缓存中异步获取指定 key 对应的内容

Parameters

GetStorageParams args

属性值对

Return Value

Success

static public Success getSystemInfo ()

​获取系统信息(异步)

Return Value

Success

static public void getSystemInfoSync ()

​获取系统信息(同步)

Return Value

void

static public void hideNavigationBarLoading ()

隐藏导航条加载动画

Return Value

void

static public void hideToast ()

关闭显示的提示框

Return Value

void

static public void MakePhoneCall (MakePhoneCall args)

拨打电话

Parameters

MakePhoneCall args

属性值对

Return Value

void

根据设定的关闭页面数,连续关闭页面

Parameters

NavigateBackParams args

属性值对

Return Value

void

跳转到其它小程序

Parameters

$UI/wxsys/JSON args

属性值对

Return Value

$UI/wxsys/JSON

​打开新页面

Parameters

NavigateToParams args

属性值对

Return Value

void

跳转到其它小程序

Parameters

$UI/wxsys/JSON args

属性值对

Return Value

$UI/wxsys/JSON

static public void onSocketError ()

监听WebSocket错误

Return Value

void

static public void onSocketOpen ()

监听WebSocket连接打开事件

Return Value

void

static public void openDocument (OpenDocument args)

新开页面打开文档,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx

Parameters

OpenDocument args

属性值对

Return Value

void

static public void openLocation ($UI/wxsys/lib/wx/wx/openLocation/OpenLocationParams args)

​使用微信内置地图查看位置。

Parameters

$UI/wxsys/lib/wx/wx/openLocation/OpenLocationParams args

属性值对

Return Value

void

static public void pauseBackgroundAudio ()

暂停播放音乐

Return Value

void

static public void pauseVoice ()

暂停正在播放的语音

Return Value

void

static public void playBackgroundAudio (PlayBackgroundAudioParams args)

使用后台播放器播放音乐

Parameters

PlayBackgroundAudioParams args

属性值对

Return Value

void

static public void playVoice (PlayVoiceParams args)

开始播放语音,同时只允许一个语音文件正在播放,如果前一个语音文件还没播放完,将中断前一个语音播放

Parameters

PlayVoiceParams args

属性值对

Return Value

void

static public void previewImage (PreviewImageParams args)

预览图片

Parameters

PreviewImageParams args

属性值对

Return Value

void

static public void redirectTo (RedirctToParams args)

关闭当前页面后,打开新页面

Parameters

RedirctToParams args

属性值对

Return Value

void

static public void reLaunch (ReLaunchParams args)

关闭所有页面,打开到应用内的某个页面。

Parameters

ReLaunchParams args

属性值对

Return Value

void

static public void removeSavedFile (RemoveSavedFile args)

删除本地存储的文件

Parameters

RemoveSavedFile args

属性值对

Return Value

void

static public void removeStorage (RemoveStorageParams args)

从本地缓存中异步移除指定 key

Parameters

RemoveStorageParams args

属性值对

Return Value

void

static public Success request (RequestParams args)

发起请求

Parameters

RequestParams args

属性值对

Return Value

Success

static public Succsee saveFile (SaveFileParams args)

保存文件到本地

Parameters

SaveFileParams args

属性值对

Return Value

Succsee

static public Success saveImageToPhotosAlbum (SaveImageParams args)

保存图片到系统相册

Parameters

SaveImageParams args

属性值对

Return Value

Success

static public void saveVideoToPhotosAlbum (SaveVideoParams args)

保存视频到系统相册,需要用户授权

Parameters

SaveVideoParams args

属性值对

Return Value

void

static public Success scanCode (ScanCodeParams args)

扫描二维码

Parameters

ScanCodeParams args

属性值对

Return Value

Success

static public void seekBackgroundAudio (SeekBackgroundAudioParams args)

控制音乐播放进度

Parameters

SeekBackgroundAudioParams args

属性值对

Return Value

void

static public void sendSocketMessage (SendSocketMessage args)

通过 WebSocket 连接发送数据,需要先 WX#connectSocket,并在 WX#onSocketOpen 回调之后才能发送

Parameters

SendSocketMessage args

属性值对

Return Value

void

static public void setNavigationBarTitle (SetNavigationBarTitleParams args)

​设置页面标题

Parameters

SetNavigationBarTitleParams args

属性值对

Return Value

void

static public void setStorage (SetStorageParams args)

将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容,这是一个异步接口

Parameters

SetStorageParams args

属性值对

Return Value

void

static public Success showActionSheet (ActionSheetParams args)

​显示出列表选择框

Parameters

ActionSheetParams args

属性值对

Return Value

Success

static public Success showModal (ShowModeParams args)

​​显示出消息对话框

Parameters

ShowModeParams args

属性值对

Return Value

Success

static public void showNavigationBarLoading ()

​在页面上显示导航条加载动画

Return Value

void

static public void showToast (ShowToastParams args)

显示一个提示框

Parameters

ShowToastParams args

属性值对

Return Value

void

static public void startRecord ()

开始录音

Return Value

void

static public void stopBackgroundAudio ()

停止播放音乐

Return Value

void

static public void stopPullDownRefresh ()

停止当前页面下拉刷新

Return Value

void

static public void stopRecord ()

停止录音

Return Value

void

static public void stopVoice ()

结束正在播放的语音

Return Value

void

static public void switchTab (SwitchTab args)

显示主页中的指定页面

Parameters

SwitchTab args

属性值对

Return Value

void

static public void uploadFile (UploadParams args)

将本地资源上传到开发者服务器

Parameters

UploadParams args

属性值对

Return Value

void