SPAlertCollection.Add 方法 (SPListItem, SPEventType, SPAlertFrequency, SPAlertDeliveryChannels)

向集合中添加一个列表项的通知。

命名空间：  Microsoft.SharePoint
程序集：  Microsoft.SharePoint（位于 Microsoft.SharePoint.dll 中）

语法

声明
Public Function Add ( _
    item As SPListItem, _
    eventType As SPEventType, _
    alertFrequency As SPAlertFrequency, _
    deliveryChannels As SPAlertDeliveryChannels _
) As Guid
用法
Dim instance As SPAlertCollection
Dim item As SPListItem
Dim eventType As SPEventType
Dim alertFrequency As SPAlertFrequency
Dim deliveryChannels As SPAlertDeliveryChannels
Dim returnValue As Guid

returnValue = instance.Add(item, eventType, _
    alertFrequency, deliveryChannels)

public Guid Add(
    SPListItem item,
    SPEventType eventType,
    SPAlertFrequency alertFrequency,
    SPAlertDeliveryChannels deliveryChannels
)

参数

• item
  类型：Microsoft.SharePoint.SPListItem

  Microsoft.SharePoint.SPListItem对象，该对象表示警报所应用到的项。

• eventType
  类型：Microsoft.SharePoint.SPEventType

  一个Microsoft.SharePoint.SPEventType值，指定为该警报的事件类型。

• alertFrequency
  类型：Microsoft.SharePoint.SPAlertFrequency

  一个Microsoft.SharePoint.SPAlertFrequency值，指定发送通知的频率。

• deliveryChannels
  类型：Microsoft.SharePoint.SPAlertDeliveryChannels

  一个值，指定是否为电子邮件或短消息服务 (SMS) 消息发送警报。

返回值

类型：System.Guid
警报 ID。

备注

使用Add方法给每个用户，告诉他们他们成功添加警报发送的确认消息。

下面的代码示例创建一个站点的每个用户的通知。此警报立即通知其用户讨论共享文档的文档库中的指定的文件时。

Dim web As SPWeb = SPControl.GetContextWeb(Context)
Dim list As SPList = web.Lists("Shared Documents")
Dim item As SPListItem = list.Items(1)
Dim users As SPUserCollection = web.Users
Dim user As SPUser

For Each user In  users

    user.Alerts.Add(item, Microsoft.SharePoint.SPEventType.Discussion, 
        Microsoft.SharePoint.SPAlertFrequency.Immediate, Microsoft.SharePoint.SPAlertDeliveryChannels.Email)

Next user 

SPWeb oWebsite = SPContext.Current.Web;
SPList oList = oWebsite.Lists["Shared Documents"];
SPListItem oItem = oList.Items[1];
SPUserCollection collUsers = oWebsite.Users;
foreach (SPUser oUser in collUsers)
{
   oUser.Alerts.Add(oItem, Microsoft.SharePoint.SPEventType.Discussion, 
      Microsoft.SharePoint.SPAlertFrequency.Immediate, Microsoft.SharePoint.SPAlertDeliveryChannels.Email);
}

另请参阅

引用

SPAlertCollection 类

SPAlertCollection 成员

Add 重载

Microsoft.SharePoint 命名空间