FolksNoteFieldDetails

FolksNoteFieldDetails — Object representing a note that can have some parameters associated with it.

Synopsis

#define             FOLKS_TYPE_NOTE_FIELD_DETAILS
FolksNoteFieldDetails * folks_note_field_details_new    (const gchar *value,
                                                         GeeMultiMap *parameters,
                                                         const gchar *uid);
const gchar *       folks_note_field_details_get_uid    (FolksNoteFieldDetails *self);
void                folks_note_field_details_set_uid    (FolksNoteFieldDetails *self,
                                                         const gchar *value);
struct              FolksNoteFieldDetails;
void                folks_note_details_change_notes     (FolksNoteDetails *self,
                                                         GeeSet *notes,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);
void                folks_note_details_change_notes_finish
                                                        (FolksNoteDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);
GeeSet *            folks_note_details_get_notes        (FolksNoteDetails *self);
void                folks_note_details_set_notes        (FolksNoteDetails *self,
                                                         GeeSet *value);
                    FolksNoteDetails;

Object Hierarchy

  GObject
   +----FolksAbstractFieldDetails
         +----FolksNoteFieldDetails

  GInterface
   +----FolksNoteDetails

Prerequisites

FolksNoteDetails requires GObject.

Known Implementations

FolksNoteDetails is implemented by FolksIndividual.

Properties

  "id"                       gchar*                : Read / Write
  "uid"                      gchar*                : Read / Write
  "notes"                    GeeSet*               : Read / Write

Description

See FolksAbstractFieldDetails for details on common parameter names and values.

Details

FOLKS_TYPE_NOTE_FIELD_DETAILS

#define FOLKS_TYPE_NOTE_FIELD_DETAILS (folks_note_field_details_get_type ())

The type for FolksNoteFieldDetails.

folks_note_field_details_new ()

FolksNoteFieldDetails * folks_note_field_details_new    (const gchar *value,
                                                         GeeMultiMap *parameters,
                                                         const gchar *uid);

Create a new NoteFieldDetails.

`value` :	the value of the field, which should be a non-empty free-form UTF-8 string as entered by the user. [in]
`parameters` :	initial parameters. See "parameters". A `null` value is equivalent to a empty map of parameters. [in][allow-none]
Returns :	a new NoteFieldDetails

Since 0.6.0

folks_note_field_details_get_uid ()

const gchar *       folks_note_field_details_get_uid    (FolksNoteFieldDetails *self);

`self` :	the FolksNoteFieldDetails instance to query
Returns :	the value of the "uid" property

folks_note_field_details_set_uid ()

void                folks_note_field_details_set_uid    (FolksNoteFieldDetails *self,
                                                         const gchar *value);

`self` :	the FolksNoteFieldDetails instance to modify
`value` :	the new value of the "uid" property

struct FolksNoteFieldDetails

struct FolksNoteFieldDetails;

Object representing a note that can have some parameters associated with it.

See FolksAbstractFieldDetails for details on common parameter names and values.

Since 0.6.0

folks_note_details_change_notes ()

void                folks_note_details_change_notes     (FolksNoteDetails *self,
                                                         GeeSet *notes,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change the contact's notes.

It's preferred to call this rather than setting "notes" directly, as this method gives error notification and will only return once the notes have been written to the relevant backing store (or the operation's failed).

`self` :	the FolksNoteDetails instance
`notes` :	the set of notes. [in]
`_callback_` :	callback to call when the request is satisfied. [scope async]
`_user_data_` :	the data to pass to `_callback_` function. [closure]

Since 0.6.2

folks_note_details_change_notes_finish ()

void                folks_note_details_change_notes_finish
                                                        (FolksNoteDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change the contact's notes.

`self` :	the FolksNoteDetails instance
`_res_` :	a GAsyncResult
`error` :	location to store the error occuring, or `NULL` to ignore. [error-domains FolksPropertyError]

Since 0.6.2

folks_note_details_get_notes ()

GeeSet *            folks_note_details_get_notes        (FolksNoteDetails *self);

`self` :	the FolksNoteDetails instance to query
Returns :	the value of the "notes" property

folks_note_details_set_notes ()

void                folks_note_details_set_notes        (FolksNoteDetails *self,
                                                         GeeSet *value);

`self` :	the FolksNoteDetails instance to modify
`value` :	the new value of the "notes" property

FolksNoteDetails

typedef struct _FolksNoteDetails FolksNoteDetails;

This interface represents the list of notes associated to a FolksPersona and FolksIndividual.

Since 0.4.0

Property Details

The `"id"` property

  "id"                       gchar*                : Read / Write

id.

Default value: NULL

The `"uid"` property

  "uid"                      gchar*                : Read / Write

The UID of the note (if any).