FolksPhoneFieldDetails

FolksPhoneFieldDetails — Object representing a phone number that can have some parameters associated with it.

Synopsis

#define             FOLKS_TYPE_PHONE_FIELD_DETAILS
gchar *             folks_phone_field_details_get_normalised
                                                        (FolksPhoneFieldDetails *self);
FolksPhoneFieldDetails * folks_phone_field_details_new  (const gchar *value,
                                                         GeeMultiMap *parameters);
struct              FolksPhoneFieldDetails;
void                folks_phone_details_change_phone_numbers
                                                        (FolksPhoneDetails *self,
                                                         GeeSet *phone_numbers,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);
void                folks_phone_details_change_phone_numbers_finish
                                                        (FolksPhoneDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);
GeeSet *            folks_phone_details_get_phone_numbers
                                                        (FolksPhoneDetails *self);
void                folks_phone_details_set_phone_numbers
                                                        (FolksPhoneDetails *self,
                                                         GeeSet *value);
                    FolksPhoneDetails;

Object Hierarchy

  GObject
   +----FolksAbstractFieldDetails
         +----FolksPhoneFieldDetails
  GInterface
   +----FolksPhoneDetails

Prerequisites

FolksPhoneDetails requires GObject.

Known Implementations

FolksPhoneDetails is implemented by FolksIndividual.

Properties

  "id"                       gchar*                : Read / Write
  "phone-numbers"            GeeSet*               : Read / Write

Description

See FolksAbstractFieldDetails for details on common parameter names and values.

Details

FOLKS_TYPE_PHONE_FIELD_DETAILS

#define FOLKS_TYPE_PHONE_FIELD_DETAILS (folks_phone_field_details_get_type ())

The type for FolksPhoneFieldDetails.


folks_phone_field_details_get_normalised ()

gchar *             folks_phone_field_details_get_normalised
                                                        (FolksPhoneFieldDetails *self);

Return this object's normalised phone number.

Typical normalisations:

  • - `1-800-123-4567` → `18001234567`

    - `+1-800-123-4567` → `18001234567`

    - `+1-800-123-4567P123` → `18001234567P123`

self :

the FolksPhoneFieldDetails instance

Returns :

the normalised form of `number`

Since 0.6.0


folks_phone_field_details_new ()

FolksPhoneFieldDetails * folks_phone_field_details_new  (const gchar *value,
                                                         GeeMultiMap *parameters);

Create a new PhoneFieldDetails.

value :

the value of the field, which should be a non-empty phone number (no particular format is mandated). [in]

parameters :

initial parameters. See "parameters". A `null` value is equivalent to a empty map of parameters. [in][allow-none]

Returns :

a new PhoneFieldDetails

Since 0.6.0


struct FolksPhoneFieldDetails

struct FolksPhoneFieldDetails;

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

See FolksAbstractFieldDetails for details on common parameter names and values.

Since 0.6.0


folks_phone_details_change_phone_numbers ()

void                folks_phone_details_change_phone_numbers
                                                        (FolksPhoneDetails *self,
                                                         GeeSet *phone_numbers,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change the contact's phone numbers.

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

See also: folks_phone_details_change_phone_numbers_finish()

self :

the FolksPhoneDetails instance

phone_numbers :

the set of phone numbers. [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_phone_details_change_phone_numbers_finish ()

void                folks_phone_details_change_phone_numbers_finish
                                                        (FolksPhoneDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change the contact's phone numbers.

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

See also: folks_phone_details_change_phone_numbers()

self :

the FolksPhoneDetails instance

_res_ :

a GAsyncResult

error :

location to store the error occuring, or NULL to ignore. [error-domains FolksPropertyError]

Since 0.6.2


folks_phone_details_get_phone_numbers ()

GeeSet *            folks_phone_details_get_phone_numbers
                                                        (FolksPhoneDetails *self);

self :

the FolksPhoneDetails instance to query

Returns :

the value of the "phone-numbers" property

folks_phone_details_set_phone_numbers ()

void                folks_phone_details_set_phone_numbers
                                                        (FolksPhoneDetails *self,
                                                         GeeSet *value);

self :

the FolksPhoneDetails instance to modify

value :

the new value of the "phone-numbers" property

FolksPhoneDetails

typedef struct _FolksPhoneDetails FolksPhoneDetails;

Interface for classes that can provide a phone number, such as FolksPersona and FolksIndividual.

Since 0.3.5

Property Details

The "id" property

  "id"                       gchar*                : Read / Write

id.

Default value: NULL


The "phone-numbers" property

  "phone-numbers"            GeeSet*               : Read / Write

The phone numbers of the contact.

A list of phone numbers associated to the contact.

Since 0.6.0