Export (0) Print
Expand All

SPAlert members

Represents an alert, which generates periodic e-mail or Short Message Service (SMS) notifications sent to a user about the list, list item, document, or document library to which the alert applies.

The SPAlert type exposes the following members.

  Name Description
Public property AlertFrequency Gets or sets the time interval for sending the alert.
Public property AlertTemplate Gets or sets the alert template which defines the content and format of an alert message and, in the case of an e-mail version of the alert, also defines the style and rendering.
Public property AlertTemplateName Gets the name of the alert template.
Public property AlertTime Gets or sets the date and time for sending the alert.
Public property AlertType Gets or sets the type of object to which the alert applies, which can be a list or document library, a list item or document, or a custom object.
Public property AlwaysNotify Gets or sets a value that indicates whether a daily or weekly alert is always sent, even if there is no matching event.
Public property DeliveryChannels Gets or sets a value that indicates the delivery method of the alert.
Public property DynamicRecipient Gets or sets the string in Collaborative Application Markup Language (CAML) that defines the event data to used to populate the e-mail recipient field in the alert.
Public property EventType Gets or sets the type of event to which the alert applies.
Public property EventTypeBitmask Gets or sets the type of event to which the alert applies as a bitmask.
Public property Filter Gets or sets the query in Collaborative Application Markup Language (CAML) for a filter to apply to the alert.
Public property ID Gets the ID of the alert.
Public property Item Gets or sets the list item or document to which the alert applies.
Public property ItemID Gets the integer that identifies the list item or document to which an alert applies in the parent collection of list items.
Public property List Gets or sets the list or document library to which the alert applies.
Public property ListID Gets or sets the GUID of the list or document library to which the alert applies.
Public property ListUrl Gets the site-relative URL of the list to which the alert applies.
Public property MatchId Gets or sets the pre-filtering GUID for an externally matched alert.
Public property Properties Gets the properties of the alert.
Public property Status Gets or sets the status of the alert.
Public property Title Gets or sets the title of the alert as displayed in the user interface.
Public property User Gets or sets a user object representing the user who created the alert.
Public property UserId Gets or sets the ID of the user who created the alert.
Top

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method Update() Updates the SharePoint database with changes made to the alert.
Public method Update(Boolean) Updates the SharePoint database with changes made to the alert and optionally sends a confirmation e-mail message.
Top
Show:
© 2014 Microsoft