Class CommentThreadsResource.ListRequest

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

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<CommentThreadListResponse>
YouTubeBaseServiceRequest<CommentThreadListResponse>
CommentThreadsResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ListRequest : YouTubeBaseServiceRequest<CommentThreadListResponse>, IClientServiceRequest<CommentThreadListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string part)
Parameters
Type Name Description
IClientService service
System.String part

Properties

AllThreadsRelatedToChannelId

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.

Declaration
[RequestParameter("allThreadsRelatedToChannelId", RequestParameterType.Query)]
public virtual string AllThreadsRelatedToChannelId { get; set; }
Property Value
Type Description
System.String

ChannelId

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.)

Declaration
[RequestParameter("channelId", RequestParameterType.Query)]
public virtual string ChannelId { get; set; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.CommentThreadListResponse>.HttpMethod

Id

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

Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { get; set; }
Property Value
Type Description
System.String

MaxResults

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.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.CommentThreadListResponse>.MethodName

ModerationStatus

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.

Declaration
[RequestParameter("moderationStatus", RequestParameterType.Query)]
public virtual CommentThreadsResource.ListRequest.ModerationStatusEnum? ModerationStatus { get; set; }
Property Value
Type Description
System.Nullable<CommentThreadsResource.ListRequest.ModerationStatusEnum>

Order

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.

Declaration
[RequestParameter("order", RequestParameterType.Query)]
public virtual CommentThreadsResource.ListRequest.OrderEnum? Order { get; set; }
Property Value
Type Description
System.Nullable<CommentThreadsResource.ListRequest.OrderEnum>

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

Part

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

Declaration
[RequestParameter("part", RequestParameterType.Query)]
public virtual string Part { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTube.v3.Data.CommentThreadListResponse>.RestPath

SearchTerms

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.

Declaration
[RequestParameter("searchTerms", RequestParameterType.Query)]
public virtual string SearchTerms { get; set; }
Property Value
Type Description
System.String

TextFormat

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.

Declaration
[RequestParameter("textFormat", RequestParameterType.Query)]
public virtual CommentThreadsResource.ListRequest.TextFormatEnum? TextFormat { get; set; }
Property Value
Type Description
System.Nullable<CommentThreadsResource.ListRequest.TextFormatEnum>

VideoId

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

Declaration
[RequestParameter("videoId", RequestParameterType.Query)]
public virtual string VideoId { get; set; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.YouTube.v3.YouTubeBaseServiceRequest<Google.Apis.YouTube.v3.Data.CommentThreadListResponse>.InitParameters()

Implements