Class BookshelvesResource.VolumesResource.ListRequest

Retrieves volumes in a specific bookshelf for the specified user.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Volumes>
BooksBaseServiceRequest<Volumes>
BookshelvesResource.VolumesResource.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.Books.v1
Assembly: Google.Apis.Books.v1.dll
Syntax
public class ListRequest : BooksBaseServiceRequest<Volumes>, IClientServiceRequest<Volumes>, IClientServiceRequest

Constructors

ListRequest(IClientService, String, String)

Constructs a new List request.

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

Properties

HttpMethod

Gets the HTTP method.

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

MaxResults

Maximum number of results to return

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.Books.v1.Data.Volumes>.MethodName

RestPath

Gets the REST path.

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

Shelf

ID of bookshelf to retrieve volumes.

Declaration
[RequestParameter("shelf", RequestParameterType.Path)]
public virtual string Shelf { get; }
Property Value
Type Description
System.String

ShowPreorders

Set to true to show pre-ordered books. Defaults to false.

Declaration
[RequestParameter("showPreorders", RequestParameterType.Query)]
public virtual bool? ShowPreorders { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Source

String to identify the originator of this request.

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

StartIndex

Index of the first element to return (starts at 0)

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

UserId

ID of user for whom to retrieve bookshelf volumes.

Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }
Property Value
Type Description
System.String

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Books.v1.BooksBaseServiceRequest<Google.Apis.Books.v1.Data.Volumes>.InitParameters()

Implements