Class LayersResource.VolumeAnnotationsResource.ListRequest

Gets the volume annotations for a volume and layer.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Volumeannotations>
BooksBaseServiceRequest<Volumeannotations>
LayersResource.VolumeAnnotationsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Books.v1
Assembly: Google.Apis.Books.v1.dll
Syntax
public class LayersResource.VolumeAnnotationsResource.ListRequest : BooksBaseServiceRequest<Volumeannotations>, IClientServiceRequest<Volumeannotations>, 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

ContentVersion

The content version for the requested volume.

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

EndOffset

The end offset to end retrieving data from.

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

EndPosition

The end position to end retrieving data from.

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

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

LayerId

The ID for the layer to get the annotations.

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

ShowDeleted

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual bool? ShowDeleted { 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

StartOffset

The start offset to start retrieving data from.

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

StartPosition

The start position to start retrieving data from.

Declaration
[RequestParameter("startPosition", RequestParameterType.Query)]
public virtual string StartPosition { 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

VolumeAnnotationsVersion

The version of the volume annotations that you are requesting.

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

VolumeId

The volume to retrieve annotations for.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements