NIMSDK-AOS 10.3.0-beta
载入中...
搜索中...
未找到
| Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | Protected 成员函数 | 所有成员列表
com.netease.nimlib.sdk.auth.LoginInfo类 参考

用户登录认证信息。 更多...

类 com.netease.nimlib.sdk.auth.LoginInfo 继承关系图:

class  LoginInfoBuilder
 

Public 成员函数

 LoginInfo (String account, String token)
 构造用户登录信息。 更多...
 
 LoginInfo (String account, String token, String appKey)
 构造用户登录信息。 更多...
 
 LoginInfo (String account, String token, String appKey, int customClientType)
 构造用户登录信息。 更多...
 
String getAccount ()
 用户账号,对应云信 IM 账号 accid。 更多...
 
String getToken ()
 登录 token。 更多...
 
int getAuthType ()
 SDK 登录 IM 的鉴权方式。 更多...
 
String getLoginExt ()
 登录自定义扩展字段,用于第三方服务器鉴权。当 authType 为 2 时,必须传入该字段。 更多...
 
String getAppKey ()
 当前应用的 AppKey。 更多...
 
int getCustomClientType ()
 自定义客户端类型,对应云信控制台中的自定义终端类型(需提前在控制台添加)。小于等于 0 视为没有自定义类型。 更多...
 
boolean valid ()
 检查用户登录信息,验证该用户是否已存在,该用户信息是否有效。 更多...
 
boolean equals (Object o)
 
String toString ()
 
int hashCode ()
 
int describeContents ()
 
void writeToParcel (Parcel dest, int flags)
 
JSONObject toJson ()
 

静态 Public 成员函数

static LoginInfo fromJson (JSONObject object)
 

静态 Public 属性

static final Creator< LoginInfoCREATOR
 

Protected 成员函数

 LoginInfo (Parcel in)
 构造用户登录信息。 更多...
 

详细描述

用户登录认证信息。

在文件 LoginInfo.java23 行定义.

构造及析构函数说明

◆ LoginInfo() [1/4]

com.netease.nimlib.sdk.auth.LoginInfo.LoginInfo ( String  account,
String  token 
)

构造用户登录信息。

参数说明:
参数名称 描述
account 用户账号,对应云信 IM 账号 accid
token 登录 token

在文件 LoginInfo.java62 行定义.

◆ LoginInfo() [2/4]

com.netease.nimlib.sdk.auth.LoginInfo.LoginInfo ( String  account,
String  token,
String  appKey 
)

构造用户登录信息。

参数说明:
参数名称 描述
account 用户账号,对应云信 IM 账号 accid
token 登录 token
appKey 当前应用的 AppKey
一个 AppKey 对应一个账号体系,如果不填,则优先使用 SDKOptions 中配置的 AppKey,如果没有则使用 AndroidManifest 中配置的 AppKey
即 AppKey 的取值优先级为:LoginInfo中的>SDKOptions 中的>AndroidManifest 中的 AppKey

在文件 LoginInfo.java89 行定义.

◆ LoginInfo() [3/4]

com.netease.nimlib.sdk.auth.LoginInfo.LoginInfo ( String  account,
String  token,
String  appKey,
int  customClientType 
)

构造用户登录信息。

参数说明:
参数名称 描述
account 用户账号,对应云信 IM 账号 accid
token 登录 token
appKey 当前应用的 AppKey
一个 AppKey 对应一个账号体系,如果不填,则优先使用 SDKOptions 中配置的 AppKey,如果没有则使用 AndroidManifest 中配置的 AppKey
即 AppKey 的取值优先级为:LoginInfo中的>SDKOptions 中的>AndroidManifest 中的 AppKey
customClientType 自定义客户端类型,对应云信控制台中的自定义终端类型(需提前在控制台添加)。小于等于 0 视为没有自定义类型

在文件 LoginInfo.java122 行定义.

◆ LoginInfo() [4/4]

com.netease.nimlib.sdk.auth.LoginInfo.LoginInfo ( Parcel  in)
protected

构造用户登录信息。

使用场景:
当需要在登录时传入 authType 或 loginExt 时,即需要通过动态登录或第三方回调登录时,需要使用该构造函数。

在文件 LoginInfo.java132 行定义.

成员函数说明

◆ describeContents()

int com.netease.nimlib.sdk.auth.LoginInfo.describeContents ( )

在文件 LoginInfo.java243 行定义.

◆ equals()

boolean com.netease.nimlib.sdk.auth.LoginInfo.equals ( Object  o)

在文件 LoginInfo.java214 行定义.

◆ fromJson()

static LoginInfo com.netease.nimlib.sdk.auth.LoginInfo.fromJson ( JSONObject  object)
static

在文件 LoginInfo.java274 行定义.

◆ getAccount()

String com.netease.nimlib.sdk.auth.LoginInfo.getAccount ( )

用户账号,对应云信 IM 账号 accid。

在文件 LoginInfo.java158 行定义.

◆ getAppKey()

String com.netease.nimlib.sdk.auth.LoginInfo.getAppKey ( )

当前应用的 AppKey。

在文件 LoginInfo.java189 行定义.

◆ getAuthType()

int com.netease.nimlib.sdk.auth.LoginInfo.getAuthType ( )

SDK 登录 IM 的鉴权方式。

  • 0(默认):表示最初的 loginToken的校验方式,即通过静态 token 鉴权。
  • 1:表示基于 appSecret 计算的 token 鉴权方式,即通过动态 token 鉴权。
  • 2:表示基于第三方回调的 token 鉴权方式,使用该方式时,登录信息中必须传入自定义扩展字段。

在文件 LoginInfo.java175 行定义.

◆ getCustomClientType()

int com.netease.nimlib.sdk.auth.LoginInfo.getCustomClientType ( )

自定义客户端类型,对应云信控制台中的自定义终端类型(需提前在控制台添加)。小于等于 0 视为没有自定义类型。

在文件 LoginInfo.java196 行定义.

◆ getLoginExt()

String com.netease.nimlib.sdk.auth.LoginInfo.getLoginExt ( )

登录自定义扩展字段,用于第三方服务器鉴权。当 authType 为 2 时,必须传入该字段。

在文件 LoginInfo.java182 行定义.

◆ getToken()

String com.netease.nimlib.sdk.auth.LoginInfo.getToken ( )

登录 token。

在文件 LoginInfo.java165 行定义.

◆ hashCode()

int com.netease.nimlib.sdk.auth.LoginInfo.hashCode ( )

在文件 LoginInfo.java238 行定义.

◆ toJson()

JSONObject com.netease.nimlib.sdk.auth.LoginInfo.toJson ( )

在文件 LoginInfo.java259 行定义.

◆ toString()

String com.netease.nimlib.sdk.auth.LoginInfo.toString ( )

在文件 LoginInfo.java229 行定义.

◆ valid()

boolean com.netease.nimlib.sdk.auth.LoginInfo.valid ( )

检查用户登录信息,验证该用户是否已存在,该用户信息是否有效。

返回
是否有效

在文件 LoginInfo.java205 行定义.

◆ writeToParcel()

void com.netease.nimlib.sdk.auth.LoginInfo.writeToParcel ( Parcel  dest,
int  flags 
)

在文件 LoginInfo.java248 行定义.

类成员变量说明

◆ CREATOR

final Creator<LoginInfo> com.netease.nimlib.sdk.auth.LoginInfo.CREATOR
static
初始值:
= new Creator<LoginInfo>() {
@Override
public LoginInfo createFromParcel(Parcel in) {
return new LoginInfo(in);
}
@Override
public LoginInfo[] newArray(int size) {
return new LoginInfo[size];
}
}
用户登录认证信息。
Definition: LoginInfo.java:23
LoginInfo(String account, String token)
构造用户登录信息。
Definition: LoginInfo.java:62

在文件 LoginInfo.java143 行定义.


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