Class LayersResource.AnnotationDataResource.ListRequest

Gets the annotation data for a volume and layer.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Annotationsdata>
BooksBaseServiceRequest<Annotationsdata>
LayersResource.AnnotationDataResource.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<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
System.String volumeId
System.String layerId
System.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<System.String>

ContentVersion

The content version for the requested volume.

Declaration
[RequestParameter("contentVersion", RequestParameterType.Query)]
public virtual string ContentVersion { get; }
Property Value
Type Description
System.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
System.Nullable<System.Int32>

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.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
System.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
System.String

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

Scale

The requested scale for the image.

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

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

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
System.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
System.String

VolumeId

The volume to retrieve annotation data for.

Declaration
[RequestParameter("volumeId", RequestParameterType.Path)]
public virtual string VolumeId { get; }
Property Value
Type Description
System.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
System.Nullable<System.Int32>

Methods

InitParameters()

Initializes List parameter list.

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

Implements