Class VolumesResource.ListRequest

Performs a book search.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Volumes>
BooksBaseServiceRequest<Volumes>
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)

Constructs a new List request.

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

Properties

Download

Restrict to volumes by download availability.

Declaration
[RequestParameter("download", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.DownloadEnum? Download { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.DownloadEnum>

Filter

Filter search results.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.FilterEnum? Filter { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.FilterEnum>

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

LangRestrict

Restrict results to books with this language code.

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

LibraryRestrict

Restrict search to this user's library.

Declaration
[RequestParameter("libraryRestrict", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.LibraryRestrictEnum? LibraryRestrict { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.LibraryRestrictEnum>

MaxAllowedMaturityRating

The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

Declaration
[RequestParameter("maxAllowedMaturityRating", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.MaxAllowedMaturityRatingEnum? MaxAllowedMaturityRating { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.MaxAllowedMaturityRatingEnum>

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

OrderBy

Sort search results.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.OrderByEnum>

Partner

Restrict and brand results for partner ID.

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

PrintType

Restrict to books or magazines.

Declaration
[RequestParameter("printType", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.PrintTypeEnum? PrintType { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.PrintTypeEnum>

Projection

Restrict information returned to a set of selected fields.

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
System.Nullable<VolumesResource.ListRequest.ProjectionEnum>

Q

Full-text search query string.

Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { 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.Books.v1.Data.Volumes>.RestPath

ShowPreorders

Set to true to show books available for preorder. 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 result to return (starts at 0)

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

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