class FlickRaw::Flickr::Photos::Comments

Public Instance Methods

addComment(:photo_id => 'photo_id',:comment_text => 'comment_text',:secure_image_embeds => 'secure_image_embeds',:expand_bbml => 'expand_bbml',:bbml_need_all_photo_sizes => 'bbml_need_all_photo_sizes',:primary_photo_longest_dimension => 'primary_photo_longest_dimension') click to toggle source

flickr.photos.comments.addComment request.

Add comment to a photo as the currently authenticated user.

Arguments

photo_id (required): The id of the photo to add a comment to.
comment_text (required): Text of the comment
secure_image_embeds: This argument will secure the external image embeds in all the markup and return a secure back in addition to the
expand_bbml: Expand bbml in response
bbml_need_all_photo_sizes: If the API needs all photo sizes added as attributes to the bbml. Use this with expand_bbml, but dont use it with use_text_for_links. Also when you give this one, you can specify primary_photo_longest_dimension or a default of 240 will be assumed
primary_photo_longest_dimension: When used with bbml_need_all_photo_sizes, it specifies the maximum dimension of width and height to be used as the url

Error codes

1: Photo not found.

The photo id passed was not a valid photo id
8: Blank comment.

Comment text can not be blank
9: User is posting comments too fast.

The user has reached the limit for number of comments posted during a specific time period. Wait a bit and try again.
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def addComment(*args)
    @flickr.call 'flickr.photos.comments.addComment', *args
  end

deleteComment(:comment_id => 'comment_id') click to toggle source

flickr.photos.comments.deleteComment request.

Delete a comment as the currently authenticated user.

Arguments

comment_id (required): The id of the comment to edit.

Error codes

1: Photo not found.

The requested comment is against a photo which no longer exists.
2: Comment not found.

The comment id passed was not a valid comment id
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def deleteComment(*args)
    @flickr.call 'flickr.photos.comments.deleteComment', *args
  end

editComment(:comment_id => 'comment_id',:comment_text => 'comment_text',:use_text_for_links => 'use_text_for_links',:expand_bbml => 'expand_bbml',:full_result => 'full_result',:secure_image_embeds => 'secure_image_embeds',:bbml_need_all_photo_sizes => 'bbml_need_all_photo_sizes',:primary_photo_longest_dimension => 'primary_photo_longest_dimension') click to toggle source

flickr.photos.comments.editComment request.

Edit the text of a comment as the currently authenticated user.

Arguments

comment_id (required): The id of the comment to edit.
comment_text (required): Update the comment to this text.
use_text_for_links: Use text for links
expand_bbml: Expand bbml
full_result: If the caller wants the full result to be returned (as flickr.photos.comments.getComment), then this parameter should be passed in as 1.
secure_image_embeds: This argument will secure the external image embeds in all the markup and return a secure back in addition to the
bbml_need_all_photo_sizes: If the API needs all photo sizes added as attributes to the bbml. Use this with expand_bbml, but dont use it with use_text_for_links. Also when you give this one, you can specify primary_photo_longest_dimension or a default of 240 will be assumed
primary_photo_longest_dimension: When used with bbml_need_all_photo_sizes, it specifies the maximum dimension of width and height to be used as the url

Error codes

1: Photo not found.

The requested comment is against a photo which no longer exists.
2: Comment not found.

The comment id passed was not a valid comment id
8: Blank comment.

Comment text can not be blank
96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def editComment(*args)
    @flickr.call 'flickr.photos.comments.editComment', *args
  end

getList(:photo_id => 'photo_id',:min_comment_date => 'min_comment_date',:max_comment_date => 'max_comment_date',:page => 'page',:per_page => 'per_page',:include_faves => 'include_faves',:sort => 'sort',:secure_image_embeds => 'secure_image_embeds',:offset => 'offset',:limit => 'limit',:bbml_need_all_photo_sizes => 'bbml_need_all_photo_sizes',:primary_photo_longest_dimension => 'primary_photo_longest_dimension') click to toggle source

flickr.photos.comments.getList request.

Returns the comments for a photo

Arguments

photo_id (required): The id of the photo to fetch comments for.
min_comment_date: Minimum date that a a comment was added. The date should be in the form of a unix timestamp.
max_comment_date: Maximum date that a comment was added. The date should be in the form of a unix timestamp.
page
per_page
include_faves
sort: Get the comments sorted. If value is date-posted-desc, the comments are returned in reverse chronological order. The default is chronological.
secure_image_embeds: This argument will secure the external image embeds in all the markup and return a secure back in addition to the
offset
limit
bbml_need_all_photo_sizes: If the API needs all photo sizes added as attributes to the bbml. Use this with expand_bbml, but dont use it with use_text_for_links. Also when you give this one, you can specify primary_photo_longest_dimension or a default of 240 will be assumed
primary_photo_longest_dimension: When used with bbml_need_all_photo_sizes, it specifies the maximum dimension of width and height to be used as the url

Error codes

1: Photo not found

The photo id was either invalid or was for a photo not viewable by the calling user.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Umm, I'm not sure, can I get back to you on that one?

# Generated automatically from flickr api
  def getList(*args)
    @flickr.call 'flickr.photos.comments.getList', *args
  end

getRecentForContacts(:date_lastcomment => 'date_lastcomment',:contacts_filter => 'contacts_filter',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.comments.getRecentForContacts request.

Return the list of photos belonging to your contacts that have been commented on recently.

Arguments

date_lastcomment: Limits the resultset to photos that have been commented on since this date. The date should be in the form of a Unix timestamp.

The default, and maximum, offset is (1) hour.

contacts_filter: A comma-separated list of contact NSIDs to limit the scope of the query to.
extras: A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o
per_page: Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
page: The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

96: Invalid signature

The passed signature was invalid.
97: Missing signature

The call required signing but no signature was sent.
98: Login failed / Invalid auth token

The login details or auth token passed were invalid.
99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100: Invalid API Key

The API key passed was not valid or has expired.
105: Service currently unavailable

The requested service is temporarily unavailable.
106: Write operation failed

The requested operation failed due to a temporary issue.
111: Format “xxx” not found

The requested response format was not found.
112: Method “xxx” not found

The requested method was not found.
114: Invalid SOAP envelope

The SOAP envelope send in the request could not be parsed.
115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.
116: Bad URL found

One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def getRecentForContacts(*args)
    @flickr.call 'flickr.photos.comments.getRecentForContacts', *args
  end