《Lua 各个系统调用方法说明》

AgentManager

AgentManager 的所有方法说明:

方法名 参数 返回值 说明
getInstance userdata 获取 AgentManager 的实例
init appKey:string
appSecret:string
privateKey:string
oauthLoginServer:string
初始化 AgentManager
loadAllPlugins 加载所有插件。
注:这里是加载在打包工具选择的所有 SDK,选了一个 Share,就只加载 Share 的 SDK,选择两个 SDK,就只加载这两个 SDK,不用担心加载很多 SDK。
unloadAllPlugins 卸载所加载的插件
getAnalyticsPlugin userdata 获取分析统计插件
getUserPlugin userdata 获取用户插件
getIAPPlugin table 获取所有支付插件
支付插件支付多个,所以返回的是 table
getSharePlugin userdata 获取分享插件
getSocialPlugin userdata 获取社交插件
getAdsPlugin userdata 获取广告插件
getPushPlugin userdata 获取推送插件
getChannelId string 获取渠道 ID
getCustomParam string 获取自定义参数
endManager 销毁 AgentManager

用户系统 ProtocolUser

用户系统可调用的方法说明:

方法名 参数 返回值 说明
login 1. 无
2. table
用户登录
isLogined bool 获取用户登录状态
getUserID string 获取登录用户 ID
isFunctionSupported funcName:string bool 是否支持 funcName,这个函数
getPluginId string 获取插件 ID

支付系统 ProtocolIAP

支付系统调用的方法说明:

方法名 参数 返回值 说明
payForProduct productInfo:table
例子:{key1="val1", key2="val2"}
支付
setResultListener function 设置支付监听的函数
getOrderId string 获取用户 ID
resetPayState funcName:string bool 重设支付状态
调用方式:ProtocolIAP:resetPayState()
getPluginId string 获取插件 ID

统计系统 ProtocolAnalytics

统计系统调用方法说明:

方法名 参数 返回值 说明
startSession 开始统计
stopSession 结束统计
logEvent eventID:string
eventParam:string
注册一个事件,eventParam 可以为空
logError errorID:string
message:string
注册一个 error
isFunctionSupported funcName:string bool 是否支持 funcName 这个函数
setSessionContinueMillis millis:number 设置 session 持续时间
logTimedEventBegin eventID:string 开始统计 eventID 这个事件
logTimedEventEnd eventID:string 结束统计 eventID 这个事件
setCaptureUncaughtException bool 是否开启接受异常

分享系统 ProtocolShare

分享系统调用方法说明:

方法名 参数 返回值 说明
share shareInfo: table,{key1="val1", key2="val2"} 分享一段内容
setResultListener func: function 设置监听函数

广告系统 ProtocolAds

广告系统调用方法说明:

方法名 参数 返回值 说明
showAds adsType:AdType(number)
idx:number,该类型广告索引
显示广告
hideAds adsType:AdType(number)
idx:number,该类型广告索引
隐藏广告
preloadAds adsType:AdType(number)
idx:number,该类型广告索引
预加载广告
queryPoints number 查询积分,(针对有积分广告)
spendPoints points:number 消费积分(针对有积分广告)
isAdTypeSupported adsType:AdType 查看是否支持该类型的广告
setAdsListener func:function 设置监听函数

推送系统 ProtocolPush

推送系统调用方法说明:

方法名 参数 返回值 说明
startPush 开启推送
closePush 关闭推送
setAlias alias:string,别名 设置别名
delAlias alias:string,别名 删除别名
setTags tags:table,{"young", "big"} 设置标签
delTags tags:table,{"young", "big"} 删除设置标签
setActionListener func:function 设置监听函数

社交系统 ProtocolSocial

社交系统可调用方法说明:

方法名 参数 返回值 说明
signIn 登录
signOut 登出
submitScore leadboardID:string
score:number
上传分数
showLeaderboard leadboardID:string 显示排行榜
unlockAchievement achInfo:table 解锁成就
showAchievements 显示所有成就
setListener funcName:function 设置监听函数

各个系统公共函数

各个系统公共函数说明:

方法名 参数 返回值 说明
callFuncWithParam 调用 funcName 这个方法
callStringFuncWithParam funcName:string, 函数名字
param1: PluginParam
string 调用 funcName 这个方法
callIntFuncWithParam funcName:string, 函数名字
param1: PluginParam
number(int) 调用 funcName 这个方法
callBoolFuncWithParam funcName:string, 函数名字
param1: PluginParam
number(0, 1) 调用 funcName 这个方法
callFloatFuncWithParam funcName:string, 函数名字
param1: PluginParam
number(float) 调用 funcName 这个方法
setPluginName plugin_name:string 设置插件名字
getPluginName string 获取插件名字
getPluginVersion string 获取插件版本号
getSDKVersion string 获取 SDK 版本号

callFuncWithParam 的调用示例:

--1.无 param 参数
user_plugin:callFuncWithParam("logout")

--2.有 param 参数
local param = PluginParam:create(ToolBarPlace.kToolBarTopLeft)
user_plugin:callFuncWithParam("showToolBar", param)

【评论区】