com.netease.nimlib.sdk.superteam

Interface SuperTeamService

public interface SuperTeamService

Created by hzsunyj on 2019-05-16.

Method Summary

Modifier and Type	Method and Description
InvocationFuture<java.lang.Void>	acceptInvite(java.lang.String teamId, java.lang.String inviter) Join a group by accepting an invitation
InvocationFuture<java.util.List<SuperTeamMember>>	addManagers(java.lang.String teamId, java.util.List<java.lang.String> accounts) The group owner assign administrators Only the group owner has the permissions
InvocationFuture<java.util.List<java.lang.String>>	addMembers(java.lang.String teamId, java.util.List<java.lang.String> accounts, java.lang.String postscript) Add a group member
InvocationFuture<SuperTeam>	applyJoinTeam(java.lang.String tid, java.lang.String postscript) Request joining a group
InvocationFuture<java.util.List<SessionAckInfo>>	clearUnreadCount(java.util.List<java.lang.String> teamIdList) Set the unread count of specified recent contact to 0 (tag read).
InvocationFuture<java.lang.Void>	declineInvite(java.lang.String teamId, java.lang.String inviter, java.lang.String reason) Decline an invite request
InvocationFuture<java.lang.Void>	muteAllTeamMember(java.lang.String teamId, boolean mute) Mute or unmute a group.
InvocationFuture<java.lang.Void>	muteTeam(java.lang.String teamId, TeamMessageNotifyTypeEnum notifyType) Set message type of a specified group.
InvocationFuture<java.lang.Void>	muteTeamMembers(java.lang.String teamId, java.util.ArrayList<java.lang.String> accountList, boolean mute) Mute and unmute
InvocationFuture<java.lang.Void>	passApply(java.lang.String teamId, java.lang.String account) Accept join requests Only the group owner and administrators have the permissions
InvocationFuture<java.util.List<SuperTeamMember>>	queryMemberList(java.lang.String teamId) Get a list of specified group members This operation may only read cached data from the local database or synchronize new data from the server.
InvocationFuture<java.util.List<SuperTeamMember>>	queryMemberListByPage(java.lang.String teamId, int offset, int limit) Get a list of specified group members on paginated pages This operation may only read cached data from the local database or synchronize new data from the server.
java.util.List<SuperTeamMember>	queryMutedTeamMembers(java.lang.String teamId) Query the list of muted group members The operation returns members muted by calling muteTeamMembers(String, ArrayList, boolean).
InvocationFuture<SuperTeam>	queryTeam(java.lang.String teamId) Query the group profile.
SuperTeam	queryTeamBlock(java.lang.String teamId) Query the group profile on local storage, not from the server If the current user does not belong to the group, the interface returns expired data.
InvocationFuture<java.util.List<SuperTeam>>	queryTeamList() Get the list of groups the current user has joined
java.util.List<SuperTeam>	queryTeamListBlock() Get the list of groups the current user has joined (sync)
InvocationFuture<java.util.List<SuperTeam>>	queryTeamListById(java.util.List<java.lang.String> tidList) Query groups based groups IDs
java.util.List<SuperTeam>	queryTeamListByIdBlock(java.util.List<java.lang.String> tidList) Query groups based groups IDs (sync)
InvocationFuture<SuperTeamMember>	queryTeamMember(java.lang.String teamId, java.lang.String account) Get the profile of a group member.
SuperTeamMember	queryTeamMemberBlock(java.lang.String teamId, java.lang.String account) Get the profile of a group member.
InvocationFuture<java.lang.Void>	quitTeam(java.lang.String teamId) Leave a group
InvocationFuture<java.lang.Void>	rejectApply(java.lang.String teamId, java.lang.String account, java.lang.String reason) Reject join requests Only administrators have the permissions
InvocationFuture<java.util.List<SuperTeamMember>>	removeManagers(java.lang.String teamId, java.util.List<java.lang.String> managers) The group owner revokes the administrator privilege Only the group owner has the permissions
InvocationFuture<java.lang.Void>	removeMember(java.lang.String teamId, java.lang.String member) Remove a group member.
InvocationFuture<java.lang.Void>	removeMembers(java.lang.String teamId, java.util.List<java.lang.String> members) Remove multiple group members.
InvocationFuture<java.lang.Void>	replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend) Reply a message.
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message) Recall a messages.
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload) Recall a message and set third party push notifications, including the iOS platform.
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload, boolean shouldNotifyBeCount) Recall a message and set third party push notifications, including the iOS platform.
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload, boolean shouldNotifyBeCount, java.lang.String postscript) Recall a message and set third party push notifications, including the iOS platform.
InvocationFuture<SuperTeam>	searchTeam(java.lang.String teamId) Query group profiles from servers
InvocationFuture<java.util.List<java.lang.String>>	searchTeamIdByName(java.lang.String name) Search group IDs using a group name
InvocationFuture<java.util.List<SuperTeam>>	searchTeamsByKeyword(java.lang.String keyword) Search all groups using keywords.
InvocationFuture<java.lang.Void>	sendAckSession(java.lang.String teamId, long timestamp) Mark a session ACK
InvocationFuture<java.lang.Void>	sendMessage(IMMessage msg, boolean resend) Sending a message.
InvocationFuture<java.util.List<SuperTeamMember>>	transferTeam(java.lang.String tid, java.lang.String account, boolean quit) The group owner transfer the ownership of a group to a member.
InvocationFuture<java.lang.Void>	updateMemberNick(java.lang.String teamId, java.lang.String account, java.lang.String nick) Group administrators edit the nickname of a member Only administrators have the permissions
InvocationFuture<java.lang.Void>	updateMyMemberExtension(java.lang.String teamId, java.lang.String extension) Edit the extension field in the group profile of the current user (user defined attribute contains up to 32 characters)
InvocationFuture<java.lang.Void>	updateMyTeamNick(java.lang.String teamId, java.lang.String nick) Edit the nickname of the current user
InvocationFuture<java.lang.Void>	updateTeam(java.lang.String teamId, TeamFieldEnum field, java.io.Serializable value) Update the group profile
InvocationFuture<java.lang.Void>	updateTeamFields(java.lang.String teamId, java.util.Map<TeamFieldEnum,java.io.Serializable> fields) Update multiple fields of the group profile.
InvocationFuture<java.lang.Void>	updateTeamFields(java.lang.String teamId, java.util.Map<TeamFieldEnum,java.io.Serializable> fields, AntiSpamConfig antiSpamConfig) Update multiple fields of the group profile.

Method Detail

sendMessage

InvocationFuture<java.lang.Void> sendMessage(IMMessage msg,
                                             boolean resend)

Sending a message.
To update the progress of the message delivery, call MsgServiceObserve.observeMsgStatus(Observer, boolean)

Parameters:

msg - Message body constructed by MessageBuilder

resend - To resend the message if failed, set the value to true. Otherwise, set the value to false.

Returns:

InvocationFuture Set a callback The method can be called after the message is sent. For information about error code, see specific error codes.

replyMessage

InvocationFuture<java.lang.Void> replyMessage(IMMessage msg,
                                              IMMessage replyMsg,
                                              boolean resend)

Reply a message.
To update the progress of the message delivery, call MsgServiceObserve.observeMsgStatus(Observer, boolean)

Parameters:

msg - Message body constructed by MessageBuilder

replyMsg - The message to be replied.

resend - To resend the message if failed, set the value to true. Otherwise, set the value to false.

Returns:

InvocationFuture set a callback function. The method can be called after the message is sent. For information about error code, see specific error codes.

addMembers

InvocationFuture<java.util.List<java.lang.String>> addMembers(java.lang.String teamId,
                                                              java.util.List<java.lang.String> accounts,
                                                              java.lang.String postscript)

Add a group member

Parameters:

teamId - group ID

accounts - The list of accounts to join a group

postscript - Additional message. The length of the message cannot exceed 5000 characters.

Returns:

InvocationFuture callback to observe the result.

removeMember

InvocationFuture<java.lang.Void> removeMember(java.lang.String teamId,
                                              java.lang.String member)

Remove a group member. Only the group owner has the permissions.

Parameters:

teamId - group ID

member - account of a member to be removed

Returns:

InvocationFuture callback to observe the result.

removeMembers

InvocationFuture<java.lang.Void> removeMembers(java.lang.String teamId,
                                               java.util.List<java.lang.String> members)

Remove multiple group members. Only the group owner has the permissions.

Parameters:

teamId - group ID

members - list of accounts to be removed

Returns:

InvocationFuture callback to observe the result.

quitTeam

InvocationFuture<java.lang.Void> quitTeam(java.lang.String teamId)

Leave a group

Parameters:

teamId - group ID

Returns:

InvocationFuture callback to observe the result.

clearUnreadCount

InvocationFuture<java.util.List<SessionAckInfo>> clearUnreadCount(java.util.List<java.lang.String> teamIdList)

Set the unread count of specified recent contact to 0 (tag read).
The interface call will trigger MsgServiceObserve.observeRecentContact(Observer, boolean)

updateTeam

InvocationFuture<java.lang.Void> updateTeam(java.lang.String teamId,
                                            TeamFieldEnum field,
                                            java.io.Serializable value)

Update the group profile

Parameters:

teamId - group ID

field - field to be updatged

value - new value of a field The value data type must be consistent with the defined fieldType.

Returns:

InvocationFuture callback to observe the result.

updateTeamFields

InvocationFuture<java.lang.Void> updateTeamFields(java.lang.String teamId,
                                                  java.util.Map<TeamFieldEnum,java.io.Serializable> fields)

Update multiple fields of the group profile.

Parameters:

teamId - group ID

fields - new values of fields to be updated. The value data type must be consistent with the defined fieldType.

Returns:

InvocationFuture callback to observe the result.

updateTeamFields

InvocationFuture<java.lang.Void> updateTeamFields(java.lang.String teamId,
                                                  java.util.Map<TeamFieldEnum,java.io.Serializable> fields,
                                                  AntiSpamConfig antiSpamConfig)

Update multiple fields of the group profile.

Parameters:

teamId - group ID

fields - new values of fields to be updated. The value data type must be consistent with the defined fieldType.

antiSpamConfig - Anti-spam configuration

Returns:

InvocationFuture callback to observe the result.

queryTeamList

InvocationFuture<java.util.List<SuperTeam>> queryTeamList()

Get the list of groups the current user has joined

Returns:

InvocationFuture callback. If the callback is triggered, the list of groups is returned.

queryTeamListBlock

java.util.List<SuperTeam> queryTeamListBlock()

Get the list of groups the current user has joined (sync)

queryTeamListById

InvocationFuture<java.util.List<SuperTeam>> queryTeamListById(java.util.List<java.lang.String> tidList)

Query groups based groups IDs

Parameters:

tidList - List of group IDs

queryTeamListByIdBlock

java.util.List<SuperTeam> queryTeamListByIdBlock(java.util.List<java.lang.String> tidList)

Query groups based groups IDs (sync)

Parameters:

tidList - List of group IDs

Returns:

list of groups the current user has joined

queryTeam

InvocationFuture<SuperTeam> queryTeam(java.lang.String teamId)

Query the group profile. If the data of group profiles does not exist, retrieve the data from the server.
If the current user does not belong to the group, the interface returns expired data. To update the group profile, call searchTeam(String teamId).

Parameters:

teamId - group ID

Returns:

InvocationFuture callback. If the callback is triggered, the group profile is returned.

queryTeamBlock

SuperTeam queryTeamBlock(java.lang.String teamId)

Query the group profile on local storage, not from the server If the current user does not belong to the group, the interface returns expired data. To update the group profile, call searchTeam(String teamId).

Parameters:

teamId - group ID

Returns:

group profile

searchTeam

InvocationFuture<SuperTeam> searchTeam(java.lang.String teamId)

Query group profiles from servers

Parameters:

teamId -

Returns:

queryMemberList

InvocationFuture<java.util.List<SuperTeamMember>> queryMemberList(java.lang.String teamId)

Get a list of specified group members
This operation may only read cached data from the local database or synchronize new data from the server. Therefore, it may take a long time.

Parameters:

teamId - group ID

Returns:

InvocationFuture callback. If the callback is triggered, the group member information is returned.

queryMemberListByPage

InvocationFuture<java.util.List<SuperTeamMember>> queryMemberListByPage(java.lang.String teamId,
                                                                        int offset,
                                                                        int limit)

Get a list of specified group members on paginated pages
This operation may only read cached data from the local database or synchronize new data from the server. Therefore, it may take a long time.

Parameters:

teamId - group ID

offset - offset

limit - limit of returned members. Up to 200 members can be loaded.

Returns:

InvocationFuture callback. If the callback is triggered, the group member information is returned.

queryTeamMember

InvocationFuture<SuperTeamMember> queryTeamMember(java.lang.String teamId,
                                                  java.lang.String account)

Get the profile of a group member. If the local group member profile has expired, the method will gets the newest profile data from the server.

Parameters:

teamId - group ID

account - account of a group member

Returns:

InvocationFuture callback. If the callback is triggered, the profile of a group member is returned.

queryTeamMemberBlock

SuperTeamMember queryTeamMemberBlock(java.lang.String teamId,
                                     java.lang.String account)

Get the profile of a group member. (sync)

Parameters:

teamId - group ID

account - account of a group member

Returns:

group member profile

queryMutedTeamMembers

java.util.List<SuperTeamMember> queryMutedTeamMembers(java.lang.String teamId)

Query the list of muted group members The operation returns members muted by calling muteTeamMembers(String, ArrayList, boolean).

Parameters:

teamId - group ID

Returns:

list of muted members

updateMyTeamNick

InvocationFuture<java.lang.Void> updateMyTeamNick(java.lang.String teamId,
                                                  java.lang.String nick)

Edit the nickname of the current user

Parameters:

teamId - group ID

nick - new nickname

Returns:

InvocationFuture callback to observe the result.

updateMyMemberExtension

InvocationFuture<java.lang.Void> updateMyMemberExtension(java.lang.String teamId,
                                                         java.lang.String extension)

Edit the extension field in the group profile of the current user (user defined attribute contains up to 32 characters)

Parameters:

teamId - group ID

extension - extension field (user defined)

Returns:

InvocationFuture callback to observe the result.

muteTeam

InvocationFuture<java.lang.Void> muteTeam(java.lang.String teamId,
                                          TeamMessageNotifyTypeEnum notifyType)

Set message type of a specified group. For information about message types, see TeamMessageNotifyTypeEnum

Parameters:

teamId - group ID

notifyType - notification type enumeration

Returns:

InvocationFuture callback to observe the result.

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message)

Recall a messages. No third party push notifications are enabled by default including the iOS platform. For more information, see MsgService#revokeMessageEx(IMMessage, String, Map)

Parameters:

message - The message to be recalled.

Returns:

InvocationFuture callback that observe the result.

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload)

Recall a message and set third party push notifications, including the iOS platform. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)

Parameters:

message - The message to be recalled.

customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.

pushPayload - Custom push payload in JSON with a maximum of 2048 characters.

Returns:

InvocationFuture callback that observe the result.

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload,
                                               boolean shouldNotifyBeCount)

Recall a message and set third party push notifications, including the iOS platform. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)

Parameters:

message - The message to be recalled.

customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.

pushPayload - Custom push payload in JSON with a maximum of 2048 characters.

shouldNotifyBeCount - Specify whether to update the unread count when a message is recalled.

Returns:

InvocationFuture callback that observe the result.

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload,
                                               boolean shouldNotifyBeCount,
                                               java.lang.String postscript)

Recall a message and set third party push notifications, including the iOS platform. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)

Parameters:

message - The message to be recalled.

customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.

pushPayload - Custom push payload in JSON with a maximum of 2048 characters.

shouldNotifyBeCount - Specify whether to update the unread count when a message is recalled.

postscript - Additional message

Returns:

InvocationFuture callback that observe the result.

searchTeamsByKeyword

InvocationFuture<java.util.List<SuperTeam>> searchTeamsByKeyword(java.lang.String keyword)

Search all groups using keywords.

Returns:

groups

applyJoinTeam

InvocationFuture<SuperTeam> applyJoinTeam(java.lang.String tid,
                                          java.lang.String postscript)

Request joining a group

Parameters:

tid - the ID of a group to be joined

postscript - Additional message. The length of the message cannot exceed 5000 characters.

Returns:

InvocationFuture callback. If the callback is triggered, the group profile is returned.

passApply

InvocationFuture<java.lang.Void> passApply(java.lang.String teamId,
                                           java.lang.String account)

Accept join requests
Only the group owner and administrators have the permissions

Parameters:

teamId - group ID

account - ID of accounts that sent the join request

Returns:

InvocationFuture callback

rejectApply

InvocationFuture<java.lang.Void> rejectApply(java.lang.String teamId,
                                             java.lang.String account,
                                             java.lang.String reason)

Reject join requests
Only administrators have the permissions

Parameters:

teamId - group ID

account - ID of accounts that sent the join request

reason - reason for declining a join request. The length of the reason cannot exceed 5000 characters.

Returns:

InvocationFuture callback

acceptInvite

InvocationFuture<java.lang.Void> acceptInvite(java.lang.String teamId,
                                              java.lang.String inviter)

Join a group by accepting an invitation

Parameters:

teamId - group ID

inviter - account of an inviter

Returns:

InvocationFuture callback

declineInvite

InvocationFuture<java.lang.Void> declineInvite(java.lang.String teamId,
                                               java.lang.String inviter,
                                               java.lang.String reason)

Decline an invite request

Parameters:

teamId - group ID

inviter - account of an inviter

reason - reason for declining a join request. The length of the reason cannot exceed 5000 characters.

Returns:

InvocationFuture callback

sendAckSession

InvocationFuture<java.lang.Void> sendAckSession(java.lang.String teamId,
                                                long timestamp)

Mark a session ACK

Parameters:

teamId - group ID

timestamp - timestamp of the last ACK message in the session in milliseconds.

Returns:

InvocationFuture callback

addManagers

InvocationFuture<java.util.List<SuperTeamMember>> addManagers(java.lang.String teamId,
                                                              java.util.List<java.lang.String> accounts)

The group owner assign administrators
Only the group owner has the permissions

Parameters:

teamId - group ID

accounts - list of members to be assigned the administrator privilege

Returns:

InvocationFuture callback. If the callback is triggered, a list of assigned administrators is returned.

removeManagers

InvocationFuture<java.util.List<SuperTeamMember>> removeManagers(java.lang.String teamId,
                                                                 java.util.List<java.lang.String> managers)

The group owner revokes the administrator privilege
Only the group owner has the permissions

Parameters:

teamId - group ID

managers - list of administrators to be revoked the administrator privilege.

Returns:

InvocationFuture callback. If the callback is triggered, a list of members with a normal privilege is returned.

muteAllTeamMember

InvocationFuture<java.lang.Void> muteAllTeamMember(java.lang.String teamId,
                                                   boolean mute)

Mute or unmute a group. The operation applies only to members. Only the group owner and administrators have permissions to perform this operation.

Parameters:

teamId - group ID

mute - true: mute; false: unmute

Returns:

InvocationFuture callback to observe the result.

muteTeamMembers

InvocationFuture<java.lang.Void> muteTeamMembers(java.lang.String teamId,
                                                 java.util.ArrayList<java.lang.String> accountList,
                                                 boolean mute)

Mute and unmute

Parameters:

teamId - group ID

account - list of muted or ummuted accounts

mute - true: mute; false: unmute

Returns:

InvocationFuture callback to observe the result.

updateMemberNick

InvocationFuture<java.lang.Void> updateMemberNick(java.lang.String teamId,
                                                  java.lang.String account,
                                                  java.lang.String nick)

Group administrators edit the nickname of a member
Only administrators have the permissions

Parameters:

teamId - group ID

account - account of a member whose nickname is edited

nick - new nickname

Returns:

InvocationFuture callback to observe the result.

transferTeam

InvocationFuture<java.util.List<SuperTeamMember>> transferTeam(java.lang.String tid,
                                                               java.lang.String account,
                                                               boolean quit)

The group owner transfer the ownership of a group to a member.
The original group owner become a member. If the quit parameter is set to true, the original group owner leave the group after the transfer succeeds

Parameters:

tid - group ID

account - account of the new group owner

quit - specify whether to leave the group after the transfer

Returns:

InvocationFuture callback. If the transfer succeeds, the result varis depending on the value of the quit paramter:
If the quit parameter is set to false, the permissions of the original group owner and the new group owner are updated.
If the quit parameter is set to true: The parameter is empty

searchTeamIdByName

InvocationFuture<java.util.List<java.lang.String>> searchTeamIdByName(java.lang.String name)

Search group IDs using a group name

Parameters:

name - group name

Returns:

list of IDs