Package | com.adobe.webapis.flickr.methodgroups |
Class | public class Photos |
Property | Defined by | ||
---|---|---|---|
licenses : Licenses
[read-only]
Provide read-only access to the Licenses method group in the Flickr API
| Photos | ||
notes : Notes
[read-only]
Provide read-only access to the Notes method group in the Flickr API
| Photos | ||
transform : Transform
[read-only]
Provide read-only access to the Transform method group in the Flickr API
| Photos | ||
upload : Upload
[read-only]
Provide read-only access to the Upload method group in the Flickr API
| Photos |
Method | Defined by | ||
---|---|---|---|
Photos(service:FlickrService)
Construct a new Blogs "method group" class
| Photos | ||
addTags(photo_id:String, tags:String):void
Add tags to a photo.
| Photos | ||
getAllContexts(photo_id:String):void
Returns all visble sets and pools the photo belongs to.
| Photos | ||
getContactsPhotos(count:Number = 10, just_friends:Boolean = false, single_photo:Boolean = false, include_self:Boolean = false):void
Fetch a list of recent photos from the calling users' contacts.
| Photos | ||
getContactsPublicPhotos(user_id:String, count:Number = 10, just_friends:Boolean = false, single_photo:Boolean = false, include_self:Boolean = false):void
Fetch a list of recent public photos from a users' contacts.
| Photos | ||
getContext(photo_id:String):void
Returns next and previous photos for a photo in a photostream.
| Photos | ||
getCounts(dates:Array = null, taken_dates:Array = null):void
Gets a list of photo counts for the given date ranges for the
calling user.
| Photos | ||
getExif(photo_id:String, secret:String = ""):void
Retrieves a list of EXIF/TIFF/GPS tags for a given photo.
| Photos | ||
getInfo(photo_id:String, secret:String = ""):void
Get information about a photo.
| Photos | ||
getNotInSet(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of your photos that are not part of any sets.
| Photos | ||
getPerms(photo_id:String):void
Get permissions for a photo.
| Photos | ||
getRecent(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of the latest public photos uploaded to flickr.
| Photos | ||
getSizes(photo_id:String):void
Returns the available sizes for a photo.
| Photos | ||
getUntagged(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of your photos with no tags.
| Photos | ||
removeTag(tag_id:String):void
Remove a tag from a photo.
| Photos | ||
search(user_id:String = "", tags:String = "", tag_mode:String = "any", text:String = "", min_upload_date:Date = null, max_upload_date:Date = null, min_taken_date:Date = null, max_taken_date:Date = null, license:Number = -1, extras:String = "", per_page:Number = 100, page:Number = 1, sort:String = "date-posted-desc"):void
Return a list of photos matching some criteria.
| Photos | ||
setDates(photo_id:String, date_posted:Date = null, date_taken:Date = null, date_taken_granularity:Number = 0):void
Set one or both of the dates for a photo.
| Photos | ||
setMeta(photo_id:String, title:String, description:String):void
Set the meta information for a photo.
| Photos | ||
setPerms(photo_id:String, is_public:Boolean, is_friend:Boolean, is_family:Boolean, perm_comment:int, perm_addmeta:int):void
Set permissions for a photo.
| Photos | ||
setTags(photo_id:String, tags:String):void
Set the tags for a photo.
| Photos |
Event | Summary | Defined by | ||
---|---|---|---|---|
Broadcast as a result of the addTags method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getAllContexts method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PhotoContext instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getContactsPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getContactsPublicPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getContext method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances. | Photos | |||
Broadcast as a result of the getCounts method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an array of PhotoCount instances When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getExif method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getInfo method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getNotInSet method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getPerms method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getRecent method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getSizes method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of PhotoSize instances When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the getUntagged method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instnace When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a result of the removeTag method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a search of the search method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instnace When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a search of the setDates method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a search of the setMeta method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a search of the setPerms method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos | |||
Broadcast as a search of the setTags method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance | Photos |
licenses | property |
licenses:Licenses
[read-only]Provide read-only access to the Licenses method group in the Flickr API
Implementation public function get licenses():Licenses
notes | property |
notes:Notes
[read-only]Provide read-only access to the Notes method group in the Flickr API
Implementation public function get notes():Notes
transform | property |
transform:Transform
[read-only]Provide read-only access to the Transform method group in the Flickr API
Implementation public function get transform():Transform
upload | property |
upload:Upload
[read-only]Provide read-only access to the Upload method group in the Flickr API
Implementation public function get upload():Upload
Photos | () | constructor |
public function Photos(service:FlickrService)
Construct a new Blogs "method group" class
Parametersservice:FlickrService — The FlickrService this method group
is associated with.
|
addTags | () | method |
public function addTags(photo_id:String, tags:String):void
Add tags to a photo. This method requires authentication with WRITE permission.
Parametersphoto_id:String — The id of the photo to add tags to.
|
|
tags:String — The tags to add to the photo.
|
See also
getAllContexts | () | method |
public function getAllContexts(photo_id:String):void
Returns all visble sets and pools the photo belongs to.
Parametersphoto_id:String — The photo to return information for.
|
See also
getContactsPhotos | () | method |
public function getContactsPhotos(count:Number = 10, just_friends:Boolean = false, single_photo:Boolean = false, include_self:Boolean = false):void
Fetch a list of recent photos from the calling users' contacts. This method requires authentication with READ permission.
Parameterscount:Number (default = 10 ) — (Optional) Number of photos to return. Defaults to 10, maximum 50.
This is only used if single_photo is not passed.
|
|
just_friends:Boolean (default = false ) — (Optional) Set as true to only show photos from friends and
family (excluding regular contacts).
|
|
single_photo:Boolean (default = false ) — (Optional) Only fetch one photo (the latest) per contact,
instead of all photos in chronological order.
|
|
include_self:Boolean (default = false ) — (Optional) Set to true to include photos from the calling user.
|
See also
getContactsPublicPhotos | () | method |
public function getContactsPublicPhotos(user_id:String, count:Number = 10, just_friends:Boolean = false, single_photo:Boolean = false, include_self:Boolean = false):void
Fetch a list of recent public photos from a users' contacts.
Parametersuser_id:String — The NSID of the user to fetch photos for.
|
|
count:Number (default = 10 ) — (Optional) Number of photos to return. Defaults to 10, maximum 50.
This is only used if single_photo is not passed.
|
|
just_friends:Boolean (default = false ) — (Optional) Set as true to only show photos from friends and
family (excluding regular contacts).
|
|
single_photo:Boolean (default = false ) — (Optional) Only fetch one photo (the latest) per contact,
instead of all photos in chronological order.
|
|
include_self:Boolean (default = false ) — (Optional) Set to true to include photos from user specified
by user_id
|
See also
getContext | () | method |
public function getContext(photo_id:String):void
Returns next and previous photos for a photo in a photostream.
Parametersphoto_id:String — The id of the photo to fetch the context for.
|
See also
getCounts | () | method |
public function getCounts(dates:Array = null, taken_dates:Array = null):void
Gets a list of photo counts for the given date ranges for the calling user. This method requires authentication with READ permission.
Parametersdates:Array (default = null ) — (Optional) A list of Date objects, specified earliest first
|
|
taken_dates:Array (default = null ) — (Optional) A list of Date objects, specified earliest
first
|
See also
getExif | () | method |
public function getExif(photo_id:String, secret:String = ""):void
Retrieves a list of EXIF/TIFF/GPS tags for a given photo. The calling user must have permission to view the photo.
Parametersphoto_id:String — The id of the photo to fetch information for.
|
|
secret:String (default = " ") — (Optional) The secret for the photo. If the correct secret
is passed then permissions checking is skipped. This enables
the 'sharing' of individual photos by passing around the id
and secret.
|
See also
getInfo | () | method |
public function getInfo(photo_id:String, secret:String = ""):void
Get information about a photo. The calling user must have permission to view the photo.
Parametersphoto_id:String — The id of the photo to fetch information for.
|
|
secret:String (default = " ") — (Optional) The secret for the photo. If the correct secret
is passed then permissions checking is skipped. This enables
the 'sharing' of individual photos by passing around the id
and secret.
|
See also
getNotInSet | () | method |
public function getNotInSet(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of your photos that are not part of any sets. This method requires authentication with READ permission.
Parametersextras:String (default = " ") — (Optional) A comma-delimited list of extra information to
fetch for each returned record. Currently supported fields are:
license, date_upload, date_taken, owner_name, icon_server, and
original_format.
|
|
per_page:Number (default = 100 ) — (Optional) Number of photos to return per page. If this
argument is omitted, it defaults to 100. The maximum allowed
value is 500.
|
|
page:Number (default = 1 ) — (Optional) The page of results to return. If this argument
is omitted, it defaults to 1.
|
See also
getPerms | () | method |
public function getPerms(photo_id:String):void
Get permissions for a photo. This method requires authentication with READ permission.
Parametersphoto_id:String — The id of the photo to get permissions for.
|
See also
getRecent | () | method |
public function getRecent(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of the latest public photos uploaded to flickr.
Parametersextras:String (default = " ") — (Optional) A comma-delimited list of extra information to
fetch for each returned record. Currently supported fields are:
license, date_upload, date_taken, owner_name, icon_server, and
original_format.
|
|
per_page:Number (default = 100 ) — (Optional) Number of photos to return per page. If this
argument is omitted, it defaults to 100. The maximum allowed
value is 500.
|
|
page:Number (default = 1 ) — (Optional) The page of results to return. If this argument
is omitted, it defaults to 1.
|
See also
getSizes | () | method |
public function getSizes(photo_id:String):void
Returns the available sizes for a photo. The calling user must have permission to view the photo.
Parametersphoto_id:String — The id of the photo to get permissions for.
|
See also
getUntagged | () | method |
public function getUntagged(extras:String = "", per_page:Number = 100, page:Number = 1):void
Returns a list of your photos with no tags. This method requires authentication with READ permission.
Parametersextras:String (default = " ") — (Optional) A comma-delimited list of extra information to
fetch for each returned record. Currently supported fields are:
license, date_upload, date_taken, owner_name, icon_server, and
original_format.
|
|
per_page:Number (default = 100 ) — (Optional) Number of photos to return per page. If this
argument is omitted, it defaults to 100. The maximum allowed
value is 500.
|
|
page:Number (default = 1 ) — (Optional) The page of results to return. If this argument
is omitted, it defaults to 1.
|
See also
removeTag | () | method |
public function removeTag(tag_id:String):void
Remove a tag from a photo. This method requires authentication with WRITE permission.
Parameterstag_id:String — The tag to remove from the photo. This parameter should
be a tag id such as one returned by flickr.photos.getInfo
|
See also
search | () | method |
public function search(user_id:String = "", tags:String = "", tag_mode:String = "any", text:String = "", min_upload_date:Date = null, max_upload_date:Date = null, min_taken_date:Date = null, max_taken_date:Date = null, license:Number = -1, extras:String = "", per_page:Number = 100, page:Number = 1, sort:String = "date-posted-desc"):void
Return a list of photos matching some criteria. Only photos visible to the calling user will be returned. To return private or semi-private photos, the caller must be authenticated with 'read' permissions, and have permission to view the photos. Unauthenticated calls will only return public photos.
Parametersuser_id:String (default = " ") — (Optional) The NSID of the user who's photo to search.
If this parameter isn't passed then everybody's public photos
will be searched.
|
|
tags:String (default = " ") — (Optional) A comma-delimited list of tags. Photos with one
or more of the tags listed will be returned.
|
|
tag_mode:String (default = "any ") — (Optional) Either 'any' for an OR combination of tags,
or 'all' for an AND combination. Defaults to 'any' if not specified.
|
|
text:String (default = " ") — (Optional) A free text search. Photos who's title,
description or tags contain the text will be returned.
|
|
min_upload_date:Date (default = null ) — (Optional) Minimum upload date. Photos with an
upload date greater than or equal to this value will be returned.
|
|
max_upload_date:Date (default = null ) — (Optional) Maximum upload date. Photos with an
upload date less than or equal to this value will be returned.
|
|
min_taken_date:Date (default = null ) — (Optional) Minimum taken date. Photos with an taken
date greater than or equal to this value will be returned
|
|
max_taken_date:Date (default = null ) — (Optional) Maximum taken date. Photos with an taken
date less than or equal to this value will be returned.
|
|
license:Number (default = -1 ) — (Optional) The license id for photos (for possible values
see the flickr.photos.licenses.getInfo method).
|
|
extras:String (default = " ") — (Optional) A comma-delimited list of extra information to
fetch for each returned record. Currently supported fields are:
license, date_upload, date_taken, owner_name, icon_server, and
original_format.
|
|
per_page:Number (default = 100 ) — (Optional) Number of photos to return per page. If this
argument is omitted, it defaults to 100. The maximum allowed
value is 500.
|
|
page:Number (default = 1 ) — (Optional) The page of results to return. If this argument
is omitted, it defaults to 1.
|
|
sort:String (default = "date-posted-desc ") — (Optional) The order in which to sort returned photos.
Deafults to date-posted-desc. The possible values are:
date-posted-asc, date-posted-desc, date-taken-asc and
date-taken-desc.
|
See also
setDates | () | method |
public function setDates(photo_id:String, date_posted:Date = null, date_taken:Date = null, date_taken_granularity:Number = 0):void
Set one or both of the dates for a photo. This method requires authentication with WRITE permission.
Parametersphoto_id:String — The id of the photo to edit dates for.
|
|
date_posted:Date (default = null ) — (Optional) The date the photo was uploaded to flickr
|
|
date_taken:Date (default = null ) — (Optional) The date the photo was taken
|
|
date_taken_granularity:Number (default = 0 ) — (Optional) The granularity of the date
the photo was taken
|
See also
setMeta | () | method |
public function setMeta(photo_id:String, title:String, description:String):void
Set the meta information for a photo. This method requires authentication with WRITE permission.
Parametersphoto_id:String — The id of the photo to set information for.
|
|
title:String — The title for the photo.
|
|
description:String — The description for the photo.
|
See also
setPerms | () | method |
public function setPerms(photo_id:String, is_public:Boolean, is_friend:Boolean, is_family:Boolean, perm_comment:int, perm_addmeta:int):void
Set permissions for a photo. This method requires authentication with WRITE permission.
Parametersphoto_id:String — The id of the photo to set permissions for.
|
|
is_public:Boolean — true to set the photo to public, false to set it to private.
|
|
is_friend:Boolean — true to make the photo visible to friends when private,
false to not.
|
|
is_family:Boolean — true to make the photo visible to family when private,
false to not.
|
|
perm_comment:int — Who can add comments to the photo and it's notes. one of:
0: nobody
1: friends & family
2: contacts
3: everybody
|
|
perm_addmeta:int — Who can add notes and tags to the photo. one of:
0: nobody / just the owner
1: friends & family
2: contacts
3: everybody
|
See also
setTags | () | method |
public function setTags(photo_id:String, tags:String):void
Set the tags for a photo.
Parametersphoto_id:String — The id of the photo to set tags for.
|
|
tags:String — All tags for the photo (as a single space-delimited string).
|
See also
photosAddTags | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the addTags method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also
photosGetAllContexts | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getAllContexts method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PhotoContext instance When success is false, contains an "error" FlickrError instance
See also
photosGetContactsPhotos | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getContactsPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances When success is false, contains an "error" FlickrError instance
See also
photosGetContactsPublicPhotos | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getContactsPublicPhotos method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances When success is false, contains an "error" FlickrError instance
See also
photosGetContext | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getContext method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of Photo instances. The first element is the previous photo, the second element is the next photo. When success is false, contains an "error" FlickrError instance
See also
photosGetCounts | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getCounts method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an array of PhotoCount instances When success is false, contains an "error" FlickrError instance
See also
photosGetExif | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getExif method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance
See also
photosGetInfo | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getInfo method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance
See also
photosGetNotInSet | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getNotInSet method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance
See also
photosGetPerms | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getPerms method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a Photo instance When success is false, contains an "error" FlickrError instance
See also
photosGetRecent | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getRecent method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instance When success is false, contains an "error" FlickrError instance
See also
photosGetSizes | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getSizes method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an Array of PhotoSize instances When success is false, contains an "error" FlickrError instance
See also
photosGetUntagged | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the getUntagged method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instnace When success is false, contains an "error" FlickrError instance
See also
photosRemoveTag | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a result of the removeTag method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also
photosSearch | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a search of the search method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, a PagedPhotoList instnace When success is false, contains an "error" FlickrError instance
See also
photosSetDates | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a search of the setDates method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also
photosSetMeta | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a search of the setMeta method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also
photosSetPerms | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a search of the setPerms method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also
photosSetTags | event |
com.adobe.webapis.flickr.events.FlickrResultEvent
Broadcast as a search of the setTags method being called The event contains the following properties success - Boolean indicating if the call was successful or not data - When success is true, an empty object When success is false, contains an "error" FlickrError instance
See also