SPAlertCollection class

Artigo
05/12/2015

Representa uma coleção de objetos SPAlert .

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.Administration.SPAutoSerializingObject
    Microsoft.SharePoint.SPBaseCollection
      Microsoft.SharePoint.SPAlertCollection

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

Syntax

'Declaração
Public Class SPAlertCollection _
    Inherits SPBaseCollection
'Uso
Dim instance As SPAlertCollection

public class SPAlertCollection : SPBaseCollection

Comentários

O objeto SPAlertCollection está disponível como uma propriedade de SPWeb ou SPUser.

Use a propriedade Alerts da classe SPUser ou SPWeb para retornar a coleção de alertas para o usuário ou site da Web. Para criar um alerta, use um dos métodos Add da classe SPAlertCollection .

Use um indexador para retornar um único campo da coleção. Por exemplo, supondo que a coleção é atribuído a uma variável chamada collAlerts, use collAlerts[index] em C# ou deindexde collAlerts() em Visual Basic, onde index é o número de índice do alerta da coleção ou o nome de exibição do alerta.

Examples

O exemplo de código a seguir itera através de todos os alertas dentro de um conjunto de sites para exibir o título de cada site, o nome de exibição da lista e item aos qual cada alerta se aplica e o nome do usuário que recebe a cada alerta.

O exemplo pressupõe a existência de uma página. aspx que contém um controle label.

Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim sites As SPWebCollection = siteCollection.AllWebs
Dim site As SPWeb

For Each site In  sites

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

    For Each alert In  alerts

        Label1.Text += SPEncode.HtmlEncode(site.Title) & " :: " _
            & SPEncode.HtmlEncode(alert.Title) & " :: " _
            & alert.User.LoginName & "<BR>"

    Next alert

Next site

SPSite oSiteCollection = SPContext.Current.Site;
SPWebCollection collWebsites = oSite.AllWebs;
foreach (SPWeb oWebsite in collWebsites)
{
    SPAlertCollection collAlerts = oWebsite.Alerts;

    foreach (SPAlert oAlert in collAlerts)
    {
        Label1.Text = SPEncode.HtmlEncode(oWebsite.Title) + " :: " +
            SPEncode.HtmlEncode(oAlert.Title) + " :: " +
            oAlert.User.LoginName + "<BR>";
        writer.Write(strLabelText);
    }
    oWebsite.Dispose();
}

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

SPAlertCollection members

Microsoft.SharePoint namespace

Compartilhar via