C# 클래스 Pixum.API.Services.Album

Holds Album specific methods.

상속: PixumApiBase

파일 보기 프로젝트 열기: Pixum/Pixum.API-csharp 1 사용 예제들

공개 메소드들

메소드	설명
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.

비공개 메소드들

메소드	설명
Album ( IRestClient client ) : System

메소드 상세

CreateAlbum() 공개 메소드

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.
리턴	Task

DeleteAlbum() 공개 메소드

Deletes a album.

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

GetAlbum() 공개 메소드

Gets data for a single album.

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

GetAlbumImages() 공개 메소드

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.
리턴	Task

GetAlbums() 공개 메소드

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.
리턴	Task

SetAlbumData() 공개 메소드

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.
리턴	Task>