向集合中添加一个警报的列表。
命名空间: Microsoft.SharePoint
程序集: Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)
语法
声明
Public Function Add ( _
list As SPList, _
eventType As SPEventType, _
alertFrequency As SPAlertFrequency, _
deliveryChannels As SPAlertDeliveryChannels _
) As Guid
用法
Dim instance As SPAlertCollection
Dim list As SPList
Dim eventType As SPEventType
Dim alertFrequency As SPAlertFrequency
Dim deliveryChannels As SPAlertDeliveryChannels
Dim returnValue As Guid
returnValue = instance.Add(list, eventType, _
alertFrequency, deliveryChannels)
public Guid Add(
SPList list,
SPEventType eventType,
SPAlertFrequency alertFrequency,
SPAlertDeliveryChannels deliveryChannels
)
参数
list
类型:Microsoft.SharePoint.SPListMicrosoft.SharePoint.SPList对象,该对象代表警报所应用到的列表。
eventType
类型:Microsoft.SharePoint.SPEventType一个Microsoft.SharePoint.SPEventType值,指定为该警报的事件类型。
alertFrequency
类型:Microsoft.SharePoint.SPAlertFrequency一个Microsoft.SharePoint.SPAlertFrequency值,指定发送通知的频率。
deliveryChannels
类型:Microsoft.SharePoint.SPAlertDeliveryChannels一个值,指定是否为电子邮件或短消息服务 (SMS) 消息发送警报。
返回值
类型:System.Guid
警报 ID。
备注
使用Add方法将确认通知发送到每个用户,告诉他们他们成功添加警报。
修改通知列表时,下面的代码示例创建 SharePoint 网站的每个用户的每日通知。
Dim web As SPWeb = SPControl.GetContextWeb(Context)
Dim users As SPUserCollection = web.Users
Dim list As SPList = web.Lists("Announcements")
Dim user As SPUser
For Each user In users
user.Alerts.Add(list, Microsoft.SharePoint.SPEventType.Modify,
Microsoft.SharePoint.SPAlertFrequency.Daily, Microsoft.SharePoint.SPAlertDeliveryChannels.Email)
Next user
SPWeb oWebsite = SPContext.Current.Web;
SPUserCollection collUsers = oWebsite.Users;
SPList oList = oWebsite.Lists["Announcements"];
foreach (SPUser oUser in collUsers)
{
oUser.Alerts.Add(oList, Microsoft.SharePoint.SPEventType.Modify,
Microsoft.SharePoint.SPAlertFrequency.Daily, Microsoft.SharePoint.SPAlertDeliveryChannels.Email);
}