Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProtocolPush

en

Push 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

closePush

  • closePush(): void
  • en

    close Push services

    zh

    关闭推送

    example
    sdkhub.getPushPlugin().closePush();
    

    Returns void

delAlias

  • delAlias(alias: string): void
  • en

    delete alias

    zh

    删除别名

    example
    var params = "alias1";
    sdkhub.getPushPlugin().delAlias(params);
    

    Parameters

    • alias: string

      alias

    Returns void

delTags

  • delTags(tags: any): void
  • en

    delete tags

    zh

    删除标签,需要传入字符串数组

    example
    var params = ["tag1", "tag2"];
    sdkhub.getPushPlugin().delTags(params)
    

    Parameters

    • tags: any

      tags

    Returns void

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

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

removeListener

  • removeListener(): void
  • en

    remove the plugin listener

    zh

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

    example
    sdkhub.getUserPlugin().removeListener();
    

    Returns void

setAlias

  • setAlias(alias: string): void
  • en

    set alias

    zh

    设置别名

    example
    var params = "alias1";
    sdkhub.getPushPlugin().setAlias(params);
    

    Parameters

    • alias: string

      alias

    Returns void

setListener

  • en

    set the plugin listener

    zh

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

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

    Parameters

    Returns void

setTags

  • setTags(tags: any): void
  • en

    set tags

    zh

    设置标签,需要传入字符串数组

    example
    var params = ["tag1", "tag2"];
    sdkhub.getPushPlugin().setTags(params)
    

    Parameters

    • tags: any

      tags

    Returns void

startPush

  • startPush(): void
  • en

    start/register Push services

    zh

    开始推送,调用 SDK 的开始或注册推送方法,在成功回调中获取推送 Token。

    example
    sdkhub.getPushPlugin().startPush();
    

    Returns void

Generated using TypeDoc