class FlickRaw::Flickr::Contacts
Public Instance Methods
flickr.contacts.getList request.
Get a list of contacts for the calling user.
Arguments
- filter
-
An optional filter of the results. The following values are valid:
friends
Only contacts who are friends (and not family)family Only contacts who are family (and not friends)both Only contacts who are both friends and familyneither Only contacts who are neither friends nor family
- page
-
The page of results to return. If this argument is omitted, it defaults to 1.
- per_page
-
Number of photos to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.
- sort
-
The order in which to sort the returned contacts. Defaults to name. The possible values are: name and time.
- fields
-
The fields can have the following args:
realname, friend, family,path_alias,location,public_photos_count,can_tag
Error codes
-
1: Invalid sort parameter.
The possible values are: name and time.
-
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 getList(*args) @flickr.call 'flickr.contacts.getList', *args end
flickr.contacts.getListRecentlyUploaded request.
Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded.
This method is still considered experimental. We don't plan for it to change or to go away but so long as this notice is present you should write your code accordingly.
Arguments
- date_lastupload
-
Limits the resultset to contacts that have uploaded photos since this date. The date should be in the form of a Unix timestamp.
The default offset is (1) hour and the maximum (24) hours.
- filter
-
Limit the result set to all contacts or only those who are friends or family. Valid options are:
ff friends and family all all your contacts
Default value is “all”.
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 getListRecentlyUploaded(*args) @flickr.call 'flickr.contacts.getListRecentlyUploaded', *args end
flickr.contacts.getPublicList request.
Get the contact list for a user.
Arguments
- user_id (required)
-
The NSID of the user to fetch the contact list for.
- page
-
The page of results to return. If this argument is omitted, it defaults to 1.
- per_page
-
Number of photos to return per page. If this argument is omitted, it defaults to 1000. The maximum allowed value is 1000.
- show_more
-
Include additional information for each contact, such as realname, is_friend, is_family, path_alias and location.
Error codes
-
1: User not found
The specified user NSID was not a valid 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
# Generated automatically from flickr api def getPublicList(*args) @flickr.call 'flickr.contacts.getPublicList', *args end
flickr.contacts.getTaggingSuggestions request.
Get suggestions for tagging people in photos based on the calling user's contacts.
Arguments
- include_self
-
Return calling user in the list of suggestions. Default: true.
- include_address_book
-
Include suggestions from the user's address book. Default: false
- per_page
-
Number of contacts to return per page. If this argument is omitted, all contacts will be returned.
- 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.
Returns
# Generated automatically from flickr api def getTaggingSuggestions(*args) @flickr.call 'flickr.contacts.getTaggingSuggestions', *args end