Compartilhar via


SPAlert class

Representa um alerta, o que gera emails periódicos ou notificações de serviço de mensagem curta (SMS) enviadas a um usuário sobre a lista, item de lista, documentos ou biblioteca de documentos à qual se aplica o alerta.

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.SPAlert

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

Syntax

'Declaração
Public NotInheritable Class SPAlert
'Uso
Dim instance As SPAlert
public sealed class SPAlert

Comentários

SPAlert fornece informações sobre o alerta, como qual modelo de alerta é usado, a freqüência dos alertas e UserID do usuário que criou o alerta.

Use a propriedade Alerts da classe a SPUser ou SPWeb para retornar um objeto SPAlertCollection que representa a coleção de alertas para o usuário ou site da Web. Use um indexador para retornar um único alerta da coleção.

Dica

Use o método Update após fazer quaisquer alterações para o alerta.

Examples

Este exemplo de código usa a classe SPAlert para percorrer todos os alertas para todos os usuários de um site e atualizar a freqüência dos alertas.

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

Dica

Determinados objetos implementam a interface IDisposable , e você deve evitar reter esses objetos na memória depois que eles não são mais necessários. Para obter informações sobre boas práticas de codificação, consulte Disposing Objects.

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Ver também

Referência

SPAlert members

Microsoft.SharePoint namespace