GrssFeedEnclosure

GrssFeedEnclosure — a component attached to an item

Synopsis

struct              GrssFeedEnclosure;
GrssFeedEnclosure * grss_feed_enclosure_new             (gchar *url);
const gchar *       grss_feed_enclosure_get_url         (GrssFeedEnclosure *enclosure);
void                grss_feed_enclosure_set_format      (GrssFeedEnclosure *enclosure,
                                                         gchar *type);
const gchar *       grss_feed_enclosure_get_format      (GrssFeedEnclosure *enclosure);
void                grss_feed_enclosure_set_length      (GrssFeedEnclosure *enclosure,
                                                         gsize length);
gsize               grss_feed_enclosure_get_length      (GrssFeedEnclosure *enclosure);

Object Hierarchy

  GObject
   +----GrssFeedEnclosure

Description

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

Details

struct GrssFeedEnclosure

struct GrssFeedEnclosure;


grss_feed_enclosure_new ()

GrssFeedEnclosure * grss_feed_enclosure_new             (gchar *url);

Allocates a new GrssFeedEnclosure, to be downloaded separately.

url :

URL of the external element.

Returns :

a new GrssFeedEnclosure.

grss_feed_enclosure_get_url ()

const gchar *       grss_feed_enclosure_get_url         (GrssFeedEnclosure *enclosure);

Retrieves the URL of the enclosure.

enclosure :

a GrssFeedEnclosure.

Returns :

the URL where the enclosure may be found.

grss_feed_enclosure_set_format ()

void                grss_feed_enclosure_set_format      (GrssFeedEnclosure *enclosure,
                                                         gchar *type);

To set the type of the external file.

enclosure :

a GrssFeedEnclosure.

type :

type of content.

grss_feed_enclosure_get_format ()

const gchar *       grss_feed_enclosure_get_format      (GrssFeedEnclosure *enclosure);

Retrieves the format of the enclosed file.

enclosure :

a GrssFeedEnclosure.

Returns :

type of enclosure.

grss_feed_enclosure_set_length ()

void                grss_feed_enclosure_set_length      (GrssFeedEnclosure *enclosure,
                                                         gsize length);

To set the size of the embedded enclosure.

enclosure :

a GrssFeedEnclosure.

length :

size of the enclosure, in bytes.

grss_feed_enclosure_get_length ()

gsize               grss_feed_enclosure_get_length      (GrssFeedEnclosure *enclosure);

Retrieves the size of the embedded file.

enclosure :

a GrssFeedEnclosure.

Returns :

size of the enclosure, in bytes.