Home · All Classes · All Namespaces · Modules · Functions · Files
Tpy::Client::ChannelTypeCallInterface

Tpy::Client::ChannelTypeCallInterface Class Reference

#include <TelepathyQt4Yell/Channel>

List of all members.

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Call.DRAFT."

Constructor & Destructor Documentation

Tpy::Client::ChannelTypeCallInterface::ChannelTypeCallInterface ( const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ChannelTypeCallInterface associated with the given object on the session bus.

Parameters:
busName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.
Tpy::Client::ChannelTypeCallInterface::ChannelTypeCallInterface ( const QDBusConnection &  connection,
const QString &  busName,
const QString &  objectPath,
QObject *  parent = 0 
)

Creates a ChannelTypeCallInterface associated with the given object on the given bus.

Parameters:
connection The bus via which the object can be reached.
busName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.
Tpy::Client::ChannelTypeCallInterface::ChannelTypeCallInterface ( Tp::DBusProxy *  proxy  ) 

Creates a ChannelTypeCallInterface associated with the same object as the given proxy.

Parameters:
proxy The proxy to use. It will also be the QObject::parent() for this object.
Tpy::Client::ChannelTypeCallInterface::ChannelTypeCallInterface ( const Tp::Client::ChannelInterface &  mainInterface  )  [explicit]

Creates a ChannelTypeCallInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.

Parameters:
mainInterface The proxy to use.
Tpy::Client::ChannelTypeCallInterface::ChannelTypeCallInterface ( const Tp::Client::ChannelInterface &  mainInterface,
QObject *  parent 
)

Creates a ChannelTypeCallInterface associated with the same object as the given proxy. However, a different parent object can be specified.

Parameters:
mainInterface The proxy to use.
parent Passed to the parent class constructor.

Member Function Documentation

static QLatin1String Tpy::Client::ChannelTypeCallInterface::staticInterfaceName (  )  [inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.Call.DRAFT", which this class represents.

Returns:
The D-Bus interface name.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyContents (  )  const [inline]

Asynchronous getter for the remote object property "Contents" of type Tpy::ObjectPathList.

The list of <tp:dbus-ref namespace="ofdT.Call">Content.DRAFT</tp:dbus-ref> objects that are part of this call. Change notification is via the <tp:member-ref>ContentAdded</tp:member-ref> and <tp:member-ref>ContentRemoved</tp:member-ref> signals.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyCallStateDetails (  )  const [inline]

Asynchronous getter for the remote object property "CallStateDetails" of type QVariantMap.

A map used to provide optional extensible details for the <tp:member-ref>CallState</tp:member-ref>, <tp:member-ref>CallFlags</tp:member-ref> and/or <tp:member-ref>CallStateReason</tp:member-ref>.

Well-known keys and their corresponding value types include:

hangup-message - s

An optional human-readable message sent when the call was ended, corresponding to the Message argument to the <tp:member-ref>Hangup</tp:member-ref> method. This is only applicable when the call state is <tp:type>Call_State</tp:type>_Ended. <tp:rationale> XMPP Jingle can send such messages. </tp:rationale>

queue-message - s

An optional human-readable message sent when the local contact is being held in a queue. This is only applicable when <tp:type>Call_Flags</tp:type>_Queued is in the call flags. <tp:rationale> SIP 182 notifications can have human-readable messages attached. </tp:rationale>

debug-message - s
A message giving further details of any error indicated by the <tp:member-ref>CallStateReason</tp:member-ref>. This will not normally be localized or suitable for display to users, and is only applicable when the call state is <tp:type>Call_State</tp:type>_Ended.
Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyCallState (  )  const [inline]

Asynchronous getter for the remote object property "CallState" of type uint.

The current high-level state of this call. The <tp:member-ref>CallFlags</tp:member-ref> provide additional information, and the <tp:member-ref>CallStateReason</tp:member-ref> and <tp:member-ref>CallStateDetails</tp:member-ref> explain the reason for the current values for those properties.

Note that when in a conference call, this property is purely to show your state in joining the call. The receiver (or remote contact) in this context is the conference server itself. The property does not change when other call members' states change.

Clients MAY consider unknown values in this property to be an error.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyCallFlags (  )  const [inline]

Asynchronous getter for the remote object property "CallFlags" of type uint.

Flags representing the status of the call as a whole, providing more specific information than the <tp:member-ref>CallState</tp:member-ref>.

Clients are expected to ignore unknown flags in this property, without error.

When an ongoing call is active and not on hold or has any other problems, this property will be 0.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyCallStateReason (  )  const [inline]

Asynchronous getter for the remote object property "CallStateReason" of type Tpy::CallStateReason.

The reason for the last change to the <tp:member-ref>CallState</tp:member-ref> and/or <tp:member-ref>CallFlags</tp:member-ref>. The <tp:member-ref>CallStateDetails</tp:member-ref> MAY provide additional information.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyHardwareStreaming (  )  const [inline]

Asynchronous getter for the remote object property "HardwareStreaming" of type bool.

If this property is True, all of the media streaming is done by some mechanism outside the scope of Telepathy.

<tp:rationale>

A connection manager might be intended for a specialized hardware device, which will take care of the audio streaming (e.g. telepathy-yafono, which uses GSM hardware which does the actual audio streaming for the call). </tp:rationale>

If this is False, the handler is responsible for doing the actual media streaming for at least some contents itself. Those contents will have the <tp:dbus-ref namespace="ofdT.Call.Content.Interface">Media.DRAFT</tp:dbus-ref> interface, to communicate the necessary information to a streaming implementation. Connection managers SHOULD operate like this, if possible.

<tp:rationale>

Many connection managers (such as telepathy-gabble) only do the call signalling, and expect the client to do the actual streaming using something like Farsight, to improve latency and allow better UI integration. </tp:rationale>

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyCallMembers (  )  const [inline]

Asynchronous getter for the remote object property "CallMembers" of type Tpy::CallMemberMap.

A mapping from the remote contacts that are part of this call to flags describing their status. This mapping never has the local user's handle as a key.

When the call ends, this property should be an empty list, and notified with <tp:member-ref>CallMembersChanged</tp:member-ref>

If the Call implements <tp:dbus-ref namespace="ofdT.Channel.Interface">Group</tp:dbus-ref> and the Group members are channel-specific handles, then this call SHOULD also use channel-specific handles.

Anonymous members are exposed as channel-specific handles with no owner.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyInitialTransport (  )  const [inline]

Asynchronous getter for the remote object property "InitialTransport" of type uint.

If set on a requested channel, this indicates the transport that should be used for this call. Where not applicable, this property is defined to be <tp:type>Stream_Transport_Type</tp:type>_Unknown, in particular, on CMs with hardware streaming.

<tp:rationale> When implementing a voip gateway one wants the outgoing leg of the gatewayed to have the same transport as the incoming leg. This property allows the gateway to request a Call with the right transport from the CM. </tp:rationale>

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyInitialAudio (  )  const [inline]

Asynchronous getter for the remote object property "InitialAudio" of type bool.

If set to True in a channel request that will create a new channel, the connection manager should immediately attempt to establish an audio stream to the remote contact, making it unnecessary for the client to call <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">AddContent</tp:dbus-ref>.

If this property, or InitialVideo, is passed to EnsureChannel (as opposed to CreateChannel), the connection manager SHOULD ignore these properties when checking whether it can return an existing channel as suitable; these properties only become significant when the connection manager has decided to create a new channel.

If True on a requested channel, this indicates that the audio stream has already been requested and the client does not need to call RequestStreams, although it MAY still do so.

If True on an unrequested (incoming) channel, this indicates that the remote contact initially requested an audio stream; this does not imply that that audio stream is still active (as indicated by <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">Contents</tp:dbus-ref>).

The name of this new content can be decided by using the <tp:member-ref>InitialAudioName</tp:member-ref> property.

Connection managers that support the <tp:dbus-ref namespace="ofdT.Connection.Interface">ContactCapabilities</tp:dbus-ref> interface SHOULD represent the capabilities of receiving audio and/or video calls by including a channel class in a contact's capabilities with ChannelType = Call in the fixed properties dictionary, and InitialAudio and/or InitialVideo in the allowed properties list. Clients wishing to discover whether a particular contact is likely to be able to receive audio and/or video calls SHOULD use this information.

<tp:rationale>

Not all clients support video calls, and it would also be possible (although unlikely) to have a client which could only stream video, not audio. </tp:rationale>

Clients that are willing to receive audio and/or video calls SHOULD include the following among their channel classes if calling <tp:dbus-ref namespace="ofdT.Connection.Interface.ContactCapabilities">UpdateCapabilities</tp:dbus-ref> (clients of a <tp:dbus-ref namespace="org.freedesktop.Telepathy">ChannelDispatcher</tp:dbus-ref> SHOULD instead arrange for the ChannelDispatcher to do this, by including the filters in their <tp:dbus-ref namespace="ofdT.Client.Handler">HandlerChannelFilter</tp:dbus-ref> properties):

  • { ChannelType = Call }
  • { ChannelType = Call, InitialAudio = True } if receiving calls with audio is supported
  • { ChannelType = Call, InitialVideo = True } if receiving calls with video is supported

<tp:rationale>

Connection managers for protocols with capability discovery, like XMPP, need this information to advertise the appropriate capabilities for their protocol. </tp:rationale>

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyInitialVideo (  )  const [inline]

Asynchronous getter for the remote object property "InitialVideo" of type bool.

The same as <tp:member-ref>InitialAudio</tp:member-ref>, but for a video stream. This property is immutable (cannot change).

In particular, note that if this property is False, this does not imply that an active video stream has not been added, only that no video stream was active at the time the channel appeared.

This property is the correct way to discover whether connection managers, contacts etc. support video calls; it appears in capabilities structures in the same way as InitialAudio.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyInitialAudioName (  )  const [inline]

Asynchronous getter for the remote object property "InitialAudioName" of type QString.

If <tp:member-ref>InitialAudio</tp:member-ref> is set to True, then this property will name the intial audio content with the value of this property.

<tp:rationale>

Content names are meant to be significant, but if no name can be given to initial audio content, then its name cannot be meaningful or even localized. </tp:rationale>

If this property is empty or missing from the channel request and InitialAudio is True, then the CM must come up with a sensible for the content, such as "audio".

If the protocol has no concept of stream names then this property will not show up in the allowed properties list of the Requestable Channel Classes for call channels.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyInitialVideoName (  )  const [inline]

Asynchronous getter for the remote object property "InitialVideoName" of type QString.

The same as <tp:member-ref>InitialAudioName</tp:member-ref>, but for a video stream created by setting <tp:member-ref>InitialVideo</tp:member-ref> to True. This property is immutable and so cannot change.

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariant* Tpy::Client::ChannelTypeCallInterface::requestPropertyMutableContents (  )  const [inline]

Asynchronous getter for the remote object property "MutableContents" of type bool.

If True, a stream of a different content type can be added after the Channel has been requested

If this property is missing, clients SHOULD assume that it is False, and thus that the channel's streams cannot be changed once the call has started.

If this property isn't present in the "allowed" set in any of the Call entries contact capabilities, then user interfaces MAY choose to show a separate "call" option for each class of call.

<tp:rationale>

For example, once an audio-only Google Talk call has started, it is not possible to add a video stream; both audio and video must be requested at the start of the call if video is desired. User interfaces may use this pseudo-capability as a hint to display separate "Audio call" and "Video call" buttons, rather than a single "Call" button with the option to add and remove video once the call has started for contacts without this flag. </tp:rationale>

Returns:
A pending variant which will emit finished when the property has been retrieved.
Tp::PendingVariantMap* Tpy::Client::ChannelTypeCallInterface::requestAllProperties (  )  const [inline]

Request all of the DBus properties on the interface.

Returns:
A pending variant map which will emit finished when the properties have been retrieved.
QDBusPendingReply Tpy::Client::ChannelTypeCallInterface::SetRinging ( int  timeout = -1  )  [inline, slot]

Begins a call to the D-Bus method "SetRinging" on the remote object.

Indicate that the local user has been alerted about the incoming call.

This method is only useful if the channel's <tp:dbus-ref namespace="ofdT.Channel">Requested</tp:dbus-ref> property is False, and the <tp:member-ref>CallState</tp:member-ref> is <tp:type>Call_State</tp:type>_Pending_Receiver (an incoming call waiting on the local user to pick up). While this is the case, this method SHOULD change the <tp:member-ref>CallFlags</tp:member-ref> to include <tp:type>Call_Flags</tp:type>_Locally_Ringing, and notify the remote contact that the local user has been alerted (if the protocol implements this); repeated calls to this method SHOULD succeed, but have no further effect.

In all other states, this method SHOULD fail with the error NotAvailable.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
timeout The timeout in milliseconds.
QDBusPendingReply Tpy::Client::ChannelTypeCallInterface::Accept ( int  timeout = -1  )  [inline, slot]

Begins a call to the D-Bus method "Accept" on the remote object.

For incoming calls in state <tp:type>Call_State</tp:type>_Pending_Receiver, accept the incoming call; this changes the <tp:member-ref>CallState</tp:member-ref> to <tp:type>Call_State</tp:type>_Accepted.

For outgoing calls in state <tp:type>Call_State</tp:type>_Pending_Initiator, actually call the remote contact; this changes the <tp:member-ref>CallState</tp:member-ref> to <tp:type>Call_State</tp:type>_Pending_Receiver.

Otherwise, this method SHOULD fail with the error NotAvailable.

This method should be called exactly once per Call, by whatever client (user interface) is handling the channel.

When this method is called, for each <tp:dbus-ref namespace="ofdT.Call">Content.DRAFT</tp:dbus-ref> whose <tp:dbus-ref namespace="ofdT.Call.Content.DRAFT">Disposition</tp:dbus-ref> is <tp:type>Call_Content_Disposition</tp:type>_Initial, any streams where the <tp:dbus-ref namespace="ofdT.Call.Stream.DRAFT">LocalSendingState</tp:dbus-ref> is <tp:type>Sending_State</tp:type>_Pending_Send will be moved to <tp:type>Sending_State</tp:type>_Sending as if <tp:dbus-ref namespace="ofdT.Call.Stream.DRAFT">SetSending</tp:dbus-ref>(True) had been called.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
timeout The timeout in milliseconds.
QDBusPendingReply Tpy::Client::ChannelTypeCallInterface::Hangup ( uint  reason,
const QString &  detailedHangupReason,
const QString &  message,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method "Hangup" on the remote object.

Request that the call is ended. All contents will be removed from the Call so that the Contents property will be the empty list.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
reason A generic hangup reason.
detailedHangupReason A more specific reason for the call hangup, if one is available, or an empty string otherwise.
message A human-readable message to be sent to the remote contact(s). XMPP Jingle allows calls to be terminated with a human-readable message.
timeout The timeout in milliseconds.
QDBusPendingReply<QDBusObjectPath> Tpy::Client::ChannelTypeCallInterface::AddContent ( const QString &  contentName,
uint  contentType,
int  timeout = -1 
) [inline, slot]

Begins a call to the D-Bus method "AddContent" on the remote object.

Request that a new Content.DRAFT of type Content_Type is added to the Call. Handlers should check the value of the MutableContents property before trying to add another content as it might not be allowed.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:
contentName The suggested name of the content to add. The content name property should be meaningful, so should be given a name which is significant to the user. The name could be a localized "audio", "video" or perhaps include some string identifying the source, such as a webcam identifier. If there is already a content with the same name as this property then a sensible suffix should be added. For example, if this argument is "audio" but a content of the same name already exists, a sensible suffix such as " (1)" is appended to name the new content "audio (1)". A further content with the name "audio" would then be named "audio (2)".
contentType The media stream type of the content to be added to the call.
timeout The timeout in milliseconds.
Returns:

Path to the newly-created Call.Content.DRAFT object.

void Tpy::Client::ChannelTypeCallInterface::ContentAdded ( const QDBusObjectPath &  content  )  [signal]

Represents the signal "ContentAdded" on the remote object.

Emitted when a new <tp:dbus-ref namespace="ofdT.Call">Content.DRAFT</tp:dbus-ref> is added to the call.

Parameters:
content Path to the newly-created Content.DRAFT object.
void Tpy::Client::ChannelTypeCallInterface::ContentRemoved ( const QDBusObjectPath &  content  )  [signal]

Represents the signal "ContentRemoved" on the remote object.

Emitted when a <tp:dbus-ref namespace="ofdT.Call">Content.DRAFT</tp:dbus-ref> is removed from the call.

Parameters:
content The Content.DRAFT which was removed.
void Tpy::Client::ChannelTypeCallInterface::CallStateChanged ( uint  callState,
uint  callFlags,
const Tpy::CallStateReason &  callStateReason,
const QVariantMap &  callStateDetails 
) [signal]

Represents the signal "CallStateChanged" on the remote object.

Emitted when the state of the call as a whole changes.

This signal is emitted for any change in the properties corresponding to its arguments, even if the other properties referenced remain unchanged.

Parameters:
callState The new value of the CallState property.
callFlags The new value of the CallFlags property.
callStateReason The new value of the CallStateReason property.
callStateDetails The new value of the CallStateDetails property.
void Tpy::Client::ChannelTypeCallInterface::CallMembersChanged ( const Tpy::CallMemberMap &  flagsChanged,
const Tpy::UIntList &  removed 
) [signal]

Represents the signal "CallMembersChanged" on the remote object.

Emitted when the CallMembers property changes in any way, either because contacts have been added to the call, contacts have been removed from the call, or contacts' flags have changed.

Parameters:
flagsChanged A map from members of the call to their new call member flags, including at least the members who have been added to CallMembers, and the members whose flags have changed.
removed A list of members who have left the call, i.e. keys to be removed from CallMembers.
void Tpy::Client::ChannelTypeCallInterface::invalidate ( Tp::DBusProxy *  proxy,
const QString &  error,
const QString &  message 
) [protected, virtual]

Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4-Yell 0.1.6