Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProtocolUser

en

User plugin protocol

zh

用户插件对象类

Hierarchy

Index

Methods

callBoolFuncWithParam

  • callBoolFuncWithParam(funcName: string, params?: any): boolean
  • en

    Call plugin function with function name

    zh

    需要直接返回 Boolean 值的扩展调用方法

    example
    var params = {...};
    var boolValue = sdkhub.getUserPlugin().callBoolFuncWithParam("funcName", params);
    

    Parameters

    • funcName: string

      function name

    • Optional params: any

      params

    Returns boolean

    the plugin function return value

callFloatFuncWithParam

  • callFloatFuncWithParam(funcName: string, params?: any): number
  • en

    Call plugin function with function name

    zh

    需要直接返回 Number 浮点数(对应 C++ 侧为 Float 型)值的扩展方法调用

    example
    var params = {...};
    var floatValue = sdkhub.getUserPlugin().callFloatFuncWithParam("funcName", params);
    

    Parameters

    • funcName: string

      function name

    • Optional params: any

      params

    Returns number

    the plugin function return value

callFuncWithParam

  • callFuncWithParam(funcName: string, params?: any): void
  • en

    Call plugin function with function name

    zh

    若接入的 SDK 中的所需方法,不在 Cocos SDKHub 框架的封装定义中,则我们需要通过该方法,通过传入方法名与所需参数进行调用。可参考各 SDK 插件说明文档和 Sample 中的调用方式

    example
    var params = {...};
    sdkhub.getUserPlugin().callFuncWithParam("funcName", params);
    

    Parameters

    • funcName: string

      function name

    • Optional params: any

      params

    Returns void

callIntFuncWithParam

  • callIntFuncWithParam(funcName: string, params?: any): number
  • en

    Call plugin function with function name

    zh

    需要直接返回 Number 整数(对应 C++ 侧为 Int 型)值的扩展调用方法

    example
    var params = {...};
    var intValue = sdkhub.getUserPlugin().callIntFuncWithParam("funcName", params);
    

    Parameters

    • funcName: string

      function name

    • Optional params: any

      params

    Returns number

    the plugin function return value

callStringFuncWithParam

  • callStringFuncWithParam(funcName: string, params?: any): string
  • en

    Call plugin function with function name

    zh

    需要直接返回 String 值的扩展调用方法

    example
    var params = {...};
    var str = sdkhub.getUserPlugin().callStringFuncWithParam("funcName", params);
    

    Parameters

    • funcName: string

      function name

    • Optional params: any

      params

    Returns string

    the plugin function return value

getPluginId

  • getPluginId(): string
  • en

    get the id of plugin

    zh

    获取插件 ID。接入 Cocos SDKHub 的游戏工程,可能接入多个渠道或多个相同功能的 SDK 插件,需要在代码中通过插件 ID 进行判断

    example
    var feePluginId = sdkhub.getFeePlugin().getPluginId();
    

    Returns string

    the id of plugin

getPluginVersion

  • getPluginVersion(): string
  • en

    get the version of plugin

    zh

    获取插件版本号,例如 "1.0.0_4.0.3",下划线前为插件的版本号,下划线后为接入平台 SDK 的版本号。同一个插件中,不同类型的 SDK 版本号也可能存在差异,所以不同类型插件获取的后半部分 SDK 版本号 的值也可能不同

    example
    var pluginVersion = sdkhub.getUserPlugin().getPluginVersion();
    

    Returns string

    the version of plugin

getSDKVersion

  • getSDKVersion(): string
  • en

    get the version of sdk

    zh

    获取插件对应 SDK 版本号,例如 "4.0.3",平台 SDK 的版本号。同一个插件中,不同类型的 SDK 版本号也可能存在差异

    example
    var sdkVersion = sdkhub.getUserPlugin().getSDKVersion();
    

    Returns string

    the version of sdk

getUserInfo

  • getUserInfo(): any
  • en

    get user info

    zh

    获取用户登录信息。若 SDK 可以在客户端完成登录验证并获取到用户唯一 ID。可通过该方法获取登录信息。可以读取 userID 参数作为用户唯一 ID

    example
    var userInfo = sdkhub.getUserPlugin().getUserInfo();
    

    Returns any

    user info

hideToolBar

  • hideToolBar(): void
  • en

    hide toolbar

    zh

    隐藏浮标,大部分情况无需开发者主动调用。

    example
    sdkhub.getUserPlugin().hideToolBar();
    

    Returns void

isFunctionSupported

  • isFunctionSupported(funcName: string): boolean
  • en

    Check function the plugin support or not

    zh

    判断插件是否支持该方法。调用各类型方法前,可以先调用本方法,检查插件是否支持该方法,再做调用。由于 JS 层调用不存在的方法名,也不会导致崩溃,该方法可选

    example
    if (sdkhub.getUserPlugin().isFunctionSupported("funcName")) {}
    

    Parameters

    • funcName: string

      function name

    Returns boolean

    if the function support, return true, else return false

login

  • login(): void
  • en

    user login

    zh

    登录,需要游戏对登录后的信息做处理,判断登录状态

    example
    sdkhub.getUserPlugin().login();
    

    Returns void

logout

  • logout(): void
  • en

    user logout

    zh

    登出,游戏端需要在回调中判断当前登录状态

    example
    sdkhub.getUserPlugin().logout();
    

    Returns void

removeListener

  • removeListener(): void
  • en

    remove the plugin listener

    zh

    移除该功能插件对象的回调监听

    example
    sdkhub.getUserPlugin().removeListener();
    

    Returns void

setListener

  • en

    set the plugin listener

    zh

    设置该功能对象的回调监听

    example
    sdkhub.getUserPlugin().setListener(this.onUserResult, this);
    

    Parameters

    Returns void

setUserInfo

  • setUserInfo(info: any): void
  • en

    set user info

    zh

    设置用户登录信息,若 SDK 需要服务端验证后才能获得唯一用户 ID。需要将插件所需的登录信息回传给 Cocos SDKHub

    example
    var params = {
        userID : "890839221",
        userName : "test_name"
    }
    sdkhub.getUserPlugin().setUserInfo(params);
    

    Parameters

    • info: any

      the user info for the method, please refer to the attached document

    Returns void

showAchievements

  • showAchievements(params: any): void
  • en

    show the page of achievements

    zh

    展示成就列表。若需要调用,传入参数需参考对应插件文档

    example
    var params = {...};
    sdkhub.getUserPlugin().showAchievements(params);
    

    Parameters

    • params: any

      the params for the method, please refer to the attached document

    Returns void

showLeaderBoard

  • showLeaderBoard(params: any): void
  • en

    show the id of LeaderBoard page

    zh

    展示排行榜。若需要调用,传入参数需参考对应插件文档

    example
    var params = {...};
    sdkhub.getUserPlugin().showAchievements(params);
    

    Parameters

    • params: any

      the params for the method, please refer to the attached document

    Returns void

showToolBar

  • en

    show toolbar with place

    zh

    显示浮标,大部分情况无需开发者主动调用。部分插件需要传入 ToolBarPlace 作为浮动工具栏初始位置

    example
    sdkhub.getUserPlugin().showToolBar(sdkhub.ToolBarPlace.kToolBarTopLeft);
    

    Parameters

    Returns void

submitScore

  • submitScore(params: any): void
  • en

    submit the score

    zh

    提交分数。若需要调用,传入参数需参考对应插件文档

    example
    var params = {...};
    sdkhub.getUserPlugin().submitScore(params);
    

    Parameters

    • params: any

      the params for the method, please refer to the attached document

    Returns void

unlockAchievement

  • unlockAchievement(params: any): void
  • en

    unlock achievement feature

    zh

    解锁成就事件。若需要调用,传入参数需参考对应插件文档

    example
    var params = {...}
    sdkhub.getUserPlugin().unlockAchievement(params);
    

    Parameters

    • params: any

      the params for the method, please refer to the attached document

    Returns void

Generated using TypeDoc