/ 
Imgur-API-0.0.1
River stage zero No dependents
/ Imgur::API::Endpoint::Gallery

NAME

Imgur::API::Endpoint::Gallery

SYNOPSISA

Access to the imgur Gallery API Endpoint. 

See: https://api.imgur.com/endpoints/gallery

METHODS

get(%params)

Returns the images in the gallery. For example the main gallery is https://api.imgur.com/3/gallery/hot/viral/0.json

Parameters =over 4

  • showViral OPTIONAL true | false - Show or hide viral images from the 'user' section. Defaults to true

  • section OPTIONAL hot | top | user - defaults to hot

  • window OPTIONAL Change the date range of the request if the section is "top", day | week | month | year | all, defaults to day

  • page OPTIONAL integer - the data paging number

  • sort OPTIONAL viral | top | time | rising (only available with user section) - defaults to viral

memeSubgallery(%params)

View images for memes subgallery

Parameters =over 4

  • window OPTIONAL Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • page OPTIONAL integer - the data paging number

  • sort OPTIONAL viral | time | top - defaults to viral

memeSubgalleryImage(%params)

View a single image in the memes gallery

Parameters =over 4

  • image_id REQUIRED The ID for the image.

subreddit(%params)

View gallery images for a subreddit

Parameters =over 4

  • page OPTIONAL integer - the data paging number

  • window OPTIONAL Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • sort OPTIONAL time | top - defaults to time

  • subreddit REQUIRED pics - A valid subreddit name

subredditImage(%params)

View a single image in the subreddit

Parameters =over 4

  • image_id REQUIRED The ID for the image.

  • subreddit REQUIRED pics - A valid subreddit name

tag(%params)

View images for a gallery tag

Parameters =over 4

  • sort OPTIONAL viral | time | top - defaults to viral

  • page OPTIONAL integer - the data paging number

  • window OPTIONAL Change the date range of the request if the sort is "top", day | week | month | year | all, defaults to week

  • t_name REQUIRED The name of the tag.

tagImage(%params)

View a single image in a gallery tag

Parameters =over 4

  • t_name REQUIRED The name of the tag.

  • image_id REQUIRED The ID for the image.

itemTags(%params)

View tags for a gallery item

Parameters =over 4

  • id REQUIRED ID of the gallery item

  • gallery REQUIRED Gallery

tagVote(%params)

Vote for a tag, 'up' or 'down' vote. Send the same value again to undo a vote.

Parameters =over 4

  • gallery REQUIRED Gallery

  • id REQUIRED ID of the gallery item

  • t_name REQUIRED Name of the tag (implicitly created, if doesn't exist)

  • vote REQUIRED 'up' or 'down'

updateGalleryTags(%params)

Update the tags for a post in the gallery

Parameters =over 4

  • gallery REQUIRED Gallery

  • id REQUIRED ID of the gallery item

  • tags REQUIRED The name of the tags you wish to associate with a post. Can be passed as tags[]=funny&tags[]=cat or tags=funny,cat/td>

search(%params)

Search the gallery with a given query string.

Parameters =over 4

  • sort OPTIONAL time | viral | top - defaults to time

  • window OPTIONAL Change the date range of the request if the sort is 'top', day | week | month | year | all, defaults to all.

  • page OPTIONAL integer - the data paging number

random(%params)

Returns a random set of gallery images.

Parameters =over 4

  • page OPTIONAL A page of random gallery images, from 0-50. Pages are regenerated every hour.

toGallery(%params)

Share an Album or Image to the Gallery.

Parameters =over 4

  • title REQUIRED The title of the image. This is required.

  • terms OPTIONAL If the user has not accepted our terms yet, this endpoint will return an error. To by-pass the terms in general simply set this value to 1.

  • gallery REQUIRED Gallery

  • topic OPTIONAL Topic name

  • mature OPTIONAL If the post is mature, set this value to 1.

  • tags[] OPTIONAL The name of the tags you wish to associate with a post. Can be passed as tags[]=funny&tags[]=cat or tags=funny,cat

fromGallery(%params)

Remove an image from the gallery. You must be logged in as the owner of the item to do this action.

Parameters =over 4

  • gallery REQUIRED Gallery

album(%params)

Get additional information about an album in the gallery.

Parameters =over 4

  • gallery REQUIRED Gallery

image(%params)

Get additional information about an image in the gallery.

Parameters =over 4

  • gallery REQUIRED Gallery

reporting(%params)

Report an Image in the gallery

Parameters =over 4

  • 2 REQUIRED

  • 4 REQUIRED

  • 1 REQUIRED

  • 3 REQUIRED

  • reason OPTIONAL An integer representing the reason for the report Value Description 1 Doesn't belong on Imgur 2 Spam 3 Abusive 4 Mature content not marked as mature 5 Pornography

  • 5 REQUIRED

votes(%params)

Get the vote information about an image

Parameters =over 4

  • gallery REQUIRED Gallery

voting(%params)

Vote for an image, 'up' or 'down' vote. Send 'veto' to undo a vote.

Parameters =over 4

  • vote REQUIRED Vote

  • gallery REQUIRED Gallery

comments(%params)

Comment on an image in the gallery.

Parameters =over 4

  • sort OPTIONAL best | top | new - defaults to best

  • gallery REQUIRED Gallery

comment(%params)

Information about a specific comment. This action also allows any of the additional actions provided in the Comment Endpoint.

Parameters =over 4

  • comment REQUIRED Comment

  • gallery REQUIRED Gallery

commentCreation(%params)

Create a comment for an image.

Parameters =over 4

  • comment REQUIRED The text of the comment.

  • gallery REQUIRED Gallery

commentReply(%params)

Reply to a comment that has been created for an image.

Parameters =over 4

  • commentReply REQUIRED CommentReply

  • gallery REQUIRED Gallery

  • comment REQUIRED The text you want to use as the reply.

commentIds(%params)

List all of the IDs for the comments on an image.

Parameters =over 4

  • gallery REQUIRED Gallery

commentCount(%params)

The number of comments on an Image.

Parameters =over 4

  • gallery REQUIRED Gallery

25 POD Errors

The following errors were encountered while parsing the POD:

Around line 22:

'=item' outside of any '=over'

Around line 52:

'=item' outside of any '=over'

Around line 74:

'=item' outside of any '=over'

Around line 88:

'=item' outside of any '=over'

Around line 114:

'=item' outside of any '=over'

Around line 132:

'=item' outside of any '=over'

Around line 158:

'=item' outside of any '=over'

Around line 176:

'=item' outside of any '=over'

Around line 194:

'=item' outside of any '=over'

Around line 220:

'=item' outside of any '=over'

Around line 243:

'=item' outside of any '=over'

Around line 265:

'=item' outside of any '=over'

Around line 279:

'=item' outside of any '=over'

Around line 313:

'=item' outside of any '=over'

Around line 327:

'=item' outside of any '=over'

Around line 341:

'=item' outside of any '=over'

Around line 355:

'=item' outside of any '=over'

Around line 402:

'=item' outside of any '=over'

Around line 416:

'=item' outside of any '=over'

Around line 434:

'=item' outside of any '=over'

Around line 452:

'=item' outside of any '=over'

Around line 470:

'=item' outside of any '=over'

Around line 488:

'=item' outside of any '=over'

Around line 510:

'=item' outside of any '=over'

Around line 524:

'=item' outside of any '=over'