Show / Hide Table of Contents

Class VolumesResource.ListRequest

Performs a book search.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Volumes>
BooksBaseServiceRequest<Volumes>
VolumesResource.ListRequest
Implements
IClientServiceRequest<Volumes>
IClientServiceRequest
Inherited Members
BooksBaseServiceRequest<Volumes>.Xgafv
BooksBaseServiceRequest<Volumes>.AccessToken
BooksBaseServiceRequest<Volumes>.Alt
BooksBaseServiceRequest<Volumes>.Callback
BooksBaseServiceRequest<Volumes>.Fields
BooksBaseServiceRequest<Volumes>.Key
BooksBaseServiceRequest<Volumes>.OauthToken
BooksBaseServiceRequest<Volumes>.PrettyPrint
BooksBaseServiceRequest<Volumes>.QuotaUser
BooksBaseServiceRequest<Volumes>.UploadType
BooksBaseServiceRequest<Volumes>.UploadProtocol
ClientServiceRequest<Volumes>.Execute()
ClientServiceRequest<Volumes>.ExecuteAsStream()
ClientServiceRequest<Volumes>.ExecuteAsync()
ClientServiceRequest<Volumes>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Volumes>.ExecuteAsStreamAsync()
ClientServiceRequest<Volumes>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Volumes>.CreateRequest(bool?)
ClientServiceRequest<Volumes>.GenerateRequestUri()
ClientServiceRequest<Volumes>.GetBody()
ClientServiceRequest<Volumes>.GetDefaultETagAction(string)
ClientServiceRequest<Volumes>.ETagAction
ClientServiceRequest<Volumes>.ModifyRequest
ClientServiceRequest<Volumes>.ValidateParameters
ClientServiceRequest<Volumes>.ApiVersion
ClientServiceRequest<Volumes>.RequestParameters
ClientServiceRequest<Volumes>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Books.v1
Assembly: Google.Apis.Books.v1.dll
Syntax
public class VolumesResource.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
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
VolumesResource.ListRequest.DownloadEnum?

Filter

Filter search results.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
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
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
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
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
long?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
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
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
string

PrintType

Restrict to books or magazines.

Declaration
[RequestParameter("printType", RequestParameterType.Query)]
public virtual VolumesResource.ListRequest.PrintTypeEnum? PrintType { get; set; }
Property Value
Type Description
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
VolumesResource.ListRequest.ProjectionEnum?

Q

Full-text search query string.

Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
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
bool?

Source

String to identify the originator of this request.

Declaration
[RequestParameter("source", RequestParameterType.Query)]
public virtual string Source { get; set; }
Property Value
Type Description
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
long?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
BooksBaseServiceRequest<Volumes>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX