GDataGDReminder

## GDataGDReminder GDataGDReminder — GData reminder element |

## Stability Level

Unstable, unless otherwise indicated

## Synopsis

    #include <gdata/gd/gdata-gd-reminder.h>

                        GDataGDReminder;
                        GDataGDReminderClass;
    GDataGDReminder *   gdata_gd_reminder_new               (const gchar *method,
                                                             GTimeVal *absolute_time,
                                                             gint relative_time);
    gint                gdata_gd_reminder_compare           (const GDataGDReminder *a,
                                                             const GDataGDReminder *b);
    const gchar *       gdata_gd_reminder_get_method        (GDataGDReminder *self);
    void                gdata_gd_reminder_set_method        (GDataGDReminder *self,
                                                             const gchar *method);
    void                gdata_gd_reminder_get_absolute_time (GDataGDReminder *self,
                                                             GTimeVal *absolute_time);
    void                gdata_gd_reminder_set_absolute_time (GDataGDReminder *self,
                                                             GTimeVal *absolute_time);
    gboolean            gdata_gd_reminder_is_absolute_time  (GDataGDReminder *self);
    gint                gdata_gd_reminder_get_relative_time (GDataGDReminder *self);
    void                gdata_gd_reminder_set_relative_time (GDataGDReminder *self,
                                                             gint relative_time);

## Object Hierarchy

      GObject
       +----GDataParsable
             +----GDataGDReminder

## Properties

      "absolute-time"            GDataTimeVal*         : Read / Write
      "is-absolute-time"         gboolean              : Read
      "method"                   gchar*                : Read / Write
      "relative-time"            gint                  : Read / Write

## Description

GDataGDReminder represents a "reminder" element from the GData specification.

## Details

### GDataGDReminder

    typedef struct _GDataGDReminder GDataGDReminder;

All the fields in the GDataGDReminder structure are private and should never be accessed directly.

Since 0.2.0

### GDataGDReminderClass

    typedef struct {
    } GDataGDReminderClass;

All the fields in the GDataGDReminderClass structure are private and should never be accessed directly.

Since 0.4.0

### gdata_gd_reminder_new ()

    GDataGDReminder *   gdata_gd_reminder_new               (const gchar *method,
                                                             GTimeVal *absolute_time,
                                                             gint relative_time);

Creates a new GDataGDReminder. More information is available in the GData specification.

`method` : | the notification method the reminder should use, or `NULL`. [allow-none]
`absolute_time` : | the absolute time for the reminder, or `NULL`. [allow-none]
`relative_time` : | the relative time for the reminder, in minutes, or `-1`
Returns : | a new GDataGDReminder, or `NULL`; unref with `g_object_unref()`

Since 0.2.0

### gdata_gd_reminder_compare ()

    gint                gdata_gd_reminder_compare           (const GDataGDReminder *a,
                                                             const GDataGDReminder *b);

Compares the two reminders in a `strcmp()` fashion. `NULL` values are handled gracefully, with `0` returned if both `a` and `b` are `NULL`, `-1` if `a` is `NULL` and `1` if `b` is `NULL`.

The comparison of non-`NULL` values is done on the basis all the properties of the GDataGDReminders.

`a` : | a GDataGDReminder, or `NULL`
`b` : | another GDataGDReminder, or `NULL`
Returns : | `0` if `a` equals `b`, `-1` or `1` as appropriate otherwise

Since 0.4.0

### gdata_gd_reminder_get_method ()

    const gchar *       gdata_gd_reminder_get_method        (GDataGDReminder *self);

Gets the "method" property.

`self` : | a GDataGDReminder
Returns : | the method, or `NULL`

Since 0.4.0

### gdata_gd_reminder_set_method ()

    void                gdata_gd_reminder_set_method        (GDataGDReminder *self,
                                                             const gchar *method);

Sets the "method" property to `method`.

Set `method` to `NULL` to unset the property.

`self` : | a GDataGDReminder
`method` : | the new method, or `NULL`. [allow-none]

Since 0.4.0

### gdata_gd_reminder_get_absolute_time ()

    void                gdata_gd_reminder_get_absolute_time (GDataGDReminder *self,
                                                             GTimeVal *absolute_time);

Gets the "absolute-time" property and returns it in `absolute_time`. If the property is unset, both fields of `start_time` are set to `0`.

`self` : | a GDataGDReminder
`absolute_time` : | return location for the absolute time. [out caller-allocates]

Since 0.4.0

### gdata_gd_reminder_set_absolute_time ()

    void                gdata_gd_reminder_set_absolute_time (GDataGDReminder *self,
                                                             GTimeVal *absolute_time);

Sets the "absolute-time" property to `absolute_time`.

Set `absolute_time` to `NULL` to unset the property.

`self` : | a GDataGDReminder
`absolute_time` : | the new absolute time, or `NULL`. [allow-none]

Since 0.4.0

### gdata_gd_reminder_is_absolute_time ()

    gboolean            gdata_gd_reminder_is_absolute_time  (GDataGDReminder *self);

Returns whether the reminder is specified as an absolute time, or as a number of minutes after the corresponding event's start time.

`self` : | a GDataGDReminder
Returns : | `TRUE` if the reminder is absolute, `FALSE` otherwise

Since 0.4.0

### gdata_gd_reminder_get_relative_time ()

    gint                gdata_gd_reminder_get_relative_time (GDataGDReminder *self);

Gets the "relative-time" property.

`self` : | a GDataGDReminder
Returns : | the relative time, or `-1`

Since 0.4.0

### gdata_gd_reminder_set_relative_time ()

    void                gdata_gd_reminder_set_relative_time (GDataGDReminder *self,
                                                             gint relative_time);

Sets the "relative-time" property to `relative_time`.

Set `relative_time` to `-1` to unset the property.

`self` : | a GDataGDReminder
`relative_time` : | the new relative time, or `-1`

Since 0.4.0

## Property Details

### The `"absolute-time"` property

      "absolute-time"            GDataTimeVal*         : Read / Write

Absolute time at which the reminder should be issued.

For more information, see the GData specification.

Since 0.4.0

### The `"is-absolute-time"` property

      "is-absolute-time"         gboolean              : Read

Whether the reminder is specified in terms of an absolute or relative time.

For more information, see the GData specification.

Default value: FALSE

Since 0.4.0

### The `"method"` property

      "method"                   gchar*                : Read / Write

The notification method the reminder should use.

For more information, see the GData specification.

Default value: NULL

Since 0.4.0

### The `"relative-time"` property

      "relative-time"            gint                  : Read / Write

Time at which the reminder should be issued, in minutes relative to the start time of the corresponding event.

For more information, see the GData specification.

Allowed values: >= G_MAXULONG

Default value: -1

Since 0.4.0