FeedEnclosure

FeedEnclosure — a component attached to an item

Stability Level

, unless otherwise indicated

Synopsis

                    FeedEnclosure;
FeedEnclosure*      feed_enclosure_new                  (gchar *url);
const gchar*        feed_enclosure_get_url              (FeedEnclosure *enclosure);
void                feed_enclosure_set_format           (FeedEnclosure *enclosure,
                                                         gchar *type);
const gchar*        feed_enclosure_get_format           (FeedEnclosure *enclosure);
void                feed_enclosure_set_length           (FeedEnclosure *enclosure,
                                                         gsize length);
gsize               feed_enclosure_get_length           (FeedEnclosure *enclosure);

Object Hierarchy

  GObject
   +----FeedEnclosure

Description

FeedEnclosure describes an external element embedded into a FeedItem: it may be an image, a video of other kind of file to be presented with the parent item

Details

FeedEnclosure

typedef struct _FeedEnclosure FeedEnclosure;


feed_enclosure_new ()

FeedEnclosure*      feed_enclosure_new                  (gchar *url);

Allocates a new FeedEnclosure, to be downloaded separately

url :

URL of the external element

Returns :

a new FeedEnclosure

feed_enclosure_get_url ()

const gchar*        feed_enclosure_get_url              (FeedEnclosure *enclosure);

Retrieves the URL of the enclosure

enclosure :

a FeedEnclosure

Returns :

the URL where the enclosure may be found

feed_enclosure_set_format ()

void                feed_enclosure_set_format           (FeedEnclosure *enclosure,
                                                         gchar *type);

To set the type of the external file

enclosure :

a FeedEnclosure

type :

type of content

feed_enclosure_get_format ()

const gchar*        feed_enclosure_get_format           (FeedEnclosure *enclosure);

Retrieves the format of the enclosed file

enclosure :

a FeedEnclosure

Returns :

type of enclosure

feed_enclosure_set_length ()

void                feed_enclosure_set_length           (FeedEnclosure *enclosure,
                                                         gsize length);

To set the size of the embedded enclosure

enclosure :

a FeedEnclosure

length :

size of the enclosure

feed_enclosure_get_length ()

gsize               feed_enclosure_get_length           (FeedEnclosure *enclosure);

Retrieves the size of the embedded file

enclosure :

a FeedEnclosure

Returns :

size of the enclosure