![]() |
![]() |
Flickcurl Flickr API Manual | ![]() |
|
---|---|---|---|---|
Top | Description |
flickcurl_group; void flickcurl_free_group (flickcurl_group *group
); void flickcurl_free_groups (flickcurl_group **groups_object
); flickcurl_category * flickcurl_groups_browse (flickcurl *fc
,int cat_id
); flickcurl_group * flickcurl_groups_getInfo (flickcurl *fc
,const char *group_id
,const char *lang
); flickcurl_member; void flickcurl_free_member (flickcurl_member *member_object
); void flickcurl_free_members (flickcurl_member **members_object
); flickcurl_member ** flickcurl_groups_members_getList (flickcurl *fc
,const char *group_id
,const char *membertypes
,int per_page
,int page
); int flickcurl_groups_pools_add (flickcurl *fc
,const char *photo_id
,const char *group_id
); flickcurl_context ** flickcurl_groups_pools_getContext (flickcurl *fc
,const char *photo_id
,const char *group_id
); flickcurl_group ** flickcurl_groups_pools_getGroups (flickcurl *fc
,int page
,int per_page
); flickcurl_photo ** flickcurl_groups_pools_getPhotos (flickcurl *fc
,const char *group_id
,const char *tags
,const char *user_id
,const char *extras
,int per_page
,int page
); flickcurl_photos_list * flickcurl_groups_pools_getPhotos_params (flickcurl *fc
,const char *group_id
,const char *tags
,const char *user_id
,flickcurl_photos_list_params *list_params
); int flickcurl_groups_pools_remove (flickcurl *fc
,const char *photo_id
,const char *group_id
); flickcurl_group ** flickcurl_groups_search (flickcurl *fc
,const char *text
,int per_page
,int page
);
typedef struct { char* nsid; char* name; char* description; char* lang; int is_admin; int is_pool_moderated; int is_eighteenplus; int privacy; int photos; int iconserver; int members; int throttle_count; char* throttle_mode; int throttle_remaining; } flickcurl_group;
A group.
NSID | |
Group Name | |
Description | |
Language | |
is admin flag | |
is the pool moderated | |
18+ group | |
privacy level | |
photos in group count | |
icon server ID | |
member count | |
throttle count | |
throttle mode (day, ...) | |
throttle remaining |
void flickcurl_free_group (flickcurl_group *group
);
Destructor for group object
|
group object |
void flickcurl_free_groups (flickcurl_group **groups_object
);
Destructor for array of group object
|
group object array |
flickcurl_category * flickcurl_groups_browse (flickcurl *fc
,int cat_id
);
Browse the group category tree, finding groups and sub-categories.
Implements flickr.groups.browse (0.13)
|
flickcurl context |
|
The category id to fetch a list of groups and sub-categories for. If not specified, it defaults to zero, the root of the category tree. (or NULL) |
Returns : |
non-0 on failure |
flickcurl_group * flickcurl_groups_getInfo (flickcurl *fc
,const char *group_id
,const char *lang
);
Get information about a group.
Implements flickr.groups.getInfo (0.13)
|
flickcurl context |
|
The NSID of the group to fetch information for. |
|
The language of the group name and description to fetch. If the language is not found, the primary language of the group will be returned (or NULL) |
Returns : |
non-0 on failure |
typedef struct { char *nsid; char *username; int iconserver; int iconfarm; int member_type; } flickcurl_member;
Member in a group
void flickcurl_free_member (flickcurl_member *member_object
);
Destructor for member object
|
member object |
void flickcurl_free_members (flickcurl_member **members_object
);
Destructor for array of member object
|
member object array |
flickcurl_member ** flickcurl_groups_members_getList (flickcurl *fc
,const char *group_id
,const char *membertypes
,int per_page
,int page
);
Get a list of the members of a group.
The call must be signed on behalf of a Flickr member, and the ability to see the group membership will be determined by the Flickr member's group privileges.
Implements flickr.groups.members.getList (1.9) as announced as an experimental API on 2009-02-24: http://tech.groups.yahoo.com/group/yws-flickr/message/4749
|
flickcurl context |
|
Return a list of members for this group. The group must be viewable by the Flickr member on whose behalf the API call is made. |
|
Comma separated list of member types: 2: member, 3: moderator 4: admin. By default returns all types. (Returning super rare member type "1: narwhal" isn't supported by this API method) (or NULL) |
|
Number of members to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500 (or < 0) |
|
The page of results to return. If this argument is omitted, it defaults to 1 (or < 0) |
Returns : |
list of members or NULL on failure |
int flickcurl_groups_pools_add (flickcurl *fc
,const char *photo_id
,const char *group_id
);
Add a photo to a group's pool.
Implements flickr.groups.pools.add (0.12)
|
flickcurl context |
|
The id of the photo to add to the group pool. |
|
The NSID of the group who's pool the photo is to be added to. |
Returns : |
non-0 on failure |
flickcurl_context ** flickcurl_groups_pools_getContext (flickcurl *fc
,const char *photo_id
,const char *group_id
);
Get next and previous photos for a photo in a group pool.
Implements flickr.groups.pools.getContext (0.7)
|
flickcurl context |
|
photo ID |
|
group ID |
Returns : |
an array of size 3 [prev, next, NULL] flickcurl_context* or NULL on error |
flickcurl_group ** flickcurl_groups_pools_getGroups (flickcurl *fc
,int page
,int per_page
);
Returns a list of groups to which you can add photos.
Implements flickr.groups.pools.getGroups (0.12)
|
flickcurl context |
|
The page of results to return (default 1) |
|
Number of groups to return per page (default 400, max 400) |
Returns : |
non-0 on failure |
flickcurl_photo ** flickcurl_groups_pools_getPhotos (flickcurl *fc
,const char *group_id
,const char *tags
,const char *user_id
,const char *extras
,int per_page
,int page
);
Returns a list of pool photos for a given group.
See flickcurl_groups_pools_getPhotos_params()
for details
of the fields.
Implements flickr.groups.pools.getPhotos (0.12)
|
flickcurl context |
|
The id of the group who's pool you which to get the photo list for. |
|
A tag to filter the pool with. At the moment only one tag at a time is supported. (or NULL) |
|
The nsid of a user (or NULL). If given, retrieves only photos that the user has contributed to the group pool. |
|
A comma-delimited list of extra information to fetch for each returned record (or NULL) |
|
Number of photos to return per page (default 100, max 500) |
|
The page of results to return (default 1) |
Returns : |
non-0 on failure |
flickcurl_photos_list * flickcurl_groups_pools_getPhotos_params (flickcurl *fc
,const char *group_id
,const char *tags
,const char *user_id
,flickcurl_photos_list_params *list_params
);
Returns a list of pool photos for a given group.
Currently supported extra fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.
Optional extra type 'media' that will return an extra media = VALUE for VALUE "photo" or "video". API addition 2008-04-07.
|
flickcurl context |
|
The id of the group who's pool you which to get the photo list for. |
|
A tag to filter the pool with. At the moment only one tag at a time is supported. (or NULL) |
|
The nsid of a user (or NULL). If given, retrieves only photos that the user has contributed to the group pool. |
|
flickcurl_photos_list_params result parameters (or NULL) |
Returns : |
non-0 on failure |
int flickcurl_groups_pools_remove (flickcurl *fc
,const char *photo_id
,const char *group_id
);
Remove a photo from a group pool.
Implements flickr.groups.pools.remove (0.12)
|
flickcurl context |
|
The id of the photo to remove from the group pool. |
|
The NSID of the group who's pool the photo is to removed from. |
Returns : |
non-0 on failure |
flickcurl_group ** flickcurl_groups_search (flickcurl *fc
,const char *text
,int per_page
,int page
);
Search for groups. 18+ groups will only be returned for authenticated calls where the authenticated user is over 18.
Implements flickr.groups.search (0.13)
|
flickcurl context |
|
The text to search for. |
|
Number of groups to return per page, default 100, max 500 (or NULL) |
|
The page of results to return, default 1 (or NULL) |
Returns : |
non-0 on failure |