ModemManager.Modem3gppUssd¶

Subclasses:: None

Methods¶

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

	`cancel` (cancellable, callback, *user_data)
	`cancel_finish` (res)
	`cancel_sync` (cancellable)
	`dup_network_notification` ()
	`dup_network_request` ()
	`dup_path` ()
	`get_network_notification` ()
	`get_network_request` ()
	`get_path` ()
	`get_state` ()
	`initiate` (command, cancellable, callback, *user_data)
	`initiate_finish` (res)
	`initiate_sync` (command, cancellable)
	`respond` (response, cancellable, callback, *user_data)
	`respond_finish` (res)
	`respond_sync` (response, cancellable)

Virtual Methods¶

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

Properties¶

Inherited:: Gio.DBusProxy (9), ModemManager.GdbusModem3gppUssd (3)

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent	`ModemManager.GdbusModem3gppUssdProxy`	r
unused	`object`	r

Class Details¶

class ModemManager.Modem3gppUssd(**kwargs)¶

Bases:: ModemManager.GdbusModem3gppUssdProxy
Abstract:: No
Structure:: ModemManager.Modem3gppUssdClass

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

cancel(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 cancels an ongoing USSD session, either mobile or network initiated.

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.Modem3gppUssd.cancel_finish() to get the result of the operation.

See ModemManager.Modem3gppUssd.cancel_sync() for the synchronous, blocking version of this method.

New in version 1.0.

cancel_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gppUssd.cancel().
Raises:: GLib.Error
Returns:: True if the session was successfully cancelled, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Modem3gppUssd.cancel().

New in version 1.0.

cancel_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the session was successfully cancelled, False if error is set.
Return type:: bool

Synchronously cancels an ongoing USSD session, either mobile or network initiated.

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

New in version 1.0.

dup_network_notification()¶

Returns:: The network notification, or None if none available. The returned value should be freed with GLib.free().
Return type:: str

Gets a copy of any pending network-initiated request to which no USSD response is required.

New in version 1.0.

dup_network_request()¶

Returns:: The network request, or None if none available. The returned value should be freed with GLib.free().
Return type:: str

Gets a copy of any pending network-initiated request.

New in version 1.0.

dup_path()¶

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

Gets a copy of the DBus path of the ModemManager.Object object which implements this interface.

New in version 1.0.

get_network_notification()¶

Returns:: The network notification, or None if none available.
Return type:: str

Gets any pending network-initiated request to which no USSD response is required.

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.Modem3gppUssd.dup_network_notification() if on another thread.

New in version 1.0.

get_network_request()¶

Returns:: The network request, or None if none available.
Return type:: str

Gets any pending network-initiated request.

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.Modem3gppUssd.dup_network_request() if on another thread.

New in version 1.0.

get_path()¶

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

Gets the DBus path of the ModemManager.Object which implements this interface.

New in version 1.0.

get_state()¶

Returns:: A ModemManager.Modem3gppUssdSessionState value, specifying the current state.
Return type:: ModemManager.Modem3gppUssdSessionState

Get the state of the ongoing USSD session, if any.

New in version 1.0.

initiate(command, cancellable, callback, *user_data)¶

Parameters:

command (str) – The command to start the USSD session with.
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 sends a USSD command string to the network initiating a USSD session.

When the request is handled by the network, the method returns the response or an appropriate error. The network may be awaiting further response from the ME after returning from this method and no new command.

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.Modem3gppUssd.initiate_finish() to get the result of the operation.

See ModemManager.Modem3gppUssd.initiate_sync() for the synchronous, blocking version of this method.

New in version 1.0.

initiate_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gppUssd.initiate().
Raises:: GLib.Error
Returns:: The response from the network, if any. The returned value should be freed with GLib.free().
Return type:: str

Finishes an operation started with ModemManager.Modem3gppUssd.initiate().

New in version 1.0.

initiate_sync(command, cancellable)¶

Parameters:

command (str) – The command to start the USSD session with.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The response from the network, if any. The returned value should be freed with GLib.free().

Return type:

str

Synchronously sends a USSD command string to the network initiating a USSD session.

When the request is handled by the network, the method returns the response or an appropriate error. The network may be awaiting further response from the ME after returning from this method and no new command.

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

New in version 1.0.

respond(response, cancellable, callback, *user_data)¶

Parameters:

response (str) – The response to network-initiated USSD command, or a response to a request for further input.
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 responds to a USSD request that is either initiated by the mobile network, or that is awaiting further input after a previous call to ModemManager.Modem3gppUssd.initiate().

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.Modem3gppUssd.respond_finish() to get the result of the operation.

See ModemManager.Modem3gppUssd.respond_sync() for the synchronous, blocking version of this method.

New in version 1.0.

respond_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Modem3gppUssd.respond().
Raises:: GLib.Error
Returns:: The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with GLib.free().
Return type:: str

Finishes an operation started with ModemManager.Modem3gppUssd.respond().

New in version 1.0.

respond_sync(response, cancellable)¶

Parameters:

response (str) – The response to network-initiated USSD command, or a response to a request for further input.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The network reply to this response to the network-initiated USSD command. The reply may require further responses. The returned value should be freed with GLib.free().

Return type:

str

Synchronously responds to a USSD request that is either initiated by the mobile network, or that is awaiting further input after a previous call to ModemManager.Modem3gppUssd.initiate().

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

New in version 1.0.