Alert Class |
A user alert object for alerts managed in the xot_alerts table.
Inheritance HierarchyNamespace: NetQuarry.Services
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe Alert type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Alert(IAppContext) |
Standard constructor.
|
| Alert(IAppContext, String, String, AlertAttrs) |
Standard constructor for creating an alert for use in a page message.
|
Properties| Name | Description | |
|---|---|---|
 | Attributes |
Gets/sets the AlertAttrs for this alert.
This corresponds to the xot_alerts.attr_bits column.
|
| AutoCloseSeconds |
The number of seconds the message should be displayed before being closed automatically.
Set to zero if no auto-close is desired.
Set to -1 to use the alert service default if one is specified.
|
| Created |
The UTC date/time the alert was created.
|
| CssClass |
The CSS class to be added to the top level HTML presentation element for the message.
|
| DeliveryType |
The delivery method for the message.
|
| ID |
Gets the ID of this alert. This corresponds to the xot_alerts.alert_pkid IDENTITY column
and is currently populated only if a new alert is created via Save or an existing
alert is loaded using LoadFirst(String, String).
|
| LinkText |
The text caption for the LinkURL. If no such caption is provided a generic caption will be provided.
|
| Priority |
Gets/sets the alert's priority.
Note that a higher number causes the alert to be delivered before alerts with a lower priority.
A priority of zero is the default and is considered neutral.
|
Methods| Name | Description | |
|---|---|---|
 | Construct(IAppContext, DateTime, String, String, NameValueCollection, String) |
Creates an alert object from the supplied parameters
|
| Construct(IAppContext, DateTime, String, String, String, String) |
Creates an alert object from the supplied parameters
|
| Create |
Sends an alert internally. The value returned is the unique ID for this alert.
|
| Delete |
Delete this alert. Requires that ID is known.
|
| Delete(IAppContext, Int32) |
Deletes a single alert
|
| DeleteRelated |
Deletes all alerts related to the key
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| LoadFirst |
Loads the first deliverable alert matching ths specified filter.
Alerts that have a future delivery date or a past expiration date are NOT considered deliverable.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Save |
Save (insert or update as appropriate) this alert to the xot_alerts table.
|
| ToJson |
Convert the alert into a JSON object suitable for use in the EAP.DeliverMsg() javascript method.
Note that this is a non-standard serialization which includes custom alert object logic.
|
| ToString | (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | Body |
Gets/Sets the body of the alert
|
| DeliveryDateUTC |
Gets/Sets the delivery time. If null, the alert is delivered immediately.
|
| ExpireDateUTC |
Gets/Sets the expiration date. If null, the alert will not expire.
|
| LinkURL |
Gets/Sets the URL (typically handler.ashx?req=nav&mop=[MOP]&pk=[pk]).
See LinkText.
|
| MOP |
Gets/Sets the MOP (if this is set along with the PrimaryKey, the LinkURL is automatically constructed.)
|
| PrimaryKey |
Gets/Sets the PrimaryKey value (used in the LinkURL)
|
| RelatedID |
Gets/Sets the RelatedID (string, int, Guid).
|
| RelatedType |
Gets/Sets the type of the RelatedID as it should be stored in the database.
|
| Subject |
Gets/Sets the subject of the alert.
|
| UserID |
Gets/Sets the UserID who will receive the alert.
|
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also