GFBGraphAlbum

GFBGraphAlbum — GFBGraph Photo album node object

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gfbgraph/gfbgraph.h>

struct              GFBGraphAlbum;
struct              GFBGraphAlbumClass;
GFBGraphAlbum *     gfbgraph_album_new                  (void);
GFBGraphAlbum *     gfbgraph_album_new_from_id          (GFBGraphAuthorizer *authorizer,
                                                         const gchar *id,
                                                         GError **error);
const gchar *       gfbgraph_album_get_name             (GFBGraphAlbum *album);
const gchar *       gfbgraph_album_get_description      (GFBGraphAlbum *album);
const gchar *       gfbgraph_album_get_cover_photo_id   (GFBGraphAlbum *album);
guint               gfbgraph_album_get_count            (GFBGraphAlbum *album);

Object Hierarchy

  GObject
   +----GFBGraphNode
         +----GFBGraphAlbum

Implemented Interfaces

GFBGraphAlbum implements GFBGraphConnectable.

Properties

  "count"                    guint                 : Read / Write
  "cover-photo"              gchar*                : Read / Write
  "description"              gchar*                : Read / Write
  "name"                     gchar*                : Read / Write

Description

GFGraphAlbum represents the photo album node in the Graph API.

This node is connectable to: - GFBGraphUser

Details

struct GFBGraphAlbum

struct GFBGraphAlbum;

struct GFBGraphAlbumClass

struct GFBGraphAlbumClass {
        GFBGraphNodeClass parent_class;
};

gfbgraph_album_new ()

GFBGraphAlbum *     gfbgraph_album_new                  (void);

Creates a new GFBGraphAlbum.

Returns :

 a new GFBGraphAlbum; unref with g_object_unref(). [transfer full]

gfbgraph_album_new_from_id ()

GFBGraphAlbum *     gfbgraph_album_new_from_id          (GFBGraphAuthorizer *authorizer,
                                                         const gchar *id,
                                                         GError **error);

Retrieves an album node from the Facebook Graph with the give ID.

authorizer :

 a GFBGraphAuthorizer.

id :

 a const gchar with the album ID.

error :

 a GError or NULL. [allow-none]

Returns :

 a new GFBGraphAlbum; unref with g_object_unref(). [transfer full]

gfbgraph_album_get_name ()

const gchar *       gfbgraph_album_get_name             (GFBGraphAlbum *album);

album :

 a GFBGraphAlbum.

Returns :

 the album name, or NULL. [transfer none]

gfbgraph_album_get_description ()

const gchar *       gfbgraph_album_get_description      (GFBGraphAlbum *album);

album :

 a GFBGraphAlbum.

Returns :

 the album description, or NULL. [transfer none]

gfbgraph_album_get_cover_photo_id ()

const gchar *       gfbgraph_album_get_cover_photo_id   (GFBGraphAlbum *album);

gfbgraph_album_get_count ()

guint               gfbgraph_album_get_count            (GFBGraphAlbum *album);

album :

 a GFBGraphAlbum.

Returns :

 the number of photos into the album or -1 in case of error. [transfer none]

Property Details

The "count" property

  "count"                    guint                 : Read / Write

The number of photos in the album.

Default value: 0

The "cover-photo" property

  "cover-photo"              gchar*                : Read / Write

The ID for the cover photo of the album.

Default value: ""

The "description" property

  "description"              gchar*                : Read / Write

The album description given by the owner.

Default value: ""

The "name" property

  "name"                     gchar*                : Read / Write

The album name.

Default value: ""

Generated by GTK-Doc V1.19