Show / Hide Table of Contents

Class MylibraryResource.BookshelvesResource

The "bookshelves" collection of methods.

Inheritance
object
MylibraryResource.BookshelvesResource
Inherited Members
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 MylibraryResource.BookshelvesResource

Constructors

BookshelvesResource(IClientService)

Constructs a new resource.

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

Properties

Volumes

Gets the Volumes resource.

Declaration
public virtual MylibraryResource.BookshelvesResource.VolumesResource Volumes { get; }
Property Value
Type Description
MylibraryResource.BookshelvesResource.VolumesResource

Methods

AddVolume(string, string)

Adds a volume to a bookshelf.

Declaration
public virtual MylibraryResource.BookshelvesResource.AddVolumeRequest AddVolume(string shelf, string volumeId)
Parameters
Type Name Description
string shelf

ID of bookshelf to which to add a volume.

string volumeId

ID of volume to add.

Returns
Type Description
MylibraryResource.BookshelvesResource.AddVolumeRequest

ClearVolumes(string)

Clears all volumes from a bookshelf.

Declaration
public virtual MylibraryResource.BookshelvesResource.ClearVolumesRequest ClearVolumes(string shelf)
Parameters
Type Name Description
string shelf

ID of bookshelf from which to remove a volume.

Returns
Type Description
MylibraryResource.BookshelvesResource.ClearVolumesRequest

Get(string)

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

Declaration
public virtual MylibraryResource.BookshelvesResource.GetRequest Get(string shelf)
Parameters
Type Name Description
string shelf

ID of bookshelf to retrieve.

Returns
Type Description
MylibraryResource.BookshelvesResource.GetRequest

List()

Retrieves a list of bookshelves belonging to the authenticated user.

Declaration
public virtual MylibraryResource.BookshelvesResource.ListRequest List()
Returns
Type Description
MylibraryResource.BookshelvesResource.ListRequest

MoveVolume(string, string, int)

Moves a volume within a bookshelf.

Declaration
public virtual MylibraryResource.BookshelvesResource.MoveVolumeRequest MoveVolume(string shelf, string volumeId, int volumePosition)
Parameters
Type Name Description
string shelf

ID of bookshelf with the volume.

string volumeId

ID of volume to move.

int volumePosition

Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)

Returns
Type Description
MylibraryResource.BookshelvesResource.MoveVolumeRequest

RemoveVolume(string, string)

Removes a volume from a bookshelf.

Declaration
public virtual MylibraryResource.BookshelvesResource.RemoveVolumeRequest RemoveVolume(string shelf, string volumeId)
Parameters
Type Name Description
string shelf

ID of bookshelf from which to remove a volume.

string volumeId

ID of volume to remove.

Returns
Type Description
MylibraryResource.BookshelvesResource.RemoveVolumeRequest
In this article
Back to top Generated by DocFX