folks Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Known Implementations | Properties |
FolksImFieldDetailsFolksImFieldDetails — Object representing an IM address value that can have some parameters associated with it. |
#define FOLKS_TYPE_IM_FIELD_DETAILS FolksImFieldDetails * folks_im_field_details_new (const gchar *value
,GeeMultiMap *parameters
); struct FolksImFieldDetails; enum FolksImDetailsError; void folks_im_details_change_im_addresses (FolksImDetails *self
,GeeMultiMap *im_addresses
,GAsyncReadyCallback _callback_
,gpointer _user_data_
); void folks_im_details_change_im_addresses_finish (FolksImDetails *self
,GAsyncResult *_res_
,GError **error
); GeeMultiMap * folks_im_details_get_im_addresses (FolksImDetails *self
); void folks_im_details_set_im_addresses (FolksImDetails *self
,GeeMultiMap *value
); gchar * folks_im_details_normalise_im_address (const gchar *im_address
,const gchar *protocol
,GError **error
); FolksImDetails;
GObject +----FolksAbstractFieldDetails +----FolksImFieldDetails
GInterface +----FolksImDetails
#define FOLKS_TYPE_IM_FIELD_DETAILS (folks_im_field_details_get_type ())
The type for FolksImFieldDetails.
FolksImFieldDetails * folks_im_field_details_new (const gchar *value
,GeeMultiMap *parameters
);
Create a new ImFieldDetails.
|
the value of the field, which should be a valid, non-empty IM address. [in] |
|
initial parameters. See "parameters". A `null` value is equivalent to an empty map of parameters. [in][allow-none] |
Returns : |
a new ImFieldDetails |
Since 0.6.0
struct FolksImFieldDetails;
Object representing an IM address value that can have some parameters associated with it.
See FolksAbstractFieldDetails.
Since 0.6.0
typedef enum { FOLKS_IM_DETAILS_ERROR_INVALID_IM_ADDRESS } FolksImDetailsError;
Errors related to IM addresses and IM address handling.
void folks_im_details_change_im_addresses (FolksImDetails *self
,GeeMultiMap *im_addresses
,GAsyncReadyCallback _callback_
,gpointer _user_data_
);
Change the contact's set of IM addresses.
It's preferred to call this rather than setting "im-addresses" directly, as this method gives error notification and will only return once the IM addresses have been written to the relevant backing store (or the operation's failed).
See also: folks_im_details_change_im_addresses_finish()
|
the FolksImDetails instance |
|
the new map of protocols to IM addresses. [in] |
|
callback to call when the request is satisfied. [scope async] |
|
the data to pass to _callback_ function. [closure]
|
Since 0.6.2
void folks_im_details_change_im_addresses_finish (FolksImDetails *self
,GAsyncResult *_res_
,GError **error
);
Change the contact's set of IM addresses.
It's preferred to call this rather than setting "im-addresses" directly, as this method gives error notification and will only return once the IM addresses have been written to the relevant backing store (or the operation's failed).
See also: folks_im_details_change_im_addresses()
|
the FolksImDetails instance |
|
a GAsyncResult |
|
location to store the error occuring, or NULL to ignore. [error-domains FolksPropertyError]
|
Since 0.6.2
GeeMultiMap * folks_im_details_get_im_addresses (FolksImDetails *self
);
|
the FolksImDetails instance to query |
Returns : |
the value of the "im-addresses" property |
void folks_im_details_set_im_addresses (FolksImDetails *self
,GeeMultiMap *value
);
|
the FolksImDetails instance to modify |
|
the new value of the "im-addresses" property |
gchar * folks_im_details_normalise_im_address (const gchar *im_address
,const gchar *protocol
,GError **error
);
Normalise an IM address so that it's suitable for string comparison.
IM addresses for various protocols can be represented in different ways, only one of which is canonical. In order to allow simple string comparisons of IM addresses to work, the IM addresses must be normalised beforehand.
If the provided IM address is invalid, FOLKS_IM_DETAILS_ERROR_INVALID_IM_ADDRESS will be thrown. Note that this isn't guaranteed to be thrown for all invalid addresses, but if it is thrown, the address is guaranteed to be invalid.
|
the address to normalise. [in] |
|
the protocol of this im_address. [in] |
|
location to store the error occuring, or NULL to ignore. [error-domains FolksImDetailsError]
|
Since 0.2.0
typedef struct _FolksImDetails FolksImDetails;
IM addresses exposed by an object implementing FolksPresenceDetails.
Since 0.1.13
"im-addresses"
property "im-addresses" GeeMultiMap* : Read / Write
A mapping of IM protocol to an (unordered) set of IM addresses.
Each mapping is from an arbitrary protocol identifier to a set of IM addresses on that protocol for the contact, listed in no particular order.
There must be no duplicate IM addresses in each set, though a given IM address may be present in the sets for different protocols.
All the IM addresses must be normalised using
before being added to this property.folks_im_details_normalise_im_address()
Since 0.5.1