Class MylibraryResource.AnnotationsResource.ListRequest

Retrieves a list of annotations, possibly filtered.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Annotations>
BooksBaseServiceRequest<Annotations>
MylibraryResource.AnnotationsResource.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<Annotations>, IClientServiceRequest<Annotations>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

ContentVersion

The content version for the requested volume.

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

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

LayerId

The layer ID to limit annotation by.

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

LayerIds

The layer ID(s) to limit annotation by.

Declaration
[RequestParameter("layerIds", RequestParameterType.Query)]
public virtual Repeatable<string> LayerIds { get; set; }
Property Value
Type Description
Repeatable<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.Annotations>.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.Annotations>.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
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

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 restrict annotations to.

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

Methods

InitParameters()

Initializes List parameter list.

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

Implements