Flag type constants

| Home · All Classes · All Namespaces · Modules · Functions · Files

Typedefs | Enumerations
Flag type constants
Types and constants

## Typedefs
typedef QFlags< ConnMgrParamFlag > | Tp::ConnMgrParamFlags
typedef QFlags < ConnectionAliasFlag > | Tp::ConnectionAliasFlags
typedef QFlags< AnonymityMode > | Tp::AnonymityModeFlags
typedef QFlags < ConnectionCapabilityFlag > | Tp::ConnectionCapabilityFlags
typedef QFlags < ContactBlockingCapability > | Tp::ContactBlockingCapabilities
typedef QFlags< ContactInfoFlag > | Tp::ContactInfoFlags
typedef QFlags < ContactInfoFieldFlag > | Tp::ContactInfoFieldFlags
typedef QFlags< LocationFeature > | Tp::LocationFeatures
typedef QFlags < MailNotificationFlag > | Tp::MailNotificationFlags
typedef QFlags< CallFlag > | Tp::CallFlags
typedef QFlags< CallMemberFlag > | Tp::CallMemberFlags
typedef QFlags < MediaStreamPending > | Tp::MediaStreamPendingSend
typedef QFlags < ChannelMediaCapability > | Tp::ChannelMediaCapabilities
typedef QFlags < ChannelTextMessageFlag > | Tp::ChannelTextMessageFlags
typedef QFlags< CaptchaFlag > | Tp::CaptchaFlags
typedef QFlags< ChannelCallState > | Tp::ChannelCallStateFlags
typedef QFlags< ChannelGroupFlag > | Tp::ChannelGroupFlags
typedef QFlags < MessagePartSupportFlag > | Tp::MessagePartSupportFlags
typedef QFlags < MessageSendingFlag > | Tp::MessageSendingFlags
typedef QFlags < DeliveryReportingSupportFlag > | Tp::DeliveryReportingSupportFlags
typedef QFlags < ChannelPasswordFlag > | Tp::ChannelPasswordFlags
typedef QFlags< PropertyFlag > | Tp::PropertyFlags
typedef QFlags < StorageRestrictionFlag > | Tp::StorageRestrictionFlags
typedef QFlags < RTCPXRStatisticsFlag > | Tp::RTCPXRStatisticsFlags

## Enumerations
enum | Tp::ConnMgrParamFlag { Tp::ConnMgrParamFlagRequired, Tp::ConnMgrParamFlagRegister, Tp::ConnMgrParamFlagHasDefault, Tp::ConnMgrParamFlagSecret, Tp::ConnMgrParamFlagDBusProperty, Tp::_ConnMgrParamFlagPadding }
enum | Tp::ConnectionAliasFlag { Tp::ConnectionAliasFlagUserSet, Tp::_ConnectionAliasFlagPadding }
enum | Tp::AnonymityMode { Tp::AnonymityModeClientInfo, Tp::AnonymityModeShowClientInfo, Tp::AnonymityModeNetworkInfo, Tp::_AnonymityModePadding }
enum | Tp::ConnectionCapabilityFlag { Tp::ConnectionCapabilityFlagCreate, Tp::ConnectionCapabilityFlagInvite, Tp::_ConnectionCapabilityFlagPadding }
enum | Tp::ContactBlockingCapability { Tp::ContactBlockingCapabilityCanReportAbusive, Tp::_ContactBlockingCapabilityPadding }
enum | Tp::ContactInfoFlag { Tp::ContactInfoFlagCanSet, Tp::ContactInfoFlagPush, Tp::_ContactInfoFlagPadding }
enum | Tp::ContactInfoFieldFlag { Tp::ContactInfoFieldFlagParametersExact, Tp::ContactInfoFieldFlagOverwrittenByNickname, Tp::_ContactInfoFieldFlagPadding }
enum | Tp::LocationFeature { Tp::LocationFeatureCanSet, Tp::_LocationFeaturePadding }
enum | Tp::MailNotificationFlag { Tp::MailNotificationFlagSupportsUnreadMailCount, Tp::MailNotificationFlagSupportsUnreadMails, Tp::MailNotificationFlagEmitsMailsReceived, Tp::MailNotificationFlagSupportsRequestInboxURL, Tp::MailNotificationFlagSupportsRequestMailURL, Tp::MailNotificationFlagThreadBased, Tp::_MailNotificationFlagPadding }
enum | Tp::CallFlag { Tp::CallFlagLocallyHeld, Tp::CallFlagLocallyRinging, Tp::CallFlagLocallyQueued, Tp::CallFlagForwarded, Tp::CallFlagClearing, Tp::_CallFlagPadding }
enum | Tp::CallMemberFlag { Tp::CallMemberFlagRinging, Tp::CallMemberFlagHeld, Tp::CallMemberFlagConferenceHost, Tp::_CallMemberFlagPadding }
enum | Tp::MediaStreamPending { Tp::MediaStreamPendingLocalSend, Tp::MediaStreamPendingRemoteSend, Tp::_MediaStreamPendingPadding }
enum | Tp::ChannelMediaCapability { Tp::ChannelMediaCapabilityAudio, Tp::ChannelMediaCapabilityVideo, Tp::ChannelMediaCapabilityNATTraversalSTUN, Tp::ChannelMediaCapabilityNATTraversalGTalkP2P, Tp::ChannelMediaCapabilityNATTraversalICEUDP, Tp::ChannelMediaCapabilityImmutableStreams, Tp::_ChannelMediaCapabilityPadding }
enum | Tp::ChannelTextMessageFlag { Tp::ChannelTextMessageFlagTruncated, Tp::ChannelTextMessageFlagNonTextContent, Tp::ChannelTextMessageFlagScrollback, Tp::ChannelTextMessageFlagRescued, Tp::_ChannelTextMessageFlagPadding }
enum | Tp::CaptchaFlag { Tp::CaptchaFlagRequired, Tp::_CaptchaFlagPadding }
enum | Tp::ChannelCallState { Tp::ChannelCallStateRinging, Tp::ChannelCallStateQueued, Tp::ChannelCallStateHeld, Tp::ChannelCallStateForwarded, Tp::ChannelCallStateInProgress, Tp::ChannelCallStateConferenceHost, Tp::_ChannelCallStatePadding }
enum | Tp::ChannelGroupFlag { Tp::ChannelGroupFlagCanAdd, Tp::ChannelGroupFlagCanRemove, Tp::ChannelGroupFlagCanRescind, Tp::ChannelGroupFlagMessageAdd, Tp::ChannelGroupFlagMessageRemove, Tp::ChannelGroupFlagMessageAccept, Tp::ChannelGroupFlagMessageReject, Tp::ChannelGroupFlagMessageRescind, Tp::ChannelGroupFlagChannelSpecificHandles, Tp::ChannelGroupFlagOnlyOneGroup, Tp::ChannelGroupFlagHandleOwnersNotAvailable, Tp::ChannelGroupFlagProperties, Tp::ChannelGroupFlagMembersChangedDetailed, Tp::ChannelGroupFlagMessageDepart, Tp::_ChannelGroupFlagPadding }
enum | Tp::MessagePartSupportFlag { Tp::MessagePartSupportFlagOneAttachment, Tp::MessagePartSupportFlagMultipleAttachments, Tp::_MessagePartSupportFlagPadding }
enum | Tp::MessageSendingFlag { Tp::MessageSendingFlagReportDelivery, Tp::MessageSendingFlagReportRead, Tp::MessageSendingFlagReportDeleted, Tp::_MessageSendingFlagPadding }
enum | Tp::DeliveryReportingSupportFlag { Tp::DeliveryReportingSupportFlagReceiveFailures, Tp::DeliveryReportingSupportFlagReceiveSuccesses, Tp::DeliveryReportingSupportFlagReceiveRead, Tp::DeliveryReportingSupportFlagReceiveDeleted, Tp::_DeliveryReportingSupportFlagPadding }
enum | Tp::ChannelPasswordFlag { Tp::ChannelPasswordFlagProvide, Tp::ChannelPasswordFlagHint, Tp::_ChannelPasswordFlagPadding }
enum | Tp::PropertyFlag { Tp::PropertyFlagRead, Tp::PropertyFlagWrite, Tp::_PropertyFlagPadding }
enum | Tp::StorageRestrictionFlag { Tp::StorageRestrictionFlagCannotSetParameters, Tp::StorageRestrictionFlagCannotSetEnabled, Tp::StorageRestrictionFlagCannotSetPresence, Tp::StorageRestrictionFlagCannotSetService, Tp::_StorageRestrictionFlagPadding }
enum | Tp::RTCPXRStatisticsFlag { Tp::RTCPXRStatisticsFlagLoss, Tp::RTCPXRStatisticsFlagDuplicate, Tp::RTCPXRStatisticsFlagJitter, Tp::RTCPXRStatisticsFlagTTL, Tp::RTCPXRStatisticsFlagHL, Tp::_RTCPXRStatisticsFlagPadding }

## Detailed Description

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

## Typedef Documentation

QFlags< ConnMgrParamFlag > Tp::ConnMgrParamFlags

Type representing combinations of ConnMgrParamFlag values.

QFlags< ConnectionAliasFlag > Tp::ConnectionAliasFlags

Type representing combinations of ConnectionAliasFlag values.

QFlags< AnonymityMode > Tp::AnonymityModeFlags

Type representing combinations of AnonymityMode values.

Flags for the various types of anonymity modes. These modes are solely to inform the CM of the desired anonymous settings. It is up to the CM to determine whether the anonymity modes should be handled within the CM itself, or whether the network that a CM might be talking to should be enforcing anonymity. CMs MAY support only a subset of these modes, and specific connections MAY support none at all.

QFlags< ConnectionCapabilityFlag > Tp::ConnectionCapabilityFlags

Type representing combinations of ConnectionCapabilityFlag values.

QFlags< ContactBlockingCapability > Tp::ContactBlockingCapabilities

Type representing combinations of ContactBlockingCapability values.

QFlags< ContactInfoFlag > Tp::ContactInfoFlags

Type representing combinations of ContactInfoFlag values.

Flags defining the behaviour of contact information on this protocol. Some protocols provide no information on contacts without an explicit request; others always push information to the connection manager as and when it changes.

QFlags< ContactInfoFieldFlag > Tp::ContactInfoFieldFlags

Type representing combinations of ContactInfoFieldFlag values.

Flags describing the behaviour of a vCard field.

QFlags< LocationFeature > Tp::LocationFeatures

Type representing combinations of LocationFeature values.

Flags describing the Location features which may be supported on any given connection.

QFlags< MailNotificationFlag > Tp::MailNotificationFlags

Type representing combinations of MailNotificationFlag values.

Flags representing capabilities provided by a connection manager. Those values can be used as bitfield. Some flags depend on, or conflict with, each other. Connections SHOULD implement as many of these features as the underlying protocol allows, preferring to implement Supports_Unread_Mails instead of Emits_Mails_Received if both are possible.

QFlags< CallFlag > Tp::CallFlags

Type representing combinations of CallFlag values.

A set of flags representing additional information than is available in CallState. Many of these flags only make sense in a particular (or may explain why a call is in a specific state).

QFlags< CallMemberFlag > Tp::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.

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.

QFlags< MediaStreamPending > Tp::MediaStreamPendingSend

Type representing combinations of MediaStreamPending values.

QFlags< ChannelMediaCapability > Tp::ChannelMediaCapabilities

Type representing combinations of ChannelMediaCapability values.

The channel-type-specific capability flags used for Channel.Type.StreamedMedia in the Connection.Interface.Capabilities interface. See the InitialAudio property for details of the mechanisms that will replace this.

QFlags< ChannelTextMessageFlag > Tp::ChannelTextMessageFlags

Type representing combinations of ChannelTextMessageFlag values.

QFlags< CaptchaFlag > Tp::CaptchaFlags

Type representing combinations of CaptchaFlag values.

Extra flags to include with Captcha information

QFlags< ChannelCallState > Tp::ChannelCallStateFlags

Type representing combinations of ChannelCallState values.

A set of flags representing call states.

QFlags< ChannelGroupFlag > Tp::ChannelGroupFlags

Type representing combinations of ChannelGroupFlag values.

QFlags< MessagePartSupportFlag > Tp::MessagePartSupportFlags

Type representing combinations of MessagePartSupportFlag values.

Flags indicating the level of support for message parts on this channel. They are designed such that setting more flags always implies that the channel has more capabilities.

If no flags are set, this indicates that messages may contain a single message part whose content-type is any of the types from SupportedContentTypes, possibly with some alternatives.

There is no flag indicating support for alternatives. This is because the SendMessage implementation can always accept messages containing alternatives, even if the underlying protocol does not, by deleting all alternatives except the first (most preferred) that is supported.

Each of the flags so far implies the previous flag, so we could have used a simple enumeration here; however, we've defined the message-part support indicator as a flag set for future expansion.

See SupportedContentTypes for some examples.

QFlags< MessageSendingFlag > Tp::MessageSendingFlags

Type representing combinations of MessageSendingFlag values.

Flags altering the way a message is sent. The "most usual" action should always be to have these flags unset. Some indication of which flags are supported is provided by the DeliveryReportingSupport property.

QFlags< DeliveryReportingSupportFlag > Tp::DeliveryReportingSupportFlags

Type representing combinations of DeliveryReportingSupportFlag values.

Flags indicating the level of support for delivery reporting on this channel, as found on the DeliveryReportingSupport property. Any future flags added to this set will conform to the convention that the presence of an extra flag implies that more operations will succeed. Note that CMs may always provide more reports than are requested in the Message_Sending_Flags passed to SendMessage. If senders want delivery reports, they should ask for them. If they don't want delivery reports, they can just ignore them, so there's no need to have capability discovery for what will happen if a delivery report isn't requested.

QFlags< ChannelPasswordFlag > Tp::ChannelPasswordFlags

Type representing combinations of ChannelPasswordFlag values.

QFlags< PropertyFlag > Tp::PropertyFlags

Type representing combinations of PropertyFlag values.

QFlags< StorageRestrictionFlag > Tp::StorageRestrictionFlags

Type representing combinations of StorageRestrictionFlag values.

Flags indicating restrictions imposed on an Account by its storage method.

QFlags< RTCPXRStatisticsFlag > Tp::RTCPXRStatisticsFlags

Type representing combinations of RTCPXRStatisticsFlag values.

## Enumeration Type Documentation

enum Tp::ConnMgrParamFlag

Flag type generated from the specification.

Enumerator
ConnMgrParamFlagRequired | This parameter is required for connecting to the server.
ConnMgrParamFlagRegister | This parameter is required for registering an account on the server.
ConnMgrParamFlagHasDefault | This parameter has a default value, which is returned in GetParameters; not providing this parameter is equivalent to providing the default.
ConnMgrParamFlagSecret | This parameter should be considered private or secret; for instance, clients should store it in a "password safe" like gnome-keyring or kwallet, omit it from debug logs, and use a text input widget that hides the value of the parameter. (Clients that support older connection managers may also treat any parameter whose name contains "password" as though it had this flag.)
ConnMgrParamFlagDBusProperty | This parameter is also a D-Bus property on the resulting ConnectionInterface ; a parameter named `com.example.Duck.Macaroni` with this flag corresponds to the `Macaroni` property on the `com.example.Duck` interface. Its value can be queried and possibly changed on an existing Connection using methods on the `org.freedesktop.DBus.Properties` interface. When a new value for a parameter with this flag is passed to AccountInterface::UpdateParameters() , the account manager will attempt to update its value on any running connections. Similarly, if the parameter also has the `Has_Default` flag, and is passed in the second argument to `UpdateParameters`, the default value will be applied to any running connections. Thus, clients generally do not need to directly access or update the connection property; instead, they SHOULD manipulate AccountInterface::Parameters . This allows runtime-configurable options to be stored and maintained by the AccountManagerInterface , without needing to invent a separate account preference for “properties that should be set on the connection as soon as it is created”. It was originally invented to manage ConnectionInterfaceCellularInterface preferences.
_ConnMgrParamFlagPadding |

enum Tp::ConnectionAliasFlag

Flag type generated from the specification.

Enumerator
ConnectionAliasFlagUserSet | The aliases of contacts on this connection may be changed by the user of the service, not just by the contacts themselves. This is the case on Jabber, for instance. It is possible that aliases can be changed by the contacts too - which alias takes precedence is not defined by this specification, and depends on the server and/or connection manager implementation. This flag only applies to the aliases of "globally valid" contact handles. At this time, clients should not expect to be able to change the aliases corresponding to any channel-specific handles. If this becomes possible in future, a new flag will be defined.
_ConnectionAliasFlagPadding |

enum Tp::AnonymityMode

Flag type generated from the specification.

Enumerator
AnonymityModeClientInfo | Obscure any information that provides user identification, user-agent identification or personal details. Examples of this information might be GSM CallerID, SIP from address, various informational email headers, etc. The CM should scrub/replace any of this information before passing messages or data onto the network. Note that a CM which has the option of obscuring the information at the CM or privacy service level would choose both (anonymity services are opaque to clients of this interface). Clients SHOULD NOT set both Client_Info and Show_Client_Info modes. If they are set, the CM MUST respect Client_Info and ignore Show_Client_Info.
AnonymityModeShowClientInfo | Explicitly request showing of client information. In connection context, this can be used to override service default. In channel context, this overrides connection anonymity modes. In GSM, it's possible to have CLIR enabled by default, and explicitly suppress CLIR for a single phone call. Clients SHOULD NOT set both Client_Info and Show_Client_Info modes. If they are set, the CM MUST respect Client_Info and ignore Show_Client_Info. The CM MAY set both Client_Info and Show_Client_Info in SupportedAnonymityModes to indicate its support for explicitly hiding and publicising client information.
AnonymityModeNetworkInfo | Obscure any originating IP address information, contact URIs, and anonymize all traffic involved with sending/receiving any media streams or call content. Examples of this include the "headers" portions of RFC 3323 as well as the History-Info (described in RFC 4244) for a SIP CM. This SHOULD have the effect of hiding address information from the remote contact (ie, the contact cannot know what IP address the session is originated from). Obviously the network still needs to be able to route information between contacts, so this provides no guarantees of what can be seen by intermediaries.
_AnonymityModePadding |

enum Tp::ConnectionCapabilityFlag

Flag type generated from the specification.

Enumerator
ConnectionCapabilityFlagCreate | The given channel type and handle can be given to RequestChannel to create a new channel of this type.
ConnectionCapabilityFlagInvite | The given contact can be invited to an existing channel of this type.
_ConnectionCapabilityFlagPadding |

enum Tp::ContactBlockingCapability

Flag type generated from the specification.

Enumerator
ContactBlockingCapabilityCanReportAbusive | When calling BlockContacts() , the contacts may be reporting as abusive to the server administrators by setting Report_Abusive to `True`.
_ContactBlockingCapabilityPadding |

enum Tp::ContactInfoFlag

Flag type generated from the specification.

Enumerator
ContactInfoFlagCanSet | Indicates that SetContactInfo is supported on this connection.
ContactInfoFlagPush | Indicates that the protocol pushes all contacts' information to the connection manager without prompting. If set, ContactInfoChanged will be emitted whenever contacts' information changes.
_ContactInfoFlagPadding |

enum Tp::ContactInfoFieldFlag

Flag type generated from the specification.

Enumerator
ContactInfoFieldFlagParametersExact | If present, exactly the parameters indicated must be set on this field; in the case of an empty list of parameters, this implies that parameters may not be used. If absent, and the list of allowed parameters is non-empty, any (possibly empty) subset of that list may be used. If absent, and the list of allowed parameters is empty, any parameters may be used.
ContactInfoFieldFlagOverwrittenByNickname | Indicates that this field will be overwritten when the user's alias is changed with ConnectionInterfaceAliasingInterface::SetAliases() or when the Account's AccountInterface::Nickname is updated. Clients that allow the editing of the Alias and the ContactInfo in the same location should hide fields with this flag. If a client allowed the user to edit both the nickname and the ContactInfo field at the same time, the user could set them to two different values even though they map to the same property. This would result in surprising behavior where the second value would win over the first. In addition to hiding this field when editing ContactInfo together with the user's nickname, it is recommended that clients call SetContactInfo() before setting the user's nickname. This ensures that if the user changes the nickname, the correct value will get set even if the stale nickname is mistakenly sent along with SetContactInfo() . If used, this flag typically appears on either the 'nickname' or 'fn' field.
_ContactInfoFieldFlagPadding |

enum Tp::LocationFeature

Flag type generated from the specification.

Enumerator
LocationFeatureCanSet | Indicates that setting your own location with SetLocation is supported on this connection.
_LocationFeaturePadding |

enum Tp::MailNotificationFlag

Flag type generated from the specification.

Enumerator
MailNotificationFlagSupportsUnreadMailCount | This Connection provides the number of unread e-mails (or e-mail threads) in the main folder of your e-mail account, as the UnreadMailCount property. The connection manager will update this value by emitting the UnreadMailsChanged signal.
MailNotificationFlagSupportsUnreadMails | This Connection provides a detailed list of unread e-mails, as the UnreadMails property. If this flag is set, Supports_Unread_Mail_Count MUST be set, and Emits_Mails_Received MUST NOT be set. The Connection will update the list by emitting the UnreadMailsChanged signals.
MailNotificationFlagEmitsMailsReceived | This Connection emits the MailsReceived signal, which provides details about newly arrived e-mails but does not maintain their read/unread status afterwards. This flag MUST NOT be combined with Supports_Unread_Mails.
MailNotificationFlagSupportsRequestInboxURL | This Connection can provide a URL (with optional POST data) to open the the inbox of the e-mail account in a web-based client, via the RequestInboxURL method.
MailNotificationFlagSupportsRequestMailURL | This Connection can provide a URL (with optional POST data) to open a specific mail in a web-based client, via the RequestMailURL() method. This feature is not useful unless either Emits_Mails_Received or Supports_Unread_Mails is set. If this flag is not set, clients SHOULD fall back to using RequestInboxURL() if available.
MailNotificationFlagThreadBased | Each Mail represents a thread of e-mails, which MAY have more than one sender. Google Talk notifies users about new mail in terms of unread threads, rather than unread e-mails.
_MailNotificationFlagPadding |

enum Tp::CallFlag

Flag type generated from the specification.

Enumerator
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. 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! This flag exists as a simplified proxy for HoldStateChanged, to reduce the number of signals that need to be listened to by a simple UI.
CallFlagLocallyRinging | This flag exists for observability of the SetRinging method (e.g. so that loggers can tell whether the call got as far as alerting the user, or whether something went wrong before then). It should be set when the SetRinging is called, and unset when the call leaves Initialised.
CallFlagLocallyQueued | This flag exists for observability of the SetQueued method. It should be set when the SetQueued is called, and unset when the call leaves Initialising or Initialised.
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. It SHOULD be set or unset according to informational messages from other contacts.
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.
_CallFlagPadding |

enum Tp::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. 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.
CallMemberFlagHeld | The call member has put this call on hold. 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.
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 |

enum Tp::MediaStreamPending

Flag type generated from the specification.

Enumerator
MediaStreamPendingLocalSend | The local user has been asked to send media by the remote user. Call RequestStreamDirection to indicate whether or not this is acceptable.
MediaStreamPendingRemoteSend | The remote user has been asked to send media by the local user. The StreamDirectionChanged signal will be emitted when the remote user accepts or rejects this change.
_MediaStreamPendingPadding |

enum Tp::ChannelMediaCapability

Flag type generated from the specification.

Enumerator
ChannelMediaCapabilityAudio | The handle is capable of using audio streams within a media channel.
ChannelMediaCapabilityVideo | The handle is capable of using video streams within a media channel.
ChannelMediaCapabilityNATTraversalSTUN | The handle is capable of performing STUN to traverse NATs.
ChannelMediaCapabilityNATTraversalGTalkP2P | The handle is capable of establishing Google Talk peer-to-peer connections (as implemented in libjingle 0.3) to traverse NATs.
ChannelMediaCapabilityNATTraversalICEUDP | The handle is capable of establishing ICE UDP peer-to-peer connections (as defined by the IETF MMUSIC working group) to traverse NATs.
ChannelMediaCapabilityImmutableStreams | Channels whose target handle is this contact will have ImmutableStreams = True.
_ChannelMediaCapabilityPadding |

enum Tp::ChannelTextMessageFlag

Flag type generated from the specification.

Enumerator
ChannelTextMessageFlagTruncated | The incoming message was truncated to a shorter length by the server or the connection manager.
ChannelTextMessageFlagNonTextContent | The incoming message contained non-text content which cannot be represented by this interface, but has been signalled in the ChannelInterfaceMessagesInterface interface. Connection managers SHOULD only set this flag if the non-text content appears to be relatively significant (exactly how significant is up to the implementor). The intention is that if this flag is set, clients using this interface SHOULD inform the user that part of the message was not understood.
ChannelTextMessageFlagScrollback | The incoming message was part of a replay of message history. In XMPP multi-user chat, a few past messages are replayed when you join a chatroom. A sufficiently capable IRC connection manager could also set this flag on historical messages when connected to a proxy like bip or irssi-proxy. The existence of this flag allows loggers and UIs to use better heuristics when eliminating duplicates (a simple implementation made possible by this flag would be to avoid logging scrollback at all).
ChannelTextMessageFlagRescued | The incoming message has been seen in a previous channel during the lifetime of the ConnectionInterface , but had not been acknowledged when that channel closed, causing an identical channel (the channel in which the message now appears) to open. This means that a logger (which should already have seen the message in the previous channel) is able to recognise and ignore these replayed messages.
_ChannelTextMessageFlagPadding |

enum Tp::CaptchaFlag

Flag type generated from the specification.

Enumerator
CaptchaFlagRequired | This captcha mechanism is required to be successfully answered in order to pass this captcha challenge.
_CaptchaFlagPadding |

enum Tp::ChannelCallState

Flag type generated from the specification.

Enumerator
ChannelCallStateRinging | The contact has been alerted about the call but has not responded (e.g. 180 Ringing in SIP).
ChannelCallStateQueued | 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).
ChannelCallStateHeld | The contact has placed the call on hold, and will not receive media from the local user or any other participants until they unhold the call again.
ChannelCallStateForwarded | 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.
ChannelCallStateInProgress | Progress has been made in placing the outgoing call, but the destination 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.
ChannelCallStateConferenceHost | 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.
_ChannelCallStatePadding |

enum Tp::ChannelGroupFlag

Flag type generated from the specification.

Enumerator
ChannelGroupFlagCanAdd | The AddMembers method can be used to add or invite members who are not already in the local pending list (which is always valid).
ChannelGroupFlagCanRemove | The RemoveMembers method can be used to remove channel members (removing those on the pending local list is always valid).
ChannelGroupFlagCanRescind | The RemoveMembers method can be used on people on the remote pending list.
ChannelGroupFlagMessageAdd | A message may be sent to the server when calling AddMembers on contacts who are not currently pending members.
ChannelGroupFlagMessageRemove | A message may be sent to the server when calling RemoveMembers on contacts who are currently channel members.
ChannelGroupFlagMessageAccept | A message may be sent to the server when calling AddMembers on contacts who are locally pending.
ChannelGroupFlagMessageReject | A message may be sent to the server when calling RemoveMembers on contacts who are locally pending.
ChannelGroupFlagMessageRescind | A message may be sent to the server when calling RemoveMembers on contacts who are remote pending.
ChannelGroupFlagChannelSpecificHandles | The members of this group have handles which are specific to this channel, and are not valid as general-purpose handles on the connection. Depending on the channel, it may be possible to check the HandleOwners property or call GetHandleOwners() to find the owners of these handles, which should be done if you wish to (e.g.) subscribe to the contact's presence. Connection managers must ensure that any given handle is not simultaneously a general-purpose handle and a channel-specific handle.
ChannelGroupFlagOnlyOneGroup | Placing a contact in multiple groups of this type is not allowed and will raise NotAvailable (on services where contacts may only be in one user-defined group, user-defined groups will have this flag).
ChannelGroupFlagHandleOwnersNotAvailable | In rooms with channel specific handles (ie Channel_Specific_Handles flag is set), this flag indicates that no handle owners are available, apart from the owner of the SelfHandle. This used to be an important optimization to avoid repeated GetHandleOwners calls, before we introduced the HandleOwners property and HandleOwnersChanged signal.
ChannelGroupFlagProperties | This flag indicates that all the properties introduced in specification 0.17.6 are fully supported.
ChannelGroupFlagMembersChangedDetailed | Indicates that MembersChangedDetailed will be emitted for changes to this group's members in addition to MembersChanged. Clients can then connect to the former and ignore emission of the latter. This flag's state MUST NOT change over the lifetime of a channel. If it were allowed to change, client bindings would have to always connect to MembersChanged just in case the flag ever went away (and generally be unnecessarily complicated), which would mostly negate the point of having this flag in the first place.
ChannelGroupFlagMessageDepart | A message may be sent to the server when calling RemoveMembers on the SelfHandle. This would be set for XMPP Multi-User Chat or IRC channels, but not for a typical implementation of streamed media calls.
_ChannelGroupFlagPadding |

enum Tp::MessagePartSupportFlag

Flag type generated from the specification.

Enumerator
MessagePartSupportFlagOneAttachment | SendMessage will accept messages containing a textual message body, plus a single attachment of any type listed in the SupportedContentTypes property. It does not make sense for this flag to be set if Message_Part_Support_Flag_Data_Only is not also set (because the connection manager can trivially provide an empty text part if necessary).
MessagePartSupportFlagMultipleAttachments | SendMessage will accept messages containing a textual message body, plus an arbitrary number of attachments of any type listed in the SupportedContentTypes property. It does not make sense for this flag to be set if Message_Part_Support_Flag_One_Attachment is not also set.
_MessagePartSupportFlagPadding |

enum Tp::MessageSendingFlag

Flag type generated from the specification.

Enumerator
MessageSendingFlagReportDelivery | Provide a successful delivery report if possible, even if this is not the default for this protocol. Ignored if delivery reports are not possible on this protocol. In some protocols, like XMPP, it is not conventional to request or send positive delivery notifications. Delivery failure reports SHOULD always be sent, but if this flag is present, the connection manager MAY also try harder to obtain failed delivery reports or allow them to be matched to outgoing messages.
MessageSendingFlagReportRead | Provide a delivery report when the message is read by the recipient, even if this is not the default for this protocol. Ignored if read reports are not possible on this protocol.
MessageSendingFlagReportDeleted | Provide a delivery report when the message is deleted by the recipient, even if this is not the default for this protocol. Ignored if such reports are not possible on this protocol.
_MessageSendingFlagPadding |

enum Tp::DeliveryReportingSupportFlag

Flag type generated from the specification.

Enumerator
DeliveryReportingSupportFlagReceiveFailures | Clients MAY expect to receive negative delivery reports if Message_Sending_Flag_Report_Delivery is specified when sending.
DeliveryReportingSupportFlagReceiveSuccesses | Clients MAY expect to receive positive delivery reports if Message_Sending_Flag_Report_Delivery is specified when sending.
DeliveryReportingSupportFlagReceiveRead | Clients MAY expect to receive Delivery_Status Read reports if Message_Sending_Flag_Report_Read is specified when sending.
DeliveryReportingSupportFlagReceiveDeleted | Clients MAY expect to receive Delivery_Status Deleted reports if Message_Sending_Flag_Report_Deleted is specified when sending.
_DeliveryReportingSupportFlagPadding |

enum Tp::ChannelPasswordFlag

Flag type generated from the specification.

Enumerator
ChannelPasswordFlagProvide | The ProvidePassword method must be called now for the user to join the channel
ChannelPasswordFlagHint | The RoomConfig1.PasswordHint contains a hint for the password.
_ChannelPasswordFlagPadding |

enum Tp::PropertyFlag

Flag type generated from the specification.

Enumerator
PropertyFlagRead | The property can be read
PropertyFlagWrite | The property can be written
_PropertyFlagPadding |

enum Tp::StorageRestrictionFlag

Flag type generated from the specification.

Enumerator
StorageRestrictionFlagCannotSetParameters | The account's Parameters property can't be changed by calling UpdateParameters.
StorageRestrictionFlagCannotSetEnabled | The account can't be enabled/disabled by setting the Enabled property.
StorageRestrictionFlagCannotSetPresence | The account's presence can't be changed by setting the RequestedPresence and AutomaticPresence properties.
StorageRestrictionFlagCannotSetService | The account's Service property cannot be changed.
_StorageRestrictionFlagPadding |

enum Tp::RTCPXRStatisticsFlag

Flag type generated from the specification.

Enumerator
RTCPXRStatisticsFlagLoss | Loss report flag, as defined in RFC3611 section 4.6.
RTCPXRStatisticsFlagDuplicate | Duplicate report flag, as defined in RFC3611 section 4.6.
RTCPXRStatisticsFlagJitter | Jitter flag, as defined in RFC3611 section 4.6.
RTCPXRStatisticsFlagTTL | First bit of TTL or Hop Limit flag, as defined in RFC3611 section 4.6.
RTCPXRStatisticsFlagHL | Second bit of TTL or Hop Limit flag, as defined in RFC3611 section 4.6.
_RTCPXRStatisticsFlagPadding |