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

NAME

Imgur::API::Endpoint::Album

SYNOPSISA

Access to the imgur Album API Endpoint. 

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

METHODS

get(%params)

Get information about a specific album.

Parameters =over 4

  • album REQUIRED Album

images(%params)

Return all of the images in the album

Parameters =over 4

  • album REQUIRED Album

image(%params)

Get information about an image in an album, any additional actions found in Image Endpoint will also work.

Parameters =over 4

  • album REQUIRED Album

  • image REQUIRED Image

upload(%params)

Create a new album. Optional parameter of ids[] is an array of image ids to add to the album. array of image ids to add to the album. If uploading anonymous images to anonymous album please use the optional parameter of deletehashes[] rather than ids[]. Note: including the optional deletehashes[] parameter will also work for authenticated user albums. There is no need to duplicate image ids with their corresponding deletehash. This method is available without authenticating an account, and may be used merely by sending "Authorization: Client-ID {client_id}" in the request headers. Doing so will create an anonymous album which is not tied to an account.

Parameters =over 4

  • privacy OPTIONAL Sets the privacy level of the album. Values are : public | hidden | secret. Defaults to user's privacy settings for logged in users.

  • cover OPTIONAL The ID of an image that you want to be the cover of the album

  • layout OPTIONAL Sets the layout to display the album. Values are : blog | grid | horizontal | vertical

  • ids[] OPTIONAL The image ids that you want to be included in the album.

  • description OPTIONAL The description of the album

  • title OPTIONAL The title of the album

  • deletehashes[] OPTIONAL The deletehashes of the images that you want to be included in the album.

update(%params)

Update the information of an album. For anonymous albums, {album} should be the deletehash that is returned at creation. If uploading anonymous images to anonymous album please use the optional parameter of deletehashes[] rather than ids[]. Note: including the optional deletehashes[] parameter will also work for authenticated user albums. There is no need to duplicate image ids with their corresponding deletehash.

Parameters =over 4

  • title OPTIONAL The title of the album

  • album REQUIRED Album

  • privacy OPTIONAL Sets the privacy level of the album. Values are : public | hidden | secret

  • layout OPTIONAL Sets the layout to display the album. Values are : blog | grid | horizontal | vertical

  • deletehashes[] OPTIONAL The deletehashes of the images that you want to be included in the album.

  • cover OPTIONAL The ID of an image that you want to be the cover of the album

  • ids[] OPTIONAL The image ids that you want to be included in the album.

  • description OPTIONAL The description of the album

delete(%params)

Delete an album with a given ID. You are required to be logged in as the user to delete the album. For anonymous albums, {album} should be the deletehash that is returned at creation.

Parameters =over 4

  • album REQUIRED Album

favorite(%params)

Favorite an album with a given ID. The user is required to be logged in to favorite the album.

Parameters =over 4

  • album REQUIRED Album

setTo(%params)

Sets the images for an album, removes all other images and only uses the images in this request. For anonymous albums, {album} should be the deletehash that is returned at creation. If uploading anonymous images to anonymous album please use the optional parameter of deletehashes[] rather than ids[]. Note: including the optional deletehashes[] parameter will also work for authenticated user albums. There is no need to duplicate image ids with their corresponding deletehash.

Parameters =over 4

  • ids[] OPTIONAL The image ids that you want to be added to the album. The [] represents the ability to use this variable as an array.

  • deletehashes[] OPTIONAL The image deletehashes that you want to be added to the album. The [] represents the ability to use this variable as an array.

  • album REQUIRED Album

addTo(%params)

For anonymous albums, {album} should be the deletehash that is returned at creation. If uploading anonymous images to anonymous album please use the optional parameter of deletehashes[] rather than ids[]. Note: including the optional deletehashes[] parameter will also work for authenticated user albums. There is no need to duplicate image ids with their corresponding deletehash.

Parameters =over 4

  • ids[] OPTIONAL The image ids that you want to be added to the album. The [] represents the ability to use this variable as an array.

  • album REQUIRED Album

  • deletehashes[] OPTIONAL The image deletehashes that you want to be added to the album. The [] represents the ability to use this variable as an array.

removeFrom(%params)

Takes parameter, ids[], as an array of ids and removes from the album. For anonymous albums, {album} should be the deletehash that is returned at creation.

Parameters =over 4

  • album REQUIRED Album

  • ids[] REQUIRED The image ids that you want to be removed from the album.

10 POD Errors

The following errors were encountered while parsing the POD:

Around line 22:

'=item' outside of any '=over'

Around line 36:

'=item' outside of any '=over'

Around line 50:

'=item' outside of any '=over'

Around line 68:

'=item' outside of any '=over'

Around line 106:

'=item' outside of any '=over'

Around line 148:

'=item' outside of any '=over'

Around line 162:

'=item' outside of any '=over'

Around line 176:

'=item' outside of any '=over'

Around line 198:

'=item' outside of any '=over'

Around line 220:

'=item' outside of any '=over'