Protocol
Object Hierarchy:
Description:
[ CCode ( type_id = "tp_protocol_get_type ()" ) ]
[ Version ( since = "0.11.11" ) ]
public class Protocol : Proxy
[ Version ( since = "0.11.11" ) ]
public class Protocol : Proxy
A base class for connection managers' protocols.
Namespace: TelepathyGLib
Package: telepathy-glib
Content:
Properties:
- public string[] addressable_uri_schemes { get; }
A non-%NULL
GStrv
of URI schemes supported by this protocol. - public string[] addressable_vcard_fields { get; }
A non-%NULL
GStrv
of vCard fields supported by this protocol. - public string[] authentication_types { get; }
A non-%NULL
GStrv
of interfaces which provide information as to what kind of authentication channels can possibly appear before the connection reaches the CONNECTED state, ornull
ifTP_PROTOCOL_FEATURE_CORE
has not been prepared. - public void* avatar_requirements { get; }
A AvatarRequirements representing the avatar requirements on this protocol, or
null
ifTP_PROTOCOL_FEATURE_CORE
has not been prepared or if the protocol doesn't support avatars. - public Capabilities capabilities { get; }
The classes of channel that can be requested from connections to this protocol, or
null
if this is unknown or theTP_PROTOCOL_FEATURE_CORE
feature has not been prepared. - public string cm_name { get; construct; }
The name of the connection manager this protocol is on.
- public string english_name { get; }
The name of the protocol in a form suitable for display to users, such as "AIM" or "Yahoo!", or a string based on protocol_name (currently constructed by putting the first character in title case, but this is not guaranteed) if no better name is available or the
TP_PROTOCOL_FEATURE_CORE
feature has not been prepared. - public string icon_name { get; }
The name of an icon in the system's icon theme.
- public string[] param_names { owned get; }
A list of parameter names supported by this connection manager for this protocol, or
null
ifTP_PROTOCOL_FEATURE_PARAMETERS
has not been prepared. - public string protocol_name { owned get; construct; }
The machine-readable name of the protocol, taken from the Telepathy D-Bus Interface Specification, such as "jabber" or "local-xmpp".
- public Variant protocol_properties_vardict { owned get; }
The immutable properties of this Protocol, as provided at construction time.
- public string vcard_field { get; }
The most common vCard field used for this protocol's contact identifiers, normalized to lower case, or
null
if there is no such field or theTP_PROTOCOL_FEATURE_CORE
feature has not been prepared.
Static methods:
- public static Quark get_feature_quark_core ()
- public static Quark get_feature_quark_parameters ()
- public static void init_known_interfaces ()
Ensure that the known interfaces for TpProtocol have been set up.
Creation methods:
- public Protocol (DBusDaemon dbus, string cm_name, string protocol_name, HashTable<void*,void*> immutable_properties) throws Error
- public Protocol.vardict (DBusDaemon dbus, string cm_name, string protocol_name, Variant immutable_properties) throws Error
Create a new protocol proxy.
Methods:
- public bool can_register ()
Return whether a new account can be registered on this protocol, by setting the special "register" parameter to
true
. - public Variant dup_immutable_properties ()
Return the protocol_properties_vardict property.
- public ConnectionManagerParam dup_param (string param)
- public string[] dup_param_names ()
Returns a list of parameter names supported by this connection manager for this protocol.
- public List<ConnectionManagerParam> dup_params ()
Returns a list of parameters supported by this connection manager.
- public List<PresenceStatusSpec> dup_presence_statuses ()
Return the presence statuses that might be supported by connections to this protocol.
- public unowned string[] get_addressable_uri_schemes ()
- public unowned string[] get_addressable_vcard_fields ()
- public unowned string[] get_authentication_types ()
- public unowned AvatarRequirements get_avatar_requirements ()
Return the avatar_requirements property
- public unowned Capabilities get_capabilities ()
- public unowned string get_cm_name ()
Return the cm_name property.
- public unowned string get_english_name ()
- public unowned string get_icon_name ()
- public unowned string get_name ()
Return the same thing as the protocol-name property, for convenient use in C code.
- public unowned ConnectionManagerParam get_param (string param)
- public unowned string get_vcard_field ()
- public bool has_param (string param)
- public async string identify_account_async (Variant vardict, Cancellable? cancellable) throws Error
Return a string that could identify the account with the given parameters.
- public async string normalize_contact_async (string contact, Cancellable? cancellable) throws Error
Perform best-effort offline contact normalization.
- public async string normalize_contact_uri_async (string uri, Cancellable? cancellable) throws Error
Perform best-effort offline contact normalization, for a contact in the form of a URI.
- public async string normalize_vcard_address_async (string field, string value, Cancellable? cancellable) throws Error
Perform best-effort offline contact normalization, for a contact in the form of a vCard field.
Inherited Members:
All known members inherited from class TelepathyGLib.Proxy
All known members inherited from class GLib.Object