NAME

Imgur::API::Endpoint::Album

DESCRIPTION

Access to the imgur Album API Endpoint.

METHODS

get

Get information about a specific album.

Parameters

• album required

  Album

images

Return all of the images in the album

Parameters

• album required

  Album

image

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

Parameters

• album required

  Album

• image required

  Image

upload

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

• title optional

  The title of the album

• deletehashes[] optional

  The deletehashes of the images that you want to be included in the album.

• description optional

  The description of the album

• ids[] optional

  The image ids that you want to be included in the album.

• layout optional

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

• 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

update

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

• 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

• ids[] optional

  The image ids that you want to be included in the album.

• description optional

  The description of the album

• deletehashes[] optional

  The deletehashes of the images that you want to be included in the album.

• title optional

  The title of the album

• cover optional

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

• album required

  Album

delete

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

• album required

  Album

favorite

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

Parameters

• album required

  Album

setTo

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

• 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.

• 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.

addTo

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

• 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.

• 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.

removeFrom

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

• ids[] required

  The image ids that you want to be removed from the album.

• album required

  Album

SEE ALSO

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

cpanm Imgur::API

perl -MCPAN -e shell
install Imgur::API