UIM Remote Unlock response: libqmi-glib Reference Manual

UIM Remote Unlock response

UIM Remote Unlock response — Methods to manage the UIM Remote Unlock response.

Functions

QmiMessageUimRemoteUnlockInput *	qmi_message_uim_remote_unlock_input_new ()
QmiMessageUimRemoteUnlockInput *	qmi_message_uim_remote_unlock_input_ref ()
void	qmi_message_uim_remote_unlock_input_unref ()
gboolean	qmi_message_uim_remote_unlock_input_get_simlock_extended_data ()
gboolean	qmi_message_uim_remote_unlock_input_set_simlock_extended_data ()
gboolean	qmi_message_uim_remote_unlock_input_get_simlock_data ()
gboolean	qmi_message_uim_remote_unlock_input_set_simlock_data ()
QmiMessageUimRemoteUnlockOutput *	qmi_message_uim_remote_unlock_output_ref ()
void	qmi_message_uim_remote_unlock_output_unref ()
gboolean	qmi_message_uim_remote_unlock_output_get_result ()
QmiMessageUimRemoteUnlockOutput *	qmi_message_uim_remote_unlock_response_parse ()
void	qmi_client_uim_remote_unlock ()
QmiMessageUimRemoteUnlockOutput *	qmi_client_uim_remote_unlock_finish ()

Types and Values

	QmiMessageUimRemoteUnlockInput
	QmiMessageUimRemoteUnlockOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageUimRemoteUnlockInput
    ╰── QmiMessageUimRemoteUnlockOutput

Description

Collection of methods to create requests and parse responses of the UIM Remote Unlock message.

Functions

qmi_message_uim_remote_unlock_input_new ()

QmiMessageUimRemoteUnlockInput *
qmi_message_uim_remote_unlock_input_new
                               (void);

Allocates a new QmiMessageUimRemoteUnlockInput.

Returns

the newly created QmiMessageUimRemoteUnlockInput. The returned value should be freed with qmi_message_uim_remote_unlock_input_unref().

Since: 1.32

qmi_message_uim_remote_unlock_input_ref ()

QmiMessageUimRemoteUnlockInput *
qmi_message_uim_remote_unlock_input_ref
                               (QmiMessageUimRemoteUnlockInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimRemoteUnlockInput.

Returns

the new reference to self .

Since: 1.32

qmi_message_uim_remote_unlock_input_unref ()

void
qmi_message_uim_remote_unlock_input_unref
                               (QmiMessageUimRemoteUnlockInput *self);

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

Parameters

self

a QmiMessageUimRemoteUnlockInput.

Since: 1.32

qmi_message_uim_remote_unlock_input_get_simlock_extended_data ()

gboolean
qmi_message_uim_remote_unlock_input_get_simlock_extended_data
                               (QmiMessageUimRemoteUnlockInput *self,
                                GArray **value_simlock_extended_data,
                                GError **error);

Get the 'SimLock Extended Data' field from self .

Parameters

self	a QmiMessageUimRemoteUnlockInput.
value_simlock_extended_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.32

qmi_message_uim_remote_unlock_input_set_simlock_extended_data ()

gboolean
qmi_message_uim_remote_unlock_input_set_simlock_extended_data
                               (QmiMessageUimRemoteUnlockInput *self,
                                GArray *value_simlock_extended_data,
                                GError **error);

Set the 'SimLock Extended Data' field in the message.

Parameters

self	a QmiMessageUimRemoteUnlockInput.
value_simlock_extended_data	a GArray of guint8 elements. A new reference to `value_simlock_extended_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.32

qmi_message_uim_remote_unlock_input_get_simlock_data ()

gboolean
qmi_message_uim_remote_unlock_input_get_simlock_data
                               (QmiMessageUimRemoteUnlockInput *self,
                                GArray **value_simlock_data,
                                GError **error);

Get the 'SimLock Data' field from self .

Parameters

self	a QmiMessageUimRemoteUnlockInput.
value_simlock_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.32

qmi_message_uim_remote_unlock_input_set_simlock_data ()

gboolean
qmi_message_uim_remote_unlock_input_set_simlock_data
                               (QmiMessageUimRemoteUnlockInput *self,
                                GArray *value_simlock_data,
                                GError **error);

Set the 'SimLock Data' field in the message.

Parameters

self	a QmiMessageUimRemoteUnlockInput.
value_simlock_data	a GArray of guint8 elements. A new reference to `value_simlock_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.32

qmi_message_uim_remote_unlock_output_ref ()

QmiMessageUimRemoteUnlockOutput *
qmi_message_uim_remote_unlock_output_ref
                               (QmiMessageUimRemoteUnlockOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimRemoteUnlockOutput.

Returns

the new reference to self .

Since: 1.32

qmi_message_uim_remote_unlock_output_unref ()

void
qmi_message_uim_remote_unlock_output_unref
                               (QmiMessageUimRemoteUnlockOutput *self);

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

Parameters

self

a QmiMessageUimRemoteUnlockOutput.

Since: 1.32

qmi_message_uim_remote_unlock_output_get_result ()

gboolean
qmi_message_uim_remote_unlock_output_get_result
                               (QmiMessageUimRemoteUnlockOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.32

qmi_message_uim_remote_unlock_response_parse ()

QmiMessageUimRemoteUnlockOutput *
qmi_message_uim_remote_unlock_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_uim_remote_unlock ()

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

Asynchronously sends a Remote Unlock 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_remote_unlock_finish() to get the result of the operation.

Parameters

self	a QmiClientUim.
input	a QmiMessageUimRemoteUnlockInput.
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.32

qmi_client_uim_remote_unlock_finish ()

QmiMessageUimRemoteUnlockOutput *
qmi_client_uim_remote_unlock_finish (QmiClientUim *self,
                                     GAsyncResult *res,
                                     GError **error);

Finishes an async operation started with qmi_client_uim_remote_unlock().

Parameters

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

Returns

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

Since: 1.32

Types and Values

QmiMessageUimRemoteUnlockInput

typedef struct _QmiMessageUimRemoteUnlockInput QmiMessageUimRemoteUnlockInput;

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

Since: 1.32

QmiMessageUimRemoteUnlockOutput

typedef struct _QmiMessageUimRemoteUnlockOutput QmiMessageUimRemoteUnlockOutput;

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

Since: 1.32