blob: 6666c8d276da55a637ecee2689e89aa69a858bcd [file] [log] [blame]
paulhu667e8fb2021-12-14 01:30:22 +00001// Signature format: 2.0
Remi NGUYEN VAN51935fc2022-01-07 13:18:54 +09002package android.nearby {
3
4 public class FastPairAccountKeyDeviceMetadata {
5 method @Nullable public byte[] getAccountKey();
6 method @Nullable public android.nearby.FastPairDeviceMetadata getFastPairDeviceMetadata();
7 method @Nullable public android.nearby.FastPairDiscoveryItem getFastPairDiscoveryItem();
8 method @Nullable public byte[] getSha256AccountKeyPublicAddress();
9 }
10
11 public static final class FastPairAccountKeyDeviceMetadata.Builder {
12 ctor public FastPairAccountKeyDeviceMetadata.Builder();
13 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata build();
14 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata.Builder setAccountKey(@Nullable byte[]);
15 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata.Builder setFastPairDeviceMetadata(@Nullable android.nearby.FastPairDeviceMetadata);
16 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata.Builder setFastPairDiscoveryItem(@Nullable android.nearby.FastPairDiscoveryItem);
17 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata.Builder setSha256AccountKeyPublicAddress(@Nullable byte[]);
18 }
19
20 public class FastPairAntispoofkeyDeviceMetadata {
21 }
22
23 public static final class FastPairAntispoofkeyDeviceMetadata.Builder {
24 ctor public FastPairAntispoofkeyDeviceMetadata.Builder();
25 method @NonNull public android.nearby.FastPairAntispoofkeyDeviceMetadata build();
26 method @NonNull public android.nearby.FastPairAntispoofkeyDeviceMetadata.Builder setAntiSpoofPublicKey(@Nullable byte[]);
27 method @NonNull public android.nearby.FastPairAntispoofkeyDeviceMetadata.Builder setFastPairDeviceMetadata(@Nullable android.nearby.FastPairDeviceMetadata);
28 }
29
30 public abstract class FastPairDataProviderBase {
31 ctor public FastPairDataProviderBase(@NonNull String);
32 method @Nullable public final android.os.IBinder getBinder();
33 method public abstract void onLoadFastPairAccountDevicesMetadata(@NonNull android.nearby.FastPairDataProviderBase.FastPairAccountDevicesMetadataRequest, @NonNull android.nearby.FastPairDataProviderBase.FastPairAccountDevicesMetadataCallback);
34 method public abstract void onLoadFastPairAntispoofkeyDeviceMetadata(@NonNull android.nearby.FastPairDataProviderBase.FastPairAntispoofkeyDeviceMetadataRequest, @NonNull android.nearby.FastPairDataProviderBase.FastPairAntispoofkeyDeviceMetadataCallback);
35 method public abstract void onLoadFastPairEligibleAccounts(@NonNull android.nearby.FastPairDataProviderBase.FastPairEligibleAccountsRequest, @NonNull android.nearby.FastPairDataProviderBase.FastPairEligibleAccountsCallback);
36 method public abstract void onManageFastPairAccount(@NonNull android.nearby.FastPairDataProviderBase.FastPairManageAccountRequest, @NonNull android.nearby.FastPairDataProviderBase.FastPairManageActionCallback);
37 method public abstract void onManageFastPairAccountDevice(@NonNull android.nearby.FastPairDataProviderBase.FastPairManageAccountDeviceRequest, @NonNull android.nearby.FastPairDataProviderBase.FastPairManageActionCallback);
38 field public static final String ACTION_FAST_PAIR_DATA_PROVIDER = "android.nearby.action.FAST_PAIR_DATA_PROVIDER";
39 field public static final int ERROR_CODE_BAD_REQUEST = 0; // 0x0
40 field public static final int ERROR_CODE_INTERNAL_ERROR = 1; // 0x1
41 field public static final int MANAGE_REQUEST_ADD = 0; // 0x0
42 field public static final int MANAGE_REQUEST_REMOVE = 1; // 0x1
43 }
44
45 public static interface FastPairDataProviderBase.FastPairAccountDevicesMetadataCallback {
46 method public void onError(int, @Nullable String);
47 method public void onFastPairAccountDevicesMetadataReceived(@NonNull java.util.Collection<android.nearby.FastPairAccountKeyDeviceMetadata>);
48 }
49
50 public static class FastPairDataProviderBase.FastPairAccountDevicesMetadataRequest {
51 method @NonNull public android.accounts.Account getAccount();
52 }
53
54 public static interface FastPairDataProviderBase.FastPairAntispoofkeyDeviceMetadataCallback {
55 method public void onError(int, @Nullable String);
56 method public void onFastPairAntispoofkeyDeviceMetadataReceived(@NonNull android.nearby.FastPairAntispoofkeyDeviceMetadata);
57 }
58
59 public static class FastPairDataProviderBase.FastPairAntispoofkeyDeviceMetadataRequest {
60 method @NonNull public byte[] getModelId();
61 }
62
63 public static interface FastPairDataProviderBase.FastPairEligibleAccountsCallback {
64 method public void onError(int, @Nullable String);
65 method public void onFastPairEligibleAccountsReceived(@NonNull java.util.Collection<android.nearby.FastPairEligibleAccount>);
66 }
67
68 public static class FastPairDataProviderBase.FastPairEligibleAccountsRequest {
69 }
70
71 public static class FastPairDataProviderBase.FastPairManageAccountDeviceRequest {
72 method @NonNull public android.accounts.Account getAccount();
73 method @NonNull public android.nearby.FastPairAccountKeyDeviceMetadata getAccountKeyDeviceMetadata();
74 method @Nullable public String getBleAddress();
75 method public int getRequestType();
76 }
77
78 public static class FastPairDataProviderBase.FastPairManageAccountRequest {
79 method @NonNull public android.accounts.Account getAccount();
80 method public int getRequestType();
81 }
82
83 public static interface FastPairDataProviderBase.FastPairManageActionCallback {
84 method public void onError(int, @Nullable String);
85 method public void onSuccess();
86 }
87
88 public class FastPairDeviceMetadata {
89 method @Nullable public String getAssistantSetupHalfSheet();
90 method @Nullable public String getAssistantSetupNotification();
91 method public int getBleTxPower();
92 method @Nullable public String getConfirmPinDescription();
93 method @Nullable public String getConfirmPinTitle();
94 method @Nullable public String getConnectSuccessCompanionAppInstalled();
95 method @Nullable public String getConnectSuccessCompanionAppNotInstalled();
96 method public int getDeviceType();
97 method @Nullable public String getDownloadCompanionAppDescription();
98 method @Nullable public String getFailConnectGoToSettingsDescription();
99 method @Nullable public String getFastPairTvConnectDeviceNoAccountDescription();
100 method @Nullable public byte[] getImage();
101 method @Nullable public String getImageUrl();
102 method @Nullable public String getInitialNotificationDescription();
103 method @Nullable public String getInitialNotificationDescriptionNoAccount();
104 method @Nullable public String getInitialPairingDescription();
105 method @Nullable public String getIntentUri();
106 method @Nullable public String getLocale();
107 method @Nullable public String getOpenCompanionAppDescription();
108 method @Nullable public String getRetroactivePairingDescription();
109 method @Nullable public String getSubsequentPairingDescription();
110 method @Nullable public String getSyncContactsDescription();
111 method @Nullable public String getSyncContactsTitle();
112 method @Nullable public String getSyncSmsDescription();
113 method @Nullable public String getSyncSmsTitle();
114 method public float getTriggerDistance();
115 method @Nullable public String getTrueWirelessImageUrlCase();
116 method @Nullable public String getTrueWirelessImageUrlLeftBud();
117 method @Nullable public String getTrueWirelessImageUrlRightBud();
118 method @Nullable public String getUnableToConnectDescription();
119 method @Nullable public String getUnableToConnectTitle();
120 method @Nullable public String getUpdateCompanionAppDescription();
121 method @Nullable public String getWaitLaunchCompanionAppDescription();
122 }
123
124 public static final class FastPairDeviceMetadata.Builder {
125 ctor public FastPairDeviceMetadata.Builder();
126 method @NonNull public android.nearby.FastPairDeviceMetadata build();
127 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setAssistantSetupHalfSheet(@Nullable String);
128 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setAssistantSetupNotification(@Nullable String);
129 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setBleTxPower(int);
130 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setConfirmPinDescription(@Nullable String);
131 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setConfirmPinTitle(@Nullable String);
132 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setConnectSuccessCompanionAppInstalled(@Nullable String);
133 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setConnectSuccessCompanionAppNotInstalled(@Nullable String);
134 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setDeviceType(int);
135 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setDownloadCompanionAppDescription(@Nullable String);
136 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setFailConnectGoToSettingsDescription(@Nullable String);
137 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setFastPairTvConnectDeviceNoAccountDescription(@Nullable String);
138 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setImage(@Nullable byte[]);
139 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setImageUrl(@Nullable String);
140 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setInitialNotificationDescription(@Nullable String);
141 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setInitialNotificationDescriptionNoAccount(@Nullable String);
142 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setInitialPairingDescription(@Nullable String);
143 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setIntentUri(@Nullable String);
144 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setLocale(@Nullable String);
145 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setOpenCompanionAppDescription(@Nullable String);
146 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setRetroactivePairingDescription(@Nullable String);
147 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setSubsequentPairingDescription(@Nullable String);
148 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setSyncContactsDescription(@Nullable String);
149 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setSyncContactsTitle(@Nullable String);
150 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setSyncSmsDescription(@Nullable String);
151 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setSyncSmsTitle(@Nullable String);
152 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setTriggerDistance(float);
153 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setTrueWirelessImageUrlCase(@Nullable String);
154 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setTrueWirelessImageUrlLeftBud(@Nullable String);
155 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setTrueWirelessImageUrlRightBud(@Nullable String);
156 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setUnableToConnectDescription(@Nullable String);
157 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setUnableToConnectTitle(@Nullable String);
158 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setUpdateCompanionAppDescription(@Nullable String);
159 method @NonNull public android.nearby.FastPairDeviceMetadata.Builder setWaitLaunchCompanionAppDescription(@Nullable String);
160 }
161
162 public class FastPairDiscoveryItem {
163 method @Nullable public String getActionUrl();
164 method public int getActionUrlType();
165 method @Nullable public String getAppName();
166 method public int getAttachmentType();
167 method @Nullable public byte[] getAuthenticationPublicKeySecp256r1();
168 method @Nullable public byte[] getBleRecordBytes();
169 method public int getDebugCategory();
170 method @Nullable public String getDebugMessage();
171 method @Nullable public String getDescription();
172 method @Nullable public String getDeviceName();
173 method @Nullable public String getDisplayUrl();
174 method @Nullable public String getEntityId();
175 method @Nullable public String getFeatureGraphicUrl();
176 method public long getFirstObservationTimestampMillis();
177 method @Nullable public String getGroupId();
178 method @Nullable public String getIconFfeUrl();
179 method @Nullable public byte[] getIconPng();
180 method @Nullable public String getId();
181 method public long getLastObservationTimestampMillis();
182 method public int getLastUserExperience();
183 method public long getLostMillis();
184 method @Nullable public String getMacAddress();
185 method @Nullable public String getPackageName();
186 method public long getPendingAppInstallTimestampMillis();
187 method public int getRssi();
188 method public int getState();
189 method @Nullable public String getTitle();
190 method @Nullable public String getTriggerId();
191 method public int getTxPower();
192 method public int getType();
193 }
194
195 public static final class FastPairDiscoveryItem.Builder {
196 ctor public FastPairDiscoveryItem.Builder();
197 method @NonNull public android.nearby.FastPairDiscoveryItem build();
198 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setActionUrl(@Nullable String);
199 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setActionUrlType(int);
200 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setAppName(@Nullable String);
201 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setAttachmentType(int);
202 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setAuthenticationPublicKeySecp256r1(@Nullable byte[]);
203 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setBleRecordBytes(@Nullable byte[]);
204 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setDebugCategory(int);
205 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setDebugMessage(@Nullable String);
206 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setDescription(@Nullable String);
207 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setDeviceName(@Nullable String);
208 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setDisplayUrl(@Nullable String);
209 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setEntityId(@Nullable String);
210 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setFeatureGraphicUrl(@Nullable String);
211 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setFirstObservationTimestampMillis(long);
212 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setGroupId(@Nullable String);
213 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setIconFfeUrl(@Nullable String);
214 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setIconPng(@Nullable byte[]);
215 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setId(@Nullable String);
216 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setLastObservationTimestampMillis(long);
217 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setLastUserExperience(int);
218 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setLostMillis(long);
219 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setMacAddress(@Nullable String);
220 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setPackageName(@Nullable String);
221 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setPendingAppInstallTimestampMillis(long);
222 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setRssi(int);
223 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setState(int);
224 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setTitle(@Nullable String);
225 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setTriggerId(@Nullable String);
226 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setTxPower(int);
227 method @NonNull public android.nearby.FastPairDiscoveryItem.Builder setType(int);
228 }
229
230 public class FastPairEligibleAccount {
231 }
232
233 public static final class FastPairEligibleAccount.Builder {
234 ctor public FastPairEligibleAccount.Builder();
235 method @NonNull public android.nearby.FastPairEligibleAccount build();
236 method @NonNull public android.nearby.FastPairEligibleAccount.Builder setAccount(@Nullable android.accounts.Account);
237 method @NonNull public android.nearby.FastPairEligibleAccount.Builder setOptIn(boolean);
238 }
239
240 public abstract class NearbyDevice {
241 method public int getMedium();
242 method @IntRange(from=0xffffff81, to=126) public int getRssi();
243 method public static boolean isValidMedium(int);
244 }
245
246 public final class NearbyDeviceParcelable implements android.os.Parcelable {
247 method public int describeContents();
248 method @Nullable public String getBluetoothAddress();
249 method @Nullable public byte[] getData();
250 method @Nullable public String getFastPairModelId();
251 method public int getMedium();
252 method @Nullable public String getName();
253 method @IntRange(from=0xffffff81, to=126) public int getRssi();
254 method public void writeToParcel(@NonNull android.os.Parcel, int);
255 field @NonNull public static final android.os.Parcelable.Creator<android.nearby.NearbyDeviceParcelable> CREATOR;
256 }
257
258 public static final class NearbyDeviceParcelable.Builder {
259 ctor public NearbyDeviceParcelable.Builder();
260 method @NonNull public android.nearby.NearbyDeviceParcelable build();
261 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setBluetoothAddress(@Nullable String);
262 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setData(@Nullable byte[]);
263 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setFastPairModelId(@Nullable String);
264 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setMedium(int);
265 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setName(@Nullable String);
266 method @NonNull public android.nearby.NearbyDeviceParcelable.Builder setRssi(int);
267 }
268
269 public final class NearbyFrameworkInitializer {
270 method public static void registerServiceWrappers();
271 }
272
273 public class NearbyManager {
274 method public void startScan(@NonNull android.nearby.ScanRequest, @NonNull java.util.concurrent.Executor, @NonNull android.nearby.ScanCallback);
275 method public void stopScan(@NonNull android.nearby.ScanCallback);
276 }
277
278 public interface ScanCallback {
279 method public void onDiscovered(@NonNull android.nearby.NearbyDevice);
280 method public void onLost(@NonNull android.nearby.NearbyDevice);
281 method public void onUpdated(@NonNull android.nearby.NearbyDevice);
282 }
283
284 public final class ScanRequest implements android.os.Parcelable {
285 method public int describeContents();
286 method public int getScanMode();
287 method public int getScanType();
288 method @NonNull public android.os.WorkSource getWorkSource();
289 method public boolean isEnableBle();
290 method public static boolean isValidScanMode(int);
291 method public static boolean isValidScanType(int);
292 method @NonNull public static String scanModeToString(int);
293 method public void writeToParcel(@NonNull android.os.Parcel, int);
294 field @NonNull public static final android.os.Parcelable.Creator<android.nearby.ScanRequest> CREATOR;
295 field public static final int SCAN_MODE_BALANCED = 1; // 0x1
296 field public static final int SCAN_MODE_LOW_LATENCY = 2; // 0x2
297 field public static final int SCAN_MODE_LOW_POWER = 0; // 0x0
298 field public static final int SCAN_MODE_NO_POWER = -1; // 0xffffffff
299 field public static final int SCAN_TYPE_EXPOSURE_NOTIFICATION = 4; // 0x4
300 field public static final int SCAN_TYPE_FAST_PAIR = 1; // 0x1
301 field public static final int SCAN_TYPE_NEARBY_PRESENCE = 3; // 0x3
302 field public static final int SCAN_TYPE_NEARBY_SHARE = 2; // 0x2
303 }
304
305 public static final class ScanRequest.Builder {
306 ctor public ScanRequest.Builder();
307 method @NonNull public android.nearby.ScanRequest build();
308 method @NonNull public android.nearby.ScanRequest.Builder setEnableBle(boolean);
309 method @NonNull public android.nearby.ScanRequest.Builder setScanMode(int);
310 method @NonNull public android.nearby.ScanRequest.Builder setScanType(int);
311 method @NonNull @RequiresPermission(android.Manifest.permission.UPDATE_DEVICE_STATS) public android.nearby.ScanRequest.Builder setWorkSource(@Nullable android.os.WorkSource);
312 }
313
314}
315