AlertType Class
The AlertType class defines the alert type. Derive from this class to create alerts for new types.
System.Object
Microsoft.SharePoint.Portal.Alerts.Extension
Microsoft.SharePoint.Portal.Alerts.AlertType
Public Constructors
The following table shows the constructors of the AlertType class and a brief description of each.
| Name | Description |
|---|---|
| AlertType | Initializes a new instance of the AlertType class. This constructor is protected. |
Public Methods
The following table shows the public methods of the AlertType class and a brief description of each.
| Name | Description |
|---|---|
| CreateEditAlertPage(Microsoft.SharePoint.Portal.Alerts.Alert) | Override to get an AlertEditPage object that is used to edit alerts of this type on the Edit Alert page in the user interface (UI). |
| CreateNewAlertPage(Microsoft.SharePoint.Portal.Alerts.NewAlertObjectInfo) | Override to get an AlertEditPage object that is used to create alerts of this type on the Create New Alert page in the UI. |
| GetNewAlertActionInfo(System.Data.DataRow, Microsoft.SharePoint.Portal.Alerts.NewAlertObjectInfo, Microsoft.SharePoint.Portal.Alerts.NewAlertActionInfo) | Override to provide "Alert Me" link in search and alert results for your alert type. |
| IsMyType(System.Data.DataRow) | Override to get a flag that indicates whether the specified DataRow is described by your derived alert type. |
Protected Methods
The following table shows the methods of the AlertType class and a brief description of each.
| Name | Description |
|---|---|
| GetAlertCreationLink(System.Web.UI.Page, String, String, String, String, String, String, String) | Creates an "Alert Me" link by using the specified parameters. The current HTTP context is used to identify the portal site. |
| GetAlertCreationLink(String, String, String, String, String, String, String) | Creates an "Alert Me" link by using the specified parameters. |
| GetAlertCreationLink(Microsoft.SharePoint.Portal.PortalContext, String, String, String, String, String, String, String) | Creates an "Alert Me" link by using the specified parameters. A reference to a PortalContext object is used to identify the current portal site. |
| PrepareAlertTitle(System.String) | Creates a suggested alert title by using the object display name. |
Public Properties
The following table shows the properties of the AlertType class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| AlertGroupDisplayName | String | Gets the display name for the group in which this alert type is displayed in the My Alerts Summary page. |
| AlertGroupSortKey | String | Gets the group in which this alert type is displayed in the My Alerts Summary page. |
| AlertViewDescription | String | Gets description text for actions for this alert type that are displayed in the UI. |
| ExtensionId | String | Gets the unique identifier for this alert extension. For most alert type implementation, the extension identifier is set to the type identifier. |
| ObjectContentClasses | String | Gets the alert implementation for a search or alerts result. Indicates which objects are described by your derived alert type. |
| OpenObjectText | String | Gets the link text that is displayed in the UI for alerts of this type. |
| RankingEnabled | Boolean | Gets a flag that indicates whether ranking is enabled for the query that defines alerts of this type. |
| SingleItemAlert | Boolean | Gets a flag that indicates whether this alert type represents a single item. |
| TypeDisplayName | String | Gets the display name for this alert type. |
| TypeId | String | Gets the identifier for this alert type. |
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.
Remarks
Derive from this class to create new alert types. Alert types available in Microsoft Office SharePoint Portal Server 2003 are in the Microsoft.SharePoint.Portal.Alerts.Types namespace.
Requirements
Namespace: Microsoft.SharePoint.Portal.Alerts
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security