PersonAlertTemplate Class
The PersonAlertTemplate class represents the template for creating new alerts for a person in Microsoft SharePoint Portal Server.
System.Object
Microsoft.SharePoint.Portal.Alerts.StandardAlertTemplate
Microsoft.SharePoint.Portal.Alerts.PersonAlertTemplate
Public Constructors
The following table shows the constructors of the PersonAlertTemplate class and a brief description of each.
| Name | Description |
|---|---|
| PersonAlertTemplate(Microsoft.SharePoint.Portal.Alerts.Alert) | Initializes a new instance of the PersonAlertTemplate class with the specified reference to an Alert object that represents an existing alert. |
| PersonAlertTemplate(Microsoft.SharePoint.Portal.People.UserProfile) | Initializes a new instance of the PersonAlertTemplate class with the specified reference to a UserProfile object that represents a person in SharePoint Portal Server. |
| PersonAlertTemplate(System.Guid, Microsoft.SharePoint.Portal.PortalContext) | Initializes a new instance of the PersonAlertTemplate class with the specified GUID and a reference to a PortalContent object. |
Protected Methods
The following table shows the methods of the PersonAlertTemplate class and a brief description of each.
| Name | Description |
|---|---|
| UpdateApplicationData | Generates information needed to populate fields in this template and saves it to the database. |
| CreateQuery | Reserved for internal use only. |
| GetAlertType | Reserved for internal use only. |
Public Properties
The following table shows the public properties of the PersonAlertTemplate class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| ConditionText | String | Gets a user-friendly description of the query that describes alerts created with this template. |
| DocActionRestriction | Microsoft.SharePoint.Portal.Alerts.ActionRestriction | Gets or sets the document action restriction for action filtering. It allows the user to easily define desired changes. |
| MatchOnPersonalSiteChanges | Boolean | Gets or sets a flag that indicates whether to notify a person about changes on a person's My Site. |
| MatchOnPersonDocuments | Boolean | Gets or sets a flag that indicates whether an Alert notification is sent when acting with person's documents |
| MatchOnProfileChanges | Boolean | Gets or sets a flag that indicates whether this alert includes changes to a user's profile. |
Protected Properties
The following table shows the protected properties of the PersonAlertTemplate class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| LcidModifyItemCondition | Microsoft.SharePoint.Portal.WebControls.LocStringId | Reserved for internal use only. |
| LcidNewItemCondition | Microsoft.SharePoint.Portal.WebControls.LocStringId | Reserved for internal use only. |
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.
Remarks
Use this object to create new alerts for a person in SharePoint Portal Server.
Requirements
Namespace: Microsoft.SharePoint.Portal.Alerts
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security