SPAlert Class
Collapse the table of content
Expand the table of content
The document is archived and information here might be outdated

SPAlert Class

Windows SharePoint Services 3

Represents an alert, which generates periodic e-mail notifications sent to a user about the list, list item, document, or document library to which the alert applies. SPAlert provides information about the alert, such as which alert template is used, the alert frequency, and the UserID of the user who created the alert.


Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPAlert

Use the Alerts property of either the SPUser or SPWeb class to return an SPAlertCollection object that represents the collection of alerts for the user or Web site. Use an indexer to return a single alert from the collection. For example, if the collection is assigned to a variable named collAlerts, use collAlerts[index] in C#, or collAlerts(index) in Visual Basic, where index is either the index number of the alert in the collection or the display name of the alert.


Use the Update method after making any changes to the alert.

This code example uses the SPAlert class to iterate through all the alerts for every user of a site and update the alert frequency.

SPWeb oWebsite = SPContext.Current.Web;
SPUserCollection collUsers = oWebsite.Users;

    foreach (SPUser oUser in collUsers)
        SPAlertCollection collAlerts = oUser.Alerts;

         foreach (SPAlert oAlert in collAlerts)
             oAlert.AlertFrequency =  


Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Best Practices: Using Disposable Windows SharePoint Services Objects.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2016 Microsoft