Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.plugin.messaging.PluginMessageRecipient Interface Reference
Inheritance diagram for org.bukkit.plugin.messaging.PluginMessageRecipient:
org.bukkit.entity.Player org.bukkit.Server org.bukkit.World

Public Member Functions

void sendPluginMessage (Plugin source, String channel, byte[] message)
 
Set< String > getListeningPluginChannels ()
 

Detailed Description

Represents a possible recipient for a Plugin Message.

Definition at line 9 of file PluginMessageRecipient.java.

Member Function Documentation

Set<String> org.bukkit.plugin.messaging.PluginMessageRecipient.getListeningPluginChannels ( )

Gets a set containing all the Plugin Channels that this client is listening on.

Returns
Set containing all the channels that this client may accept.
void org.bukkit.plugin.messaging.PluginMessageRecipient.sendPluginMessage ( Plugin  source,
String  channel,
byte[]  message 
)

Sends this recipient a Plugin Message on the specified outgoing channel.

The message may not be larger than Messenger#MAX_MESSAGE_SIZE bytes, and the plugin must be registered to send messages on the specified channel.

Parameters
sourceThe plugin that sent this message.
channelThe channel to send this message on.
messageThe raw message to send.
Exceptions
IllegalArgumentExceptionThrown if the source plugin is disabled.
IllegalArgumentExceptionThrown if source, channel or message is null.
MessageTooLargeExceptionThrown if the message is too big.
ChannelNotRegisteredExceptionThrown if the channel is not registered for this plugin.

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