Qmi.ClientWms¶

Subclasses:: None

Methods¶

Inherited:: Qmi.Client (8), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`delete` (input, timeout, cancellable, callback, *user_data)
	`delete_finish` (res)
	`get_message_protocol` (unused, timeout, cancellable, callback, *user_data)
	`get_message_protocol_finish` (res)
	`get_routes` (unused, timeout, cancellable, callback, *user_data)
	`get_routes_finish` (res)
	`get_supported_messages` (unused, timeout, cancellable, callback, *user_data)
	`get_supported_messages_finish` (res)
	`list_messages` (input, timeout, cancellable, callback, *user_data)
	`list_messages_finish` (res)
	`modify_tag` (input, timeout, cancellable, callback, *user_data)
	`modify_tag_finish` (res)
	`raw_read` (input, timeout, cancellable, callback, *user_data)
	`raw_read_finish` (res)
	`raw_send` (input, timeout, cancellable, callback, *user_data)
	`raw_send_finish` (res)
	`raw_write` (input, timeout, cancellable, callback, *user_data)
	`raw_write_finish` (res)
	`reset` (unused, timeout, cancellable, callback, *user_data)
	`reset_finish` (res)
	`send_ack` (input, timeout, cancellable, callback, *user_data)
	`send_ack_finish` (res)
	`send_from_memory_storage` (input, timeout, cancellable, callback, *user_data)
	`send_from_memory_storage_finish` (res)
	`set_event_report` (input, timeout, cancellable, callback, *user_data)
	`set_event_report_finish` (res)
	`set_routes` (input, timeout, cancellable, callback, *user_data)
	`set_routes_finish` (res)

Virtual Methods¶

Inherited:: Qmi.Client (1), GObject.Object (7)

Properties¶

Inherited:: Qmi.Client (6)

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`event-report`	The `::event-report` signal gets emitted when a ‘’Event Report [libqmi-glib-WMS-Event-Report-indication.top_of_page]’’ indication is received.
`smsc-address`	The `::smsc-address` signal gets emitted when a ‘’SMSC Address [libqmi-glib-WMS-SMSC-Address-indication.top_of_page]’’ indication is received.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`Qmi.Client`	r
priv_unused	`object`	r

Class Details¶

class Qmi.ClientWms(**kwargs)¶

Bases:: Qmi.Client
Abstract:: No
Structure:: Qmi.ClientWmsClass

The Qmi.ClientWms structure contains private data and should only be accessed using the provided API.

New in version 1.0.

delete(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsDeleteInput) – a Qmi.MessageWmsDeleteInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Delete request to the device.

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 Qmi.ClientWms.delete_finish() to get the result of the operation.

New in version 1.0.

delete_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.delete().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsDeleteOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsDeleteOutput.unref().
Return type:: Qmi.MessageWmsDeleteOutput

Finishes an async operation started with Qmi.ClientWms.delete().

New in version 1.0.

get_message_protocol(unused, timeout, cancellable, callback, *user_data)¶

Parameters:

unused (object or None) – None. This message doesn’t have any input bundle.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Get Message Protocol request to the device.

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 Qmi.ClientWms.get_message_protocol_finish() to get the result of the operation.

New in version 1.0.

get_message_protocol_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.get_message_protocol().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsGetMessageProtocolOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsGetMessageProtocolOutput.unref().
Return type:: Qmi.MessageWmsGetMessageProtocolOutput

Finishes an async operation started with Qmi.ClientWms.get_message_protocol().

New in version 1.0.

get_routes(unused, timeout, cancellable, callback, *user_data)¶

Parameters:

unused (object or None) – None. This message doesn’t have any input bundle.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Get Routes request to the device.

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 Qmi.ClientWms.get_routes_finish() to get the result of the operation.

New in version 1.0.

get_routes_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.get_routes().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsGetRoutesOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsGetRoutesOutput.unref().
Return type:: Qmi.MessageWmsGetRoutesOutput

Finishes an async operation started with Qmi.ClientWms.get_routes().

New in version 1.0.

get_supported_messages(unused, timeout, cancellable, callback, *user_data)¶

Parameters:

unused (object or None) – None. This message doesn’t have any input bundle.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Get Supported Messages request to the device.

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 Qmi.ClientWms.get_supported_messages_finish() to get the result of the operation.

New in version 1.14.

get_supported_messages_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.get_supported_messages().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsGetSupportedMessagesOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsGetSupportedMessagesOutput.unref().
Return type:: Qmi.MessageWmsGetSupportedMessagesOutput

Finishes an async operation started with Qmi.ClientWms.get_supported_messages().

New in version 1.14.

list_messages(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsListMessagesInput) – a Qmi.MessageWmsListMessagesInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a List Messages request to the device.

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 Qmi.ClientWms.list_messages_finish() to get the result of the operation.

New in version 1.0.

list_messages_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.list_messages().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsListMessagesOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsListMessagesOutput.unref().
Return type:: Qmi.MessageWmsListMessagesOutput

Finishes an async operation started with Qmi.ClientWms.list_messages().

New in version 1.0.

modify_tag(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsModifyTagInput) – a Qmi.MessageWmsModifyTagInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Modify Tag request to the device.

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 Qmi.ClientWms.modify_tag_finish() to get the result of the operation.

New in version 1.0.

modify_tag_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.modify_tag().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsModifyTagOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsModifyTagOutput.unref().
Return type:: Qmi.MessageWmsModifyTagOutput

Finishes an async operation started with Qmi.ClientWms.modify_tag().

New in version 1.0.

raw_read(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsRawReadInput) – a Qmi.MessageWmsRawReadInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Raw Read request to the device.

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 Qmi.ClientWms.raw_read_finish() to get the result of the operation.

New in version 1.0.

raw_read_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.raw_read().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsRawReadOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsRawReadOutput.unref().
Return type:: Qmi.MessageWmsRawReadOutput

Finishes an async operation started with Qmi.ClientWms.raw_read().

New in version 1.0.

raw_send(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsRawSendInput) – a Qmi.MessageWmsRawSendInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Raw Send request to the device.

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 Qmi.ClientWms.raw_send_finish() to get the result of the operation.

New in version 1.0.

raw_send_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.raw_send().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsRawSendOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsRawSendOutput.unref().
Return type:: Qmi.MessageWmsRawSendOutput

Finishes an async operation started with Qmi.ClientWms.raw_send().

New in version 1.0.

raw_write(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsRawWriteInput) – a Qmi.MessageWmsRawWriteInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Raw Write request to the device.

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 Qmi.ClientWms.raw_write_finish() to get the result of the operation.

New in version 1.0.

raw_write_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.raw_write().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsRawWriteOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsRawWriteOutput.unref().
Return type:: Qmi.MessageWmsRawWriteOutput

Finishes an async operation started with Qmi.ClientWms.raw_write().

New in version 1.0.

reset(unused, timeout, cancellable, callback, *user_data)¶

Parameters:

unused (object or None) – None. This message doesn’t have any input bundle.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Reset request to the device.

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 Qmi.ClientWms.reset_finish() to get the result of the operation.

New in version 1.0.

reset_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.reset().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsResetOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsResetOutput.unref().
Return type:: Qmi.MessageWmsResetOutput

Finishes an async operation started with Qmi.ClientWms.reset().

New in version 1.0.

send_ack(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsSendAckInput) – a Qmi.MessageWmsSendAckInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Send Ack request to the device.

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 Qmi.ClientWms.send_ack_finish() to get the result of the operation.

New in version 1.28.

send_ack_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.send_ack().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsSendAckOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsSendAckOutput.unref().
Return type:: Qmi.MessageWmsSendAckOutput

Finishes an async operation started with Qmi.ClientWms.send_ack().

New in version 1.28.

send_from_memory_storage(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsSendFromMemoryStorageInput) – a Qmi.MessageWmsSendFromMemoryStorageInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Send From Memory Storage request to the device.

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 Qmi.ClientWms.send_from_memory_storage_finish() to get the result of the operation.

New in version 1.0.

send_from_memory_storage_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.send_from_memory_storage().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsSendFromMemoryStorageOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsSendFromMemoryStorageOutput.unref().
Return type:: Qmi.MessageWmsSendFromMemoryStorageOutput

Finishes an async operation started with Qmi.ClientWms.send_from_memory_storage().

New in version 1.0.

set_event_report(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsSetEventReportInput) – a Qmi.MessageWmsSetEventReportInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Set Event Report request to the device.

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 Qmi.ClientWms.set_event_report_finish() to get the result of the operation.

New in version 1.0.

set_event_report_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.set_event_report().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsSetEventReportOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsSetEventReportOutput.unref().
Return type:: Qmi.MessageWmsSetEventReportOutput

Finishes an async operation started with Qmi.ClientWms.set_event_report().

New in version 1.0.

set_routes(input, timeout, cancellable, callback, *user_data)¶

Parameters:

input (Qmi.MessageWmsSetRoutesInput) – a Qmi.MessageWmsSetRoutesInput.
timeout (int) – maximum time to wait for the method to complete, in seconds.
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.
user_data (object or None) – user data to pass to callback.

Asynchronously sends a Set Routes request to the device.

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 Qmi.ClientWms.set_routes_finish() to get the result of the operation.

New in version 1.0.

set_routes_finish(res)¶

Parameters:: res (Gio.AsyncResult) – the Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Qmi.ClientWms.set_routes().
Raises:: GLib.Error
Returns:: a Qmi.MessageWmsSetRoutesOutput, or None if error is set. The returned value should be freed with Qmi.MessageWmsSetRoutesOutput.unref().
Return type:: Qmi.MessageWmsSetRoutesOutput

Finishes an async operation started with Qmi.ClientWms.set_routes().

New in version 1.0.

Signal Details¶

Qmi.ClientWms.signals.event_report(client_wms, output)¶

Signal Name:

event-report

Flags:

RUN_LAST

Parameters:

client_wms (Qmi.ClientWms) – The object which received the signal
output (Qmi.IndicationWmsEventReportOutput) – A Qmi.IndicationWmsEventReportOutput.

The ::event-report signal gets emitted when a ‘’Event Report [libqmi-glib-WMS-Event-Report-indication.top_of_page]’’ indication is received.

New in version 1.0.

Qmi.ClientWms.signals.smsc_address(client_wms, output)¶

Signal Name:

smsc-address

Flags:

RUN_LAST

Parameters:

client_wms (Qmi.ClientWms) – The object which received the signal
output (Qmi.IndicationWmsSmscAddressOutput) – A Qmi.IndicationWmsSmscAddressOutput.

The ::smsc-address signal gets emitted when a ‘’SMSC Address [libqmi-glib-WMS-SMSC-Address-indication.top_of_page]’’ indication is received.

New in version 1.14.