Folks.AbstractFieldDetails – folks – Vala Binding Reference

Description:

public abstract class AbstractFieldDetails<T> : Object

Object representing any type of value that can have some vCard-like parameters associated with it.

Some contact details, like phone numbers or URLs, can have some extra details associated with them. For instance, a phone number expressed in vcard notation as tel;type=work,voice:(111) 555-1234 would be represented as a AbstractFieldDetails with value "(111) 555-1234" and with parameters ['type': ('work', 'voice')].

The parameter name "type" with values "work", "home", or "other" are common amongst most vCard attributes (and thus most AbstractFieldDetails-derived classes). A "type" of "pref" may be used to indicate a preferred AbstractFieldDetails.value amongst many. See specific classes for information on additional parameters and values specific to that class.

See RFC2426 for more details on pre-defined parameter names and values.

Since:

0.6.0

Namespace: Folks

Package: folks

Content:

Constants:

public const unowned string PARAM_TYPE

Parameter name for classifying the type of value this field contains.

public const unowned string PARAM_TYPE_HOME

Parameter value for home-related field values.

public const unowned string PARAM_TYPE_WORK

Parameter value for work-related field values.

public const unowned string PARAM_TYPE_OTHER

Parameter value for miscellaneous field values.

Properties:

public virtual T value { construct set; get; }

The value of the field.

public Type value_type { get; }

The GLib.Type of the AbstractFieldDetails.value.

public virtual string id { set; get; }

A unique ID (if any) for this specific detail.

public virtual MultiMap<string,string> parameters { construct set; get; }

The parameters associated with the value.

Static methods:

public static bool equal_static (AbstractFieldDetails left, AbstractFieldDetails right)

Same as AbstractFieldDetails.equal, but static, so we can use libgee 0.8 without an API break.

public static uint hash_static (AbstractFieldDetails value)

Same as AbstractFieldDetails.hash, but static, so we can use libgee 0.8 without an API break.

Creation methods:

Methods:

public Collection<string>? get_parameter_values (string parameter_name)

Get the values for a parameter

public void add_parameter (string parameter_name, string parameter_value)

Add a new value for a parameter.

public void set_parameter (string parameter_name, string parameter_value)

Set the value of a parameter.

public void extend_parameters (MultiMap<string,string> additional)

Extend the existing parameters.

public void remove_parameter_all (string parameter_name)

Remove all instances of a parameter.

public virtual bool equal (AbstractFieldDetails<T> that)

A fairly-strict equality function for AbstractFieldDetails.

public virtual bool parameters_equal (AbstractFieldDetails<T> that)

An equality function which only considers parameters.

public virtual bool values_equal (AbstractFieldDetails<T> that)

An equality function which does not consider parameters.

public virtual uint hash ()

A hash function for the AbstractFieldDetails.

Inherited Members:

All known members inherited from class GLib.Object

@new
newv
new_valist
get_type
get_class
@ref
unref
ref_sink
weak_ref
weak_unref
add_weak_pointer
remove_weak_pointer

@get
@set
get_property
set_property
get_data
set_data
set_data_full
steal_data
get_qdata
set_qdata
set_qdata_full
steal_qdata

freeze_notify
thaw_notify
dispose
constructed
notify_property
connect
disconnect
add_toggle_ref
remove_toggle_ref
bind_property
notify
ref_count

AbstractFieldDetails

Object Hierarchy: