Alert Class
The Alert class provides an entry point for modifying data for a single alert.
System.Object
Microsoft.SharePoint.Portal.Alerts.Alert
Public Methods
The following table shows the methods of the Alert class and a brief description of each.
| Name | Description |
|---|---|
| Activate | Activates this alert. |
| Commit | Commits changes to this alert to the database. |
| Deactivate | Deactivates this alert. |
| Delete | Deletes this alert. The resulting object is a disposed object that should not be used. |
| DeleteResults(Microsoft.SharePoint.Portal.Alerts.Result[]) | Deletes the results in the specified array. |
| DeleteResults(System.DateTime) | Deletes results that were created before the specified date and time. |
| DeleteResults | Deletes all the results for this alert. |
| GetResults | Gets a DataSet object that contains the current set of results. |
Public Properties
The following table shows the properties of the Alert class, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| Active | Boolean | Gets a flag that indicates whether this alert is active. |
| ApplicationData | String | Gets or sets persisted data about this alert. |
| Catalogs | System.Collections.Specialized.StringCollection | Gets the list of search catalogs that an alert should be active on. An empty list means that the alert is active on all catalogs. |
| ConditionText | String | Gets or sets the description of conditions that cause this alert to be sent. |
| DeliveryChannels | Microsoft.SharePoint.Portal.Alerts.AlertDeliveryChannelCollection | Gets the collection of delivery channels that are available for this alert. |
| DeliveryText | String | Gets the string that describes the delivery options selected for this alert. |
| Expensive | Boolean | Gets a flag that indicates whether this alert requires intensive computation. Alerts that require excessive resources to process are disabled. |
| ID | Int32 | Gets the unique identifier for this alert. |
| Name | String | Gets the name of this alert. |
| ObjectDisplayName | String | Gets or sets the display name of the object for which this alert was created. |
| ObjectID | String | Gets or sets the unique identifier for the object that this alert describes. |
| ObjectUrl | String | Gets or sets the URL for the object that this alert describes. Setting this property does not affect alert execution. |
| Owner | System.Guid | Gets the GUID for the owner of this alert. |
| Query | String | Gets or sets the SQL query that defines this alert. Use the alert template to define query attributes for your alert. |
| QueryLocale | Int32 | Gets or sets the locale identifier of the server where the query for this alert is executed. |
| RankingEnabled | Boolean | Gets a flag that indicates whether ranking is enabled for the query that defines this alert. |
| Type | Microsoft.SharePoint.Portal.Alerts.AlertType | Gets the type of this alert. |
| UrlRenderingPortalZone | Microsoft.SharePoint.Portal.Topology.PortalZone | Gets or sets a reference to a PortalZone object that specifies the portal zone that indicates how links are rendered in notification messages. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Requirements
Namespace: Microsoft.SharePoint.Portal.Alerts
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security