UIM Verify PIN

UIM Verify PIN

Synopsis

                    QmiMessageUimVerifyPinInput;
                    QmiMessageUimVerifyPinOutput;

QmiMessageUimVerifyPinInput * qmi_message_uim_verify_pin_input_new
                                                        (void);
QmiMessageUimVerifyPinInput * qmi_message_uim_verify_pin_input_ref
                                                        (QmiMessageUimVerifyPinInput *self);
void                qmi_message_uim_verify_pin_input_unref
                                                        (QmiMessageUimVerifyPinInput *self);
gboolean            qmi_message_uim_verify_pin_input_get_response_in_indication_token
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         guint32 *value_response_in_indication_token,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_input_set_response_in_indication_token
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         guint32 value_response_in_indication_token,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_input_get_info
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimPinId *value_info_pin_id,
                                                         const gchar **value_info_pin_value,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_input_set_info
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimPinId value_info_pin_id,
                                                         const gchar *value_info_pin_value,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_input_get_session_information
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimSessionType *value_session_information_session_type,
                                                         const gchar **value_session_information_application_identifier,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_input_set_session_information
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimSessionType value_session_information_session_type,
                                                         const gchar *value_session_information_application_identifier,
                                                         GError **error);

QmiMessageUimVerifyPinOutput * qmi_message_uim_verify_pin_output_ref
                                                        (QmiMessageUimVerifyPinOutput *self);
void                qmi_message_uim_verify_pin_output_unref
                                                        (QmiMessageUimVerifyPinOutput *self);
gboolean            qmi_message_uim_verify_pin_output_get_result
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_output_get_card_result
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint8 *value_card_result_sw1,
                                                         guint8 *value_card_result_sw2,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_output_get_retries_remaining
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint8 *value_retries_remaining_verify_retries_left,
                                                         guint8 *value_retries_remaining_unblock_retries_left,
                                                         GError **error);
gboolean            qmi_message_uim_verify_pin_output_get_response_in_indication_token
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint32 *value_response_in_indication_token,
                                                         GError **error);

void                qmi_client_uim_verify_pin           (QmiClientUim *self,
                                                         QmiMessageUimVerifyPinInput *input,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
QmiMessageUimVerifyPinOutput * qmi_client_uim_verify_pin_finish
                                                        (QmiClientUim *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Object Hierarchy

  GBoxed
   +----QmiMessageUimVerifyPinInput
  GBoxed
   +----QmiMessageUimVerifyPinOutput

Description

Details

QmiMessageUimVerifyPinInput

typedef struct _QmiMessageUimVerifyPinInput QmiMessageUimVerifyPinInput;

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


QmiMessageUimVerifyPinOutput

typedef struct _QmiMessageUimVerifyPinOutput QmiMessageUimVerifyPinOutput;

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


qmi_message_uim_verify_pin_input_new ()

QmiMessageUimVerifyPinInput * qmi_message_uim_verify_pin_input_new
                                                        (void);

Allocates a new QmiMessageUimVerifyPinInput.

Returns :

the newly created QmiMessageUimVerifyPinInput. The returned value should be freed with qmi_message_uim_verify_pin_input_unref().

qmi_message_uim_verify_pin_input_ref ()

QmiMessageUimVerifyPinInput * qmi_message_uim_verify_pin_input_ref
                                                        (QmiMessageUimVerifyPinInput *self);

Atomically increments the reference count of self by one.

self :

a QmiMessageUimVerifyPinInput.

Returns :

the new reference to self.

qmi_message_uim_verify_pin_input_unref ()

void                qmi_message_uim_verify_pin_input_unref
                                                        (QmiMessageUimVerifyPinInput *self);

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


qmi_message_uim_verify_pin_input_get_response_in_indication_token ()

gboolean            qmi_message_uim_verify_pin_input_get_response_in_indication_token
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         guint32 *value_response_in_indication_token,
                                                         GError **error);

Get the 'Response In Indication Token' field from self.

self :

a QmiMessageUimVerifyPinInput.

value_response_in_indication_token :

a placeholder for the output guint32, or NULL if not required.

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_message_uim_verify_pin_input_set_response_in_indication_token ()

gboolean            qmi_message_uim_verify_pin_input_set_response_in_indication_token
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         guint32 value_response_in_indication_token,
                                                         GError **error);

Set the 'Response In Indication Token' field in the message.

self :

a QmiMessageUimVerifyPinInput.

value_response_in_indication_token :

a guint32.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_uim_verify_pin_input_get_info ()

gboolean            qmi_message_uim_verify_pin_input_get_info
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimPinId *value_info_pin_id,
                                                         const gchar **value_info_pin_value,
                                                         GError **error);

Get the 'Info' field from self.

self :

a QmiMessageUimVerifyPinInput.

value_info_pin_id :

a placeholder for the output QmiUimPinId, or NULL if not required.

value_info_pin_value :

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_uim_verify_pin_input_set_info ()

gboolean            qmi_message_uim_verify_pin_input_set_info
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimPinId value_info_pin_id,
                                                         const gchar *value_info_pin_value,
                                                         GError **error);

Set the 'Info' field in the message.

self :

a QmiMessageUimVerifyPinInput.

value_info_pin_id :

a QmiUimPinId.

value_info_pin_value :

a constant string.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_uim_verify_pin_input_get_session_information ()

gboolean            qmi_message_uim_verify_pin_input_get_session_information
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimSessionType *value_session_information_session_type,
                                                         const gchar **value_session_information_application_identifier,
                                                         GError **error);

Get the 'Session Information' field from self.

self :

a QmiMessageUimVerifyPinInput.

value_session_information_session_type :

a placeholder for the output QmiUimSessionType, or NULL if not required.

value_session_information_application_identifier :

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_uim_verify_pin_input_set_session_information ()

gboolean            qmi_message_uim_verify_pin_input_set_session_information
                                                        (QmiMessageUimVerifyPinInput *self,
                                                         QmiUimSessionType value_session_information_session_type,
                                                         const gchar *value_session_information_application_identifier,
                                                         GError **error);

Set the 'Session Information' field in the message.

self :

a QmiMessageUimVerifyPinInput.

value_session_information_session_type :

a QmiUimSessionType.

value_session_information_application_identifier :

a constant string.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_uim_verify_pin_output_ref ()

QmiMessageUimVerifyPinOutput * qmi_message_uim_verify_pin_output_ref
                                                        (QmiMessageUimVerifyPinOutput *self);

Atomically increments the reference count of self by one.

self :

a QmiMessageUimVerifyPinOutput.

Returns :

the new reference to self.

qmi_message_uim_verify_pin_output_unref ()

void                qmi_message_uim_verify_pin_output_unref
                                                        (QmiMessageUimVerifyPinOutput *self);

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


qmi_message_uim_verify_pin_output_get_result ()

gboolean            qmi_message_uim_verify_pin_output_get_result
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         GError **error);

Get the result of the QMI operation.

self :

a QmiMessageUimVerifyPinOutput.

error :

Return location for error or NULL.

Returns :

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

qmi_message_uim_verify_pin_output_get_card_result ()

gboolean            qmi_message_uim_verify_pin_output_get_card_result
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint8 *value_card_result_sw1,
                                                         guint8 *value_card_result_sw2,
                                                         GError **error);

Get the 'Card Result' field from self.

self :

a QmiMessageUimVerifyPinOutput.

value_card_result_sw1 :

a placeholder for the output guint8, or NULL if not required.

value_card_result_sw2 :

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_message_uim_verify_pin_output_get_retries_remaining ()

gboolean            qmi_message_uim_verify_pin_output_get_retries_remaining
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint8 *value_retries_remaining_verify_retries_left,
                                                         guint8 *value_retries_remaining_unblock_retries_left,
                                                         GError **error);

Get the 'Retries Remaining' field from self.

self :

a QmiMessageUimVerifyPinOutput.

value_retries_remaining_verify_retries_left :

a placeholder for the output guint8, or NULL if not required.

value_retries_remaining_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_message_uim_verify_pin_output_get_response_in_indication_token ()

gboolean            qmi_message_uim_verify_pin_output_get_response_in_indication_token
                                                        (QmiMessageUimVerifyPinOutput *self,
                                                         guint32 *value_response_in_indication_token,
                                                         GError **error);

Get the 'Response In Indication Token' field from self.

self :

a QmiMessageUimVerifyPinOutput.

value_response_in_indication_token :

a placeholder for the output guint32, or NULL if not required.

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_client_uim_verify_pin ()

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

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

self :

a QmiClientUim.

input :

a QmiMessageUimVerifyPinInput.

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_uim_verify_pin_finish ()

QmiMessageUimVerifyPinOutput * qmi_client_uim_verify_pin_finish
                                                        (QmiClientUim *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an async operation started with qmi_client_uim_verify_pin().

self :

a QmiClientUim.

res :

the GAsyncResult obtained from the GAsyncReadyCallback passed to qmi_client_uim_verify_pin().

error :

Return location for error or NULL.

Returns :

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