SocialDataService.GetCommentsOnUrl Method

Retrieves all social comments for the specified URL and last modified date after the specified time, up to the specified maximum number and starting at the specified zero-based index.

Namespace:  [SocialDataService Web service]
Web service reference: http://Site/_vti_bin/SocialDataService.asmx

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://microsoft.com/webservices/SharePointPortalServer/SocialDataService/GetCommentsOnUrl", RequestNamespace := "http://microsoft.com/webservices/SharePointPortalServer/SocialDataService",  _
    ResponseNamespace := "http://microsoft.com/webservices/SharePointPortalServer/SocialDataService",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetCommentsOnUrl ( _
    url As String, _
    maximumItemsToReturn As Nullable(Of Integer), _
    startIndex As Nullable(Of Integer), _
    excludeItemsTime As Nullable(Of DateTime) _
) As SocialCommentDetail()
'Usage
Dim instance As SocialDataService
Dim url As String
Dim maximumItemsToReturn As Nullable(Of Integer)
Dim startIndex As Nullable(Of Integer)
Dim excludeItemsTime As Nullable(Of DateTime)
Dim returnValue As SocialCommentDetail()

returnValue = instance.GetCommentsOnUrl(url, _
    maximumItemsToReturn, startIndex, _
    excludeItemsTime)
[SoapDocumentMethodAttribute("http://microsoft.com/webservices/SharePointPortalServer/SocialDataService/GetCommentsOnUrl", RequestNamespace = "http://microsoft.com/webservices/SharePointPortalServer/SocialDataService", 
    ResponseNamespace = "http://microsoft.com/webservices/SharePointPortalServer/SocialDataService", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public SocialCommentDetail[] GetCommentsOnUrl(
    string url,
    Nullable<int> maximumItemsToReturn,
    Nullable<int> startIndex,
    Nullable<DateTime> excludeItemsTime
)

Parameters

  • url
    Type: System.String

    The URL for which all social comments are retrieved. This value must be in a valid URI format and must contain fewer than 2085 characters.

  • maximumItemsToReturn
    Type: System.Nullable<Int32>

    The maximum number of comments to return. This value must be null or nonnegative. If it is null or 0, this method returns up to 1000 social comments.

  • startIndex
    Type: System.Nullable<Int32>

    The zero-based index of the total set of social comments that match the specified parameters at which the returned set of social comments starts. This value must be null or nonnegative. If this value is null or 0, this method returns the set of social comments starting with the first social comment in the total set of social comments that match the specified parameters.

  • excludeItemsTime
    Type: System.Nullable<DateTime>

    The starting time for the last modified date of the social comments included in the result. This method returns only social comments with a last modified date after this time. If this value is null , this method does not filter social comments based on the last modified date.

Return Value

Type: []
An array that contains all social comments created for the specified URL and last modified date after the specified time, up to the specified maximum number and starting at the specified zero-based index.

Exceptions

Exception Condition
ArgumentNullException

url is null .

UriFormatException

url is not in the correct format.

ArgumentOutOfRangeException

maximumItemsToReturn or startIndex is less than 0.

UriFormatException

url is not in the correct format.

SqlException

The user does not have permission to access the comments.

See Also

Reference

SocialDataService Class

SocialDataService Members

SocialDataService Web Service