(SPListItem, SPEventType, SPAlertFrequency, SPAlertDeliveryChannels) del método SPAlertCollection.Add

Agrega una alerta para un elemento de lista a la colección.

Espacio de nombres:  Microsoft.SharePoint
Ensamblado:  Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Public Function Add ( _
    item As SPListItem, _
    eventType As SPEventType, _
    alertFrequency As SPAlertFrequency, _
    deliveryChannels As SPAlertDeliveryChannels _
) As Guid
'Uso
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
)

Parámetros

• item
  Tipo: Microsoft.SharePoint.SPListItem

  Un objeto Microsoft.SharePoint.SPListItem que representa el elemento al que se aplica la alerta.

• eventType
  Tipo: Microsoft.SharePoint.SPEventType

  Un valor de Microsoft.SharePoint.SPEventType que especifica el tipo de evento de la alerta.

• alertFrequency
  Tipo: Microsoft.SharePoint.SPAlertFrequency

  Un valor de Microsoft.SharePoint.SPAlertFrequency que especifica la frecuencia de envío de una alerta.

• deliveryChannels
  Tipo: Microsoft.SharePoint.SPAlertDeliveryChannels

  Un valor que especifica si la alerta se entrega como correo electrónico o como un mensaje de servicio de mensajes cortos (SMS).

Valor devuelto

Tipo: System.Guid
El identificador de la alerta.

Comentarios

Uso del método Add envía un mensaje de confirmación a todos los usuarios que les informará que se haya agregado correctamente una alerta.

En el ejemplo de código siguiente se crea una alerta para todos los usuarios de un sitio. Esta alerta les notifica inmediatamente cada vez que un usuario trata de un archivo especificado en la biblioteca de documentos documentos compartidos.

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

Vea también

Referencia

clase SPAlertCollection

Miembros SPAlertCollection

Sobrecarga Add

Espacio de nombres Microsoft.SharePoint