xref: /aosp_15_r20/prebuilts/sdk/33/module-lib/api/framework-connectivity.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b) 
1// Signature format: 2.0
2package android.net {
3
4  public final class ConnectivityFrameworkInitializer {
5    method public static void registerServiceWrappers();
6  }
7
8  public class ConnectivityManager {
9    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void addUidToMeteredNetworkAllowList(int);
10    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void addUidToMeteredNetworkDenyList(int);
11    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void factoryReset();
12    method @NonNull @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public java.util.List<android.net.NetworkStateSnapshot> getAllNetworkStateSnapshots();
13    method @Nullable public android.net.ProxyInfo getGlobalProxy();
14    method @NonNull public static android.util.Range<java.lang.Integer> getIpSecNetIdRange();
15    method @Nullable @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public android.net.LinkProperties getRedactedLinkPropertiesForPackage(@NonNull android.net.LinkProperties, int, @NonNull String);
16    method @Nullable @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public android.net.NetworkCapabilities getRedactedNetworkCapabilitiesForPackage(@NonNull android.net.NetworkCapabilities, int, @NonNull String);
17    method @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public void registerDefaultNetworkCallbackForUid(int, @NonNull android.net.ConnectivityManager.NetworkCallback, @NonNull android.os.Handler);
18    method @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public void registerSystemDefaultNetworkCallback(@NonNull android.net.ConnectivityManager.NetworkCallback, @NonNull android.os.Handler);
19    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void removeUidFromMeteredNetworkAllowList(int);
20    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void removeUidFromMeteredNetworkDenyList(int);
21    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void replaceFirewallChain(int, @NonNull int[]);
22    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void requestBackgroundNetwork(@NonNull android.net.NetworkRequest, @NonNull android.net.ConnectivityManager.NetworkCallback, @NonNull android.os.Handler);
23    method @Deprecated public boolean requestRouteToHostAddress(int, java.net.InetAddress);
24    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_SETUP_WIZARD, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void setAcceptPartialConnectivity(@NonNull android.net.Network, boolean, boolean);
25    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_SETUP_WIZARD, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void setAcceptUnvalidated(@NonNull android.net.Network, boolean, boolean);
26    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_SETUP_WIZARD, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void setAvoidUnvalidated(@NonNull android.net.Network);
27    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void setFirewallChainEnabled(int, boolean);
28    method @RequiresPermission(android.Manifest.permission.NETWORK_STACK) public void setGlobalProxy(@Nullable android.net.ProxyInfo);
29    method @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public void setLegacyLockdownVpnEnabled(boolean);
30    method @Deprecated @RequiresPermission(android.Manifest.permission.NETWORK_STACK) public void setProfileNetworkPreference(@NonNull android.os.UserHandle, int, @Nullable java.util.concurrent.Executor, @Nullable Runnable);
31    method @RequiresPermission(android.Manifest.permission.NETWORK_STACK) public void setProfileNetworkPreferences(@NonNull android.os.UserHandle, @NonNull java.util.List<android.net.ProfileNetworkPreference>, @Nullable java.util.concurrent.Executor, @Nullable Runnable);
32    method @RequiresPermission(anyOf={android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK, android.Manifest.permission.NETWORK_STACK, android.Manifest.permission.NETWORK_SETTINGS}) public void setRequireVpnForUids(boolean, @NonNull java.util.Collection<android.util.Range<java.lang.Integer>>);
33    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void setUidFirewallRule(int, int, int);
34    method @RequiresPermission(anyOf={android.Manifest.permission.MANAGE_TEST_NETWORKS, android.Manifest.permission.NETWORK_STACK}) public void simulateDataStall(int, long, @NonNull android.net.Network, @NonNull android.os.PersistableBundle);
35    method @RequiresPermission(anyOf={android.Manifest.permission.NETWORK_SETTINGS, android.Manifest.permission.NETWORK_STACK, android.net.NetworkStack.PERMISSION_MAINLINE_NETWORK_STACK}) public void startCaptivePortalApp(@NonNull android.net.Network);
36    method public void systemReady();
37    field public static final String ACTION_CLEAR_DNS_CACHE = "android.net.action.CLEAR_DNS_CACHE";
38    field public static final String ACTION_PROMPT_LOST_VALIDATION = "android.net.action.PROMPT_LOST_VALIDATION";
39    field public static final String ACTION_PROMPT_PARTIAL_CONNECTIVITY = "android.net.action.PROMPT_PARTIAL_CONNECTIVITY";
40    field public static final String ACTION_PROMPT_UNVALIDATED = "android.net.action.PROMPT_UNVALIDATED";
41    field public static final int BLOCKED_METERED_REASON_ADMIN_DISABLED = 262144; // 0x40000
42    field public static final int BLOCKED_METERED_REASON_DATA_SAVER = 65536; // 0x10000
43    field public static final int BLOCKED_METERED_REASON_MASK = -65536; // 0xffff0000
44    field public static final int BLOCKED_METERED_REASON_USER_RESTRICTED = 131072; // 0x20000
45    field public static final int BLOCKED_REASON_APP_STANDBY = 4; // 0x4
46    field public static final int BLOCKED_REASON_BATTERY_SAVER = 1; // 0x1
47    field public static final int BLOCKED_REASON_DOZE = 2; // 0x2
48    field public static final int BLOCKED_REASON_LOCKDOWN_VPN = 16; // 0x10
49    field public static final int BLOCKED_REASON_LOW_POWER_STANDBY = 32; // 0x20
50    field public static final int BLOCKED_REASON_NONE = 0; // 0x0
51    field public static final int BLOCKED_REASON_RESTRICTED_MODE = 8; // 0x8
52    field public static final int FIREWALL_CHAIN_DOZABLE = 1; // 0x1
53    field public static final int FIREWALL_CHAIN_LOW_POWER_STANDBY = 5; // 0x5
54    field public static final int FIREWALL_CHAIN_POWERSAVE = 3; // 0x3
55    field public static final int FIREWALL_CHAIN_RESTRICTED = 4; // 0x4
56    field public static final int FIREWALL_CHAIN_STANDBY = 2; // 0x2
57    field public static final int FIREWALL_RULE_ALLOW = 1; // 0x1
58    field public static final int FIREWALL_RULE_DEFAULT = 0; // 0x0
59    field public static final int FIREWALL_RULE_DENY = 2; // 0x2
60    field public static final int PROFILE_NETWORK_PREFERENCE_DEFAULT = 0; // 0x0
61    field public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE = 1; // 0x1
62    field public static final int PROFILE_NETWORK_PREFERENCE_ENTERPRISE_NO_FALLBACK = 2; // 0x2
63  }
64
65  public static class ConnectivityManager.NetworkCallback {
66    method public void onBlockedStatusChanged(@NonNull android.net.Network, int);
67  }
68
69  public class ConnectivitySettingsManager {
70    method public static void clearGlobalProxy(@NonNull android.content.Context);
71    method @Nullable public static String getCaptivePortalHttpUrl(@NonNull android.content.Context);
72    method public static int getCaptivePortalMode(@NonNull android.content.Context, int);
73    method @NonNull public static java.time.Duration getConnectivityKeepPendingIntentDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
74    method @NonNull public static android.util.Range<java.lang.Integer> getDnsResolverSampleRanges(@NonNull android.content.Context);
75    method @NonNull public static java.time.Duration getDnsResolverSampleValidityDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
76    method public static int getDnsResolverSuccessThresholdPercent(@NonNull android.content.Context, int);
77    method @Nullable public static android.net.ProxyInfo getGlobalProxy(@NonNull android.content.Context);
78    method public static long getIngressRateLimitInBytesPerSecond(@NonNull android.content.Context);
79    method @NonNull public static java.time.Duration getMobileDataActivityTimeout(@NonNull android.content.Context, @NonNull java.time.Duration);
80    method public static boolean getMobileDataAlwaysOn(@NonNull android.content.Context, boolean);
81    method @NonNull public static java.util.Set<java.lang.Integer> getMobileDataPreferredUids(@NonNull android.content.Context);
82    method public static int getNetworkAvoidBadWifi(@NonNull android.content.Context);
83    method @Nullable public static String getNetworkMeteredMultipathPreference(@NonNull android.content.Context);
84    method public static int getNetworkSwitchNotificationMaximumDailyCount(@NonNull android.content.Context, int);
85    method @NonNull public static java.time.Duration getNetworkSwitchNotificationRateDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
86    method @NonNull public static String getPrivateDnsDefaultMode(@NonNull android.content.Context);
87    method @Nullable public static String getPrivateDnsHostname(@NonNull android.content.Context);
88    method public static int getPrivateDnsMode(@NonNull android.content.Context);
89    method @NonNull public static java.util.Set<java.lang.Integer> getUidsAllowedOnRestrictedNetworks(@NonNull android.content.Context);
90    method public static boolean getWifiAlwaysRequested(@NonNull android.content.Context, boolean);
91    method @NonNull public static java.time.Duration getWifiDataActivityTimeout(@NonNull android.content.Context, @NonNull java.time.Duration);
92    method public static void setCaptivePortalHttpUrl(@NonNull android.content.Context, @Nullable String);
93    method public static void setCaptivePortalMode(@NonNull android.content.Context, int);
94    method public static void setConnectivityKeepPendingIntentDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
95    method public static void setDnsResolverSampleRanges(@NonNull android.content.Context, @NonNull android.util.Range<java.lang.Integer>);
96    method public static void setDnsResolverSampleValidityDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
97    method public static void setDnsResolverSuccessThresholdPercent(@NonNull android.content.Context, @IntRange(from=0, to=100) int);
98    method public static void setGlobalProxy(@NonNull android.content.Context, @NonNull android.net.ProxyInfo);
99    method public static void setIngressRateLimitInBytesPerSecond(@NonNull android.content.Context, @IntRange(from=-1L, to=4294967295L) long);
100    method public static void setMobileDataActivityTimeout(@NonNull android.content.Context, @NonNull java.time.Duration);
101    method public static void setMobileDataAlwaysOn(@NonNull android.content.Context, boolean);
102    method public static void setMobileDataPreferredUids(@NonNull android.content.Context, @NonNull java.util.Set<java.lang.Integer>);
103    method public static void setNetworkAvoidBadWifi(@NonNull android.content.Context, int);
104    method public static void setNetworkMeteredMultipathPreference(@NonNull android.content.Context, @NonNull String);
105    method public static void setNetworkSwitchNotificationMaximumDailyCount(@NonNull android.content.Context, @IntRange(from=0) int);
106    method public static void setNetworkSwitchNotificationRateDuration(@NonNull android.content.Context, @NonNull java.time.Duration);
107    method public static void setPrivateDnsDefaultMode(@NonNull android.content.Context, @NonNull int);
108    method public static void setPrivateDnsHostname(@NonNull android.content.Context, @Nullable String);
109    method public static void setPrivateDnsMode(@NonNull android.content.Context, int);
110    method public static void setUidsAllowedOnRestrictedNetworks(@NonNull android.content.Context, @NonNull java.util.Set<java.lang.Integer>);
111    method public static void setWifiAlwaysRequested(@NonNull android.content.Context, boolean);
112    method public static void setWifiDataActivityTimeout(@NonNull android.content.Context, @NonNull java.time.Duration);
113    field public static final int CAPTIVE_PORTAL_MODE_AVOID = 2; // 0x2
114    field public static final int CAPTIVE_PORTAL_MODE_IGNORE = 0; // 0x0
115    field public static final int CAPTIVE_PORTAL_MODE_PROMPT = 1; // 0x1
116    field public static final int NETWORK_AVOID_BAD_WIFI_AVOID = 2; // 0x2
117    field public static final int NETWORK_AVOID_BAD_WIFI_IGNORE = 0; // 0x0
118    field public static final int NETWORK_AVOID_BAD_WIFI_PROMPT = 1; // 0x1
119    field public static final int PRIVATE_DNS_MODE_OFF = 1; // 0x1
120    field public static final int PRIVATE_DNS_MODE_OPPORTUNISTIC = 2; // 0x2
121    field public static final int PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = 3; // 0x3
122  }
123
124  public final class DhcpOption implements android.os.Parcelable {
125    ctor public DhcpOption(byte, @Nullable byte[]);
126    method public int describeContents();
127    method public byte getType();
128    method @Nullable public byte[] getValue();
129    method public void writeToParcel(@NonNull android.os.Parcel, int);
130    field @NonNull public static final android.os.Parcelable.Creator<android.net.DhcpOption> CREATOR;
131  }
132
133  public final class NetworkAgentConfig implements android.os.Parcelable {
134    method @Nullable public String getSubscriberId();
135    method public boolean isBypassableVpn();
136    method public boolean isVpnValidationRequired();
137  }
138
139  public static final class NetworkAgentConfig.Builder {
140    method @NonNull public android.net.NetworkAgentConfig.Builder setBypassableVpn(boolean);
141    method @NonNull public android.net.NetworkAgentConfig.Builder setLocalRoutesExcludedForVpn(boolean);
142    method @NonNull public android.net.NetworkAgentConfig.Builder setSubscriberId(@Nullable String);
143    method @NonNull public android.net.NetworkAgentConfig.Builder setVpnRequiresValidation(boolean);
144  }
145
146  public final class NetworkCapabilities implements android.os.Parcelable {
147    method @NonNull @RequiresPermission(android.Manifest.permission.NETWORK_FACTORY) public java.util.Set<java.lang.Integer> getAllowedUids();
148    method @Nullable public java.util.Set<android.util.Range<java.lang.Integer>> getUids();
149    method public boolean hasForbiddenCapability(int);
150    field public static final long REDACT_ALL = -1L; // 0xffffffffffffffffL
151    field public static final long REDACT_FOR_ACCESS_FINE_LOCATION = 1L; // 0x1L
152    field public static final long REDACT_FOR_LOCAL_MAC_ADDRESS = 2L; // 0x2L
153    field public static final long REDACT_FOR_NETWORK_SETTINGS = 4L; // 0x4L
154    field public static final long REDACT_NONE = 0L; // 0x0L
155    field public static final int TRANSPORT_TEST = 7; // 0x7
156  }
157
158  public static final class NetworkCapabilities.Builder {
159    method @NonNull @RequiresPermission(android.Manifest.permission.NETWORK_FACTORY) public android.net.NetworkCapabilities.Builder setAllowedUids(@NonNull java.util.Set<java.lang.Integer>);
160    method @NonNull public android.net.NetworkCapabilities.Builder setUids(@Nullable java.util.Set<android.util.Range<java.lang.Integer>>);
161  }
162
163  public class NetworkRequest implements android.os.Parcelable {
164    method @NonNull public int[] getEnterpriseIds();
165    method @NonNull public int[] getForbiddenCapabilities();
166    method public boolean hasEnterpriseId(int);
167    method public boolean hasForbiddenCapability(int);
168  }
169
170  public static class NetworkRequest.Builder {
171    method @NonNull public android.net.NetworkRequest.Builder addForbiddenCapability(int);
172    method @NonNull public android.net.NetworkRequest.Builder removeForbiddenCapability(int);
173    method @NonNull public android.net.NetworkRequest.Builder setUids(@Nullable java.util.Set<android.util.Range<java.lang.Integer>>);
174  }
175
176  public final class ProfileNetworkPreference implements android.os.Parcelable {
177    method public int describeContents();
178    method @NonNull public int[] getExcludedUids();
179    method @NonNull public int[] getIncludedUids();
180    method public int getPreference();
181    method public int getPreferenceEnterpriseId();
182    method public void writeToParcel(@NonNull android.os.Parcel, int);
183    field @NonNull public static final android.os.Parcelable.Creator<android.net.ProfileNetworkPreference> CREATOR;
184  }
185
186  public static final class ProfileNetworkPreference.Builder {
187    ctor public ProfileNetworkPreference.Builder();
188    method @NonNull public android.net.ProfileNetworkPreference build();
189    method @NonNull public android.net.ProfileNetworkPreference.Builder setExcludedUids(@NonNull int[]);
190    method @NonNull public android.net.ProfileNetworkPreference.Builder setIncludedUids(@NonNull int[]);
191    method @NonNull public android.net.ProfileNetworkPreference.Builder setPreference(int);
192    method @NonNull public android.net.ProfileNetworkPreference.Builder setPreferenceEnterpriseId(int);
193  }
194
195  public final class TestNetworkInterface implements android.os.Parcelable {
196    ctor public TestNetworkInterface(@NonNull android.os.ParcelFileDescriptor, @NonNull String);
197    method public int describeContents();
198    method @NonNull public android.os.ParcelFileDescriptor getFileDescriptor();
199    method @NonNull public String getInterfaceName();
200    method public void writeToParcel(@NonNull android.os.Parcel, int);
201    field @NonNull public static final android.os.Parcelable.Creator<android.net.TestNetworkInterface> CREATOR;
202  }
203
204  public class TestNetworkManager {
205    method @NonNull @RequiresPermission(android.Manifest.permission.MANAGE_TEST_NETWORKS) public android.net.TestNetworkInterface createTapInterface();
206    method @NonNull @RequiresPermission(android.Manifest.permission.MANAGE_TEST_NETWORKS) public android.net.TestNetworkInterface createTunInterface(@NonNull java.util.Collection<android.net.LinkAddress>);
207    method @RequiresPermission(android.Manifest.permission.MANAGE_TEST_NETWORKS) public void setupTestNetwork(@NonNull String, @NonNull android.os.IBinder);
208    method @RequiresPermission(android.Manifest.permission.MANAGE_TEST_NETWORKS) public void teardownTestNetwork(@NonNull android.net.Network);
209    field public static final String TEST_TAP_PREFIX = "testtap";
210  }
211
212  public final class TestNetworkSpecifier extends android.net.NetworkSpecifier implements android.os.Parcelable {
213    ctor public TestNetworkSpecifier(@NonNull String);
214    method public int describeContents();
215    method @Nullable public String getInterfaceName();
216    method public void writeToParcel(@NonNull android.os.Parcel, int);
217    field @NonNull public static final android.os.Parcelable.Creator<android.net.TestNetworkSpecifier> CREATOR;
218  }
219
220  public interface TransportInfo {
221    method public default long getApplicableRedactions();
222    method @NonNull public default android.net.TransportInfo makeCopy(long);
223  }
224
225  public final class VpnTransportInfo implements android.os.Parcelable android.net.TransportInfo {
226    ctor public VpnTransportInfo(int, @Nullable String);
227    method public int describeContents();
228    method @Nullable public String getSessionId();
229    method public int getType();
230    method @NonNull public android.net.VpnTransportInfo makeCopy(long);
231    method public void writeToParcel(@NonNull android.os.Parcel, int);
232    field @NonNull public static final android.os.Parcelable.Creator<android.net.VpnTransportInfo> CREATOR;
233  }
234
235}
236
237