SharingEntryMedia

SharingEntryMedia — Media element of SharingEntry

Synopsis

gchar*              sharing_entry_media_get_name        (const SharingEntryMedia *self);
gchar*              sharing_entry_media_get_filename    (const SharingEntryMedia *self);
gchar*              sharing_entry_media_get_filename_without_extension
                                                        (const SharingEntryMedia *self);
gchar*              sharing_entry_media_get_title       (const SharingEntryMedia *self);
const gchar*        sharing_entry_media_get_desc        (const SharingEntryMedia *self);
const GSList*       sharing_entry_media_get_tags        (const SharingEntryMedia *self);
const gchar*        sharing_entry_media_get_localpath   (const SharingEntryMedia *self);
gchar*              sharing_entry_media_get_mime        (const SharingEntryMedia *self);
guint64             sharing_entry_media_get_size        (const SharingEntryMedia *self);
void                sharing_entry_media_set_sent        (SharingEntryMedia *self,
                                                         gboolean sent);
gboolean            sharing_entry_media_get_sent        (SharingEntryMedia *self);

Description

SharingEntryMedia is abstraction of sharing entry's media element. It holds methods to get and modify metadata of media elements.

Details

sharing_entry_media_get_name ()

gchar*              sharing_entry_media_get_name        (const SharingEntryMedia *self);

Get name of SharingEntryMedia object. Name is title if it's defined. And if not then filename is given as name. This value can be used in UI or other places where media needs to be shown to user as text.

`self` :	Pointer to SharingEntryMedia object
Returns :	Newly allocated string. Free with `g_free()`. `NULL` in error.

sharing_entry_media_get_filename ()

gchar*              sharing_entry_media_get_filename    (const SharingEntryMedia *self);

Returns filename of the SharingEntryMedia.

`self` :	Pointer to SharingEntryMedia object
Returns :	Newly allocated gchar. Free with `g_free()`. `NULL` in error.

sharing_entry_media_get_filename_without_extension ()

gchar*              sharing_entry_media_get_filename_without_extension
                                                        (const SharingEntryMedia *self);

Return: Newly allocated string. Free with g_free(). NULL in error.

self : Pointer to SharingEntryMedia object

sharing_entry_media_get_title ()

gchar*              sharing_entry_media_get_title       (const SharingEntryMedia *self);

Get title of SharingEntryMedia object

`self` :	Pointer to SharingEntryMedia object
Returns :	Newly allocated string. Free with `g_free()`

sharing_entry_media_get_desc ()

const gchar*        sharing_entry_media_get_desc        (const SharingEntryMedia *self);

Get description of SharingEntryMedia object

`self` :	Pointer to SharingEntryMedia object
Returns :	Constant pointer to description. `NULL` if not defined.

sharing_entry_media_get_tags ()

const GSList*       sharing_entry_media_get_tags        (const SharingEntryMedia *self);

Get tags added to object

`self` :	Pointer to SharingEntryMedia object
Returns :	GSList of SharingTag objects. Owned by SharingEntryMedia and shouldn't be freed or modified. Valid until tags of object is changed.

sharing_entry_media_get_localpath ()

const gchar*        sharing_entry_media_get_localpath   (const SharingEntryMedia *self);

Get localpath of SharingEntryMedia if available

`self` :	Pointer to SharingEntryMedia
Returns :	Localpath of media or `NULL` if no local file is available

sharing_entry_media_get_mime ()

gchar*              sharing_entry_media_get_mime        (const SharingEntryMedia *self);

Get Mime type of SharingEntryMedia object's file

`self` :	Pointer SharingEntryMedia object
Returns :	Mime or `NULL` if Mime not defined. Free with `g_free()`.

sharing_entry_media_get_size ()

guint64             sharing_entry_media_get_size        (const SharingEntryMedia *self);

Get size of SharingEntryMedia object's file

`self` :	Pointer SharingEntryMedia object
Returns :	Size of file in bytes or 0 if file not defined or size can't be solved.

sharing_entry_media_set_sent ()

void                sharing_entry_media_set_sent        (SharingEntryMedia *self,
                                                         gboolean sent);

Marks whatever SharingEntryMedia is already sent

`self` :	Pointer to SharingEntryMedia object
`sent` :	is media sent

sharing_entry_media_get_sent ()

gboolean            sharing_entry_media_get_sent        (SharingEntryMedia *self);

Gets boolean value of media sent

`self` :	Pointer to SharingEntryMedia object
Returns :	`TRUE` if sent and `FALSE` if not.

			LibSharing Manual
Top \| Description