# Module: 基础能力-mogs

基础能力-mogs()

# Other

名称 功能说明
AccelerometerEvent
AdStyle
AuthSetting 用户授权设置信息
AuthorizeParams
AuthorizeRes
BannerAd banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。
BatteryInfo
Camera
Canvas
CanvasRenderingContext2D
CardImage
CardText
CheckSessionParams
CheckSessionRes
ChooseImageParams
ChooseImageRes
ClearStorageParams
ClearStorageRes
CloseSocketParams
CloseSocketRes
CompassEvent
ConnectSocketParams
ConnectSocketRes
CreateBannerAdByCaseIdParams
CreateBannerAdByUnitIdParams
CreateCameraParams
CreateCameraRes
CreateGridAdByCaseIdParams
CreateGridAdByUnitIdParams
CreateInterstitialAdByCaseIdParams
CreateInterstitialAdByUnitIdParams
CreateRewardedVideoAdByCaseIdParams
CreateRewardedVideoAdByUnitIdParams
CreateUserInfoButtonParams
CreateVideoParams
CustomImageCard
CustomImageCardInfo
DeviceMotionEvent
DeviceOrientationChangeEvent
DownloadFileParams
DownloadFileRes
DownloadTask 一个可以监听下载进度变化事件,以及取消下载任务的对象
ExitMiniProgramParams
ExitMiniProgramRes
ExitVoIPChatParams
ExitVoIPChatRes
FileSystemManagerAccessParams
FileSystemManagerAccessRes
FileSystemManagerAppendFileParams
FileSystemManagerAppendFileRes
FileSystemManagerCopyFileParams
FileSystemManagerCopyFileRes
FileSystemManagerGetFileInfoParams
FileSystemManagerGetFileInfoRes
FileSystemManagerGetSavedFileListParams
FileSystemManagerGetSavedFileListRes
FileSystemManagerImportFileParams
FileSystemManagerImportFileRes
FileSystemManagerMkdirParams
FileSystemManagerMkdirRes
FileSystemManagerReadFileParams
FileSystemManagerReadFileRes
FileSystemManagerReaddirParams
FileSystemManagerReaddirRes
FileSystemManagerRemoveSavedFileParams
FileSystemManagerRemoveSavedFileRes
FileSystemManagerRenameParams
FileSystemManagerRenameRes
FileSystemManagerRmdirParams
FileSystemManagerRmdirRes
FileSystemManagerSaveFileParams
FileSystemManagerSaveFileRes
FileSystemManagerShareFileParams
FileSystemManagerShareFileRes
FileSystemManagerStatParams
FileSystemManagerStatRes
FileSystemManagerUnlinkParams
FileSystemManagerUnlinkRes
FileSystemManagerUnzipParams
FileSystemManagerUnzipRes
FileSystemManagerWriteFileParams
FileSystemManagerWriteFileRes
GetAvailableAudioSourcesParams
GetAvailableAudioSourcesRes
GetBatteryInfoParams
GetBatteryInfoRes
GetClipboardDataParams
GetClipboardDataRes
GetDeviceCryptoFileHostParams
GetDeviceCryptoFileHostRes
GetGameSoundStatusParams 获取游戏音效开启状态 参数类型
GetGameSoundStatusRes 获取游戏音效开启状态 返回值类型
GetLocationParams
GetLocationRes
GetLogManagerParams
GetNetworkTypeParams
GetNetworkTypeRes
GetScreenBrightnessParams
GetScreenBrightnessRes
GetSettingParams
GetSettingRes
GetShareInfoParams
GetShareInfoRes
GetStorageInfoParams
GetStorageInfoRes
GetStorageParams
GetStorageRes
GetSystemInfoParams 获取系统信息 参数
GetSystemInfoRes 获取系统信息 返回值
GetTextLineHeightParams
GetUserInfoParams
GetUserInfoRes
GetUserInteractiveStorageError
GetUserInteractiveStorageParams
GetUserInteractiveStorageRes
GetVoIPChatMuteDetailParams
GetVoIPChatMuteDetailRes
GridAd grid(格子) 广告组件。grid(格子) 广告组件是一个原生组件,层级比普通组件高。grid(格子) 广告组件默认是隐藏的,需要调用 GridAd.show() 将其显示。grid(格子) 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 GridAd.onResize() 事件中提供。
GyroscopeEvent
HideKeyboardParams
HideKeyboardRes
HideLoadingParams
HideLoadingRes
HideShareMenuParams
HideShareMenuRes
HideToastParams
HideToastRes
Image 图片对象
InnerAudioContext
InterstitialAd 插屏广告组件。插屏广告组件是一个原生组件,层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用),默认是隐藏的,需要调用 InterstitialAd.show() 将其显示。
JoinVoIPChatParams
JoinVoIPChatRes
KVData 托管的 KV 数据
LaunchOptions
LoadSubpackageParams 分包加载 参数
LoadSubpackageRes 分包加载 返回值
LoadSubpackageTask 加载分包任务实例,用于获取分包加载状态。
LoadSubpackageTaskOnProgressUpdateCallback
LoginParams
LoginRes
MenuButtonBoundingClientRect 菜单按钮的布局位置信息
MinimizeMiniProgramParams
MinimizeMiniProgramRes
MouseEvent
MouseMoveEvent
MuteConfig
NavigateToMiniProgramParams
NavigateToMiniProgramRes
NetworkStatusChangeEvent
OnAccelerometerChangeCallback
OnAdErrorCallback
OnAdResizeCallback
OnAddToFavoritesCallback 用户点击菜单「收藏」按钮时触发的事件的回调函数
OnAddToFavoritesCallbackRes 用户点击菜单「收藏」按钮时触发的事件的回调函数的返回值
OnAudioErrorCallback
OnCompassChangeCallback
OnDeviceCryptoFilePortChangedCallback
OnDeviceMotionChangeCallback
OnDeviceOrientationChangeCallback
OnErrorCallback
OnErrorCallbackParams
OnGameSoundStatusChangeCallback 游戏音效开启状态改变时触发的回调函数。
OnGyroscopeChangeCallback
OnHeadersReceivedCallback HTTP Response Header 事件的回调函数
OnHeadersReceivedCallbackParams
OnInteractiveStorageModifiedCallback 互动型托管数据事件发生的回调函数
OnKeyEventCallback
OnKeyEventCallbackParams
OnKeyboardEventCallback
OnMessageCallback
OnMouseEventCallback
OnMouseMoveEventCallback
OnNetworkStatusChangeCallback
OnNetworkStatusChangeEvent
OnProgressCallback
OnProgressUpdateCallback
OnRewardedVideoAdCloseCallback
OnShareAppMessageCallback
OnShareMessageToFriendCallback
OnShowCallback
OnShowCloseGameModalCallback 游戏音效开启状态改变时触发的回调函数。
OnSocketCloseCallback
OnSocketErrorCallback
OnSocketMessageCallback
OnSocketOpenCallback
OnTimeUpdateCallback
OnTouchEventCallback
OnTouchEventCallbackParams
OnUDPSocketErrorCallback
OnUnhandledRejectionCallback
OnUnhandledRejectionCallbackParams
OnVideoErrorCallback
OnVoIPChatInterruptedCallback 监听被动断开实时语音通话事件的回调函数
OnVoIPChatMembersChangedCallback 实时语音通话成员在线状态变化事件的回调函数
OnVoIPChatSpeakersChangedCallback 实时语音通话成员通话状态变化事件的回调函数
OnWheelCallback
OnWindowResizeCallback
OpenDataContext
OpenTencentContractParams 打开腾讯协议页面 参数
OpenTencentContractRes 打开腾讯协议页面 返回值
ParameterItem
PreviewImageParams
PreviewImageRes
Profile
RankExceedUserData
ReadClientConfigParams
ReadClientConfigRes
RecorderManager
ReferrerInfo
RemoveStorageParams
RemoveStorageRes
RemoveUserCloudStorageParams
RemoveUserCloudStorageRes
ReportMonitorParams
ReportMonitorRes
RequestAnimationFrameCallback
RequestMidasPaymentQQParams 米大师支付 手Q平台所需参数
RequestMidasPaymentRes
RequestMidasPaymentWXParams 米大师支付 微信平台所需参数
RequestParams
RequestRes
RequestSubscribeMessageParams
RequestSubscribeMessageRes
RequestSubscribeSystemMessageParams
RequestSubscribeSystemMessageRes
RequestTask 网络请求任务对象
RewardedVideoAd 激励视频广告组件。激励视频广告组件是一个原生组件,层级比普通组件高。激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用),默认是隐藏的,需要调用 RewardedVideoAd.show() 将其显示。
SafeArea
SaveBase64ImageToFileParams
SaveBase64ImageToFileRes
SaveFileToDiskParams
SaveFileToDiskRes
SaveImageToPhotosAlbumParams
SaveImageToPhotosAlbumRes
SavedFile
SendShareCustomImagesParams {@link sendShareImage} 发送自定义图片卡片列表
SendShareImageContentParams {@link sendShareImage} 发送图片(Base64 格式)
SendShareImageParams {@link sendShareImage} 发送图片(URL 格式)
SendShareImageRes
SendSocketMessageParams
SendSocketMessageRes
SetClipboardDataParams
SetClipboardDataRes
SetEnableDebugParams 设置是否打开调试开关入参
SetEnableDebugRes 设置是否打开调试开关出参
SetFullScreenParams 设置全屏参数
SetFullScreenRes
SetGameSoundStatusParams 设置游戏音效开启状态参数
SetGameSoundStatusRes
SetInnerAudioOptionParams
SetInnerAudioOptionRes
SetKeepScreenOnParams
SetKeepScreenOnRes
SetMenuStyleParams
SetMenuStyleRes
SetMessageToFriendQueryParams
SetMessageToFriendQueryRes
SetNavigationBarParams
SetNavigationBarRes
SetScreenBrightnessParams
SetScreenBrightnessRes
SetStatusBarStyleParams
SetStatusBarStyleRes
SetStorageParams
SetStorageRes
SetUserCloudStorageParams
SetUserCloudStorageRes
SetWindowSizeParams
SetWindowSizeRes
ShareAppMessageParams
ShareAppMessageRes
ShowActionSheetParams
ShowActionSheetRes
ShowKeyboardParams
ShowKeyboardRes
ShowLoadingParams
ShowLoadingRes
ShowModalParams
ShowModalRes
ShowShareMenuParams
ShowShareMenuRes
ShowToastParams
ShowToastRes
SocketTask WebSocket 任务,可通过 mogs.connectSocket() 接口创建返回
SpeakerMuteDetail
StartAccelerometerParams
StartAccelerometerRes
StartCompassParams
StartCompassRes
StartDeviceMotionListeningParams
StartDeviceMotionListeningRes
StartGyroscopeParams
StartGyroscopeRes
Stats 描述文件状态的对象
StopAccelerometerParams
StopAccelerometerRes
StopCompassParams
StopCompassRes
StopDeviceMotionListeningParams
StopDeviceMotionListeningRes
StopGyroscopeParams
StopGyroscopeRes
StorageInfo
SubscriptionsSetting 订阅消息设置
SystemInfo
TempFile
TemplateInfo
ToTempFilePathParams
ToTempFilePathRes
Touch
TrackBeginParams
TrackBeginRes
TrackEndParams
TrackEndRes
UDPSocket 一个 UDP Socket 实例,默认使用 IPv4 协议。
UpdateKeyboardParams
UpdateKeyboardRes
UpdateShareMenuParams
UpdateShareMenuRes
UpdateVoIPChatMuteConfigParams
UpdateVoIPChatMuteConfigRes
UploadFileParams
UploadFileRes
UploadTask 一个可以监听上传进度变化事件,以及取消上传任务的对象
UserInfo 用户信息
UserInfoButton 用户信息按钮
UserInfoButtonOnTapCallback
UserInfoButtonOnTapCallbackParams
UserInfoButtonStyle
VibrateLongParams
VibrateLongRes
VibrateShortParams
VibrateShortRes
Video
WebGLRenderingContext
WheelEvent
Worker Worker 实例,主线程中可通过 mogs.createWorker 接口获取,worker 线程中可通过全局变量 worker 获取。
WriteLogToClientParams 设置是否打开调试开关入参
WriteLogToClientRes 设置是否打开调试开关出参

# 基础

名称 功能说明
LogManager 日志管理器实例,可以通过 `mogs.getLogManager` 获取。

# 开放接口

名称 功能说明
FeedbackButton 创建打开意见反馈页面的按钮

# 网络

名称 功能说明
FileSystemManager 文件管理器

# 通用类型

名称 功能说明
MogsParams MOGS 异步 API 通用参数
MogsRes MOGS 通用返回值

# Other

名称 功能说明
createBannerAd 创建 banner 广告组件。请通过 mogs.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号 >= 2.0.4 后再使用该 API。每次调用该方法创建 banner 广告都会返回一个全新的实例。
createGridAd 创建 grid(格子) 广告组件。请通过 mogs.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号 >= 2.9.2 后再使用该 API。每次调用该方法创建 grid(格子) 广告都会返回一个全新的实例。
createInterstitialAd 创建插屏广告组件。请通过 mogs.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用)。
createRewardedVideoAd 创建激励视频广告组件。请通过 mogs.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号后再使用该 API(小游戏端要求 >= 2.0.4, 小程序端要求 >= 2.6.0)。调用该方法创建的激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用)。
createUserInfoButton

# Worker

名称 功能说明
createWorker 创建一个 Worker 线程。
目前限制最多只能创建一个 Worker,创建下一个 Worker 前请先调用 {@link Worker.terminate}

# 位置

名称 功能说明
getLocation 获取当前的地理位置、速度。

当用户离开小程序后,此接口无法调用。 开启高精度定位,接口耗时会增加,可指定 highAccuracyExpireTime 作为超时时间。 地图相关使用的坐标格式应为 gcj02。 |

# 协议

名称 功能说明
openTencentAccountCancelContract 游戏账号注销协议(仅支持微信)
openTencentBoardGameContract 腾讯棋牌网络游戏许可及服务协议(仅支持微信)
openTencentChildrenGuideContract 腾讯游戏儿童隐私保护指引(仅支持微信)
openTencentGameContract 腾讯游戏许可及服务协议(仅支持微信)
openTencentPrivacyContract 腾讯游戏隐私保护指引(仅支持微信)

# 基础

名称 功能说明
exitMiniProgram 退出当前小游戏,游戏正常结束时调用,游戏中途退出,请调用匹配系统
getLaunchOptionsSync 获取小游戏启动时的参数。
getLogManager 获取日志管理器对象
getSystemInfo 获取系统信息
getSystemInfoSync 获取系统信息
loadSubpackage 触发分包加载(仅支持微信、手Q)
minimizeMiniProgram 最小化单机游戏(仅支持有乐IOS版本)
offAudioInterruptionBegin 取消监听音频因为受到系统占用而被中断开始事件
offAudioInterruptionEnd 取消监听音频中断结束事件
offDestroy 取消监听webview将被销毁前的通知(仅支持有乐)
offError 取消监听全局错误事件
offHide 取消监听小游戏隐藏到后台事件
offKeyDown 取消监听键盘按键按下事件
offKeyUp 取消监听键盘按键弹起事件
offMouseDown 取消监听鼠标按键按下事件
offMouseMove 取消监听鼠标移动事件
offMouseUp 取消监听鼠标按键弹起事件
offShow 取消监听小游戏回到前台的事件
offTouchCancel 取消监听触点失效事件
offTouchEnd 取消监听触摸结束事件
offTouchMove 取消监听触点移动事件
offTouchStart 取消监听开始触摸事件
offUnhandledRejection 取消监听未处理的 Promise 拒绝事件
offWheel 取消监听鼠标滚轮事件
onAudioInterruptionBegin 监听音频因为受到系统占用而被中断开始事件。

以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。 此事件触发后,小程序内所有音频会暂停。 | | onAudioInterruptionEnd | 监听音频中断结束事件。 在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功 | | onBackPressed | web对战游戏中,当用户按返回键时,会通知此事件给web(仅支持有乐) | | onDestroy | 监听webview将被销毁前的通知,在webview销毁前300ms通知给web(仅支持有乐) | | onError | 监听全局错误事件 | | onHide | 监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。 | | onKeyDown | 监听键盘按键按下事件,仅适用于 PC 平台 | | onKeyUp | 监听键盘按键弹起事件,仅适用于 PC 平台 | | onMouseDown | 监听鼠标按键按下事件 | | onMouseMove | 监听鼠标移动事件 | | onMouseUp | 监听鼠标按键弹起事件 | | onShow | 监听小游戏回到前台的事件 | | onTouchCancel | 监听触点失效事件 | | onTouchEnd | 监听触摸结束事件 | | onTouchMove | 监听触点移动事件 | | onTouchStart | 监听开始触摸事件 | | onUnhandledRejection | 监听未处理的 Promise 拒绝事件 | | onWheel | 监听鼠标滚轮事件 | | setEnableDebug | 设置是否打开调试开关。此开关对正式版也能生效。 | | writeLogToClient | 写日志到客户端(仅支持有乐) |

# 媒体

名称 功能说明
chooseImage 从本地相册选择图片或使用相机拍照。
createCamera 创建相机
createInnerAudioContext 创建内部 audio 上下文 {@link InnerAudioContext} 对象。
createVideo 创建视频
exitVoIPChat 退出(销毁)实时语音通话
getAvailableAudioSources 获取当前支持的音频输入源
getGameSoundStatus 获取游戏音效开启状态。仅于 cymini 平台可用。
getRecorderManager 获取全局唯一的录音管理器 {@link RecorderManager}
getVoIPChatMuteDetail 获取用户麦位状态(仅支持有乐)
joinVoIPChat 加入 (创建) 实时语音通话
offGameSoundStatusChange 取消监听游戏音效开启状态改变事件。仅于 cymini 平台可用。
offVoIPChatInterrupted 取消监听被动断开实时语音通话事件(仅支持微信,手Q)
offVoIPChatMembersChanged 取消监听实时语音通话成员在线状态变化事件
offVoIPChatSpeakersChanged 取消监听实时语音通话成员通话状态变化事件
onGameSoundStatusChange 监听游戏音效开启状态改变事件。仅于 cymini 平台可用。
onVoIPChatInterrupted 监听被动断开实时语音通话事件,包括小游戏切入后端时断开(仅支持微信,手Q)
onVoIPChatMembersChanged 监听实时语音通话成员在线状态变化事件。有成员加入/退出通话时触发回调
onVoIPChatSpeakersChanged 监听实时语音通话成员通话状态变化事件。有成员开始/停止说话时触发回调
previewImage 在新页面中全屏预览图片。
预览的过程中用户可以进行保存图片、发送给朋友等操作。
saveBase64ImageToFile 将base64编码图片保存为图片文件(仅支持有乐)
saveImageToPhotosAlbum 保存图片到系统相册。
setGameSoundStatus 设置游戏音效开启状态。仅于 cymini 平台可用。
注意:调用此接口会触发 `mogs.onGameSoundStatusChange`。
setInnerAudioOption 设置 {@link InnerAudioContext} 的播放选项。
设置之后对当前小程序全局生效。
updateVoIPChatMuteConfig 更新实时语音静音设置

# 开放接口

名称 功能说明
authorize 提前向用户发起授权请求。

调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据,但不会实际调用对应接口。 如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。 更多用法详见 {@link 用户授权 (opens new window)}。 | | checkSession | 检查登录态是否过期。 | | createFeedbackButton | 创建打开意见反馈页面的按钮 | | getOpenDataContext | 获取开放数据域 | | getSetting | 获取用户的当前设置 | | getUserInfo | 获取用户信息。 | | getUserInteractiveStorage | 获取当前用户互动型托管数据对应 key 的数据 | | login | 调用接口获取登录凭证(code) | | navigateToMiniProgram | 打开另一个小程序 | | onInteractiveStorageModified | 监听成功修改好友的互动型托管数据事件 | | readClientConfig | 读取有乐配置的文件内容(仅支持有乐) | | removeUserCloudStorage | 删除用户托管数据当中对应 key 的数据 | | reportMonitor | 自定义业务数据监控上报接口 | | requestSubscribeMessage | 调起客户端小游戏订阅消息界面 返回用户订阅消息的操作结果 | | requestSubscribeSystemMessage | 调起小游戏系统订阅消息界面 返回用户订阅消息的操作结果 | | setUserCloudStorage | 对用户托管数据进行写数据操作 | | trackBegin | 记录耗时的开始 | | trackEnd | 记录耗时的结束 |

# 数据缓存

名称 功能说明
clearStorage 清理本地数据缓存
clearStorageSync {@link clearStorage} 的同步版本
getStorage 从本地缓存中异步获取指定 key 的内容
getStorageInfo 异步获取当前storage的相关信息
getStorageInfoSync {@link getStorageInfoSync} 的同步版本
getStorageSync {@link getStorage} 的同步版本
removeStorage 从本地缓存中移除指定 key
removeStorageSync {@link removeStorage} 的同步版本
setStorage 将数据存储在本地缓存中指定的 key 中。

会覆盖掉原来该 key 对应的内容。 除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。 单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。 | | setStorageSync | {@link setStorage} 的同步版本 |

# 文件

名称 功能说明
saveFileToDisk 保存文件系统的文件到用户磁盘,仅在 PC 端支持(仅支持微信,手Q)

# 渲染

名称 功能说明
cancelRequestAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求
createCanvas 创建一个画布对象。
首次调用创建的是显示在屏幕上的画布,之后调用创建的都是离屏画布。
createImage 创建一个图片对象
getTextLineHeight 获取一行文本的行高
loadFont 加载自定义字体文件
requestAnimationFrame 在下次进行重绘时执行。
setCursor 加载自定义光标,仅支持 PC 平台
setPreferredFramesPerSecond 可以修改渲染帧率。默认渲染帧率为 60 帧每秒。
修改后,requestAnimationFrame 的回调频率会发生改变。

# 界面

名称 功能说明
getMenuButtonBoundingClientRect 获取菜单按钮(右上角胶囊按钮)的布局位置信息。
坐标信息以屏幕左上角为原点。
hideKeyboard 隐藏键盘
hideLoading 隐藏 loading 提示框
hideToast 隐藏消息提示框
offKeyboardComplete 取消监听键盘收起的事件
offKeyboardConfirm 取消监听用户点击键盘 Confirm 按钮时的事件
offKeyboardInput 取消监听键盘输入事件
offWindowResize 取消监听窗口尺寸变化事件
onKeyboardComplete 监听键盘收起的事件
onKeyboardConfirm 监听用户点击键盘 Confirm 按钮时的事件
onKeyboardInput 监听键盘输入事件
onShowCloseGameModal 单机游戏退出时,二次确认弹框的事件通知。仅于 cymini 平台可用。
onWindowResize 监听窗口尺寸变化事件
setMenuStyle 动态设置通过右上角按钮拉起的菜单的样式。
setNavigationBar 动态设置当前页面的导航条(仅支持有乐)
setStatusBarStyle 当在配置中设置 showStatusBarStyle 时,屏幕顶部会显示状态栏。
此接口可以修改状态栏的样式。
setWindowSize 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南
showActionSheet 显示操作菜单
showKeyboard 显示键盘
showLoading 显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框
showModal 显示模态对话框
showToast 显示消息提示框
updateKeyboard 更新键盘输入框内容。
只有当键盘处于拉起状态时才会产生效果

# 网络

名称 功能说明
closeSocket 关闭 WebSocket 连接
connectSocket 创建一个 WebSocket 连接。使用前请注意阅读{@link 相关说明 (opens new window)}。
createUDPSocket 当前兼容平台<wx,qq>

创建一个 UDP Socket 实例。 使用前请注意阅读{@link 相关说明 (opens new window)}。 | | downloadFile | 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为 200MB。使用前请注意阅读相关说明。 注意:请在服务端响应的 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型。 | | getDeviceCryptoFileHost | 用于访问加密文件,访问流程为:先调用cryptoFileManager.getDeviceHost接口获取host、port、token参数。然后通过https://{host}:{port}?fileUrl={encode(url)}&token={token} 的地址来正常访问此加密文件,客户端会下载url对应的加密文件,并解密后返给web。(仅支持有乐) | | getFileSystemManager | 发起 HTTPS 网络请求 | | onDeviceCryptoFilePortChanged | 用于访问加密文件,监听端口变化事件(仅支持有乐) | | onSocketClose | 监听 WebSocket 连接关闭事件 | | onSocketError | 监听 WebSocket 错误事件 | | onSocketMessage | 监听 WebSocket 接受到服务器的消息事件 | | onSocketOpen | 监听 WebSocket 连接打开事件 | | request | 发起 HTTPS 网络请求 | | sendSocketMessage | 通过 WebSocket 连接发送数据。 需要先 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送 | | uploadFile | 将本地资源上传到服务器。 客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data。 使用前请注意阅读{@link 相关说明 (opens new window)}。 |

# 虚拟支付

名称 功能说明
requestMidasPayment 发起米大师支付

# 设备

名称 功能说明
getBatteryInfo 获取设备电量。同步 API mogs.getBatteryInfoSync 在 iOS 上不可用。
getBatteryInfoSync mogs.getBatteryInfo 的同步版本
getClipboardData 获取系统剪贴板的内容
getNetworkType 获取网络类型
getScreenBrightness 获取屏幕亮度
offAccelerometerChange 取消监听加速度数据事件。
offCompassChange 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听。
offDeviceMotionChange 取消监听设备方向变化事件,参数为空,则取消所有的事件监听。
offDeviceOrientationChange 取消监听横竖屏切换事件
offGyroscopeChange 取消监听陀螺仪数据变化事件。
offNetworkStatusChange 当前兼容平台<wx,qq,cymini>
取消监听网络变化事件
onAccelerometerChange 监听加速度数据事件。
频率根据 mogs.startAccelerometer() 的 interval 参数, 接口调用后会自动开始监听。
onCompassChange 监听罗盘数据变化事件。
频率:5 次/秒,接口调用后会自动开始监听,可使用 {@link stopCompass} 停止监听。
onDeviceMotionChange 监听设备方向变化事件。

频率根据 mogs.startDeviceMotionListening() 的 interval 参数。 可以使用 mogs.stopDeviceMotionListening() 停止监听。 | | onDeviceOrientationChange | 监听横竖屏切换事件 | | onGyroscopeChange | 监听陀螺仪数据变化事件。 频率根据 mogs.startDeviceMotion() 的 interval 参数。 可以使用 mogs.stopDeviceMotion() 停止监听。 | | onNetworkStatusChange | 监听网络状态变化事件 | | onUserCaptureScreen | 监听用户主动截屏事件。 用户使用系统截屏按键截屏时触发,只能注册一个监听 | | setClipboardData | 设置系统剪贴板的内容。 调用成功后,会弹出 toast 提示"内容已复制",持续 1.5s | | setFullScreen | 设置全屏(仅支持有乐) | | setKeepScreenOn | 设置是否保持常亮状态。 仅在当前小程序生效,离开小程序后设置失效。 | | setScreenBrightness | 设置屏幕亮度 | | startAccelerometer | 开始监听加速度数据。 | | startCompass | 开始监听罗盘数据 | | startDeviceMotionListening | 开始监听设备方向的变化。 | | startGyroscope | 开始监听陀螺仪数据。 | | stopAccelerometer | 停止监听加速度数据。 | | stopCompass | 开始监听罗盘数据 | | stopDeviceMotionListening | 停止监听陀螺仪数据。 | | stopGyroscope | 停止监听陀螺仪数据。 | | vibrateLong | 使手机发生较短时间的振动(400ms)。 | | vibrateShort | 使手机发生较短时间的振动(15 ms)。 |

# 转发

名称 功能说明
getShareInfo 获取转发详细信息
hideShareMenu 隐藏转发按钮
offAddToFavorites 取消监听用户点击菜单「收藏」按钮时触发的事件
offShareAppMessage 取消监听用户点击右上角菜单的「转发」按钮时触发的事件
onAddToFavorites 监听用户点击菜单「收藏」按钮时触发的事件
onShareAppMessage 监听用户点击右上角菜单的「转发」按钮时触发的事件
onShareMessageToFriend 监听主域接收 mogs.shareMessageToFriend 接口的成功失败通知
sendShareImage 发送自定义分享图片给好友(仅支持有乐)
setMessageToFriendQuery 设置 wx.shareMessageToFriend 接口 query 字段的值
shareAppMessage 主动拉起转发,进入选择通讯录界面。
有乐环境下请使用 {@link sendShareImage}
showShareMenu 显示当前页面的转发按钮
updateShareMenu 更新转发属性

# References

# mogs

mogs: