Share via


PublishingService.GetChangedFriendlyUrlBasedWebs method

Returns the list of webs that have changed after the last “changeToken”.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function GetChangedFriendlyUrlBasedWebs ( _
    contentPartitionId As Guid, _
    changeToken As String, _
    ByRef pagingToken As String _
) As FriendlyUrlBasedWeb()
'Usage
Dim instance As PublishingService
Dim contentPartitionId As Guid
Dim changeToken As String
Dim pagingToken As String
Dim returnValue As FriendlyUrlBasedWeb()

returnValue = instance.GetChangedFriendlyUrlBasedWebs(contentPartitionId, _
    changeToken, pagingToken)
[WebMethodAttribute]
public FriendlyUrlBasedWeb[] GetChangedFriendlyUrlBasedWebs(
    Guid contentPartitionId,
    string changeToken,
    ref string pagingToken
)

Parameters

  • changeToken
    Type: System.String

    An opaque token passed to the caller when the call to GetAllContentPartitions is made. The caller is supposed to pass that token to get a list of SPWeb objects that changed since the token was issued.

  • pagingToken
    Type: System.String

    Tracks the current page of result.

Return value

Type: []

Remarks

There may be a large number of results that need to be returned. In that case, the results need to be chunked into pages. The pagingToken parameter is an opaque token that SharePoint Server returns to the caller of the PublishingService web service. The caller keeps calling the GetFriendlyUrlBasedWebs(System.Guid,System.String@) method with the pagingToken parameter, and SharePoint Server continues to update the paging token until the last page is reached. When the last page is reached, SharePoint Server sets it to an empty string. In the first call, the caller is supposed to set the pagingToken parameter to an empty string.

The returned results are based on the following:

  1. If any web is deleted from the content database, SharePoint Server returns it.

  2. Any web that has started or stopped using managed navigation is returned.

  3. If there is any change in a NavigationTermSet object, then all of the webs that are associated with the NavigationTermSet are returned. If the changeToken pass is a null reference (Nothing in Visual Basic), it behaves exactly the same as the GetAllWebs method.

See also

Reference

PublishingService class

PublishingService members

Microsoft.SharePoint.Publishing.WebServices namespace