weapp - v1.0.6

wechat/base

base module provides frequently used miniprogram APIs extend them as much as one needs, all wechat bindings are asynchronous and returns a Promise

Types

Date

</>

javascript Date object

pub type Date

Values

add_phone_contact

</> 
pub fn add_phone_contact(
  first_name f: String,
  mobile_phone_number mp: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.addPhoneContact Add a contact to the phone book

check_session

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

wx.checkSession

choose_contact

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

wx.chooseContact Select a contact from the phone book

clear_storage

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

wx.clearStorage

get_api_category

</> 
pub fn get_api_category() -> String

wx.getApiCategory Get API category. Used to determine whether the current environment is a mini program, game, etc.

get_background_fetch_data

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

wx.getBackgroundFetchData Get background fetch data

get_background_fetch_token

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

wx.getBackgroundFetchToken Get background fetch token

get_clipboard

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

wx.getClipboardData

get_env_user_data_path

</> 
pub fn get_env_user_data_path() -> String

wx.env.USER_DATA_PATH Get user data directory path

get_file_info

</> 
pub fn get_file_info(
  path p: String,
  digest_algorithm a: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.getFileInfo

get_privacy_contract

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

wx.getPrivacyContract

get_privacy_setting

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

wx.getPrivacySetting

get_random_values

</> 
pub fn get_random_values(length l: Int) -> object.JsObject

Encryption (Random)

wx.getRandomValues Get cryptographically secure random numbers

get_router

</> 
pub fn get_router() -> object.JsObject

Custom Router

wx.router Get custom router

get_saved_file_list

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

wx.getSavedFileList

get_setting

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

wx.getSetting

get_storage

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

wx.getStorage

get_storage_info

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

wx.getStorageInfo

get_system_info

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

wx.getSystemInfo is duplicated to keep backward compatibility

get_update_manager

</> 
pub fn get_update_manager() -> object.JsObject

wx.getUpdateManager Get update manager for app updates

get_user_crypto_manager

</> 
pub fn get_user_crypto_manager() -> object.JsObject

User Crypto Manager

wx.getUserCryptoManager Get user crypto manager

hide_loading

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

wx.hideLoading

hide_tabbar

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

wx.hideTabbar

login

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

wx.login

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

wx.navigateBack

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

wx.navigateTo

now

</> 
pub fn now() -> Date

get timestamp of Date

off_app_hide

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

wx.offAppHide Remove app hide listener

off_app_show

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

App Event Off Listeners

wx.offAppShow Remove app show listener

off_error

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

wx.offError Remove error listener

off_lazy_load_error

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

wx.offLazyLoadError Remove lazy load error listener

off_page_not_found

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

wx.offPageNotFound Remove page not found listener

off_theme_change

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

wx.offThemeChange Remove theme change listener

off_unhandled_rejection

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

wx.offUnhandledRejection Remove unhandled rejection listener

on_background_fetch_data

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

wx.onBackgroundFetchData Listen for background fetch data event

open_document

</> 
pub fn open_document(
  path p: String,
  of t: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.openDocument

pre_download_subpackage

</> 
pub fn pre_download_subpackage(
  root_dir rd: String,
  name n: String,
) -> object.JsObject

Subpackage Pre-download

wx.preDownloadSubpackage Pre-download subpackage

redirect_to

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

wx.redirectTo Redirect to page in app, closing current page

relaunch

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

wx.reLaunch

remove_saved_file

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

wx.removeSavedFile

remove_storage

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

wx.removeStorage

request

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

wx.request Simplified request using object builder pattern For more control, use wechat/network.request() which accepts explicit parameters

request_payment

</> 
pub fn request_payment(
  time_stamp t: String,
  nonce_str n: String,
  pkg p: String,
  sign_type s: String,
  pay_sign ps: String,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.requestPayment

rewrite_route

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

wx.rewriteRoute Rewrite route with new parameters

router_add_route_builder

</> 
pub fn router_add_route_builder(
  router r: object.JsObject,
  name n: String,
  builder b: object.JsObject,
) -> Nil

Router.addRouteBuilder Add route builder

router_get_route_context

</> 
pub fn router_get_route_context(
  router r: object.JsObject,
) -> object.JsObject

Router.getRouteContext Get route context

router_remove_route_builder

</> 
pub fn router_remove_route_builder(
  router r: object.JsObject,
  name n: String,
) -> Nil

Router.removeRouteBuilder Remove route builder

save_file

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

wx.saveFile

scan_code

</> 
pub fn scan_code(
  scan_type st: List(String),
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.scanCode Scan the QR code

set_background_fetch_token

</> 
pub fn set_background_fetch_token(token t: String) -> Nil

Background Fetch

wx.setBackgroundFetchToken Set background fetch token

set_clipboard

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

wx.setClipboardData

set_navigation_bar

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

wx.setNavigationBarTitle

set_storage

</> 
pub fn set_storage(
  key k: String,
  value v: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.setStorage

show_loading

</> 
pub fn show_loading(
  title t: String,
  mask m: Bool,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.showLoading

show_tabbar

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

wx.showTabbar

show_toast

</> 
pub fn show_toast(
  title t: String,
  icon i: String,
  mask m: Bool,
  duration d: Int,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.showToast

switch_tab

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

wx.switchTab

to_payment

</> 
pub fn to_payment(p: String) -> Int

utility function convert string to wechat payment

Examples

> to_payment("2.9")
290

> to_payment("129.013")
12901

update_manager_apply_update

</> 
pub fn update_manager_apply_update(um: object.JsObject) -> Nil

UpdateManager.applyUpdate Apply the update and restart

update_manager_on_check_for_update

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

UpdateManager.onCheckForUpdate Listen for update check event

update_manager_on_update_failed

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

UpdateManager.onUpdateFailed Listen for update failed event

update_manager_on_update_ready

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

UpdateManager.onUpdateReady Listen for update ready event

update_wechat_app

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

Phase 17: Base/System (Remaining)

wx.updateWeChatApp Update client version. Jump to WeChat update page when client version is too low.

upload_file

</> 
pub fn upload_file(
  to url: String,
  path p: String,
  header h: object.JsObject,
  form f: object.JsObject,
  complete cb: fn() -> Nil,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

wx.uploadFile

user_crypto_manager_get_latest_user_key

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

UserCryptoManager.getLatestUserKey Get latest user key

user_crypto_manager_get_random_values

</> 
pub fn user_crypto_manager_get_random_values(
  manager m: object.JsObject,
  length l: Int,
) -> object.JsObject

UserCryptoManager.getRandomValues Get random values from crypto manager

vibrate_long

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

wx.vibrateLong

vibrate_short

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

wx.vibrateShort

ymd

</> 
pub fn ymd(
  d: Date,
) -> promise.Promise(Result(object.JsObject, object.WechatError))

utility function to convert Date to local YYYY-MM-DD asynchronous, a test is written as showcase

✨ Search Document