AbstractInterface | +--photos.PhotosInterface
| Method Summary | |
public boolean |
addTags(string photo_id, string tags)
Add tags to a photo. |
public boolean |
delete(string photo_id)
Delete a photo from flickr. |
public array |
getAllContexts(string photo_id)
Returns all visible sets and pools the photo belongs to. |
public array |
getContactsPhotos([numeric count], [boolean just_friends], [boolean single_photo], [boolean include_self], [string extras])
Fetch a list of recent photos from the calling users' contacts. |
public array |
getContactsPublicPhotos(string user_id, [numeric count], [boolean just_friends], [boolean single_photo], [boolean include_self], [string extras])
|
public PhotoContext |
getContext(string photo_id)
Returns next and previous photos for a photo in a photostream. |
public array |
getCounts([array dates], [array taken_dates])
Gets a list of photo counts for the given date ranges for the calling user. |
public Photo |
getExif(string photo_id, [string secret])
Retrieves a list of EXIF/TIFF/GPS tags for a given photo. The calling user must have permission to view the photo. |
public FavoriterList |
getFavorites(string photo_id, [numeric page], [numeric per_page])
Returns the list of people who have favorited a given photo. |
public Photo |
getInfo(string photo_id, [string secret])
Get information about a photo. The calling user must have permission to view the photo. |
public PhotoList |
getNotInSet([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [integer privacy_filter], [string extras], [numeric per_page], [numeric page])
Returns a list of your photos that are not part of any sets. |
public Permission |
getPerms(string photo_id)
Get permissions for a photo. |
public PhotoList |
getRecent([string extras], [numeric per_page], [numeric page])
Returns a list of the latest public photos uploaded to flickr. |
public array |
getSizes(string photo_id)
Returns the available sizes for a photo. The calling user must have permission to view the photo. |
public PhotoList |
getUntagged([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [integer privacy_filter], [string extras], [numeric per_page], [numeric page])
Returns a list of your photos with no tags. |
public PhotoList |
getWithGeoData([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string privacy_filter], [string sort], [string extras], [numeric per_page], [numeric page])
|
public PhotoList |
getWithoutGeoData([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string privacy_filter], [string sort], [string extras], [numeric per_page], [numeric page])
|
public PhotoList |
recentlyUpdated(date min_date, [string extras], [numeric per_page], [numeric page])
|
public boolean |
removeTag(string tag_id)
Remove a tag from a photo. |
public PhotoList |
search([string user_id], [string tags], [string tag_mode], [string text], [date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string license], [string sort], [string privacy_filter], [string bbox], [numeric accuracy], [numeric safe_search], [numeric content_type], [string extras], [string machine_tags], [string machine_tag_mode], [string group_id], [numeric per_page], [numeric page])
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. |
public boolean |
setContentType(string photo_id, numeric content_type)
Set the content type of a photo. |
public boolean |
setDates(string photo_id, [date date_posted], [date date_taken], [numeric date_taken_granularity])
Set one or both of the dates for a photo. |
public boolean |
setMeta(string photo_id, string title, string description)
Set the meta information for a photo. |
public boolean |
setPerms(string photo_id, boolean is_public, boolean is_friend, boolean is_family, numeric perm_comment, numeric perm_addmeta)
Set permissions for a photo. |
public boolean |
setSafetyLevel(string photo_id, [numeric safety_level], [boolean hidden])
Set the safety level of a photo. |
public boolean |
setTags(string photo_id, string tags)
Set the tags for a photo. |
| Methods inherited from AbstractInterface |
init
|
| Method Detail |
public boolean addTags(string photo_id, string tags)
string photo_id (Required) - The id of the photo to add tags to. string tags (Required) - The tags to add to the photo. public boolean delete(string photo_id)
string photo_id (Required) - The id of the photo to delete. public array getAllContexts(string photo_id)
string photo_id (Required) - The photo to return information for. public array getContactsPhotos([numeric count], [boolean just_friends], [boolean single_photo], [boolean include_self], [string extras])
numeric count (Optional) - Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed. boolean just_friends (Optional) - Only show photos from friends and family (excluding regular contacts). boolean single_photo (Optional) - Only fetch one photo (the latest) per contact, instead of all photos in chronological order.boolean include_self (Optional) - Include photos from the calling user. string extras (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, original_format, last_update, geo. public array getContactsPublicPhotos(string user_id, [numeric count], [boolean just_friends], [boolean single_photo], [boolean include_self], [string extras])
string user_id (Required) - The NSID of the user to fetch photos for. numeric count (Optional) - Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed. boolean just_friends (Optional) - Only show photos from friends and family (excluding regular contacts). boolean single_photo (Optional) - Only fetch one photo (the latest) per contact, instead of all photos in chronological order.boolean include_self (Optional) - Include photos from the calling user. string extras (Optional) - List, any of: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geopublic CFlickr.photos.PhotoContext getContext(string photo_id)
string photo_id (Required) - The id of the photo to fetch the context for.public array getCounts([array dates], [array taken_dates])
array dates (Optional) - Array of dates, denoting the periods to return counts for. They should be specified smallest first.array taken_dates (Optional) - Array of dates, denoting the periods to return counts for. They should be specified smallest first.public CFlickr.photos.Photo getExif(string photo_id, [string secret])
string photo_id (Required) - The is of the photo to fetch information for. string secret (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.public CFlickr.favorites.FavoriterList getFavorites(string photo_id, [numeric page], [numeric per_page])
string photo_id (Required) - The ID of the photo to fetch the favoriters list for.numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1. numeric per_page (Optional) - Number of users to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.public CFlickr.photos.Photo getInfo(string photo_id, [string secret])
string photo_id (Required) - The is of the photo to fetch information for. string secret (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.public CFlickr.photos.PhotoList getNotInSet([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [integer privacy_filter], [string extras], [numeric per_page], [numeric page])
date min_upload_date (Optional) - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. date max_upload_date (Optional) - Maximum upload date. Photos with an upload date less than or equal to this value will be returned.date min_taken_date (Optional) - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned.date max_taken_date (Optional) - Maximum taken date. Photos with an taken date less than or equal to this value will be returned.integer privacy_filter (Optional)string extras (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, original_format, last_update, geo.numeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500. numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1. public CFlickr.photos.Permission getPerms(string photo_id)
string photo_id (Required) - The id of the photo to get permissions for.public CFlickr.photos.PhotoList getRecent([string extras], [numeric per_page], [numeric page])
string extras (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, original_format, last_update, geo. numeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500. numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1. public array getSizes(string photo_id)
string photo_id (Required) - The id of the photo to fetch size information for. public CFlickr.photos.PhotoList getUntagged([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [integer privacy_filter], [string extras], [numeric per_page], [numeric page])
date min_upload_date (Optional) - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. date max_upload_date (Optional) - Maximum upload date. Photos with an upload date less than or equal to this value will be returned.date min_taken_date (Optional) - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned.date max_taken_date (Optional) - Maximum taken date. Photos with an taken date less than or equal to this value will be returned.integer privacy_filter (Optional)string extras (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, original_format, last_update, geo.numeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500. numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1. public CFlickr.photos.PhotoList getWithGeoData([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string privacy_filter], [string sort], [string extras], [numeric per_page], [numeric page])
date min_upload_date (Optional) - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. date max_upload_date (Optional) - Maximum upload date. Photos with an upload date less than or equal to this value will be returned.date min_taken_date (Optional) - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned.date max_taken_date (Optional) - Maximum taken date. Photos with an taken date less than or equal to this value will be returned.string privacy_filter (Optional)string sort (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, date-taken-desc, interestingness-desc, and interestingness-asc.string extras (Optional) - List, any of: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geonumeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1.public CFlickr.photos.PhotoList getWithoutGeoData([date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string privacy_filter], [string sort], [string extras], [numeric per_page], [numeric page])
date min_upload_date (Optional) - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. date max_upload_date (Optional) - Maximum upload date. Photos with an upload date less than or equal to this value will be returned.date min_taken_date (Optional) - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned.date max_taken_date (Optional) - Maximum taken date. Photos with an taken date less than or equal to this value will be returned.string privacy_filter (Optional)string sort (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, date-taken-desc, interestingness-desc, and interestingness-asc.string extras (Optional) - List, any of: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geonumeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1.public CFlickr.photos.PhotoList recentlyUpdated(date min_date, [string extras], [numeric per_page], [numeric page])
date min_date (Required) - the date from which modifications should be compared. string extras (Optional) - List, any of: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geonumeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1.public boolean removeTag(string tag_id)
string tag_id (Required) - The tag to remove from the photo. This parameter should contain a tag id, as returned by CFlickr.photos.PhotosInterface.getInfo() method.public CFlickr.photos.PhotoList search([string user_id], [string tags], [string tag_mode], [string text], [date min_upload_date], [date max_upload_date], [date min_taken_date], [date max_taken_date], [string license], [string sort], [string privacy_filter], [string bbox], [numeric accuracy], [numeric safe_search], [numeric content_type], [string extras], [string machine_tags], [string machine_tag_mode], [string group_id], [numeric per_page], [numeric page])
string user_id (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. A value of 'me' will search against the calling user's photos for authenticated calls. string tags (Optional) - A comma-delimited list of tags. Photos with one or more of the tags listed will be returned. string tag_mode (Optional) - Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.string text (Optional) - A free text search. Photos who's title, description or tags contain the text will be returned. date min_upload_date (Optional) - Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. date max_upload_date (Optional) - Maximum upload date. Photos with an upload date less than or equal to this value will be returned.date min_taken_date (Optional) - Minimum taken date. Photos with an taken date greater than or equal to this value will be returned.date max_taken_date (Optional) - Maximum taken date. Photos with an taken date less than or equal to this value will be returned.string license (Optional) - The license id for photos (for possible values see the CFlickr.photos.licenses.LicensesInterface.getInfo() method). Multiple licenses may be comma-separated.string sort (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, date-taken-desc, interestingness-desc, interestingness-asc, and relevance. string privacy_filter (Optional)string bbox (Optional) - A comma-delimited list of 4 values defining the Bounding Box of the area that will be searched. The 4 values represent the bottom-left corner of the box and the top-right corner, minimum_longitude, minimum_latitude, maximum_longitude, maximum_latitude. Longitude has a range of -180 to 180 , latitude of -90 to 90. Defaults to -180, -90, 180, 90 if not specified. numeric accuracy (Optional) - Recorded accuracy level of the location information. World level is 1, Country is ~3, Region ~6, City ~11, Street ~16. Current range is 1-16. Defaults to maximum value if not specified. numeric safe_search (Optional)numeric content_type (Optional)string extras (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, original_format, last_update, geo. string machine_tags (Optional)string machine_tag_mode (Optional) - Either 'any' for an OR combination of tags, or 'all' for an AND combination. Defaults to 'any' if not specified.string group_id (Optional) - The id of a group who's pool to search. If specified, only matching photos posted to the group's pool will be returned.numeric per_page (Optional) - Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500. numeric page (Optional) - The page of results to return. If this argument is omitted, it defaults to 1. public boolean setContentType(string photo_id, numeric content_type)
string photo_id (Required) - The id of the photo to set the content type for.numeric content_type (Required) - The content type of the photo. Must be one of: 1 for Photo, 2 for Screenshot, and 3 for Other.public boolean setDates(string photo_id, [date date_posted], [date date_taken], [numeric date_taken_granularity])
string photo_id (Required) - The id of the photo to edit dates for. date date_posted (Optional) - The date the photo was uploaded to flickr. date date_taken (Optional) - The date the photo was taken. numeric date_taken_granularity (Optional)public boolean setMeta(string photo_id, string title, string description)
string photo_id (Required) - The id of the photo to set information for. string title (Required) - The title for the photo. string description (Required) - The description for the photo. public boolean setPerms(string photo_id, boolean is_public, boolean is_friend, boolean is_family, numeric perm_comment, numeric perm_addmeta)
string photo_id (Required) - The id of the photo to set permissions for. boolean is_public (Required) - true to set the photo to public, false to set it to private. boolean is_friend (Required) - true to make the photo visible to friends when private, false to not.boolean is_family (Required) - true to make the photo visible to family when private, false to not. numeric perm_comment (Required)numeric perm_addmeta (Required)public boolean setSafetyLevel(string photo_id, [numeric safety_level], [boolean hidden])
string photo_id (Required) - The id of the photo to set safety level for. numeric safety_level (Optional) - The safety level of the photo. Must be one of: 1 for Safe, 2 for Moderate, and 3 for Restricted.boolean hidden (Optional) - Whether or not to additionally hide the photo from public searches. Must be either 1 for Yes or 0 for No.public boolean setTags(string photo_id, string tags)
string photo_id (Required) - The id of the photo to set tags for. string tags (Required) - All tags for the photo (as a single space-delimited string).