Messenger (Spigot-API 1.9.2-R0.1-SNAPSHOT API)

既知の実装クラスのリスト:

StandardMessenger
```
public interface Messenger
```
A class responsible for managing the registrations of plugin channels and their listeners.

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`MAX_CHANNEL_SIZE` Represents the largest size that a Plugin Channel may be.
`static int`	`MAX_MESSAGE_SIZE` Represents the largest size that an individual Plugin Message may be.

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`void`	`dispatchIncomingMessage(Player source, String channel, byte[] message)` Dispatches the specified incoming message to any registered listeners.
`Set<PluginMessageListenerRegistration>`	`getIncomingChannelRegistrations(Plugin plugin)` Gets a set containing all the incoming plugin channel registrations that the specified plugin has.
`Set<PluginMessageListenerRegistration>`	`getIncomingChannelRegistrations(Plugin plugin, String channel)` Gets a set containing all the incoming plugin channel registrations that the specified plugin has on the requested channel.
`Set<PluginMessageListenerRegistration>`	`getIncomingChannelRegistrations(String channel)` Gets a set containing all the incoming plugin channel registrations that are on the requested channel.
`Set<String>`	`getIncomingChannels()` Gets a set containing all the incoming plugin channels.
`Set<String>`	`getIncomingChannels(Plugin plugin)` Gets a set containing all the incoming plugin channels that the specified plugin is registered for.
`Set<String>`	`getOutgoingChannels()` Gets a set containing all the outgoing plugin channels.
`Set<String>`	`getOutgoingChannels(Plugin plugin)` Gets a set containing all the outgoing plugin channels that the specified plugin is registered to.
`boolean`	`isIncomingChannelRegistered(Plugin plugin, String channel)` Checks if the specified plugin has registered to receive incoming messages through the requested channel.
`boolean`	`isOutgoingChannelRegistered(Plugin plugin, String channel)` Checks if the specified plugin has registered to send outgoing messages through the requested channel.
`boolean`	`isRegistrationValid(PluginMessageListenerRegistration registration)` Checks if the specified plugin message listener registration is valid.
`boolean`	`isReservedChannel(String channel)` Checks if the specified channel is a reserved name.
`PluginMessageListenerRegistration`	`registerIncomingPluginChannel(Plugin plugin, String channel, PluginMessageListener listener)` Registers the specific plugin for listening on the requested incoming plugin channel, allowing it to act upon any plugin messages.
`void`	`registerOutgoingPluginChannel(Plugin plugin, String channel)` Registers the specific plugin to the requested outgoing plugin channel, allowing it to send messages through that channel to any clients.
`void`	`unregisterIncomingPluginChannel(Plugin plugin)` Unregisters the specific plugin from listening on all plugin channels through all listeners.
`void`	`unregisterIncomingPluginChannel(Plugin plugin, String channel)` Unregisters the specific plugin from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
`void`	`unregisterIncomingPluginChannel(Plugin plugin, String channel, PluginMessageListener listener)` Unregisters the specific plugin's listener from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
`void`	`unregisterOutgoingPluginChannel(Plugin plugin)` Unregisters the specific plugin from all outgoing plugin channels, no longer allowing it to send any plugin messages.
`void`	`unregisterOutgoingPluginChannel(Plugin plugin, String channel)` Unregisters the specific plugin from the requested outgoing plugin channel, no longer allowing it to send messages through that channel to any clients.

- フィールドの詳細
  - MAX_MESSAGE_SIZE
```
static final int MAX_MESSAGE_SIZE
```
    Represents the largest size that an individual Plugin Message may be.
    
    関連項目:
    
    定数フィールド値
  - MAX_CHANNEL_SIZE
```
static final int MAX_CHANNEL_SIZE
```
    Represents the largest size that a Plugin Channel may be.
    
    関連項目:
    
    定数フィールド値
- メソッドの詳細
  - isReservedChannel
```
boolean isReservedChannel(String channel)
```
    Checks if the specified channel is a reserved name.
    
    パラメータ:
    
    channel - Channel name to check.
    
    戻り値:
    
    True if the channel is reserved, otherwise false.
    
    例外:
    
    IllegalArgumentException - Thrown if channel is null.
  - registerOutgoingPluginChannel
```
void registerOutgoingPluginChannel(Plugin plugin,
                                   String channel)
```
    Registers the specific plugin to the requested outgoing plugin channel, allowing it to send messages through that channel to any clients.
    
    パラメータ:
    
    plugin - Plugin that wishes to send messages through the channel.
    
    channel - Channel to register.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin or channel is null.
  - unregisterOutgoingPluginChannel
```
void unregisterOutgoingPluginChannel(Plugin plugin,
                                     String channel)
```
    Unregisters the specific plugin from the requested outgoing plugin channel, no longer allowing it to send messages through that channel to any clients.
    
    パラメータ:
    
    plugin - Plugin that no longer wishes to send messages through the channel.
    
    channel - Channel to unregister.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin or channel is null.
  - unregisterOutgoingPluginChannel
```
void unregisterOutgoingPluginChannel(Plugin plugin)
```
    Unregisters the specific plugin from all outgoing plugin channels, no longer allowing it to send any plugin messages.
    
    パラメータ:
    
    plugin - Plugin that no longer wishes to send plugin messages.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin is null.
  - registerIncomingPluginChannel
```
PluginMessageListenerRegistration registerIncomingPluginChannel(Plugin plugin,
                                                                String channel,
                                                                PluginMessageListener listener)
```
    Registers the specific plugin for listening on the requested incoming plugin channel, allowing it to act upon any plugin messages.
    
    パラメータ:
    
    plugin - Plugin that wishes to register to this channel.
    
    channel - Channel to register.
    
    listener - Listener to receive messages on.
    
    戻り値:
    
    The resulting registration that was made as a result of this method.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin, channel or listener is null, or the listener is already registered for this channel.
  - unregisterIncomingPluginChannel
```
void unregisterIncomingPluginChannel(Plugin plugin,
                                     String channel,
                                     PluginMessageListener listener)
```
    Unregisters the specific plugin's listener from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
    
    パラメータ:
    
    plugin - Plugin that wishes to unregister from this channel.
    
    channel - Channel to unregister.
    
    listener - Listener to stop receiving messages on.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin, channel or listener is null.
  - unregisterIncomingPluginChannel
```
void unregisterIncomingPluginChannel(Plugin plugin,
                                     String channel)
```
    Unregisters the specific plugin from listening on the requested incoming plugin channel, no longer allowing it to act upon any plugin messages.
    
    パラメータ:
    
    plugin - Plugin that wishes to unregister from this channel.
    
    channel - Channel to unregister.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin or channel is null.
  - unregisterIncomingPluginChannel
```
void unregisterIncomingPluginChannel(Plugin plugin)
```
    Unregisters the specific plugin from listening on all plugin channels through all listeners.
    
    パラメータ:
    
    plugin - Plugin that wishes to unregister from this channel.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin is null.
  - getOutgoingChannels
```
Set<String> getOutgoingChannels()
```
    Gets a set containing all the outgoing plugin channels.
    
    戻り値:
    
    List of all registered outgoing plugin channels.
  - getOutgoingChannels
```
Set<String> getOutgoingChannels(Plugin plugin)
```
    Gets a set containing all the outgoing plugin channels that the specified plugin is registered to.
    
    パラメータ:
    
    plugin - Plugin to retrieve channels for.
    
    戻り値:
    
    List of all registered outgoing plugin channels that a plugin is registered to.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin is null.
  - getIncomingChannels
```
Set<String> getIncomingChannels()
```
    Gets a set containing all the incoming plugin channels.
    
    戻り値:
    
    List of all registered incoming plugin channels.
  - getIncomingChannels
```
Set<String> getIncomingChannels(Plugin plugin)
```
    Gets a set containing all the incoming plugin channels that the specified plugin is registered for.
    
    パラメータ:
    
    plugin - Plugin to retrieve channels for.
    
    戻り値:
    
    List of all registered incoming plugin channels that the plugin is registered for.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin is null.
  - getIncomingChannelRegistrations
```
Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(Plugin plugin)
```
    Gets a set containing all the incoming plugin channel registrations that the specified plugin has.
    
    パラメータ:
    
    plugin - Plugin to retrieve registrations for.
    
    戻り値:
    
    List of all registrations that the plugin has.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin is null.
  - getIncomingChannelRegistrations
```
Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(String channel)
```
    Gets a set containing all the incoming plugin channel registrations that are on the requested channel.
    
    パラメータ:
    
    channel - Channel to retrieve registrations for.
    
    戻り値:
    
    List of all registrations that are on the channel.
    
    例外:
    
    IllegalArgumentException - Thrown if channel is null.
  - getIncomingChannelRegistrations
```
Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(Plugin plugin,
                                                                       String channel)
```
    Gets a set containing all the incoming plugin channel registrations that the specified plugin has on the requested channel.
    
    パラメータ:
    
    plugin - Plugin to retrieve registrations for.
    
    channel - Channel to filter registrations by.
    
    戻り値:
    
    List of all registrations that the plugin has.
    
    例外:
    
    IllegalArgumentException - Thrown if plugin or channel is null.
  - isRegistrationValid
```
boolean isRegistrationValid(PluginMessageListenerRegistration registration)
```
    Checks if the specified plugin message listener registration is valid.
    A registration is considered valid if it has not be unregistered and that the plugin is still enabled.
    
    パラメータ:
    
    registration - Registration to check.
    
    戻り値:
    
    True if the registration is valid, otherwise false.
  - isIncomingChannelRegistered
```
boolean isIncomingChannelRegistered(Plugin plugin,
                                    String channel)
```
    Checks if the specified plugin has registered to receive incoming messages through the requested channel.
    
    パラメータ:
    
    plugin - Plugin to check registration for.
    
    channel - Channel to test for.
    
    戻り値:
    
    True if the channel is registered, else false.
  - isOutgoingChannelRegistered
```
boolean isOutgoingChannelRegistered(Plugin plugin,
                                    String channel)
```
    Checks if the specified plugin has registered to send outgoing messages through the requested channel.
    
    パラメータ:
    
    plugin - Plugin to check registration for.
    
    channel - Channel to test for.
    
    戻り値:
    
    True if the channel is registered, else false.
  - dispatchIncomingMessage
```
void dispatchIncomingMessage(Player source,
                             String channel,
                             byte[] message)
```
    Dispatches the specified incoming message to any registered listeners.
    
    パラメータ:
    
    source - Source of the message.
    
    channel - Channel that the message was sent by.
    
    message - Raw payload of the message.

インタフェース Messenger

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

MAX_MESSAGE_SIZE

MAX_CHANNEL_SIZE

メソッドの詳細

isReservedChannel

registerOutgoingPluginChannel

unregisterOutgoingPluginChannel

unregisterOutgoingPluginChannel

registerIncomingPluginChannel

unregisterIncomingPluginChannel

unregisterIncomingPluginChannel

unregisterIncomingPluginChannel

getOutgoingChannels

getOutgoingChannels

getIncomingChannels

getIncomingChannels

getIncomingChannelRegistrations

getIncomingChannelRegistrations

getIncomingChannelRegistrations

isRegistrationValid

isIncomingChannelRegistered

isOutgoingChannelRegistered

dispatchIncomingMessage