# Module: 基础能力-mogs

基础能力-mogs()

MOGS 基础模块

description 提供 MOGS-SDK 基础能力。

author ericjxzhang

# Other

名称 功能说明
AdStyle
AuthSetting 用户授权设置信息
BannerAd banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。
CardImage
CardText
CreateBannerAdByCaseIdParams
CreateBannerAdByUnitIdParams
CreateGridAdByCaseIdParams
CreateGridAdByUnitIdParams
CreateInterstitialAdByCaseIdParams
CreateInterstitialAdByUnitIdParams
CreateRewardedVideoAdByCaseIdParams
CreateRewardedVideoAdByUnitIdParams
CustomImageCard
CustomImageCardInfo
ExitMiniProgramParams
ExitMiniProgramRes
ExitVoIPChatParams
ExitVoIPChatRes
GetGameSoundStatusParams 获取游戏音效开启状态 参数类型
GetGameSoundStatusRes 获取游戏音效开启状态 返回值类型
GetLogManagerParams
GetNetworkTypeParams
GetNetworkTypeRes
GetSettingParams
GetSettingRes
GetSystemInfoParams 获取系统信息 参数
GetSystemInfoRes 获取系统信息 返回值
GetUserInteractiveStorageError
GetUserInteractiveStorageParams
GetUserInteractiveStorageRes
GetVoIPChatMuteDetailParams
GetVoIPChatMuteDetailRes
GridAd grid(格子) 广告组件。grid(格子) 广告组件是一个原生组件,层级比普通组件高。grid(格子) 广告组件默认是隐藏的,需要调用 GridAd.show() 将其显示。grid(格子) 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 GridAd.onResize() 事件中提供。
InterstitialAd 插屏广告组件。插屏广告组件是一个原生组件,层级比普通组件高。插屏广告组件每次创建都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用),默认是隐藏的,需要调用 InterstitialAd.show() 将其显示。
JoinVoIPChatParams
JoinVoIPChatRes
KVData 托管的 KV 数据
LaunchOptions
LoadSubpackageParams 分包加载 参数
LoadSubpackageRes 分包加载 返回值
LoadSubpackageTask 加载分包任务实例,用于获取分包加载状态。
LoadSubpackageTaskOnProgressUpdateCallback
LoginParams
LoginRes
MuteConfig
NavigateToMiniProgramParams
NavigateToMiniProgramRes
NetworkStatusChangeEvent
OnAdErrorCallback
OnAdResizeCallback
OnAddToFavoritesCallback 用户点击菜单「收藏」按钮时触发的事件的回调函数
OnAddToFavoritesCallbackRes 用户点击菜单「收藏」按钮时触发的事件的回调函数的返回值
OnGameSoundStatusChangeCallback 游戏音效开启状态改变时触发的回调函数。
OnHeadersReceivedCallback HTTP Response Header 事件的回调函数
OnHeadersReceivedCallbackParams
OnInteractiveStorageModifiedCallback 互动型托管数据事件发生的回调函数
OnNetworkStatusChangeCallback
OnRewardedVideoAdCloseCallback
OnShowCallback
OnShowCloseGameModalCallback 游戏音效开启状态改变时触发的回调函数。
OnVoIPChatInterruptedCallback 监听被动断开实时语音通话事件的回调函数
OnVoIPChatMembersChangedCallback 实时语音通话成员在线状态变化事件的回调函数
OnVoIPChatSpeakersChangedCallback 实时语音通话成员通话状态变化事件的回调函数
OpenTencentContractParams 打开腾讯协议页面 参数
OpenTencentContractRes 打开腾讯协议页面 返回值
Profile
RankExceedUserData
ReadClientConfigParams
ReadClientConfigRes
ReferrerInfo
RemoveUserCloudStorageParams
RemoveUserCloudStorageRes
RequestMidasPaymentQQParams 米大师支付 手Q平台所需参数
RequestMidasPaymentRes
RequestMidasPaymentWXParams 米大师支付 微信平台所需参数
RequestParams
RequestRes
RequestSubscribeMessageParams
RequestSubscribeMessageRes
RequestSubscribeSystemMessageParams
RequestSubscribeSystemMessageRes
RequestTask 网络请求任务对象
RewardedVideoAd 激励视频广告组件。激励视频广告组件是一个原生组件,层级比普通组件高。激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用),默认是隐藏的,需要调用 RewardedVideoAd.show() 将其显示。
SafeArea
SendShareCustomImagesParams {@link sendShareImage} 发送自定义图片卡片列表
SendShareImageContentParams {@link sendShareImage} 发送图片(Base64 格式)
SendShareImageParams {@link sendShareImage} 发送图片(URL 格式)
SendShareImageRes
SetEnableDebugParams 设置是否打开调试开关入参
SetEnableDebugRes 设置是否打开调试开关出参
SetFullScreenParams 设置全屏参数
SetFullScreenRes
SetGameSoundStatusParams 设置游戏音效开启状态参数
SetGameSoundStatusRes
SetUserCloudStorageParams
SetUserCloudStorageRes
ShowModalParams
ShowModalRes
ShowShareMenuParams
ShowShareMenuRes
ShowToastParams
ShowToastRes
SpeakerMuteDetail
SubscriptionsSetting 订阅消息设置
SystemInfo
UpdateVoIPChatMuteConfigParams
UpdateVoIPChatMuteConfigRes

# 基础

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

# 通用类型

名称 功能说明
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)。调用该方法创建的激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用)。

# 协议

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

# 基础

名称 功能说明
exitMiniProgram 退出当前小游戏,游戏正常结束时调用,游戏中途退出,请调用匹配系统
getLogManager 获取日志管理器对象
getSystemInfo 获取系统信息
getSystemInfoSync 获取系统信息
loadSubpackage 触发分包加载(仅支持微信、手Q)
offHide 取消监听小游戏隐藏到后台事件
offShow 取消监听小游戏回到前台的事件
onHide 监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。
onShow 监听小游戏回到前台的事件
setEnableDebug 设置是否打开调试开关。此开关对正式版也能生效。

# 媒体

名称 功能说明
exitVoIPChat 退出(销毁)实时语音通话
getGameSoundStatus 获取游戏音效开启状态。仅于 cymini 平台可用。
getVoIPChatMuteDetail 获取用户麦位状态(仅支持有乐)
joinVoIPChat 加入 (创建) 实时语音通话
offGameSoundStatusChange 取消监听游戏音效开启状态改变事件。仅于 cymini 平台可用。
offVoIPChatInterrupted 取消监听被动断开实时语音通话事件(仅支持微信,手Q)
offVoIPChatMembersChanged 取消监听实时语音通话成员在线状态变化事件
offVoIPChatSpeakersChanged 取消监听实时语音通话成员通话状态变化事件
onGameSoundStatusChange 监听游戏音效开启状态改变事件。仅于 cymini 平台可用。
onVoIPChatInterrupted 监听被动断开实时语音通话事件,包括小游戏切入后端时断开(仅支持微信,手Q)
onVoIPChatMembersChanged 监听实时语音通话成员在线状态变化事件。有成员加入/退出通话时触发回调
onVoIPChatSpeakersChanged 监听实时语音通话成员通话状态变化事件。有成员开始/停止说话时触发回调
setGameSoundStatus 设置游戏音效开启状态。仅于 cymini 平台可用。
注意:调用此接口会触发 `mogs.onGameSoundStatusChange`。
updateVoIPChatMuteConfig 更新实时语音静音设置

# 开放接口

名称 功能说明
getSetting 获取用户的当前设置
getUserInteractiveStorage 获取当前用户互动型托管数据对应 key 的数据
login 调用接口获取登录凭证(code)
navigateToMiniProgram 打开另一个小程序
onInteractiveStorageModified 监听成功修改好友的互动型托管数据事件
readClientConfig 读取有乐配置的文件内容(仅支持有乐)
removeUserCloudStorage 删除用户托管数据当中对应 key 的数据
requestSubscribeMessage 调起客户端小游戏订阅消息界面 返回用户订阅消息的操作结果
requestSubscribeSystemMessage 调起小游戏系统订阅消息界面 返回用户订阅消息的操作结果
setUserCloudStorage 对用户托管数据进行写数据操作

# 界面

名称 功能说明
onShowCloseGameModal 单机游戏退出时,二次确认弹框的事件通知。仅于 cymini 平台可用。
showModal 显示模态对话框
showToast 显示消息提示框

# 网络

名称 功能说明
request 发起 HTTPS 网络请求

# 虚拟支付

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

# 设备

名称 功能说明
getNetworkType 获取网络类型
offNetworkStatusChange 当前兼容平台<wx,qq,cymini>
取消监听网络变化事件
onNetworkStatusChange 监听网络状态变化事件
setFullScreen 设置全屏(仅支持有乐)

# 转发

名称 功能说明
offAddToFavorites 取消监听用户点击菜单「收藏」按钮时触发的事件
onAddToFavorites 监听用户点击菜单「收藏」按钮时触发的事件
sendShareImage 发送自定义分享图片给好友(仅支持有乐)
showShareMenu 显示当前页面的转发按钮

# References

# mogs

mogs: