UIM Logical Channel response: libqmi-glib Reference Manual

UIM Logical Channel response

UIM Logical Channel response — Methods to manage the UIM Logical Channel response.

Functions

QmiMessageUimLogicalChannelInput *	qmi_message_uim_logical_channel_input_new ()
QmiMessageUimLogicalChannelInput *	qmi_message_uim_logical_channel_input_ref ()
void	qmi_message_uim_logical_channel_input_unref ()
gboolean	qmi_message_uim_logical_channel_input_get_terminate_application ()
gboolean	qmi_message_uim_logical_channel_input_set_terminate_application ()
gboolean	qmi_message_uim_logical_channel_input_get_file_control_information ()
gboolean	qmi_message_uim_logical_channel_input_set_file_control_information ()
gboolean	qmi_message_uim_logical_channel_input_get_channel_id ()
gboolean	qmi_message_uim_logical_channel_input_set_channel_id ()
gboolean	qmi_message_uim_logical_channel_input_get_aid ()
gboolean	qmi_message_uim_logical_channel_input_set_aid ()
gboolean	qmi_message_uim_logical_channel_input_get_slot ()
gboolean	qmi_message_uim_logical_channel_input_set_slot ()
QmiMessageUimLogicalChannelOutput *	qmi_message_uim_logical_channel_output_ref ()
void	qmi_message_uim_logical_channel_output_unref ()
gboolean	qmi_message_uim_logical_channel_output_get_card_result ()
gboolean	qmi_message_uim_logical_channel_output_get_result ()
gboolean	qmi_message_uim_logical_channel_output_get_channel_id ()
gboolean	qmi_message_uim_logical_channel_output_get_select_response ()
QmiMessageUimLogicalChannelOutput *	qmi_message_uim_logical_channel_response_parse ()
void	qmi_client_uim_logical_channel ()
QmiMessageUimLogicalChannelOutput *	qmi_client_uim_logical_channel_finish ()

Types and Values

	QmiMessageUimLogicalChannelInput
	QmiMessageUimLogicalChannelOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageUimLogicalChannelInput
    ╰── QmiMessageUimLogicalChannelOutput

Description

Collection of methods to create requests and parse responses of the UIM Logical Channel message.

Functions

qmi_message_uim_logical_channel_input_new ()

QmiMessageUimLogicalChannelInput *
qmi_message_uim_logical_channel_input_new
                               (void);

Allocates a new QmiMessageUimLogicalChannelInput.

Returns

the newly created QmiMessageUimLogicalChannelInput. The returned value should be freed with qmi_message_uim_logical_channel_input_unref().

Since: 1.36

qmi_message_uim_logical_channel_input_ref ()

QmiMessageUimLogicalChannelInput *
qmi_message_uim_logical_channel_input_ref
                               (QmiMessageUimLogicalChannelInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimLogicalChannelInput.

Returns

the new reference to self .

Since: 1.36

qmi_message_uim_logical_channel_input_unref ()

void
qmi_message_uim_logical_channel_input_unref
                               (QmiMessageUimLogicalChannelInput *self);

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

Parameters

self

a QmiMessageUimLogicalChannelInput.

Since: 1.36

qmi_message_uim_logical_channel_input_get_terminate_application ()

gboolean
qmi_message_uim_logical_channel_input_get_terminate_application
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 *value_terminate_application,
                                GError **error);

Get the 'Terminate Application' field from self .

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_terminate_application	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_set_terminate_application ()

gboolean
qmi_message_uim_logical_channel_input_set_terminate_application
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 value_terminate_application,
                                GError **error);

Set the 'Terminate Application' field in the message.

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_terminate_application	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_get_file_control_information ()

gboolean
qmi_message_uim_logical_channel_input_get_file_control_information
                               (QmiMessageUimLogicalChannelInput *self,
                                QmiUimFileControlInformation *value_file_control_information,
                                GError **error);

Get the 'File Control Information' field from self .

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_file_control_information	a placeholder for the output QmiUimFileControlInformation, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_set_file_control_information ()

gboolean
qmi_message_uim_logical_channel_input_set_file_control_information
                               (QmiMessageUimLogicalChannelInput *self,
                                QmiUimFileControlInformation value_file_control_information,
                                GError **error);

Set the 'File Control Information' field in the message.

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_file_control_information	a QmiUimFileControlInformation.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_get_channel_id ()

gboolean
qmi_message_uim_logical_channel_input_get_channel_id
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 *value_channel_id,
                                GError **error);

Get the 'Channel ID' field from self .

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_channel_id	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_set_channel_id ()

gboolean
qmi_message_uim_logical_channel_input_set_channel_id
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 value_channel_id,
                                GError **error);

Set the 'Channel ID' field in the message.

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_channel_id	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_get_aid ()

gboolean
qmi_message_uim_logical_channel_input_get_aid
                               (QmiMessageUimLogicalChannelInput *self,
                                GArray **value_aid,
                                GError **error);

Get the 'AID' field from self .

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_aid	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.36

qmi_message_uim_logical_channel_input_set_aid ()

gboolean
qmi_message_uim_logical_channel_input_set_aid
                               (QmiMessageUimLogicalChannelInput *self,
                                GArray *value_aid,
                                GError **error);

Set the 'AID' field in the message.

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_aid	a GArray of guint8 elements. A new reference to `value_aid` 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.36

qmi_message_uim_logical_channel_input_get_slot ()

gboolean
qmi_message_uim_logical_channel_input_get_slot
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 *value_slot,
                                GError **error);

Get the 'Slot' field from self .

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_slot	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_input_set_slot ()

gboolean
qmi_message_uim_logical_channel_input_set_slot
                               (QmiMessageUimLogicalChannelInput *self,
                                guint8 value_slot,
                                GError **error);

Set the 'Slot' field in the message.

Parameters

self	a QmiMessageUimLogicalChannelInput.
value_slot	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_output_ref ()

QmiMessageUimLogicalChannelOutput *
qmi_message_uim_logical_channel_output_ref
                               (QmiMessageUimLogicalChannelOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimLogicalChannelOutput.

Returns

the new reference to self .

Since: 1.36

qmi_message_uim_logical_channel_output_unref ()

void
qmi_message_uim_logical_channel_output_unref
                               (QmiMessageUimLogicalChannelOutput *self);

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

Parameters

self

a QmiMessageUimLogicalChannelOutput.

Since: 1.36

qmi_message_uim_logical_channel_output_get_card_result ()

gboolean
qmi_message_uim_logical_channel_output_get_card_result
                               (QmiMessageUimLogicalChannelOutput *self,
                                guint8 *value_card_result_sw1,
                                guint8 *value_card_result_sw2,
                                GError **error);

Get the 'Card result' field from self .

Parameters

self	a QmiMessageUimLogicalChannelOutput.
value_card_result_sw1	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
value_card_result_sw2	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_output_get_result ()

gboolean
qmi_message_uim_logical_channel_output_get_result
                               (QmiMessageUimLogicalChannelOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.36

qmi_message_uim_logical_channel_output_get_channel_id ()

gboolean
qmi_message_uim_logical_channel_output_get_channel_id
                               (QmiMessageUimLogicalChannelOutput *self,
                                guint8 *value_channel_id,
                                GError **error);

Get the 'Channel ID' field from self .

Parameters

self	a QmiMessageUimLogicalChannelOutput.
value_channel_id	a placeholder for the output guint8, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_logical_channel_output_get_select_response ()

gboolean
qmi_message_uim_logical_channel_output_get_select_response
                               (QmiMessageUimLogicalChannelOutput *self,
                                GArray **value_select_response,
                                GError **error);

Get the 'Select Response' field from self .

Parameters

self	a QmiMessageUimLogicalChannelOutput.
value_select_response	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.36

qmi_message_uim_logical_channel_response_parse ()

QmiMessageUimLogicalChannelOutput *
qmi_message_uim_logical_channel_response_parse
                               (QmiMessage *message,
                                GError **error);

Parses a QmiMessage and builds a QmiMessageUimLogicalChannelOutput 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 QmiMessageUimLogicalChannelOutput, or NULL if error is set. The returned value should be freed with qmi_message_uim_logical_channel_output_unref().

Since: 1.36

qmi_client_uim_logical_channel ()

void
qmi_client_uim_logical_channel (QmiClientUim *self,
                                QmiMessageUimLogicalChannelInput *input,
                                guint timeout,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously sends a Logical Channel 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_uim_logical_channel_finish() to get the result of the operation.

Parameters

self	a QmiClientUim.
input	a QmiMessageUimLogicalChannelInput.
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.36

qmi_client_uim_logical_channel_finish ()

QmiMessageUimLogicalChannelOutput *
qmi_client_uim_logical_channel_finish (QmiClientUim *self,
                                       GAsyncResult *res,
                                       GError **error);

Finishes an async operation started with qmi_client_uim_logical_channel().

Parameters

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

Returns

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

Since: 1.36

Types and Values

QmiMessageUimLogicalChannelInput

typedef struct _QmiMessageUimLogicalChannelInput QmiMessageUimLogicalChannelInput;

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

Since: 1.36

QmiMessageUimLogicalChannelOutput

typedef struct _QmiMessageUimLogicalChannelOutput QmiMessageUimLogicalChannelOutput;

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

Since: 1.36