GroupInfo (android API)

java.lang.Object
- cn.jpush.im.android.api.model.GroupBasicInfo
- - cn.jpush.im.android.api.model.GroupInfo

public abstract class GroupInfo
extends GroupBasicInfo

Nested Class Summary
- Nested classes/interfaces inherited from class cn.jpush.im.android.api.model.GroupBasicInfo
  GroupBasicInfo.Type

Constructor Summary

Constructors
Constructor and Description

GroupInfo()

Constructors
Constructor and Description
`GroupInfo()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract void`	`addGroupKeeper(java.util.List<UserInfo> userInfos, BasicCallback callback)` 添加群管理员，管理员可以移除、禁言普通群成员，并且在公开群组里可以直接添加群成员和审核入群审批`GroupApprovalEvent`. 群主可以添加、取消管理员并且移除或禁言管理员
`abstract void`	`changeGroupAdmin(java.lang.String username, java.lang.String appKey, BasicCallback callback)` 移交群主,将群主移交給指定群内成员,移交群主后原群主成为普通群成员. 移交群主成功后群内所有成员会收到群主变更事件，SDK收到事件会以类型为`EventNotificationContent.EventNotificationType.group_owner_changed` 的消息事件方式上报
`abstract void`	`changeGroupType(GroupBasicInfo.Type type, BasicCallback callback)` 修改群组类型,群组类型修改成功后群内所有成员会收到群类型变更事件,SDK会以类型为`EventNotificationContent.EventNotificationType.group_type_changed` 的消息事件方式上报，注意只有群主有权限修改群组类型，并且如果修改后的群组类型未发生改变的话不会有事件上报
`static GroupInfo`	`fromJson(java.lang.String jsonString)` 从Json字符串转换成对象, 转换失败返回null
`static java.util.Collection<GroupInfo>`	`fromJsonToGroupCollection(java.lang.String jsonString)` 从Json字符串转换成Collection对象，方便GroupInfo的集合类的转换, 转换失败返回null
`abstract void`	`getAvatarBitmap(GetAvatarBitmapCallback callback)` 从本地获取群组头像的缩略图bitmap，如果本地存在头像缩略图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当群组未设置头像，或者下载失败时回调返回Null。所有的缩略头像bitmap在sdk内都会缓存，并且会有清理机制，所以上层不需要对缩略头像bitmap做缓存。
`abstract java.io.File`	`getAvatarFile()` 从本地获取群头像缩略图文件，头像缩略图会在调用`JMessageClient.getGroupInfo(long, GetGroupInfoCallback)` 时自动下载。当此群未设置头像，或者自动下载失败时此接口返回Null。
`abstract void`	`getBigAvatarBitmap(GetAvatarBitmapCallback callback)` 从本地获取群组头像的原图bitmap，如果本地存在头像原图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当群组未设置头像，或者下载失败时回调返回Null。注意：在调用`updateAvatar(File, String, BasicCallback)` 上传头像时，若上传的头像未经压缩处理，调此接口则有可能出现OOM
`abstract java.io.File`	`getBigAvatarFile()` 从本地获取群组头像原图文件，当群组未设置头像，或者本地不存在头像原图文件时此接口返回Null。
`abstract java.util.List<UserInfo>`	`getGroupKeepers()` 获取群管理员列表, 返回群内管理员的成员信息列表，管理员角色描述详见官方文档群组管理员
`abstract UserInfo`	`getGroupMemberInfo(java.lang.String username)` Deprecated. deprecated in jmessage 1.3.0 use `getGroupMemberInfo(String, String)` instead.
`abstract UserInfo`	`getGroupMemberInfo(java.lang.String username, java.lang.String appKey)` 根据appKey跨应用获取单个群成员UserInfo
`abstract java.util.List<UserInfo>`	`getGroupMembers()` 获取群成员userinfo列表。
`abstract java.lang.String`	`getGroupOwner()` 获取群主的username
`abstract java.util.List<UserInfo>`	`getGroupSilenceMembers()` 获取群成员禁言列表，返回群内被禁言的成员信息列表
`abstract int`	`getNoDisturb()` 群组是否在免打扰名单中
`abstract java.lang.String`	`getOwnerAppkey()` 获取群主所属appkey
`static java.lang.String`	`groupCollectionToJson(java.util.Collection<GroupInfo> groupInfos)` 将GroupInfo对象的集合类转换为Json字符串,使用`fromJsonToGroupCollection(String)`转换回来
`abstract int`	`isGroupBlocked()` 群组是否在被屏蔽的名单中
`abstract boolean`	`isKeepSilence(java.lang.String username, java.lang.String appKey)` 判断用户在该群内是否被禁言，若被禁言返回true，否则返回false
`abstract void`	`removeGroupKeeper(java.util.List<UserInfo> userInfos, BasicCallback callback)` 取消群管理员，管理员角色描述详见官方文档群组管理员
`abstract void`	`setBlockGroupMessage(int blocked, BasicCallback callback)` 设置屏蔽群消息,设置后将不会再收到此群的消息
`abstract void`	`setGroupMemSilence(java.lang.String username, java.lang.String appKey, boolean keepSilence, BasicCallback callback)` 群成员禁言状态设置,禁言后用户可正常接收消息，但无法向被禁言的群组中发送消息解禁后可正常发送消息,禁言状态设置成功后群内所有成员将会收到群禁言通知事件 sdk收到群禁言通知事件后会以类型为`ContentType.eventNotification` 的消息事件方式上报
`abstract void`	`setNoDisturb(int noDisturb, BasicCallback callback)` 将此群组设置为免打扰。设置之后收到此群消息时将不会在通知栏展示通知
`abstract void`	`updateAvatar(java.io.File avatar, java.lang.String format, BasicCallback callback)` 更新群组头像，建议用户在上传头像前先对头像先进行压缩，否则在调用`getBigAvatarBitmap(GetAvatarBitmapCallback)` 接口拿头像的原图时，有可能会抛出OOM异常。
`abstract void`	`updateDescription(java.lang.String groupDesc, BasicCallback callback)` 修改群组描述,新的描述不允许为空
`abstract void`	`updateName(java.lang.String groupName, BasicCallback callback)` 修改群组名称,新的群名称不允许为空

Methods inherited from class cn.jpush.im.android.api.model.GroupBasicInfo
fromJsonToGroupBasicCollection, getAvatar, getGroupDescription, getGroupFlag, getGroupID, getGroupLevel, getGroupName, getGroupType, getMaxMemberCount, groupBasicCollectionToJson, toJson

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupInfo
```
public GroupInfo()
```
- Method Detail
  - getNoDisturb
```
public abstract int getNoDisturb()
```
    群组是否在免打扰名单中
    
    Returns:
    
    1表示存在，0表示不存在
  - getGroupOwner
```
public abstract java.lang.String getGroupOwner()
```
    获取群主的username
    
    Returns:
  - getOwnerAppkey
```
public abstract java.lang.String getOwnerAppkey()
```
    获取群主所属appkey
    
    Since:
    
    1.4.0
  - getGroupMembers
```
public abstract java.util.List<UserInfo> getGroupMembers()
```
    获取群成员userinfo列表。
    
    Returns:
  - getGroupMemberInfo
```
@Deprecated
public abstract UserInfo getGroupMemberInfo(java.lang.String username)
```
    Deprecated. deprecated in jmessage 1.3.0 use getGroupMemberInfo(String, String) instead.
    
    获取单个群成员Userinfo，默认获取本应用appkey下用户信息,如果需要获取跨应用下其他用户的用户信息，请使用getGroupMemberInfo(String, String)
    
    Parameters:
    
    username - 指定群成员的username
    
    Returns:
    
    指定username的用户信息，如果本地未找到则返回null
  - getGroupMemberInfo
```
public abstract UserInfo getGroupMemberInfo(java.lang.String username,
                                            java.lang.String appKey)
```
    根据appKey跨应用获取单个群成员UserInfo
    
    Parameters:
    
    username - 指定群成员的username
    
    appKey - 群成员所属的appKey
    
    Returns:
    
    指定username的用户信息，如果本地未找到则返回null
  - setNoDisturb
```
public abstract void setNoDisturb(int noDisturb,
                                  BasicCallback callback)
```
    将此群组设置为免打扰。设置之后收到此群消息时将不会在通知栏展示通知
    
    Parameters:
    
    noDisturb - 1 -- 免打扰，其他 -- 非免打扰
    
    callback - 回调接口
  - setBlockGroupMessage
```
public abstract void setBlockGroupMessage(int blocked,
                                          BasicCallback callback)
```
    设置屏蔽群消息,设置后将不会再收到此群的消息
    
    Parameters:
    
    blocked - 1 -- 设置屏蔽; 其他(int) -- 取消屏蔽
    
    callback - 回调接口
    
    Since:
    
    2.1.0
  - isGroupBlocked
```
public abstract int isGroupBlocked()
```
    群组是否在被屏蔽的名单中
    
    Returns:
    
    1 -- 存在; 0 -- 不存在
    
    Since:
    
    2.1.0
  - getAvatarFile
```
public abstract java.io.File getAvatarFile()
```
    从本地获取群头像缩略图文件，头像缩略图会在调用JMessageClient.getGroupInfo(long, GetGroupInfoCallback) 时自动下载。当此群未设置头像，或者自动下载失败时此接口返回Null。
    
    Returns:
    
    群组缩略头像文件对象，若未设置头像或者未下载完成则返回null
    
    Since:
    
    2.3.0
  - getAvatarBitmap
```
public abstract void getAvatarBitmap(GetAvatarBitmapCallback callback)
```
    从本地获取群组头像的缩略图bitmap，如果本地存在头像缩略图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当群组未设置头像，或者下载失败时回调返回Null。
    所有的缩略头像bitmap在sdk内都会缓存，并且会有清理机制，所以上层不需要对缩略头像bitmap做缓存。
    
    Since:
    
    2.3.0
  - getBigAvatarFile
```
public abstract java.io.File getBigAvatarFile()
```
    从本地获取群组头像原图文件，当群组未设置头像，或者本地不存在头像原图文件时此接口返回Null。
    
    Returns:
    
    群组头像原图文件对象，若未设置头像或者本地不存在头像原图文件则返回null
    
    Since:
    
    2.3.0
  - getBigAvatarBitmap
```
public abstract void getBigAvatarBitmap(GetAvatarBitmapCallback callback)
```
    从本地获取群组头像的原图bitmap，如果本地存在头像原图文件，直接返回；若不存在，会异步从服务器拉取。下载完成后会将头像保存至本地并返回。当群组未设置头像，或者下载失败时回调返回Null。
    注意：在调用updateAvatar(File, String, BasicCallback) 上传头像时，若上传的头像未经压缩处理，调此接口则有可能出现OOM
    
    Since:
    
    2.3.0
  - updateAvatar
```
public abstract void updateAvatar(java.io.File avatar,
                                  java.lang.String format,
                                  BasicCallback callback)
```
    更新群组头像，建议用户在上传头像前先对头像先进行压缩，否则在调用getBigAvatarBitmap(GetAvatarBitmapCallback) 接口拿头像的原图时，有可能会抛出OOM异常。
    此接口可以指定头像文件在后台存储时的扩展名，如果填空或者不填，则后台存储文件时将没有扩展名。
    
    Parameters:
    
    avatar - 头像文件
    
    format - 文件扩展名，注意名称中不要包括"."
    
    callback - 回调对象
    
    Since:
    
    2.3.0
  - updateName
```
public abstract void updateName(java.lang.String groupName,
                                BasicCallback callback)
```
    修改群组名称,新的群名称不允许为空
    
    Parameters:
    
    groupName - 群名称
    
    callback - 回调接口
    
    Since:
    
    2.3.0
  - updateDescription
```
public abstract void updateDescription(java.lang.String groupDesc,
                                       BasicCallback callback)
```
    修改群组描述,新的描述不允许为空
    
    Parameters:
    
    groupDesc - 群组描述
    
    callback - 回调接口
    
    Since:
    
    2.3.0
  - setGroupMemSilence
```
public abstract void setGroupMemSilence(java.lang.String username,
                                        java.lang.String appKey,
                                        boolean keepSilence,
                                        BasicCallback callback)
```
    群成员禁言状态设置,禁言后用户可正常接收消息，但无法向被禁言的群组中发送消息解禁后可正常发送消息,禁言状态设置成功后群内所有成员将会收到群禁言通知事件 sdk收到群禁言通知事件后会以类型为ContentType.eventNotification 的消息事件方式上报
    
    Parameters:
    
    username - 待设置群成员的username
    
    appKey - 待设置群成员的appKey，传入空则默认使用本应用appKey
    
    keepSilence - //true 设置禁言， false 取消禁言
    
    callback -
    
    Since:
    
    2.4.0
  - getGroupSilenceMembers
```
public abstract java.util.List<UserInfo> getGroupSilenceMembers()
```
    获取群成员禁言列表，返回群内被禁言的成员信息列表
    
    Returns:
    
    Since:
    
    2.4.0
  - isKeepSilence
```
public abstract boolean isKeepSilence(java.lang.String username,
                                      java.lang.String appKey)
```
    判断用户在该群内是否被禁言，若被禁言返回true，否则返回false
    
    Parameters:
    
    username - 待判断用户的用户名
    
    appKey - 待判断用户的appKey，若传入空则默认使用本应用appKey
    
    Returns:
    
    Since:
    
    2.4.0
  - addGroupKeeper
```
public abstract void addGroupKeeper(java.util.List<UserInfo> userInfos,
                                    BasicCallback callback)
```
    添加群管理员，管理员可以移除、禁言普通群成员，并且在公开群组里可以直接添加群成员和审核入群审批GroupApprovalEvent.
    群主可以添加、取消管理员并且移除或禁言管理员
    
    Parameters:
    
    userInfos - 群成员UserInfo列表
    
    callback - 回调
    
    Since:
    
    2.5.0
  - removeGroupKeeper
```
public abstract void removeGroupKeeper(java.util.List<UserInfo> userInfos,
                                       BasicCallback callback)
```
    取消群管理员，管理员角色描述详见官方文档群组管理员
    
    Parameters:
    
    userInfos - 群成员UserInfo列表
    
    callback - 回调
    
    Since:
    
    2.5.0
  - getGroupKeepers
```
public abstract java.util.List<UserInfo> getGroupKeepers()
```
    获取群管理员列表, 返回群内管理员的成员信息列表，管理员角色描述详见官方文档群组管理员
    
    Returns:
    
    管理员的成员信息列表
    
    Since:
    
    2.5.0
  - changeGroupAdmin
```
public abstract void changeGroupAdmin(java.lang.String username,
                                      java.lang.String appKey,
                                      BasicCallback callback)
```
    移交群主,将群主移交給指定群内成员,移交群主后原群主成为普通群成员.
    移交群主成功后群内所有成员会收到群主变更事件，SDK收到事件会以类型为EventNotificationContent.EventNotificationType.group_owner_changed 的消息事件方式上报
    
    Parameters:
    
    username - 待移交者用户名
    
    appKey - 待移交者appKey, 若传入空则默认使用本应用appKey
    
    Since:
    
    2.5.0
  - changeGroupType
```
public abstract void changeGroupType(GroupBasicInfo.Type type,
                                     BasicCallback callback)
```
    修改群组类型,群组类型修改成功后群内所有成员会收到群类型变更事件,SDK会以类型为EventNotificationContent.EventNotificationType.group_type_changed 的消息事件方式上报，注意只有群主有权限修改群组类型，并且如果修改后的群组类型未发生改变的话不会有事件上报
    
    Parameters:
    
    type - 目标群组类型GroupInfo.Type
    
    callback - 修改群组类型结果回调
    
    Since:
    
    2.6.1
  - groupCollectionToJson
```
public static java.lang.String groupCollectionToJson(java.util.Collection<GroupInfo> groupInfos)
```
    将GroupInfo对象的集合类转换为Json字符串,使用fromJsonToGroupCollection(String)转换回来
    
    Parameters:
    
    groupInfos -
    
    Returns:
    
    json格式的String
    
    Since:
    
    2.6.1
  - fromJson
```
public static GroupInfo fromJson(java.lang.String jsonString)
```
    从Json字符串转换成对象, 转换失败返回null
    
    Parameters:
    
    jsonString -
    
    Returns:
    
    GroupInfo, 失败返回null
    
    Since:
    
    2.6.0
  - fromJsonToGroupCollection
```
public static java.util.Collection<GroupInfo> fromJsonToGroupCollection(java.lang.String jsonString)
```
    从Json字符串转换成Collection对象，方便GroupInfo的集合类的转换, 转换失败返回null
    
    Parameters:
    
    jsonString -
    
    Returns:
    
    Collection，失败返回null
    
    Since:
    
    2.6.0

Class GroupInfo

Nested Class Summary

Nested classes/interfaces inherited from class cn.jpush.im.android.api.model.GroupBasicInfo

Constructor Summary

Method Summary

Methods inherited from class cn.jpush.im.android.api.model.GroupBasicInfo

Methods inherited from class java.lang.Object

Constructor Detail

GroupInfo

Method Detail

getNoDisturb

getGroupOwner

getOwnerAppkey

getGroupMembers

getGroupMemberInfo

getGroupMemberInfo

setNoDisturb

setBlockGroupMessage

isGroupBlocked

getAvatarFile

getAvatarBitmap

getBigAvatarFile

getBigAvatarBitmap

updateAvatar

updateName

updateDescription

setGroupMemSilence

getGroupSilenceMembers

isKeepSilence

addGroupKeeper

removeGroupKeeper

getGroupKeepers

changeGroupAdmin

changeGroupType

groupCollectionToJson

fromJson

fromJsonToGroupCollection