C# Class Imgur.API.Endpoints.Impl.CustomGalleryEndpoint

Custom Gallery related actions.
Inheritance: EndpointBase, ICustomGalleryEndpoint
Show file Open project: DamienDennehy/Imgur.API Class Usage Examples

Private Properties

Property Type Description
CustomGalleryEndpoint System

Public Methods

Method Description
AddCustomGalleryTagsAsync ( IEnumerable tags ) : Task

Add tags to a user's custom gallery. OAuth authentication required.
AddFilteredOutGalleryTagAsync ( string tag ) : Task

Add tags to filter out. OAuth authentication required.
CustomGalleryEndpoint ( IApiClient apiClient ) : System

Initializes a new instance of the CustomGalleryEndpoint class.
GetCustomGalleryAsync ( CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task

View images for current user's custom gallery. OAuth authentication required.
GetCustomGalleryItemAsync ( string galleryItemId ) : Task

View a single item in a user's custom gallery. OAuth authentication required.
GetFilteredOutGalleryAsync ( CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task

Retrieve user's filtered out gallery. OAuth authentication required.
RemoveCustomGalleryTagsAsync ( IEnumerable tags ) : Task

Remove tags from a custom gallery. OAuth authentication required.
RemoveFilteredOutGalleryTagAsync ( string tag ) : Task

Remove a filtered out tag. OAuth authentication required.

Private Methods

Method Description
CustomGalleryEndpoint ( IApiClient apiClient, HttpClient httpClient ) : System

Initializes a new instance of the CustomGalleryEndpoint class.

Method Details

AddCustomGalleryTagsAsync() public method

Add tags to a user's custom gallery. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public AddCustomGalleryTagsAsync ( IEnumerable tags ) : Task
tags IEnumerable The tags that should be added.
return Task

AddFilteredOutGalleryTagAsync() public method

Add tags to filter out. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public AddFilteredOutGalleryTagAsync ( string tag ) : Task
tag string The tag that should be filtered out.
return Task

CustomGalleryEndpoint() public method

Initializes a new instance of the CustomGalleryEndpoint class.
public CustomGalleryEndpoint ( IApiClient apiClient ) : System
apiClient IApiClient The type of client that will be used for authentication.
return System

GetCustomGalleryAsync() public method

View images for current user's custom gallery. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public GetCustomGalleryAsync ( CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task
sort CustomGallerySortOrder The order that the gallery should be sorted by. Default: Viral
window TimeWindow The time period that should be used in filtering requests. Default: Week
page int Set the page number so you don't have to retrieve all the data at once. Default: null
return Task

GetCustomGalleryItemAsync() public method

View a single item in a user's custom gallery. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public GetCustomGalleryItemAsync ( string galleryItemId ) : Task
galleryItemId string The gallery item id.
return Task

GetFilteredOutGalleryAsync() public method

Retrieve user's filtered out gallery. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public GetFilteredOutGalleryAsync ( CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task
sort CustomGallerySortOrder The order that the gallery should be sorted by. Default: Viral
window TimeWindow The time period that should be used in filtering requests. Default: Week
page int Set the page number so you don't have to retrieve all the data at once. Default: null
return Task

RemoveCustomGalleryTagsAsync() public method

Remove tags from a custom gallery. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public RemoveCustomGalleryTagsAsync ( IEnumerable tags ) : Task
tags IEnumerable The tags that should be removed.
return Task

RemoveFilteredOutGalleryTagAsync() public method

Remove a filtered out tag. OAuth authentication required.
/// Thrown when a null reference is passed to a method that does not accept it as a /// valid argument. /// Thrown when an error is found in a response from an Imgur endpoint. Thrown when an error is found in a response from a Mashape endpoint.
public RemoveFilteredOutGalleryTagAsync ( string tag ) : Task
tag string The tag that should be removed.
return Task