Show / Hide Table of Contents

Class LayersResource.AnnotationDataResource.ListRequest

Gets the annotation data for a volume and layer.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Annotationsdata>
BooksBaseServiceRequest<Annotationsdata>
LayersResource.AnnotationDataResource.ListRequest
Implements
IClientServiceRequest<Annotationsdata>
IClientServiceRequest
Inherited Members
BooksBaseServiceRequest<Annotationsdata>.Xgafv
BooksBaseServiceRequest<Annotationsdata>.AccessToken
BooksBaseServiceRequest<Annotationsdata>.Alt
BooksBaseServiceRequest<Annotationsdata>.Callback
BooksBaseServiceRequest<Annotationsdata>.Fields
BooksBaseServiceRequest<Annotationsdata>.Key
BooksBaseServiceRequest<Annotationsdata>.OauthToken
BooksBaseServiceRequest<Annotationsdata>.PrettyPrint
BooksBaseServiceRequest<Annotationsdata>.QuotaUser
BooksBaseServiceRequest<Annotationsdata>.UploadType
BooksBaseServiceRequest<Annotationsdata>.UploadProtocol
ClientServiceRequest<Annotationsdata>.Execute()
ClientServiceRequest<Annotationsdata>.ExecuteAsStream()
ClientServiceRequest<Annotationsdata>.ExecuteAsync()
ClientServiceRequest<Annotationsdata>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Annotationsdata>.ExecuteAsStreamAsync()
ClientServiceRequest<Annotationsdata>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Annotationsdata>.CreateRequest(bool?)
ClientServiceRequest<Annotationsdata>.GenerateRequestUri()
ClientServiceRequest<Annotationsdata>.GetBody()
ClientServiceRequest<Annotationsdata>.GetDefaultETagAction(string)
ClientServiceRequest<Annotationsdata>.ETagAction
ClientServiceRequest<Annotationsdata>.ModifyRequest
ClientServiceRequest<Annotationsdata>.ValidateParameters
ClientServiceRequest<Annotationsdata>.ApiVersion
ClientServiceRequest<Annotationsdata>.RequestParameters
ClientServiceRequest<Annotationsdata>.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 LayersResource.AnnotationDataResource.ListRequest : BooksBaseServiceRequest<Annotationsdata>, IClientServiceRequest<Annotationsdata>, IClientServiceRequest

Constructors

ListRequest(IClientService, string, string, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string volumeId, string layerId, string contentVersion)
Parameters
Type Name Description
IClientService service
string volumeId
string layerId
string contentVersion

Properties

AnnotationDataId

The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.

Declaration
[RequestParameter("annotationDataId", RequestParameterType.Query)]
public virtual Repeatable<string> AnnotationDataId { get; set; }
Property Value
Type Description
Repeatable<string>

ContentVersion

The content version for the requested volume.

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

H

The requested pixel height for any images. If height is provided width must also be provided.

Declaration
[RequestParameter("h", RequestParameterType.Query)]
public virtual int? H { get; set; }
Property Value
Type Description
int?

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.Annotationsdata>.HttpMethod

LayerId

The ID for the layer to get the annotation data.

Declaration
[RequestParameter("layerId", RequestParameterType.Path)]
public virtual string LayerId { get; }
Property Value
Type Description
string

Locale

The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

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

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.Annotationsdata>.MethodName

PageToken

The value of the nextToken from the previous page.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
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.Annotationsdata>.RestPath

Scale

The requested scale for the image.

Declaration
[RequestParameter("scale", RequestParameterType.Query)]
public virtual int? Scale { get; set; }
Property Value
Type Description
int?

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

UpdatedMax

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

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

UpdatedMin

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

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

VolumeId

The volume to retrieve annotation data for.

Declaration
[RequestParameter("volumeId", RequestParameterType.Path)]
public virtual string VolumeId { get; }
Property Value
Type Description
string

W

The requested pixel width for any images. If width is provided height must also be provided.

Declaration
[RequestParameter("w", RequestParameterType.Query)]
public virtual int? W { get; set; }
Property Value
Type Description
int?

Methods

InitParameters()

Initializes List parameter list.

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

Implements

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