IEventService (sdk 2.0.0-beta.4 API)

All Known Implementing Classes:

PusherEventService
```
public interface IEventService
```
Interface for an event service for subscribing to and registering for events from the Enjin Cloud.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`isConnected()` Checks if this service is connected to the platform.
`boolean`	`isSubscribedToAsset(java.lang.String asset)` Determines if the channel is open for the specified asset.
`boolean`	`isSubscribedToPlayer(java.lang.String project, java.lang.String player)` Determines if the channel is open for the specified player.
`boolean`	`isSubscribedToProject(java.lang.String project)` Determines if the channel is open for the specified project.
`boolean`	`isSubscribedToWallet(java.lang.String wallet)` Determines if the channel is open for the specified wallet address.
`EventListenerRegistration`	`registerListener(IEventListener listener)` Registers a event listener and provides the registration object used for it.
`EventListenerRegistration`	`registerListenerExcludingTypes(IEventListener listener, EventType... types)` Registers a event listener with event types to ignore and provides the registration object used for it.
`EventListenerRegistration`	`registerListenerIncludingTypes(IEventListener listener, EventType... types)` Registers a event listener with event types to allow and provides the registration object used for it.
`EventListenerRegistration`	`registerListenerWithMatcher(IEventListener listener, IEventMatcher matcher)` Registers a event listener with an event matcher and provides the registration object used for it.
`java.util.concurrent.Future<java.lang.Void>`	`shutdown()` Shuts down this service.
`java.util.concurrent.Future<java.lang.Void>`	`start()` Starts this service.
`java.util.concurrent.Future<java.lang.Void>`	`start(IConnectionEventListener listener)` Starts this service with the provided connection listener.
`java.util.concurrent.Future<java.lang.Void>`	`start(Platform platform)` Starts this service with the provided platform details.
`java.util.concurrent.Future<java.lang.Void>`	`start(Platform platform, IConnectionEventListener listener)` Starts this service with the provided platform details and connection listener.
`void`	`subscribeToAsset(java.lang.String asset)` Opens a channel for the specified asset, allowing listeners to receive events for that asset.
`void`	`subscribeToPlayer(java.lang.String project, java.lang.String player)` Opens a channel for the specified player, allowing listeners to receive events for that player.
`void`	`subscribeToProject(java.lang.String project)` Opens a channel for the specified project, allowing listeners to receive events for that project.
`void`	`subscribeToWallet(java.lang.String wallet)` Opens a channel for the specified wallet address, allowing listeners to receive events for that wallet.
`void`	`unregisterListener(IEventListener listener)` Unregisters a event listener.
`void`	`unsubscribeToAsset(java.lang.String asset)` Closes a channel for the specified asset, preventing listeners from receiving events for that asset.
`void`	`unsubscribeToPlayer(java.lang.String project, java.lang.String player)` Closes a channel for the specified player, preventing listeners from receiving events for that player.
`void`	`unsubscribeToProject(java.lang.String project)` Closes a channel for the specified project, preventing listeners from receiving events for that project.
`void`	`unsubscribeToWallet(java.lang.String wallet)` Closes a channel for the specified wallet address, preventing listeners from receiving events for that wallet.

- Method Detail
  - start
```
java.util.concurrent.Future<java.lang.Void> start()
```
    Starts this service.
    
    Returns:
    
    the future for this operation
  - start
```
java.util.concurrent.Future<java.lang.Void> start(Platform platform)
```
    Starts this service with the provided platform details.
    
    Parameters:
    
    platform - the platform
    
    Returns:
    
    the future for this operation
  - start
```
java.util.concurrent.Future<java.lang.Void> start(IConnectionEventListener listener)
```
    Starts this service with the provided connection listener.
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    the future for this operation
  - start
```
java.util.concurrent.Future<java.lang.Void> start(Platform platform,
                                                  IConnectionEventListener listener)
```
    Starts this service with the provided platform details and connection listener.
    
    Parameters:
    
    platform - the platform
    
    listener - the listener
    
    Returns:
    
    the future for this operation
  - isConnected
```
boolean isConnected()
```
    Checks if this service is connected to the platform.
    
    Returns:
    
    true if connected, else false
  - shutdown
```
java.util.concurrent.Future<java.lang.Void> shutdown()
```
    Shuts down this service.
    
    Returns:
    
    the future for this operation
  - registerListener
```
EventListenerRegistration registerListener(IEventListener listener)
```
    Registers a event listener and provides the registration object used for it.
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    the registration
  - registerListenerWithMatcher
```
EventListenerRegistration registerListenerWithMatcher(IEventListener listener,
                                                      IEventMatcher matcher)
```
    Registers a event listener with an event matcher and provides the registration object used for it.
    
    Parameters:
    
    listener - the listener
    
    matcher - the event matcher
    
    Returns:
    
    the registration
  - registerListenerIncludingTypes
```
EventListenerRegistration registerListenerIncludingTypes(IEventListener listener,
                                                         EventType... types)
```
    Registers a event listener with event types to allow and provides the registration object used for it.
    
    Parameters:
    
    listener - the listener
    
    types - the events to listen for
    
    Returns:
    
    the registration
  - registerListenerExcludingTypes
```
EventListenerRegistration registerListenerExcludingTypes(IEventListener listener,
                                                         EventType... types)
```
    Registers a event listener with event types to ignore and provides the registration object used for it.
    
    Parameters:
    
    listener - the listener
    
    types - the events to ignore
    
    Returns:
    
    the registration
  - unregisterListener
```
void unregisterListener(IEventListener listener)
```
    Unregisters a event listener.
    
    Parameters:
    
    listener - the listener
  - subscribeToProject
```
void subscribeToProject(java.lang.String project)
```
    Opens a channel for the specified project, allowing listeners to receive events for that project.
    
    Parameters:
    
    project - the project's UUID
  - unsubscribeToProject
```
void unsubscribeToProject(java.lang.String project)
```
    Closes a channel for the specified project, preventing listeners from receiving events for that project.
    
    Parameters:
    
    project - the project's UUID
  - isSubscribedToProject
```
boolean isSubscribedToProject(java.lang.String project)
```
    Determines if the channel is open for the specified project.
    
    Parameters:
    
    project - the project's UUID
    
    Returns:
    
    true if open, else false
  - subscribeToPlayer
```
void subscribeToPlayer(java.lang.String project,
                       java.lang.String player)
```
    Opens a channel for the specified player, allowing listeners to receive events for that player.
    
    Parameters:
    
    project - the UUID of the project the player is on
    
    player - the player ID
  - unsubscribeToPlayer
```
void unsubscribeToPlayer(java.lang.String project,
                         java.lang.String player)
```
    Closes a channel for the specified player, preventing listeners from receiving events for that player.
    
    Parameters:
    
    project - the UUID of the project the player is on
    
    player - the player ID
  - isSubscribedToPlayer
```
boolean isSubscribedToPlayer(java.lang.String project,
                             java.lang.String player)
```
    Determines if the channel is open for the specified player.
    
    Parameters:
    
    project - the UUID of the project the player is on
    
    player - the player ID
    
    Returns:
    
    true if open, else false
  - subscribeToAsset
```
void subscribeToAsset(java.lang.String asset)
```
    Opens a channel for the specified asset, allowing listeners to receive events for that asset.
    
    Parameters:
    
    asset - the asset ID
  - unsubscribeToAsset
```
void unsubscribeToAsset(java.lang.String asset)
```
    Closes a channel for the specified asset, preventing listeners from receiving events for that asset.
    
    Parameters:
    
    asset - the asset ID
  - isSubscribedToAsset
```
boolean isSubscribedToAsset(java.lang.String asset)
```
    Determines if the channel is open for the specified asset.
    
    Parameters:
    
    asset - the asset ID
    
    Returns:
    
    true if open, else false
  - subscribeToWallet
```
void subscribeToWallet(java.lang.String wallet)
```
    Opens a channel for the specified wallet address, allowing listeners to receive events for that wallet.
    
    Parameters:
    
    wallet - the address
  - unsubscribeToWallet
```
void unsubscribeToWallet(java.lang.String wallet)
```
    Closes a channel for the specified wallet address, preventing listeners from receiving events for that wallet.
    
    Parameters:
    
    wallet - the address
  - isSubscribedToWallet
```
boolean isSubscribedToWallet(java.lang.String wallet)
```
    Determines if the channel is open for the specified wallet address.
    
    Parameters:
    
    wallet - the address
    
    Returns:
    
    true if open, else false

Interface IEventService

Method Summary

Method Detail

start

start

start

start

isConnected

shutdown

registerListener

registerListenerWithMatcher

registerListenerIncludingTypes

registerListenerExcludingTypes

unregisterListener

subscribeToProject

unsubscribeToProject

isSubscribedToProject

subscribeToPlayer

unsubscribeToPlayer

isSubscribedToPlayer

subscribeToAsset

unsubscribeToAsset

isSubscribedToAsset

subscribeToWallet

unsubscribeToWallet

isSubscribedToWallet