C# Class Pixum.API.Services.Album

Holds Album specific methods.

Inheritance: PixumApiBase

显示文件 Open project: Pixum/Pixum.API-csharp Class Usage Examples

Public Methods

Method	Description
CreateAlbum ( string title, string description = null, string sharingStatus = null, string sharingPassword = null ) : Task	Creates a new album.
DeleteAlbum ( int albumId ) : Task>	Deletes a album.
GetAlbum ( string albumId ) : Task	Gets data for a single album.
GetAlbumImages ( string albumId, int start, int limit = 25, string order = "upload" ) : Task	Returns the images from an album.
GetAlbums ( int start, int limit = 25, bool withInbox = true, bool withInboxFilter = false, bool withTrash = true, bool withAlbum = true, bool withSharedAlbum = false ) : Task	Get the albums from a user.
SetAlbumData ( int albumId, string title = null, string description = null, int coverImageId = null ) : Task>	Updates album information.

Private Methods

Method	Description
Album ( IRestClient client ) : System

Method Details

CreateAlbum() public method

Creates a new album.

public CreateAlbum ( string title, string description = null, string sharingStatus = null, string sharingPassword = null ) : Task
title	string	The title for the album.
description	string	The description for the album.
sharingStatus	string	The sharing status for the album.
sharingPassword	string	A password for the album used when shared.
return	Task

DeleteAlbum() public method

Deletes a album.

public DeleteAlbum ( int albumId ) : Task>
albumId	int	The album for the to be deleted album.
return	Task>

GetAlbum() public method

Gets data for a single album.

public GetAlbum ( string albumId ) : Task
albumId	string	The albumId of the album.
return	Task

GetAlbumImages() public method

Returns the images from an album.

public GetAlbumImages ( string albumId, int start, int limit = 25, string order = "upload" ) : Task
albumId	string	The id of the album.
start	int	Start position of images.
limit	int	Result limit.
order	string	Order of the result.
return	Task

GetAlbums() public method

Get the albums from a user.

public GetAlbums ( int start, int limit = 25, bool withInbox = true, bool withInboxFilter = false, bool withTrash = true, bool withAlbum = true, bool withSharedAlbum = false ) : Task
start	int	Start position.
limit	int	Result limit.
withInbox	bool	Include Inbox.
withInboxFilter	bool	Include Inbox Filter.
withTrash	bool	Include Trash.
withAlbum	bool	Include Albums.
withSharedAlbum	bool	Include shared albums.
return	Task

SetAlbumData() public method

Updates album information.

public SetAlbumData ( int albumId, string title = null, string description = null, int coverImageId = null ) : Task>
albumId	int	The id of the album.
title	string	The new title.
description	string	The new description.
coverImageId	int	The new cover image.
return	Task>