|  |  |  | libmm-glib Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
| MMSimpleConnectPropertiesMMSimpleConnectProperties — Helper object to handle connection properties. | 
struct MMSimpleConnectProperties; MMSimpleConnectProperties * mm_simple_connect_properties_new (void); const gchar * mm_simple_connect_properties_get_pin (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_pin (MMSimpleConnectProperties *self,const gchar *pin); const gchar * mm_simple_connect_properties_get_operator_id (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_operator_id (MMSimpleConnectProperties *self,const gchar *operator_id); const gchar * mm_simple_connect_properties_get_apn (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_apn (MMSimpleConnectProperties *self,const gchar *apn); MMBearerAllowedAuth mm_simple_connect_properties_get_allowed_auth (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_allowed_auth (MMSimpleConnectProperties *self,MMBearerAllowedAuth allowed_auth); const gchar * mm_simple_connect_properties_get_user (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_user (MMSimpleConnectProperties *self,const gchar *user); const gchar * mm_simple_connect_properties_get_password (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_password (MMSimpleConnectProperties *self,const gchar *password); MMBearerIpFamily mm_simple_connect_properties_get_ip_type (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_ip_type (MMSimpleConnectProperties *self,MMBearerIpFamily ip_type); gboolean mm_simple_connect_properties_get_allow_roaming (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_allow_roaming (MMSimpleConnectProperties *self,gboolean allow_roaming); const gchar * mm_simple_connect_properties_get_number (MMSimpleConnectProperties *self); void mm_simple_connect_properties_set_number (MMSimpleConnectProperties *self,const gchar *number);
The MMSimpleConnectProperties is an object handling the properties requested to ModemManager when launching a connection with the Simple interface.
This object is created by the user and passed to ModemManager with either
mm_modem_simple_connect() or mm_modem_simple_connect_sync().
struct MMSimpleConnectProperties;
The MMSimpleConnectProperties structure contains private data and should only be accessed using the provided API.
MMSimpleConnectProperties * mm_simple_connect_properties_new
                                                        (void);
Creates a new empty MMSimpleConnectProperties.
| Returns : | a MMSimpleConnectProperties. The returned value should be freed with g_object_unref(). [transfer full] | 
const gchar *       mm_simple_connect_properties_get_pin
                                                        (MMSimpleConnectProperties *self);
Gets the PIN code to use when unlocking the modem.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the PIN, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_pin (MMSimpleConnectProperties *self,const gchar *pin);
Sets the PIN code to use when unlocking the modem.
| 
 | a MMSimpleConnectProperties. | 
| 
 | PIN code. | 
const gchar *       mm_simple_connect_properties_get_operator_id
                                                        (MMSimpleConnectProperties *self);
Gets the ID of the network to which register before connecting.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the operator ID, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_operator_id (MMSimpleConnectProperties *self,const gchar *operator_id);
Sets the ID of the network to which register before connecting.
| 
 | a MMSimpleConnectProperties. | 
| 
 | operator ID, given as MCC/MNC. | 
const gchar *       mm_simple_connect_properties_get_apn
                                                        (MMSimpleConnectProperties *self);
Gets the name of the access point to use when connecting.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the access point, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_apn (MMSimpleConnectProperties *self,const gchar *apn);
Sets the name of the access point to use when connecting.
| 
 | a MMSimpleConnectProperties. | 
| 
 | Name of the access point. | 
MMBearerAllowedAuth mm_simple_connect_properties_get_allowed_auth
                                                        (MMSimpleConnectProperties *self);
Gets the authentication methods allowed in the connection.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | a bitmask of MMBearerAllowedAuth values, or MM_BEARER_ALLOWED_AUTH_UNKNOWNto request the modem-default method. | 
void mm_simple_connect_properties_set_allowed_auth (MMSimpleConnectProperties *self,MMBearerAllowedAuth allowed_auth);
Sets the authentication method to use.
| 
 | a MMSimpleConnectProperties. | 
| 
 | a bitmask of MMBearerAllowedAuth values. MM_BEARER_ALLOWED_AUTH_UNKNOWNmay be given to request the modem-default method. | 
const gchar *       mm_simple_connect_properties_get_user
                                                        (MMSimpleConnectProperties *self);
Gets the username used to authenticate with the access point.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the username, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_user (MMSimpleConnectProperties *self,const gchar *user);
Sets the username used to authenticate with the access point.
| 
 | a MMSimpleConnectProperties. | 
| 
 | the username | 
const gchar *       mm_simple_connect_properties_get_password
                                                        (MMSimpleConnectProperties *self);
Gets the password used to authenticate with the access point.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the password, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_password (MMSimpleConnectProperties *self,const gchar *password);
Sets the password used to authenticate with the access point.
| 
 | a MMSimpleConnectProperties. | 
| 
 | the password | 
MMBearerIpFamily    mm_simple_connect_properties_get_ip_type
                                                        (MMSimpleConnectProperties *self);
Sets the IP type to use.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | a MMBearerIpFamily. | 
void mm_simple_connect_properties_set_ip_type (MMSimpleConnectProperties *self,MMBearerIpFamily ip_type);
Sets the IP type to use.
| 
 | a MMSimpleConnectProperties. | 
| 
 | a MMBearerIpFamily. | 
gboolean            mm_simple_connect_properties_get_allow_roaming
                                                        (MMSimpleConnectProperties *self);
Checks whether roaming is allowed in the connection.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | TRUEif roaming is allowed,FALSEotherwise.. | 
void mm_simple_connect_properties_set_allow_roaming (MMSimpleConnectProperties *self,gboolean allow_roaming);
Sets the flag to indicate whether roaming is allowed or not in the connection.
| 
 | a MMSimpleConnectProperties. | 
| 
 | boolean value. | 
const gchar *       mm_simple_connect_properties_get_number
                                                        (MMSimpleConnectProperties *self);
Gets the number to use when performing the connection.
| 
 | a MMSimpleConnectProperties. | 
| Returns : | the number, or NULL if not set. Do not free the returned value, it is owned by self. [transfer none] | 
void mm_simple_connect_properties_set_number (MMSimpleConnectProperties *self,const gchar *number);
Sets the number to use when performing the connection.
| 
 | a MMSimpleConnectProperties. | 
| 
 | the number. |