SPList.GetChanges method (SPChangeToken, SPChangeToken)
Retorna uma coleção das alterações conectado por meio de um período de tempo especificado.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
Public Function GetChanges ( _
changeToken As SPChangeToken, _
changeTokenEnd As SPChangeToken _
) As SPChangeCollection
'Uso
Dim instance As SPList
Dim changeToken As SPChangeToken
Dim changeTokenEnd As SPChangeToken
Dim returnValue As SPChangeCollection
returnValue = instance.GetChanges(changeToken, _
changeTokenEnd)
public SPChangeCollection GetChanges(
SPChangeToken changeToken,
SPChangeToken changeTokenEnd
)
Parâmetros
changeToken
Type: Microsoft.SharePoint.SPChangeTokenA data e hora de início.
changeTokenEnd
Type: Microsoft.SharePoint.SPChangeTokenA data e hora de término.
Valor retornado
Type: Microsoft.SharePoint.SPChangeCollection
As alterações.
Exceptions
| Exception | Condition |
|---|---|
| SPException | changeToken ou changeTokenEnd não é um token válido. |
Comentários
Ao construir os objetos de SPChangeToken para usar com este método, passe SPChangeCollection.CollectionScope. List como o primeiro argumento do construtor, o valor da propriedade de SPList.ID do objeto atual como o segundo argumento e um objeto de DateTime como o terceiro argumento.
Além disso, as seguintes regras se aplicam:
Se qualquer um dos token se refere a uma hora antes do início do log de alteração atual, o método gera uma exceção.
Se o tempo do segundo token é antes do tempo do token primeiro, o método retorna uma coleção vazia.
Se o primeiro símbolo for a null reference (Nothing in Visual Basic), o conjunto de alterações que é retornado começa no início do log de alteração atual.
Se o segundo token for a null reference (Nothing in Visual Basic), alterar coleção retornada inclui todas as alterações depois da data especificada pelo token de alteração primeiro, até o limite de uma única coleção. Se mais alterações ocorreram nesse período, o primeiro lote será retornado.
Dica
Por padrão, o log de alterações retém dados por 60 dias. Você pode configurar o período de retenção, definindo a propriedade ChangeLogRetentionPeriod .
Examples
O exemplo a seguir é um aplicativo de console que consulta o log de alteração para que as alterações a uma lista durante um período de sete dias. Depois de recuperar as alterações, o aplicativo imprime informações sobre cada alteração no console.
using System;
using Microsoft.SharePoint;
namespace Test
{
class ConsoleApp
{
static void Main(string[] args)
{
using (SPSite siteCollection = new SPSite("https://localhost"))
{
using (SPWeb webSite = siteCollection.OpenWeb())
{
// Get a list.
SPList list = webSite.Lists[0];
SPChangeToken startToken = new SPChangeToken(
SPChangeCollection.CollectionScope.List,
list.ID,
new DateTime(2008, 10, 12));
SPChangeToken endToken = new SPChangeToken(
SPChangeCollection.CollectionScope.List,
list.ID,
new DateTime(2008, 10, 18));
SPTimeZone timeZone = webSite.RegionalSettings.TimeZone;
int total = 0;
// Get the first batch of changes.
SPChangeCollection changes = list.GetChanges(startToken, endToken);
// Loop until we reach the end of the log.
while (changes.Count > 0)
{
total += changes.Count;
// Print info about each change to the console.
foreach (SPChange change in changes)
{
Console.WriteLine("\nDate: {0}",
timeZone.UTCToLocalTime(change.Time).ToString());
Console.WriteLine("Object type: {0}", change.GetType().ToString());
Console.WriteLine("Change: {0}", change.ChangeType.ToString());
}
// Go get another batch.
startToken = changes.LastChangeToken;
changes = list.GetChanges(startToken, endToken);
}
Console.WriteLine("\nTotal of {0} changes to {1} list", total, list.Title);
}
}
Console.Write("\nPress ENTER to continue...");
Console.ReadLine();
}
}
}
Imports System
Imports Microsoft.SharePoint
Module ConsoleApp
Sub Main()
Using siteCollection As SPSite = New SPSite("https://localhost")
Using webSite As SPWeb = siteCollection.OpenWeb()
' Get a list.
Dim list As SPList = webSite.Lists(0)
Dim startToken As New SPChangeToken(SPChangeCollection.CollectionScope.List, _
list.ID, _
New DateTime(2008, 10, 12))
Dim endToken As New SPChangeToken(SPChangeCollection.CollectionScope.List, _
list.ID, _
New DateTime(2008, 10, 18))
Dim timeZone As SPTimeZone = webSite.RegionalSettings.TimeZone
Dim total As Integer = 0
' Get the first batch of changes.
Dim changes As SPChangeCollection = list.GetChanges(startToken, endToken)
' Loop until we reach the end of the log.
While changes.Count > 0
total += changes.Count
' Print info about each change to the console.
For Each change As SPChange In changes
Console.WriteLine(vbCrLf + "Date: {0}", timeZone.UTCToLocalTime(change.Time).ToString())
Console.WriteLine("Object type: {0}", change.GetType().ToString())
Console.WriteLine("Change: {0}", change.ChangeType.ToString())
Next change
' Go get another batch of changes starting where we left off.
startToken = changes.LastChangeToken
changes = list.GetChanges(startToken, endToken)
End While
Console.WriteLine(vbCrLf + "Total of {0:#,#} changes to {1} list", total, list.Title)
End Using
End Using
Console.Write(vbCrLf + "Press ENTER to continue...")
Console.ReadLine()
End Sub
End Module
Ver também
Referência
Microsoft.SharePoint namespace