IAccAlert Interface Reference
Inherited by
IAccCallAlert.
Detailed Description
The
IAccAlert encapsulates an AIM alert.
Public Types
- enum AccAlertType {
AccAlertType_Mail = 0,
AccAlertType_Ygp = 1,
AccAlertType_Rendered = 2
}
- enum AccAlertProp {
AccAlertProp_Uuid,
AccAlertProp_Cookie,
AccAlertProp_Timestamp,
AccAlertProp_GotMail = 1000,
AccAlertProp_NumMails,
AccAlertProp_NumVoicemails,
AccAlertProp_Address,
AccAlertProp_ReadUrl,
AccAlertProp_GotPics = 1100,
AccAlertProp_Description = 1200,
AccAlertProp_Content,
AccAlertProp_ImageUrl,
AccAlertProp_MoreInfoUrl,
AccAlertProp_Duplicate,
AccAlertProp_DisplayTime,
AccAlertProp_Duration,
AccAlertProp_NotifyPrefs
}
- typedef enum
IAccAlert::AccAlertType AccAlertType
- typedef enum
IAccAlert::AccAlertProp AccAlertProp
Public Member Functions
Member Typedef Documentation
Values for the Type property.
Properties for the Property method.
Member Enumeration Documentation
Values for the Type property.
- Enumerator:
-
| AccAlertType_Mail |
|
| AccAlertType_Ygp |
|
| AccAlertType_Rendered |
|
Properties for the Property method.
- Enumerator:
-
| AccAlertProp_Uuid |
UUID (type) of the alert [get] xp_str* |
| AccAlertProp_Cookie |
Unique ID for this particular alert [get] xp_str* |
| AccAlertProp_Timestamp |
Time the alert was sent [get] xp_date* |
| AccAlertProp_GotMail |
Is there new mail for this user? [get] xp_bool* |
| AccAlertProp_NumMails |
Number of new emails in the user's inbox [get] xp_s32* |
| AccAlertProp_NumVoicemails |
Number of new voicemails in the user's inbox [get] xp_s32* |
| AccAlertProp_Address |
Email address this alert is in reference to [get] xp_str* |
| AccAlertProp_ReadUrl |
URL to be used for reading mail [get] xp_str* |
| AccAlertProp_GotPics |
Checks if there are new pictures for the user [get] xp_bool* |
| AccAlertProp_Description |
Description of this "rendered" alert [get] xp_str* |
| AccAlertProp_Content |
The content for this "rendered" alert [get] xp_str* |
| AccAlertProp_ImageUrl |
The URL for displaying an image for a specific alert [get] xp_str* |
| AccAlertProp_MoreInfoUrl |
The URL for more info on a specific alert [get] xp_str* |
| AccAlertProp_Duplicate |
Checks if this is a duplicate alert [get] xp_bool* |
| AccAlertProp_DisplayTime |
Time when this alert should be displayed [get] xp_s32* |
| AccAlertProp_Duration |
Duration to display this alert for [get] xp_s32* |
| AccAlertProp_NotifyPrefs |
Indicates how this alert should be displayed [get] xp_u32* |
Member Function Documentation
| HRESULT IAccAlert::Type |
( |
[out, retval] AccAlertType * |
type |
) |
[get] |
| HRESULT IAccAlert::Property |
( |
[in] xp_int |
property, |
|
|
[out, retval] xp_variant * |
value | |
|
) |
| | [get] |
Get a specific property of the alert. Properties are from AccAlertProp; which properties are valid depends on the value of Type().