Top |
MMSimpleConnectPropertiesMMSimpleConnectProperties — Helper object to handle connection properties. |
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()
.
MMSimpleConnectProperties *
mm_simple_connect_properties_new (void
);
Creates a new empty MMSimpleConnectProperties.
a MMSimpleConnectProperties. The returned value should be freed with g_object_unref()
.
[transfer full]
Since: 1.0
const gchar *
mm_simple_connect_properties_get_pin (MMSimpleConnectProperties *self
);
Gets the PIN code to use when unlocking the modem.
the PIN, or NULL if not set. Do not free the
returned value, it is owned by self
.
[transfer none]
Since: 1.0
void mm_simple_connect_properties_set_pin (MMSimpleConnectProperties *self
,const gchar *pin
);
Sets the PIN code to use when unlocking the modem.
Since: 1.0
const gchar *
mm_simple_connect_properties_get_operator_id
(MMSimpleConnectProperties *self
);
Gets the ID of the network to which register before connecting.
the operator ID, or NULL if not set. Do not free
the returned value, it is owned by self
.
[transfer none]
Since: 1.0
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.
Since: 1.0
const gchar *
mm_simple_connect_properties_get_apn (MMSimpleConnectProperties *self
);
Gets the name of the access point to use when connecting.
the access point, or NULL if not set. Do not free
the returned value, it is owned by self
.
[transfer none]
Since: 1.0
void mm_simple_connect_properties_set_apn (MMSimpleConnectProperties *self
,const gchar *apn
);
Sets the name of the access point to use when connecting.
Since: 1.0
MMBearerApnType
mm_simple_connect_properties_get_apn_type
(MMSimpleConnectProperties *self
);
Gets the APN types to use.
Since: 1.18
void mm_simple_connect_properties_set_apn_type (MMSimpleConnectProperties *self
,MMBearerApnType apn_type
);
Sets the APN types to use.
Since: 1.18
MMBearerAllowedAuth
mm_simple_connect_properties_get_allowed_auth
(MMSimpleConnectProperties *self
);
Gets the authentication methods allowed in the connection.
a bitmask of MMBearerAllowedAuth values, or
MM_BEARER_ALLOWED_AUTH_UNKNOWN
to request the modem-default method.
Since: 1.0
void mm_simple_connect_properties_set_allowed_auth (MMSimpleConnectProperties *self
,MMBearerAllowedAuth allowed_auth
);
Sets the authentication method to use.
self |
||
allowed_auth |
a bitmask of MMBearerAllowedAuth values.
|
Since: 1.0
const gchar *
mm_simple_connect_properties_get_user (MMSimpleConnectProperties *self
);
Gets the username used to authenticate with the access point.
the username, or NULL if not set. Do not free the
returned value, it is owned by self
.
[transfer none]
Since: 1.0
void mm_simple_connect_properties_set_user (MMSimpleConnectProperties *self
,const gchar *user
);
Sets the username used to authenticate with the access point.
Since: 1.0
const gchar *
mm_simple_connect_properties_get_password
(MMSimpleConnectProperties *self
);
Gets the password used to authenticate with the access point.
the password, or NULL if not set. Do not free the
returned value, it is owned by self
.
[transfer none]
Since: 1.0
void mm_simple_connect_properties_set_password (MMSimpleConnectProperties *self
,const gchar *password
);
Sets the password used to authenticate with the access point.
Since: 1.0
MMBearerIpFamily
mm_simple_connect_properties_get_ip_type
(MMSimpleConnectProperties *self
);
Sets the IP type to use.
Since: 1.0
void mm_simple_connect_properties_set_ip_type (MMSimpleConnectProperties *self
,MMBearerIpFamily ip_type
);
Sets the IP type to use.
Since: 1.0
gint
mm_simple_connect_properties_get_profile_id
(MMSimpleConnectProperties *self
);
Gets the profile ID to use.
Since: 1.18
void mm_simple_connect_properties_set_profile_id (MMSimpleConnectProperties *self
,gint profile_id
);
Sets the profile ID to use.
Since: 1.18
gboolean
mm_simple_connect_properties_get_allow_roaming
(MMSimpleConnectProperties *self
);
Checks whether roaming is allowed in the connection.
Since: 1.0
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.
Since: 1.0
MMModemCdmaRmProtocol
mm_simple_connect_properties_get_rm_protocol
(MMSimpleConnectProperties *self
);
Get the RM protocol requested by the user.
Since: 1.16
void mm_simple_connect_properties_set_rm_protocol (MMSimpleConnectProperties *self
,MMModemCdmaRmProtocol protocol
);
Sets the RM protocol requested by the user.
Since: 1.16
MMBearerMultiplexSupport
mm_simple_connect_properties_get_multiplex
(MMSimpleConnectProperties *self
);
Get the multiplex support requested by the user.
Since: 1.18
void mm_simple_connect_properties_set_multiplex (MMSimpleConnectProperties *self
,MMBearerMultiplexSupport multiplex
);
Sets the multiplex support requested by the user.
Since: 1.18
struct MMSimpleConnectProperties;
The MMSimpleConnectProperties structure contains private data and should only be accessed using the provided API.