DocumentAlertType Class

The DocumentAlertType class represents an alert for a document.

System.Object

Microsoft.SharePoint.Portal.Alerts.AlertType

  **Microsoft.SharePoint.Portal.Alerts.DocumentAlertType**

Public Constructors

The following table shows the constructors of the DocumentAlertType class and a brief description of each.

Name Description
DocumentAlertType Initializes a new instance of the DocumentAlertType class.

Public Fields

The following table shows the fields of the DocumentAlertType class and a brief description of each.

Name Description
DocumentAlertTypeId Contains the type of this alert.

Public Methods

The following table shows the public methods of the DocumentAlertType class and a brief description of each.

Name Description
CreateEditAlertPage(Microsoft.SharePoint.Portal.Alerts.Alert) Gets an AlertEditPage object that is used to edit document alerts on the edit alert page in the user interface (UI).
CreateNewAlertPage(Microsoft.SharePoint.Portal.Alerts.NewAlertObjectInfo) Gets an AlertEditPage object that is used to create alerts of this type on the create new alert page in the user interface (UI).
GetAlertCreationLink(String, String) Creates an "Alert Me" link by using the specified parameters.
GetAlertCreationLink(String, String, String) Creates an "Alert Me" link by using the specified parameters.

Protected Methods

The following table shows the protected methods of the DocumentAlertType class and a brief description of each.

Name Description
PrepareAlertTitle(String) Creates a suggested alert title by using the document display name.

Public Properties

The following table shows the properties of the DocumentAlertType 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.
ObjectContentClass String Gets the alert implementation for a search or alerts result.
OpenObjectText String
SingleItemAlert Boolean Gets a flag that indicates whether this alert type represents a single item.
TypeDisplayName String
TypeId String Gets the value of the DocumentAlertTypeId constant, which indicates the type for this alert.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any 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