com.electrotank.electroserver4.extensions.api
Class PluginPrivateMessageResponse

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

public class PluginPrivateMessageResponse
extends PluginApiResponse

This class represents a response from the server in regards to a plugin message delivery request. The getInvalidNames() method will return a list of any users that did not receive the message.

See Also:

PluginApiResponse, PluginPublicMessageResponse

Nested Class Summary

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

PluginApiResponse.Status

Constructor Summary

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

Method Summary

void	addName(String userName) Adds a name to the list of failed deliveries.
void	addNames(Collection<String> invalidUserNames) Adds a collection of user names to the failed deliveries list.
Collection<String>	getInvalidNames() Gets a list of failed deliveries by user name.

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

PluginPrivateMessageResponse

public PluginPrivateMessageResponse()

This constructor will be invoked by the server automatically.

Method Detail

addName

public void addName(String userName)

Adds a name to the list of failed deliveries.

Parameters:

userName - the user name to add

See Also:

addNames

addNames

public void addNames(Collection<String> invalidUserNames)

Adds a collection of user names to the failed deliveries list.

Parameters:

invalidUserNames - a collection of failed user names

See Also:

addName

getInvalidNames

public Collection<String> getInvalidNames()

Gets a list of failed deliveries by user name.

Returns:

a collection containing failed deliveries by user name