ZpjSkydriveEntry

ZpjSkydriveEntry — Abstract base class for file, folder and photo objects.

Functions

Properties

GDateTime * created-time Read
char * description Read
char * from-id Read
char * from-name Read
char * id Read
JsonNode * json Write / Construct Only
char * name Read
char * parent-id Read
ZpjSkydriveEntryType type Read
GDateTime * updated-time Read

Types and Values

Object Hierarchy

    GObject
    ╰── ZpjSkydriveEntry
        ├── ZpjSkydriveFile
        ╰── ZpjSkydriveFolder

Includes

#include <zpj/zpj.h>

Description

ZpjSkydriveEntry is an abstract base class for Skydrive file, folder and photo

objects.

Subclasses may implement ZpjSkydriveEntryClass.parse_json_node (should chain up to its parent class) to parse data specific to them in the JSON returned by the server.

Functions

zpj_skydrive_entry_get_created_time ()

GDateTime *
zpj_skydrive_entry_get_created_time (ZpjSkydriveEntry *self);

Gets the time at which self was created. This is the value of the

updated_time member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

a GDateTime representing the time at which the entry was created. The returned time is owned by the ZpjSkydriveEntry and should not be unreferenced.

[transfer none]


zpj_skydrive_entry_get_description ()

const gchar *
zpj_skydrive_entry_get_description (ZpjSkydriveEntry *self);

Gets the description of self . This is the value of the description member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

description of the entry. This string is owned by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_from_id ()

const gchar *
zpj_skydrive_entry_get_from_id (ZpjSkydriveEntry *self);

Gets the ID of the user who created or uploaded self . This is part of the from object in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

ID of the user who created the entry. This string is by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_from_name ()

const gchar *
zpj_skydrive_entry_get_from_name (ZpjSkydriveEntry *self);

Gets the name of the user who created or uploaded self . This is part of the from object in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

name of the user who created the entry. This string is by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_id ()

const gchar *
zpj_skydrive_entry_get_id (ZpjSkydriveEntry *self);

Gets the ID of self . This is the value of the id member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

the entry's ID. This string is owned by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_name ()

const gchar *
zpj_skydrive_entry_get_name (ZpjSkydriveEntry *self);

Gets the name of self . This is the value of the name member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

name of the entry. This string is owned by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_parent_id ()

const gchar *
zpj_skydrive_entry_get_parent_id (ZpjSkydriveEntry *self);

Gets the ID of the folder containing self . This is the value of the parent_id member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

ID of the parent folder. This string is owned by the ZpjSkydriveEntry and should not be modified or freed.

[transfer none]


zpj_skydrive_entry_get_updated_time ()

GDateTime *
zpj_skydrive_entry_get_updated_time (ZpjSkydriveEntry *self);

Gets the time at which self was last updated. This is the value of the updated_time member in the JSON returned by the server.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

a GDateTime representing the time at which the entry was last updated. The returned time is owned by the ZpjSkydriveEntry and should not be unreferenced.

[transfer none]


zpj_skydrive_entry_is_folder ()

gboolean
zpj_skydrive_entry_is_folder (ZpjSkydriveEntry *self);

Whether self is a folder.

Parameters

self

A ZpjSkydriveEntry.

 

Returns

TRUE if the entry is a folder.

Types and Values

struct ZpjSkydriveEntry

struct ZpjSkydriveEntry;

The ZpjSkydriveEntry structure contains only private data and should only be accessed using the provided API.


struct ZpjSkydriveEntryClass

struct ZpjSkydriveEntryClass {
  GObjectClass parent_class;

  void    (*parse_json_node)    (ZpjSkydriveEntry *self, JsonNode *node);
};

Class structure for ZpjSkydriveEntry.

Members

parse_json_node ()

Virtual function that subclasses may implement to parse data specific to them in the JSON returned by the server. Implementations must chain up to their parent classes.

 

enum ZpjSkydriveEntryType

The types of Skydrive

objects.

This enumeration can be expanded at a later date.

Members

ZPJ_SKYDRIVE_ENTRY_TYPE_FILE

A file.

 

ZPJ_SKYDRIVE_ENTRY_TYPE_FOLDER

A folder.

 

ZPJ_SKYDRIVE_ENTRY_TYPE_PHOTO

A photo.

 

ZPJ_SKYDRIVE_ENTRY_TYPE_INVALID

Invalid or unknown object.

 

Property Details

The “created-time” property

  “created-time”             GDateTime *

The date and time when the entry was created.

Owner: ZpjSkydriveEntry

Flags: Read


The “description” property

  “description”              char *

A brief description of this entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “from-id” property

  “from-id”                  char *

The ID of the user created this entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “from-name” property

  “from-name”                char *

The name of the user created this entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “id” property

  “id”                       char *

Unique identifier corresponding to this entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “json” property

  “json”                     JsonNode *

The JSON node representing this entry.

Owner: ZpjSkydriveEntry

Flags: Write / Construct Only


The “name” property

  “name”                     char *

Human readable name of this entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “parent-id” property

  “parent-id”                char *

Unique identifier corresponding to the parent entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: NULL


The “type” property

  “type”                     ZpjSkydriveEntryType

Indicates whether this entry is a file or a entry.

Owner: ZpjSkydriveEntry

Flags: Read

Default value: ZPJ_SKYDRIVE_ENTRY_TYPE_INVALID


The “updated-time” property

  “updated-time”             GDateTime *

The date and time when the entry was last updated.

Owner: ZpjSkydriveEntry

Flags: Read