libmm-glib Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Known Implementations | Properties | Signals |
Synopsis
MmGdbusSms; struct MmGdbusSmsIface; guint mm_gdbus_sms_get_state (MmGdbusSms *object
); guint mm_gdbus_sms_get_pdu_type (MmGdbusSms *object
); guint mm_gdbus_sms_get_message_reference (MmGdbusSms *object
); guint mm_gdbus_sms_get_storage (MmGdbusSms *object
); const gchar * mm_gdbus_sms_get_text (MmGdbusSms *object
); gchar * mm_gdbus_sms_dup_text (MmGdbusSms *object
); GVariant * mm_gdbus_sms_get_data (MmGdbusSms *object
); GVariant * mm_gdbus_sms_dup_data (MmGdbusSms *object
); const gchar * mm_gdbus_sms_get_number (MmGdbusSms *object
); gchar * mm_gdbus_sms_dup_number (MmGdbusSms *object
); const gchar * mm_gdbus_sms_get_smsc (MmGdbusSms *object
); gchar * mm_gdbus_sms_dup_smsc (MmGdbusSms *object
); GVariant * mm_gdbus_sms_get_validity (MmGdbusSms *object
); GVariant * mm_gdbus_sms_dup_validity (MmGdbusSms *object
); gint mm_gdbus_sms_get_class (MmGdbusSms *object
); const gchar * mm_gdbus_sms_get_timestamp (MmGdbusSms *object
); gchar * mm_gdbus_sms_dup_timestamp (MmGdbusSms *object
); const gchar * mm_gdbus_sms_get_discharge_timestamp (MmGdbusSms *object
); gchar * mm_gdbus_sms_dup_discharge_timestamp (MmGdbusSms *object
); gboolean mm_gdbus_sms_get_delivery_report_request (MmGdbusSms *object
); guint mm_gdbus_sms_get_delivery_state (MmGdbusSms *object
); void mm_gdbus_sms_call_send (MmGdbusSms *proxy
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean mm_gdbus_sms_call_send_finish (MmGdbusSms *proxy
,GAsyncResult *res
,GError **error
); gboolean mm_gdbus_sms_call_send_sync (MmGdbusSms *proxy
,GCancellable *cancellable
,GError **error
); void mm_gdbus_sms_call_store (MmGdbusSms *proxy
,guint arg_storage
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean mm_gdbus_sms_call_store_finish (MmGdbusSms *proxy
,GAsyncResult *res
,GError **error
); gboolean mm_gdbus_sms_call_store_sync (MmGdbusSms *proxy
,guint arg_storage
,GCancellable *cancellable
,GError **error
);
Properties
"class" gint : Read / Write "data" GVariant* : Read / Write "delivery-report-request" gboolean : Read / Write "delivery-state" guint : Read / Write "discharge-timestamp" gchar* : Read / Write "message-reference" guint : Read / Write "number" gchar* : Read / Write "pdu-type" guint : Read / Write "smsc" gchar* : Read / Write "state" guint : Read / Write "storage" guint : Read / Write "text" gchar* : Read / Write "timestamp" gchar* : Read / Write "validity" GVariant* : Read / Write
Description
This section contains code for working with the org.freedesktop.ModemManager1.Sms D-Bus interface in C.
Details
MmGdbusSms
typedef struct _MmGdbusSms MmGdbusSms;
Abstract interface type for the D-Bus interface org.freedesktop.ModemManager1.Sms.
struct MmGdbusSmsIface
struct MmGdbusSmsIface { GTypeInterface parent_iface; gboolean (*handle_send) ( MmGdbusSms *object, GDBusMethodInvocation *invocation); gboolean (*handle_store) ( MmGdbusSms *object, GDBusMethodInvocation *invocation, guint arg_storage); gint (*get_class) (MmGdbusSms *object); GVariant * (*get_data) (MmGdbusSms *object); gboolean (*get_delivery_report_request) (MmGdbusSms *object); guint (*get_delivery_state) (MmGdbusSms *object); const gchar * (*get_discharge_timestamp) (MmGdbusSms *object); guint (*get_message_reference) (MmGdbusSms *object); const gchar * (*get_number) (MmGdbusSms *object); guint (*get_pdu_type) (MmGdbusSms *object); const gchar * (*get_smsc) (MmGdbusSms *object); guint (*get_state) (MmGdbusSms *object); guint (*get_storage) (MmGdbusSms *object); const gchar * (*get_text) (MmGdbusSms *object); const gchar * (*get_timestamp) (MmGdbusSms *object); GVariant * (*get_validity) (MmGdbusSms *object); };
Virtual table for the D-Bus interface org.freedesktop.ModemManager1.Sms.
GTypeInterface |
The parent interface. |
Handler for the "handle-send" signal. | |
Handler for the "handle-store" signal. | |
Getter for the "class" property. | |
Getter for the "data" property. | |
Getter for the "delivery-report-request" property. | |
Getter for the "delivery-state" property. | |
Getter for the "discharge-timestamp" property. | |
Getter for the "message-reference" property. | |
Getter for the "number" property. | |
Getter for the "pdu-type" property. | |
Getter for the "smsc" property. | |
Getter for the "state" property. | |
Getter for the "storage" property. | |
Getter for the "text" property. | |
Getter for the "timestamp" property. | |
Getter for the "validity" property. |
mm_gdbus_sms_get_state ()
guint mm_gdbus_sms_get_state (MmGdbusSms *object
);
Gets the value of the "State" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_pdu_type ()
guint mm_gdbus_sms_get_pdu_type (MmGdbusSms *object
);
Gets the value of the "PduType" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_message_reference ()
guint mm_gdbus_sms_get_message_reference (MmGdbusSms *object
);
Gets the value of the "MessageReference" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_storage ()
guint mm_gdbus_sms_get_storage (MmGdbusSms *object
);
Gets the value of the "Storage" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_text ()
const gchar * mm_gdbus_sms_get_text (MmGdbusSms *object
);
Gets the value of the "Text" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_text()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_text ()
gchar * mm_gdbus_sms_dup_text (MmGdbusSms *object
);
Gets a copy of the "Text" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
mm_gdbus_sms_get_data ()
GVariant * mm_gdbus_sms_get_data (MmGdbusSms *object
);
Gets the value of the "Data" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_data()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_data ()
GVariant * mm_gdbus_sms_dup_data (MmGdbusSms *object
);
Gets a copy of the "Data" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref() . [transfer full]
|
mm_gdbus_sms_get_number ()
const gchar * mm_gdbus_sms_get_number (MmGdbusSms *object
);
Gets the value of the "Number" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_number()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_number ()
gchar * mm_gdbus_sms_dup_number (MmGdbusSms *object
);
Gets a copy of the "Number" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
mm_gdbus_sms_get_smsc ()
const gchar * mm_gdbus_sms_get_smsc (MmGdbusSms *object
);
Gets the value of the "SMSC" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_smsc()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_smsc ()
gchar * mm_gdbus_sms_dup_smsc (MmGdbusSms *object
);
Gets a copy of the "SMSC" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
mm_gdbus_sms_get_validity ()
GVariant * mm_gdbus_sms_get_validity (MmGdbusSms *object
);
Gets the value of the "Validity" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_validity()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_validity ()
GVariant * mm_gdbus_sms_dup_validity (MmGdbusSms *object
);
Gets a copy of the "Validity" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_variant_unref() . [transfer full]
|
mm_gdbus_sms_get_class ()
gint mm_gdbus_sms_get_class (MmGdbusSms *object
);
Gets the value of the "Class" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_timestamp ()
const gchar * mm_gdbus_sms_get_timestamp (MmGdbusSms *object
);
Gets the value of the "Timestamp" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_timestamp()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_timestamp ()
gchar * mm_gdbus_sms_dup_timestamp (MmGdbusSms *object
);
Gets a copy of the "Timestamp" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
mm_gdbus_sms_get_discharge_timestamp ()
const gchar * mm_gdbus_sms_get_discharge_timestamp
(MmGdbusSms *object
);
Gets the value of the "DischargeTimestamp" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
Warning
The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread whereobject
was constructed. Use mm_gdbus_sms_dup_discharge_timestamp()
if on another thread.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. Do not free the returned value, it belongs to object . [transfer none]
|
mm_gdbus_sms_dup_discharge_timestamp ()
gchar * mm_gdbus_sms_dup_discharge_timestamp
(MmGdbusSms *object
);
Gets a copy of the "DischargeTimestamp" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value or NULL if the property is not set. The returned value should be freed with g_free() . [transfer full]
|
mm_gdbus_sms_get_delivery_report_request ()
gboolean mm_gdbus_sms_get_delivery_report_request
(MmGdbusSms *object
);
Gets the value of the "DeliveryReportRequest" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_get_delivery_state ()
guint mm_gdbus_sms_get_delivery_state (MmGdbusSms *object
);
Gets the value of the "DeliveryState" D-Bus property.
Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.
|
A MmGdbusSms. |
Returns : |
The property value. |
mm_gdbus_sms_call_send ()
void mm_gdbus_sms_call_send (MmGdbusSms *proxy
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously invokes the Send()
proxy
.
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 mm_gdbus_sms_call_send_finish()
to get the result of the operation.
See mm_gdbus_sms_call_send_sync()
for the synchronous, blocking version of this method.
|
A MmGdbusSmsProxy. |
|
A GCancellable or NULL . [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL . |
|
User data to pass to callback . |
mm_gdbus_sms_call_send_finish ()
gboolean mm_gdbus_sms_call_send_finish (MmGdbusSms *proxy
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_gdbus_sms_call_send()
.
|
A MmGdbusSmsProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_gdbus_sms_call_send() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
mm_gdbus_sms_call_send_sync ()
gboolean mm_gdbus_sms_call_send_sync (MmGdbusSms *proxy
,GCancellable *cancellable
,GError **error
);
Synchronously invokes the Send()
proxy
. The calling thread is blocked until a reply is received.
See mm_gdbus_sms_call_send()
for the asynchronous version of this method.
|
A MmGdbusSmsProxy. |
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
mm_gdbus_sms_call_store ()
void mm_gdbus_sms_call_store (MmGdbusSms *proxy
,guint arg_storage
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously invokes the Store()
proxy
.
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 mm_gdbus_sms_call_store_finish()
to get the result of the operation.
See mm_gdbus_sms_call_store_sync()
for the synchronous, blocking version of this method.
|
A MmGdbusSmsProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL . [allow-none]
|
|
A GAsyncReadyCallback to call when the request is satisfied or NULL . |
|
User data to pass to callback . |
mm_gdbus_sms_call_store_finish ()
gboolean mm_gdbus_sms_call_store_finish (MmGdbusSms *proxy
,GAsyncResult *res
,GError **error
);
Finishes an operation started with mm_gdbus_sms_call_store()
.
|
A MmGdbusSmsProxy. |
|
The GAsyncResult obtained from the GAsyncReadyCallback passed to mm_gdbus_sms_call_store() . |
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
mm_gdbus_sms_call_store_sync ()
gboolean mm_gdbus_sms_call_store_sync (MmGdbusSms *proxy
,guint arg_storage
,GCancellable *cancellable
,GError **error
);
Synchronously invokes the Store()
proxy
. The calling thread is blocked until a reply is received.
See mm_gdbus_sms_call_store()
for the asynchronous version of this method.
|
A MmGdbusSmsProxy. |
|
Argument to pass with the method invocation. |
|
A GCancellable or NULL . [allow-none]
|
|
Return location for error or NULL . |
Returns : |
TRUE if the call succeded, FALSE if error is set. [skip]
|
Property Details
The "class"
property
"class" gint : Read / Write
Represents the D-Bus property "Class".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "data"
property
"data" GVariant* : Read / Write
Represents the D-Bus property "Data".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Allowed values: GVariant<ay>
Default value: NULL
The "delivery-report-request"
property
"delivery-report-request" gboolean : Read / Write
Represents the D-Bus property "DeliveryReportRequest".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: FALSE
The "delivery-state"
property
"delivery-state" guint : Read / Write
Represents the D-Bus property "DeliveryState".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "discharge-timestamp"
property
"discharge-timestamp" gchar* : Read / Write
Represents the D-Bus property "DischargeTimestamp".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
The "message-reference"
property
"message-reference" guint : Read / Write
Represents the D-Bus property "MessageReference".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "number"
property
"number" gchar* : Read / Write
Represents the D-Bus property "Number".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
The "pdu-type"
property
"pdu-type" guint : Read / Write
Represents the D-Bus property "PduType".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "smsc"
property
"smsc" gchar* : Read / Write
Represents the D-Bus property "SMSC".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
The "state"
property
"state" guint : Read / Write
Represents the D-Bus property "State".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "storage"
property
"storage" guint : Read / Write
Represents the D-Bus property "Storage".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: 0
The "text"
property
"text" gchar* : Read / Write
Represents the D-Bus property "Text".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
The "timestamp"
property
"timestamp" gchar* : Read / Write
Represents the D-Bus property "Timestamp".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Default value: NULL
The "validity"
property
"validity" GVariant* : Read / Write
Represents the D-Bus property "Validity".
Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.
Allowed values: GVariant<(uv)>
Default value: NULL
Signal Details
The "handle-send"
signal
gboolean user_function (MmGdbusSms *object,
GDBusMethodInvocation *invocation,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Send()
If a signal handler returns TRUE
, it means the signal handler will handle the invocation (e.g. take a reference to invocation
and eventually call mm_gdbus_sms_complete_send()
or e.g. g_dbus_method_invocation_return_error()
on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD
error is returned.
|
A MmGdbusSms. |
|
A GDBusMethodInvocation. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |
The "handle-store"
signal
gboolean user_function (MmGdbusSms *object,
GDBusMethodInvocation *invocation,
guint arg_storage,
gpointer user_data) : Run Last
Signal emitted when a remote caller is invoking the Store()
If a signal handler returns TRUE
, it means the signal handler will handle the invocation (e.g. take a reference to invocation
and eventually call mm_gdbus_sms_complete_store()
or e.g. g_dbus_method_invocation_return_error()
on it) and no order signal handlers will run. If no signal handler handles the invocation, the G_DBUS_ERROR_UNKNOWN_METHOD
error is returned.
|
A MmGdbusSms. |
|
A GDBusMethodInvocation. |
|
Argument passed by remote caller. |
|
user data set when the signal handler was connected. |
Returns : |
TRUE if the invocation was handled, FALSE to let other signal handlers run. |