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

Topic related actions.
Inheritance: EndpointBase, ITopicEndpoint
Show file Open project: DamienDennehy/Imgur.API Class Usage Examples

Private Properties

Property Type Description
TopicEndpoint System

Public Methods

Method Description
GetDefaultTopicsAsync ( ) : Task>

Get the list of default topics.
GetGalleryTopicItemAsync ( string galleryItemId, string topicId ) : Task

View a single item in a gallery topic.
GetGalleryTopicItemsAsync ( string topicId, CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task>

View gallery items for a topic.
TopicEndpoint ( IApiClient apiClient ) : System

Initializes a new instance of the TopicEndpoint class.

Private Methods

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

Initializes a new instance of the TopicEndpoint class.

Method Details

GetDefaultTopicsAsync() public method

Get the list of default topics.
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 GetDefaultTopicsAsync ( ) : Task>
return Task>

GetGalleryTopicItemAsync() public method

View a single item in a gallery topic.
/// 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 GetGalleryTopicItemAsync ( string galleryItemId, string topicId ) : Task
galleryItemId string The gallery item id.
topicId string /// The ID or URL-formatted name of the topic. If using a topic's name, replace its spaces with /// underscores (Mother's_Day). ///
return Task

GetGalleryTopicItemsAsync() public method

View gallery items for a topic.
/// 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 GetGalleryTopicItemsAsync ( string topicId, CustomGallerySortOrder sort = CustomGallerySortOrder.Viral, TimeWindow window = TimeWindow.Week, int page = null ) : Task>
topicId string /// The ID or URL-formatted name of the topic. If using a topic's name, replace its spaces with /// underscores (Mother's_Day). ///
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 The data paging number. Default: null
return Task>

TopicEndpoint() public method

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