Flag type constants
[Types and constants]

Typedefs

• typedef QFlags< CallFlag > Tpy::CallFlags
• typedef QFlags< CallMemberFlag > Tpy::CallMemberFlags

Enumerations

• enum Tpy::CallFlag {
    Tpy::CallFlagLocallyRinging, Tpy::CallFlagQueued, Tpy::CallFlagLocallyHeld, Tpy::CallFlagForwarded,
    Tpy::CallFlagInProgress, Tpy::CallFlagClearing, Tpy::CallFlagMuted, Tpy::_CallFlagPadding
  }
• enum Tpy::CallMemberFlag { Tpy::CallMemberFlagRinging, Tpy::CallMemberFlagHeld, Tpy::CallMemberFlagConferenceHost, Tpy::_CallMemberFlagPadding }

---

Detailed Description

Types generated from the specification representing bit flag constants and combinations of them (bitfields).

---

Typedef Documentation

QFlags< CallFlag > Tpy::CallFlags

Type representing combinations of CallFlag values.

A set of flags representing the status of the call as a whole, providing more specific information than the CallState. Many of these flags only make sense in a particular state.

QFlags< CallMemberFlag > Tpy::CallMemberFlags

Type representing combinations of CallMemberFlag values.

A set of flags representing the status of a remote contact in a call.

It is protocol- and client-specific whether a particular contact will ever have a particular flag set on them, and Telepathy clients SHOULD NOT assume that a flag will ever be set.

<tp:rationale>

180 Ringing in SIP, and its equivalent in XMPP, are optional informational messages, and implementations are not required to send them. The same applies to the messages used to indicate hold state. </tp:rationale>

---

Enumeration Type Documentation

enum Tpy::CallFlag

Flag type generated from the specification.

Enumerator:

CallFlagLocallyRinging	The local contact has been alerted about the call but has not responded; if possible, the remote contact(s) have been informed of this fact. This flag only makes sense on incoming calls in state Call_State_Pending_Receiver. It SHOULD be set when SetRinging is called successfully, and unset when the state changes.
CallFlagQueued	The contact is temporarily unavailable, and the call has been placed in a queue (e.g. 182 Queued in SIP, or call-waiting in telephony). This flag only makes sense on outgoing 1-1 calls in state Call_State_Pending_Receiver. It SHOULD be set or unset according to informational messages from other contacts.
CallFlagLocallyHeld	The call has been put on hold by the local user, e.g. using the Hold interface. This flag SHOULD only be set if there is at least one Content, and all Contents are locally held; it makes sense on calls in state Call_State_Pending_Receiver or Call_State_Accepted. Otherwise, in transient situations where some but not all contents are on hold, UIs would falsely indicate that the call as a whole is on hold, which could lead to the user saying something they'll regret, while under the impression that the other contacts can't hear them!
CallFlagForwarded	The initiator of the call originally called a contact other than the current recipient of the call, but the call was then forwarded or diverted. This flag only makes sense on outgoing calls, in state Call_State_Pending_Receiver or Call_State_Accepted. It SHOULD be set or unset according to informational messages from other contacts.
CallFlagInProgress	Progress has been made in placing the outgoing call, but the contact may not have been made aware of the call yet (so the Ringing state is not appropriate). This corresponds to SIP's status code 183 Session Progress, and could be used when the outgoing call has reached a gateway, for instance. This flag only makes sense on outgoing calls in state Call_State_Pending_Receiver, and SHOULD be set or unset according to informational messages from servers, gateways and other infrastructure.
CallFlagClearing	This flag only occurs when the CallState is Ended. The call with this flag set has ended, but not all resources corresponding to the call have been freed yet. Depending on the protocol there might be some audible feedback while the clearing flag is set. In calls following the ITU-T Q.931 standard there is a period of time between the call ending and the underlying channel being completely free for re-use.
CallFlagMuted	The call has been muted by the local user, e.g. using the Mute.DRAFT interface. This flag SHOULD only be set if there is at least one Content, and all Contents are locally muted; it makes sense on calls in state Call_State_Pending_Receiver or Call_State_Accepted.
_CallFlagPadding

enum Tpy::CallMemberFlag

Flag type generated from the specification.

Enumerator:

CallMemberFlagRinging	The remote contact's client has told us that the contact has been alerted about the call but has not responded. <tp:rationale> This is a flag per member, not a flag for the call as a whole, because in Muji conference calls, you could invite someone and have their state be "ringing" for a while. </tp:rationale>
CallMemberFlagHeld	The call member has put this call on hold. <tp:rationale> This is a flag per member, not a flag for the call as a whole, because in conference calls, any member could put the conference on hold. </tp:rationale>
CallMemberFlagConferenceHost	This contact has merged this call into a conference. Note that GSM provides a notification when the remote party merges a call into a conference, but not when it is split out again; thus, this flag can only indicate that the call has been part of a conference at some point. If a GSM connection manager receives a notification that a call has been merged into a conference a second time, it SHOULD represent this by clearing and immediately re-setting this flag on the remote contact.
_CallMemberFlagPadding