Returns a list of comment threads that match the API request parameters. More...

Inheritance diagram for Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest:

Public Types
enum	ModerationStatusEnum { ModerationStatusEnum.HeldForReview, ModerationStatusEnum.LikelySpam, ModerationStatusEnum.Published }
	Set this parameter to limit the returned comment threads to a particular moderation state. More...

enum	OrderEnum { OrderEnum.Relevance, OrderEnum.Time }
	The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter. More...

enum	TextFormatEnum { TextFormatEnum.Html, TextFormatEnum.PlainText }
	Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text. More...

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service, string part)
	Constructs a new List request. More...

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list. More...

Protected Member Functions inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< Google.Apis.YouTube.v3.Data.CommentThreadListResponse >
	YouTubeBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new YouTubeBaseServiceRequest instance. More...

override void	InitParameters ()
	Initializes YouTube parameter list. More...

Properties
virtual string	Part `[get]`
	The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. More...

virtual string	AllThreadsRelatedToChannelId `[get, set]`
	The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos. More...

virtual string	ChannelId `[get, set]`
	The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.) More...

virtual string	Id `[get, set]`
	The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved. More...

virtual System.Nullable< long >	MaxResults `[get, set]`
	The maxResults parameter specifies the maximum number of items that should be returned in the result set. More...

virtual System.Nullable< ModerationStatusEnum >	ModerationStatus `[get, set]`
	Set this parameter to limit the returned comment threads to a particular moderation state. More...

virtual System.Nullable< OrderEnum >	Order `[get, set]`
	The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter. More...

virtual string	PageToken `[get, set]`
	The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. More...

virtual string	SearchTerms `[get, set]`
	The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms. More...

virtual System.Nullable< TextFormatEnum >	TextFormat `[get, set]`
	Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text. More...

virtual string	VideoId `[get, set]`
	The videoId parameter instructs the API to return comment threads associated with the specified video ID. More...

override string	MethodName `[get]`
	summary>Gets the HTTP method. More...

override string	HttpMethod `[get]`
	summary>Gets the REST path. More...

override string	RestPath `[get]`

Properties inherited from Google.Apis.YouTube.v3.YouTubeBaseServiceRequest< Google.Apis.YouTube.v3.Data.CommentThreadListResponse >
virtual System.Nullable< AltEnum >	Alt `[get, set]`
	Data format for the response. More...

virtual string	Fields `[get, set]`
	Selector specifying which fields to include in a partial response. More...

virtual string	Key `[get, set]`
	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...

virtual string	OauthToken `[get, set]`
	OAuth 2.0 token for the current user. More...

virtual System.Nullable< bool >	PrettyPrint `[get, set]`
	Returns response with indentations and line breaks. More...

virtual string	QuotaUser `[get, set]`
	An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...

virtual string	UserIp `[get, set]`
	Deprecated. Please use quotaUser instead. More...

Detailed Description

Returns a list of comment threads that match the API request parameters.

Member Enumeration Documentation

◆ ModerationStatusEnum

enum Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.ModerationStatusEnum

strong

Set this parameter to limit the returned comment threads to a particular moderation state.

Note: This parameter is not supported for use in conjunction with the id parameter.

Enumerator
HeldForReview	Retrieve comment threads that are awaiting review by a moderator. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment are awaiting review.
LikelySpam	Retrieve comment threads classified as likely to be spam. A comment thread can be included in the response if the top-level comment or at least one of the replies to that comment is considered likely to be spam.
Published	Retrieve threads of published comments. This is the default value. A comment thread can be included in the response if its top-level comment has been published.

◆ OrderEnum

enum Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.OrderEnum

strong

The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

Enumerator
Relevance	Order by relevance.
Time	Order by time.

◆ TextFormatEnum

enum Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.TextFormatEnum

strong

Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

Enumerator
Html	Returns the comments in HTML format. This is the default value.
PlainText	Returns the comments in plain text format.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.ListRequest	(	Google.Apis.Services.IClientService	service,
		string	part
	)

inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.InitParameters ( )

inlineprotected

Initializes List parameter list.

Property Documentation

◆ AllThreadsRelatedToChannelId

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.AllThreadsRelatedToChannelId

getset

The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.

◆ ChannelId

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.ChannelId

getset

The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.)

◆ HttpMethod

override string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

◆ Id

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.Id

getset

The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

◆ MaxResults

virtual System.Nullable<long> Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.MaxResults

getset

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is not supported for use in conjunction with the id parameter.

[default: 20] [minimum: 1] [maximum: 100]

◆ MethodName

override string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.MethodName

get

summary>Gets the HTTP method.

◆ ModerationStatus

virtual System.Nullable<ModerationStatusEnum> Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.ModerationStatus

getset

Set this parameter to limit the returned comment threads to a particular moderation state.

Note: This parameter is not supported for use in conjunction with the id parameter.

[default: MODERATION_STATUS_PUBLISHED]

◆ Order

virtual System.Nullable<OrderEnum> Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.Order

getset

The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

[default: true]

◆ PageToken

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.PageToken

getset

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.

Note: This parameter is not supported for use in conjunction with the id parameter.

◆ Part

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.Part

get

The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.

◆ SearchTerms

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.SearchTerms

getset

The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.

Note: This parameter is not supported for use in conjunction with the id parameter.

◆ TextFormat

virtual System.Nullable<TextFormatEnum> Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.TextFormat

getset

Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

[default: FORMAT_HTML]

◆ VideoId

virtual string Google.Apis.YouTube.v3.CommentThreadsResource.ListRequest.VideoId

getset

The videoId parameter instructs the API to return comment threads associated with the specified video ID.

summary>Gets the method name.

The documentation for this class was generated from the following file:

Google.Apis.YouTube.v3.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ModerationStatusEnum

◆ OrderEnum

◆ TextFormatEnum

Constructor & Destructor Documentation

◆ ListRequest()

Member Function Documentation

◆ InitParameters()

Property Documentation

◆ AllThreadsRelatedToChannelId

◆ ChannelId

◆ HttpMethod

◆ Id

◆ MaxResults

◆ MethodName

◆ ModerationStatus

◆ Order

◆ PageToken

◆ Part

◆ SearchTerms

◆ TextFormat

◆ VideoId