UserInfo (android API)

java.lang.Object
- cn.jpush.im.android.api.model.UserInfo

public abstract class UserInfo
extends java.lang.Object

嵌套类概要

嵌套类
限定符和类型类和说明

static class UserInfo.Field

static class UserInfo.Gender

嵌套类
限定符和类型	类和说明
`static class`	`UserInfo.Field`
`static class`	`UserInfo.Gender`

构造器概要

构造器
构造器和说明

UserInfo()

构造器
构造器和说明
`UserInfo()`

方法概要

所有方法静态方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`static java.lang.String`	`collectionToJson(java.util.Collection<UserInfo> userInfos)` 将UserInfo对象的集合类转换为Json字符串,使用`fromJsonToCollection(String)`转换回来
`static UserInfo`	`fromJson(java.lang.String jsonString)` 从Json字符串转换成UserInfo对象,转换失败返回null
`static java.util.Collection<UserInfo>`	`fromJsonToCollection(java.lang.String jsonString)` 从Json字符串转换成Collection对象，方便UserInfo的集合类的转换, 转换失败返回null
`java.lang.String`	`getAddress()` 获取用户地址信息
`abstract java.lang.String`	`getAppKey()` 获取用户所属appkey
`java.lang.String`	`getAvatar()` 获取用户头像的mediaID
`abstract void`	`getAvatarBitmap(GetAvatarBitmapCallback callback)` 从本地获取用户头像的缩略头像bitmap，如果本地存在头像缩略图文件，直接返回；若不存在，会异步从服务器拉取。
`abstract java.io.File`	`getAvatarFile()` 从本地获取用户头像缩略图文件，头像缩略图会在调用`JMessageClient.getUserInfo(String, GetUserInfoCallback)` 时自动下载。
`abstract void`	`getAvatarFileAsync(DownloadAvatarCallback callback)` 已过时。 deprecated in sdk version 1.1.5,use `getAvatarBitmap(GetAvatarBitmapCallback)` instead
`abstract void`	`getBigAvatarBitmap(GetAvatarBitmapCallback callback)` 从本地获取用户头像的原图的bitmap，如果本地存在头像原图文件，直接返回；若不存在，会异步从服务器拉取。
`abstract java.io.File`	`getBigAvatarFile()` 从本地获取用户头像原图文件，当用户未设置头像，或者本地不存在头像原图文件时此接口返回Null。
`abstract long`	`getBirthday()` 获取用户生日，单位毫秒
`abstract int`	`getBlacklist()` 此用户是否在黑名单当中
`abstract java.lang.String`	`getDisplayName()` 获取该用户的展示名.
`java.lang.String`	`getExtra(java.lang.String key)` 获取指定扩展字段的内容
`java.util.Map<java.lang.String,java.lang.String>`	`getExtras()` 获取用户所有扩展字段
`UserInfo.Gender`	`getGender()` 获取用户性别信息
`int`	`getmTime()` 获取用户信息最后一次被更新的时间，单位-秒
`java.lang.String`	`getNickname()` 获取用户的昵称
`abstract int`	`getNoDisturb()` 用户是否在免打扰名单中
`abstract java.lang.String`	`getNotename()` 获取用户的备注名
`abstract java.lang.String`	`getNoteText()` 获取用户的备注信息
`java.lang.String`	`getRegion()` 获取用户地区信息
`java.lang.String`	`getSignature()` 获取用户签名
`int`	`getStar()`
`long`	`getUserID()` 获取用户的userID
`java.lang.String`	`getUserName()` 获取用户的username
`abstract boolean`	`isFriend()` 用户是否是你的好友
`abstract void`	`removeFromFriendList(BasicCallback callback)` 将用户从你的好友列表中移出
`boolean`	`setAddress(java.lang.String address)` 设置用户的address.
`abstract void`	`setBirthday(long timeInMillis)` 设置用户的birthday,单位毫秒.
`boolean`	`setGender(UserInfo.Gender gender)` 设置用户的gender.
`boolean`	`setNickname(java.lang.String nickname)` 设置用户的nickname.
`abstract void`	`setNoDisturb(int noDisturb, BasicCallback callback)` 将此用户设置为免打扰。
`void`	`setNotename(java.lang.String notename)` 已过时。 deprecated in 2.2.0,use `updateNoteName(String, BasicCallback)` instead.
`void`	`setNoteText(java.lang.String noteText)` 已过时。 deprecated in 2.2.0,use `updateNoteText(String, BasicCallback)` instead.
`boolean`	`setRegion(java.lang.String region)` 设置用户的region.
`boolean`	`setSignature(java.lang.String signature)` 设置用户的signature.
`abstract void`	`setUserExtras(java.util.Map<java.lang.String,java.lang.String> extras)` 设置用户的所有扩展字段，原来的扩展字段内容都会移除替换成传进来的map对象内容此接口仅在需要更新当前登录用户的信息时需要配合`JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)`使用其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
`abstract void`	`setUserExtras(java.lang.String key, java.lang.String value)` 设置用户的扩展字段 value为null时删除key对应的键值此接口仅在需要更新当前登录用户的信息时需要配合`JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)`使用其他情况下单独调用此接口仅会更新内存中的值，是无意义的
`java.lang.String`	`toJson()` 将对象转换为Json字符串,使用`fromJson(String)`转换回来
`abstract void`	`updateNoteName(java.lang.String noteName, BasicCallback callback)` 更新用户的备注名。
`abstract void`	`updateNoteText(java.lang.String noteText, BasicCallback callback)` 更新用户的备注信息。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - UserInfo
```
public UserInfo()
```
- 方法详细资料
  - getUserID
```
public long getUserID()
```
    获取用户的userID
    
    返回:
  - getUserName
```
public java.lang.String getUserName()
```
    获取用户的username
    
    返回:
  - getNickname
```
public java.lang.String getNickname()
```
    获取用户的昵称
    
    返回:
  - getNotename
```
public abstract java.lang.String getNotename()
```
    获取用户的备注名
    
    返回:
  - getNoteText
```
public abstract java.lang.String getNoteText()
```
    获取用户的备注信息
    
    返回:
  - getBirthday
```
public abstract long getBirthday()
```
    获取用户生日，单位毫秒
    
    返回:
  - getSignature
```
public java.lang.String getSignature()
```
    获取用户签名
    
    返回:
  - getGender
```
public UserInfo.Gender getGender()
```
    获取用户性别信息
    
    返回:
  - getRegion
```
public java.lang.String getRegion()
```
    获取用户地区信息
    
    返回:
  - getAddress
```
public java.lang.String getAddress()
```
    获取用户地址信息
    
    返回:
  - getExtras
```
public java.util.Map<java.lang.String,java.lang.String> getExtras()
```
    获取用户所有扩展字段
    
    返回:
    
    无法修改的map对象
    
    从以下版本开始:
    
    2.3.0
  - getExtra
```
public java.lang.String getExtra(java.lang.String key)
```
    获取指定扩展字段的内容
    
    参数:
    
    key -
    
    返回:
    
    若extras map中存在该键值，则返回对应key的value，否则返回null
    
    从以下版本开始:
    
    2.3.0
  - getAvatar
```
public java.lang.String getAvatar()
```
    获取用户头像的mediaID
    
    返回:
    
    用户头像的mediaID，若未设置头像则返回null
  - getAvatarFile
```
public abstract java.io.File getAvatarFile()
```
    从本地获取用户头像缩略图文件，头像缩略图会在调用JMessageClient.getUserInfo(String, GetUserInfoCallback) 时自动下载。当用户未设置头像，或者自动下载失败时此接口返回Null。
    
    返回:
    
    用户缩略头像文件对象，若未设置头像或者未下载完成则返回null
  - getAvatarFileAsync
```
@Deprecated
public abstract void getAvatarFileAsync(DownloadAvatarCallback callback)
```
    已过时。 deprecated in sdk version 1.1.5,use getAvatarBitmap(GetAvatarBitmapCallback) instead
    
    异步获取用户缩略头像文件对象，如果本地存在头像缩略图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当用户未设置头像，或者下载失败时回调返回Null。
    
    参数:
    
    callback - 下载头像的回调接口
  - getAvatarBitmap
```
public abstract void getAvatarBitmap(GetAvatarBitmapCallback callback)
```
    从本地获取用户头像的缩略头像bitmap，如果本地存在头像缩略图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当用户未设置头像，或者下载失败时回调返回Null。
    所有的缩略头像bitmap在sdk内都会缓存，并且会有清理机制，所以上层不需要对缩略头像bitmap做缓存。
  - getBigAvatarFile
```
public abstract java.io.File getBigAvatarFile()
```
    从本地获取用户头像原图文件，当用户未设置头像，或者本地不存在头像原图文件时此接口返回Null。
    
    返回:
    
    用户头像原图文件对象，若未设置头像或者本地不存在头像原图文件则返回null
    
    从以下版本开始:
    
    2.3.0
  - getBigAvatarBitmap
```
public abstract void getBigAvatarBitmap(GetAvatarBitmapCallback callback)
```
    从本地获取用户头像的原图的bitmap，如果本地存在头像原图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当用户未设置头像，或者下载失败时回调返回Null。
    注意：在调用JMessageClient.updateUserAvatar(File, BasicCallback)上传头像时，若上传的头像未经压缩处理，调此接口则有可能出现OOM
  - getBlacklist
```
public abstract int getBlacklist()
```
    此用户是否在黑名单当中
    
    返回:
    
    1表示存在，0表示不存在
  - getNoDisturb
```
public abstract int getNoDisturb()
```
    用户是否在免打扰名单中
    
    返回:
    
    1表示存在，0表示不存在
  - getStar
```
public int getStar()
```
  - isFriend
```
public abstract boolean isFriend()
```
    用户是否是你的好友
    
    返回:
    
    true 表示是好友,false表示其他情况。
  - getAppKey
```
public abstract java.lang.String getAppKey()
```
    获取用户所属appkey
    
    返回:
  - setUserExtras
```
public abstract void setUserExtras(java.util.Map<java.lang.String,java.lang.String> extras)
```
    设置用户的所有扩展字段，原来的扩展字段内容都会移除替换成传进来的map对象内容此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    extras -
    
    从以下版本开始:
    
    2.3.0
  - setUserExtras
```
public abstract void setUserExtras(java.lang.String key,
                                   java.lang.String value)
```
    设置用户的扩展字段 value为null时删除key对应的键值此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的
    
    参数:
    
    key -
    
    value -
    
    从以下版本开始:
    
    2.3.0
  - setNickname
```
public boolean setNickname(java.lang.String nickname)
```
    设置用户的nickname. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    nickname - 待更新的nickname
    
    返回:
    
    操作结果 true - 成功，false - 失败
  - setBirthday
```
public abstract void setBirthday(long timeInMillis)
```
    设置用户的birthday,单位毫秒. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    timeInMillis - 待更新的birthday信息
  - setSignature
```
public boolean setSignature(java.lang.String signature)
```
    设置用户的signature. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    signature - 待更新的signature信息
    
    返回:
    
    操作结果 true - 成功，false - 失败
  - setGender
```
public boolean setGender(UserInfo.Gender gender)
```
    设置用户的gender. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    gender - 待更新的gender信息
    
    返回:
    
    操作结果 true - 成功，false - 失败
  - setRegion
```
public boolean setRegion(java.lang.String region)
```
    设置用户的region. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    region - 待更新的region信息
    
    返回:
    
    操作结果 true - 成功，false - 失败
  - setAddress
```
public boolean setAddress(java.lang.String address)
```
    设置用户的address. 此接口仅在需要更新当前登录用户的信息时需要配合JMessageClient#updateMyInfo(Field, UserInfo, BasicCallback)使用。
    其他情况下单独调用此接口仅会更新内存中的值，是无意义的。
    
    参数:
    
    address - 待更新的gender信息
    
    返回:
    
    操作结果 true - 成功，false - 失败
  - setNoDisturb
```
public abstract void setNoDisturb(int noDisturb,
                                  BasicCallback callback)
```
    将此用户设置为免打扰。
    
    参数:
    
    noDisturb - 1 -- 免打扰，其他 -- 非免打扰
    
    callback - 回调接口
  - removeFromFriendList
```
public abstract void removeFromFriendList(BasicCallback callback)
```
    将用户从你的好友列表中移出
    
    参数:
    
    callback - 结果回调
    
    从以下版本开始:
    
    1.4.0
  - setNotename
```
public void setNotename(java.lang.String notename)
```
    已过时。 deprecated in 2.2.0,use updateNoteName(String, BasicCallback) instead.
    
    设置用户的notename.
    
    参数:
    
    notename - notename.
  - setNoteText
```
public void setNoteText(java.lang.String noteText)
```
    已过时。 deprecated in 2.2.0,use updateNoteText(String, BasicCallback) instead.
    
    设置用户的note text.
    
    参数:
    
    noteText - noteText.
  - updateNoteName
```
public abstract void updateNoteName(java.lang.String noteName,
                                    BasicCallback callback)
```
    更新用户的备注名。仅当用户存在于当前用户的好友列表中时可以更新。
    
    参数:
    
    noteName - 新的备注名
    
    callback - 结果回调
    
    从以下版本开始:
    
    1.4.0
  - updateNoteText
```
public abstract void updateNoteText(java.lang.String noteText,
                                    BasicCallback callback)
```
    更新用户的备注信息。仅当用户存在于当前用户的好友列表中时可以更新。
    
    参数:
    
    noteText - 新的备注信息
    
    callback - 结果回调
    
    从以下版本开始:
    
    1.4.0
  - getmTime
```
public int getmTime()
```
    获取用户信息最后一次被更新的时间，单位-秒
    
    返回:
    
    用户信息最后一次被更新的时间
  - getDisplayName
```
public abstract java.lang.String getDisplayName()
```
    获取该用户的展示名. 展示名返回优先级为：备注名 > 用户昵称 > 用户名。即：有备注名则优先返回备注，没有备注如果用户有昵称则返回昵称，没有昵称则返回用户注册时的用户名, 本地未找到用户名则返回userID
    
    返回:
    
    用户的展示名
    
    从以下版本开始:
    
    2.2.1
  - toJson
```
public java.lang.String toJson()
```
    将对象转换为Json字符串,使用fromJson(String)转换回来
    
    返回:
    
    json格式的String
    
    从以下版本开始:
    
    2.6.1
  - collectionToJson
```
public static java.lang.String collectionToJson(java.util.Collection<UserInfo> userInfos)
```
    将UserInfo对象的集合类转换为Json字符串,使用fromJsonToCollection(String)转换回来
    
    参数:
    
    userInfos -
    
    返回:
    
    json格式的String
    
    从以下版本开始:
    
    2.6.1
  - fromJson
```
public static UserInfo fromJson(java.lang.String jsonString)
```
    从Json字符串转换成UserInfo对象,转换失败返回null
    
    参数:
    
    jsonString -
    
    返回:
    
    UserInfo，失败返回null
    
    从以下版本开始:
    
    2.6.0
  - fromJsonToCollection
```
public static java.util.Collection<UserInfo> fromJsonToCollection(java.lang.String jsonString)
```
    从Json字符串转换成Collection对象，方便UserInfo的集合类的转换, 转换失败返回null
    
    参数:
    
    jsonString -
    
    返回:
    
    Collection, 失败返回null
    
    从以下版本开始:
    
    2.6.0

类 UserInfo

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

UserInfo

方法详细资料

getUserID

getUserName

getNickname

getNotename

getNoteText

getBirthday

getSignature

getGender

getRegion

getAddress

getExtras

getExtra

getAvatar

getAvatarFile

getAvatarFileAsync

getAvatarBitmap

getBigAvatarFile

getBigAvatarBitmap

getBlacklist

getNoDisturb

getStar

isFriend

getAppKey

setUserExtras

setUserExtras

setNickname

setBirthday

setSignature

setGender

setRegion

setAddress

setNoDisturb

removeFromFriendList

setNotename

setNoteText

updateNoteName

updateNoteText

getmTime

getDisplayName

toJson

collectionToJson

fromJson

fromJsonToCollection