![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
#include <gdata/gd/gdata-gd-reminder.h> #define GDATA_GD_REMINDER_ALERT #define GDATA_GD_REMINDER_EMAIL #define GDATA_GD_REMINDER_SMS GDataGDReminder; GDataGDReminderClass; GDataGDReminder * gdata_gd_reminder_new (const gchar *method
,gint64 absolute_time
,gint relative_time
); const gchar * gdata_gd_reminder_get_method (GDataGDReminder *self
); void gdata_gd_reminder_set_method (GDataGDReminder *self
,const gchar *method
); gint64 gdata_gd_reminder_get_absolute_time (GDataGDReminder *self
); void gdata_gd_reminder_set_absolute_time (GDataGDReminder *self
,gint64 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
);
"absolute-time" gint64 : Read / Write "is-absolute-time" gboolean : Read "method" gchar* : Read / Write "relative-time" gint : Read / Write
#define GDATA_GD_REMINDER_ALERT "alert"
The "method" for an alert to appear in the user's browser.
Since 0.7.0
#define GDATA_GD_REMINDER_EMAIL "email"
The "method" for an alert to be sent to the user by e-mail.
Since 0.7.0
#define GDATA_GD_REMINDER_SMS "sms"
The "method" for an alert to be sent to the user by SMS.
Since 0.7.0
typedef struct _GDataGDReminder GDataGDReminder;
All the fields in the GDataGDReminder structure are private and should never be accessed directly.
Since 0.2.0
typedef struct { } GDataGDReminderClass;
All the fields in the GDataGDReminderClass structure are private and should never be accessed directly.
Since 0.4.0
GDataGDReminder * gdata_gd_reminder_new (const gchar *method
,gint64 absolute_time
,gint relative_time
);
Creates a new GDataGDReminder. More information is available in the GData specification.
|
the notification method the reminder should use, or NULL . [allow-none]
|
|
the absolute time for the reminder, or -1
|
|
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
const gchar * gdata_gd_reminder_get_method (GDataGDReminder *self
);
Gets the "method" property.
|
a GDataGDReminder |
Returns : |
the method, or NULL
|
Since 0.4.0
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.
|
a GDataGDReminder |
|
the new method, or NULL . [allow-none]
|
Since 0.4.0
gint64 gdata_gd_reminder_get_absolute_time (GDataGDReminder *self
);
Gets the "absolute-time" property. If the property is unset, -1
will be returned.
|
a GDataGDReminder |
Returns : |
the UNIX timestamp of the absolute time for the reminder, or -1
|
Since 0.4.0
void gdata_gd_reminder_set_absolute_time (GDataGDReminder *self
,gint64 absolute_time
);
Sets the "absolute-time" property to absolute_time
.
Set absolute_time
to -1
to unset the property.
|
a GDataGDReminder |
|
the new absolute time, or -1
|
Since 0.4.0
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.
|
a GDataGDReminder |
Returns : |
TRUE if the reminder is absolute, FALSE otherwise |
Since 0.4.0
gint gdata_gd_reminder_get_relative_time (GDataGDReminder *self
);
Gets the "relative-time" property.
|
a GDataGDReminder |
Returns : |
the relative time, or -1
|
Since 0.4.0
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.
|
a GDataGDReminder |
|
the new relative time, or -1
|
Since 0.4.0
"absolute-time"
property "absolute-time" gint64 : Read / Write
Absolute time at which the reminder should be issued.
For more information, see the GData specification.
Allowed values: >= -1
Default value: -1
Since 0.4.0
"is-absolute-time"
property "is-absolute-time" gboolean : Read
Whether the reminder is specified as an absolute or relative time.
For more information, see the GData specification.
Default value: FALSE
Since 0.4.0
"method"
property "method" gchar* : Read / Write
The notification method the reminder should use. For example: GDATA_GD_REMINDER_ALERT
or GDATA_GD_REMINDER_EMAIL
.
For more information, see the GData specification.
Default value: NULL
Since 0.4.0
"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