SPAlert Members

Include Protected Members
Include Inherited 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.

Properties

	Name	Description
	AlertFrequency	Gets or sets the time interval for sending the alert.
	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.
	AlertTemplateName	Gets the name of the alert template.
	AlertTime	Gets or sets the date and time for sending the alert.
	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.
	AlwaysNotify	Gets or sets a value that indicates whether a daily or weekly alert is always sent, even if there is no matching event.
	DeliveryChannels	Gets or sets a value that indicates the delivery method of the alert.
	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.
	EventType	Gets or sets the type of event to which the alert applies.
	EventTypeBitmask	Gets or sets the type of event to which the alert applies as a bitmask.
	Filter	Gets or sets the query in Collaborative Application Markup Language (CAML) for a filter to apply to the alert.
	ID	Gets the ID of the alert.
	Item	Gets or sets the list item or document to which the alert applies.
	ItemID	Gets the integer that identifies the list item or document to which an alert applies in the parent collection of list items.
	List	Gets or sets the list or document library to which the alert applies.
	ListID	Gets or sets the GUID of the list or document library to which the alert applies.
	ListUrl	Gets the site-relative URL of the list to which the alert applies.
	MatchId	Gets or sets the pre-filtering GUID for an externally matched alert.
	Properties	Gets the properties of the alert.
	Status	Gets or sets the status of the alert.
	Title	Gets or sets the title of the alert as displayed in the user interface.
	User	Gets or sets a user object representing the user who created the alert.
	UserId	Gets or sets the ID of the user who created the alert.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)
	Update()	Updates the SharePoint database with changes made to the alert.
	Update(Boolean)	Updates the SharePoint database with changes made to the alert and optionally sends a confirmation e-mail message.

Top

See Also

Reference

SPAlert Class

Microsoft.SharePoint Namespace