SocialDataService.AddTagByKeyword method

Associates a social tag with the specified keyword with the specified URL for the current user.

Namespace:  WebSvcSocialDataService
Assembly:  UserProfileServices (in UserProfileServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePointPortalServer/SocialDataService/AddTagByKeyword", RequestNamespace := "https://microsoft.com/webservices/SharePointPortalServer/SocialDataService",  _
    ResponseNamespace := "https://microsoft.com/webservices/SharePointPortalServer/SocialDataService",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function AddTagByKeyword ( _
    url As String, _
    keyword As String, _
    title As String, _
    isPrivate As Nullable(Of Boolean) _
) As SocialTagDetail
'Usage
Dim instance As SocialDataService
Dim url As String
Dim keyword As String
Dim title As String
Dim isPrivate As Nullable(Of Boolean)
Dim returnValue As SocialTagDetail

returnValue = instance.AddTagByKeyword(url, _
    keyword, title, isPrivate)
[SoapDocumentMethodAttribute("https://microsoft.com/webservices/SharePointPortalServer/SocialDataService/AddTagByKeyword", RequestNamespace = "https://microsoft.com/webservices/SharePointPortalServer/SocialDataService", 
    ResponseNamespace = "https://microsoft.com/webservices/SharePointPortalServer/SocialDataService", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public SocialTagDetail AddTagByKeyword(
    string url,
    string keyword,
    string title,
    Nullable<bool> isPrivate
)

Parameters

  • url
    Type: System.String

    The URL for which the social tag is added. This value must be in a valid URI format and must contain fewer than 2085 characters.

  • keyword
    Type: System.String

    The keyword associated with the social tag. This value must contain fewer than 256 characters.

  • title
    Type: System.String

    The title of the social tag. This value must contain fewer than 501 characters.

  • isPrivate
    Type: System.Nullable<Boolean>

    true to indicate the social tag is private; otherwise, false. If this value is null , this method assumes false for this parameter.

Return value

Type: WebSvcSocialDataService.SocialTagDetail
The new social tag.

Exceptions

Exception Condition
ArgumentNullException

url is null .

UriFormatException

The value of url is not in a valid format.

InvalidOperationException

The social tag term is not available for tagging.

Remarks

If no social tag term exists for the specified keyword, this method creates one for the association.

See also

Reference

SocialDataService class

SocialDataService members

WebSvcSocialDataService namespace