C# Class Net.Pokeshot.JiveSdk.Clients.CommentsClient

Inheritance: JiveClient

Show file Open project: jivesoftware/JiveDotNetSDK

Private Properties

Property	Type	Description

Public Methods

Method	Description
CommentsClient ( string communityUrl, NetworkCredential credentials ) : System
CreateAbuseReport ( int commentID, AbuseReport abuse_report ) : AbuseReport	Register that the requesting person considers the specified comment as abusive.
CreateComment ( Comment new_comment, bool author = false, System.DateTime published = null, System.DateTime updated = null, List fields = null ) : Comment	Create a new comment with the specified characteristics. The parent field must contain the URI of either a content object for which this is a direct reply, or the URI of a previous comment to which this is a reply.
CreateCommentHelpful ( int commentID ) : void	Register that the requesting person considers the specified comment helpful.
CreateCommentLike ( int commentID ) : void	Register that the requesting person likes the specified comment.
CreateCommentUnhelpful ( int commentID ) : void	Register that the requesting person considers the specified comment unhelpful.
CreateReply ( int commentID, Comment new_comment, List fields = null, System.DateTime published = null, System.DateTime updated = null ) : Comment	Create a new comment as a reply to an existing comment with the specified characteristics.
DestroyComment ( int commentID, bool recursiveDelete = true ) : void	Delete the specified comment and its sub comments recursively
DestroyCommentHelpful ( int commentID ) : void	Delete the helpful mark of the specified comment by the requesting user.
DestroyCommentLike ( int commentID ) : void	Delete the like of the specified content object by the requesting user.
DestroyCommentUnhelpful ( int commentID ) : void	Delete the registration of the specified comment as unhelpful by the requesting user.
GetAbuseReports ( int commentID, List fields = null ) : List	Retrieve the abuse reports for the specified comment
GetComment ( int commentID, bool abridged = false, List fields = null ) : Comment	Return the specified comment object with the specified fields.
GetCommentLikes ( int commentID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of the people who like the specified comment.
GetComments ( int commentID, bool excludeReplies = false, int count = 25, int startIndex, string anchor = null, List fields = null ) : List	Return a paginated list of comments to the specified content object, optionally limiting the returned results to direct replies only. The specified content object type must support comments, or be a comment itself (in which case replies to this comment only are returned).
GetEditableComment ( int commentID, List fields = null ) : Comment	Return the specified editable content object with the specified fields.
GetHaveMarkedHelpful ( int commentID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of the people who consider this comment helpful.
GetHaveMarkedUnhelpful ( int commentID, int count = 25, int startIndex, List fields = null ) : List	Return a paginated list of the people who consider this comment unhelpful.
UpdateComment ( int commentID, Comment comment, System.DateTime updated = null, List fields = null ) : Comment	Update the specified comment with the specified characteristics
UpdateEditableComment ( int commentID, Comment comment, System.DateTime updated = null, List fields = null ) : Comment	Update the specified editable comment with the specified characteristics.

Method Details

CommentsClient() public method

public CommentsClient ( string communityUrl, NetworkCredential credentials ) : System
communityUrl	string
credentials	System.Net.NetworkCredential
return	System

CreateAbuseReport() public method

public CreateAbuseReport ( int commentID, AbuseReport abuse_report ) : AbuseReport
commentID	int	ID of the comment to be marked as abusive
abuse_report	Net.Pokeshot.JiveSdk.Models.AbuseReport	AbuseReport object containing the abuse report information
return	Net.Pokeshot.JiveSdk.Models.AbuseReport

CreateComment() public method

Create a new comment with the specified characteristics. The parent field must contain the URI of either a content object for which this is a direct reply, or the URI of a previous comment to which this is a reply.

public CreateComment ( Comment new_comment, bool author = false, System.DateTime published = null, System.DateTime updated = null, List fields = null ) : Comment
new_comment	Net.Pokeshot.JiveSdk.Models.Comment	Comment object describing the comment to be created
author	bool	Flag indicating if new comment is an author comment or a regular comment (only valid for documents). By default a regular comment will be created.
published	System.DateTime	Date and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content.
updated	System.DateTime	Date and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content.
fields	List	Fields to be included in the returned Comment object
return	Net.Pokeshot.JiveSdk.Models.Comment

CreateCommentHelpful() public method

public CreateCommentHelpful ( int commentID ) : void
commentID	int	ID of the comment to be marked as helpful
return	void

CreateCommentLike() public method

public CreateCommentLike ( int commentID ) : void
commentID	int	ID of the comment to be liked
return	void

CreateCommentUnhelpful() public method

public CreateCommentUnhelpful ( int commentID ) : void
commentID	int	ID of the comment to be marked as unhelpful
return	void

CreateReply() public method

Create a new comment as a reply to an existing comment with the specified characteristics.

public CreateReply ( int commentID, Comment new_comment, List fields = null, System.DateTime published = null, System.DateTime updated = null ) : Comment
commentID	int	ID of the comment being replied to
new_comment	Net.Pokeshot.JiveSdk.Models.Comment	Comment object describing the reply comment to be created
fields	List	Fields to include in the returned Comment object
published	System.DateTime	Date and time when this content object was originally created. Set 'updated' param as well. Only set this field when importing content. Since 3.6.
updated	System.DateTime	Date and time when this content object was most recently updated. Set 'published' param as well. Only set this field when importing content. Since 3.6.
return	Net.Pokeshot.JiveSdk.Models.Comment

DestroyComment() public method

Delete the specified comment and its sub comments recursively

public DestroyComment ( int commentID, bool recursiveDelete = true ) : void
commentID	int	ID of the comment to be deleted
recursiveDelete	bool	Flag indicating if the delete is recursive. The flag defaults to true if not provided
return	void

DestroyCommentHelpful() public method

Delete the helpful mark of the specified comment by the requesting user.

public DestroyCommentHelpful ( int commentID ) : void
commentID	int	ID of the comment for which a like is being removed
return	void

DestroyCommentLike() public method

Delete the like of the specified content object by the requesting user.

public DestroyCommentLike ( int commentID ) : void
commentID	int	ID of the comment for which a like is being removed
return	void

DestroyCommentUnhelpful() public method

Delete the registration of the specified comment as unhelpful by the requesting user.

public DestroyCommentUnhelpful ( int commentID ) : void
commentID	int	ID of the comment for which an unhelpful registration is being removed
return	void

GetAbuseReports() public method

Retrieve the abuse reports for the specified comment

public GetAbuseReports ( int commentID, List fields = null ) : List
commentID	int	ID of the comment marked as abusive
fields	List	Fields to be returned in the abuse report response
return	List

GetComment() public method

Return the specified comment object with the specified fields.

public GetComment ( int commentID, bool abridged = false, List fields = null ) : Comment
commentID	int	ID of the comment to be returned
abridged	bool	Flag indicating that if content.text is requested, it will be abridged (length shortened, HTML tags removed)
fields	List	Fields to be returned
return	Net.Pokeshot.JiveSdk.Models.Comment

GetCommentLikes() public method

Return a paginated list of the people who like the specified comment.

public GetCommentLikes ( int commentID, int count = 25, int startIndex, List fields = null ) : List
commentID	int	ID of the comment for which to return liking people
count	int	Maximum number of people to be returned
startIndex	int	Zero-relative index of the first person to be returned
fields	List	Fields to be returned on people that like the comment
return	List

GetComments() public method

Return a paginated list of comments to the specified content object, optionally limiting the returned results to direct replies only. The specified content object type must support comments, or be a comment itself (in which case replies to this comment only are returned).

public GetComments ( int commentID, bool excludeReplies = false, int count = 25, int startIndex, string anchor = null, List fields = null ) : List
commentID	int	ID of the comment for which to return reply comments
excludeReplies	bool	Flag indicating whether to exclude replies (and therefore return direct replies only)
count	int	Maximum number of comments to be returned
startIndex	int	Zero-relative index of the first comment to be returned
anchor	string	optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. /// If the anchor could not be found then the first page of comments will be returned.
fields	List	Fields to be returned in the selected comments
return	List

GetEditableComment() public method

Return the specified editable content object with the specified fields.

public GetEditableComment ( int commentID, List fields = null ) : Comment
commentID	int	ID of the comment to be returned
fields	List	Fields to be returned
return	Net.Pokeshot.JiveSdk.Models.Comment

GetHaveMarkedHelpful() public method

Return a paginated list of the people who consider this comment helpful.

public GetHaveMarkedHelpful ( int commentID, int count = 25, int startIndex, List fields = null ) : List
commentID	int	ID of the comment that has been marked helpful
count	int	Maximum number of people to be returned (default is 25)
startIndex	int	Zero-relative index of the first person to be returned (default is 0)
fields	List	Fields to be returned on people who have marked this comment as helpful (default is @summary)
return	List

GetHaveMarkedUnhelpful() public method

Return a paginated list of the people who consider this comment unhelpful.

public GetHaveMarkedUnhelpful ( int commentID, int count = 25, int startIndex, List fields = null ) : List
commentID	int	ID of the comment that has been marked unhelpful
count	int	Maximum number of people to be returned (default is 25)
startIndex	int	Zero-relative index of the first person to be returned (default is 0)
fields	List	Fields to be returned on people who have marked this comment as unhelpful (default is @summary)
return	List

UpdateComment() public method

Update the specified comment with the specified characteristics

public UpdateComment ( int commentID, Comment comment, System.DateTime updated = null, List fields = null ) : Comment
commentID	int	ID of the comment to be updated
comment	Net.Pokeshot.JiveSdk.Models.Comment	Comment object containing the updated comment
updated	System.DateTime	Date and time when this content object was most recently updated
fields	List	Fields to include in the returned entity
return	Net.Pokeshot.JiveSdk.Models.Comment

UpdateEditableComment() public method

Update the specified editable comment with the specified characteristics.

public UpdateEditableComment ( int commentID, Comment comment, System.DateTime updated = null, List fields = null ) : Comment
commentID	int	ID of the editable comment to be updated
comment	Net.Pokeshot.JiveSdk.Models.Comment	Comment object containing the updated comment
updated	System.DateTime	Date and time when this content object was most recently updated.
fields	List	Fields to include in the returned entity
return	Net.Pokeshot.JiveSdk.Models.Comment