WMS List Messages

WMS List Messages

Synopsis

                    QmiMessageWmsListMessagesInput;
                    QmiMessageWmsListMessagesOutput;
                    QmiMessageWmsListMessagesOutputMessageListElement;

QmiMessageWmsListMessagesInput * qmi_message_wms_list_messages_input_new
                                                        (void);
QmiMessageWmsListMessagesInput * qmi_message_wms_list_messages_input_ref
                                                        (QmiMessageWmsListMessagesInput *self);
void                qmi_message_wms_list_messages_input_unref
                                                        (QmiMessageWmsListMessagesInput *self);
gboolean            qmi_message_wms_list_messages_input_get_message_mode
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageMode *message_mode,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_input_set_message_mode
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageMode message_mode,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_input_get_message_tag
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageTagType *message_tag,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_input_set_message_tag
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageTagType message_tag,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_input_get_storage_type
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsStorageType *storage_type,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_input_set_storage_type
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsStorageType storage_type,
                                                         GError **error);

QmiMessageWmsListMessagesOutput * qmi_message_wms_list_messages_output_ref
                                                        (QmiMessageWmsListMessagesOutput *self);
void                qmi_message_wms_list_messages_output_unref
                                                        (QmiMessageWmsListMessagesOutput *self);
gboolean            qmi_message_wms_list_messages_output_get_result
                                                        (QmiMessageWmsListMessagesOutput *self,
                                                         GError **error);
gboolean            qmi_message_wms_list_messages_output_get_message_list
                                                        (QmiMessageWmsListMessagesOutput *self,
                                                         GArray **message_list,
                                                         GError **error);

void                qmi_client_wms_list_messages        (QmiClientWms *self,
                                                         QmiMessageWmsListMessagesInput *input,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
QmiMessageWmsListMessagesOutput * qmi_client_wms_list_messages_finish
                                                        (QmiClientWms *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Object Hierarchy

  GBoxed
   +----QmiMessageWmsListMessagesInput
  GBoxed
   +----QmiMessageWmsListMessagesOutput

Description

Details

QmiMessageWmsListMessagesInput

typedef struct _QmiMessageWmsListMessagesInput QmiMessageWmsListMessagesInput;

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


QmiMessageWmsListMessagesOutput

typedef struct _QmiMessageWmsListMessagesOutput QmiMessageWmsListMessagesOutput;

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


QmiMessageWmsListMessagesOutputMessageListElement

typedef struct {
    guint32 memory_index;
    QmiWmsMessageTagType message_tag;
} QmiMessageWmsListMessagesOutputMessageListElement;

A QmiMessageWmsListMessagesOutputMessageListElement struct.

guint32 memory_index;

a guint32.

QmiWmsMessageTagType message_tag;

a QmiWmsMessageTagType.

qmi_message_wms_list_messages_input_new ()

QmiMessageWmsListMessagesInput * qmi_message_wms_list_messages_input_new
                                                        (void);

Allocates a new QmiMessageWmsListMessagesInput.

Returns :

the newly created QmiMessageWmsListMessagesInput. The returned value should be freed with qmi_message_wms_list_messages_input_unref().

qmi_message_wms_list_messages_input_ref ()

QmiMessageWmsListMessagesInput * qmi_message_wms_list_messages_input_ref
                                                        (QmiMessageWmsListMessagesInput *self);

Atomically increments the reference count of self by one.

self :

a QmiMessageWmsListMessagesInput.

Returns :

the new reference to self.

qmi_message_wms_list_messages_input_unref ()

void                qmi_message_wms_list_messages_input_unref
                                                        (QmiMessageWmsListMessagesInput *self);

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


qmi_message_wms_list_messages_input_get_message_mode ()

gboolean            qmi_message_wms_list_messages_input_get_message_mode
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageMode *message_mode,
                                                         GError **error);

Get the 'Message Mode' field from self.

self :

a QmiMessageWmsListMessagesInput.

message_mode :

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

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_message_wms_list_messages_input_set_message_mode ()

gboolean            qmi_message_wms_list_messages_input_set_message_mode
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageMode message_mode,
                                                         GError **error);

Set the 'Message Mode' field in the message.

self :

a QmiMessageWmsListMessagesInput.

message_mode :

a QmiWmsMessageMode.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_wms_list_messages_input_get_message_tag ()

gboolean            qmi_message_wms_list_messages_input_get_message_tag
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageTagType *message_tag,
                                                         GError **error);

Get the 'Message Tag' field from self.

self :

a QmiMessageWmsListMessagesInput.

message_tag :

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

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_message_wms_list_messages_input_set_message_tag ()

gboolean            qmi_message_wms_list_messages_input_set_message_tag
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsMessageTagType message_tag,
                                                         GError **error);

Set the 'Message Tag' field in the message.

self :

a QmiMessageWmsListMessagesInput.

message_tag :

a QmiWmsMessageTagType.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_wms_list_messages_input_get_storage_type ()

gboolean            qmi_message_wms_list_messages_input_get_storage_type
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsStorageType *storage_type,
                                                         GError **error);

Get the 'Storage Type' field from self.

self :

a QmiMessageWmsListMessagesInput.

storage_type :

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

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_message_wms_list_messages_input_set_storage_type ()

gboolean            qmi_message_wms_list_messages_input_set_storage_type
                                                        (QmiMessageWmsListMessagesInput *self,
                                                         QmiWmsStorageType storage_type,
                                                         GError **error);

Set the 'Storage Type' field in the message.

self :

a QmiMessageWmsListMessagesInput.

storage_type :

a QmiWmsStorageType.

error :

Return location for error or NULL.

Returns :

TRUE if value was successfully set, FALSE otherwise.

qmi_message_wms_list_messages_output_ref ()

QmiMessageWmsListMessagesOutput * qmi_message_wms_list_messages_output_ref
                                                        (QmiMessageWmsListMessagesOutput *self);

Atomically increments the reference count of self by one.

self :

a QmiMessageWmsListMessagesOutput.

Returns :

the new reference to self.

qmi_message_wms_list_messages_output_unref ()

void                qmi_message_wms_list_messages_output_unref
                                                        (QmiMessageWmsListMessagesOutput *self);

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


qmi_message_wms_list_messages_output_get_result ()

gboolean            qmi_message_wms_list_messages_output_get_result
                                                        (QmiMessageWmsListMessagesOutput *self,
                                                         GError **error);

Get the result of the QMI operation.

self :

a QmiMessageWmsListMessagesOutput.

error :

Return location for error or NULL.

Returns :

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

qmi_message_wms_list_messages_output_get_message_list ()

gboolean            qmi_message_wms_list_messages_output_get_message_list
                                                        (QmiMessageWmsListMessagesOutput *self,
                                                         GArray **message_list,
                                                         GError **error);

Get the 'Message List' field from self.

self :

a QmiMessageWmsListMessagesOutput.

message_list :

a placeholder for the output GArray of QmiMessageWmsListMessagesOutputMessageListElement elements, or NULL if not required. Do not free it, it is owned by self.

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_client_wms_list_messages ()

void                qmi_client_wms_list_messages        (QmiClientWms *self,
                                                         QmiMessageWmsListMessagesInput *input,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

self :

a QmiClientWms.

input :

a QmiMessageWmsListMessagesInput.

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

QmiMessageWmsListMessagesOutput * qmi_client_wms_list_messages_finish
                                                        (QmiClientWms *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an async operation started with qmi_client_wms_list_messages().

self :

a QmiClientWms.

res :

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

error :

Return location for error or NULL.

Returns :

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