oracle.adfmf.framework.event

Class Event

Object

java.util.EventObject

oracle.adfmf.framework.event.Event

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NativeLocalNotificationEvent, NativePushEvent, OpenURLEvent

public abstract class Event
extends java.util.EventObject

Abstract class representing a mobile application framework event

An event is defined with:

• a source representing type of event
• a payload representing event information
• whether it triggers start of an application
• application state at time of event

See Also:

EventSource, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPLICATION_STATE_BACKGROUND application is in background at the time of event
static int	APPLICATION_STATE_FOREGROUND application is running in foreground at the time of event
static int	APPLICATION_STATE_NOT_RUNNING application is not running and was started due to event
static int	APPLICATION_STATE_UNKNOWN application state unknown

Constructor Summary

Constructors

Constructor and Description
Event(EventSource source, Object payload) Constructor - for events with application state unknown at the time of event
Event(EventSource source, Object payload, int appState) Constructor

Method Summary

Modifier and Type	Method and Description
int	getApplicationState() Returns the application state at the time of event.
String	getPayload() Get event payload as a string
Object	getPayloadObject() Get event payload object
boolean	isStartTriggered() Deprecated. use getApplicationState() instead

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

APPLICATION_STATE_UNKNOWN

public static final int APPLICATION_STATE_UNKNOWN

application state unknown

See Also:

Constant Field Values

APPLICATION_STATE_NOT_RUNNING

public static final int APPLICATION_STATE_NOT_RUNNING

application is not running and was started due to event

See Also:

Constant Field Values

APPLICATION_STATE_BACKGROUND

public static final int APPLICATION_STATE_BACKGROUND

application is in background at the time of event

See Also:

Constant Field Values

APPLICATION_STATE_FOREGROUND

public static final int APPLICATION_STATE_FOREGROUND

application is running in foreground at the time of event

See Also:

Constant Field Values

Constructor Detail

Event

public Event(EventSource source,
             Object payload,
             int appState)

Constructor

Parameters:

source - event source

payload - event information

appState - application state at the time of event. Can be one of the following:

• APPLICATION_STATE_UNKNOWN
• APPLICATION_STATE_NOT_RUNNING
• APPLICATION_STATE_BACKGROUND
• APPLICATION_STATE_FOREGROUND

Event

public Event(EventSource source,
             Object payload)

Constructor - for events with application state unknown at the time of event

Parameters:

source - event source

payload - event information

Method Detail

getPayload

public String getPayload()

Get event payload as a string

Returns:

event payload as a string

getPayloadObject

public Object getPayloadObject()

Get event payload object

Returns:

event payload object

getApplicationState

public int getApplicationState()

Returns the application state at the time of event.

Returns:

the state of application. It can be one of the following:

• APPLICATION_STATE_UNKNOWN
• APPLICATION_STATE_NOT_RUNNING
• APPLICATION_STATE_BACKGROUND
• APPLICATION_STATE_FOREGROUND

isStartTriggered

public boolean isStartTriggered()

Deprecated. use getApplicationState() instead

Returns true if event started application, false otherwise

Returns:

true if event started application, false otherwise