1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.systemui.statusbar.pipeline.mobile.data.model
18 
19 import android.os.ParcelUuid
20 import android.telephony.SubscriptionManager.ProfileClass
21 
22 /**
23  * SystemUI representation of [SubscriptionInfo]. Currently we only use two fields on the
24  * subscriptions themselves: subscriptionId and isOpportunistic. Any new fields that we need can be
25  * added below and provided in the repository classes
26  */
27 data class SubscriptionModel(
28     val subscriptionId: Int,
29     /**
30      * True if the subscription that this model represents has [SubscriptionInfo.isOpportunistic].
31      * Opportunistic networks are networks with limited coverage, and we use this bit to determine
32      * filtering in certain cases. See [MobileIconsInteractor] for the filtering logic
33      */
34     val isOpportunistic: Boolean = false,
35 
36     /**
37      * True if this subscription **only** supports non-terrestrial networks (NTN) and false
38      * otherwise. (non-terrestrial == satellite)
39      *
40      * Note that we intend to filter these subscriptions out, because these connections are actually
41      * supported by
42      * [com.android.systemui.statusbar.pipeline.satellite.data.DeviceBasedSatelliteRepository]. See
43      * [com.android.systemui.statusbar.pipeline.mobile.domain.interactor.MobileIconsInteractor] for
44      * the filtering.
45      */
46     val isExclusivelyNonTerrestrial: Boolean = false,
47 
48     /** Subscriptions in the same group may be filtered or treated as a single subscription */
49     val groupUuid: ParcelUuid? = null,
50 
51     /** Text representing the name for this connection */
52     val carrierName: String,
53 
54     /** Allow us to filter out PROVISIONING profiles. See [SubscriptionInfo.getProfileClass] */
55     @ProfileClass val profileClass: Int
56 )
57