Package sfs3.client.core

Class ApiEvent

java.lang.Object
sfs3.client.core.ApiEvent
Direct Known Subclasses:
SFSBuddyEvent, SFSEvent
public class ApiEvent extends Object
This is the base class of all the events dispatched by the SmartFoxServer 3 Java Client API. In particular, check the SFSEvent and SFSBuddyEvent children classes for more information.
See Also:

  • Field Details

    • type

      protected String type

    • target

      protected Object target

  • Constructor Details

    • ApiEvent

      public ApiEvent(String type)
      Internal

    • ApiEvent

      public ApiEvent(String type, Map<String,Object> params)
      Parameters:
      type - The type of event.
      params - An object containing the parameters of the event.
      Internal

  • Method Details

    • getTarget

      public Object getTarget()
      Internal

    • setTarget

      public void setTarget(Object target)
      Internal

    • getType

      public String getType()
      Returns the type of the event.
      Returns:
      A string representing the type of the event.

    • toString

      public String toString()
      Generates a string containing all the properties of the BaseEvent object.
      Overrides:
      toString in class Object
      Returns:
      A string containing all the properties of the BaseEvent object.

    • clone

      public ApiEvent clone()
      Overrides:
      clone in class Object
      Returns:
      A new BaseEvent object that is identical to the original.
      Internal

    • setParams

      public void setParams(Map<String,Object> arguments)
      Internal

    • getParams

      public Map<String,Object> getParams()
      Returns a Map<String, Object> containing the parameters of the event.
      Returns:
      A Map<String, Object> containing the parameters of the event.

    • getParam

      public Object getParam(String name)