atavism.agis.plugins
Class GroupClient

java.lang.Object
  atavism.agis.plugins.GroupClient

public class GroupClient
extends java.lang.Object

Nested Class Summary

static class	GroupClient.createGroupMessage
static class	GroupClient.GetGroupMembersMessage
static class	GroupClient.getPlayerByNameMessage
static class	GroupClient.GroupEventType
static class	GroupClient.GroupInfo
static class	GroupClient.groupInviteByNameMessage

Field Summary

static java.lang.String	EXTMSG_GROUP_CANCEL_INVITE_REQUEST
static java.lang.String	EXTMSG_GROUP_INVITE_DECLINED
static java.lang.String	EXTMSG_GROUP_INVITE_REQUEST
static java.lang.String	EXTMSG_GROUP_PROPERTY_UPDATE
static java.lang.String	EXTMSG_GROUP_UPDATE
static MessageType	MSG_TYPE_ADD_FRIEND
static MessageType	MSG_TYPE_CREATE_GROUP
static MessageType	MSG_TYPE_GET_FRIENDS
static MessageType	MSG_TYPE_GET_GROUP_MEMBERS
static MessageType	MSG_TYPE_GET_PLAYER_BY_NAME
static MessageType	MSG_TYPE_GROUP_CHAT
static MessageType	MSG_TYPE_GROUP_INFO_RESPONSE
static MessageType	MSG_TYPE_GROUP_INVITE
static MessageType	MSG_TYPE_GROUP_INVITE_BY_NAME
static MessageType	MSG_TYPE_GROUP_INVITE_RESPONSE
static MessageType	MSG_TYPE_GROUP_LEAVE
static MessageType	MSG_TYPE_GROUP_MUTE_VOICE_CHAT
static MessageType	MSG_TYPE_GROUP_PROMOTE_LEADER
static MessageType	MSG_TYPE_GROUP_REMOVE_MEMBER
static MessageType	MSG_TYPE_GROUP_SET_ALLOWED_SPEAKER
static MessageType	MSG_TYPE_GROUP_VOICE_CHAT_STATUS
static MessageType	MSG_TYPE_REQUEST_GROUP_INFO
static MessageType	MSG_TYPE_SOCIAL_ADD_FRIEND
static MessageType	MSG_TYPE_SOCIAL_DEL_FRIEND
static MessageType	MSG_TYPE_SOCIAL_GET_FRIENDS

Constructor Summary

GroupClient()

Method Summary

static void	createGroup(java.util.ArrayList<OID> groupMembers)
static GroupClient.GroupInfo	GetGroupMemberOIDs(OID subject) Sends an RPC message to the GroupPlugin and returns a list of group member OIDs.
static java.util.LinkedList<OID>	GetGroupMembers(OID oid)
static OID	getPlayerByName(java.lang.String name) Sends the getPlayerByNameMessage which will attempt to get a players oid from their name.
static void	groupInviteByName(OID oid, java.lang.String name) Sends the groupInviteByNameMessage which will attempt to invite the named member to the group.
static void	removeMember(OID oid) Sends an RPC message to the GroupPlugin to remove member from group.
static void	removeMember(OID oid, OID kickerOid) Sends an RPC message to the GroupPlugin to remove member from group.
static void	removeMember(OID oid, OID kickerOid, OID groupOid) Sends an RPC message to the GroupPlugin to remove member from group.
static void	SendGroupEventMessage(GroupClient.GroupEventType eventType, AgisGroup group, OID subjectOid) SendGroupEventMessage is used to send messages to each group member about specific group releated events

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTMSG_GROUP_UPDATE

public static final java.lang.String EXTMSG_GROUP_UPDATE

See Also:

Constant Field Values

EXTMSG_GROUP_PROPERTY_UPDATE

public static final java.lang.String EXTMSG_GROUP_PROPERTY_UPDATE

See Also:

Constant Field Values

EXTMSG_GROUP_INVITE_REQUEST

public static final java.lang.String EXTMSG_GROUP_INVITE_REQUEST

See Also:

Constant Field Values

EXTMSG_GROUP_CANCEL_INVITE_REQUEST

public static final java.lang.String EXTMSG_GROUP_CANCEL_INVITE_REQUEST

See Also:

Constant Field Values

EXTMSG_GROUP_INVITE_DECLINED

public static final java.lang.String EXTMSG_GROUP_INVITE_DECLINED

See Also:

Constant Field Values

MSG_TYPE_GROUP_INVITE

public static final MessageType MSG_TYPE_GROUP_INVITE

MSG_TYPE_GROUP_INVITE_RESPONSE

public static final MessageType MSG_TYPE_GROUP_INVITE_RESPONSE

MSG_TYPE_GROUP_LEAVE

public static final MessageType MSG_TYPE_GROUP_LEAVE

MSG_TYPE_GROUP_REMOVE_MEMBER

public static final MessageType MSG_TYPE_GROUP_REMOVE_MEMBER

MSG_TYPE_GROUP_CHAT

public static final MessageType MSG_TYPE_GROUP_CHAT

MSG_TYPE_REQUEST_GROUP_INFO

public static final MessageType MSG_TYPE_REQUEST_GROUP_INFO

MSG_TYPE_GROUP_INFO_RESPONSE

public static final MessageType MSG_TYPE_GROUP_INFO_RESPONSE

MSG_TYPE_GROUP_SET_ALLOWED_SPEAKER

public static final MessageType MSG_TYPE_GROUP_SET_ALLOWED_SPEAKER

MSG_TYPE_GROUP_MUTE_VOICE_CHAT

public static final MessageType MSG_TYPE_GROUP_MUTE_VOICE_CHAT

MSG_TYPE_GROUP_VOICE_CHAT_STATUS

public static final MessageType MSG_TYPE_GROUP_VOICE_CHAT_STATUS

MSG_TYPE_GROUP_PROMOTE_LEADER

public static final MessageType MSG_TYPE_GROUP_PROMOTE_LEADER

MSG_TYPE_GROUP_INVITE_BY_NAME

public static final MessageType MSG_TYPE_GROUP_INVITE_BY_NAME

MSG_TYPE_GET_PLAYER_BY_NAME

public static final MessageType MSG_TYPE_GET_PLAYER_BY_NAME

MSG_TYPE_CREATE_GROUP

public static final MessageType MSG_TYPE_CREATE_GROUP

MSG_TYPE_GET_FRIENDS

public static final MessageType MSG_TYPE_GET_FRIENDS

MSG_TYPE_ADD_FRIEND

public static final MessageType MSG_TYPE_ADD_FRIEND

MSG_TYPE_SOCIAL_ADD_FRIEND

public static final MessageType MSG_TYPE_SOCIAL_ADD_FRIEND

MSG_TYPE_SOCIAL_DEL_FRIEND

public static final MessageType MSG_TYPE_SOCIAL_DEL_FRIEND

MSG_TYPE_SOCIAL_GET_FRIENDS

public static final MessageType MSG_TYPE_SOCIAL_GET_FRIENDS

MSG_TYPE_GET_GROUP_MEMBERS

public static final MessageType MSG_TYPE_GET_GROUP_MEMBERS

Constructor Detail

GroupClient

public GroupClient()

Method Detail

SendGroupEventMessage

public static void SendGroupEventMessage(GroupClient.GroupEventType eventType,
                                         AgisGroup group,
                                         OID subjectOid)

SendGroupEventMessage is used to send messages to each group member about specific group releated events

Parameters:

eventType - Type of event to send to the group members

group - Group object for which the event pertains

subjectOid - Oid of the player/object that the message is about

GetGroupMemberOIDs

public static GroupClient.GroupInfo GetGroupMemberOIDs(OID subject)

Sends an RPC message to the GroupPlugin and returns a list of group member OIDs.

Parameters:

subject - Oid of the player/object assoicated with the group you want info about

groupInviteByName

public static void groupInviteByName(OID oid,
                                     java.lang.String name)
                              throws java.io.IOException

Sends the groupInviteByNameMessage which will attempt to invite the named member to the group.

Throws:

java.io.IOException

getPlayerByName

public static OID getPlayerByName(java.lang.String name)
                           throws java.io.IOException

Sends the getPlayerByNameMessage which will attempt to get a players oid from their name.

Throws:

java.io.IOException

removeMember

public static void removeMember(OID oid)

Sends an RPC message to the GroupPlugin to remove member from group.

Parameters:

oid -

removeMember

public static void removeMember(OID oid,
                                OID kickerOid)

Sends an RPC message to the GroupPlugin to remove member from group.

Parameters:

oid -

kickerOid -

removeMember

public static void removeMember(OID oid,
                                OID kickerOid,
                                OID groupOid)

Sends an RPC message to the GroupPlugin to remove member from group.

Parameters:

oid -

kickerOid -

groupOid -

createGroup

public static void createGroup(java.util.ArrayList<OID> groupMembers)

Parameters:

oid -

GetGroupMembers

public static java.util.LinkedList<OID> GetGroupMembers(OID oid)