Attention Properties
[Attention Manager]

Detailed Description

The attention alert properties are used to specify the data to be displayed or to control how the alert is to be handled or how the alert is to be layed out when displayed.

The data to be display comes from properties like ALP_ATTN_PROP_ALERT_TITLE for the title of the alert, ALP_ATTN_PROP_ALERT_ICON for the icon to be associated with alert, or ALP_ATTN_PROP_ALERT_TEXT* for the data to be displayed in the summary and detail areas of an alert dialog.

The layout of the attnetion alert dialog is controlled by properties such as ALP_ATTN_PROP_DIALOG_URL to specify the glade file to use for the dialog, ALP_ATTN_PROP_DIALOG_TYPE, which specifies the window type of the dialog used to display the alert, and ALP_ATTN_PROP_DIALOG_BACKGROUND_URL, which specifies the image to used for the background of that dialog.

Control / handling of the attentions alers is controlled by properties such as ALP_ATTN_PROP_LEVEL to control the priority of the alert in order to arbitrate which alert should be displayed first, or ALP_ATTN_PROP_FACILITIES which determines the "facilities" that an alert would use (be displayed one) such as the modal dialog, a regular dialog and/or the alert list.

There are two ways in which an alert gets its properties:

via the property array passed in the alp_attn_post(), alp_attn_post_with_callback() and alp_attn_update().
via the attention manager specific preferences in global settings

Only the property array method will be discussed here. The global settings preference method is primarily meant for customization by the licensee and is discussed in more detail in the PDK documentation.

The property array consists of AlpAttnProp elements and AlpAttnProp is a structure made up of two fields: a key field and a value field. The key field stores the string name of the property while the value field stores the string value. All property values are strings.

One way to create this array is to declare the array as close as possible before the call the alp_attn_post() (or other associated functions). In this way, dynamic parameters can be determined before initialization of the array otherwise one would need to index the array and directly set the value field prior to the call which can be source of errors if entries are added and/or deleted from the property array.

Here is an example:

      const gint small_bufflen = 5;
      gchar luid_str[32];
      gchar event_start[16];
      gchar event_time[12];
      gchar event_date[12];
      gchar tone_count[small_bufflen];
      gchar nag_count[small_bufflen];
      gchar *note = NULL;
          :
          :
      sprintf(luid_str, "%u", taskID);
      tm = gmtime(&alarmTime);
      prv_get_localized_time_string(event_time, 12, tm);

      time(&current_time);
      today_tm = localtime(&current_time);
      prv_get_localized_date_string(event_date, 12, today_tm);

      if (taskNote) {
          note = g_markup_escape_text(taskNote, -1);
      } else {
          note = "";
      }
          :
          :
      facilities = show_window ?
          "+" ALP_ATTN_VALUE_FACILITY_DIALOG : // add alert dialog to facility list
          "-" ALP_ATTN_VALUE_FACILITY_DIALOG;  // remove dialog from facility list

      effects = vibrate ?
          "+" ALP_ATTN_VALUE_EFFECT_VIBRATE :  // enable vibration effect
          "-" ALP_ATTN_VALUE_EFFECT_VIBRATE;   // disable vibration effect
          :
          :
      // now initialize props array
      AlpAttnProp props[] = {
          { ALP_ATTN_PROP_FACILITIES, facilities },
          { ALP_ATTN_PROP_EFFECTS, effects },
          { ALP_ATTN_PROP_VIBRATE_URL, vibrate_url },
          { ALP_ATTN_PROP_VIBRATE_TYPE, ALP_ATTN_VALUE_VIBRATE_TYPE_ALARM },
          { ALP_ATTN_PROP_ALERT_TITLE, _("Tasks Alarm") },
          { ALP_ATTN_PROP_ALERT_ICON,  ALP_STOCK_TASKS_APP },
          { ALP_ATTN_PROP_ALERT_IMAGE, ALP_STOCK_ALARM },
          { ALP_ATTN_PROP_ALERT_SUMMARY, task_description },
          // some properties initialized with the ALP_ATTN_PROP() macro
          ALP_ATTN_PROP(ALP_ATTN_PROP_ACTION_DEFAULT, ALP_ATTN_VALUE_VERB_SNOOZE),
          ALP_ATTN_PROP(ALP_ATTN_PROP_EVENT_START, event_time),
          ALP_ATTN_PROP(ALP_ATTN_PROP_SOUND_URL, tone_url),
          // some properties initialized with the ALP_ATTN_PROPERTY() macro
          ALP_ATTN_PROPERTY(SOUND_COUNT, tone_count),
          ALP_ATTN_PROPERTY(SOUND_TYPE, ALP_ATTN_VALUE_SOUND_TYPE_ALARM),
          ALP_ATTN_PROPERTY(NAG_COUNT, nag_count),
          ALP_ATTN_PROPERTY(NAG_INTERVAL, nag_interval),
          ALP_ATTN_PROPERTY(ALERT_SMARTTEXT"-1", event_time),
          // back to regular initialization, note the concatentation in the key name
          { ALP_ATTN_PROP_ALERT_SMARTTEXT"-2", event_date },
          { ALP_ATTN_PROP_ALERT_MARKUP"-3", task_description },
          { ALP_ATTN_PROP_ALERT_MARKUP"-4", note }
      };
      int nprops = G_N_ELEMENTS(props); // G_N_ELEMENTS() is a GLib helper macro

      status = alp_attn_post(TASKS_APPID_STR,           // app id of posting application
                             ALP_ALERT_TYPE_ALARM_TASK, // alert type name - hierarchial (i.e. /alp/alarm/...)
                             luid_str,                  // handle string (opaque string for app's use)
                             nprops,                    // number of elements in property array
                             props                      // property array
                             );

Telephony specific action properties

These properties are intended to use for incoming call alerts and are of little use for other types of alerts.

#define ALP_ATTN_PROP_ACCEPT_CALL   "accept-call"

Control how an alert is to be accepted.

#define ALP_ATTN_PROP_ACCEPT_DELAY   "accept-delay"

Timeout to automatically accept an alert.

#define ALP_ATTN_PROP_ACTION_ACCEPT   "action-accept"

Action to perform when the alert is accepted.

#define ALP_ATTN_PROP_ACTION_REJECT   "action-reject"

Action to perform when the alert is rejected.

Generic alert action properties

#define ALP_ATTN_PROP_ACTION_CLEAR   "action-clear"

Action for Clear operation.

#define ALP_ATTN_PROP_ACTION_DEFAULT   "action-default"

Default action.

#define ALP_ATTN_PROP_ACTION_DIALOG_TIMEOUT   "action-dialog-timeout"

Dialog Timeout action.

#define ALP_ATTN_PROP_ACTION_GOTO   "action-goto"

Action for Goto operation.

#define ALP_ATTN_PROP_ACTION_OKAY   "action-okay"

Action for Okay operation.

Basic Alert properties

#define ALP_ATTN_PROP_ALERT_ACTION   "action"

Alert action.

#define ALP_ATTN_PROP_ALERT_ACTION_BUTTON   "action-button"

Alert button action.

#define ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_ACTIVE   "action-toggled-active"

Alert toggle button action.

#define ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_INACTIVE   "action-toggled-inactive"

Alert toggle button action.

#define ALP_ATTN_PROP_ALERT_ANIM_IMAGE   "animated-image"

Alert dialog animated image.

#define ALP_ATTN_PROP_ALERT_BUTTON   "button"

Alert dialog button.

#define ALP_ATTN_PROP_ALERT_DETAILS_TITLE   "details-label"

Details folder label.

#define ALP_ATTN_PROP_ALERT_ICON   "icon"

Alert icon.

#define ALP_ATTN_PROP_ALERT_IMAGE   "image"

Alert dialog image.

#define ALP_ATTN_PROP_ALERT_MARKUP   "markup"

Alert dialog markup.

#define ALP_ATTN_PROP_ALERT_SMARTTEXT   "smarttext"

Alert dialog smart text.

#define ALP_ATTN_PROP_ALERT_SUMMARY   "summary"

Alert list summary.

#define ALP_ATTN_PROP_ALERT_SUMMARY_TITLE   "summary-label"

Summary folder label.

#define ALP_ATTN_PROP_ALERT_TEXT   "text"

Alert dialog text.

#define ALP_ATTN_PROP_ALERT_TITLE   "title"

Alert dialog title.

#define ALP_ATTN_PROP_POWER_WAKE_STATE   "power-wake"

Power wake state.

Deprecated Properties

The following properties have been deprecated and should not be used in newly-written code.

#define ALP_ATTN_PROP_ALERT_DIALOG_ROOT   ALP_ATTN_PROP_DIALOG_ROOT

#define ALP_ATTN_PROP_ALERT_DIALOG_TIMEOUT   ALP_ATTN_PROP_DIALOG_TIMEOUT

#define ALP_ATTN_PROP_ALERT_DIALOG_URL   ALP_ATTN_PROP_DIALOG_URL

#define ALP_ATTN_PROP_ALERT_DIALOG_WIDGET   ALP_ATTN_PROP_DIALOG_TOP

#define ALP_ATTN_PROP_ALERT_LED_PATTERN   "led-pattern"

#define ALP_ATTN_PROP_ALERT_VIBRATE_PATTERN   ALP_ATTN_PROP_VIBRATE_PATTERN

#define ALP_ATTN_PROP_DIALOG_WIDGET   ALP_ATTN_PROP_DIALOG_TOP

#define ALP_ATTN_PROP_NAG_REPEAT_COUNT   ALP_ATTN_PROP_NAG_COUNT

Number of times to "nag" an alert.

#define ALP_ATTN_PROP_VIBRATE_PATTERN   "vibrate-pattern"

Sound properties

#define ALP_ATTN_PROP_ALERT_RING_TONE_URL   "ring-tone-url"

#define ALP_ATTN_PROP_ALERT_TONE_MAX_DURATION   "alert-tone-max-duration"

#define ALP_ATTN_PROP_ALERT_TONE_REPEAT_COUNT   "alert-tone-repeat-count"

#define ALP_ATTN_PROP_ALERT_TONE_URL   "alert-tone-url"

#define ALP_ATTN_PROP_SIMPLE_SOUND_URL   "simple-sound-url"

Simple sound resource URL.

#define ALP_ATTN_PROP_SOUND_COUNT   "sound-count"

Sound play count.

#define ALP_ATTN_PROP_SOUND_MAX_DURATION   "sound-max-duration"

Sound max duration.

#define ALP_ATTN_PROP_SOUND_RAMP_INTERVAL   "sound-ramp-interval"

Sound ramp timer interval.

#define ALP_ATTN_PROP_SOUND_RAMP_TYPE   "sound-ramp-type"

Sound ramp type.

#define ALP_ATTN_PROP_SOUND_TYPE   "sound-type"

Sound Audio Types.

#define ALP_ATTN_PROP_SOUND_URL   "sound-url"

Sound resource URL.

#define ALP_ATTN_PROP_SOUND_VOLUME   "sound-volume"

Volume level.

#define ALP_ATTN_PROP_SOUND_VOLUME_START   "sound-volume-start"

Start volume level.

#define ALP_ATTN_PROP_SOUND_VOLUME_STEP   "sound-volume-step"

Volume step.

Alert Dialog Window properties

#define ALP_ATTN_PROP_DIALOG_BACKGROUND_URL   "background-url"

Dialog Background URL.

#define ALP_ATTN_PROP_DIALOG_TYPE   "dialog-type"

Dialog Window Type.

Alert Dialog properties

#define ALP_ATTN_PROP_DIALOG_EMOTICON_BUNDLE_ID   "emoticon-id"

Dialog emoticon resource bundle id.

#define ALP_ATTN_PROP_DIALOG_ROOT   "dialog-root"

Dialog glade root.

#define ALP_ATTN_PROP_DIALOG_TIMEOUT   "dialog-timeout"

Dialog timeout.

#define ALP_ATTN_PROP_DIALOG_TOP   "dialog-top"

Dialog glade top.

#define ALP_ATTN_PROP_DIALOG_URL   "dialog-url"

Dialog glade URL.

Alert handling properties

#define ALP_ATTN_PROP_EFFECTS   "effects"

Alert effects.

#define ALP_ATTN_PROP_EFFECTS_INTERVAL   "effects-interval"

Effects sequence interval.

#define ALP_ATTN_PROP_EFFECTS_SEQUENCE_TYPE   "effects-seq-type"

Effects sequence type.

#define ALP_ATTN_PROP_FACILITIES   "facilities"

Alert facilities.

#define ALP_ATTN_PROP_LEVEL   "level"

Alert priority level.

Alert event time properties

#define ALP_ATTN_PROP_EVENT_DURATION   "event-duration"

Event start time.

#define ALP_ATTN_PROP_EVENT_END   "event-end"

Event start time.

#define ALP_ATTN_PROP_EVENT_START   "event-start"

Event start time.

Alert Nagging properties and value

The "nag" properties are used to specify when to "nag" the user about an attention alert that has not been dismisse. The user is "nagged" by replaying the sound, vibrate and other effects configured for the alert.
The "nags" will be repeated until the alert is dismissed or the nag count reaches zero.

#define ALP_ATTN_PROP_NAG_COUNT   "nag-count"

Number of times to "nag" an alert.

#define ALP_ATTN_PROP_NAG_INTERVAL   "nag-interval"

Interval between "nagging" in seconds.

#define ALP_ATTN_VALUE_NAG_CONTINUOUS   "continuous"

Nag continuously until dismissed.

Vibrate properties

#define ALP_ATTN_PROP_VIBRATE_COUNT   "vibrate-count"

Vibration count.

#define ALP_ATTN_PROP_VIBRATE_DURATION   "vibrate-duration"

Vibration duration.

#define ALP_ATTN_PROP_VIBRATE_TYPE   "vibrate-type"

Vibration type.

#define ALP_ATTN_PROP_VIBRATE_URL   "vibrate-url"

Vibrate URL.

Alert accept on values

accept-call = { on-accept-key | on-any-key | after-delay }

#define ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY   "after-delay"

Perform accept action after accept delay.

#define ALP_ATTN_VALUE_ACCEPT_ON_ACCEPT_KEY   "on-accept-key"

Perform accept action on 'Accept' key press.

#define ALP_ATTN_VALUE_ACCEPT_ON_ANY_KEY   "on-any-key"

Perform accept action on any key press.

Action verb definitions

#define ALP_ATTN_VALUE_ADVERB_CLEAR   "-clear"

Clear adverb.

#define ALP_ATTN_VALUE_VERB_ACCEPT   "accept"

Indirect accept action verb.

#define ALP_ATTN_VALUE_VERB_CLEAR   "clear"

Indirect clear action verb.

#define ALP_ATTN_VALUE_VERB_CONNECT   "connect"

Connect action verb connect to a callback channel and send args.

#define ALP_ATTN_VALUE_VERB_DEF_CONNECT   "def-connect"

Default connect action verb.

#define ALP_ATTN_VALUE_VERB_DELETE   "delete"

Delete action verb delete alert.

#define ALP_ATTN_VALUE_VERB_DISMISS   "dismiss"

Dismiss alert action verb.

#define ALP_ATTN_VALUE_VERB_DISPLAY   "display"

Display action verb.

#define ALP_ATTN_VALUE_VERB_EXCHANGE   "exchange"

Exchange action verb.

#define ALP_ATTN_VALUE_VERB_GOTO   "goto"

Indirect goto action verb.

#define ALP_ATTN_VALUE_VERB_LAUNCH   "launch"

Launch action verb.

#define ALP_ATTN_VALUE_VERB_OKAY   "okay"

Indirect okay action verb.

#define ALP_ATTN_VALUE_VERB_REJECT   "reject"

Indirect reject action verb.

#define ALP_ATTN_VALUE_VERB_SET   "set"

Set properties.

#define ALP_ATTN_VALUE_VERB_SNOOZE   "snooze"

Snooze action verb.

Deprecated Values

These value definitions have been deprecated and should not be used in newly-written code.

#define ALP_ATTN_VALUE_DEST_DIALOG   "dialog"

#define ALP_ATTN_VALUE_DEST_LIST   "list"

#define ALP_ATTN_VALUE_STOCK_VIBRATE_DEF   "alp-stock-default"

#define ALP_ATTN_VALUE_STOCK_VIBRATE_OFF   "alp-stock-off"

Alert dialog window type definitions

#define ALP_ATTN_VALUE_DIALOG_TYPE_DEFAULT   "default"

Default window type.

#define ALP_ATTN_VALUE_DIALOG_TYPE_DIALOG   "dialog"

Dialog window type.

#define ALP_ATTN_VALUE_DIALOG_TYPE_FULL   "full"

Normal window type.

#define ALP_ATTN_VALUE_DIALOG_TYPE_FULLSCREEN   "fullscreen"

Normal window type Dialog window fills the entire screen including the status bar and window decoration is disabled.

#define ALP_ATTN_VALUE_DIALOG_TYPE_NORMAL   "normal"

Normal window type.

Alert effect values

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_1   "custom-1"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_2   "custom-2"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_3   "custom-3"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_4   "custom-4"

#define ALP_ATTN_VALUE_EFFECT_KBD_BACKLIGHT   "kbd-backlight"

#define ALP_ATTN_VALUE_EFFECT_LED   "led"

#define ALP_ATTN_VALUE_EFFECT_SOUND   "sound"

#define ALP_ATTN_VALUE_EFFECT_VIBRATE   "vibrate"

Alert effect sequence types (builtin)

#define ALP_ATTN_VALUE_EFFECT_SEQ_DEFAULT   "default"

Default effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_SILENT   "silent"

Silent effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_SOUND   "sound"

Sound effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE   "vibrate"

Vibrate effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_AND_SOUND   "vibrate-and-sound"

Silent effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_THEN_SOUND   "vibrate-then-sound"

Silent effect sequence.

Alert display facility values

#define ALP_ATTN_VALUE_FACILITY_DIALOG   "dialog"

Alert Dialog.

#define ALP_ATTN_VALUE_FACILITY_LIST   "list"

Alert List.

#define ALP_ATTN_VALUE_FACILITY_MODAL_DIALOG   "modal-dialog"

Alert Modal Dialog.

Alert level values

See also:
ALP_ATTN_PROP_LEVEL

#define ALP_ATTN_VALUE_LEVEL_CRITICAL   "critical"

Critical alert priority level.

#define ALP_ATTN_VALUE_LEVEL_DEFAULT   ""

#define ALP_ATTN_VALUE_LEVEL_IMPORTANT   "important"

Important alert priority level.

#define ALP_ATTN_VALUE_LEVEL_INFO   "info"

Info alert priority level.

#define ALP_ATTN_VALUE_LEVEL_NOTICE   "notice"

Notice alert priority level.

Alert power wake state values

See also:
ALP_ATTN_PROP_POWER_WAKE_STATE

#define ALP_ATTN_VALUE_POWER_WAKE_FULL   "full"

Fully wake device.

#define ALP_ATTN_VALUE_POWER_WAKE_SEMI   "semi"

Partially wake device.

Alert sound volume ramp properties values

#define ALP_ATTN_VALUE_SOUND_RAMP_ASP   "asp"

Use the Acoustic Shock Protection ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM   "custom"

Use custom ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_DEFAULT   "default"

Use default ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_ESCALATING   "escalating"

Use standard "escalating" volume ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_NONE   "none"

No volume ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_QUICK   "quick"

Use quick "escalating" volume ramp profile.

#define ALP_ATTN_VALUE_SOUND_RAMP_RINGTONE_ESCALATING   "ringtone-escalating"

Use ring tone specific "escalating" volume ramp profile.

Alert sound type values

These are predefined sound types are strings contants that as supported by the Media Session framework (see ALP_MM_SESSION_AUDIO_APP_TYPE). That framework may support additional sound type

#define ALP_ATTN_VALUE_SOUND_TYPE_ALARM   "alarm"

Alarm alert sound type.

#define ALP_ATTN_VALUE_SOUND_TYPE_ALERT   "alerts"

Generic alert sound type.

#define ALP_ATTN_VALUE_SOUND_TYPE_MESSAGE   "message"

Message alert sound type.

#define ALP_ATTN_VALUE_SOUND_TYPE_PHONE_CALL   "phone_call"

Phone Call alert sound type.

#define ALP_ATTN_VALUE_SOUND_TYPE_POWER   "power_sound"

Power alert sound type.

#define ALP_ATTN_VALUE_SOUND_TYPE_SYSTEM   "system_sounds"

System alert sound type.

Alert vibrate type values

Vibrate types are used to arbitrate which vibrate pattern takes precedence.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_ALARM   "alarm"

Alarm vibrate type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_ALERT   "etc"

Alert vibrate type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_MESSAGE   "message"

Message vibrate type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_PHONE_CALL   "incoming"

Phone call vibrate type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_SYSTEM   "system"

System vibrate type.

Defines

#define ALP_ATTN_VALUE_SOUND_CONTINUOUS   "continuous"

Play sound resouce continuously.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_CONNECT   "connect"

Connect alert type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_DISCONNECT   "disconnect"

Disconnect alert type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POPUP   "popup"

Popup alert type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_OFF   "power_off"

Power off alert type.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_ON   "power_on"

Power on alert type.

Define Documentation

#define ALP_ATTN_PROP_ACCEPT_CALL "accept-call"

Control how an alert is to be accepted.
Specifies under what conditions the action-accept will be performed. The values for ALP_ATTN_PROP_ACCEPT_CALL are ALP_ATTN_VALUE_ACCEPT_ON_ACCEPT_KEY, ALP_ATTN_VALUE_ACCEPT_ON_ANY_KEY, or ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY.
The default is ALP_ATTN_VALUE_ACCEPT_ON_ACCEPT_KEY.

#define ALP_ATTN_PROP_ACCEPT_DELAY "accept-delay"

Timeout to automatically accept an alert.
Specifies the number of milliseconds before performing the ALP_ATTN_PROP_ACTION_ACCEPT action if ALP_ATTN_PROP_ACCEPT_CALL is set to ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY.
A value of zero (0) will prevent the action from being performed.

#define ALP_ATTN_PROP_ACTION_ACCEPT "action-accept"

Action to perform when the alert is accepted.
Action to be taken when the accept key is pressed to accept an incoming call. There is no default action.
If the ALP_ATTN_PROP_ACCEPT_CALL is set to ALP_ATTN_VALUE_ACCEPT_ON_ANY_KEY, then this action will be performed when any key is pressed or button touched (except the reject key/button). If set to ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY (to support the auto-answer feature), this action will be performed when the ALP_ATTN_PROP_ACCEPT_DELAY expires.
There is no default action.

#define ALP_ATTN_PROP_ACTION_CLEAR "action-clear"

Action for Clear operation.
Action to be performed when the "clear" operation is selected.
Default value is ALP_ATTN_VALUE_VERB_DELETE.

#define ALP_ATTN_PROP_ACTION_DEFAULT "action-default"

Default action.
If the alert dialog is dismissed (removed) from the screen for any reason (new alert, pressing the home key or apps key, etc), the specified action is performed.
Default value is ALP_ATTN_VALUE_VERB_DISMISS.

#define ALP_ATTN_PROP_ACTION_DIALOG_TIMEOUT "action-dialog-timeout"

Dialog Timeout action.
Specifies action to be performed when the dialog timer expires.
If this property is not set, then the ALP_ATTN_PROP_ACTION_DEFAULT property (and if not set, it's default) is used.

#define ALP_ATTN_PROP_ACTION_GOTO "action-goto"

Action for Goto operation.
Action to be performed when the "goto" operation is selected.
Default value is ALP_ATTN_VALUE_VERB_DISPLAY.

#define ALP_ATTN_PROP_ACTION_OKAY "action-okay"

Action for Okay operation.
Action to be performed when the "okay" operation is selected.
Default value is ALP_ATTN_VALUE_VERB_DISMISS.

#define ALP_ATTN_PROP_ACTION_REJECT "action-reject"

Action to perform when the alert is rejected.
Action to be taken when the reject key is pressed to reject an incoming call.
There is no default action.

#define ALP_ATTN_PROP_ALERT_ACTION "action"

Alert action.
This property is used to associated an action with an action widget. For instance, to specify the action for the "button-4" widget, the alert dialog will look for the property "action-button-4" and use the value specified there as the action for the alert.
At this time, only GtkButton are supported.
Again, there are no defaults but the default glade file (or the one specified with the ALP_ATTN_PROP_ALERT_DIALOG_URLmay have establish some

#define ALP_ATTN_PROP_ALERT_ACTION_BUTTON "action-button"

Alert button action.

#define ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_ACTIVE "action-toggled-active"

Alert toggle button action.

#define ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_INACTIVE "action-toggled-inactive"

Alert toggle button action.

#define ALP_ATTN_PROP_ALERT_ANIM_IMAGE "animated-image"

Alert dialog animated image.
The "animated-image" and "animated-image-1" thru "animated-image-5" properties will be used if there is a widget with same name in the dialog glade.
The format for this property is a single URL using these supported forms:

pathname
File pathname of resource local to the alert's source application's resource area

bundle-id/pathname
File pathname of resource belonging to specified bundle.

file://pathname
Absolute file pathname reference.

The animated images will play animated images such as GIF animations.
There is no default for the animated image widgets. If used in glade file without a matching property or a valid URL, then the missing icon will be displayed in it place.

#define ALP_ATTN_PROP_ALERT_BUTTON "button"

Alert dialog button.
The values for these button properties. "button-1", "button-2", "button-3" and "button-4" are used for the labels on the GtkButtons widgets with the same name.
These value have no defaults but the default glade file if used does have default buttons.

#define ALP_ATTN_PROP_ALERT_DETAILS_TITLE "details-label"

Details folder label.
This property may be used to specify a pango markup label for the details folder widget in the generic dialog.
Default value is no label.

#define ALP_ATTN_PROP_ALERT_DIALOG_ROOT ALP_ATTN_PROP_DIALOG_ROOT

Deprecated:
Replaced by ALP_ATTN_PROP_DIALOG_ROOT.

#define ALP_ATTN_PROP_ALERT_DIALOG_TIMEOUT ALP_ATTN_PROP_DIALOG_TIMEOUT

Deprecated:
Replaced by ALP_ATTN_PROP_DIALOG_TIMEOUT.

#define ALP_ATTN_PROP_ALERT_DIALOG_URL ALP_ATTN_PROP_DIALOG_URL

Deprecated:
Replaced by ALP_ATTN_PROP_DIALOG_URL.

#define ALP_ATTN_PROP_ALERT_DIALOG_WIDGET ALP_ATTN_PROP_DIALOG_TOP

Deprecated:
Replaced by ALP_ATTN_PROP_DIALOG_TOP.

#define ALP_ATTN_PROP_ALERT_ICON "icon"

Alert icon.
This property is used to specify an image list (base image plus optional badge images) for the icon image that appears next to the alert item in the attention alert list. Additionally, it will be used as the default image if there exists an "image" GtkImage widget in the glade file the alert dialog and the image property isn't provided.
Since the icon images may be made up of a base image with several badge images, the value for this property is a list of space separated URLs.

Example
Here is an example using stock icons:
char *icon_urls = ALP_STOCK_TELEPHONY_APP " " ALP_STOCK_TELE_MISSED_BADGE;
The URL forms supported are:

pathname
File pathname of resource local to the alert's source application's resource area

bundle-id/pathname
File pathname of resource belonging to specified bundle.

file://pathname
Absolute file pathname reference.

stock icon name Stock icon name (see <alp/icons.h>)

#define ALP_ATTN_PROP_ALERT_IMAGE "image"

Alert dialog image.
The properties "image" and "image-1" thru "image-5" are used to provide an image list for any GtkImage widget that has the same name as the property. An example would be having a widget named "image-5" in the dialog glade file. When the attention alert dialog goes to display the glade file and this "image-5" widget, it will lookup the value of the corresponding "image-5" property and then use the expected image list to construct the desired image for that widget.
The format for this property is the same as the image list used for ALP_ATTN_PROP_ALERT_ICON.
For the "image" property, if it is not specified, the attention alert dialog will attempt to use the "icon" (ALP_ATTN_PROP_ALERT_ICON) if specified. Otherwise it will use the "alp-stock-alert" (ALP_STOCK_ALERT).
For the other "image" widgets (ones named "image-1", "image-2", ... "image-5") there is no default. If used in glade file without a matching property or a valid URL, then the missing icon will be displayed in it place.

#define ALP_ATTN_PROP_ALERT_LED_PATTERN "led-pattern"

Deprecated:

#define ALP_ATTN_PROP_ALERT_MARKUP "markup"

Alert dialog markup.
The markup properties, "markup-1", "markup-2", ... "markup-6" are used with GtkLabel widgets with the same name. Support for pango style text markup is enabled.
There is no default value.

#define ALP_ATTN_PROP_ALERT_RING_TONE_URL "ring-tone-url"

Deprecated:
Replaced by ALP_ATTN_PROP_SOUND_URL and ALP_ATTN_PROP_SOUND_COUNT set to ALP_ATTN_VALUE_SOUND_CONTINUOUS.

#define ALP_ATTN_PROP_ALERT_SMARTTEXT "smarttext"

Alert dialog smart text.
The smart text properties "smarttext-1" thru "smarttext-6" are mapped to non-editable GtkTextView widgets with the same name. They are used to display text that contains phone numbers, email address, and web addresses. These numbers and addresses are recognized as smart text and if selected, will result in a popup menu offering a number of action to take on the smart text.
For instance, a phone number may result in a menu offering to dial, text it back, or save it in contacts.
These smarttext widgets do not support the use of Pango style text markup.
There is no default value for this property.

#define ALP_ATTN_PROP_ALERT_SUMMARY "summary"

Alert list summary.
This property is used where only a 1 to 2 line summary of the alert is to be displayed. This property accepts Pango style text markup.
If this property is not specified, the first and second text / markup / smarttext fields are concatenated together with a newline placed between the two lines.

#define ALP_ATTN_PROP_ALERT_SUMMARY_TITLE "summary-label"

Summary folder label.
This property may be used to specify a pango markup label for the summary folder widget in the generic dialog.
Default value is no label.

#define ALP_ATTN_PROP_ALERT_TEXT "text"

Alert dialog text.
The text properties, "text-1", "text-2", ... "text-6" are used with GtkLabel widgets with the same name. Support for pango style text markup is disabled and will result in the markup being displayed in the label.
There is no default value.

#define ALP_ATTN_PROP_ALERT_TITLE "title"

Alert dialog title.
This property may be used to specify the title of the alert dialog.

#define ALP_ATTN_PROP_ALERT_TONE_MAX_DURATION "alert-tone-max-duration"

Deprecated:
Replaced by ALP_ATTN_PROP_SOUND_MAX_DURATION.

#define ALP_ATTN_PROP_ALERT_TONE_REPEAT_COUNT "alert-tone-repeat-count"

Deprecated:
Replaced by ALP_ATTN_PROP_SOUND_COUNT.

#define ALP_ATTN_PROP_ALERT_TONE_URL "alert-tone-url"

Deprecated:
Replaced by ALP_ATTN_PROP_SOUND_URL.

#define ALP_ATTN_PROP_ALERT_VIBRATE_PATTERN ALP_ATTN_PROP_VIBRATE_PATTERN

Deprecated:
Replaced by ALP_ATTN_PROP_VIBRATE_VIBRATE.

#define ALP_ATTN_PROP_DIALOG_BACKGROUND_URL "background-url"

Dialog Background URL.
This property may be set to the URL of an image resource that will used for the background of the alert dialog.
The URL forms supported are:

pathname
File pathname of resource local to the alert's source application's resource area

bundle-id/pathname
File pathname of resource belonging to specified bundle.

file://pathname
Absolute file pathname reference.

There is no background image by default.

#define ALP_ATTN_PROP_DIALOG_EMOTICON_BUNDLE_ID "emoticon-id"

Dialog emoticon resource bundle id.

#define ALP_ATTN_PROP_DIALOG_ROOT "dialog-root"

Dialog glade root.
This property, if set, specifies the name of the widget to start building the dialog from.
Default value is NULL.

#define ALP_ATTN_PROP_DIALOG_TIMEOUT "dialog-timeout"

Dialog timeout.
The dialog timeout in seconds. When the timeout expires, the dialog will be dismissed. If the ALP_ATTN_PROP_ACTION_DEFAULT is specified, that action will be performed.
Default is 0 which means the timeout is disabled.

#define ALP_ATTN_PROP_DIALOG_TOP "dialog-top"

Dialog glade top.
This property, if set, specifies the name of the top level (i.e. window) widget to look for in the glade file. If ALP_ATTN_PROP_DIALOG_ROOT is specified, the top widget must be a child of the root widget.
Default vale is dialog-top .

#define ALP_ATTN_PROP_DIALOG_TYPE "dialog-type"

Dialog Window Type.
This property can be used to control the window type hint for the alert dialog window..
The default value is ALP_ATTN_VALUE_DIALOG_TYPE_DEFAULT.

See also:
ALP_ATTN_VALUE_DIALOG_TYPE_DEFAULT
ALP_ATTN_VALUE_DIALOG_TYPE_DIALOG
ALP_ATTN_VALUE_DIALOG_TYPE_NORMAL
ALP_ATTN_VALUE_DIALOG_TYPE_FULL
ALP_ATTN_VALUE_DIALOG_TYPE_FULLSCREEN

#define ALP_ATTN_PROP_DIALOG_URL "dialog-url"

Dialog glade URL.
This property, if set, will specify the URL of the glade file to use for the alert dialog.
The URL forms supported are:

pathname
File pathname of resource local to the alert's source application's resource area

bundle-id/pathname
File pathname of resource belonging to specified bundle.

file://pathname
Absolute file pathname reference.

If this property is not specified, a default glade file for generic alerts (bar:com.access.apps.alert_dialog/alert_dialog.glade) will be used.

#define ALP_ATTN_PROP_DIALOG_WIDGET ALP_ATTN_PROP_DIALOG_TOP

Deprecated:
Replaced by ALP_ATTN_PROP_DIALOG_TOP.

#define ALP_ATTN_PROP_EFFECTS "effects"

Alert effects.
List of effects (sound, vibrate, etc) that are requested to be activated when the alert is presented.
The property can be a specific list of effects like this
"sound,vibrate"
or it can be relative to a default effects list where effects are added or subtracted. An example of this would be:
"-sound,+vibrate"
which would remove the playing of sound as an effect for the alert while at the same time ensuring that the alert would vibrate the device.

Here the same example, except using the definitions:
"-" ALP_ATTN_VALUE_EFFECT_SOUND ",+" ALP_ATTN_VALUE_EFFECT_VIBRATE
The default value for this property is determine by the ALP_ATTN_PROP_LEVEL value.

See also:
ALP_ATTN_VALUE_EFFECT_SOUND
ALP_ATTN_VALUE_EFFECT_VIBRATE
ALP_ATTN_VALUE_EFFECT_LED
ALP_ATTN_VALUE_EFFECT_KBD_BACKLIGHT
ALP_ATTN_VALUE_EFFECT_CUSTOM_1
ALP_ATTN_VALUE_EFFECT_CUSTOM_2
ALP_ATTN_VALUE_EFFECT_CUSTOM_3
ALP_ATTN_VALUE_EFFECT_CUSTOM_4

#define ALP_ATTN_PROP_EFFECTS_INTERVAL "effects-interval"

Effects sequence interval.
Specifies the interval on which effects are repeated.
If the value is negative, the sound effect repeat will cause the other effects to repeat if it happens before the interval expires.
This is for the case where a file of unknown duration is provided and there is still the need to cause the other effects to repeat at a reasonable rate. So, if the sound repeats prior to the interval timing out, then the other effects would use the sound's repeat notification to replay the other effects as well.

#define ALP_ATTN_PROP_EFFECTS_SEQUENCE_TYPE "effects-seq-type"

Effects sequence type.

#define ALP_ATTN_PROP_EVENT_DURATION "event-duration"

Event start time.
The duration of the event associated with the alert.
The duration is in number of seconds.

#define ALP_ATTN_PROP_EVENT_END "event-end"

Event start time.
The end time of the event associated with the alert.
Value is the number of seconds since 12:00 GMT Jan 1,1970 (i.e. UNIX time).

#define ALP_ATTN_PROP_EVENT_START "event-start"

Event start time.
The start time of the event associated with the alert.
Value is the number of seconds since 12:00 GMT Jan 1,1970 (i.e. UNIX time).

#define ALP_ATTN_PROP_FACILITIES "facilities"

Alert facilities.
List of facilities (modal dialog, dialog, list, etc) that the are requested to display the alert.
The property can be a specific list of facilities like this
"dialog,list"
or it can be relative to a default facility list where facilities are added or subtracted. An example of this would be:
"-dialog,+list"
which would remove the alert dialog as a facility to display the alert while at the same time ensuring that the alert would appear on the attention alert list.
The default value of this property is determine by the ALP_ATTN_PROP_LEVEL value.

See also:
ALP_ATTN_VALUE_FACILITY_MODAL_DIALOG
ALP_ATTN_VALUE_FACILITY_DIALOG
ALP_ATTN_VALUE_FACILITY_LIST

#define ALP_ATTN_PROP_LEVEL "level"

Alert priority level.
This property provides a priority level specification for an alert.
The priority specification allows for a plus or minus offset to allow more granularity of assigning priority to alerts.
Level format:
<defined-level-name>[{+|-}<numeric-offset]

Since it is most likely that an alert's priority level we be setting via settings preference, here is a preference setting example for an alert type:
<keyvalue> <key>/alp/attnmgr/types/alp/alarm/red-alert/props/level</key> <type>string</string> <value>important+10000</value> </keyvalue>
Specifying a postive offset will give the alert a higher priority while specifying a negative offset will give the alert a lower priority.
The default value is determined by the global setting /alp/attnmgr/types/props/level.default.

See also:
ALP_ATTN_VALUE_LEVEL_CRITICAL
ALP_ATTN_VALUE_LEVEL_IMPORTANT
ALP_ATTN_VALUE_LEVEL_NOTICE
ALP_ATTN_VALUE_LEVEL_INFO

#define ALP_ATTN_PROP_NAG_COUNT "nag-count"

Number of times to "nag" an alert.
Default is ALP_ATTN_VALUE_NAG_CONTINUOUS.

#define ALP_ATTN_PROP_NAG_INTERVAL "nag-interval"

Interval between "nagging" in seconds.
Default is 0 which means nagging is disabled.

#define ALP_ATTN_PROP_NAG_REPEAT_COUNT ALP_ATTN_PROP_NAG_COUNT

Number of times to "nag" an alert.

Deprecated:

Replaced by ALP_ATTN_PROP_NAG_COUNT.

#define ALP_ATTN_PROP_POWER_WAKE_STATE "power-wake"

Power wake state.
This property controls the power state to place the device into when the alert dialog is displayed.
Default is to used the current power state.

See also:
ALP_ATTN_VALUE_POWER_WAKE_FULL
ALP_ATTN_VALUE_POWER_WAKE_SEMI

#define ALP_ATTN_PROP_SIMPLE_SOUND_URL "simple-sound-url"

Simple sound resource URL.
This property allows the specification of the sound resource to be played when only the "simple" or abbreviate alert sound is to be played. This "simple" sound is usually used when the alert is not presented to the user as an alert dialog. There are three general cases where the dialog won't be present to the user:

"sound only" - alert is not displayed on the list or the dialog

"list only" - alert is not displayed on the dialog but it is on the list

"blocked" - alert is not display as a dialog because either the there is a higher priority dialog being currently displayed or the conflict manager rules CANCELed this particular alert-type of the dialog.

Only the stock sound names should be specified for this URL. (see ALP_SYS_STOCK_SOUND_PREFIX)

#define ALP_ATTN_PROP_SOUND_COUNT "sound-count"

Sound play count.
The number of times to play the sound resource.
Default value is ALP_ATTN_VALUE_SOUND_CONTINUOUS.

#define ALP_ATTN_PROP_SOUND_MAX_DURATION "sound-max-duration"

Sound max duration.
The maximum amount to play the sound including repeations in milliseconds.
Using this property in combination with ALP_ATTN_PROP_SOUND_COUNT being set to ALP_ATTN_VALUE_SOUND_CONTINUOUS allows you to keep a sound playing for a specific amount of time.
Default value is zero ("0") meaning no maximum duration.

#define ALP_ATTN_PROP_SOUND_RAMP_INTERVAL "sound-ramp-interval"

Sound ramp timer interval.
This property specifies the value of the interval timer in milliseconds.
If this value is negative, the timer is set to the absolute value of it. If the selected ring tone should repeat prior to the timer expiring, the volume step is added to the current volume and the interval timer is reset. This is done to allow a normal ring tone representing a single ring to advance the volume. Otherwise, the volume is increase each time this timer expires.
The default value is 4000.
Again, this only comes into play when ALP_ATTN_PROP_SOUND_RAMP_TYPE is set to ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM.

#define ALP_ATTN_PROP_SOUND_RAMP_TYPE "sound-ramp-type"

Sound ramp type.
This property specifies the ramp to use for the alert. The type names are used to look up the characteristics of a particular sound ramp.
The ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM value allows the alert to specify use its own ramp characteristics.

See also:
ALP_ATTN_VALUE_SOUND_RAMP_DEFAULT
ALP_ATTN_VALUE_SOUND_RAMP_NONE
ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM
ALP_ATTN_VALUE_SOUND_RAMP_QUICK
ALP_ATTN_VALUE_SOUND_RAMP_ESCALATING
ALP_ATTN_VALUE_SOUND_RAMP_RINGTONE_ESCALATING
ALP_ATTN_VALUE_SOUND_RAMP_ASP

#define ALP_ATTN_PROP_SOUND_TYPE "sound-type"

Sound Audio Types.
This property is used to set the ALP_MM_SESSION_AUDIO_APP_TYPE property on the destination stream of the audio session. This audio type is used by audio router / manager to arbitrate different sound sources (audio player output, keyboard clicks and attention alert sounds for instance) and either pause, block or mix the sounds depending on the device's configuration.
The property's string value is simply passed through to the media session framework. The media session framework has several predefined audio types of which several of those are useful for alert sound types. These have ALP_ATTN_VALUE_SOUND_TYPE_* definitions below.

Remarks:
It is possible, that on any particular device, the media session framework will have configured additional audio types that aren't among the predefined ones. In that case, since the string value for this property is simply passed on to the media session, all that is needed to use these additional types it to set this property to the string value of that the additional audio type.
If this property is not specified, then the ALP_ATTN_VALUE_SOUND_TYPE_ALERT ("alerts") is used as the default value.

See also:
ALP_ATTN_VALUE_SOUND_TYPE_ALARM
ALP_ATTN_VALUE_SOUND_TYPE_ALERT
ALP_ATTN_VALUE_SOUND_TYPE_MESSAGE
ALP_ATTN_VALUE_SOUND_TYPE_PHONE_CALL
ALP_ATTN_VALUE_SOUND_TYPE_POWER
ALP_ATTN_VALUE_SOUND_TYPE_SYSTEM

#define ALP_ATTN_PROP_SOUND_URL "sound-url"

Sound resource URL.
This property allows the specification of the sound resource to be played when the alert is presented to the user.
The URL forms supported are:

pathname
File pathname of resource local to the alert's source application's resource area

bundle-id/pathname
File pathname of resource belonging to specified bundle.

file://pathname
Absolute file pathname reference.

stock:sound/stock-sound-name
Stock sound name (see ALP_SYS_STOCK_SOUND_PREFIX)

#define ALP_ATTN_PROP_SOUND_VOLUME "sound-volume"

Volume level.
Value is a numeric string in the range from 0 to 100.
Note that this value is a precentage volume multiplied against the percentage volume set for the sound audio type times the percentage volume set for the output device.
For instance, if this property is set to "80" and the audio type was set at "80" plus the output device was set to "90", the resulting level would be "58" (.8 x .8 x .9 = .576).
Default value is "100". This is probably the best value for attention alerts.

#define ALP_ATTN_PROP_SOUND_VOLUME_START "sound-volume-start"

Start volume level.
This property is similar to the ALP_ATTN_PROP_SOUND_VOLUME but is meant to be used with the sound volume ramping logic and establishes what the starting volume level of the volume ramp should be.
Value is a numeric string in the range from 0 to 100.
Default value is "25" but only comes into play when the volume ramp is being used.
Again, this only comes into play when ALP_ATTN_PROP_SOUND_RAMP_TYPE is set to ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM.

#define ALP_ATTN_PROP_SOUND_VOLUME_STEP "sound-volume-step"

Volume step.
This property specifies the value by which to increase the volume by when the ramp interval timer expires.
Default value is "25" also. This allows the volume to start at "25" and then ramp "100" by the fourth ring of the incoming call alert.
Again, this only comes into play when ALP_ATTN_PROP_SOUND_RAMP_TYPE is set to ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM.

#define ALP_ATTN_PROP_VIBRATE_COUNT "vibrate-count"

Vibration count.
This property specifies the number of time to play the vibrate effect.
If both ALP_ATTN_PROP_VIBRATE_COUNT and ALP_ATTN_PROP_VIBRATE_DURATION are provided, ALP_ATTN_PROP_VIBRATE_COUNT will be used.
The default value is 1.

#define ALP_ATTN_PROP_VIBRATE_DURATION "vibrate-duration"

Vibration duration.
This property specifies the amount of time to do the vibrate effect in milliseconds.
If both ALP_ATTN_PROP_VIBRATE_COUNT and ALP_ATTN_PROP_VIBRATE_DURATION are provided, ALP_ATTN_PROP_VIBRATE_COUNT will be used.
There is no default value.

#define ALP_ATTN_PROP_VIBRATE_PATTERN "vibrate-pattern"

Deprecated:
Replaced by ALP_ATTN_PROP_VIBRATE_URL.

#define ALP_ATTN_PROP_VIBRATE_TYPE "vibrate-type"

Vibration type.
This property specifies the type of vibrate so that in the case of two or more vibrate effects being active, the may be arbitrated between as per licensee configuration. It is similar in concept to the ALP_ATTN_PROP_SOUND_TYPE.

See also:
ALP_ATTN_VALUE_VIBRATE_TYPE_ALARM
ALP_ATTN_VALUE_VIBRATE_TYPE_ALERT
ALP_ATTN_VALUE_VIBRATE_TYPE_MESSAGE
ALP_ATTN_VALUE_VIBRATE_TYPE_PHONE_CALL
ALP_ATTN_VALUE_VIBRATE_TYPE_SYSTEM
There is no default value.

#define ALP_ATTN_PROP_VIBRATE_URL "vibrate-url"

Vibrate URL.
This specifies the URL of vibrate song.
Only builtin (stock) vibrate songs are supported in this release.
The URL form supported is

stock:effect/

The stock effect song. Stock effects are defined in <alp/hweffects.h>
There is no default value.

#define ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY "after-delay"

Perform accept action after accept delay.
Perform accept action after the delay specified by ALP_ATTN_PROP_ACCEPT_DELAY passes.
Used for automatic call answer.

#define ALP_ATTN_VALUE_ACCEPT_ON_ACCEPT_KEY "on-accept-key"

Perform accept action on 'Accept' key press.
Perform accept action when either the on screen 'Accept' button or the call accept hard key (usually a key with a green phone handset on it) is pressed.

#define ALP_ATTN_VALUE_ACCEPT_ON_ANY_KEY "on-any-key"

Perform accept action on any key press.
Perform accept action on the pressing of any on screen button or hardkey except for the on screen 'Reject' button or hard key (usually a key with the red phone handset on it).

#define ALP_ATTN_VALUE_ADVERB_CLEAR "-clear"

Clear adverb.
This string definition is meant to be used with several of the action verbs such as ALP_ATTN_VALUE_VERB_LAUNCH or ALP_ATTN_VALUE_VERB_DEF_CONNECT.

Example:
AlpAttnProp props[] = { : ALP_ATTN_PROP( ALP_ATTN_PROP_ACTION_ACCEPT, ALP_ATTN_VALUE_VERB_DEF_CONNECT ALP_ATTN_VALUE_ADVERB_CLEAR " accept"), : };
This example creates a property element with a key "action-accept" and a value "def-connect-clear accept". The value is created here by concatenating the strings "def-connect" with "-clear" to form the actual action verb and then concatenates " accept" as the only argument for that action.

#define ALP_ATTN_VALUE_DEST_DIALOG "dialog"

Deprecated:
Use the ALP_ATTN_PROP_FACILITIES property with the ALP_ATTN_VALUE_FACILITY_DIALOG value.

#define ALP_ATTN_VALUE_DEST_LIST "list"

Deprecated:
Use the ALP_ATTN_PROP_FACILITIES property with the ALP_ATTN_VALUE_FACILITY_LIST value.

#define ALP_ATTN_VALUE_DIALOG_TYPE_DEFAULT "default"

Default window type.
Specifies the use of the theme or licensee defined default dialog window type.

#define ALP_ATTN_VALUE_DIALOG_TYPE_DIALOG "dialog"

Dialog window type.
Specifies a dialog window type that is just large enough to contain the alert. The window decoration is enabled.

#define ALP_ATTN_VALUE_DIALOG_TYPE_FULL "full"

Normal window type.
Specifies a dialog window that fills the screen except for the status bar. The window decoration is disabled.

#define ALP_ATTN_VALUE_DIALOG_TYPE_FULLSCREEN "fullscreen"

Normal window type Dialog window fills the entire screen including the status bar and window decoration is disabled.
Specifies a dialog window that fills most of screen except for the status bar and that has window decoration enabled.

#define ALP_ATTN_VALUE_DIALOG_TYPE_NORMAL "normal"

Normal window type.
Specifies a dialog window that fills most of screen except for the status bar. The window decoration is enabled.

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_1 "custom-1"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_2 "custom-2"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_3 "custom-3"

#define ALP_ATTN_VALUE_EFFECT_CUSTOM_4 "custom-4"

#define ALP_ATTN_VALUE_EFFECT_KBD_BACKLIGHT "kbd-backlight"

#define ALP_ATTN_VALUE_EFFECT_LED "led"

#define ALP_ATTN_VALUE_EFFECT_SEQ_DEFAULT "default"

Default effect sequence.
This will allow the system to choose the best sequence type for the effects.

#define ALP_ATTN_VALUE_EFFECT_SEQ_SILENT "silent"

Silent effect sequence.
This effects sequence will not play sound nor will it cause the device to vibrate.

#define ALP_ATTN_VALUE_EFFECT_SEQ_SOUND "sound"

Sound effect sequence.
This effects sequence will only play sound according to the ALP_ATTN_PROP_SOUND_URL. It will not cause the device to vibrate.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE "vibrate"

Vibrate effect sequence.
This effects sequence will not play sound but will cause the device to vibrate according to ALP_ATTN_PROP_VIBRATE_URL and ALP_ATTN_PROP_VIBRATE_TYPE.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_AND_SOUND "vibrate-and-sound"

Silent effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_THEN_SOUND "vibrate-then-sound"

Silent effect sequence.

#define ALP_ATTN_VALUE_EFFECT_SOUND "sound"

#define ALP_ATTN_VALUE_EFFECT_VIBRATE "vibrate"

#define ALP_ATTN_VALUE_FACILITY_DIALOG "dialog"

Alert Dialog.
Requests that the alert be presented in an attention alert dialog window.

#define ALP_ATTN_VALUE_FACILITY_LIST "list"

Alert List.
Requests that the alert be included on the attention alert list.

#define ALP_ATTN_VALUE_FACILITY_MODAL_DIALOG "modal-dialog"

Alert Modal Dialog.
Requests that the alert be presented in a system modal attention alert dialog window.

#define ALP_ATTN_VALUE_LEVEL_CRITICAL "critical"

Critical alert priority level.
This priority level is reserved for the most important alert which require immediate attention such as an incoming call alert or critical battery warning.

#define ALP_ATTN_VALUE_LEVEL_DEFAULT ""

#define ALP_ATTN_VALUE_LEVEL_IMPORTANT "important"

Important alert priority level.
This priority level it intended for alerts which are important and intrusive such as a clock or wakeup alarms and to slightly lesser degree, calendar events.

#define ALP_ATTN_VALUE_LEVEL_INFO "info"

Info alert priority level.
This priority level is intended for alerts which are not intrusive (no dialogs). This includes attention list only or sound only alerts.

#define ALP_ATTN_VALUE_LEVEL_NOTICE "notice"

Notice alert priority level.
This priority level is intended for alerts which are less intrusive such as download complete notifications.

#define ALP_ATTN_VALUE_NAG_CONTINUOUS "continuous"

Nag continuously until dismissed.
This value will cause the alert to nag continuously until the alert is dismissed.

#define ALP_ATTN_VALUE_POWER_WAKE_FULL "full"

Fully wake device.
Request that device become fully awake with the screen on.

#define ALP_ATTN_VALUE_POWER_WAKE_SEMI "semi"

Partially wake device.
Request that device be only partially awake with the screen off.

#define ALP_ATTN_VALUE_SOUND_CONTINUOUS "continuous"

Play sound resouce continuously.
Use this value for ALP_ATTN_PROP_SOUND_COUNT when wishing to play the sound continuously until the alert is dismissed.

#define ALP_ATTN_VALUE_SOUND_RAMP_ASP "asp"

Use the Acoustic Shock Protection ramp profile.
Similar to the ALP_ATTN_VALUE_SOUND_RAMP_ESCALATING in that it starts at the first volume setting and then step up to the next volume setting every 2000 milliseconds up set to specified volume (ALP_ATTN_PROP_SOUND_VOLUME).

#define ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM "custom"

Use custom ramp profile.
Set the volume to the initial volume (ALP_ATTN_PROP_SOUND_VOLUME_START), and then step up the volume by ALP_ATTN_PROP_SOUND_VOLUME_STEP every ALP_ATTN_PROP_SOUND_RAMP_INTERVAL milliseconds, up to ALP_ATTN_PROP_SOUND_VOLUME.

#define ALP_ATTN_VALUE_SOUND_RAMP_DEFAULT "default"

Use default ramp profile.
Use the default ramp profile specific to the ALP_ATTN_PROP_SOUND_TYPE.

#define ALP_ATTN_VALUE_SOUND_RAMP_ESCALATING "escalating"

Use standard "escalating" volume ramp profile.
The standard ramp starts at the first volume setting and then steps up to the next volume setting every 4000 milliseconds until reaching ALP_ATTN_PROP_SOUND_VOLUME, if specified, otherwise 100%.

#define ALP_ATTN_VALUE_SOUND_RAMP_NONE "none"

No volume ramp profile.
Simply set volume to specified volume (ALP_ATTN_PROP_SOUND_VOLUME if set, otherwise to 100 percent, the default).

#define ALP_ATTN_VALUE_SOUND_RAMP_QUICK "quick"

Use quick "escalating" volume ramp profile.
The quick ramp starts at the 10% volume setting and then steps up volume 15% every 667 milliseconds until reaching ALP_ATTN_PROP_SOUND_VOLUME, if specified, otherwise 100%. This will allow the sound to reach full volume within 4 seconds.

#define ALP_ATTN_VALUE_SOUND_RAMP_RINGTONE_ESCALATING "ringtone-escalating"

Use ring tone specific "escalating" volume ramp profile.
The standard ramp will start at volume setting 25% and then step the volume up 25% when the ring tone repeats or every 6500 msec (which ever occurs first) until reaching ALP_ATTN_PROP_SOUND_VOLUME, if specified, otherwise 100%.

#define ALP_ATTN_VALUE_SOUND_TYPE_ALARM "alarm"

Alarm alert sound type.
This sound type is used for "alarm" type alerts such clock alarm, wakeup alarm and calendar events.

#define ALP_ATTN_VALUE_SOUND_TYPE_ALERT "alerts"

Generic alert sound type.
Sound type to use for all the alert types that don't fit the other, more specific sound types.

#define ALP_ATTN_VALUE_SOUND_TYPE_MESSAGE "message"

Message alert sound type.
Sound type to use for messaging types of alerts such as email, im, and sms.

#define ALP_ATTN_VALUE_SOUND_TYPE_PHONE_CALL "phone_call"

Phone Call alert sound type.
Sound type to use for the incoming call alert.

#define ALP_ATTN_VALUE_SOUND_TYPE_POWER "power_sound"

Power alert sound type.
Sound type to use for power manager alerts such as the low battery alert and the critical battery alert.

#define ALP_ATTN_VALUE_SOUND_TYPE_SYSTEM "system_sounds"

System alert sound type.
Sound type to use for alerts generate by various system services.

#define ALP_ATTN_VALUE_STOCK_VIBRATE_DEF "alp-stock-default"

Deprecated:
Patterns replaced with ALP_ATTN_PROP_VIBRATE_URL and ALP_ATTN_PROP_VIBRATE_TYPE.
No direct replacement.

#define ALP_ATTN_VALUE_STOCK_VIBRATE_OFF "alp-stock-off"

Deprecated:
Patterns replaced with ALP_ATTN_PROP_VIBRATE_URL and ALP_ATTN_PROP_VIBRATE_TYPE (see ALP_ATTN_VALUE_VIBRATE_TYPE_*).
No direct replacement.

#define ALP_ATTN_VALUE_VERB_ACCEPT "accept"

Indirect accept action verb.
This specifies that the action defined for ALP_ATTN_PROP_ACTION_ACCEPT should be used.

#define ALP_ATTN_VALUE_VERB_CLEAR "clear"

Indirect clear action verb.
This specifies that the action defined for ALP_ATTN_PROP_ACTION_CLEAR should be used.

#define ALP_ATTN_VALUE_VERB_CONNECT "connect"

Connect action verb connect to a callback channel and send args.
Specifies doing a connection action to the specified callback channel and sending the supplied arguments to the waiting callback function. If the optional suffix "-clear" is present, the alert will be deleted after the connect.

Format:
connect[-clear] <callback-channel> <arg0> ... <argN>

#define ALP_ATTN_VALUE_VERB_DEF_CONNECT "def-connect"

Default connect action verb.
Specifies doing a connection action to the default callback channel and sending the supplied arguments to the waiting callback function. If the optional suffix "-clear" is present, the alert will be deleted after the connect. The default callback channel is passed in a property by alp_attn_post_with_callback().

Format:
def-connect[-clear] <arg0> ... <argN>

#define ALP_ATTN_VALUE_VERB_DELETE "delete"

Delete action verb delete alert.
This specifies that the associated alert is to be deleted. This will dismiss the alert dialog and if ALP_ATTN_PROP_ACTION_DEFAULT is also specified, its action will be peformed.
This verb takes no arguments.

#define ALP_ATTN_VALUE_VERB_DISMISS "dismiss"

Dismiss alert action verb.
Specifies that the current displayed alert dialog should be dismissed (or closed). The alert is not deleted.
This verb takes no arguments.

#define ALP_ATTN_VALUE_VERB_DISPLAY "display"

Display action verb.
This is a shortcut action for launching the alert's source application with a few predefined arguments including the handle string used in posting the alert. This is done so that the application can display information pertinent to the handle string.

Format:
display [<arg0> ... <argN>]

This is equivalent to:
launch-clear <source-app-id> --alp-primary --alp-display <handle> [<arg0> ... <argN>]

#define ALP_ATTN_VALUE_VERB_EXCHANGE "exchange"

Exchange action verb.
Specifies the exchange action and arguments to pass to it. The alert will be cleared after the exchange action is performed.

Format:
exchange <verb[/method]> <data-type> [<type>/<key>=<value>] ...

#define ALP_ATTN_VALUE_VERB_GOTO "goto"

Indirect goto action verb.
This specifies that the action defined for ALP_ATTN_PROP_ACTION_GOTO should be used.

#define ALP_ATTN_VALUE_VERB_LAUNCH "launch"

Launch action verb.
Specifies doing a launch of the specified application, passing it any additional arguments present. If the optional suffix "-clear" is present, the alert will be deleted after the launch.

Format:
launch[-clear] <app-id> [<arg0> ... <argN>]

Example:
launch bar:com.access.apps.calendar --alp-primary --alp-display 12345

#define ALP_ATTN_VALUE_VERB_OKAY "okay"

Indirect okay action verb.
This specifies that the action defined for ALP_ATTN_PROP_ACTION_OKAY should be used.

#define ALP_ATTN_VALUE_VERB_REJECT "reject"

Indirect reject action verb.
This specifies that the action defined for ALP_ATTN_PROP_ACTION_REJECT should be used.

#define ALP_ATTN_VALUE_VERB_SET "set"

Set properties.
Sets properties, specified by a key name, to a value.
Format:
set <property-key-name>=<property-value> [<property-key-name>=<property-value> ...]

Example:
ALP_ATTN_PROP(ALP_ATTN_PROP_ACTION"-checkbox-1-toggled-active", ALP_ATTN_VALUE_VERB_SET " action-goto='def-connect allow always' action-button-2='def-connect cancel always'"), ALP_ATTN_PROP(ALP_ATTN_PROP_ACTION"-checkbox-1-toggled-inactive", ALP_ATTN_VALUE_VERB_SET " action-goto='def-connect allow' action-button-2='def-connect cancel'"),

#define ALP_ATTN_VALUE_VERB_SNOOZE "snooze"

Snooze action verb.
This action will cause the associated alert to be snoozed for the specified number of minutes. If the snooze time is not provided, the default is 5 minutes.

Format:
snooze [minutes-to-snooze]

Parameters:

minutes-to-snooze is the time to snooze in minutes.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_ALARM "alarm"

Alarm vibrate type.
This is for "alarm" type alerts such as clock alarms, wakeup alarms and calendar events.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_ALERT "etc"

Alert vibrate type.
This is for generic alerts that don't fit the other types.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_CONNECT "connect"

Connect alert type.
This is for alerts indicating a connection has been established.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_DISCONNECT "disconnect"

Disconnect alert type.
This is for alerts indicating a connection has been disconnected.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_MESSAGE "message"

Message vibrate type.
This is for messaging type alerts such email, im or sms alerts.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_PHONE_CALL "incoming"

Phone call vibrate type.
This is for incoming call alerts.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POPUP "popup"

Popup alert type.
This is for a popup dialog type alert that does not fall under the generic ALP_ATTN_VALUE_VIBRATE_TYPE_ALERT.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_OFF "power_off"

Power off alert type.
This is for power off alerts.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_ON "power_on"

Power on alert type.
This is for power on alerts.

#define ALP_ATTN_VALUE_VIBRATE_TYPE_SYSTEM "system"

System vibrate type.
This is for alert generate by system services.

Generated on Wed Jul 30 07:06:44 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Telephony specific action properties
These properties are intended to use for incoming call alerts and are of little use for other types of alerts.
#define	ALP_ATTN_PROP_ACCEPT_CALL "accept-call"
	Control how an alert is to be accepted.
#define	ALP_ATTN_PROP_ACCEPT_DELAY "accept-delay"
	Timeout to automatically accept an alert.
#define	ALP_ATTN_PROP_ACTION_ACCEPT "action-accept"
	Action to perform when the alert is accepted.
#define	ALP_ATTN_PROP_ACTION_REJECT "action-reject"
	Action to perform when the alert is rejected.
Generic alert action properties
#define	ALP_ATTN_PROP_ACTION_CLEAR "action-clear"
	Action for Clear operation.
#define	ALP_ATTN_PROP_ACTION_DEFAULT "action-default"
	Default action.
#define	ALP_ATTN_PROP_ACTION_DIALOG_TIMEOUT "action-dialog-timeout"
	Dialog Timeout action.
#define	ALP_ATTN_PROP_ACTION_GOTO "action-goto"
	Action for Goto operation.
#define	ALP_ATTN_PROP_ACTION_OKAY "action-okay"
	Action for Okay operation.
Basic Alert properties
#define	ALP_ATTN_PROP_ALERT_ACTION "action"
	Alert action.
#define	ALP_ATTN_PROP_ALERT_ACTION_BUTTON "action-button"
	Alert button action.
#define	ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_ACTIVE "action-toggled-active"
	Alert toggle button action.
#define	ALP_ATTN_PROP_ALERT_ACTION_TOGGLED_INACTIVE "action-toggled-inactive"
	Alert toggle button action.
#define	ALP_ATTN_PROP_ALERT_ANIM_IMAGE "animated-image"
	Alert dialog animated image.
#define	ALP_ATTN_PROP_ALERT_BUTTON "button"
	Alert dialog button.
#define	ALP_ATTN_PROP_ALERT_DETAILS_TITLE "details-label"
	Details folder label.
#define	ALP_ATTN_PROP_ALERT_ICON "icon"
	Alert icon.
#define	ALP_ATTN_PROP_ALERT_IMAGE "image"
	Alert dialog image.
#define	ALP_ATTN_PROP_ALERT_MARKUP "markup"
	Alert dialog markup.
#define	ALP_ATTN_PROP_ALERT_SMARTTEXT "smarttext"
	Alert dialog smart text.
#define	ALP_ATTN_PROP_ALERT_SUMMARY "summary"
	Alert list summary.
#define	ALP_ATTN_PROP_ALERT_SUMMARY_TITLE "summary-label"
	Summary folder label.
#define	ALP_ATTN_PROP_ALERT_TEXT "text"
	Alert dialog text.
#define	ALP_ATTN_PROP_ALERT_TITLE "title"
	Alert dialog title.
#define	ALP_ATTN_PROP_POWER_WAKE_STATE "power-wake"
	Power wake state.
Deprecated Properties
The following properties have been deprecated and should not be used in newly-written code.
#define	ALP_ATTN_PROP_ALERT_DIALOG_ROOT ALP_ATTN_PROP_DIALOG_ROOT
#define	ALP_ATTN_PROP_ALERT_DIALOG_TIMEOUT ALP_ATTN_PROP_DIALOG_TIMEOUT
#define	ALP_ATTN_PROP_ALERT_DIALOG_URL ALP_ATTN_PROP_DIALOG_URL
#define	ALP_ATTN_PROP_ALERT_DIALOG_WIDGET ALP_ATTN_PROP_DIALOG_TOP
#define	ALP_ATTN_PROP_ALERT_LED_PATTERN "led-pattern"
#define	ALP_ATTN_PROP_ALERT_VIBRATE_PATTERN ALP_ATTN_PROP_VIBRATE_PATTERN
#define	ALP_ATTN_PROP_DIALOG_WIDGET ALP_ATTN_PROP_DIALOG_TOP
#define	ALP_ATTN_PROP_NAG_REPEAT_COUNT ALP_ATTN_PROP_NAG_COUNT
	Number of times to "nag" an alert.
#define	ALP_ATTN_PROP_VIBRATE_PATTERN "vibrate-pattern"
Sound properties
#define	ALP_ATTN_PROP_ALERT_RING_TONE_URL "ring-tone-url"
#define	ALP_ATTN_PROP_ALERT_TONE_MAX_DURATION "alert-tone-max-duration"
#define	ALP_ATTN_PROP_ALERT_TONE_REPEAT_COUNT "alert-tone-repeat-count"
#define	ALP_ATTN_PROP_ALERT_TONE_URL "alert-tone-url"
#define	ALP_ATTN_PROP_SIMPLE_SOUND_URL "simple-sound-url"
	Simple sound resource URL.
#define	ALP_ATTN_PROP_SOUND_COUNT "sound-count"
	Sound play count.
#define	ALP_ATTN_PROP_SOUND_MAX_DURATION "sound-max-duration"
	Sound max duration.
#define	ALP_ATTN_PROP_SOUND_RAMP_INTERVAL "sound-ramp-interval"
	Sound ramp timer interval.
#define	ALP_ATTN_PROP_SOUND_RAMP_TYPE "sound-ramp-type"
	Sound ramp type.
#define	ALP_ATTN_PROP_SOUND_TYPE "sound-type"
	Sound Audio Types.
#define	ALP_ATTN_PROP_SOUND_URL "sound-url"
	Sound resource URL.
#define	ALP_ATTN_PROP_SOUND_VOLUME "sound-volume"
	Volume level.
#define	ALP_ATTN_PROP_SOUND_VOLUME_START "sound-volume-start"
	Start volume level.
#define	ALP_ATTN_PROP_SOUND_VOLUME_STEP "sound-volume-step"
	Volume step.
Alert Dialog Window properties
#define	ALP_ATTN_PROP_DIALOG_BACKGROUND_URL "background-url"
	Dialog Background URL.
#define	ALP_ATTN_PROP_DIALOG_TYPE "dialog-type"
	Dialog Window Type.
Alert Dialog properties
#define	ALP_ATTN_PROP_DIALOG_EMOTICON_BUNDLE_ID "emoticon-id"
	Dialog emoticon resource bundle id.
#define	ALP_ATTN_PROP_DIALOG_ROOT "dialog-root"
	Dialog glade root.
#define	ALP_ATTN_PROP_DIALOG_TIMEOUT "dialog-timeout"
	Dialog timeout.
#define	ALP_ATTN_PROP_DIALOG_TOP "dialog-top"
	Dialog glade top.
#define	ALP_ATTN_PROP_DIALOG_URL "dialog-url"
	Dialog glade URL.
Alert handling properties
#define	ALP_ATTN_PROP_EFFECTS "effects"
	Alert effects.
#define	ALP_ATTN_PROP_EFFECTS_INTERVAL "effects-interval"
	Effects sequence interval.
#define	ALP_ATTN_PROP_EFFECTS_SEQUENCE_TYPE "effects-seq-type"
	Effects sequence type.
#define	ALP_ATTN_PROP_FACILITIES "facilities"
	Alert facilities.
#define	ALP_ATTN_PROP_LEVEL "level"
	Alert priority level.
Alert event time properties
#define	ALP_ATTN_PROP_EVENT_DURATION "event-duration"
	Event start time.
#define	ALP_ATTN_PROP_EVENT_END "event-end"
	Event start time.
#define	ALP_ATTN_PROP_EVENT_START "event-start"
	Event start time.
Alert Nagging properties and value
The "nag" properties are used to specify when to "nag" the user about an attention alert that has not been dismisse. The user is "nagged" by replaying the sound, vibrate and other effects configured for the alert. The "nags" will be repeated until the alert is dismissed or the nag count reaches zero.
#define	ALP_ATTN_PROP_NAG_COUNT "nag-count"
	Number of times to "nag" an alert.
#define	ALP_ATTN_PROP_NAG_INTERVAL "nag-interval"
	Interval between "nagging" in seconds.
#define	ALP_ATTN_VALUE_NAG_CONTINUOUS "continuous"
	Nag continuously until dismissed.
Vibrate properties
#define	ALP_ATTN_PROP_VIBRATE_COUNT "vibrate-count"
	Vibration count.
#define	ALP_ATTN_PROP_VIBRATE_DURATION "vibrate-duration"
	Vibration duration.
#define	ALP_ATTN_PROP_VIBRATE_TYPE "vibrate-type"
	Vibration type.
#define	ALP_ATTN_PROP_VIBRATE_URL "vibrate-url"
	Vibrate URL.
Alert accept on values
accept-call = { on-accept-key \| on-any-key \| after-delay }
#define	ALP_ATTN_VALUE_ACCEPT_AFTER_DELAY "after-delay"
	Perform accept action after accept delay.
#define	ALP_ATTN_VALUE_ACCEPT_ON_ACCEPT_KEY "on-accept-key"
	Perform accept action on 'Accept' key press.
#define	ALP_ATTN_VALUE_ACCEPT_ON_ANY_KEY "on-any-key"
	Perform accept action on any key press.
Action verb definitions
#define	ALP_ATTN_VALUE_ADVERB_CLEAR "-clear"
	Clear adverb.
#define	ALP_ATTN_VALUE_VERB_ACCEPT "accept"
	Indirect accept action verb.
#define	ALP_ATTN_VALUE_VERB_CLEAR "clear"
	Indirect clear action verb.
#define	ALP_ATTN_VALUE_VERB_CONNECT "connect"
	Connect action verb connect to a callback channel and send args.
#define	ALP_ATTN_VALUE_VERB_DEF_CONNECT "def-connect"
	Default connect action verb.
#define	ALP_ATTN_VALUE_VERB_DELETE "delete"
	Delete action verb delete alert.
#define	ALP_ATTN_VALUE_VERB_DISMISS "dismiss"
	Dismiss alert action verb.
#define	ALP_ATTN_VALUE_VERB_DISPLAY "display"
	Display action verb.
#define	ALP_ATTN_VALUE_VERB_EXCHANGE "exchange"
	Exchange action verb.
#define	ALP_ATTN_VALUE_VERB_GOTO "goto"
	Indirect goto action verb.
#define	ALP_ATTN_VALUE_VERB_LAUNCH "launch"
	Launch action verb.
#define	ALP_ATTN_VALUE_VERB_OKAY "okay"
	Indirect okay action verb.
#define	ALP_ATTN_VALUE_VERB_REJECT "reject"
	Indirect reject action verb.
#define	ALP_ATTN_VALUE_VERB_SET "set"
	Set properties.
#define	ALP_ATTN_VALUE_VERB_SNOOZE "snooze"
	Snooze action verb.
Deprecated Values
These value definitions have been deprecated and should not be used in newly-written code.
#define	ALP_ATTN_VALUE_DEST_DIALOG "dialog"
#define	ALP_ATTN_VALUE_DEST_LIST "list"
#define	ALP_ATTN_VALUE_STOCK_VIBRATE_DEF "alp-stock-default"
#define	ALP_ATTN_VALUE_STOCK_VIBRATE_OFF "alp-stock-off"
Alert dialog window type definitions
#define	ALP_ATTN_VALUE_DIALOG_TYPE_DEFAULT "default"
	Default window type.
#define	ALP_ATTN_VALUE_DIALOG_TYPE_DIALOG "dialog"
	Dialog window type.
#define	ALP_ATTN_VALUE_DIALOG_TYPE_FULL "full"
	Normal window type.
#define	ALP_ATTN_VALUE_DIALOG_TYPE_FULLSCREEN "fullscreen"
	Normal window type Dialog window fills the entire screen including the status bar and window decoration is disabled.
#define	ALP_ATTN_VALUE_DIALOG_TYPE_NORMAL "normal"
	Normal window type.
Alert effect values
#define	ALP_ATTN_VALUE_EFFECT_CUSTOM_1 "custom-1"
#define	ALP_ATTN_VALUE_EFFECT_CUSTOM_2 "custom-2"
#define	ALP_ATTN_VALUE_EFFECT_CUSTOM_3 "custom-3"
#define	ALP_ATTN_VALUE_EFFECT_CUSTOM_4 "custom-4"
#define	ALP_ATTN_VALUE_EFFECT_KBD_BACKLIGHT "kbd-backlight"
#define	ALP_ATTN_VALUE_EFFECT_LED "led"
#define	ALP_ATTN_VALUE_EFFECT_SOUND "sound"
#define	ALP_ATTN_VALUE_EFFECT_VIBRATE "vibrate"
Alert effect sequence types (builtin)
#define	ALP_ATTN_VALUE_EFFECT_SEQ_DEFAULT "default"
	Default effect sequence.
#define	ALP_ATTN_VALUE_EFFECT_SEQ_SILENT "silent"
	Silent effect sequence.
#define	ALP_ATTN_VALUE_EFFECT_SEQ_SOUND "sound"
	Sound effect sequence.
#define	ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE "vibrate"
	Vibrate effect sequence.
#define	ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_AND_SOUND "vibrate-and-sound"
	Silent effect sequence.
#define	ALP_ATTN_VALUE_EFFECT_SEQ_VIBRATE_THEN_SOUND "vibrate-then-sound"
	Silent effect sequence.
Alert display facility values
#define	ALP_ATTN_VALUE_FACILITY_DIALOG "dialog"
	Alert Dialog.
#define	ALP_ATTN_VALUE_FACILITY_LIST "list"
	Alert List.
#define	ALP_ATTN_VALUE_FACILITY_MODAL_DIALOG "modal-dialog"
	Alert Modal Dialog.
Alert level values
See also: ALP_ATTN_PROP_LEVEL
#define	ALP_ATTN_VALUE_LEVEL_CRITICAL "critical"
	Critical alert priority level.
#define	ALP_ATTN_VALUE_LEVEL_DEFAULT ""
#define	ALP_ATTN_VALUE_LEVEL_IMPORTANT "important"
	Important alert priority level.
#define	ALP_ATTN_VALUE_LEVEL_INFO "info"
	Info alert priority level.
#define	ALP_ATTN_VALUE_LEVEL_NOTICE "notice"
	Notice alert priority level.
Alert power wake state values
See also: ALP_ATTN_PROP_POWER_WAKE_STATE
#define	ALP_ATTN_VALUE_POWER_WAKE_FULL "full"
	Fully wake device.
#define	ALP_ATTN_VALUE_POWER_WAKE_SEMI "semi"
	Partially wake device.
Alert sound volume ramp properties values
#define	ALP_ATTN_VALUE_SOUND_RAMP_ASP "asp"
	Use the Acoustic Shock Protection ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_CUSTOM "custom"
	Use custom ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_DEFAULT "default"
	Use default ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_ESCALATING "escalating"
	Use standard "escalating" volume ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_NONE "none"
	No volume ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_QUICK "quick"
	Use quick "escalating" volume ramp profile.
#define	ALP_ATTN_VALUE_SOUND_RAMP_RINGTONE_ESCALATING "ringtone-escalating"
	Use ring tone specific "escalating" volume ramp profile.
Alert sound type values
These are predefined sound types are strings contants that as supported by the Media Session framework (see ALP_MM_SESSION_AUDIO_APP_TYPE). That framework may support additional sound type
#define	ALP_ATTN_VALUE_SOUND_TYPE_ALARM "alarm"
	Alarm alert sound type.
#define	ALP_ATTN_VALUE_SOUND_TYPE_ALERT "alerts"
	Generic alert sound type.
#define	ALP_ATTN_VALUE_SOUND_TYPE_MESSAGE "message"
	Message alert sound type.
#define	ALP_ATTN_VALUE_SOUND_TYPE_PHONE_CALL "phone_call"
	Phone Call alert sound type.
#define	ALP_ATTN_VALUE_SOUND_TYPE_POWER "power_sound"
	Power alert sound type.
#define	ALP_ATTN_VALUE_SOUND_TYPE_SYSTEM "system_sounds"
	System alert sound type.
Alert vibrate type values
Vibrate types are used to arbitrate which vibrate pattern takes precedence.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_ALARM "alarm"
	Alarm vibrate type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_ALERT "etc"
	Alert vibrate type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_MESSAGE "message"
	Message vibrate type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_PHONE_CALL "incoming"
	Phone call vibrate type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_SYSTEM "system"
	System vibrate type.
Defines
#define	ALP_ATTN_VALUE_SOUND_CONTINUOUS "continuous"
	Play sound resouce continuously.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_CONNECT "connect"
	Connect alert type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_DISCONNECT "disconnect"
	Disconnect alert type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_POPUP "popup"
	Popup alert type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_OFF "power_off"
	Power off alert type.
#define	ALP_ATTN_VALUE_VIBRATE_TYPE_POWER_ON "power_on"
	Power on alert type.

Attention Properties [Attention Manager]

Detailed Description

Telephony specific action properties

Generic alert action properties

Basic Alert properties

Deprecated Properties

Sound properties

Alert Dialog Window properties

Alert Dialog properties

Alert handling properties

Alert event time properties

Alert Nagging properties and value

Vibrate properties

Alert accept on values

Action verb definitions

Deprecated Values

Alert dialog window type definitions

Alert effect values

Alert effect sequence types (builtin)

Alert display facility values

Alert level values

Alert power wake state values

Alert sound volume ramp properties values

Alert sound type values

Alert vibrate type values

Defines

Define Documentation

Attention Properties
[Attention Manager]