com.electrotank.electroserver4.extensions.api
Class PluginPublicMessageResponse

java.lang.Object
  com.electrotank.electroserver4.extensions.api.PluginApiResponse
      com.electrotank.electroserver4.extensions.api.PluginPublicMessageResponse

public class PluginPublicMessageResponse
extends PluginApiResponse

This class represents a response from the server in regards to a plugin public message delivery request.

See Also:

PluginApiResponse, PluginPrivateMessageResponse

Nested Class Summary

class

PluginPublicMessageResponse.ZoneRoomCombo Object class used by PluginPublicMessageResponse to record both the zoneId and roomId of a location that failed to deliver a public message.

Nested classes/interfaces inherited from class com.electrotank.electroserver4.extensions.api.PluginApiResponse

PluginApiResponse.Status

Constructor Summary

PluginPublicMessageResponse()
This constructor will be invoked by the server automatically.

Method Summary

void	addInvalidRoom(int zoneId, int roomId) Adds a room to the list of the failed deliveries.
void	addInvalidZone(int zoneId) Adds a zone to the list of failed deliveries.
Collection<PluginPublicMessageResponse.ZoneRoomCombo>	getInvalidZoneRoomCombos() Gets a Collection of ZoneRoomCombo objects specifying which zones/rooms failed to deliver the message.

Methods inherited from class com.electrotank.electroserver4.extensions.api.PluginApiResponse

getStatus, isSuccess, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPublicMessageResponse

public PluginPublicMessageResponse()

This constructor will be invoked by the server automatically.

Method Detail

addInvalidZone

public void addInvalidZone(int zoneId)

Adds a zone to the list of failed deliveries.

Parameters:

zoneId - Id of the zone that failed to deliver the message

See Also:

addInvalidRoom

addInvalidRoom

public void addInvalidRoom(int zoneId,
                           int roomId)

Adds a room to the list of the failed deliveries.

Parameters:

zoneId - zoneId of the room

roomId - room that failed to deliver the message

See Also:

addInvalidZone

getInvalidZoneRoomCombos

public Collection<PluginPublicMessageResponse.ZoneRoomCombo> getInvalidZoneRoomCombos()

Gets a Collection of ZoneRoomCombo objects specifying which zones/rooms failed to deliver the message.

Returns:

collection of zones and rooms that failed to deliver