The List() method

List (OUT aa{sv} profiles);

Lists the available profiles or contexts provisioned on the modem.

Profiles are represented as dictionaries of properties, and any of the 3GPP-specific properties defined in the bearer properties are allowed.

Depending on the implementation, the settings applicable to the initial EPS bearer given in bearer properties may also be reported as an item in the returned list, identified by the MM_BEARER_APN_TYPE_INITIAL "apn-type" flag.

Since: 1.18

The Set() method

Set (IN  a{sv} requested_properties,
     OUT a{sv} stored_properties);

Creates or updates a connection profile on this modem, depending on whether the expected index field is given or not. If not given, a new profile will be created; otherwise, the profile with the given index will be updated.

Profiles are represented as dictionaries of properties, and any of the 3GPP-specific properties defined in the bearer properties are allowed. The real list of supported properties really depends on the underlying protocol and implementation, though; e.g. in AT-based modems setting "apn-type" won't be supported, and instead the user should give that setting explicitly when creating the bearer object.

The operation may fail if it is attempting to update an existing profile for which connected bearer objects already exist. In this case, the user should make sure these bearer objects are already disconnected before attempting to change the profile settings.

The operation may also fail if it is attempting to update the profile associated to the settings of the initial EPS bearer, identified by the MM_BEARER_APN_TYPE_INITIAL "apn-type" flag. In this case, SetInitialEpsBearerSettings() should be used instead.

The output stored_properties will contain the settings that were successfully stored, including the new "profile-id" if the operation was creating a new profile.

Since: 1.18

The Delete() method

Delete (IN  a{sv} properties);

Deletes the profile with the index field given in properties.

If additional settings are given in properties they are ignored. This allows the user to easily request the deletion of a profile that has been provided in the List() operation.

This method may just clear the existing profiles (i.e. reseting all the properties to defaults) instead of fully removing them if the profiles cannot be fully removed. In this case, the method will succeed, but the size of the list of profiles will not change.

This method will fail if the expected index field is not given.

The operation may fail if it is attempting to delete a profile for which connected bearer objects already exist. In this case, the user should make sure these bearer objects are already disconnected before attempting to delete the profile.

The operation may also fail if it is attempting to delete the profile associated to the settings of the initial EPS bearer, identified by the MM_BEARER_APN_TYPE_INITIAL "apn-type" flag. In this case, SetInitialEpsBearerSettings() may be used instead to clear these settings.

Since: 1.18

The "Updated" signal

Updated ();

Emitted when the profiles are updated by the network through OTA procedures.

Since: 1.18

The "IndexField" property

IndexField  readable   s

Indicates which field should be considered as unique index, depending on the underlying protocol.

This will be 'profile-id' by default for all implementations, and only set to 'apn-type' for MBIM devices implementing the Microsoft profile management interface extensions.

Since: 1.20