Class CommentsResource.ListRequest
Returns a list of comments that match the API request parameters.
Inheritance
Inherited Members
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ListRequest : YouTubeBaseServiceRequest<CommentListResponse>, IClientServiceRequest<CommentListResponse>, IClientServiceRequestConstructors
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
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Id
The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.
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
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 |
ParentId
The parentId parameter specifies the ID of the comment for which replies should be retrieved.
Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.
Declaration
[RequestParameter("parentId", RequestParameterType.Query)]
public virtual string ParentId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Part
The part parameter specifies a comma-separated list of one or more comment 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
TextFormat
This parameter indicates whether the API should return comments formatted as HTML or as plain text.
Declaration
[RequestParameter("textFormat", RequestParameterType.Query)]
public virtual CommentsResource.ListRequest.TextFormatEnum? TextFormat { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<CommentsResource.ListRequest.TextFormatEnum> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()