FolksUrlFieldDetails

FolksUrlFieldDetails — Object representing a URL that can have some parameters associated with it.

Synopsis

#define             FOLKS_TYPE_URL_FIELD_DETAILS
#define             FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_HOME_PAGE
#define             FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_BLOG
#define             FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_PROFILE
#define             FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_FTP
FolksUrlFieldDetails * folks_url_field_details_new      (const gchar *value,
                                                         GeeMultiMap *parameters);
struct              FolksUrlFieldDetails;
void                folks_url_details_change_urls       (FolksUrlDetails *self,
                                                         GeeSet *urls,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);
void                folks_url_details_change_urls_finish
                                                        (FolksUrlDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);
GeeSet *            folks_url_details_get_urls          (FolksUrlDetails *self);
void                folks_url_details_set_urls          (FolksUrlDetails *self,
                                                         GeeSet *value);
                    FolksUrlDetails;

Object Hierarchy

  GObject
   +----FolksAbstractFieldDetails
         +----FolksUrlFieldDetails
  GInterface
   +----FolksUrlDetails

Prerequisites

FolksUrlDetails requires GObject.

Known Implementations

FolksUrlDetails is implemented by FolksIndividual.

Properties

  "urls"                     GeeSet*               : Read / Write

Description

See FolksAbstractFieldDetails for details on common parameter names and values.

Details

FOLKS_TYPE_URL_FIELD_DETAILS

#define FOLKS_TYPE_URL_FIELD_DETAILS (folks_url_field_details_get_type ())

The type for FolksUrlFieldDetails.


FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_HOME_PAGE

#define FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_HOME_PAGE "x-home-page"

Parameter value for URLs for the contact's home page.

Value for a parameter with name FOLKS_ABSTRACT_FIELD_DETAILS_PARAM_TYPE.

Since 0.6.3


FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_BLOG

#define FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_BLOG "x-blog"

Parameter value for URLs for the contact's personal or professional blog.

Value for a parameter with name FOLKS_ABSTRACT_FIELD_DETAILS_PARAM_TYPE.

Since 0.6.3


FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_PROFILE

#define FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_PROFILE "x-profile"

Parameter value for URLs for the contact's social networking profile.

Value for a parameter with name FOLKS_ABSTRACT_FIELD_DETAILS_PARAM_TYPE.

Since 0.6.3


FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_FTP

#define FOLKS_URL_FIELD_DETAILS_PARAM_TYPE_FTP "x-ftp"

Parameter value for URLs for the contact's personal or professional FTP server.

Value for a parameter with name FOLKS_ABSTRACT_FIELD_DETAILS_PARAM_TYPE.

Since 0.6.3


folks_url_field_details_new ()

FolksUrlFieldDetails * folks_url_field_details_new      (const gchar *value,
                                                         GeeMultiMap *parameters);

Create a new UrlFieldDetails.

value :

the value of the field, a non-empty URI. [in]

parameters :

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

Returns :

a new UrlFieldDetails

Since 0.6.0


struct FolksUrlFieldDetails

struct FolksUrlFieldDetails;

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

See FolksAbstractFieldDetails for details on common parameter names and values.

Since 0.6.0


folks_url_details_change_urls ()

void                folks_url_details_change_urls       (FolksUrlDetails *self,
                                                         GeeSet *urls,
                                                         GAsyncReadyCallback _callback_,
                                                         gpointer _user_data_);

Change the contact's URLs.

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

See also: folks_url_details_change_urls_finish()

self :

the FolksUrlDetails instance

urls :

the set of URLs. [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_url_details_change_urls_finish ()

void                folks_url_details_change_urls_finish
                                                        (FolksUrlDetails *self,
                                                         GAsyncResult *_res_,
                                                         GError **error);

Change the contact's URLs.

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

See also: folks_url_details_change_urls()

self :

the FolksUrlDetails instance

_res_ :

a GAsyncResult

error :

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

Since 0.6.2


folks_url_details_get_urls ()

GeeSet *            folks_url_details_get_urls          (FolksUrlDetails *self);

self :

the FolksUrlDetails instance to query

Returns :

the value of the "urls" property

folks_url_details_set_urls ()

void                folks_url_details_set_urls          (FolksUrlDetails *self,
                                                         GeeSet *value);

self :

the FolksUrlDetails instance to modify

value :

the new value of the "urls" property

FolksUrlDetails

typedef struct _FolksUrlDetails FolksUrlDetails;

Associates a list of URLs with a contact.

Since 0.3.5

Property Details

The "urls" property

  "urls"                     GeeSet*               : Read / Write

The websites of the contact.

A list or websites associated to the contact.

Since 0.5.1