C# Class ImgurNet.ApiEndpoints.AlbumEndpoint

Inheritance: BaseEndpoint

Show file Open project: 0xdeafcafe/ImgurNet Class Usage Examples

Public Methods

Method	Description
AddImageToAlbumAsync ( string albumId, string imageId ) : Task>	Adds an image to an album. Must be authenticated using OAuth2Authentication to call this Endpoint
AddImagesToAlbumAsync ( string albumId, string imageIds ) : Task>	Adds images to an album. Must be authenticated using OAuth2Authentication to call this Endpoint
AlbumEndpoint ( Imgur imgur ) : System
CreateAlbumAsync ( Image images = null, Image coverImage = null, string title = null, string description = null, Privacy privacy = Privacy.Public, AlbumLayout layout = AlbumLayout.Blog ) : Task>	Creates an album on imgur, if authorized with OAuth2Authentication then it will be added to the authorised.
CreateAlbumFromIdsAsync ( string imageIds = null, string coverImageId = null, string title = null, string description = null, Privacy privacy = Privacy.Public, AlbumLayout layout = AlbumLayout.Blog ) : Task>	Creates an album on imgur, if authorized with OAuth2Authentication then it will be added to the authorised.
DeleteAlbumAsync ( string albumDeletionHash ) : Task>	Delete an album with a deletion hash
FavouriteAlbumAsync ( string albumId ) : Task>	Adds/Removes an album from the authenticated user's favourites. Must be authenticated using OAuth2Authentication to call this Endpoint.
GetAlbumDetailsAsync ( string albumId ) : Task>	Get information about a specific album.
GetAllImagesFromAlbumAsync ( string albumId ) : Task>	Get a list of images in a specific album.
RemoveImageFromAlbumAsync ( string albumId, string imageId ) : Task>	Removes an image from an album. Must be authenticated using OAuth2Authentication to call this Endpoint
RemoveImagesFromAlbumAsync ( string albumId, string imageIds ) : Task>	Removes images from an album. Must be authenticated using OAuth2Authentication to call this Endpoint

Method Details

AddImageToAlbumAsync() public method

Adds an image to an album. Must be authenticated using OAuth2Authentication to call this Endpoint

public AddImageToAlbumAsync ( string albumId, string imageId ) : Task>
albumId	string	The AlbumId of the album you want to add an image to
imageId	string	An image id to add to the album
return	Task>

AddImagesToAlbumAsync() public method

Adds images to an album. Must be authenticated using OAuth2Authentication to call this Endpoint

public AddImagesToAlbumAsync ( string albumId, string imageIds ) : Task>
albumId	string	The AlbumId of the album you want to add images to
imageIds	string	A collection of image ids to add to the album
return	Task>

AlbumEndpoint() public method

public AlbumEndpoint ( Imgur imgur ) : System
imgur	Imgur
return	System

CreateAlbumAsync() public method

Creates an album on imgur, if authorized with OAuth2Authentication then it will be added to the authorised.

public CreateAlbumAsync ( Image images = null, Image coverImage = null, string title = null, string description = null, Privacy privacy = Privacy.Public, AlbumLayout layout = AlbumLayout.Blog ) : Task>
images	Image	A collection of valid Image's that should be added to this album.
coverImage	Image	An Imgur Image that want to be the cover of the album (has to be in )
title	string	The title of the album
description	string	The description of the album
privacy	Privacy	The privacy mode of the album
layout	AlbumLayout	The defualt layout of the album
return	Task>

CreateAlbumFromIdsAsync() public method

Creates an album on imgur, if authorized with OAuth2Authentication then it will be added to the authorised.

public CreateAlbumFromIdsAsync ( string imageIds = null, string coverImageId = null, string title = null, string description = null, Privacy privacy = Privacy.Public, AlbumLayout layout = AlbumLayout.Blog ) : Task>
imageIds	string	A collection of ImageId's for valid imgur images that should be added to this album.
coverImageId	string	The ImageId of the image you want to be the cover of the album (has to be in )
title	string	The title of the album
description	string	The description of the album
privacy	Privacy	The privacy mode of the album
layout	AlbumLayout	The defualt layout of the album
return	Task>

DeleteAlbumAsync() public method

Delete an album with a deletion hash

public DeleteAlbumAsync ( string albumDeletionHash ) : Task>
albumDeletionHash	string	The deletion hash of the album
return	Task>

FavouriteAlbumAsync() public method

Adds/Removes an album from the authenticated user's favourites. Must be authenticated using OAuth2Authentication to call this Endpoint.

public FavouriteAlbumAsync ( string albumId ) : Task>
albumId	string	The AlbumId of the album you want to favourite.
return	Task>

GetAlbumDetailsAsync() public method

Get information about a specific album.

public GetAlbumDetailsAsync ( string albumId ) : Task>
albumId	string	The id of the album you are requesting.
return	Task>

GetAllImagesFromAlbumAsync() public method

Get a list of images in a specific album.

public GetAllImagesFromAlbumAsync ( string albumId ) : Task>
albumId	string	The id of the album you are requesting images from.
return	Task>

RemoveImageFromAlbumAsync() public method

Removes an image from an album. Must be authenticated using OAuth2Authentication to call this Endpoint

public RemoveImageFromAlbumAsync ( string albumId, string imageId ) : Task>
albumId	string	The AlbumId of the album you want to remove an image from
imageId	string	An image id to remove from the album
return	Task>

RemoveImagesFromAlbumAsync() public method

Removes images from an album. Must be authenticated using OAuth2Authentication to call this Endpoint

public RemoveImagesFromAlbumAsync ( string albumId, string imageIds ) : Task>
albumId	string	The AlbumId of the album you want to remove images from
imageIds	string	A collection of image ids to remove from the album
return	Task>