Easemob Windows SDK
Public Member Functions | List of all members
easemob::EMGroupManagerInterface Class Referenceabstract
Collaboration diagram for easemob::EMGroupManagerInterface:
Collaboration graph

Public Member Functions

virtual void addListener (EMGroupManagerListener *)=0
 Add a listener to group manager. More...
 
virtual void removeListener (EMGroupManagerListener *)=0
 Remove a listener. More...
 
virtual void clearListeners ()=0
 Remove all the listeners. More...
 
virtual EMGroupPtr groupWithId (const std::string &groupId)=0
 Get a group with groupId, create the group if not exist. More...
 
virtual EMGroupList allMyGroups (EMError &error)=0
 Get groups for login user from memory. More...
 
virtual EMGroupList loadAllMyGroupsFromDB ()=0
 Get groups for login user from db. More...
 
virtual EMGroupList fetchAllMyGroups (EMError &error)=0
 Fetch all groups for login user from server. More...
 
virtual EMCursorResult fetchPublicGroupsWithCursor (const std::string &cursor, int pageSize, EMError &error)=0
 Fetch app's public groups. More...
 
virtual EMGroupPtr createGroup (const std::string &subject, const std::string &description, const std::string &welcomeMessage, const EMGroupSetting &setting, const EMGroupMemberList &members, EMError &error)=0
 Create a new group. More...
 
virtual EMGroupPtr joinPublicGroup (const std::string &groupId, EMError &error)=0
 Join a public group. More...
 
virtual EMGroupPtr applyJoinPublicGroup (const std::string &groupId, const std::string &nickName, const std::string &message, EMError &error)=0
 Apply to join a public group, need owner's approval. More...
 
virtual EMGroupPtr leaveGroup (const std::string &groupId, EMError &error)=0
 Leave a group. More...
 
virtual EMGroupPtr destroyGroup (const std::string &groupId, EMError &error)=0
 Destroy a group. More...
 
virtual EMGroupPtr addGroupMembers (const std::string &groupId, const EMGroupMemberList &members, const std::string &welcomeMessage, EMError &error)=0
 Add members to a group. More...
 
virtual EMGroupPtr removeGroupMembers (const std::string &groupId, const EMGroupMemberList &members, EMError &error)=0
 Remove members from a group. More...
 
virtual EMGroupPtr blockGroupMembers (const std::string &groupId, const EMGroupMemberList &members, EMError &error, const std::string &reason="")=0
 Block group's members, the blocked user can't send message in the group. More...
 
virtual EMGroupPtr unblockGroupMembers (const std::string &groupId, const EMGroupMemberList &members, EMError &error)=0
 Unblock group's members. More...
 
virtual EMGroupPtr changeGroupSubject (const std::string &groupId, const std::string &newSubject, EMError &error)=0
 Change group's subject. More...
 
virtual EMGroupPtr changeGroupDescription (const std::string &groupId, const std::string &newDescription, EMError &error)=0
 Change group's description. More...
 
virtual EMGroupPtr fetchGroupSpecification (const std::string &groupId, EMError &error, bool fetchMembers=true)=0
 Get group's specification. More...
 
virtual const EMGroupMemberList * fetchGroupBans (const std::string &groupId, EMError &error)=0
 Get group's black list. More...
 
virtual EMGroupPtr searchPublicGroup (const std::string &groupId, EMError &error)=0
 Search for a public group. More...
 
virtual EMGroupPtr blockGroupMessage (const std::string &groupId, EMError &error)=0
 Block group message. More...
 
virtual EMGroupPtr unblockGroupMessage (const std::string &groupId, EMError &error)=0
 Unblock group message. More...
 
virtual EMGroupPtr acceptJoinGroupApplication (const std::string &groupId, const std::string &user, EMError &error)=0
 Accept user's join application. More...
 
virtual EMGroupPtr declineJoinGroupApplication (const std::string &groupId, const std::string &user, const std::string &reason, EMError &error)=0
 Reject user's join application. More...
 
virtual EMGroupPtr acceptInvitationFromGroup (const std::string &groupId, const std::string &inviter, EMError &error)=0
 accept group's invitation. More...
 
virtual void declineInvitationFromGroup (const std::string &groupId, const std::string &inviter, const std::string &reason, EMError &error)=0
 decline group's invitation. More...
 

Member Function Documentation

§ acceptInvitationFromGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::acceptInvitationFromGroup ( const std::string &  groupId,
const std::string &  inviter,
EMError error 
)
pure virtual

accept group's invitation.

Parameters
Group'sID.
Inviter.
EMErrorused for output.
Returns
The group user has accepted.

§ acceptJoinGroupApplication()

virtual EMGroupPtr easemob::EMGroupManagerInterface::acceptJoinGroupApplication ( const std::string &  groupId,
const std::string &  user,
EMError error 
)
pure virtual

Accept user's join application.

Note: Only group's owner can approval someone's application.

Parameters
Group'sID.
Theuser that send the application.
EMErrorused for output.
Returns
NA.

§ addGroupMembers()

virtual EMGroupPtr easemob::EMGroupManagerInterface::addGroupMembers ( const std::string &  groupId,
const EMGroupMemberList &  members,
const std::string &  welcomeMessage,
EMError error 
)
pure virtual

Add members to a group.

Note: Maybe user don't have the priviledge, it depends on group's setting.

Parameters
Group'sID.
Invitedusers.
Welcomemessage that will be sent to invited user.
EMErrorused for output.
Returns
The group that added members.

§ addListener()

virtual void easemob::EMGroupManagerInterface::addListener ( EMGroupManagerListener )
pure virtual

Add a listener to group manager.

Parameters
Agroup manager listener.
Returns
NA

§ allMyGroups()

virtual EMGroupList easemob::EMGroupManagerInterface::allMyGroups ( EMError error)
pure virtual

Get groups for login user from memory.

Parameters
EMErrorused for output.
Returns
All user joined groups in memory.

§ applyJoinPublicGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::applyJoinPublicGroup ( const std::string &  groupId,
const std::string &  nickName,
const std::string &  message,
EMError error 
)
pure virtual

Apply to join a public group, need owner's approval.

Note: The group's style must be PUBLIC_JOIN_APPROVAL, or will return error.

Parameters
Group'sID.
Nickname in the group.
Applymessage, that will be sent to group owner.
EMErrorused for output.
Returns
The group that try to join.

§ blockGroupMembers()

virtual EMGroupPtr easemob::EMGroupManagerInterface::blockGroupMembers ( const std::string &  groupId,
const EMGroupMemberList &  members,
EMError error,
const std::string &  reason = "" 
)
pure virtual

Block group's members, the blocked user can't send message in the group.

Note: Only group's owner can block other members.

Parameters
Group'sID.
Blockedusers.
EMErrorused for output.
Thereason that why block the members.
Returns
The group that blocked members.

§ blockGroupMessage()

virtual EMGroupPtr easemob::EMGroupManagerInterface::blockGroupMessage ( const std::string &  groupId,
EMError error 
)
pure virtual

Block group message.

Note: Owner can't block the group message.

Parameters
Group'sID.
EMErrorused for output.
Returns
The group that blocked message.

§ changeGroupDescription()

virtual EMGroupPtr easemob::EMGroupManagerInterface::changeGroupDescription ( const std::string &  groupId,
const std::string &  newDescription,
EMError error 
)
pure virtual

Change group's description.

Note: Only group's owner can change group's description.

Parameters
Group'sID.
Thenew group description.
EMErrorused for output.
Returns
The group that with new description.

§ changeGroupSubject()

virtual EMGroupPtr easemob::EMGroupManagerInterface::changeGroupSubject ( const std::string &  groupId,
const std::string &  newSubject,
EMError error 
)
pure virtual

Change group's subject.

Note: Only group's owner can change group's subject.

Parameters
Group'sID.
Thenew group subject.
EMErrorused for output.
Returns
The group that with new subject.

§ clearListeners()

virtual void easemob::EMGroupManagerInterface::clearListeners ( )
pure virtual

Remove all the listeners.

Parameters
NA
Returns
NA

§ createGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::createGroup ( const std::string &  subject,
const std::string &  description,
const std::string &  welcomeMessage,
const EMGroupSetting setting,
const EMGroupMemberList &  members,
EMError error 
)
pure virtual

Create a new group.

Note: Login user will be the owner of created .

Parameters
Group'ssubject.
Group'sdescription.
Welcomemessage that will be sent to invited user.
Group'ssetting.
Group'smembers.
EMErrorused for output.
Returns
The created group.

§ declineInvitationFromGroup()

virtual void easemob::EMGroupManagerInterface::declineInvitationFromGroup ( const std::string &  groupId,
const std::string &  inviter,
const std::string &  reason,
EMError error 
)
pure virtual

decline group's invitation.

Parameters
Group'sID.
Inviter.
Thedecline reason.
EMErrorused for output.
Returns
NA.

§ declineJoinGroupApplication()

virtual EMGroupPtr easemob::EMGroupManagerInterface::declineJoinGroupApplication ( const std::string &  groupId,
const std::string &  user,
const std::string &  reason,
EMError error 
)
pure virtual

Reject user's join application.

Note: Only group's owner can reject someone's application.

Parameters
Group'sID.
Theuser that send the application.
Thereject reason.
EMErrorused for output.
Returns
NA.

§ destroyGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::destroyGroup ( const std::string &  groupId,
EMError error 
)
pure virtual

Destroy a group.

Note: Only group's owner can destroy the group.

Parameters
Group'sID.
EMErrorused for output.
Returns
The destroyed group.

§ fetchAllMyGroups()

virtual EMGroupList easemob::EMGroupManagerInterface::fetchAllMyGroups ( EMError error)
pure virtual

Fetch all groups for login user from server.

Note: Groups in memory will be updated.

Parameters
EMErrorused for output.
Returns
All user joined groups.

§ fetchGroupBans()

virtual const EMGroupMemberList* easemob::EMGroupManagerInterface::fetchGroupBans ( const std::string &  groupId,
EMError error 
)
pure virtual

Get group's black list.

Parameters
Group'sID.
EMErrorused for output.
Returns
The group's black list.

§ fetchGroupSpecification()

virtual EMGroupPtr easemob::EMGroupManagerInterface::fetchGroupSpecification ( const std::string &  groupId,
EMError error,
bool  fetchMembers = true 
)
pure virtual

Get group's specification.

Parameters
Group'sID.
EMErrorused for output.
Whetherget group's members.
Returns
The group that update it's specification.

§ fetchPublicGroupsWithCursor()

virtual EMCursorResult easemob::EMGroupManagerInterface::fetchPublicGroupsWithCursor ( const std::string &  cursor,
int  pageSize,
EMError error 
)
pure virtual

Fetch app's public groups.

Note: User can input empty string as cursor at the first time.

Parameters
Page'scursor.
Page'ssize.
EMErrorused for output.
Returns
Wrapper of next page's cursor and current page result.

§ groupWithId()

virtual EMGroupPtr easemob::EMGroupManagerInterface::groupWithId ( const std::string &  groupId)
pure virtual

Get a group with groupId, create the group if not exist.

Parameters
Group'sid.
Returns
A group with the groupId.

§ joinPublicGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::joinPublicGroup ( const std::string &  groupId,
EMError error 
)
pure virtual

Join a public group.

Note: The group's style must be PUBLIC_JOIN_OPEN, or will return error.

Parameters
Group'sID.
EMErrorused for output.
Returns
The joined group.

§ leaveGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::leaveGroup ( const std::string &  groupId,
EMError error 
)
pure virtual

Leave a group.

Note: Group's owner can't leave the group.

Parameters
Group'sID.
EMErrorused for output.
Returns
The leaved group.

§ loadAllMyGroupsFromDB()

virtual EMGroupList easemob::EMGroupManagerInterface::loadAllMyGroupsFromDB ( )
pure virtual

Get groups for login user from db.

Returns
All user joined groups in db.

§ removeGroupMembers()

virtual EMGroupPtr easemob::EMGroupManagerInterface::removeGroupMembers ( const std::string &  groupId,
const EMGroupMemberList &  members,
EMError error 
)
pure virtual

Remove members from a group.

Note: Only group's owner can remove members.

Parameters
Group'sID.
Removedusers.
EMErrorused for output.
Returns
The group that removed members.

§ removeListener()

virtual void easemob::EMGroupManagerInterface::removeListener ( EMGroupManagerListener )
pure virtual

Remove a listener.

Parameters
Agroup manager listener.
Returns
NA

§ searchPublicGroup()

virtual EMGroupPtr easemob::EMGroupManagerInterface::searchPublicGroup ( const std::string &  groupId,
EMError error 
)
pure virtual

Search for a public group.

Parameters
Group'sID.
EMErrorused for output.
Returns
The search result.

§ unblockGroupMembers()

virtual EMGroupPtr easemob::EMGroupManagerInterface::unblockGroupMembers ( const std::string &  groupId,
const EMGroupMemberList &  members,
EMError error 
)
pure virtual

Unblock group's members.

Note: Only group's owner can unblock other members.

Parameters
Group'sID.
Unblockedusers.
EMErrorused for output.
Returns
The group that unblocked members.

§ unblockGroupMessage()

virtual EMGroupPtr easemob::EMGroupManagerInterface::unblockGroupMessage ( const std::string &  groupId,
EMError error 
)
pure virtual

Unblock group message.

Parameters
Group'sID.
EMErrorused for output.
Returns
The group that unclocked message.

The documentation for this class was generated from the following file: