Compartilhar via

Lists.GetListItemChangesSinceToken Method

  • Artigo

Retorna as alterações feitas a lista desde a data e hora especificada no token.

Web Service: ListsWeb Reference: http://<Site>/_vti_bin/Lists.asmx

Syntax

'Declaração
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetListItemChangesSinceToken", RequestNamespace:="https://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace:="https://schemas.microsoft.com/sharepoint/soap/", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
PublicFunctionGetListItemChangesSinceToken ( _
    listNameAsString, _
    viewNameAsString, _
    queryAsXmlNode, _
    viewFieldsAsXmlNode, _
    rowLimitAsString, _
    queryOptionsAsXmlNode, _
    changeTokenAsString, _
    containsAsXmlNode _
) AsXmlNode
'Uso
DiminstanceAsListsDimlistNameAsStringDimviewNameAsStringDimqueryAsXmlNodeDimviewFieldsAsXmlNodeDimrowLimitAsStringDimqueryOptionsAsXmlNodeDimchangeTokenAsStringDimcontainsAsXmlNodeDimreturnValueAsXmlNodereturnValue = instance.GetListItemChangesSinceToken(listName, viewName, query, viewFields, rowLimit, queryOptions, changeToken, contains)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetListItemChangesSinceToken", RequestNamespace="https://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace="https://schemas.microsoft.com/sharepoint/soap/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
publicXmlNodeGetListItemChangesSinceToken (
    stringlistName,
    stringviewName,
    XmlNodequery,
    XmlNodeviewFields,
    stringrowLimit,
    XmlNodequeryOptions,
    stringchangeToken,
    XmlNodecontains
)

Parameters

  • listName
    Uma seqüência de caracteres que contém o título ou o GUID para a lista. Ao consultar a tabela UserInfo, a seqüência de caracteres contém UserInfo.
  • viewName
    Uma seqüência de caracteres que contém o GUID de modo de exibição, que determina o modo de exibição para usar para os atributos do modo de exibição padrão representado por consulta , , viewFields e rowLimit parâmetros. Se esse argumento não for fornecido, o modo de exibição padrão será presumido. Se ele for fornecido, o valor da consulta , , viewFields ou rowLimit parâmetro substitui a configuração equivalente no modo de exibição. Por exemplo, se o modo especificado pelo parâmetro de viewFields tem um limite de linha de 100 linhas, mas o parâmetro rowLimit contém 1000, em seguida, 1.000 linhas são retornadas na resposta.

  • query
    Um elemento Q uery que contém a consulta que determina quais registros são retornados em que ordem e que podem ser atribuídos a um objeto System.Xml.XmlNode,as in o exemplo a seguir.

    <Query>
   <Where>
      <Lt>
         <FieldRef Name="ID" />
         <Value Type="Counter">3</Value>
      </Lt>
   </Where>
</Query>

    Se fornecido, o valor desse parâmetro substitui a consulta no modo de exibição especificado pelo parâmetro de v iewName ou a consulta no modo de exibição padrão para a lista.

  • viewFields
    Um elemento ViewFields que especifica quais campos retornam na consulta e em que ordem, e que pode ser atribuída a um objeto System.Xml.XmlNode,as in o exemplo a seguir.

    <ViewFields>
   <FieldRef Name="ID" />
   <FieldRef Name="Title" />
</ViewFields>

    Se fornecido, o valor desse parâmetro substitui os modo de exibição campos dentro modo especificado pelo parâmetro viewName ou os modo de exibição campos no modo de exibição para a lista padrão. Se esse valor for null,a consulta retornará todos os campos de cada item retornado.

  • rowLimit
    Uma seqüência de caracteres que especifica o número de itens, ou linhas, para exibir em uma página antes de paginação começa. Se fornecido, o valor desse parâmetro substitui o linha limite definido no modo especificado pelo parâmetro de viewName ou o limite de linha definido no modo de exibição para a lista padrão.

  • queryOptions
    Um fragmento XML in a forma a seguir que contém nós separados para as várias propriedades do objeto SPQuery, e que pode ser atribuída a um objeto System.Xml.XmlNode.

    <QueryOptions>
   <IncludeMandatoryColumns>FALSE
      </IncludeMandatoryColumns>
   <DateInUtc>TRUE</DateInUtc>
</QueryOptions>

    A tabela a seguir mostra os elementos que podem ser usados no fragmento de colaboração aplicativos Markup Language (CAML) pelos quais passou até o parâmetro queryOptions .

    Elemento

    Descrição

    DateInUtc

    TRUE Para retornar as datas no formato Tempo Universal Coordenado (UTC). FALSE Para retornar as datas no formato ISO. Esse elemento é opcional, e o valor padrão é TRUE.

    Folder

    Especifica um URL usado para filtrar itens Biblioteca de Documentos de itens na pasta especificada. Esse elemento é opcional, e o valor padrão é uma seqüência vazia.

    Paging

    Uma seqüência de caracteres que contém os dados necessários para oferecer suporte à paginação, incluindo um atributo ListItemCollectionPositionNext.Se deixado vazio, os itens da lista retornada início desde o início da lista. Aplicativos cliente devem fornecer o valor de um indicador Server-supplied. O servidor retorna a próxima página de dados com base no indicador fornecido. Esse elemento é opcional, e o valor padrão é uma seqüência vazia.

    IncludeMandatoryColumns

    TRUE Para especificar que colunas Obrigatório do sistema ser retornado junto com os campos especificados, o parâmetro viewFields (por exemplo, owsHiddenVersion,Campos Dependentes e campos obrigatórios). Esse elemento é opcional, e o valor padrão é TRUE.

    MeetingInstanceID

    Um valor inteiro onde um número positivo representa uma instância específica de reunião. Números negativos têm os seguintes significados: - 3 = UnSpecified, -2 = AllWithSeries, -1 = AllButSeries, 0 = Series.Esse elemento é opcional, e o valor padrão é -1.Valores negativos correspondem aos valores de enumeração de Microsoft.SharePoint.Meetings.SPMeeting.SpecialInstance.

    ViewAttributes

    Uma seqüência de caracteres que representa todos os atributos retornados como parte do elemento View ao recuperar um modo de exibição por meio de GetView método. Esse elemento é opcional, e seu valor padrão está vazia. Se um parâmetro viewName for fornecido, os atributos do modo de exibição do modo de exibição persistente são usados. Quando esse argumento for fornecido, ele substitui quaisquer atributos do modo de exibição que podem ser recuperados do modo persistente especificado pelo parâmetro de viewName . Esse elemento é opcional e o valor padrão é uma seqüência de caracteres vazia. Para retornar todos os documentos em uma biblioteca, o ViewAttributes elemento é usado da seguinte maneira: <ViewAttributes Scope="Recursive" />.

    Para passar um valor vazio para esse parâmetro, inclua um elemento QueryOptions vazio da seguinte maneira.

    <queryOptions xmlns:SOAPSDK9=
      "https://schemas.microsoft.com/sharepoint/soap/" >
   <QueryOptions/>
</queryOptions>
  • changeToken
    Uma seqüência de caracteres que contém o símbolo de alteração para a solicitação. Para obter uma descrição do formato usado nessa seqüência de caracteres, consulte Visão geral: Alterar tokens, tipos de objeto e tipos de alteração Tipos de alteração. Se null for passado, todos os itens na lista são retornados.

  • contains
    Um elemento Contains que define filtro personalizado para a consulta e que pode ser atribuída a um objeto System.Xml.XmlNode,as in o exemplo a seguir.

    <Contains>
   <FieldRef Name="Status"/>
   <Value Type="Text">Complete</Value>
</Contains>

    Este parâmetro pode conter null.

Return Value

Um fragmento XML na forma a seguir que retorna o último alterar token e item alterações e que podem ser atribuídos a um objeto System.Xml.XmlNode:

<listitems MinTimeBetweenSyncs="0" RecommendedTimeBetweenSyncs="180" MaxBulkDocumentSyncSize="500" 
   AlternateUrls="http://lwswss1/,http://zinzinzin/" EffectivePermMask="FullMask" 
   xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882" xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882" 
   xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:z="#RowsetSchema" 
   xmlns="https://schemas.microsoft.com/sharepoint/soap/">
   <Changes LastChangeToken="1;3;b0c07dce-e4c7-45a9-8b7f-0d5339f69633;633247934080930000;70853">
   </Changes>
   <rs:data ItemCount="2">
      <z:row ows_Attachments="0" ows_LinkTitle="t4" ows_MetaInfo="3;#" ows__ModerationStatus="0" 
         ows__Level="1" ows_Title="t4" ows_ID="3" ows_owshiddenversion="2" 
         ows_UniqueId="3;#{9153FDD3-7C00-47E9-9194-956BB20AAA8D}" ows_FSObjType="3;#0" 
         ows_Created_x0020_Date="3;#2007-08-31T21:34:59Z" ows_Created="2007-08-31T21:34:59Z" 
         ows_FileLeafRef="3;#3_.000" ows_FileRef="3;#sites/ContainsWiki/Lists/TestList/3_.000" 
         ows_ServerRedirected="0" />
      <z:row ows_Attachments="0" ows_LinkTitle="t4" ows_MetaInfo="5;#" ows__ModerationStatus="0" 
         ows__Level="1" ows_Title="t4" ows_ID="5" ows_owshiddenversion="3" 
         ows_UniqueId="5;#{5BDBB1C0-194D-4878-B716-E397B0C1318C}" ows_FSObjType="5;#0" 
         ows_Created_x0020_Date="5;#2007-08-31T21:43:23Z" ows_Created="2007-08-31T21:43:23Z" 
         ows_FileLeafRef="5;#5_.000" ows_FileRef="5;#sites/ContainsWiki/Lists/TestList/5_.000" 
         ows_ServerRedirected="0" />
         ...
   </rs:data>
</listitems>

Example

O exemplo a seguir retorna a lista de item alterações que ocorreram depois do horário especificado por um símbolo.

Dim listService As New Web_Reference_Folder.Lists()
listService.Credentials = System.Net.CredentialCache.DefaultCredentials

Dim xmlDoc = New System.Xml.XmlDocument()
Dim ndContains As XmlNode = xmlDoc.CreateNode(XmlNodeType.Element, "Contains", "")
ndContains.InnerXml = "<FieldRef Name='Title'/>" + 
    "<Value Type='Text'>My Value</Value>"

Dim strToken As String = "1;3;b0c07dce-e4c7-45a9-8b7f-0d5339f69633;633241941530270000;70848"

Try
    Dim ndListChanges As XmlNode = listService.GetListItemChangesSinceToken("My List", Nothing, Nothing, Nothing, "100", Nothing, strToken, ndContains)
    MessageBox.Show(ndListChanges.OuterXml)

    Catch ex As System.Web.Services.Protocols.SoapException
        MessageBox.Show(("Message:" + ControlChars.Lf + ex.Message + ControlChars.Lf + 
            "Detail:" + ControlChars.Lf + ex.Detail.InnerText + ControlChars.Lf + "StackTrace:" + 
            ControlChars.Lf + ex.StackTrace))
End Try

Web_Reference_Folder.Lists listService = new Web_Reference_Folder.Lists();
listService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlDocument xmlDoc = new System.Xml.XmlDocument();

XmlNode ndContains = xmlDoc.CreateNode(XmlNodeType.Element, "Contains", "");

ndContains.InnerXml = "<FieldRef Name='Title'/>" +
    "<Value Type='Text'>My Value</Value>";

string strToken = "1;3;b0c07dce-e4c7-45a9-8b7f-0d5339f69633;633241941530270000;70848";

try
{
    XmlNode ndListChanges = listService.GetListItemChangesSinceToken("My List",null,null,null,"100",null, strToken, ndContains);
    MessageBox.Show(ndListChanges.OuterXml);
}
catch (System.Web.Services.Protocols.SoapException ex)
{
    MessageBox.Show("Message:\n" + ex.Message + "\nDetail:\n" +
        ex.Detail.InnerText +
        "\nStackTrace:\n" + ex.StackTrace);
}

See Also

Reference

Lists Class
Lists Members
Lists Web Service