SPAlert - Classe

Article
05/12/2015

Représente une alerte, ce qui génère des périodiques par courrier électronique ou des notifications de Service SMS (Short Message) envoyées à un utilisateur sur la liste, élément de liste, document ou bibliothèque de documents à laquelle l'alerte s'applique.

Hiérarchie d’héritage

System.Object
Microsoft.SharePoint.SPAlert

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

Syntaxe

'Déclaration
Public NotInheritable Class SPAlert
'Utilisation
Dim instance As SPAlert

public sealed class SPAlert

Remarques

SPAlert fournit des informations sur l'alerte, par exemple quels modèle d'alerte est utilisé, la fréquence de l'alerte et la UserID de l'utilisateur qui a créé l'alerte.

Utilisez la propriété Alerts de la SPUser SPWeb classe ou pour renvoyer un objet SPAlertCollection qui représente la collection d'alertes pour l'utilisateur ou d'un site Web. Pour renvoyer une seule alerte à partir de la collection, utilisez un indexeur.

Notes

Utilisez la méthode Update après avoir apporté des modifications à l'alerte.

Exemples

Cet exemple de code utilise la classe SPAlert pour parcourir toutes les alertes pour tous les utilisateurs d'un site et mettre à jour la fréquence de l'alerte.

Dim site As SPWeb = SPControl.GetContextWeb(Context)
Dim users As SPUserCollection = site.Users
Dim user As SPUser

For Each user In  users

    Dim alerts As SPAlertCollection = user.Alerts
    Dim alert As SPAlert

    For Each alert In  alerts

        alert.AlertFrequency = 
            Microsoft.SharePoint.SPAlertFrequency.Immediate

        alert.Update()

    Next alert

Next user

SPWeb oWebsite = SPContext.Current.Web;
SPUserCollection collUsers = oWebsite.Users;

    foreach (SPUser oUser in collUsers)
    {
        SPAlertCollection collAlerts = oUser.Alerts;

         foreach (SPAlert oAlert in collAlerts)
         {
             oAlert.AlertFrequency =  
             Microsoft.SharePoint.SPAlertFrequency.Immediate;

             oAlert.Update();
         }
     }

Notes

Certains objets implémentent l'interface IDisposable , et vous devez éviter de conserver ces objets dans la mémoire après que qu'ils ne sont plus nécessaires. Pour plus d'informations sur les bonnes pratiques de codage, consultez Disposing Objects.

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPAlert - Membres

Microsoft.SharePoint - Espace de noms

Partager via