SPAlertCollection.Add method (SPListItem, SPEventType, SPAlertFrequency, SPAlertDeliveryChannels)

將警示的清單項目加入至集合。

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'宣告
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
  Type: Microsoft.SharePoint.SPListItem

  Microsoft.SharePoint.SPListItem物件，表示此警示所套用的項目。

• eventType
  Type: Microsoft.SharePoint.SPEventType

  Microsoft.SharePoint.SPEventType值，這個值指定警示的事件類型。

• alertFrequency
  Type: Microsoft.SharePoint.SPAlertFrequency

  Microsoft.SharePoint.SPAlertFrequency值，指定傳送警示的頻率。

• deliveryChannels
  Type: Microsoft.SharePoint.SPAlertDeliveryChannels

  指定是否要在作為電子郵件或短訊息服務 (SMS) 訊息，傳遞警示的值。

傳回值

Type: System.Guid
警示的識別碼。

備註

使用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 class

SPAlertCollection members

Add overload

Microsoft.SharePoint namespace