Home · Modules · All Classes · All Namespaces |
Types generated from the specification representing enumerated types ie. types the values of which are mutually exclusive integral constants.
enum Tp::HandleType |
Enumerated type generated from the specification.
enum Tp::ConnectionStatus |
Enumerated type generated from the specification.
Enumerator | |
---|---|
ConnectionStatusConnected | The connection is fully connected and all methods are available. |
ConnectionStatusConnecting | Connect has been called but the connection has not yet been established. Some methods may fail until the connection has been established. |
ConnectionStatusDisconnected | 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. |
_ConnectionStatusPadding |
Enumerated type generated from the specification.
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.
enum Tp::ContactListState |
Enumerated type generated from the specification.
The progress made in retrieving the contact list.
Enumerated type generated from the specification.
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
Enumerator | |
---|---|
SubscriptionStateUnknown | The presence subscription state is unknown. |
SubscriptionStateNo | Presence information cannot be seen, and either the subscription state Removed_Remotely does not apply, or it is not known whether that state applies. |
SubscriptionStateRemovedRemotely | 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. |
SubscriptionStateAsk | Presence information cannot be seen. Permission to see presence information has been requested, and the request has not yet been declined or accepted. |
SubscriptionStateYes | Presence information can be seen. |
_SubscriptionStatePadding |
Enumerated type generated from the specification.
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.
enum Tp::HTTPMethod |
enum Tp::ServicePointType |
Enumerated type generated from the specification.
The various types of service points a channel might connect to.
Enumerated type generated from the specification.
Enumerator | |
---|---|
ConnectionPresenceTypeUnset | 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. |
ConnectionPresenceTypeOffline | Offline |
ConnectionPresenceTypeAvailable | Available |
ConnectionPresenceTypeAway | Away |
ConnectionPresenceTypeExtendedAway | Away for an extended time |
ConnectionPresenceTypeHidden | Hidden (invisible) |
ConnectionPresenceTypeBusy | Busy, Do Not Disturb. |
ConnectionPresenceTypeUnknown | Unknown, unable to determine presence for this contact, for example if the protocol only allows presence of subscribed contacts. |
ConnectionPresenceTypeError | Error, an error occurred while trying to determine presence. The message, if set, is an error from the server. |
_ConnectionPresenceTypePadding |
Enumerated type generated from the specification.
A type for communication access control. These control policies are used in org.freedesktop.Telepathy.Connection.Interface.CommunicationPolicy.DRAFT as well as most rich presence interfaces.
New interfaces should use this type, and NOT
Enumerated type generated from the specification.
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).
ConnectionInterfaceLocationInterface
uses this for historical reasons, new interfaces will use
enum Tp::CallState |
Enumerated type generated from the specification.
The state of a call, as a whole.
The allowed transitions are:
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.
Enumerated type generated from the specification.
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.
Enumerator | |
---|---|
CallStateChangeReasonUnknown | We just don't know. Unknown values of this enum SHOULD also be treated like this. |
CallStateChangeReasonProgressMade | Situation normal. Progress has been made in the setup/teardown of the call (and it didn't require any user interaction). |
CallStateChangeReasonUserRequested |
The change was requested by the contact indicated by the Actor
member of a 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.). |
CallStateChangeReasonForwarded |
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. |
CallStateChangeReasonRejected |
The CallState changed from
Corresponds to |
CallStateChangeReasonNoAnswer |
The CallState changed from
Corresponds to |
CallStateChangeReasonInvalidContact |
The CallState changed because one of the addresses does not exist on the network. Corresponds to |
CallStateChangeReasonPermissionDenied |
The CallState changed because the local user is not authorised. Corresponds to |
CallStateChangeReasonBusy |
The CallState changed from
Corresponds to |
CallStateChangeReasonInternalError |
There has been an unexpected error in either the CM or some other local component. Corresponds to |
CallStateChangeReasonServiceError |
There has been an unexpected error in the server or some other remote component. Corresponds to
|
CallStateChangeReasonNetworkError |
There has been a network error related to the CM or the signalling part of the call (compare and contrast: Streaming_Error). Corresponds to
|
CallStateChangeReasonMediaError |
Some aspect of the content is unsupported so has to be removed from the call. Corresponds to |
CallStateChangeReasonConnectivityError | 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 |
_CallStateChangeReasonPadding |
Enumerated type generated from the specification.
Enumerated type generated from the specification.
Enumerated type generated from the specification.
enum Tp::FileHashType |
enum Tp::MediaStreamType |
enum Tp::MediaStreamState |
Enumerated type generated from the specification.
Enumerated type generated from the specification.
Enumerated type generated from the specification.
The type of message.
enum Tp::TubeType |
Enumerated type generated from the specification.
enum Tp::TubeState |
Enumerated type generated from the specification.
A reason why captcha authentication was aborted by the client.
enum Tp::CaptchaStatus |
Enumerated type generated from the specification.
Enumerator | |
---|---|
CaptchaStatusLocalPending | 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. |
CaptchaStatusRemotePending | 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. |
CaptchaStatusSucceeded | 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. |
CaptchaStatusTryAgain | The server has indicated an authentication failure. Call GetCaptchas again to get a new captcha, or CancelCaptcha followed by Close to give up. |
CaptchaStatusFailed | Authentication has failed in some way. There is nothing useful to do in this state except to close the channel with Close. |
_CaptchaStatusPadding |
enum Tp::ChannelChatState |
Enumerated type generated from the specification.
enum Tp::DTMFEvent |
Enumerated type generated from the specification.
Enumerated type generated from the specification.
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.
Enumerator | |
---|---|
ChannelGroupChangeReasonNone |
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
If the SelfHandle is removed from a group for this reason and
the actor is also the SelfHandle, the equivalent D-Bus error is
|
ChannelGroupChangeReasonOffline |
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 ChannelTypeStreamedMediaInterface 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
|
ChannelGroupChangeReasonKicked |
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
|
ChannelGroupChangeReasonBusy |
The change is due to a busy indication. If a one-to-one ChannelTypeStreamedMediaInterface 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
|
ChannelGroupChangeReasonInvited | 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? |
ChannelGroupChangeReasonBanned |
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
|
ChannelGroupChangeReasonError | The change is due to an error occurring. |
ChannelGroupChangeReasonInvalidContact |
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
|
ChannelGroupChangeReasonNoAnswer |
The change is because the requested contact did not respond. If a one-to-one ChannelTypeStreamedMediaInterface 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
|
ChannelGroupChangeReasonRenamed |
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 org.freedesktop.Telepathy.Connection.Interface.Renaming.Renamed signal on the org.freedesktop.Telepathy.Connection.Interface.Renaming interface will have been emitted for the same handles, shortly before this MembersChanged() signal is emitted. |
ChannelGroupChangeReasonPermissionDenied |
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
|
ChannelGroupChangeReasonSeparated |
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. ChannelTypeTextInterface or ChannelTypeTubesInterface 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. |
_ChannelGroupChangeReasonPadding |
enum Tp::LocalHoldState |
Enumerated type generated from the specification.
The hold state of a channel.
Enumerated type generated from the specification.
The reason for a change to the Local_Hold_State. Clients MUST treat unknown values as equivalent to Local_Hold_State_Reason_None.
enum Tp::DeliveryStatus |
Enumerated type generated from the specification.
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.
enum Tp::SASLAbortReason |
enum Tp::SASLStatus |
Enumerated type generated from the specification.
Enumerator | |
---|---|
SASLStatusNotStarted | The initial state. The Handler SHOULD either call AbortSASL, or connect to the NewChallenge signal then call StartMechanism or StartMechanismWithData. |
SASLStatusInProgress | 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. |
SASLStatusServerSucceeded | 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. |
SASLStatusClientAccepted | 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. |
SASLStatusSucceeded | 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. |
SASLStatusServerFailed | 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. |
SASLStatusClientFailed | The client has indicated an authentication failure. The possible actions are the same as for Server_Failed. |
_SASLStatusPadding |
enum Tp::TubeChannelState |
Enumerated type generated from the specification.
Enumerated type generated from the specification.
Enumerated type generated from the specification.
enum Tp::MediaStreamError |
Enumerated type generated from the specification.
enum Tp::DebugLevel |
Enumerated type generated from the specification.
Enumerated type generated from the specification.
The possible states for a TLSCertificate object.
Enumerated type generated from the specification.
Possible reasons to reject a TLS certificate.
Enumerated type generated from the specification.
A packetization method that can be used for a content.
Enumerated type generated from the specification.
The disposition of this content, which defines whether to automatically start sending data on the streams when Accept is called on the channel.
Enumerator | |
---|---|
CallContentDispositionNone | The content has no specific disposition. |
CallContentDispositionInitial |
The content was initially part of the call. When
ChannelTypeCallInterface::Accept()
is called on the channel, all streams of this content with
CallStreamInterface::LocalSendingState
set to |
_CallContentDispositionPadding |
enum Tp::RCPTXRRTTMode |
enum Tp::StreamFlowState |
Enumerated type generated from the specification.
The type of SendingState and ReceivingState .
Enumerated type generated from the specification.
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.
enum Tp::StreamComponent |
Enumerated type generated from the specification.
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.
Enumerated type generated from the specification.
A transport that can be used for streaming.
enum Tp::SendingState |
Enumerated type generated from the specification.
Enum indicating whether a contact is sending media.
Enumerated type generated from the specification.
Represents the state of ICE negotiation for a single component of a stream to an endpoint.
Enumerator | |
---|---|
StreamEndpointStateConnecting | Candidate gathering and connectivity checks are in progress. |
StreamEndpointStateProvisionallyConnected | 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. |
StreamEndpointStateFullyConnected | 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. |
StreamEndpointStateExhaustedCandidates | 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). |
StreamEndpointStateFailed | 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. |
_StreamEndpointStatePadding |
enum Tp::LocalMuteState |
Enumerated type generated from the specification.
The mute state of (at least part of) the call. See LocalMuteState for more details.
const int Tp::NUM_HANDLE_TYPES |
1 higher than the highest valid value of HandleType.
const int Tp::NUM_CONNECTION_STATUSES |
1 higher than the highest valid value of ConnectionStatus.
const int Tp::NUM_CONNECTION_STATUS_REASONS |
1 higher than the highest valid value of ConnectionStatusReason.
const int Tp::NUM_CONTACT_LIST_STATES |
1 higher than the highest valid value of ContactListState.
const int Tp::NUM_SUBSCRIPTION_STATES |
1 higher than the highest valid value of SubscriptionState.
const int Tp::NUM_CONTACT_METADATA_STORAGE_TYPES |
1 higher than the highest valid value of ContactMetadataStorageType.
const int Tp::NUM_HTTP_METHODS |
1 higher than the highest valid value of HTTPMethod.
const int Tp::NUM_SERVICE_POINT_TYPES |
1 higher than the highest valid value of ServicePointType.
const int Tp::NUM_CONNECTION_PRESENCE_TYPES |
1 higher than the highest valid value of ConnectionPresenceType.
const int Tp::NUM_ACCESS_CONTROL_TYPES |
1 higher than the highest valid value of AccessControlType.
const int Tp::NUM_RICH_PRESENCE_ACCESS_CONTROL_TYPES |
1 higher than the highest valid value of RichPresenceAccessControlType.
const int Tp::NUM_CALL_STATES |
1 higher than the highest valid value of CallState.
const int Tp::NUM_CALL_STATE_CHANGE_REASONS |
1 higher than the highest valid value of CallStateChangeReason.
const int Tp::NUM_CHANNEL_CONTACT_SEARCH_STATES |
1 higher than the highest valid value of ChannelContactSearchState.
const int Tp::NUM_FILE_TRANSFER_STATES |
1 higher than the highest valid value of FileTransferState.
const int Tp::NUM_FILE_TRANSFER_STATE_CHANGE_REASONS |
1 higher than the highest valid value of FileTransferStateChangeReason.
const int Tp::NUM_FILE_HASH_TYPES |
1 higher than the highest valid value of FileHashType.
const int Tp::NUM_MEDIA_STREAM_TYPES |
1 higher than the highest valid value of MediaStreamType.
const int Tp::NUM_MEDIA_STREAM_STATES |
1 higher than the highest valid value of MediaStreamState.
const int Tp::NUM_MEDIA_STREAM_DIRECTIONS |
1 higher than the highest valid value of MediaStreamDirection.
const int Tp::NUM_CHANNEL_TEXT_SEND_ERRORS |
1 higher than the highest valid value of ChannelTextSendError.
const int Tp::NUM_CHANNEL_TEXT_MESSAGE_TYPES |
1 higher than the highest valid value of ChannelTextMessageType.
const int Tp::NUM_TUBE_TYPES |
1 higher than the highest valid value of TubeType.
const int Tp::NUM_TUBE_STATES |
1 higher than the highest valid value of TubeState.
const int Tp::NUM_CAPTCHA_CANCEL_REASONS |
1 higher than the highest valid value of CaptchaCancelReason.
const int Tp::NUM_CAPTCHA_STATUSES |
1 higher than the highest valid value of CaptchaStatus.
const int Tp::NUM_CHANNEL_CHAT_STATES |
1 higher than the highest valid value of ChannelChatState.
const int Tp::NUM_DTMF_EVENTS |
1 higher than the highest valid value of DTMFEvent.
const int Tp::NUM_CHANNEL_GROUP_CHANGE_REASONS |
1 higher than the highest valid value of ChannelGroupChangeReason.
const int Tp::NUM_LOCAL_HOLD_STATES |
1 higher than the highest valid value of LocalHoldState.
const int Tp::NUM_LOCAL_HOLD_STATE_REASONS |
1 higher than the highest valid value of LocalHoldStateReason.
const int Tp::NUM_DELIVERY_STATUSES |
1 higher than the highest valid value of DeliveryStatus.
const int Tp::NUM_SASL_ABORT_REASONS |
1 higher than the highest valid value of SASLAbortReason.
const int Tp::NUM_SASL_STATUSES |
1 higher than the highest valid value of SASLStatus.
const int Tp::NUM_TUBE_CHANNEL_STATES |
1 higher than the highest valid value of TubeChannelState.
const int Tp::NUM_SOCKET_ADDRESS_TYPES |
1 higher than the highest valid value of SocketAddressType.
const int Tp::NUM_SOCKET_ACCESS_CONTROLS |
1 higher than the highest valid value of SocketAccessControl.
const int Tp::NUM_MEDIA_STREAM_ERRORS |
1 higher than the highest valid value of MediaStreamError.
const int Tp::NUM_MEDIA_STREAM_BASE_PROTOS |
1 higher than the highest valid value of MediaStreamBaseProto.
const int Tp::NUM_MEDIA_STREAM_TRANSPORT_TYPES |
1 higher than the highest valid value of MediaStreamTransportType.
const int Tp::NUM_DEBUG_LEVELS |
1 higher than the highest valid value of DebugLevel.
const int Tp::NUM_TLS_CERTIFICATE_STATES |
1 higher than the highest valid value of TLSCertificateState.
const int Tp::NUM_TLS_CERTIFICATE_REJECT_REASONS |
1 higher than the highest valid value of TLSCertificateRejectReason.
const int Tp::NUM_CALL_CONTENT_PACKETIZATION_TYPES |
1 higher than the highest valid value of CallContentPacketizationType.
const int Tp::NUM_CALL_CONTENT_DISPOSITIONS |
1 higher than the highest valid value of CallContentDisposition.
const int Tp::NUM_RCPT_XR_RTT_MODES |
1 higher than the highest valid value of RCPTXRRTTMode.
const int Tp::NUM_STREAM_FLOW_STATES |
1 higher than the highest valid value of StreamFlowState.
const int Tp::NUM_CALL_STREAM_CANDIDATE_TYPES |
1 higher than the highest valid value of CallStreamCandidateType.
const int Tp::NUM_STREAM_COMPONENTS |
1 higher than the highest valid value of StreamComponent.
const int Tp::NUM_STREAM_TRANSPORT_TYPES |
1 higher than the highest valid value of StreamTransportType.
const int Tp::NUM_SENDING_STATES |
1 higher than the highest valid value of SendingState.
const int Tp::NUM_STREAM_ENDPOINT_STATES |
1 higher than the highest valid value of StreamEndpointState.
const int Tp::NUM_LOCAL_MUTE_STATES |
1 higher than the highest valid value of LocalMuteState.
TelepathyQt 0.9.8 | Generated by 1.8.15 |