Enums

Details

class TelepathyGLib.AccessControlType(value)

Bases: GLib.Enum

A type for communication access control. These control policies are used in CommunicationPolicy.DRAFT as well as most rich presence interfaces. New interfaces should use this type, and NOT Rich_Presence_Access_Control_Type.

Bitfield/set of flags generated from the Telepathy specification.

WHITELIST = 0

Only allow contacts that are in a certain whitelist. The associated variant in Access_Control is a list of Contact_Handle representing the whitelist, with signature au.

PUBLISH_LIST = 1

Allow contacts in the user’s ‘publish’ list. The associated variant in Access_Control is ignored.

GROUP = 2

Only allow contacts that are in a certain group. The associated variant in Access_Control is a Group_Handle representing the permitted group.

OPEN = 3

Allow all contacts. The associated variant in Access_Control is ignored.

SUBSCRIBE_OR_PUBLISH_LIST = 4

Allow all contacts in the user’s ‘subscribe’ or ‘publish’ list. The associated variant in Access_Control is ignored.

CLOSED = 5

Forbid all contacts. The associated variant in Access_Control is ignored.

NOT_UNDERSTOOD = 6

The access control rule is too complex to be represented in the current Telepathy API. The associated variant is meaningless. Setting this mode is never valid; the connection manager MUST raise an error if this is attempted. XEP-0016 Privacy Lists can easily produce access control mechanisms that can’t be expressed in a simpler API. We need to be able to at least indicate that fact. The associated variant in Access_Control is ignored.

class TelepathyGLib.CMInfoSource(value)

Bases: GLib.Enum

Describes possible sources of information on connection managers’ supported protocols.

Since 0.11.5, there is a corresponding GObject.EnumClass type, %TP_TYPE_CM_INFO_SOURCE.

New in version 0.7.1.

NONE = 0

no information available

FILE = 1

information came from a .manager file

LIVE = 2

information came from the connection manager

class TelepathyGLib.CallContentDisposition(value)

Bases: GLib.Enum

The disposition of this content, which defines whether to automatically start sending data on the streams when Accept is called on the channel.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

The content has no specific disposition.

INITIAL = 1

The content was initially part of the call. When Accept is called on the channel, all streams of this content with LocalSendingState set to Pending_Send will be moved to Sending as if SetSending (True) had been called.

class TelepathyGLib.CallContentPacketizationType(value)

Bases: GLib.Enum

A packetization method that can be used for a content.

Bitfield/set of flags generated from the Telepathy specification.

RTP = 0

Real-time Transport Protocol, as documented by RFC 3550.

RAW = 1

Raw media.

MSN_WEBCAM = 2

MSN webcam. This is the video-only one-way type which was used in earlier versions of WLM. Although no longer used, modern WLM clients still support the MSN webcam protocol.

class TelepathyGLib.CallState(value)

Bases: GLib.Enum

The state of a call, as a whole. The allowed transitions are: Pending_Initiator → Initialising (for outgoing calls, when Accept is called) Initialising → Initialised (for outgoing calls, when the remote client indicates that the user has been notified about the call. If the network is known not to provide feedback about whether the remote side is ringing, then the call should immediately be set to Initialised. Initialising → Initialised (for incoming calls, when e.g. the implementation has been initialised far enough that it is sensible to notify the user about the call (to reduce the probability that the user will pick up the call and have it immediately fail). The UI should then alert the user about the call, and call SetRinging) Initialised → Accepted (for outgoing calls to a contact, when the remote contact accepts the call; for incoming calls, when Accept is called.) Accepted → Active (when the local user successfully joins the call/conference, and media is known to be flowing successfully; also, when temporary connection problems are resolved (See below)). If the network is known not to provide feedback about when the call is properly connected, the call should immediately be set to Active. Active → Accepted (when there are temporary connection problems that the CM is aware of and able to recover from) any state → Ended (when the call is terminated normally, or when an error occurs that the CM is unable to recover from) Clients MAY consider unknown values from this enum to be an error - additional values will not be defined after the Call specification is declared to be stable.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The call state is not known. This call state MUST NOT appear as a value of the CallState property, but MAY be used by client code to represent calls whose state is as yet unknown.

PENDING_INITIATOR = 1

The initiator of the call hasn’t accepted the call yet. This state only makes sense for outgoing calls, where it means that the local user has not yet sent any signalling messages to the remote user(s), and will not do so until Accept is called.

INITIALISING = 2

Progress has been made in placing the call, but the contact has not been made aware of the call yet. This corresponds to SIP’s status code 183 Session Progress, and should be used for the period where the CM is waiting for the streaming implementation to initialise (before sending the initial INVITE or equivalent) and when the outgoing call has reached a gateway or ICE negotiation is pending. UIs should not produce a dialtone or start ringing if the call is in this state.

INITIALISED = 3

In the outgoing case: at least one called user has been alerted about the call (a SIP 180 (Ringing) packet or equivalent has been received) but none have answered, so the call cannot go to Accepted (use Ringing to determine which members have been informed and which haven’t, if you care). UIs SHOULD produce a dialtone for outgoing calls in this state. In the incoming case, the local user should be informed of the call as soon as the call reaches this state (and SetRinging should be called to inform the CM that this has happened, so that it can relay this fact to the caller using a SIP 180 (Ringing) packet or equivalent).

ACCEPTED = 4

The contact being called has accepted the call, but the call is not in the Active state (The most common reason for this is that the streaming implementation hasn’t connected yet).

ACTIVE = 5

The contact being called has accepted the call, and discourse between at least two parties should now be possible.

ENDED = 6

The call has ended, either via normal termination or an error.

class TelepathyGLib.CallStateChangeReason(value)

Bases: GLib.Enum

A simple representation of the reason for a change in the call’s state, which may be used by simple clients, or used as a fallback when the DBus_Reason member of a Call_State_Reason struct is not understood.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

We just don’t know. Unknown values of this enum SHOULD also be treated like this.

PROGRESS_MADE = 1

Situation normal. Progress has been made in the setup/teardown of the call (and it didn’t require any user interaction).

SERVICE_ERROR = 10

There has been an unexpected error in the server or some other remote component. Corresponds to ServiceConfused

NETWORK_ERROR = 11

There has been a network error related to the CM or the signalling part of the call (compare and contrast: Streaming_Error). Corresponds to NetworkError

MEDIA_ERROR = 12

Some aspect of the content is unsupported so has to be removed from the call. Corresponds to Media.UnsupportedType or Media.CodecsIncompatible

CONNECTIVITY_ERROR = 13

It was not possible for the streaming implementation to connect to any of the users participating in this call or content. Corresponds to ConnectionFailed or ConnectionLost

USER_REQUESTED = 2

The change was requested by the contact indicated by the Actor member of a Call_State_Reason struct. The DBus_Reason SHOULD be the empty string if the call was terminated normally, but MAY be a non-empty error name to indicate error-like call termination reasons (kicked from a conference by a moderator, etc.).

FORWARDED = 3

The call was forwarded. If known, the handle of the contact the call was forwarded to will be indicated by the “forwarded-to” member of a CallStateDetails dictionnary in the CallStateChanged signal.

REJECTED = 4

The CallState changed from Initialised or Ended (or a content’s direction changed) because it was rejected by the remote user. Corresponds to Rejected

NO_ANSWER = 5

The CallState changed from Initialised or Ended because the initiator ended the call before the receiver accepted it. With an incoming call this state change reason signifies a missed call, or one that was picked up elsewhere before it was picked up here. Corresponds to NoAnswer or PickedUpElsewhere

INVALID_CONTACT = 6

The CallState changed because one of the addresses does not exist on the network. Corresponds to DoesNotExist

PERMISSION_DENIED = 7

The CallState changed because the local user is not authorised. Corresponds to PermissionDenied or InsufficientBalance

BUSY = 8

The CallState changed from Initialised Ended because the receiver is busy (e.g. is already engaged in another call, and has not placed the initiator in a call-waiting queue). Corresponds to Busy

INTERNAL_ERROR = 9

There has been an unexpected error in either the CM or some other local component. Corresponds to Confused or Media.StreamingError

class TelepathyGLib.CallStreamCandidateType(value)

Bases: GLib.Enum

The network topology that an IP candidate represents. This can sometimes be used to infer what kind of performance characteristics (latency, bandwith, etc) can be expected of connections made to this candidate.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

This is not an IP candidate. This is a reserved value, and should not be seen on the bus.

HOST = 1

This candidate represents a direct connection to the host, as its address is taken directly the host’s IP stack.

SERVER_REFLEXIVE = 2

This candidate probably represents a connection to the host through a NAT device, as its address was discovered by sending a binding request to a STUN server or similar.

PEER_REFLEXIVE = 3

This candidate probably represents a good route between the host and its peer, as its address was discovered by sending a STUN binding request to one of the candidates advertised by the peer.

RELAY = 4

This candidate represents the address of a relay server (usually somewhere on the public internet). This candidate is the most likely to work, but all media will go via a relay server, so latency is likely to be higher than other types of candidate.

MULTICAST = 5

This candidate represents a Multicast group. This value should only appear if the Stream’s Transport is set to Multicast.

class TelepathyGLib.CaptchaCancelReason(value)

Bases: GLib.Enum

A reason why captcha authentication was aborted by the client.

Bitfield/set of flags generated from the Telepathy specification.

USER_CANCELLED = 0

The user aborted the authentication. If this is used, the CaptchaError SHOULD be set to Cancelled

NOT_SUPPORTED = 1

The Handler doesn’t support the given/required captcha types. If this is used, the CaptchaError SHOULD be set to CaptchaNotSupported. This SHOULD also be used if Close is called before CancelCaptcha. If no Handler supports captcha channels, the ChannelDispatcher will just call Close, because it has no knowledge of specific channel types.

SERVICE_CONFUSED = 2

The Handler doesn’t understand the captcha data received. The challenger may be sending gibberish. If this is used, the CaptchaError SHOULD be set to ServiceConfused.

class TelepathyGLib.CaptchaStatus(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

LOCAL_PENDING = 0

The challenge/response exchange is in progress and waiting for a local action. Call AnswerCaptchas to go to the Remote_Pending state, or call CancelCaptcha followed by Close to give up.

REMOTE_PENDING = 1

The challenge/response exchange is in progress and waiting for a response from the server. Wait for a reply from the server, which will result in the Succeeded, Try_Again, or Failed state, or call CancelCaptcha followed by Close to give up.

SUCCEEDED = 2

Everyone is happy. Connection to the server will proceed as soon as this state is reached. There is nothing useful to do in this state except to call Close to close the channel.

TRY_AGAIN = 3

The server has indicated an authentication failure. Call GetCaptchas again to get a new captcha, or CancelCaptcha followed by Close to give up.

FAILED = 4

Authentication has failed in some way. There is nothing useful to do in this state except to close the channel with Close.

class TelepathyGLib.ChannelChatState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

GONE = 0

The contact has effectively ceased participating in the chat.

INACTIVE = 1

The contact has not been active for some time.

ACTIVE = 2

The contact is actively participating in the chat.

PAUSED = 3

The contact has paused composing a message.

COMPOSING = 4

The contact is composing a message to be sent to the chat.

class TelepathyGLib.ChannelContactSearchState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NOT_STARTED = 0

The search has not started

IN_PROGRESS = 1

The search is in progress

MORE_AVAILABLE = 2

The search has paused, but more results can be retrieved by calling More.

COMPLETED = 3

The search has been completed

FAILED = 4

The search has failed

class TelepathyGLib.ChannelGroupChangeReason(value)

Bases: GLib.Enum

The reason for a set of handles to move to one of Members, LocalPendingMembers or RemotePendingMembers, or to be removed from the group. A client may supply a reason when attempting to remove members from a group with RemoveMembersWithReason, and reasons are supplied by the CM when emitting MembersChanged and MembersChangedDetailed. Some reason codes have different meanings depending on the Actor in a MembersChanged signal.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

No reason was provided for this change. In particular, this reason SHOULD be used when representing users joining a named chatroom in the usual way, users leaving a chatroom by their own request, and normal termination of a StreamedMedia call by the remote user. If the SelfHandle is removed from a group for this reason and the actor is not the SelfHandle, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Terminated. If the SelfHandle is removed from a group for this reason and the actor is also the SelfHandle, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cancelled.

OFFLINE = 1

The change is due to a user going offline. Also used when user is already offline, but this wasn’t known previously. If a one-to-one StreamedMedia call fails because the contact being called is offline, the connection manager SHOULD indicate this by removing both the SelfHandle and the other contact’s handle from the Group interface with reason Offline. For 1-1 calls, the call terminates as a result of removing the remote contact, so the SelfHandle should be removed at the same time as the remote contact and for the same reason. If a handle is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Offline.

PERMISSION_DENIED = 10

The change is because there was no permission to contact the requested handle. If a contact is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.PermissionDenied.

SEPARATED = 11

If members are removed with this reason code, the change is because the group has split into unconnected parts which can only communicate within themselves (e.g. netsplits on IRC use this reason code). If members are added with this reason code, the change is because unconnected parts of the group have rejoined. If this channel carries messages (e.g. Text or Tubes channels) applications must assume that the contacts being added are likely to have missed some messages as a result of the separation, and that the contacts in the group are likely to have missed some messages from the contacts being added. Note that from the added contacts’ perspective, they have been in the group all along, and the contacts we indicate to be in the group (including the local user) have just rejoined the group with reason Separated. Application protocols in Tubes should be prepared to cope with this situation. The SelfHandle SHOULD NOT be removed from channels with this reason.

KICKED = 2

The change is due to a kick operation. If the SelfHandle is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Channel.Kicked.

BUSY = 3

The change is due to a busy indication. If a one-to-one StreamedMedia call fails because the contact being called is busy, the connection manager SHOULD indicate this by removing both the SelfHandle and the other contact’s handle from the Group interface with reason Busy. For 1-1 calls, the call terminates as a result of removing the remote contact, so the SelfHandle should be removed at the same time as the remote contact and for the same reason. If the SelfHandle is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Busy.

INVITED = 4

The change is due to an invitation. This reason SHOULD only be used when contacts are added to the remote-pending set (to indicate that the contact has been invited) or to the members (to indicate that the contact has accepted the invitation). Otherwise, what would it mean?

BANNED = 5

The change is due to a kick+ban operation. If the SelfHandle is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Channel.Banned.

ERROR = 6

The change is due to an error occurring.

INVALID_CONTACT = 7

The change is because the requested contact does not exist. For instance, if the user invites a nonexistent contact to a chatroom or attempts to call a nonexistent contact, this could be indicated by the CM adding that contact’s handle to remote-pending for reason None or Invited, then removing it for reason Invalid_Contact. In the case of a 1-1 StreamedMedia call, the CM SHOULD remove the self handle from the Group in the same signal. For 1-1 calls, the call terminates as a result of removing the remote contact, so the SelfHandle should be removed at the same time as the remote contact and for the same reason. If a contact is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.DoesNotExist.

NO_ANSWER = 8

The change is because the requested contact did not respond. If a one-to-one StreamedMedia call fails because the contact being called did not respond, or the local user did not respond to an incoming call, the connection manager SHOULD indicate this by removing both the SelfHandle and the other contact’s handle from the Group interface with reason No_Answer. Documenting existing practice. If a contact is removed from a group for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.NoAnswer.

RENAMED = 9

The change is because a contact’s unique identifier changed. There must be exactly one handle in the removed set and exactly one handle in one of the added sets. The Renamed signal on the Renaming interface will have been emitted for the same handles, shortly before this MembersChanged signal is emitted.

class TelepathyGLib.ChannelTextMessageType(value)

Bases: GLib.Enum

The type of message.

Bitfield/set of flags generated from the Telepathy specification.

NORMAL = 0

An ordinary chat message. Unknown types SHOULD be treated like this.

ACTION = 1

An action which might be presented to the user as “* &lt;sender&gt; <action>”, such as an IRC CTCP ACTION (typically selected by the “/me” command). For example, the text of the message might be “drinks more coffee”.

NOTICE = 2

A one-off or automated message not necessarily expecting a reply

AUTO_REPLY = 3

An automatically-generated reply message.

DELIVERY_REPORT = 4

A delivery report. This message type MUST NOT appear unless the channel supports the Messages interface; see Message_Part for the format that delivery reports must take.

class TelepathyGLib.ChannelTextSendError(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

An unknown error occurred

OFFLINE = 1

The requested contact was offline

INVALID_CONTACT = 2

The requested contact is not valid

PERMISSION_DENIED = 3

The user does not have permission to speak on this channel

TOO_LONG = 4

The outgoing message was too long and was rejected by the server

NOT_IMPLEMENTED = 5

The channel doesn’t support sending text messages to the requested contact

class TelepathyGLib.ConnectionPresenceType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

UNSET = 0

An invalid presence type used as a null value. This value MUST NOT appear in the Statuses property, or in the result of GetStatuses on the deprecated Presence interface.

OFFLINE = 1

Offline

AVAILABLE = 2

Available

AWAY = 3

Away

EXTENDED_AWAY = 4

Away for an extended time

HIDDEN = 5

Hidden (invisible)

BUSY = 6

Busy, Do Not Disturb.

UNKNOWN = 7

Unknown, unable to determine presence for this contact, for example if the protocol only allows presence of subscribed contacts.

ERROR = 8

Error, an error occurred while trying to determine presence. The message, if set, is an error from the server.

class TelepathyGLib.ConnectionStatus(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

CONNECTED = 0

The connection is fully connected and all methods are available.

CONNECTING = 1

Connect has been called but the connection has not yet been established. Some methods may fail until the connection has been established.

DISCONNECTED = 2

If this is retrieved from GetStatus or Status, it indicates that connection has not yet been attempted. If seen in a StatusChanged signal, it indicates that the connection has failed; the Connection object SHOULD be removed from D-Bus immediately, and all subsequent method calls SHOULD fail.

class TelepathyGLib.ConnectionStatusReason(value)

Bases: GLib.Enum

A reason why the status of the connection changed. Apart from Requested, the values of this enumeration only make sense as reasons why the status changed to Disconnected.

Bitfield/set of flags generated from the Telepathy specification.

NONE_SPECIFIED = 0

There is no reason set for this state change. Unknown status reasons SHOULD be treated like this reason. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Disconnected.

REQUESTED = 1

The change is in response to a user request. Changes to the Connecting or Connected status SHOULD always indicate this reason; changes to the Disconnected status SHOULD indicate this reason if and only if the disconnection was requested by the user. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cancelled.

CERT_HOSTNAME_MISMATCH = 10

The server’s SSL certificate did not match its hostname. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.HostnameMismatch.

CERT_FINGERPRINT_MISMATCH = 11

The server’s SSL certificate does not have the expected fingerprint. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.FingerprintMismatch.

CERT_SELF_SIGNED = 12

The server’s SSL certificate is self-signed. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.SelfSigned.

CERT_OTHER_ERROR = 13

There was some other error validating the server’s SSL certificate. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.Invalid.

CERT_REVOKED = 14

The server’s SSL certificate has been revoked. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.Revoked.

CERT_INSECURE = 15

The server’s SSL certificate uses an insecure algorithm, or is cryptographically weak. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.Insecure.

CERT_LIMIT_EXCEEDED = 16

The length in bytes of the server certificate, or the depth of the sever certificate chain exceed the limits imposed by the crypto library. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.LimitExceeded

NETWORK_ERROR = 2

There was an error sending or receiving on the network socket. When the status changes from Connecting to Disconnected for this reason, the equivalent D-Bus error is either org.freedesktop.Telepathy.Error.NetworkError, org.freedesktop.Telepathy.Error.ConnectionRefused, org.freedesktop.Telepathy.Error.ConnectionFailed or some more specific error. When the status changes from Connected to Disconnected for this reason, the equivalent D-Bus error is either org.freedesktop.Telepathy.Error.NetworkError, org.freedesktop.Telepathy.Error.ConnectionLost or some more specific error.

AUTHENTICATION_FAILED = 3

The username or password was invalid. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.AuthenticationFailed.

ENCRYPTION_ERROR = 4

There was an error negotiating SSL on this connection, or encryption was unavailable and require-encryption was set when the connection was created. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.EncryptionNotAvailable if encryption was not available at all, or org.freedesktop.Telepathy.Error.EncryptionError if encryption failed.

NAME_IN_USE = 5

In general, this reason indicates that the requested account name or other identification could not be used due to conflict with another connection. It can be divided into three cases: If the status change is from Connecting to Disconnected and the ‘register’ parameter to RequestConnection was present and true, the requested account could not be created on the server because it already exists. The equivalent D-Bus error is org.freedesktop.Telepathy.Error.RegistrationExists. If the status change is from Connecting to Disconnected but the ‘register’ parameter is absent or false, the connection manager could not connect to the specified account because a connection to that account already exists. The equivalent D-Bus error is org.freedesktop.Telepathy.Error.AlreadyConnected. In some protocols, like XMPP (when connecting with the same JID and resource as an existing connection), the existing connection “wins” and the new one fails to connect. If the status change is from Connected to Disconnected, the existing connection was automatically disconnected because a new connection to the same account (perhaps from a different client or location) was established. The equivalent D-Bus error is org.freedesktop.Telepathy.Error.ConnectionReplaced. In some protocols, like MSNP (when connecting twice with the same Passport), the new connection “wins” and the existing one is automatically disconnected.

CERT_NOT_PROVIDED = 6

The server did not provide a SSL certificate. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.NotProvided.

CERT_UNTRUSTED = 7

The server’s SSL certificate is signed by an untrusted certifying authority. This error SHOULD NOT be used to represent a self-signed certificate: use the more specific Cert_Self_Signed reason for that. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.Untrusted.

CERT_EXPIRED = 8

The server’s SSL certificate has expired. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.Expired.

CERT_NOT_ACTIVATED = 9

The server’s SSL certificate is not yet valid. When disconnected for this reason, the equivalent D-Bus error is org.freedesktop.Telepathy.Error.Cert.NotActivated.

class TelepathyGLib.ContactFeature(value)

Bases: GLib.Enum

Enumeration representing the features a TelepathyGLib.Contact can optionally support. When requesting a TelepathyGLib.Contact, library users specify the desired features; the TelepathyGLib.Contact code will only initialize state for those features, to avoid unwanted D-Bus round-trips and signal connections.

Since 0.11.5, there is a corresponding GObject.EnumClass type, %TP_TYPE_CONTACT_FEATURE.

New in version 0.7.18.

ALIAS = 0

TelepathyGLib.Contact :alias

AVATAR_TOKEN = 1

TelepathyGLib.Contact :avatar-token

CONTACT_BLOCKING = 10

TelepathyGLib.Contact :is-blocked. Require Connection implementing the TelepathyGLib.IFACE_CONNECTION_INTERFACE_CONTACT_BLOCKING interface. (available since 0.17.0)

PRESENCE = 2

TelepathyGLib.Contact :presence-type, TelepathyGLib.Contact :presence-status and TelepathyGLib.Contact :presence-message

LOCATION = 3

TelepathyGLib.Contact :location (available since 0.11.1) and TelepathyGLib.Contact :location-vardict (since 0.19.10)

CAPABILITIES = 4

TelepathyGLib.Contact :capabilities (available since 0.11.3)

AVATAR_DATA = 5

TelepathyGLib.Contact :avatar-file and TelepathyGLib.Contact :avatar-mime-type. Implies TelepathyGLib.ContactFeature.AVATAR_TOKEN (available since 0.11.6)

CONTACT_INFO = 6

TelepathyGLib.Contact :contact-info (available since 0.11.7)

CLIENT_TYPES = 7

TelepathyGLib.Contact :client-types (available since 0.13.1)

SUBSCRIPTION_STATES = 8

TelepathyGLib.Contact :subscribe-state, TelepathyGLib.Contact :publish-state and TelepathyGLib.Contact :publish-request. Require a Connection implementing the TelepathyGLib.IFACE_CONNECTION_INTERFACE_CONTACT_LIST interface. (available since 0.13.12)

CONTACT_GROUPS = 9

TelepathyGLib.Contact :contact-groups (available since 0.13.14)

class TelepathyGLib.ContactListState(value)

Bases: GLib.Enum

The progress made in retrieving the contact list.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

The connection has not started to retrieve the contact list. If GetContactListAttributes is called in this state, it will raise NotYet.

WAITING = 1

The connection has started to retrieve the contact list, but has not yet succeeded or failed. If GetContactListAttributes is called in this state, it will raise NotYet.

FAILURE = 2

The connection has tried and failed to retrieve the contact list. If GetContactListAttributes is called in this state, it will immediately raise an error indicating the reason for failure. The connection manager SHOULD try again to obtain the contact list, if appropriate for the protocol. If it succeeds later, the ContactListState MUST advance to Success.

SUCCESS = 3

The connection has successfully retrieved the contact list. If GetContactListAttributes is called in this state, it will return successfully.

class TelepathyGLib.ContactMetadataStorageType(value)

Bases: GLib.Enum

Values of this enumeration indicate the extent to which metadata such as aliases and group memberships can be stored for the contacts on a particular connection. On some protocols, certain metadata (for instance, contact aliases) can only be stored for contacts on the contact list, or contacts with a particular contact list state. To make it easier to deal with such protocols, if clients set metadata on a contact who is not in the required state, the Connection MUST cache the metadata for the duration of the session. If clients request the attributes of that contact after the appropriate “set” method has returned successfully, the Connection MUST return the new (cached) value. If the contact is later placed in the required state to store metadata (for instance, if subscription to the contact’s presence is requested, on a protocol like MSN where the alias has storage type Subscribed_Or_Pending), the connection MUST store the cached metadata at that time. If the Connection didn’t cache changes in this way, a client intending to change the alias on MSN would have to wait until the server acknowledged the subscription request; in the meantime, other clients would still display the old alias. The only exception to that general rule is that if the Connection cannot store particular metadata at all (i.e. the storage type is None), it MUST reject attempts to set it. If the implementation knows that metadata can’t be stored at all, it’s useful to report that, which can be done synchronously. In general, user interfaces should detect storage type None and not display editing controls at all.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

This connection cannot store this type of metadata at all, and attempting to do so will fail with NotImplemented. Link-local XMPP can’t store aliases or group memberships at all, and subscription and presence states are implicit (all contacts on the local network have subscribe = publish = Yes and no other contacts exist). As of April 2010, the XMPP server for Facebook Chat provides a read-only view of the user’s Facebook contacts, so it could also usefully have this storage type.

SUBSCRIBED_OR_PENDING = 1

This type of metadata can only be stored permanently for contacts whose subscribe attribute is Ask or Yes. Contact aliases and groups on MSN have this behaviour.

SUBSCRIBED = 2

This type of metadata can only be stored permanently for contacts whose subscribe attribute is Yes. No service with this behaviour is currently known, but it’s a stricter form of Subscribed_Or_Pending.

ANYONE = 3

The user can set this metadata for any valid contact identifier, whether or not they have any presence subscription relationship to it, and it will be stored on their contact list. Contact aliases and groups on XMPP have this behaviour; it is possible to put a contact in a group, or assign an alias to them, without requesting that presence be shared.

class TelepathyGLib.DBusError(value)

Bases: GLib.Enum

GLib.Error codes for use with the %TP_DBUS_ERRORS domain.

Since 0.11.5, there is a corresponding GObject.EnumClass type, %TP_TYPE_DBUS_ERROR.

New in version 0.7.1.

UNKNOWN_REMOTE_ERROR = 0

Raised if the error raised by a remote D-Bus object is not recognised

PROXY_UNREFERENCED = 1

Emitted in TelepathyGLib.Proxy ::invalidated when the TelepathyGLib.Proxy has lost its last reference

INCONSISTENT = 10

Raised if information received from a remote object is inconsistent or otherwise obviously wrong (added in 0.7.17). See also TelepathyGLib.Error.CONFUSED.

NO_INTERFACE = 2

Raised by TelepathyGLib.Proxy methods if the remote object does not appear to have the required interface

NAME_OWNER_LOST = 3

Emitted in TelepathyGLib.Proxy ::invalidated if the remote process loses ownership of its bus name, and raised by any TelepathyGLib.Proxy methods that have not had a reply at that time or are called after the proxy becomes invalid in this way (usually meaning it crashed)

INVALID_BUS_NAME = 4

Raised if a D-Bus bus name given is not valid, or is of an unacceptable type (e.g. well-known vs. unique)

INVALID_INTERFACE_NAME = 5

Raised if a D-Bus interface or error name given is not valid

INVALID_OBJECT_PATH = 6

Raised if a D-Bus object path given is not valid

INVALID_MEMBER_NAME = 7

Raised if a D-Bus method or signal name given is not valid

OBJECT_REMOVED = 8

A generic error which can be used with TelepathyGLib.Proxy ::invalidated to indicate an application-specific indication that the remote object no longer exists, if no more specific error is available.

CANCELLED = 9

Raised from calls that re-enter the main loop (*_run_*) if they are cancelled

class TelepathyGLib.DTMFEvent(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

DIGIT_0 = 0

<![CDATA[0]]>

DIGIT_1 = 1

<![CDATA[1]]>

ASTERISK = 10

<![CDATA[*]]>

HASH = 11

<![CDATA[#]]>

LETTER_A = 12

<![CDATA[A]]>

LETTER_B = 13

<![CDATA[B]]>

LETTER_C = 14

<![CDATA[C]]>

LETTER_D = 15

<![CDATA[D]]>

DIGIT_2 = 2

<![CDATA[2]]>

DIGIT_3 = 3

<![CDATA[3]]>

DIGIT_4 = 4

<![CDATA[4]]>

DIGIT_5 = 5

<![CDATA[5]]>

DIGIT_6 = 6

<![CDATA[6]]>

DIGIT_7 = 7

<![CDATA[7]]>

DIGIT_8 = 8

<![CDATA[8]]>

DIGIT_9 = 9

<![CDATA[9]]>

class TelepathyGLib.DebugLevel(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

ERROR = 0

Log level for errors. Error messages are always fatal, resulting in the service terminating after something completely unexpected occurred.

CRITICAL = 1

Log level for critical messages. Critical messages are messages that the service might predict and it is up to the service itself to decide whether to terminate following a critical message.

WARNING = 2

Log level for warnings.

MESSAGE = 3

Log level for messages.

INFO = 4

Log level for information messages.

DEBUG = 5

Log level for debug messages.

class TelepathyGLib.DeliveryStatus(value)

Bases: GLib.Enum

The status of a message as indicated by a delivery report. If this enum is extended in future specifications, this should only be to add new, non-overlapping conditions (i.e. all failures should still be signalled as either Temporarily_Failed or Permanently_Failed). If additional detail is required (e.g. distinguishing between the various types of permanent failure) this will be done using additional Delivery_Report_Header_Keys.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The message’s disposition is unknown. Clients SHOULD consider all messages to have status Delivery_Status_Unknown unless otherwise specified; connection managers SHOULD NOT signal this delivery status explicitly.

DELIVERED = 1

The message has been delivered to the intended recipient.

TEMPORARILY_FAILED = 2

Delivery of the message has failed. Clients SHOULD notify the user, but MAY automatically try sending another copy of the message. Similar to errors with type=”wait” in XMPP; analogous to 4xx errors in SMTP.

PERMANENTLY_FAILED = 3

Delivery of the message has failed. Clients SHOULD NOT try again unless by specific user action. If the user does not modify the message or alter configuration before re-sending, this error is likely to happen again. Similar to errors with type=”cancel”, type=”modify” or type=”auth” in XMPP; analogous to 5xx errors in SMTP.

ACCEPTED = 4

An intermediate server has accepted the message but the message has not been yet delivered to the ultimate recipient. The connection manager might send a Failed report or Delivered report later. Similar to “202 Accepted” success code in SIP; analogous to 251 and 252 responses in SMTP.

READ = 5

The message has been read by the intended recipient.

DELETED = 6

The message has been deleted by the intended recipient. This MAY be signalled on its own if the message is deleted without being read, or after Read if the message was read before being deleted.

class TelepathyGLib.Error(value)

Bases: GLib.Enum

Enumerated type representing the Telepathy D-Bus errors.

NETWORK_ERROR = 0

org.freedesktop.Telepathy.Error.NetworkError: Raised when there is an error reading from or writing to the network.

NOT_IMPLEMENTED = 1

org.freedesktop.Telepathy.Error.NotImplemented: Raised when the requested method, channel, etc is not available on this connection.

NOT_YOURS = 10

org.freedesktop.Telepathy.Error.NotYours: The requested channel or other resource already exists, and another client is responsible for it

CANCELLED = 11

org.freedesktop.Telepathy.Error.Cancelled: Raised by an ongoing request if it is cancelled by user request before it has completed, or when operations are performed on an object which the user has asked to close (for instance, a Connection where the user has called Disconnect, or a Channel where the user has called Close).

AUTHENTICATION_FAILED = 12

org.freedesktop.Telepathy.Error.AuthenticationFailed: Raised when authentication with a service was unsuccessful.

ENCRYPTION_NOT_AVAILABLE = 13

org.freedesktop.Telepathy.Error.EncryptionNotAvailable: Raised if a user request insisted that encryption should be used, but encryption was not actually available.

ENCRYPTION_ERROR = 14

org.freedesktop.Telepathy.Error.EncryptionError: Raised if encryption appears to be available, but could not actually be used (for instance if SSL/TLS negotiation fails).

CERT_NOT_PROVIDED = 15

org.freedesktop.Telepathy.Error.Cert.NotProvided: Raised if the server did not provide a SSL/TLS certificate.

CERT_UNTRUSTED = 16

org.freedesktop.Telepathy.Error.Cert.Untrusted: Raised if the server provided a SSL/TLS certificate signed by an untrusted certifying authority.

CERT_EXPIRED = 17

org.freedesktop.Telepathy.Error.Cert.Expired: Raised if the server provided an expired SSL/TLS certificate.

CERT_NOT_ACTIVATED = 18

org.freedesktop.Telepathy.Error.Cert.NotActivated: Raised if the server provided an SSL/TLS certificate that will become valid at some point in the future.

CERT_FINGERPRINT_MISMATCH = 19

org.freedesktop.Telepathy.Error.Cert.FingerprintMismatch: Raised if the server provided an SSL/TLS certificate that did not have the expected fingerprint.

INVALID_ARGUMENT = 2

org.freedesktop.Telepathy.Error.InvalidArgument: Raised when one of the provided arguments is invalid.

CERT_HOSTNAME_MISMATCH = 20

org.freedesktop.Telepathy.Error.Cert.HostnameMismatch: Raised if the server provided an SSL/TLS certificate that did not match its hostname.

CERT_SELF_SIGNED = 21

org.freedesktop.Telepathy.Error.Cert.SelfSigned: Raised if the server provided an SSL/TLS certificate that is self-signed and untrusted.

CERT_INVALID = 22

org.freedesktop.Telepathy.Error.Cert.Invalid: Raised if the server provided an SSL/TLS certificate that is unacceptable in some way that does not have a more specific error.

NOT_CAPABLE = 23

org.freedesktop.Telepathy.Error.NotCapable: Raised when requested functionality is unavailable due to a contact not having the required capabilities.

OFFLINE = 24

org.freedesktop.Telepathy.Error.Offline: Raised when requested functionality is unavailable because a contact is offline.

CHANNEL_KICKED = 25

org.freedesktop.Telepathy.Error.Channel.Kicked: Used to represent a user being ejected from a channel by another user, for instance being kicked from a chatroom.

BUSY = 26

org.freedesktop.Telepathy.Error.Busy: Used to represent a user being removed from a channel because of a “busy” indication.

NO_ANSWER = 27

org.freedesktop.Telepathy.Error.NoAnswer: Used to represent a user being removed from a channel because they did not respond, e.g. to a StreamedMedia call.

DOES_NOT_EXIST = 28

org.freedesktop.Telepathy.Error.DoesNotExist: Raised when the requested user does not, in fact, exist.

TERMINATED = 29

org.freedesktop.Telepathy.Error.Terminated: Raised when a channel is terminated for an unspecified reason. In particular, this error SHOULD be used whenever normal termination of a 1-1 StreamedMedia call by the remote user is represented as a D-Bus error name.

NOT_AVAILABLE = 3

org.freedesktop.Telepathy.Error.NotAvailable: Raised when the requested functionality is temporarily unavailable.

CONNECTION_REFUSED = 30

org.freedesktop.Telepathy.Error.ConnectionRefused: Raised when a connection is refused.

CONNECTION_FAILED = 31

org.freedesktop.Telepathy.Error.ConnectionFailed: Raised when a connection can’t be established.

CONNECTION_LOST = 32

org.freedesktop.Telepathy.Error.ConnectionLost: Raised when a connection is broken.

ALREADY_CONNECTED = 33

org.freedesktop.Telepathy.Error.AlreadyConnected: Raised on attempts to connect again to an account that is already connected, if the protocol or server does not allow this.

New in version 0.7.34.

CONNECTION_REPLACED = 34

org.freedesktop.Telepathy.Error.ConnectionReplaced: Used as disconnection reason for an existing connection if it is disconnected because a second connection to the same account is made.

New in version 0.7.34.

REGISTRATION_EXISTS = 35

org.freedesktop.Telepathy.Error.RegistrationExists: Raised on attempts to register an account on a server when the account already exists.

New in version 0.7.34.

SERVICE_BUSY = 36

org.freedesktop.Telepathy.Error.ServiceBusy: Raised when a server or other infrastructure rejects a request because it is too busy.

New in version 0.7.34.

RESOURCE_UNAVAILABLE = 37

org.freedesktop.Telepathy.Error.ResourceUnavailable: Raised when a local process rejects a request because it does not have enough of a resource, such as memory.

New in version 0.7.34.

WOULD_BREAK_ANONYMITY = 38

org.freedesktop.Telepathy.Error.WouldBreakAnonymity: Raised when a request cannot be satisfied without violating an earlier request for anonymity, and the earlier request specified that raising an error is preferable to disclosing the user’s identity

New in version 0.11.7.

CERT_REVOKED = 39

org.freedesktop.Telepathy.Error.Cert.Revoked: Raised if the server provided an SSL/TLS certificate that has been revoked.

New in version 0.11.12.

PERMISSION_DENIED = 4

org.freedesktop.Telepathy.Error.PermissionDenied: The user is not permitted to perform the requested operation.

CERT_INSECURE = 40

org.freedesktop.Telepathy.Error.Cert.Insecure: Raised if the server provided an SSL/TLS certificate that uses an insecure cipher algorithm or is cryptographically weak.

New in version 0.11.12.

CERT_LIMIT_EXCEEDED = 41

org.freedesktop.Telepathy.Error.Cert.LimitExceeded: Raised if the length in bytes of the server certificate, or the depth of the server certificate chain, exceed the limits imposed by the crypto library.

New in version 0.11.12.

NOT_YET = 42

org.freedesktop.Telepathy.Error.NotYet: Raised when the requested functionality is not yet available, but is likely to become available after some time has passed.

New in version 0.11.15.

REJECTED = 43

org.freedesktop.Telepathy.Error.Rejected: Raised when an incoming or outgoing call is rejected by the receiving contact.

New in version 0.13.2.

PICKED_UP_ELSEWHERE = 44

org.freedesktop.Telepathy.Error.PickedUpElsewhere: Raised when a call was terminated as a result of the local user picking up the call on a different resource.

New in version 0.13.3.

CONFUSED = 45

org.freedesktop.Telepathy.Error.Confused: Raised if a server rejects protocol messages from a connection manager claiming that they do not make sense, two local processes fail to understand each other, or an apparently impossible situation is reached. This has a similar meaning to TelepathyGLib.DBusError.INCONSISTENT but can be passed between processes via D-Bus.

New in version 0.13.7.

SERVICE_CONFUSED = 46

org.freedesktop.Telepathy.Error.ServiceConfused: Raised when a server or other piece of infrastructure indicates an internal error, or when a message that makes no sense is received from a server or other piece of infrastructure.

New in version 0.13.7.

EMERGENCY_CALLS_NOT_SUPPORTED = 47

org.freedesktop.Telepathy.Error.EmergencyCallsNotSupported: Raised when a client attempts to dial a number that is recognized as an emergency number (e.g. ‘911’ in the USA), but the Connection Manager or provider does not support dialling emergency numbers.

SOFTWARE_UPGRADE_REQUIRED = 48

org.freedesktop.Telepathy.Error.SoftwareUpgradeRequired: Raised when a Connection cannot be established because either the Connection Manager or its support library (e.g. wocky, papyon, sofiasip) requires upgrading to support a newer protocol version.

INSUFFICIENT_BALANCE = 49

org.freedesktop.Telepathy.Error.InsufficientBalance: Raised if the user has insufficient balance to place a call. The key ‘balance-required’ MAY be included in CallStateDetails on a Call channel (with the same units and scale as AccountBalance) to indicate how much credit is required to make this call.

DISCONNECTED = 5

org.freedesktop.Telepathy.Error.Disconnected: The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.

MEDIA_CODECS_INCOMPATIBLE = 50

org.freedesktop.Telepathy.Error.Media.CodecsIncompatible: Raised when the local streaming implementation has no codecs in common with the remote side.

New in version 0.15.6.

MEDIA_UNSUPPORTED_TYPE = 51

org.freedesktop.Telepathy.Error.Media.UnsupportedType: The media stream type requested is not supported by either the local or remote side.

New in version 0.15.6.

MEDIA_STREAMING_ERROR = 52

org.freedesktop.Telepathy.Error.Media.StreamingError: Raised when the call’s streaming implementation has some kind of internal error.

New in version 0.15.6.

CAPTCHA_NOT_SUPPORTED = 53

org.freedesktop.Telepathy.Error.Media.CaptchaNotSupported: Raised if no UI is available to present captchas, or if one is available but it is unable to answer any of the captchas given.

INVALID_HANDLE = 6

org.freedesktop.Telepathy.Error.InvalidHandle: An identifier being converted to a handle was syntactically invalid, or an invalid handle was used.

CHANNEL_BANNED = 7

org.freedesktop.Telepathy.Error.Channel.Banned: You are banned from the channel.

CHANNEL_FULL = 8

org.freedesktop.Telepathy.Error.Channel.Full: The channel is full.

CHANNEL_INVITE_ONLY = 9

org.freedesktop.Telepathy.Error.Channel.InviteOnly: The requested channel is invite-only.

class TelepathyGLib.FileHashType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

No hash.

MD5 = 1

MD5 digest as a string of 32 ASCII hex digits.

SHA1 = 2

SHA1 digest as a string of ASCII hex digits.

SHA256 = 3

SHA256 digest as a string of ASCII hex digits.

class TelepathyGLib.FileTransferState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

An invalid state type used as a null value. This value MUST NOT appear in the State property.

PENDING = 1

The file transfer is waiting to be accepted/closed by the receiver. The receiver has to call AcceptFile, then wait for the state to change to Open and check the offset value.

ACCEPTED = 2

The receiver has accepted the transfer. The sender now has to call ProvideFile to actually start the transfer. The receiver should now wait for the state to change to Open and check the offset value.

OPEN = 3

The file transfer is open for traffic.

COMPLETED = 4

The file transfer has been completed successfully.

CANCELLED = 5

The file transfer has been cancelled.

class TelepathyGLib.FileTransferStateChangeReason(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

No reason was specified.

REQUESTED = 1

The change in state was requested.

LOCAL_STOPPED = 2

The file transfer was cancelled by the local user.

REMOTE_STOPPED = 3

The file transfer was cancelled by the remote user.

LOCAL_ERROR = 4

The file transfer was cancelled because of a local error.

REMOTE_ERROR = 5

The file transfer was cancelled because of a remote error.

class TelepathyGLib.HTTPMethod(value)

Bases: GLib.Enum

The HTTP Method with which to request a URL.

Bitfield/set of flags generated from the Telepathy specification.

GET = 0

Use the GET method when opening the URL.

POST = 1

Use the POST method when opening the URL. Refer to HTTP_Post_Data for more details.

class TelepathyGLib.HandleType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

A “null” handle type used to indicate the absence of a handle. When a handle type and a handle appear as a pair, if the handle type is zero, the handle must also be zero.

CONTACT = 1

A contact

ROOM = 2

A chat room

LIST = 3

A server-generated contact list (see Channel.Interface.Group)

GROUP = 4

A user-defined contact list (see Channel.Interface.Group)

class TelepathyGLib.LocalHoldState(value)

Bases: GLib.Enum

The hold state of a channel.

Bitfield/set of flags generated from the Telepathy specification.

UNHELD = 0

All streams are unheld (the call is active). New channels SHOULD have this hold state.

HELD = 1

All streams are held (the call is on hold)

PENDING_HOLD = 2

The connection manager is attempting to move to state Held, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are on hold. Examining the Hold state of Call Contents (if applicable) may provide more useful information.

PENDING_UNHOLD = 3

The connection manager is attempting to move to state Unheld, but has not yet completed that operation. It is unspecified whether any, all or none of the streams making up the channel are on hold. Examining the Hold state of Call Contents (if applicable) may provide more useful information.

class TelepathyGLib.LocalHoldStateReason(value)

Bases: GLib.Enum

The reason for a change to the Local_Hold_State. Clients MUST treat unknown values as equivalent to Local_Hold_State_Reason_None.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

The reason cannot be described by any of the predefined values (connection managers SHOULD avoid this reason, but clients MUST handle it gracefully)

REQUESTED = 1

The change is in response to a user request

RESOURCE_NOT_AVAILABLE = 2

The change is because some resource was not available

class TelepathyGLib.MediaStreamBaseProto(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

UDP = 0

UDP (User Datagram Protocol)

TCP = 1

TCP (Transmission Control Protocol)

class TelepathyGLib.MediaStreamDirection(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

Media are not being sent or received

SEND = 1

Media are being sent, but not received

RECEIVE = 2

Media are being received, but not sent

BIDIRECTIONAL = 3

Media are being sent and received

class TelepathyGLib.MediaStreamError(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

An unknown error occured.

EOS = 1

The end of the stream was reached.

CODEC_NEGOTIATION_FAILED = 2

There are no common codecs between the local side and the other particpants in the call. The possible codecs are not signalled here: the streaming implementation is assumed to report them in an implementation-dependent way, e.g. Farsight should use GstMissingElement.

CONNECTION_FAILED = 3

A network connection for the Media could not be established or was lost.

NETWORK_ERROR = 4

There was an error in the networking stack (other than the connection failure).

NO_CODECS = 5

There are no installed codecs for this media type.

INVALID_CM_BEHAVIOR = 6

The CM is doing something wrong.

MEDIA_ERROR = 7

There was an error in the media processing stack.

class TelepathyGLib.MediaStreamState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

DISCONNECTED = 0

The stream is disconnected.

CONNECTING = 1

The stream is trying to connect.

CONNECTED = 2

The stream is connected.

class TelepathyGLib.MediaStreamTransportType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

LOCAL = 0

A local address

DERIVED = 1

An external address derived by a method such as STUN

RELAY = 2

An external stream relay

class TelepathyGLib.MediaStreamType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

AUDIO = 0

An audio stream

VIDEO = 1

A video stream

class TelepathyGLib.RCPTXRRTTMode(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

ALL = 0

Both RTP data senders and data receivers MAY send DLRR blocks.

SENDER = 1

Only active RTP senders MAY send DLRR blocks, i.e., non RTP senders SHALL NOT send DLRR blocks.

class TelepathyGLib.RichPresenceAccessControlType(value)

Bases: GLib.Enum

A type of access control for Rich_Presence_Access_Control. For most types, the exact access control is given by an associated variant. These are the access control types from XMPP publish/subscribe (XEP-0060). Location uses this for historical reasons, new interfaces will use Access_Control_Type.

Bitfield/set of flags generated from the Telepathy specification.

WHITELIST = 0

The associated variant is a list of contacts (signature ‘au’, Contact_Handle[]) who can see the extended presence information.

PUBLISH_LIST = 1

All contacts in the user’s ‘publish’ contact list can see the extended presence information. The associated variant is ignored.

GROUP = 2

The associated variant is a handle of type Group (signature ‘u’, Group_Handle) representing a group of contacts who can see the extended presence information.

OPEN = 3

Anyone with access to the service can see the extended presence information.

class TelepathyGLib.SASLAbortReason(value)

Bases: GLib.Enum

A reason why SASL authentication was aborted by the client.

Bitfield/set of flags generated from the Telepathy specification.

INVALID_CHALLENGE = 0

The server sent an invalid challenge or data.

USER_ABORT = 1

The user aborted the authentication.

class TelepathyGLib.SASLStatus(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

NOT_STARTED = 0

The initial state. The Handler SHOULD either call AbortSASL, or connect to the NewChallenge signal then call StartMechanism or StartMechanismWithData.

IN_PROGRESS = 1

The challenge/response exchange is in progress. The Handler SHOULD call either Respond or AcceptSASL exactly once per emission of NewChallenge, or call AbortSASL at any time.

SERVER_SUCCEEDED = 2

The server has indicated successful authentication, and the connection manager is waiting for confirmation from the Handler. The Handler must call either AcceptSASL or AbortSASL to indicate whether it considers authentication to have been successful.

CLIENT_ACCEPTED = 3

The Handler has indicated successful authentication, and the connection manager is waiting for confirmation from the server. The state will progress to either Succeeded or Server_Failed when confirmation is received.

SUCCEEDED = 4

Everyone is happy (the server sent success, and the client has called AcceptSASL). Connection to the server will proceed as soon as this state is reached. The Handler SHOULD call Close to close the channel.

SERVER_FAILED = 5

The server has indicated an authentication failure. If CanTryAgain is true, the client may try to authenticate again, by calling StartMechanism or StartMechanismWithData again. Otherwise, it should give up completely, by calling Close on the channel.

CLIENT_FAILED = 6

The client has indicated an authentication failure. The possible actions are the same as for Server_Failed.

class TelepathyGLib.SendingState(value)

Bases: GLib.Enum

Enum indicating whether a contact is sending media.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

The contact is not sending media and has not been asked to do so.

PENDING_SEND = 1

The contact has been asked to start sending media.

SENDING = 2

The contact is sending media.

PENDING_STOP_SENDING = 3

The contact has been asked to stop sending media.

class TelepathyGLib.ServicePointType(value)

Bases: GLib.Enum

The various types of service points a channel might connect to.

Bitfield/set of flags generated from the Telepathy specification.

NONE = 0

The channel is not communicating with a service point, or it is not known whether it is communicating with a service point (e.g. an ordinary call).

EMERGENCY = 1

The service point is a generic emergency point.

COUNSELING = 2

The service point is some kind of counseling service (ie, mental health or child-services counseling).

class TelepathyGLib.SocketAccessControl(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

LOCALHOST = 0

The IP or Unix socket can be accessed by any local user (e.g. a Unix socket that accepts all local connections, or an IP socket listening on 127.0.0.1 (or ::1) or rejecting connections not from that address). The associated variant must be ignored. For a D-Bus tube, this means that the “same user” access control typically provided by default in D-Bus implementations SHOULD be disabled. If the socket is only available to local users (e.g. a Unix socket, an IPv4 socket bound to 127.0.0.1, or an IPv6 socket bound to ::1), the ANONYMOUS authentication mechanism MAY be enabled.

PORT = 1

May only be used on IP sockets, and only for Stream tubes. The associated variant must contain a struct Socket_Address_IPv4 (or Socket_Address_IPv6) containing the string form of an IP address of the appropriate version, and a port number. The socket can only be accessed if the connecting process has that address and port number; all other connections will be rejected.

NETMASK = 2

May only be used on IP sockets. The associated variant must contain a struct Socket_Netmask_IPv4 (or Socket_Netmask_IPv6) with signature (sy), containing the string form of an IP address of the appropriate version, and a prefix length “n”. The socket can only be accessed if the first n bits of the connecting address match the first n bits of the given address.

CREDENTIALS = 3

The high-level meaning of this access control type is that only the same user (e.g. same numeric Unix uid) is allowed to interact with the tube. Exactly how this is achieved varies by channel type. For StreamTube channels, this access control type may only be used on UNIX sockets. The connecting process must send a byte when it first connects, which is not considered to be part of the data stream. If the operating system uses sendmsg() with SCM_CREDS or SCM_CREDENTIALS to pass credentials over sockets, the connecting process must do so if possible; if not, it must still send the byte, without any attached credentials. (This mechanism is very similar to the first byte of a D-Bus connection, except that in D-Bus the byte is always zero, whereas in Tubes it can be nonzero.) For DBusTube channels, this access control type may be used on any type of socket, and there is no extra byte added by Telepathy at the beginning of the stream: all bytes in the stream are part of the D-Bus tube connection. The connecting process should prove its identity via any of the SASL authentication mechanisms usually used for D-Bus (in typical D-Bus implementations this involves either sending and receiving credentials as above, or demonstrating the ability to write to a file in the user’s home directory). In either case, the listening process will disconnect the connection unless it can determine by OS-specific means that the connecting process has the same user ID as the listening process. In either tube type, the associated variant must be ignored.

class TelepathyGLib.SocketAddressType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

UNIX = 0

A Unix socket. The address variant contains a byte-array, signature ‘ay’, containing the path of the socket.

ABSTRACT_UNIX = 1

An abstract Unix socket. The address variant contains a byte-array, signature ‘ay’, containing the path of the socket including the leading null byte.

IPV4 = 2

An IPv4 socket. The address variant contains a Socket_Address_IPv4, i.e. a structure with signature (sq) in which the string is an IPv4 dotted-quad address literal (and must not be a DNS name), while the 16-bit unsigned integer is the port number.

IPV6 = 3

An IPv6 socket. The address variant contains a Socket_Address_IPv6, i.e. a structure with signature (sq) in which the string is an IPv6 address literal as specified in RFC2373 (and must not be a DNS name), while the 16-bit unsigned integer is the port number.

class TelepathyGLib.StreamComponent(value)

Bases: GLib.Enum

Media streams can use more than one UDP socket: one for RTP (data) and one for RTCP (control). Most of the time, they are adjacent to each other, but some protocols (xmpp) signal each port separately.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The stream transport type is unknown or not applicable (should not appear over dbus).

DATA = 1

This is the high-traffic data socket, containing the audio/video data for the stream.

CONTROL = 2

This is the low-traffic control socket, usually containing feedback about packet loss etc.

class TelepathyGLib.StreamEndpointState(value)

Bases: GLib.Enum

Represents the state of ICE negotiation for a single component of a stream to an endpoint.

Bitfield/set of flags generated from the Telepathy specification.

CONNECTING = 0

Candidate gathering and connectivity checks are in progress.

PROVISIONALLY_CONNECTED = 1

The streaming implementation has found at least one working candidate pair. It is possible to send media at this point, but the controlling side has yet to negotiate the final candidates for use in this call.

FULLY_CONNECTED = 2

This component of the stream is connected, and an updated offer has been sent and accepted (finalising the candidates to be used for the call). This should be set by the CM in response to AcceptSelectedCandidatePair.

EXHAUSTED_CANDIDATES = 3

The streaming implementation has tried connecting to all of the available candidates and none of them have connected. This is distinct from Failed, because the CM might be able to provide more candidates later (more likely in XMPP than SIP).

FAILED = 4

The CM and streaming implementation are in agreement that it is impossible to connect to this endpoint. This value should only be set by the CM.

class TelepathyGLib.StreamFlowState(value)

Bases: GLib.Enum

The type of SendingState and ReceivingState.

Bitfield/set of flags generated from the Telepathy specification.

STOPPED = 0

No data is flowing (or expected to be flowing) at this time.

PENDING_START = 1

The streaming implementation has been told to start or receiving, but has not yet indicated that it is doing so.

PENDING_STOP = 2

The streaming implementation has been told to stop sending or receiving data, but it has not yet indicated that it has done so.

STARTED = 3

The streaming implementation is successfully sending or receiving data, and everything is going swimmingly.

class TelepathyGLib.StreamTransportType(value)

Bases: GLib.Enum

A transport that can be used for streaming.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The stream transport type is unknown or not applicable (for streams that do not have a configurable transport).

RAW_UDP = 1

Raw UDP, with or without STUN. All streaming clients are assumed to support this transport, so there is no handler capability token for it in the Call1 interface. [This corresponds to “none” or “stun” in the old Media.StreamHandler interface.]

ICE = 2

Interactive Connectivity Establishment, as defined by RFC 5245. Note that this value covers ICE-UDP only. [This corresponds to “ice-udp” in the old Media.StreamHandler interface.]

GTALK_P2P = 3

Google Talk peer-to-peer connectivity establishment, as implemented by libjingle 0.3. [This corresponds to “gtalk-p2p” in the old Media.StreamHandler interface.]

WLM_2009 = 4

The transport used by Windows Live Messenger 2009 or later, which resembles ICE draft 19. [This corresponds to “wlm-2009” in the old Media.StreamHandler interface.]

SHM = 5

Shared memory transport, as implemented by the GStreamer shmsrc and shmsink plugins.

MULTICAST = 6

Multicast transport.

class TelepathyGLib.SubscriptionState(value)

Bases: GLib.Enum

An enumeration indicating whether presence subscription is denied, denied but pending permission, or allowed. The exact semantics vary according to where this type is used: see the subscribe and publish contact attributes for details.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The presence subscription state is unknown.

NO = 1

Presence information cannot be seen, and either the subscription state Removed_Remotely does not apply, or it is not known whether that state applies.

REMOVED_REMOTELY = 2

Presence information cannot be seen because the remote contact took action: either the local user’s request to see the remote contact’s presence was denied, or the remote contact requested to see the local user’s presence but then cancelled their request.

ASK = 3

Presence information cannot be seen. Permission to see presence information has been requested, and the request has not yet been declined or accepted.

YES = 4

Presence information can be seen.

class TelepathyGLib.TLSCertificateRejectReason(value)

Bases: GLib.Enum

Possible reasons to reject a TLS certificate.

Bitfield/set of flags generated from the Telepathy specification.

UNKNOWN = 0

The certificate has been rejected for another reason not listed in this enumeration.

UNTRUSTED = 1

The certificate is not trusted.

EXPIRED = 2

The certificate is expired.

NOT_ACTIVATED = 3

The certificate is not active yet.

FINGERPRINT_MISMATCH = 4

The certificate provided does not have the expected fingerprint.

HOSTNAME_MISMATCH = 5

The hostname certified does not match the provided one.

SELF_SIGNED = 6

The certificate is self-signed.

REVOKED = 7

The certificate has been revoked.

INSECURE = 8

The certificate uses an insecure cipher algorithm, or is cryptographically weak.

LIMIT_EXCEEDED = 9

The length in bytes of the certificate, or the depth of the certificate chain exceed the limits imposed by the crypto library.

class TelepathyGLib.TLSCertificateState(value)

Bases: GLib.Enum

The possible states for a TLSCertificate object.

Bitfield/set of flags generated from the Telepathy specification.

PENDING = 0

The certificate is currently waiting to be accepted or rejected.

ACCEPTED = 1

The certificate has been verified.

REJECTED = 2

The certificate has been rejected.

class TelepathyGLib.TubeChannelState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

LOCAL_PENDING = 0

The initiator offered the tube. The tube is waiting to be accepted/closed locally. If the client accepts the tube, the tube’s state will be Open.

REMOTE_PENDING = 1

The tube is waiting to be accepted/closed remotely. If the recipient accepts the tube, the tube’s state will be Open.

OPEN = 2

The initiator offered the tube and the recipient accepted it. The tube is open for traffic. The tube’s state stays in this state until it is closed.

NOT_OFFERED = 3

The tube channel has been requested but the tube is not yet offered. The client should offer the tube to the recipient and the tube’s state will be Remote_Pending. The method used to offer the tube depends on the tube type.

class TelepathyGLib.TubeState(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

LOCAL_PENDING = 0

The tube is waiting to be accepted/closed locally.

REMOTE_PENDING = 1

The tube is waiting to be accepted/closed remotely.

OPEN = 2

The tube is open for traffic.

class TelepathyGLib.TubeType(value)

Bases: GLib.Enum

Bitfield/set of flags generated from the Telepathy specification.

DBUS = 0

The tube is D-Bus tube as described by the org.freedesktop.Telepathy.Channel.Type.DBusTube interface.

STREAM = 1

The tube is stream tube as described by the org.freedesktop.Telepathy.Channel.Type.StreamTube interface.