FolksUrlFieldDetails

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

Functions

Properties

GeeSet * urls Read / Write

Types and Values

Object Hierarchy

    GInterface
    ╰── FolksUrlDetails
    GObject
    ╰── FolksAbstractFieldDetails
        ╰── FolksUrlFieldDetails

Prerequisites

FolksUrlDetails requires GObject.

Known Implementations

FolksUrlDetails is implemented by FolksIndividual.

Description

See FolksAbstractFieldDetails for details on common parameter names and values.

Functions

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_new ()

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

Create a new UrlFieldDetails.

Parameters

value

 .

the value of the field, a non-empty URI

.

[in]

parameters

 .

initial parameters. See "parameters". A null value is equivalent to an empty map of parameters.

.

[in][allow-none]

Returns

a new UrlFieldDetails

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).

FolksPropertyError will be returned in error

if setting the URLs failed

See also: folks_url_details_change_urls_finish()

Parameters

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).

FolksPropertyError will be returned in error

if setting the URLs failed

See also: folks_url_details_change_urls()

Parameters

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);

Get and return the current value of the "urls" property.

The websites of the contact.

A list or websites associated to the contact.

Parameters

self

the FolksUrlDetails instance to query

 

Returns

the value of the "urls" property

Since 0.5.1


folks_url_details_set_urls ()

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

Set the value of the "urls" property to value .

The websites of the contact.

A list or websites associated to the contact.

Parameters

self

the FolksUrlDetails instance to modify

 

value

the new value of the "urls" property

 

Since 0.5.1

Types and Values

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


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


struct FolksUrlFieldDetailsClass

struct FolksUrlFieldDetailsClass {
	FolksAbstractFieldDetailsClass parent_class;
};

The class structure for FOLKS_TYPE_URL_FIELD_DETAILS. All the fields in this structure are private and should never be accessed directly.

Members

FolksAbstractFieldDetailsClass parent_class;

the parent class structure

 

FolksUrlDetails

typedef struct _FolksUrlDetails FolksUrlDetails;

Associates a list of URLs with a contact.

Since 0.3.5


struct FolksUrlDetailsIface

struct FolksUrlDetailsIface {
	GTypeInterface parent_iface;
	void (*change_urls) (FolksUrlDetails* self, GeeSet* urls, GAsyncReadyCallback _callback_, gpointer _user_data_);
	void (*change_urls_finish) (FolksUrlDetails* self, GAsyncResult* _res_, GError** error);
	GeeSet* (*get_urls) (FolksUrlDetails* self);
	void (*set_urls) (FolksUrlDetails* self, GeeSet* value);
};

Interface for creating FolksUrlDetails implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

 

change_urls ()

virtual method called by folks_url_details_change_urls()

 

change_urls_finish ()

asynchronous finish function for change_urls, called by folks_url_details_change_urls()

 

get_urls ()

getter method for the abstract property "urls"

 

set_urls ()

setter method for the abstract property "urls"

 

Property Details

The “urls” property

  “urls”                     GeeSet *

The websites of the contact.

A list or websites associated to the contact.

Flags: Read / Write

Since 0.5.1