SPAlertCollection.Add - Méthode (SPListItem, SPEventType, SPAlertFrequency, SPAlertDeliveryChannels)

Ajoute une alerte pour un élément de liste à la collection.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function Add ( _
    item As SPListItem, _
    eventType As SPEventType, _
    alertFrequency As SPAlertFrequency, _
    deliveryChannels As SPAlertDeliveryChannels _
) As Guid
'Utilisation
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
)

Paramètres

• item
  Type : Microsoft.SharePoint.SPListItem

  Un objet Microsoft.SharePoint.SPListItem qui représente l'élément auquel l'alerte s'applique.

• eventType
  Type : Microsoft.SharePoint.SPEventType

  Une valeur Microsoft.SharePoint.SPEventType qui spécifie le type d'événement de l'alerte.

• alertFrequency
  Type : Microsoft.SharePoint.SPAlertFrequency

  Une valeur Microsoft.SharePoint.SPAlertFrequency qui spécifie la fréquence d'envoi d'une alerte.

• deliveryChannels
  Type : Microsoft.SharePoint.SPAlertDeliveryChannels

  Valeur qui spécifie si l'alerte est remis en tant que courrier électronique ou un message de Service SMS (Short Message).

Valeur renvoyée

Type : System.Guid
L'ID de l'alerte.

Remarques

Utilisation de la méthode Add envoie un message de confirmation à chaque utilisateur les informant qu'ils ont ajoutés avec succès une alerte.

L'exemple de code suivant crée une alerte pour chaque utilisateur d'un site. Cette alerte avertit immédiatement chaque fois qu'un utilisateur présente un fichier spécifié dans la bibliothèque Documents partagés.

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);
}

Voir aussi

Référence

SPAlertCollection classe

SPAlertCollection - Membres

Add - Surcharge

Microsoft.SharePoint - Espace de noms