Share via


SubscriptionManager.CreateSubscriptionGroup(IList<Integer>) Method

Definition

Inform SubscriptionManager that subscriptions in the list are bundled as a group.

[Android.Runtime.Register("createSubscriptionGroup", "(Ljava/util/List;)Landroid/os/ParcelUuid;", "GetCreateSubscriptionGroup_Ljava_util_List_Handler", ApiSince=29)]
[Android.Runtime.RequiresPermission("android.permission.MODIFY_PHONE_STATE")]
public virtual Android.OS.ParcelUuid CreateSubscriptionGroup (System.Collections.Generic.IList<Java.Lang.Integer> subIdList);
[<Android.Runtime.Register("createSubscriptionGroup", "(Ljava/util/List;)Landroid/os/ParcelUuid;", "GetCreateSubscriptionGroup_Ljava_util_List_Handler", ApiSince=29)>]
[<Android.Runtime.RequiresPermission("android.permission.MODIFY_PHONE_STATE")>]
abstract member CreateSubscriptionGroup : System.Collections.Generic.IList<Java.Lang.Integer> -> Android.OS.ParcelUuid
override this.CreateSubscriptionGroup : System.Collections.Generic.IList<Java.Lang.Integer> -> Android.OS.ParcelUuid

Parameters

subIdList
IList<Integer>

list of subId that will be in the same group

Returns

groupUUID a UUID assigned to the subscription group.

Attributes

Remarks

Inform SubscriptionManager that subscriptions in the list are bundled as a group. It can be multiple primary (non-opportunistic) subscriptions, or one or more primary plus one or more opportunistic subscriptions.

This API will always create a new immutable group and assign group UUID to all the subscriptions, regardless whether they are in a group already or not.

Grouped subscriptions will have below behaviors: 1) They will share the same user settings. 2) The opportunistic subscriptions in the group is considered invisible and will not return from #getActiveSubscriptionInfoList(), unless caller has carrier privilege permission of the subscriptions. 3) The opportunistic subscriptions in the group can't be active by itself. If all other non-opportunistic ones are deactivated (unplugged or disabled in Settings), the opportunistic ones will be deactivated automatically.

Caller will either have android.Manifest.permission#MODIFY_PHONE_STATE permission or had carrier privilege permission on the subscriptions: TelephonyManager#hasCarrierPrivileges() or #canManageSubscription(SubscriptionInfo)

Java documentation for android.telephony.SubscriptionManager.createSubscriptionGroup(java.util.List<java.lang.Integer>).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to