agora_chat_SDK 1.0.6
agora java chat SDK
| Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
io.agora.push.PushHelper类 参考

Public 成员函数

void setPushListener (PushListener callback)
 
void init (Context context, PushConfig config)
 
void register ()
 
boolean unregister (boolean unbindToken)
 
void onReceiveToken (PushType type, final String token)
 
void onErrorResponse (PushType type, long resultCode)
 
PushType getPushType ()
 
String getPushToken ()
 
String getFCMPushToken ()
 
void setFCMPushToken (String token)
 
String getPushTokenWithType (PushType type)
 
void setPushTokenWithType (PushType type, final String token)
 
int randomDelay (int attempts)
 

静态 Public 成员函数

static PushHelper getInstance ()
 

详细描述

推送帮助类。

成员函数说明

◆ getFCMPushToken()

String io.agora.push.PushHelper.getFCMPushToken ( )

获取 FCM 推送的设备 token。

返回
FCM 推送的设备 token。

◆ getInstance()

static PushHelper io.agora.push.PushHelper.getInstance ( )
static

获取 PushHelper 的单例。

返回
PushHelper 的单例。

Gets a singleton of PushHelper.

返回
The singleton of PushHelper.

◆ getPushToken()

String io.agora.push.PushHelper.getPushToken ( )

获取推送的设备 token。

返回
推送的设备 token。

◆ getPushTokenWithType()

String io.agora.push.PushHelper.getPushTokenWithType ( PushType  type)

根据推送类型获取推送 token。

参数
type推送类型。
返回
推送 token。

◆ getPushType()

PushType io.agora.push.PushHelper.getPushType ( )

获取推送类型。

返回
推送类型。

◆ init()

void io.agora.push.PushHelper.init ( Context  context,
PushConfig  config 
)

初始化 PushHelper。

参数
context上下文。
config推送配置。

◆ onErrorResponse()

void io.agora.push.PushHelper.onErrorResponse ( PushType  type,
long  resultCode 
)

发生推送错误回调。当推送发生错误时,如绑定推送令牌失败时、解绑推送令牌失败时、不支持用户设置的推送类型等 SDK 会触发该回调。你可以通过 resultCode 了解具体的错误类型。 如果自定义的 PushListener 不为空,则将错误信息设置给 PushListener#onError(PushType, long)

参数
type推送类型。
resultCode错误码。

◆ onReceiveToken()

void io.agora.push.PushHelper.onReceiveToken ( PushType  type,
final String  token 
)

接收并上传设备 token。

参数
type推送类型。
token设备 token。

◆ register()

void io.agora.push.PushHelper.register ( )

注册推送。 登录成功后,由 SDK 调用,用户无需调用。

◆ setFCMPushToken()

void io.agora.push.PushHelper.setFCMPushToken ( String  token)

保存 FCM 推送的设备 token。

返回
FCM 推送的设备 token。

◆ setPushListener()

void io.agora.push.PushHelper.setPushListener ( PushListener  callback)

设置推送监听。 可重写 PushListener#isSupportPush(PushType, PushConfig),设置支持的推送类型。 SDK 支持的推送类型为 PushType.FCM,PushType.MIPUSH,PushType.HMSPUSH,PushType.MEIZUPUSH,PushType.OPPOPUSH,PushType.VIVOPUSH 这几种。如果开发者定义的支持推送类型多于这几种,将永远不会被匹配到,SDK 不会报错,但会选择推送类型为 PushType.NORMAL。

参数
callback自定义推送监听。

◆ setPushTokenWithType()

void io.agora.push.PushHelper.setPushTokenWithType ( PushType  type,
final String  token 
)

根据推送类型设置推送 token。

参数
type推送类型。
token推送 token。

◆ unregister()

boolean io.agora.push.PushHelper.unregister ( boolean  unbindToken)

解注册推送。 调用 ChatClient#logout(boolean) 时,由 SDK 调用。

参数
unbindToken是否解绑设备。
返回
解注册是否成功。

该类的文档由以下文件生成: