libqmi-glib Reference Manual: DMS UIM Verify PIN

DMS UIM Verify PIN

Types and Values

	QmiMessageDmsUimVerifyPinInput
	QmiMessageDmsUimVerifyPinOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageDmsUimVerifyPinInput
    ╰── QmiMessageDmsUimVerifyPinOutput

Description

Functions

qmi_message_dms_uim_verify_pin_input_new ()

QmiMessageDmsUimVerifyPinInput *
qmi_message_dms_uim_verify_pin_input_new
                               (void);

Allocates a new QmiMessageDmsUimVerifyPinInput.

Returns

the newly created QmiMessageDmsUimVerifyPinInput. The returned value should be freed with qmi_message_dms_uim_verify_pin_input_unref().

qmi_message_dms_uim_verify_pin_input_ref ()

QmiMessageDmsUimVerifyPinInput *
qmi_message_dms_uim_verify_pin_input_ref
                               (QmiMessageDmsUimVerifyPinInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsUimVerifyPinInput.

Returns

the new reference to self .

qmi_message_dms_uim_verify_pin_input_unref ()

void
qmi_message_dms_uim_verify_pin_input_unref
                               (QmiMessageDmsUimVerifyPinInput *self);

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

Parameters

self

a QmiMessageDmsUimVerifyPinInput.

qmi_message_dms_uim_verify_pin_input_get_info ()

gboolean
qmi_message_dms_uim_verify_pin_input_get_info
                               (QmiMessageDmsUimVerifyPinInput *self,
                                QmiDmsUimPinId *info_pin_id,
                                const gchar **info_pin,
                                GError **error);

Get the 'Info' field from self .

Parameters

self	a QmiMessageDmsUimVerifyPinInput.
info_pin_id	a placeholder for the output QmiDmsUimPinId, or `NULL` if not required.
info_pin	a placeholder for the output constant string, or `NULL` if not required.
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

qmi_message_dms_uim_verify_pin_input_set_info ()

gboolean
qmi_message_dms_uim_verify_pin_input_set_info
                               (QmiMessageDmsUimVerifyPinInput *self,
                                QmiDmsUimPinId info_pin_id,
                                const gchar *info_pin,
                                GError **error);

Set the 'Info' field in the message.

Parameters

self	a QmiMessageDmsUimVerifyPinInput.
info_pin_id	a QmiDmsUimPinId.
info_pin	a constant string.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

qmi_message_dms_uim_verify_pin_output_ref ()

QmiMessageDmsUimVerifyPinOutput *
qmi_message_dms_uim_verify_pin_output_ref
                               (QmiMessageDmsUimVerifyPinOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsUimVerifyPinOutput.

Returns

the new reference to self .

qmi_message_dms_uim_verify_pin_output_unref ()

void
qmi_message_dms_uim_verify_pin_output_unref
                               (QmiMessageDmsUimVerifyPinOutput *self);

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

Parameters

self

a QmiMessageDmsUimVerifyPinOutput.

qmi_message_dms_uim_verify_pin_output_get_result ()

gboolean
qmi_message_dms_uim_verify_pin_output_get_result
                               (QmiMessageDmsUimVerifyPinOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

qmi_message_dms_uim_verify_pin_output_get_pin_retries_status ()

gboolean
qmi_message_dms_uim_verify_pin_output_get_pin_retries_status
                               (QmiMessageDmsUimVerifyPinOutput *self,
                                guint8 *pin_retries_status_verify_retries_left,
                                guint8 *pin_retries_status_unblock_retries_left,
                                GError **error);

Get the 'Pin Retries Status' field from self .

Parameters

self	a QmiMessageDmsUimVerifyPinOutput.
pin_retries_status_verify_retries_left	a placeholder for the output guint8, or `NULL` if not required.
pin_retries_status_unblock_retries_left	a placeholder for the output guint8, or `NULL` if not required.
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

qmi_client_dms_uim_verify_pin ()

void
qmi_client_dms_uim_verify_pin (QmiClientDms *self,
                               QmiMessageDmsUimVerifyPinInput *input,
                               guint timeout,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data);

Asynchronously sends a UIM Verify PIN 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_dms_uim_verify_pin_finish() to get the result of the operation.

Parameters

self	a QmiClientDms.
input	a QmiMessageDmsUimVerifyPinInput.
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` .

qmi_client_dms_uim_verify_pin_finish ()

QmiMessageDmsUimVerifyPinOutput *
qmi_client_dms_uim_verify_pin_finish (QmiClientDms *self,
                                      GAsyncResult *res,
                                      GError **error);

Finishes an async operation started with qmi_client_dms_uim_verify_pin().

Parameters

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

Returns

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

Types and Values

QmiMessageDmsUimVerifyPinInput

typedef struct _QmiMessageDmsUimVerifyPinInput QmiMessageDmsUimVerifyPinInput;

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

QmiMessageDmsUimVerifyPinOutput

typedef struct _QmiMessageDmsUimVerifyPinOutput QmiMessageDmsUimVerifyPinOutput;

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

QmiMessageDmsUimVerifyPinInput *	qmi_message_dms_uim_verify_pin_input_new ()
QmiMessageDmsUimVerifyPinInput *	qmi_message_dms_uim_verify_pin_input_ref ()
void	qmi_message_dms_uim_verify_pin_input_unref ()
gboolean	qmi_message_dms_uim_verify_pin_input_get_info ()
gboolean	qmi_message_dms_uim_verify_pin_input_set_info ()
QmiMessageDmsUimVerifyPinOutput *	qmi_message_dms_uim_verify_pin_output_ref ()
void	qmi_message_dms_uim_verify_pin_output_unref ()
gboolean	qmi_message_dms_uim_verify_pin_output_get_result ()
gboolean	qmi_message_dms_uim_verify_pin_output_get_pin_retries_status ()
void	qmi_client_dms_uim_verify_pin ()
QmiMessageDmsUimVerifyPinOutput *	qmi_client_dms_uim_verify_pin_finish ()