package com.pubnub.api.java.v2.callbacks
import com.pubnub.api.callbacks.Listener
import com.pubnub.api.java.v2.callbacks.handlers.OnChannelMetadataHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnFileHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnMembershipHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnMessageActionHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnMessageHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnPresenceHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnSignalHandler
import com.pubnub.api.java.v2.callbacks.handlers.OnUuidMetadataHandler
/**
* Interface implemented by objects that are the source of real time events from the PubNub network.
*/
interface EventEmitter {
/**
* Add a listener.
*
* @param listener The listener to be added.
*/
fun addListener(listener: EventListener)
/**
* Remove a listener.
*
* @param listener The listener to be removed, previously added with [addListener].
*/
fun removeListener(listener: Listener)
/**
* Removes all listeners.
*/
fun removeAllListeners()
/**
* Sets the handler for incoming message events.
* This method allows the assignment of an [OnMessageHandler] implementation or lambda expression to handle
* incoming messages.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to message events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `setOnMessage(pnMessageResult -> System.out.println("Received: " + pnMessageResult.getMessage()));
` *
*
*
* **Removing a Behavior Example:**
* `setOnMessage(null);
` *
*
* @param onMessageHandler An implementation of [OnMessageHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnMessage(onMessageHandler: OnMessageHandler?)
/**
* Sets the handler for incoming signal events.
* This method allows the assignment of an [OnSignalHandler] implementation or lambda expression to handle
* incoming signals.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to signal events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `setOnSignal(pnSignalResult -> System.out.println("Received: " + pnSignalResult.getMessage()));
` *
*
*
* **Removing a Behavior Example:**
* `setOnSignal(null);
` *
*
* @param onSignalHandler An implementation of [OnSignalHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnSignal(onSignalHandler: OnSignalHandler?)
/**
* Sets the handler for incoming presence events.
* This method allows the assignment of an [OnPresenceHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to presence events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onPresenceHandler(pnPresenceEventResult -> System.out.println("Received: " + pnPresenceEventResult.getEvent()));
` *
*
*
* **Removing a Behavior Example:**
* `onPresenceHandler(null);
` *
*
* @param onPresenceHandler An implementation of [OnPresenceHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnPresence(onPresenceHandler: OnPresenceHandler?)
/**
* Sets the handler for incoming messageAction events.
* This method allows the assignment of an [OnMessageActionHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to messageAction events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onMessageActionHandler(pnMessageActionResult -> System.out.println("Received: " + pnMessageActionResult.getMessageAction()));
` *
*
*
* **Removing a Behavior Example:**
* `onMessageActionHandler(null);
` *
*
* @param onMessageActionHandler An implementation of [OnMessageActionHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnMessageAction(onMessageActionHandler: OnMessageActionHandler?)
/**
* Sets the handler for incoming uuidMetadata events.
* This method allows the assignment of an [OnUuidMetadataHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to uuidMetadata events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onUuidMetadataHandler(pnUUIDMetadataResult -> System.out.println("Received: " + pnUUIDMetadataResult.getData()));
` *
*
*
* **Removing a Behavior Example:**
* `onUuidMetadataHandler(null);
` *
*
* @param onUuidMetadataHandler An implementation of [OnUuidMetadataHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnUuidMetadata(onUuidMetadataHandler: OnUuidMetadataHandler?)
/**
* Sets the handler for incoming channelMetadata events.
* This method allows the assignment of an [OnChannelMetadataHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to channelMetadata events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onChannelMetadataHandler(pnChannelMetadataResult -> System.out.println("Received: " + pnChannelMetadataResult.getEvent()));
` *
*
*
* **Removing a Behavior Example:**
* `onChannelMetadataHandler(null);
` *
*
* @param onChannelMetadataHandler An implementation of [OnChannelMetadataHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnChannelMetadata(onChannelMetadataHandler: OnChannelMetadataHandler?)
/**
* Sets the handler for incoming membership events.
* This method allows the assignment of an [OnMembershipHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to membership events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onMembershipHandler(pnMembershipResult -> System.out.println("Received: " + pnMembershipResult.getEvent()));
` *
*
*
* **Removing a Behavior Example:**
* `onMembershipHandler(null);
` *
*
* @param onMembershipHandler An implementation of [OnMembershipHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnMembership(onMembershipHandler: OnMembershipHandler?)
/**
* Sets the handler for incoming file events.
* This method allows the assignment of an [OnFileHandler] implementation or lambda expression to handle
* incoming presence events.
*
* To deactivate the current behavior, simply set this property to `null`.
*
* Note that this property allows for the assignment of a singular behavior at a time, as any new assignment will override the previous one.
* For scenarios requiring multiple behaviors in response to file events, it is advisable
* to utilize [EventEmitter.addListener].
*
*
* **Setting a Behavior Example:**
* `onFileHandler(pnFileEventResult -> System.out.println("Received: " + pnFileEventResult.getMessage()));
` *
*
*
* **Removing a Behavior Example:**
* `onFileHandler(null);
` *
*
* @param onFileHandler An implementation of [OnFileHandler] or a lambda expression to handle
* incoming messages. It can be `null` to remove the current handler.
*/
fun setOnFile(onFileHandler: OnFileHandler?)
}
