C# Class Pixum.API.Services.Image

Holds image specific methods.
Inheritance: PixumApiBase
显示文件 Open project: Pixum/Pixum.API-csharp

Public Methods

Method Description
DataCreate ( byte imageData, string filename, string albumId = null ) : Task

Uploads an image into an album.

DataDelete ( int imageIds ) : Task>

Deletes given images.

GetImage ( int imageId, bool withDescription = true ) : Task

Get image informations for given image id.

GetImageByPosition ( int position, int albumId, bool withDescription = true ) : Task

Get image informations for given image specified by its position in an album.

SetDescription ( int imageId, string description ) : Task

Sets the description for the given image.

SetRotation ( int imageId, ImageRotation degrees ) : Task

Sets the rotation for the given image.

SetTitle ( int imageId, string title ) : Task

Sets the title for the given image.

Private Methods

Method Description
Image ( IRestClient client ) : System.Threading.Tasks

Method Details

DataCreate() public method

Uploads an image into an album.
public DataCreate ( byte imageData, string filename, string albumId = null ) : Task
imageData byte Image data as a byte array.
filename string The filename of the image.
albumId string The album to upload the image into.
return Task

DataDelete() public method

Deletes given images.
public DataDelete ( int imageIds ) : Task>
imageIds int The ids for the images to delete.
return Task>

GetImage() public method

Get image informations for given image id.
public GetImage ( int imageId, bool withDescription = true ) : Task
imageId int The id of the image.
withDescription bool Include description.
return Task

GetImageByPosition() public method

Get image informations for given image specified by its position in an album.
public GetImageByPosition ( int position, int albumId, bool withDescription = true ) : Task
position int The position of the image.
albumId int The album where the image lives. Must be a number.
withDescription bool Include description.
return Task

SetDescription() public method

Sets the description for the given image.
public SetDescription ( int imageId, string description ) : Task
imageId int The id of the image.
description string The new description for the image.
return Task

SetRotation() public method

Sets the rotation for the given image.
public SetRotation ( int imageId, ImageRotation degrees ) : Task
imageId int The id of the image.
degrees ImageRotation The new rotation for the image. Can only be 0, 90, 180 or 270.
return Task

SetTitle() public method

Sets the title for the given image.
public SetTitle ( int imageId, string title ) : Task
imageId int The id of the image.
title string The new title for the image.
return Task