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

Inheritance: JiveClient
显示文件 Open project: jivesoftware/JiveDotNetSDK

Private Properties

Property Type Description

Public Methods

Method Description
GetContentReplies ( int contentID, int count = 25, bool excludeReplies = false, List filter = null, bool hierarchical = true, int startIndex, string anchor = null, List fields = null ) : List

Return a list of messages for the specified content object, which must be a discussion, optionally limiting the results to direct replies only.

GetMessage ( int messageID, bool abridged = false, List fields = null ) : Message

Return the specified message with the specified fields.

GetReplies ( int messageID, int count = 25, bool excludeReplies = false, List filter = null, bool hierarchical = true, int startIndex, string anchor = null, string messageTarget = "all", List fields = null ) : List

Return a list of messages that are replies to the specified message, optionally limiting the returned results to direct replies only.

MessagesClient ( string communityUrl, NetworkCredential credentials ) : System

Method Details

GetContentReplies() public method

Return a list of messages for the specified content object, which must be a discussion, optionally limiting the results to direct replies only.
public GetContentReplies ( int contentID, int count = 25, bool excludeReplies = false, List filter = null, bool hierarchical = true, int startIndex, string anchor = null, List fields = null ) : List
contentID int ID of the content object (must be a discussion) for which to return reply messages
count int Maximum number of messages to be returned (default is 25)
excludeReplies bool Flag indicating whether to exclude replies (and therefore return direct replies only) (default is false)
filter List The filter criteria used to select reply messages
hierarchical bool Flag indicating that replies should be returned in hierarchical order instead of chronological order. (default is true) Since v3.1
startIndex int Zero-relative index of the first message to be returned (default is 0)
anchor string optional URI for a message 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 messages will be returned.
fields List Fields to be returned in the selected messages
return List

GetMessage() public method

Return the specified message with the specified fields.
public GetMessage ( int messageID, bool abridged = false, List fields = null ) : Message
messageID int ID of the message 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.Message

GetReplies() public method

Return a list of messages that are replies to the specified message, optionally limiting the returned results to direct replies only.
public GetReplies ( int messageID, int count = 25, bool excludeReplies = false, List filter = null, bool hierarchical = true, int startIndex, string anchor = null, string messageTarget = "all", List fields = null ) : List
messageID int ID of the message for which to return reply messages
count int Maximum number of messages to be returned (default is 25)
excludeReplies bool Flag indicating whether to exclude replies (and therefore return direct replies only) (default is false)
filter List The filter criteria used to select reply messages
hierarchical bool Flag indicating that replies should be returned in hierarchical order instead of chronological order. (default is true) Since v3.1
startIndex int Zero-relative index of the first message to be returned (default is 0)
anchor string optional URI for a message 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 messages will be returned.
messageTarget string is the target from which you want to replies. Must be one of "replyToTlo", "replyAsComment", "all"
fields List Fields to be returned in the selected messages
return List

MessagesClient() public method

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