Version 1.5APIs subject to change!

multiverse.mars.plugins
Class GroupClient

java.lang.Object
  extended by multiverse.mars.plugins.GroupClient

public class GroupClient
extends java.lang.Object


Nested Class Summary
static class GroupClient.GroupEventType
           
 
Field Summary
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_GROUP_CHAT
           
static MessageType MSG_TYPE_GROUP_INFO_RESPONSE
           
static MessageType MSG_TYPE_GROUP_INVITE
           
static MessageType MSG_TYPE_GROUP_INVITE_RESPONSE
           
static MessageType MSG_TYPE_GROUP_MUTE_VOICE_CHAT
           
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
           
 
Constructor Summary
GroupClient()
           
 
Method Summary
static java.util.HashSet<java.lang.Long> GetGroupMemberOIDs(java.lang.Long subject)
          Sends an RPC message to the GroupPlugin and returns a list of group member OIDs.
static void SendGroupEventMessage(GroupClient.GroupEventType eventType, MarsGroup group, long 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_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_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
Constructor Detail

GroupClient

public GroupClient()
Method Detail

SendGroupEventMessage

public static void SendGroupEventMessage(GroupClient.GroupEventType eventType,
                                         MarsGroup group,
                                         long 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 java.util.HashSet<java.lang.Long> GetGroupMemberOIDs(java.lang.Long 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


Copyright © 2008 The Multiverse Network, Inc.