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

Ajoute une alerte pour une liste à la collection.

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

Syntaxe

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

Paramètres

• list
  Type : Microsoft.SharePoint.SPList

  Un objet Microsoft.SharePoint.SPList qui représente la liste à laquelle 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 avis 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 quotidienne pour tous les utilisateurs d'un site SharePoint à chaque fois que la liste Annonces est modifiée.

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

Voir aussi

Référence

SPAlertCollection classe

SPAlertCollection - Membres

Add - Surcharge

Microsoft.SharePoint - Espace de noms