WeChat ミニプログラムでよく使用される API (概要共有)

1. システムでよく使われるAPI

1. wx.openAppAuthorizeSetting(Object object) はシステムの WeChat 認証管理ページにジャンプします

参数
1）success  接口调用成功的回调函数
2）fail  接口调用失败的回调函数
3）complete  接口调用结束的回调函数（调用成功、失败都会执行）

2. wx.getWindowInfo() ウィンドウ情報の取得

参数
1）pixelRatio	设备像素比
2）screenWidth	屏幕宽度，单位px
3）screenHeight	屏幕高度，单位px
4）windowWidth	可使用窗口宽度，单位px
5）windowHeight 可使用窗口高度，单位px
6）statusBarHeight	状态栏的高度，单位px
7）safeArea	在竖屏正方向下的安全区域
	left	安全区域左上角横坐标
	right	安全区域右下角横坐标
	top	安全区域左上角纵坐标
	bottom	安全区域右下角纵坐标
	width	安全区域的宽度，单位逻辑像素
	height	安全区域的高度，单位逻辑像素
8）screenTop	窗口上边缘的 y 值.

3. wx.getSystemInfoAsync(Object object) は、システム情報を非同期に取得します。特定の WeChat クライアントバージョンでサポートされている必要があります。サポートされていないクライアントでは、同期実装を使用して戻ります。

参数
1）success  接口调用成功的回调函数
2）fail  接口调用失败的回调函数
3）complete  接口调用结束的回调函数（调用成功、	失败都会执行）

4. wx.getAppAuthorizeSetting() は WeChat APP 認証設定を取得します

albumAuthorized	允许微信使用相册的开关（仅 iOS 有效）
bluetoothAuthorized	允许微信使用蓝牙的开关（仅 iOS 有效）
cameraAuthorized 允许微信使用摄像头的开关
locationAuthorized	允许微信使用定位的开关
locationReducedAccuracy	定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 有效）
microphoneAuthorized 允许微信使用麦克风的开关
notificationAuthorized 允许微信通知的开关
notificationAlertAuthorized	允许微信通知带有提醒的开关（仅 iOS 有效）
notificationBadgeAuthorized	允许微信通知带有标记的开关（仅 iOS 有效）
notificationSoundAuthorized	允许微信通知带有声音的开关（仅 iOS 有效）
phoneCalendarAuthorized	允许微信读写日历的开关

2. ミニプログラムの共通 API

アプレットの一般的なライフサイクル

wx.getLaunchOptionsSync は、アプレットの起動時にパラメータを取得します。App.onLaunch のコールバックパラメーターと一致します。
wx.getEnterOptionsSync 今回はアプレット起動時のパラメータを取得します。現在のスタートがコールドの場合、戻り値は App.onLaunch のコールバックパラメーターと一致し、現在のスタートがウォームの場合、戻り値は App.onShow と一致します。
wx.onUnhandledRejection(functionlistener) は、未処理の Promise 拒否イベントをリッスンします。このイベントは、App.onUnhandledRejection のコールバックタイミングおよびパラメーターと一致しています。
wx.onThemeChange(functionlistener) はシステムテーマ変更イベントをリッスンします。このイベントは、App.onThemeChange のコールバックタイミングと一致しています。
wx.onPageNotFound(functionlistener) アプレットが開くページが存在しないというイベントをリッスンします。このイベントは、App.onPageNotFound のコールバックタイミングと一致しています。
wx.onLazyLoadError(functionlistener) は、ミニプログラムの非同期コンポーネントの読み込み失敗イベントをリッスンします。
wx.onError(functionlistener) は、ミニプログラムのエラーイベントをリッスンします。スクリプトエラーやAPI呼び出しエラーなど。このイベントのコールバックのタイミングとパラメーターは App.onError と一致しています。
wx.onAudioInterruptionEnd(functionlistener) 音声中断終了イベントをリッスンします。onAudioInterruptionBegin イベントを受信すると、アプレット内のすべてのオーディオが一時停止され、このイベントを受信した後でのみ正常に再生できます。
wx.onAppShow(functionlistener) は、アプレットがフォアグラウンドに切り替わるイベントをリッスンします。このイベントは、App.onShow のコールバックパラメーターと一致しています。
wx.onAppHide(functionlistener) は、ミニプログラムのバックグラウンドイベントをリッスンします。このイベントは、App.onHide のコールバックタイミングと一致しています。

3. ルーティングジャンプAPI

wx.switchTab(Object object) は tabBar ページにジャンプし、他のすべての非 tabBar ページを閉じます
wx.reLaunch(Object object) はすべてのページを閉じて、アプリケーション内のページを開きます
wx.redirectTo(Object object) 現在のページを閉じて、アプリケーション内のページにジャンプします。ただし、タブバーページへのジャンプは許可されていません。
wx.navigateTo(Object object) 現在のページを保持し、アプリケーション内のページにジャンプします。ただし、タブバーページにジャンプすることはできません。元のページに戻るには、wx.navigateBack を使用します。ミニプログラムのページスタックには、最大 10 レベルを含めることができます。
wx.navigateBack(Object object) 現在のページを閉じて、前のページまたは複数レベルのページに戻ります。現在のページスタックは getCurrentPages を通じて取得して、返される必要があるレイヤーの数を決定できます。
wx.exitMiniProgram(Object object) 現在のミニプログラムを終了します。正常に呼び出すには、クリック動作が必要です。

4. 転送API

wx.updateShareMenu(Object object) は転送プロパティを更新します
wx.showShareMenu(Object object) は、現在のページの進むボタンを表示します。
wx.showShareImageMenu(Object object) は画像共有ポップアップウィンドウを開き、画像を友人に送信したり、収集したり、ダウンロードしたりできます。
wx.shareVideoMessage(Object オブジェクト) ビデオをチャットに転送する
wx.shareFileMessage(Object オブジェクト) ファイルをチャットに転送します

5. ページのインタラクション

wx.showToast(Object object) はメッセージプロンプトボックスを表示します
wx.showModal(Object object) はモーダルダイアログボックスを表示します
wx.showLoading(Object object) は読み込みプロンプトボックスを表示します。プロンプトボックスを閉じるには、wx.hideLoading を積極的に呼び出す必要があります。
wx.showActionSheet(Object object) はアクションメニューを表示します
wx.hideToast(Object object) はメッセージプロンプトボックスを非表示にします
wx.hideLoading(Object object) は読み込みプロンプトボックスを非表示にします
wx.enableAlertBeforeUnload(Object object) ミニプログラムページを開き、クエリダイアログボックスに戻ります。
wx.disableAlertBeforeUnload(Object object) ミニプログラムページを閉じて、クエリダイアログボックスに戻ります。

WeChat ミニ プログラムでよく使用される API (概要共有)