| Maintainer: | Sebastian Kippe sebastian@kip.pe |
| Version: | 0.8.0 |
This module stores collections of pictures, called “albums”. Each folder at the root of the module is treated as an album, unless it starts with a dollar sign ($).
| Pictures | |
| Exports | |
| listPublicAlbums | List the public albums. |
| listPrivateAlbums | List the private albums. |
| openPublicAlbum | Open a public album. |
| openPrivateAlbum | Open a private album. |
| Album | An album is a collection of pictures. |
| Properties | |
| name | The Album name. |
| client | The <BaseClient> instance scopped on this album. |
| Functions | |
| store | Store a picture. |
| remove | Remove a picture. |
| list | List the pictures. |
| getPictureURL | Get the absolute URL of a picture. |
An album is a collection of pictures. If caching is enabled for an album (see <Album.open> code), consider the method <Album.close> to end caching the very album(s).
| Properties | |
| name | The Album name. |
| client | The <BaseClient> instance scopped on this album. |
| Functions | |
| store | Store a picture. |
| remove | Remove a picture. |
| list | List the pictures. |
| getPictureURL | Get the absolute URL of a picture. |
The Album name.
store: function( mimeType, name, data )
Store a picture.
If the picture belongs to a public album, this URL can be used to display the picture without authentication.
| mimeType | the picture MIME type. |
| name | the picture name. |
| data | the picture (expected as an `ArrayBuffer`). |
A promise, which will be fulfilled with the absolute URL of the newly uploaded picture (see getPictureURL).
Store a picture.
store: function( mimeType, name, data )
Remove a picture.
remove: function( name )
List the pictures.
list: function()
Get the absolute URL of a picture.
getPictureURL: function( name )