VOICE Answer USSD response: libqmi-glib Reference Manual

VOICE Answer USSD response

VOICE Answer USSD response — Methods to manage the VOICE Answer USSD response.

Functions

QmiMessageVoiceAnswerUssdInput *	qmi_message_voice_answer_ussd_input_new ()
QmiMessageVoiceAnswerUssdInput *	qmi_message_voice_answer_ussd_input_ref ()
void	qmi_message_voice_answer_ussd_input_unref ()
gboolean	qmi_message_voice_answer_ussd_input_get_uss_data ()
gboolean	qmi_message_voice_answer_ussd_input_set_uss_data ()
QmiMessageVoiceAnswerUssdOutput *	qmi_message_voice_answer_ussd_output_ref ()
void	qmi_message_voice_answer_ussd_output_unref ()
gboolean	qmi_message_voice_answer_ussd_output_get_result ()
QmiMessageVoiceAnswerUssdOutput *	qmi_message_voice_answer_ussd_response_parse ()
void	qmi_client_voice_answer_ussd ()
QmiMessageVoiceAnswerUssdOutput *	qmi_client_voice_answer_ussd_finish ()

Types and Values

	QmiMessageVoiceAnswerUssdInput
	QmiMessageVoiceAnswerUssdOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageVoiceAnswerUssdInput
    ╰── QmiMessageVoiceAnswerUssdOutput

Description

Collection of methods to create requests and parse responses of the VOICE Answer USSD message.

Functions

qmi_message_voice_answer_ussd_input_new ()

QmiMessageVoiceAnswerUssdInput *
qmi_message_voice_answer_ussd_input_new
                               (void);

Allocates a new QmiMessageVoiceAnswerUssdInput.

Returns

the newly created QmiMessageVoiceAnswerUssdInput. The returned value should be freed with qmi_message_voice_answer_ussd_input_unref().

Since: 1.26

qmi_message_voice_answer_ussd_input_ref ()

QmiMessageVoiceAnswerUssdInput *
qmi_message_voice_answer_ussd_input_ref
                               (QmiMessageVoiceAnswerUssdInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageVoiceAnswerUssdInput.

Returns

the new reference to self .

Since: 1.26

qmi_message_voice_answer_ussd_input_unref ()

void
qmi_message_voice_answer_ussd_input_unref
                               (QmiMessageVoiceAnswerUssdInput *self);

Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

Parameters

self

a QmiMessageVoiceAnswerUssdInput.

Since: 1.26

qmi_message_voice_answer_ussd_input_get_uss_data ()

gboolean
qmi_message_voice_answer_ussd_input_get_uss_data
                               (QmiMessageVoiceAnswerUssdInput *self,
                                QmiVoiceUssDataCodingScheme *value_uss_data_data_coding_scheme,
                                GArray **value_uss_data_data,
                                GError **error);

Get the 'USS Data' field from self .

Parameters

self	a QmiMessageVoiceAnswerUssdInput.
value_uss_data_data_coding_scheme	a placeholder for the output QmiVoiceUssDataCodingScheme, or `NULL` if not required.	[out][optional]
value_uss_data_data	a placeholder for the output GArray of guint8 elements, or `NULL` if not required. Do not free it, it is owned by `self` .	[out][optional][element-type guint8][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.26

qmi_message_voice_answer_ussd_input_set_uss_data ()

gboolean
qmi_message_voice_answer_ussd_input_set_uss_data
                               (QmiMessageVoiceAnswerUssdInput *self,
                                QmiVoiceUssDataCodingScheme value_uss_data_data_coding_scheme,
                                GArray *value_uss_data_data,
                                GError **error);

Set the 'USS Data' field in the message.

Parameters

self	a QmiMessageVoiceAnswerUssdInput.
value_uss_data_data_coding_scheme	a QmiVoiceUssDataCodingScheme.
value_uss_data_data	a GArray of guint8 elements. A new reference to `value_uss_data_data` will be taken, so the caller must make sure the array was created with the correct GDestroyNotify as clear function for each element in the array.	[in][element-type guint8][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.26

qmi_message_voice_answer_ussd_output_ref ()

QmiMessageVoiceAnswerUssdOutput *
qmi_message_voice_answer_ussd_output_ref
                               (QmiMessageVoiceAnswerUssdOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageVoiceAnswerUssdOutput.

Returns

the new reference to self .

Since: 1.26

qmi_message_voice_answer_ussd_output_unref ()

void
qmi_message_voice_answer_ussd_output_unref
                               (QmiMessageVoiceAnswerUssdOutput *self);

Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

Parameters

self

a QmiMessageVoiceAnswerUssdOutput.

Since: 1.26

qmi_message_voice_answer_ussd_output_get_result ()

gboolean
qmi_message_voice_answer_ussd_output_get_result
                               (QmiMessageVoiceAnswerUssdOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageVoiceAnswerUssdOutput.
error	Return location for error or `NULL`.

Returns

TRUE if the QMI operation succeeded, FALSE if error is set.

[skip]

Since: 1.26

qmi_message_voice_answer_ussd_response_parse ()

QmiMessageVoiceAnswerUssdOutput *
qmi_message_voice_answer_ussd_response_parse
                               (QmiMessage *message,
                                GError **error);

Parses a QmiMessage and builds a QmiMessageVoiceAnswerUssdOutput out of it. The operation fails if the message is of the wrong type.

Parameters

message	a QmiMessage.
error	return location for error or `NULL`.

Returns

a QmiMessageVoiceAnswerUssdOutput, or NULL if error is set. The returned value should be freed with qmi_message_voice_answer_ussd_output_unref().

Since: 1.34

qmi_client_voice_answer_ussd ()

void
qmi_client_voice_answer_ussd (QmiClientVoice *self,
                              QmiMessageVoiceAnswerUssdInput *input,
                              guint timeout,
                              GCancellable *cancellable,
                              GAsyncReadyCallback callback,
                              gpointer user_data);

Asynchronously sends a Answer USSD 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_client_voice_answer_ussd_finish() to get the result of the operation.

Parameters

self	a QmiClientVoice.
input	a QmiMessageVoiceAnswerUssdInput.
timeout	maximum time to wait for the method to complete, in seconds.
cancellable	a GCancellable or `NULL`.
callback	a GAsyncReadyCallback to call when the request is satisfied.
user_data	user data to pass to `callback` .

Since: 1.26

qmi_client_voice_answer_ussd_finish ()

QmiMessageVoiceAnswerUssdOutput *
qmi_client_voice_answer_ussd_finish (QmiClientVoice *self,
                                     GAsyncResult *res,
                                     GError **error);

Finishes an async operation started with qmi_client_voice_answer_ussd().

Parameters

self	a QmiClientVoice.
res	the GAsyncResult obtained from the GAsyncReadyCallback passed to `qmi_client_voice_answer_ussd()`.
error	Return location for error or `NULL`.

Returns

a QmiMessageVoiceAnswerUssdOutput, or NULL if error is set. The returned value should be freed with qmi_message_voice_answer_ussd_output_unref().

Since: 1.26

Types and Values

QmiMessageVoiceAnswerUssdInput

typedef struct _QmiMessageVoiceAnswerUssdInput QmiMessageVoiceAnswerUssdInput;

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

Since: 1.26

QmiMessageVoiceAnswerUssdOutput

typedef struct _QmiMessageVoiceAnswerUssdOutput QmiMessageVoiceAnswerUssdOutput;

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

Since: 1.26