ModemManager.Call¶

Subclasses:	None

Methods¶

Inherited:	Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2)
Structs:	GObject.ObjectClass (5)

	`accept` (cancellable, callback, *user_data)
	`accept_finish` (res)
	`accept_sync` (cancellable)
	`deflect` (number, cancellable, callback, *user_data)
	`deflect_finish` (res)
	`deflect_sync` (number, cancellable)
	`dup_audio_port` ()
	`dup_number` ()
	`dup_path` ()
	`get_audio_format` ()
	`get_audio_port` ()
	`get_direction` ()
	`get_multiparty` ()
	`get_number` ()
	`get_path` ()
	`get_state` ()
	`get_state_reason` ()
	`hangup` (cancellable, callback, *user_data)
	`hangup_finish` (res)
	`hangup_sync` (cancellable)
	`join_multiparty` (cancellable, callback, *user_data)
	`join_multiparty_finish` (res)
	`join_multiparty_sync` (cancellable)
	`leave_multiparty` (cancellable, callback, *user_data)
	`leave_multiparty_finish` (res)
	`leave_multiparty_sync` (cancellable)
	`peek_audio_format` ()
	`send_dtmf` (dtmf, cancellable, callback, *user_data)
	`send_dtmf_finish` (res)
	`send_dtmf_sync` (dtmf, cancellable)
	`start` (cancellable, callback, *user_data)
	`start_finish` (res)
	`start_sync` (cancellable)

Virtual Methods¶

Inherited:	Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1)

Properties¶

Inherited:	Gio.DBusProxy (9)

Signals¶

Inherited:	Gio.DBusProxy (2), GObject.Object (1)

Fields¶

Inherited:	Gio.DBusProxy (2), GObject.Object (1)

Name	Type	Access	Description
parent	`object`	r

Class Details¶

class ModemManager.Call(**kwargs)¶

Bases:	`Gio.DBusProxy`
Abstract:	No
Structure:	`ModemManager.CallClass`

The ModemManager.Call structure contains private data and should only be accessed using the provided API.

accept(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously requests to accept the incoming call.

Call objects can only be executed once.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.accept_finish() to get the result of the operation.

See ModemManager.Call.accept_sync() for the synchronous, blocking version of this method.

New in version 1.6.

accept_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.accept`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.accept().

New in version 1.6.

accept_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to accept the incoming call.

Call objects can only be sent once.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.accept() for the asynchronous version of this method.

New in version 1.6.

deflect(number, cancellable, callback, *user_data)¶

Parameters:	number (`str`) – new number where the call will be deflected. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously requests to deflect the incoming call.

This call will be considered terminated once the deflection is performed.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.deflect_finish() to get the result of the operation.

See ModemManager.Call.deflect_sync() for the synchronous, blocking version of this method.

New in version 1.12.

deflect_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.deflect`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.deflect().

New in version 1.12.

deflect_sync(number, cancellable)¶

Parameters:	number (`str`) – new number where the call will be deflected. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to deflect the incoming call.

This call will be considered terminated once the deflection is performed.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.deflect() for the asynchronous version of this method.

New in version 1.12.

dup_audio_port()¶

Returns:	The audio port, or `None` if call audio is not routed via the host or couldn’t be retrieved.
Return type:	`str`

Gets the kernel device used for audio (if any).

New in version 1.10.

dup_number()¶

Returns:	The number, or `None` if it couldn’t be retrieved. The returned value should be freed with `GLib.free`().
Return type:	`str`

Gets the call number. In outgoing calls contains the dialing number or the remote number in incoming calls

New in version 1.6.

dup_path()¶

Returns:	The DBus path of the `ModemManager.Call` object. The returned value should be freed with `GLib.free`().
Return type:	`str`

Gets a copy of the DBus path of the ModemManager.Call object.

New in version 1.6.

get_audio_format()¶

Returns:	A `ModemManager.CallAudioFormat` that must be freed with `GObject.Object.unref`() or `None` if unknown.
Return type:	`ModemManager.CallAudioFormat`

Gets a ModemManager.CallAudioFormat object specifying the audio format used by the audio port if call audio is routed via the host.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.Call.get_audio_format() again to get a new ModemManager.CallAudioFormat with the new values.

New in version 1.10.

get_audio_port()¶

Returns:	The audio port, or `None` if call audio is not routed via the host or couldn’t be retrieved.
Return type:	`str`

Gets the kernel device used for audio (if any).

New in version 1.10.

get_direction()¶

Returns:	a `ModemManager.CallDirection`.
Return type:	`ModemManager.CallDirection`

Gets the call direction.

New in version 1.6.

get_multiparty()¶

Returns:	`True` if the call is part of a multiparty call, `False` otherwise.
Return type:	`bool`

Gets whether the call is part of a multiparty call.

New in version 1.12.

get_number()¶

Returns:	The number, or `None` if it couldn’t be retrieved.
Return type:	`str`

Gets the call number. In outgoing calls contains the dialing number or the remote number in incoming calls

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Call.dup_number() if on another thread.

New in version 1.6.

get_path()¶

Returns:	The DBus path of the `ModemManager.Call` object.
Return type:	`str`

Gets the DBus path of the ModemManager.Call object.

New in version 1.6.

get_state()¶

Returns:	a `ModemManager.CallState`.
Return type:	`ModemManager.CallState`

Gets the current state of call.

New in version 1.6.

get_state_reason()¶

Returns:	a `ModemManager.CallStateReason`.
Return type:	`ModemManager.CallStateReason`

Gets the reason of why the call changes its state.

New in version 1.6.

hangup(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously requests to hangup the call.

Call objects can only be executed once.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.hangup_finish() to get the result of the operation.

See ModemManager.Call.hangup_sync() for the synchronous, blocking version of this method.

New in version 1.6.

hangup_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.hangup`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.hangup().

New in version 1.6.

hangup_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to hangup the call.

Call objects can only be sent once.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.hangup() for the asynchronous version of this method.

New in version 1.6.

join_multiparty(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Synchronously requests to join this call into a multiparty call.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.join_multiparty_finish() to get the result of the operation.

See ModemManager.Call.join_multiparty_sync() for the synchronous, blocking version of this method.

New in version 1.12.

join_multiparty_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.join_multiparty`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.join_multiparty().

New in version 1.12.

join_multiparty_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to join this call into a multiparty call.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.join_multiparty() for the asynchronous version of this method.

New in version 1.12.

leave_multiparty(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Synchronously requests to make this call private again by leaving the multiparty call.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.leave_multiparty_finish() to get the result of the operation.

See ModemManager.Call.leave_multiparty_sync() for the synchronous, blocking version of this method.

New in version 1.12.

leave_multiparty_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.leave_multiparty`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.leave_multiparty().

New in version 1.12.

leave_multiparty_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to make this call private again by leaving the multiparty call.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.leave_multiparty() for the asynchronous version of this method.

New in version 1.12.

peek_audio_format()¶

Returns:	A `ModemManager.CallAudioFormat`. Do not free the returned value, it belongs to self.
Return type:	`ModemManager.CallAudioFormat`

Gets a ModemManager.CallAudioFormat object specifying the audio format used by the audio port if call audio is routed via the host.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.Call.get_audio_format() if on another thread.

New in version 1.10.

send_dtmf(dtmf, cancellable, callback, *user_data)¶

Parameters:	dtmf (`str`) – the DMTF tone. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously requests to send a DTMF tone the call.

Call objects can only be executed once.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.send_dtmf_finish() to get the result of the operation.

See ModemManager.Call.send_dtmf_sync() for the synchronous, blocking version of this method.

New in version 1.6.

send_dtmf_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.send_dtmf`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.send_dtmf().

New in version 1.6.

send_dtmf_sync(dtmf, cancellable)¶

Parameters:	dtmf (`str`) – the DMTF tone. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to send a DTMF tone the call.

Call objects can only be sent once.

The calling thread is blocked until an incoming call is ready. See ModemManager.Call.send_dtmf() for the asynchronous version of this method.

New in version 1.6.

start(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously requests to queue the call.

Call objects can only be executed once.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.Call.start_finish() to get the result of the operation.

See ModemManager.Call.start_sync() for the synchronous, blocking version of this method.

New in version 1.6.

start_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.Call.start`().
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.Call.start().

New in version 1.6.

start_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the operation succeeded, `False` if error is set.
Return type:	`bool`

Synchronously requests to queue the call for delivery.

Call objects can only be sent once.

The calling thread is blocked until a reply is received. See ModemManager.Call.start() for the asynchronous version of this method.

New in version 1.6.