Groups

Groups — Groups of users.

Synopsis




                    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);
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);
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);

Description

Groups of users.

Details

flickcurl_group

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.

char *nsid;

NSID

char *name;

Group Name

char *description;

Description

char *lang;

Language

int is_admin;

is admin flag

int is_pool_moderated;

is the pool moderated

int is_eighteenplus;

18+ group

int privacy;

privacy level

int photos;

photos in group count

int iconserver;

icon server ID

int members;

member count

int throttle_count;

throttle count

char *throttle_mode;

throttle mode (day, ...)

int throttle_remaining;

throttle remaining

flickcurl_free_group ()

void                flickcurl_free_group                (flickcurl_group *group);

Destructor for group object

group :

group object

flickcurl_free_groups ()

void                flickcurl_free_groups               (flickcurl_group **groups_object);

Destructor for array of group object

groups_object :

group object array

flickcurl_groups_browse ()

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)

fc :

flickcurl context

cat_id :

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_groups_getInfo ()

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)

fc :

flickcurl context

group_id :

The NSID of the group to fetch information for.

lang :

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

flickcurl_groups_pools_add ()

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)

fc :

flickcurl context

photo_id :

The id of the photo to add to the group pool.

group_id :

The NSID of the group who's pool the photo is to be added to.

Returns :

non-0 on failure

flickcurl_groups_pools_getContext ()

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)

fc :

flickcurl context

photo_id :

photo ID

group_id :

group ID

Returns :

an array of size 3 [prev, next, NULL] flickcurl_context* or NULL on error

flickcurl_groups_pools_getGroups ()

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)

fc :

flickcurl context

page :

The page of results to return (default 1)

per_page :

Number of groups to return per page (default 400, max 400)

Returns :

non-0 on failure

flickcurl_groups_pools_getPhotos ()

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.

Currently supported extra fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags.

Implements flickr.groups.pools.getPhotos (0.12)

fc :

flickcurl context

group_id :

The id of the group who's pool you which to get the photo list for.

tags :

A tag to filter the pool with. At the moment only one tag at a time is supported. (or NULL)

user_id :

The nsid of a user (or NULL). If given, retrieves only photos that the user has contributed to the group pool.

extras :

A comma-delimited list of extra information to fetch for each returned record (or NULL)

per_page :

Number of photos to return per page (default 100, max 500)

page :

The page of results to return (default 1)

Returns :

non-0 on failure

flickcurl_groups_pools_remove ()

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)

fc :

flickcurl context

photo_id :

The id of the photo to remove from the group pool.

group_id :

The NSID of the group who's pool the photo is to removed from.

Returns :

non-0 on failure

flickcurl_groups_search ()

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)

fc :

flickcurl context

text :

The text to search for.

per_page :

Number of groups to return per page, default 100, max 500 (or NULL)

page :

The page of results to return, default 1 (or NULL)

Returns :

non-0 on failure