include/hiker/attnmgr_properties.h File Reference


Detailed Description

Contains the property definitions for the ALP Attention Manager.

Go to the source code of this file.

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.


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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.