oracle.adfmf.framework.api

Class MafNativeLocalNotificationOptions

Object

oracle.adfmf.framework.api.MafNativeLocalNotificationOptions

public class MafNativeLocalNotificationOptions
extends Object

Defines local notification options

See Also:

AdfmfContainerUtilities.addLocalNotification(MafNativeLocalNotificationOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MafNativeLocalNotificationOptions.RepeatInterval

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALERT_KEY
static String	BADGE_KEY
static String	DATE_KEY
static String	PAYLOAD_KEY
static String	REPEAT_KEY
static String	SOUND_DEFAULT_SYSTEM set the sound to this value to hear the default system notification sound when notification triggers
static String	SOUND_KEY
static String	TITLE_KEY
static String	VIBRATION_DEFAULT_SYSTEM set the vibration to this value to hear the default system notification sound when notification triggers
static String	VIBRATION_KEY

Constructor Summary

Constructors

Constructor and Description
MafNativeLocalNotificationOptions()

Method Summary

Modifier and Type	Method and Description
String	getAlert()
int	getBadge()
java.time.LocalDateTime	getDate()
java.util.HashMap<String,?>	getPayload()
MafNativeLocalNotificationOptions.RepeatInterval	getRepeat()
String	getSound()
String	getTitle()
String	getVibration()
void	setAlert(String alert) Set alert text in notification alert/banner.
void	setBadge(int badge) Set the number to badge application icon with when notification triggers.
void	setDate(java.time.LocalDateTime date) Set date-time at which notification should be triggered.
void	setPayload(java.util.HashMap<String,Object> payload) Set the custom payload to be transported with notification.
void	setRepeat(MafNativeLocalNotificationOptions.RepeatInterval repeat) Set the repeat interval at which notification should be triggered.
void	setSound(String sound) Set the sound that is played when notification triggers.
void	setTitle(String title) Set title text in notification alert/banner.
void	setVibration(String vibration) Set the vibration pattern when notification triggers

Methods inherited from class Object

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

Field Detail

TITLE_KEY

public static final String TITLE_KEY

See Also:

Constant Field Values

ALERT_KEY

public static final String ALERT_KEY

See Also:

Constant Field Values

DATE_KEY

public static final String DATE_KEY

See Also:

Constant Field Values

REPEAT_KEY

public static final String REPEAT_KEY

See Also:

Constant Field Values

BADGE_KEY

public static final String BADGE_KEY

See Also:

Constant Field Values

SOUND_KEY

public static final String SOUND_KEY

See Also:

Constant Field Values

PAYLOAD_KEY

public static final String PAYLOAD_KEY

See Also:

Constant Field Values

VIBRATION_KEY

public static final String VIBRATION_KEY

See Also:

Constant Field Values

SOUND_DEFAULT_SYSTEM

public static final String SOUND_DEFAULT_SYSTEM

set the sound to this value to hear the default system notification sound when notification triggers

See Also:

Constant Field Values

VIBRATION_DEFAULT_SYSTEM

public static final String VIBRATION_DEFAULT_SYSTEM

set the vibration to this value to hear the default system notification sound when notification triggers

See Also:

Constant Field Values

Constructor Detail

MafNativeLocalNotificationOptions

public MafNativeLocalNotificationOptions()

Method Detail

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

Set title text in notification alert/banner.

Parameters:

title - - title text

getAlert

public String getAlert()

setAlert

public void setAlert(String alert)

Set alert text in notification alert/banner.

Parameters:

alert - - alert text

getDate

public java.time.LocalDateTime getDate()

setDate

public void setDate(java.time.LocalDateTime date)

Set date-time at which notification should be triggered. If set in the past or not set, notification fires immediately.

Parameters:

date -

getRepeat

public MafNativeLocalNotificationOptions.RepeatInterval getRepeat()

setRepeat

public void setRepeat(MafNativeLocalNotificationOptions.RepeatInterval repeat)

Set the repeat interval at which notification should be triggered. Notification is not repeated if this is not set.

Parameters:

repeat -

See Also:

MafNativeLocalNotificationOptions.RepeatInterval

getBadge

public int getBadge()

setBadge

public void setBadge(int badge)

Set the number to badge application icon with when notification triggers.

Value	Outcome
0	no badging occurs, existing badge stays
less than 0	existing badge is wiped off
greater than 0	badged with given value

Note : No badging occurs on Android since it does not natively support badging application icon.

Parameters:

badge - - badge number

getSound

public String getSound()

setSound

public void setSound(String sound)

Set the sound that is played when notification triggers.

Parameters:

sound - - string representing the type of sound. Currently, only valid value is SOUND_DEFAULT_SYSTEM

See Also:

SOUND_DEFAULT_SYSTEM

getVibration

public String getVibration()

setVibration

public void setVibration(String vibration)

Set the vibration pattern when notification triggers

Parameters:

vibration - - vibration pattern representing the type of vibration. Currently, only valid value is VIBRATION_DEFAULT_SYSTEM

See Also:

VIBRATION_DEFAULT_SYSTEM

getPayload

public java.util.HashMap<String,?> getPayload()

setPayload

public void setPayload(java.util.HashMap<String,Object> payload)

Set the custom payload to be transported with notification.

Parameters:

payload - - custom payload