Blame docs/reference/html/GDataGContactEvent.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataGContactEvent: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch10.html" title="GContact API">
Packit 4b6dd7
<link rel="prev" href="GDataGContactCalendar.html" title="GDataGContactCalendar">
Packit 4b6dd7
<link rel="next" href="GDataGContactExternalID.html" title="GDataGContactExternalID">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataGContactEvent

Packit 4b6dd7

GDataGContactEvent — gContact event element

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataGContactEvent *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_new ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_get_date ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_set_date ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_get_relation_type ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_set_relation_type ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_get_label ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_gcontact_event_set_label ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDate *
Packit 4b6dd7
date
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
label
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
relation-type
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
#define
Packit 4b6dd7
GDATA_GCONTACT_EVENT_ANNIVERSARY
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
#define
Packit 4b6dd7
GDATA_GCONTACT_EVENT_OTHER
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataGContactEvent
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataGContactEventClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataParsable
Packit 4b6dd7
        ╰── GDataGContactEvent
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/gcontact/gdata-gcontact-event.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataGContactEvent represents a "event" element from the

Packit 4b6dd7
gContact specification.
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_new ()

Packit 4b6dd7
GDataGContactEvent *
Packit 4b6dd7
gdata_gcontact_event_new (const GDate *date,
Packit 4b6dd7
                          const gchar *relation_type,
Packit 4b6dd7
                          const gchar *label);
Packit 4b6dd7

Creates a new GDataGContactEvent. More information is available in the gContact specification.

Packit 4b6dd7

Exactly one of relation_type

Packit 4b6dd7
 and label
Packit 4b6dd7
 should be provided; the other must be NULL.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

date

Packit 4b6dd7

the date of the event

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

relation_type

Packit 4b6dd7

the relationship between the event and its owner, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

label

Packit 4b6dd7

a human-readable label for the event, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a new GDataGContactEvent; unref with g_object_unref()

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_get_date ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_gcontact_event_get_date (GDataGContactEvent *self,
Packit 4b6dd7
                               GDate *date);
Packit 4b6dd7

Gets the “date” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

date

Packit 4b6dd7

return location for the date of the event.

Packit 4b6dd7
[out caller-allocates]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_set_date ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_gcontact_event_set_date (GDataGContactEvent *self,
Packit 4b6dd7
                               const GDate *date);
Packit 4b6dd7

Sets the “date” property to date

Packit 4b6dd7
.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

date

Packit 4b6dd7

the new date for the event

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_get_relation_type ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_gcontact_event_get_relation_type
Packit 4b6dd7
                               (GDataGContactEvent *self);
Packit 4b6dd7

Gets the “relation-type” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the event's relation type, or NULL

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_set_relation_type ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_gcontact_event_set_relation_type
Packit 4b6dd7
                               (GDataGContactEvent *self,
Packit 4b6dd7
                                const gchar *relation_type);
Packit 4b6dd7

Sets the “relation-type” property to relation_type

Packit 4b6dd7
Packit 4b6dd7
such as GDATA_GCONTACT_EVENT_ANNIVERSARY or GDATA_GCONTACT_EVENT_OTHER.

Packit 4b6dd7

If relation_type

Packit 4b6dd7
 is NULL, the relation type will be unset. When the GDataGContactEvent is used in a query, however,
Packit 4b6dd7
exactly one of “relation-type” and “label” must be NULL.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

relation_type

Packit 4b6dd7

the new relation type for the event, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_get_label ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_gcontact_event_get_label (GDataGContactEvent *self);
Packit 4b6dd7

Gets the “label” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the event's label, or NULL

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_gcontact_event_set_label ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_gcontact_event_set_label (GDataGContactEvent *self,
Packit 4b6dd7
                                const gchar *label);
Packit 4b6dd7

Sets the “label” property to label

Packit 4b6dd7
.

Packit 4b6dd7

If label

Packit 4b6dd7
 is NULL, the label will be unset. When the GDataGContactEvent is used in a query, however,
Packit 4b6dd7
exactly one of “relation-type” and “label” must be NULL.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataGContactEvent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

label

Packit 4b6dd7

the new label for the event, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDATA_GCONTACT_EVENT_ANNIVERSARY

Packit 4b6dd7
#define GDATA_GCONTACT_EVENT_ANNIVERSARY "anniversary"
Packit 4b6dd7
Packit 4b6dd7

The relation type URI for an anniversary event.

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
gContact specification.

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDATA_GCONTACT_EVENT_OTHER

Packit 4b6dd7
#define GDATA_GCONTACT_EVENT_OTHER "other"
Packit 4b6dd7
Packit 4b6dd7

The relation type URI for a miscellaneous event.

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
gContact specification.

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataGContactEvent

Packit 4b6dd7
typedef struct _GDataGContactEvent GDataGContactEvent;
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataGContactEventClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
} GDataGContactEventClass;
Packit 4b6dd7
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “date” property

Packit 4b6dd7
  “date”                     GDate *
Packit 4b6dd7

The date of the event.

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
GContact specification.
Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “label” property

Packit 4b6dd7
  “label”                    gchar *
Packit 4b6dd7

A simple string value used to name this event. It is mutually exclusive with “relation-type”.

Packit 4b6dd7
It allows UIs to display a label such as "Wedding anniversary".

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
gContact specification.
Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “relation-type” property

Packit 4b6dd7
  “relation-type”            gchar *
Packit 4b6dd7

A programmatic value that identifies the type of event. It is mutually exclusive with “label”.

Packit 4b6dd7
Examples are GDATA_GCONTACT_EVENT_ANNIVERSARY or GDATA_GCONTACT_EVENT_OTHER.

Packit 4b6dd7

For more information, see the

Packit 4b6dd7
gContact specification.
Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>