From 4b927284a62a89fdd37d1f832b022f2a7feab136 Mon Sep 17 00:00:00 2001 From: Quddus Chong Date: Tue, 26 May 2015 14:21:05 -0700 Subject: [PATCH] docs: Remove Google Play Services pages under Develop > Google Services. bug: 21407467 Change-Id: I392075b58bebc5556f306c2d20987811efe90b13 --- docs/html/google/auth/api-client.jd | 654 - docs/html/google/auth/http-auth.jd | 558 - docs/html/google/play-services/auth.jd | 239 - docs/html/google/play-services/index.jd | 706 - docs/html/google/play-services/setup.jd | 398 - .../android/gcm/GCMBaseIntentService.html | 6576 ------- .../android/gcm/GCMBroadcastReceiver.html | 1662 -- .../com/google/android/gcm/GCMConstants.html | 2139 -- .../com/google/android/gcm/GCMRegistrar.html | 1818 -- .../google/android/gcm/package-summary.html | 750 - .../google/android/gcm/server/Constants.html | 2510 --- .../gcm/server/InvalidRequestException.html | 1578 -- .../android/gcm/server/Message.Builder.html | 1486 -- .../google/android/gcm/server/Message.html | 1494 -- .../gcm/server/MulticastResult.Builder.html | 1288 -- .../android/gcm/server/MulticastResult.html | 1511 -- .../android/gcm/server/Result.Builder.html | 1333 -- .../com/google/android/gcm/server/Result.html | 1340 -- .../com/google/android/gcm/server/Sender.html | 2204 --- .../android/gcm/server/package-summary.html | 757 - .../com/google/android/gms/R.attr.html | 3380 ---- .../com/google/android/gms/R.color.html | 2590 --- .../com/google/android/gms/R.drawable.html | 2825 --- .../reference/com/google/android/gms/R.html | 1466 -- .../com/google/android/gms/R.id.html | 2449 --- .../com/google/android/gms/R.integer.html | 1368 -- .../com/google/android/gms/R.raw.html | 1368 -- .../com/google/android/gms/R.string.html | 3107 --- .../com/google/android/gms/R.style.html | 1556 -- .../com/google/android/gms/R.styleable.html | 3911 ---- .../android/gms/actions/ItemListIntents.html | 1891 -- .../android/gms/actions/NoteIntents.html | 1605 -- .../android/gms/actions/ReserveIntents.html | 1312 -- .../android/gms/actions/SearchIntents.html | 1366 -- .../android/gms/actions/package-summary.html | 923 - .../google/android/gms/ads/AdListener.html | 1605 -- .../android/gms/ads/AdRequest.Builder.html | 2083 -- .../com/google/android/gms/ads/AdRequest.html | 2320 --- .../com/google/android/gms/ads/AdSize.html | 2330 --- .../com/google/android/gms/ads/AdView.html | 15904 --------------- .../android/gms/ads/InterstitialAd.html | 2082 -- .../gms/ads/doubleclick/AppEventListener.html | 1075 - .../gms/ads/doubleclick/CustomRenderedAd.html | 1295 -- .../OnCustomRenderedAdLoadedListener.html | 1071 - .../PublisherAdRequest.Builder.html | 2368 --- .../ads/doubleclick/PublisherAdRequest.html | 2492 --- .../gms/ads/doubleclick/PublisherAdView.html | 16057 --------------- .../doubleclick/PublisherInterstitialAd.html | 2120 -- .../gms/ads/doubleclick/package-summary.html | 967 - .../identifier/AdvertisingIdClient.Info.html | 1481 -- .../ads/identifier/AdvertisingIdClient.html | 1387 -- .../gms/ads/identifier/package-summary.html | 897 - .../gms/ads/mediation/MediationAdRequest.html | 1559 -- .../gms/ads/mediation/MediationAdapter.html | 1263 -- .../ads/mediation/MediationBannerAdapter.html | 1322 -- .../mediation/MediationBannerListener.html | 1448 -- .../MediationInterstitialAdapter.html | 1313 -- .../MediationInterstitialListener.html | 1444 -- .../gms/ads/mediation/NetworkExtras.html | 1056 - .../gms/ads/mediation/admob/AdMobExtras.html | 1407 -- .../ads/mediation/admob/package-summary.html | 896 - .../mediation/customevent/CustomEvent.html | 1258 -- .../customevent/CustomEventBanner.html | 1250 -- .../CustomEventBannerListener.html | 1259 -- .../customevent/CustomEventExtras.html | 1463 -- .../customevent/CustomEventInterstitial.html | 1303 -- .../CustomEventInterstitialListener.html | 1252 -- .../customevent/CustomEventListener.html | 1392 -- .../customevent/package-summary.html | 983 - .../gms/ads/mediation/package-summary.html | 963 - .../android/gms/ads/package-summary.html | 945 - .../gms/ads/purchase/InAppPurchase.html | 1439 -- .../ads/purchase/InAppPurchaseListener.html | 1076 - .../gms/ads/purchase/InAppPurchaseResult.html | 1285 -- .../purchase/PlayStorePurchaseListener.html | 1139 -- .../gms/ads/purchase/package-summary.html | 923 - .../ads/search/SearchAdRequest.Builder.html | 2614 --- .../gms/ads/search/SearchAdRequest.html | 3035 --- .../android/gms/ads/search/SearchAdView.html | 15648 --------------- .../gms/ads/search/package-summary.html | 913 - .../gms/analytics/AnalyticsReceiver.html | 1722 -- .../gms/analytics/AnalyticsService.html | 6137 ------ .../analytics/CampaignTrackingReceiver.html | 1778 -- .../analytics/CampaignTrackingService.html | 6377 ------ .../gms/analytics/ExceptionParser.html | 1154 -- .../gms/analytics/ExceptionReporter.html | 1554 -- .../gms/analytics/GoogleAnalytics.html | 2309 --- .../analytics/HitBuilders.AppViewBuilder.html | 1686 -- .../analytics/HitBuilders.EventBuilder.html | 1959 -- .../HitBuilders.ExceptionBuilder.html | 1793 -- .../gms/analytics/HitBuilders.HitBuilder.html | 2443 --- .../analytics/HitBuilders.ItemBuilder.html | 2039 -- .../HitBuilders.ScreenViewBuilder.html | 1680 -- .../analytics/HitBuilders.SocialBuilder.html | 1841 -- .../analytics/HitBuilders.TimingBuilder.html | 1974 -- .../HitBuilders.TransactionBuilder.html | 1992 -- .../android/gms/analytics/HitBuilders.html | 1538 -- .../gms/analytics/Logger.LogLevel.html | 1541 -- .../google/android/gms/analytics/Logger.html | 1542 -- .../analytics/StandardExceptionParser.html | 1762 -- .../google/android/gms/analytics/Tracker.html | 2938 --- .../gms/analytics/ecommerce/Product.html | 2161 --- .../analytics/ecommerce/ProductAction.html | 2626 --- .../gms/analytics/ecommerce/Promotion.html | 1785 -- .../analytics/ecommerce/package-summary.html | 908 - .../gms/analytics/package-summary.html | 1141 -- .../gms/appindexing/Action.Builder.html | 2002 -- .../android/gms/appindexing/Action.html | 2317 --- .../gms/appindexing/AndroidAppUri.html | 1725 -- .../android/gms/appindexing/AppIndex.html | 1410 -- .../appindexing/AppIndexApi.ActionResult.html | 1138 -- .../AppIndexApi.AppIndexingLink.html | 1519 -- .../android/gms/appindexing/AppIndexApi.html | 1546 -- .../gms/appindexing/Thing.Builder.html | 1886 -- .../google/android/gms/appindexing/Thing.html | 1308 -- .../gms/appindexing/package-summary.html | 987 - .../google/android/gms/appstate/AppState.html | 1440 -- .../android/gms/appstate/AppStateBuffer.html | 1816 -- .../AppStateManager.StateConflictResult.html | 1359 -- .../AppStateManager.StateDeletedResult.html | 1156 -- .../AppStateManager.StateListResult.html | 1159 -- .../AppStateManager.StateLoadedResult.html | 1267 -- .../appstate/AppStateManager.StateResult.html | 1256 -- .../android/gms/appstate/AppStateManager.html | 2189 --- .../gms/appstate/AppStateStatusCodes.html | 2035 -- .../android/gms/appstate/package-summary.html | 997 - .../android/gms/auth/AccountChangeEvent.html | 1980 -- .../gms/auth/AccountChangeEventsRequest.html | 1952 -- .../gms/auth/AccountChangeEventsResponse.html | 1666 -- .../android/gms/auth/GoogleAuthException.html | 1836 -- .../android/gms/auth/GoogleAuthUtil.html | 3533 ---- ...oglePlayServicesAvailabilityException.html | 1696 -- .../auth/UserRecoverableAuthException.html | 1737 -- .../UserRecoverableNotifiedException.html | 1618 -- .../android/gms/auth/package-summary.html | 984 - .../android/gms/cast/ApplicationMetadata.html | 2054 -- .../Cast.ApplicationConnectionResult.html | 1320 -- .../google/android/gms/cast/Cast.CastApi.html | 2677 --- .../gms/cast/Cast.CastOptions.Builder.html | 1370 -- .../android/gms/cast/Cast.CastOptions.html | 1379 -- .../android/gms/cast/Cast.Listener.html | 1706 -- .../cast/Cast.MessageReceivedCallback.html | 1137 -- .../com/google/android/gms/cast/Cast.html | 1993 -- .../google/android/gms/cast/CastDevice.html | 2824 --- .../gms/cast/CastMediaControlIntent.html | 2424 --- .../android/gms/cast/CastStatusCodes.html | 2133 -- .../gms/cast/LaunchOptions.Builder.html | 1498 -- .../android/gms/cast/LaunchOptions.html | 2042 -- .../android/gms/cast/MediaInfo.Builder.html | 1828 -- .../google/android/gms/cast/MediaInfo.html | 2171 --- .../android/gms/cast/MediaMetadata.html | 4101 ---- .../google/android/gms/cast/MediaStatus.html | 2708 --- .../android/gms/cast/MediaTrack.Builder.html | 1814 -- .../google/android/gms/cast/MediaTrack.html | 2551 --- .../RemoteMediaPlayer.MediaChannelResult.html | 1151 -- ...MediaPlayer.OnMetadataUpdatedListener.html | 1060 - ...teMediaPlayer.OnStatusUpdatedListener.html | 1060 - .../android/gms/cast/RemoteMediaPlayer.html | 4038 ---- .../android/gms/cast/TextTrackStyle.html | 4285 ---- .../android/gms/cast/package-summary.html | 1157 -- .../android/gms/common/AccountPicker.html | 1389 -- .../android/gms/common/ConnectionResult.html | 3213 --- .../gms/common/ErrorDialogFragment.html | 4015 ---- .../gms/common/GoogleApiAvailability.html | 2204 --- ...oglePlayServicesNotAvailableException.html | 1660 -- ...GooglePlayServicesRepairableException.html | 1669 -- .../gms/common/GooglePlayServicesUtil.html | 2573 --- .../com/google/android/gms/common/Scopes.html | 2195 --- .../android/gms/common/SignInButton.html | 15933 --------------- .../common/SupportErrorDialogFragment.html | 3839 ---- .../gms/common/UserRecoverableException.html | 1712 -- .../gms/common/annotation/KeepName.html | 1118 -- .../common/annotation/package-summary.html | 885 - .../common/api/Api.ApiOptions.HasOptions.html | 1114 -- .../common/api/Api.ApiOptions.NoOptions.html | 1257 -- .../Api.ApiOptions.NotRequiredOptions.html | 1088 -- .../common/api/Api.ApiOptions.Optional.html | 1074 - .../gms/common/api/Api.ApiOptions.html | 1257 -- .../google/android/gms/common/api/Api.html | 1281 -- .../android/gms/common/api/Batch.Builder.html | 1441 -- .../google/android/gms/common/api/Batch.html | 2280 --- .../android/gms/common/api/BatchResult.html | 1440 -- .../gms/common/api/BatchResultToken.html | 1305 -- .../gms/common/api/CommonStatusCodes.html | 2505 --- .../common/api/GoogleApiClient.Builder.html | 2496 --- .../GoogleApiClient.ConnectionCallbacks.html | 1276 -- ...eApiClient.OnConnectionFailedListener.html | 1078 - ...t.ServerAuthCodeCallbacks.CheckResult.html | 1403 -- ...ogleApiClient.ServerAuthCodeCallbacks.html | 1214 -- .../gms/common/api/GoogleApiClient.html | 2427 --- .../android/gms/common/api/PendingResult.html | 1429 -- .../gms/common/api/PendingResults.html | 1500 -- .../android/gms/common/api/Releasable.html | 1673 -- .../google/android/gms/common/api/Result.html | 2006 -- .../gms/common/api/ResultCallback.html | 1077 - .../google/android/gms/common/api/Scope.html | 1771 -- .../google/android/gms/common/api/Status.html | 2531 --- .../gms/common/api/package-summary.html | 1155 -- .../gms/common/data/AbstractDataBuffer.html | 2297 --- .../android/gms/common/data/DataBuffer.html | 1873 -- .../data/DataBufferObserver.Observable.html | 1176 -- .../gms/common/data/DataBufferObserver.html | 1380 -- .../common/data/DataBufferObserverSet.html | 2065 -- .../gms/common/data/DataBufferUtils.html | 1515 -- .../android/gms/common/data/Freezable.html | 1783 -- .../gms/common/data/FreezableUtils.html | 1554 -- .../gms/common/data/package-summary.html | 977 - .../ImageManager.OnImageLoadedListener.html | 1078 - .../gms/common/images/ImageManager.html | 1749 -- .../android/gms/common/images/WebImage.html | 2046 -- .../gms/common/images/package-summary.html | 922 - .../android/gms/common/package-summary.html | 1022 - .../gms/drive/CreateFileActivityBuilder.html | 1691 -- .../com/google/android/gms/drive/Drive.html | 1515 -- .../drive/DriveApi.DriveContentsResult.html | 1148 -- .../gms/drive/DriveApi.DriveIdResult.html | 1142 -- .../drive/DriveApi.MetadataBufferResult.html | 1199 -- .../google/android/gms/drive/DriveApi.html | 1842 -- .../android/gms/drive/DriveContents.html | 1701 -- .../DriveFile.DownloadProgressListener.html | 1052 - .../google/android/gms/drive/DriveFile.html | 1633 -- .../drive/DriveFolder.DriveFileResult.html | 1142 -- .../drive/DriveFolder.DriveFolderResult.html | 1142 -- .../google/android/gms/drive/DriveFolder.html | 1850 -- .../com/google/android/gms/drive/DriveId.html | 2208 --- ...rencesApi.FileUploadPreferencesResult.html | 1142 -- .../gms/drive/DrivePreferencesApi.html | 1190 -- .../drive/DriveResource.MetadataResult.html | 1142 -- .../android/gms/drive/DriveResource.html | 1854 -- .../android/gms/drive/DriveStatusCodes.html | 1884 -- .../gms/drive/ExecutionOptions.Builder.html | 1604 -- .../android/gms/drive/ExecutionOptions.html | 1589 -- .../gms/drive/FileUploadPreferences.html | 1728 -- .../google/android/gms/drive/Metadata.html | 3293 ---- .../android/gms/drive/MetadataBuffer.html | 1938 -- .../gms/drive/MetadataChangeSet.Builder.html | 1948 -- .../android/gms/drive/MetadataChangeSet.html | 2086 -- .../gms/drive/OpenFileActivityBuilder.html | 1603 -- .../android/gms/drive/events/ChangeEvent.html | 1896 -- .../gms/drive/events/ChangeListener.html | 1112 -- .../gms/drive/events/CompletionEvent.html | 2557 --- .../gms/drive/events/CompletionListener.html | 1112 -- .../android/gms/drive/events/DriveEvent.html | 1246 -- .../gms/drive/events/DriveEventService.html | 6737 ------- .../gms/drive/events/ResourceEvent.html | 1286 -- .../gms/drive/events/package-summary.html | 964 - .../gms/drive/metadata/CustomPropertyKey.html | 2122 -- .../gms/drive/metadata/MetadataField.html | 1055 - .../SearchableCollectionMetadataField.html | 993 - .../metadata/SearchableMetadataField.html | 1054 - .../SearchableOrderedMetadataField.html | 996 - .../drive/metadata/SortableMetadataField.html | 986 - .../gms/drive/metadata/package-summary.html | 952 - .../android/gms/drive/package-summary.html | 1171 -- .../android/gms/drive/query/Filter.html | 1147 -- .../android/gms/drive/query/Filters.html | 2231 --- .../gms/drive/query/Query.Builder.html | 1618 -- .../google/android/gms/drive/query/Query.html | 1804 -- .../gms/drive/query/SearchableField.html | 1709 -- .../gms/drive/query/SortOrder.Builder.html | 1505 -- .../android/gms/drive/query/SortOrder.html | 1628 -- .../gms/drive/query/SortableField.html | 1661 -- .../gms/drive/query/package-summary.html | 973 - .../gms/drive/widget/DataBufferAdapter.html | 2828 --- .../gms/drive/widget/package-summary.html | 885 - .../google/android/gms/fitness/BleApi.html | 1617 -- .../google/android/gms/fitness/ConfigApi.html | 1262 -- .../google/android/gms/fitness/Fitness.html | 3000 --- .../gms/fitness/FitnessActivities.html | 7446 ------- .../gms/fitness/FitnessStatusCodes.html | 2707 --- .../fitness/HistoryApi.ViewIntentBuilder.html | 1658 -- .../android/gms/fitness/HistoryApi.html | 1384 -- .../android/gms/fitness/RecordingApi.html | 1589 -- .../android/gms/fitness/SensorsApi.html | 1463 -- .../SessionsApi.ViewIntentBuilder.html | 1568 -- .../android/gms/fitness/SessionsApi.html | 1562 -- .../android/gms/fitness/data/BleDevice.html | 1867 -- .../android/gms/fitness/data/Bucket.html | 2282 --- .../android/gms/fitness/data/DataPoint.html | 2491 --- .../android/gms/fitness/data/DataSet.html | 2116 -- .../gms/fitness/data/DataSource.Builder.html | 1828 -- .../android/gms/fitness/data/DataSource.html | 2335 --- .../android/gms/fitness/data/DataType.html | 4031 ---- .../android/gms/fitness/data/Device.html | 2359 --- .../android/gms/fitness/data/Field.html | 4631 ----- .../gms/fitness/data/Session.Builder.html | 1819 -- .../android/gms/fitness/data/Session.html | 2541 --- .../gms/fitness/data/Subscription.html | 1798 -- .../android/gms/fitness/data/Value.html | 2496 --- .../gms/fitness/data/package-summary.html | 1027 - .../android/gms/fitness/package-summary.html | 1013 - .../gms/fitness/request/BleScanCallback.html | 1435 -- .../request/DataDeleteRequest.Builder.html | 1775 -- .../fitness/request/DataDeleteRequest.html | 2172 --- .../request/DataReadRequest.Builder.html | 2490 --- .../gms/fitness/request/DataReadRequest.html | 2434 --- .../request/DataSourcesRequest.Builder.html | 1526 -- .../fitness/request/DataSourcesRequest.html | 1695 -- .../DataTypeCreateRequest.Builder.html | 1559 -- .../request/DataTypeCreateRequest.html | 1854 -- .../fitness/request/OnDataPointListener.html | 1082 -- .../request/SensorRequest.Builder.html | 1914 -- .../gms/fitness/request/SensorRequest.html | 2045 -- .../request/SessionInsertRequest.Builder.html | 1587 -- .../fitness/request/SessionInsertRequest.html | 1928 -- .../request/SessionReadRequest.Builder.html | 1948 -- .../fitness/request/SessionReadRequest.html | 2214 --- .../request/StartBleScanRequest.Builder.html | 1591 -- .../fitness/request/StartBleScanRequest.html | 1751 -- .../gms/fitness/request/package-summary.html | 1089 -- .../gms/fitness/result/BleDevicesResult.html | 1945 -- .../gms/fitness/result/DailyTotalResult.html | 1716 -- .../gms/fitness/result/DataReadResult.html | 2115 -- .../gms/fitness/result/DataSourcesResult.html | 1945 -- .../gms/fitness/result/DataTypeResult.html | 1884 -- .../result/ListSubscriptionsResult.html | 1944 -- .../gms/fitness/result/SessionReadResult.html | 2035 -- .../gms/fitness/result/SessionStopResult.html | 1877 -- .../gms/fitness/result/package-summary.html | 968 - .../fitness/service/FitnessSensorService.html | 6563 ------- .../service/FitnessSensorServiceRequest.html | 2020 -- .../service/SensorEventDispatcher.html | 1135 -- .../gms/fitness/service/package-summary.html | 925 - .../com/google/android/gms/games/Game.html | 2456 --- .../google/android/gms/games/GameBuffer.html | 1816 -- .../google/android/gms/games/GameEntity.html | 3557 ---- .../gms/games/Games.GamesOptions.Builder.html | 1502 -- .../android/gms/games/Games.GamesOptions.html | 1365 -- .../com/google/android/gms/games/Games.html | 2655 --- .../gms/games/GamesActivityResultCodes.html | 1725 -- .../games/GamesMetadata.LoadGamesResult.html | 1216 -- .../android/gms/games/GamesMetadata.html | 1174 -- .../android/gms/games/GamesStatusCodes.html | 4090 ---- .../android/gms/games/Notifications.html | 1534 -- .../android/gms/games/PageDirection.html | 1417 -- .../com/google/android/gms/games/Player.html | 2159 -- .../android/gms/games/PlayerBuffer.html | 1816 -- .../android/gms/games/PlayerEntity.html | 3020 --- .../google/android/gms/games/PlayerLevel.html | 1869 -- .../android/gms/games/PlayerLevelInfo.html | 1942 -- .../gms/games/Players.LoadPlayersResult.html | 1215 -- .../Players.LoadProfileSettingsResult.html | 1212 -- .../com/google/android/gms/games/Players.html | 1995 -- .../gms/games/achievement/Achievement.html | 2710 --- .../games/achievement/AchievementBuffer.html | 1816 -- .../games/achievement/AchievementEntity.html | 3689 ---- .../Achievements.LoadAchievementsResult.html | 1215 -- .../Achievements.UpdateAchievementResult.html | 1177 -- .../gms/games/achievement/Achievements.html | 1881 -- .../games/achievement/package-summary.html | 956 - .../google/android/gms/games/event/Event.html | 1974 -- .../android/gms/games/event/EventBuffer.html | 1816 -- .../android/gms/games/event/EventEntity.html | 3005 --- .../games/event/Events.LoadEventsResult.html | 1215 -- .../android/gms/games/event/Events.html | 1270 -- .../gms/games/event/package-summary.html | 939 - .../gms/games/leaderboard/Leaderboard.html | 1618 -- .../games/leaderboard/LeaderboardBuffer.html | 1864 -- .../games/leaderboard/LeaderboardScore.html | 2007 -- .../leaderboard/LeaderboardScoreBuffer.html | 1816 -- .../games/leaderboard/LeaderboardVariant.html | 2186 --- ...eaderboards.LeaderboardMetadataResult.html | 1215 -- .../Leaderboards.LoadPlayerScoreResult.html | 1164 -- .../Leaderboards.LoadScoresResult.html | 1269 -- .../Leaderboards.SubmitScoreResult.html | 1215 -- .../gms/games/leaderboard/Leaderboards.html | 2465 --- .../ScoreSubmissionData.Result.html | 1584 -- .../leaderboard/ScoreSubmissionData.html | 1525 -- .../games/leaderboard/package-summary.html | 1022 - .../gms/games/multiplayer/Invitation.html | 1901 -- .../games/multiplayer/InvitationBuffer.html | 1864 -- .../games/multiplayer/InvitationEntity.html | 2644 --- .../Invitations.LoadInvitationsResult.html | 1211 -- .../gms/games/multiplayer/Invitations.html | 1408 -- .../gms/games/multiplayer/Multiplayer.html | 1558 -- .../OnInvitationReceivedListener.html | 1138 -- .../gms/games/multiplayer/Participant.html | 2255 --- .../games/multiplayer/ParticipantBuffer.html | 1816 -- .../games/multiplayer/ParticipantEntity.html | 2833 --- .../games/multiplayer/ParticipantResult.html | 2259 --- .../games/multiplayer/ParticipantUtils.html | 1330 -- .../gms/games/multiplayer/Participatable.html | 1190 -- .../games/multiplayer/package-summary.html | 1032 - .../multiplayer/realtime/RealTimeMessage.html | 1835 -- .../RealTimeMessageReceivedListener.html | 1072 - ...ltiplayer.ReliableMessageSentCallback.html | 1086 -- .../realtime/RealTimeMultiplayer.html | 2190 --- .../gms/games/multiplayer/realtime/Room.html | 2453 --- .../realtime/RoomConfig.Builder.html | 1806 -- .../multiplayer/realtime/RoomConfig.html | 1922 -- .../multiplayer/realtime/RoomEntity.html | 3168 --- .../realtime/RoomStatusUpdateListener.html | 1823 -- .../realtime/RoomUpdateListener.html | 1317 -- .../multiplayer/realtime/package-summary.html | 1001 - .../turnbased/LoadMatchesResponse.html | 1687 -- ...nTurnBasedMatchUpdateReceivedListener.html | 1136 -- .../multiplayer/turnbased/TurnBasedMatch.html | 3631 ---- .../turnbased/TurnBasedMatchBuffer.html | 1864 -- .../TurnBasedMatchConfig.Builder.html | 1601 -- .../turnbased/TurnBasedMatchConfig.html | 1668 -- .../turnbased/TurnBasedMatchEntity.html | 4428 ----- ...urnBasedMultiplayer.CancelMatchResult.html | 1164 -- ...nBasedMultiplayer.InitiateMatchResult.html | 1167 -- ...TurnBasedMultiplayer.LeaveMatchResult.html | 1169 -- .../TurnBasedMultiplayer.LoadMatchResult.html | 1162 -- ...urnBasedMultiplayer.LoadMatchesResult.html | 1210 -- ...urnBasedMultiplayer.UpdateMatchResult.html | 1172 -- .../turnbased/TurnBasedMultiplayer.html | 3206 --- .../turnbased/package-summary.html | 1044 - .../android/gms/games/package-summary.html | 1110 -- .../android/gms/games/quest/Milestone.html | 1900 -- .../gms/games/quest/MilestoneBuffer.html | 1817 -- .../gms/games/quest/MilestoneEntity.html | 2541 --- .../google/android/gms/games/quest/Quest.html | 2742 --- .../android/gms/games/quest/QuestBuffer.html | 1864 -- .../android/gms/games/quest/QuestEntity.html | 3425 ---- .../gms/games/quest/QuestUpdateListener.html | 1070 - .../games/quest/Quests.AcceptQuestResult.html | 1158 -- .../quest/Quests.ClaimMilestoneResult.html | 1216 -- .../games/quest/Quests.LoadQuestsResult.html | 1217 -- .../android/gms/games/quest/Quests.html | 2576 --- .../gms/games/quest/package-summary.html | 1006 - .../gms/games/request/GameRequest.html | 2352 --- .../gms/games/request/GameRequestBuffer.html | 1865 -- .../gms/games/request/GameRequestEntity.html | 2954 --- .../request/OnRequestReceivedListener.html | 1137 -- .../request/Requests.LoadRequestsResult.html | 1230 -- .../Requests.UpdateRequestsResult.html | 1290 -- .../android/gms/games/request/Requests.html | 2742 --- .../gms/games/request/package-summary.html | 962 - .../android/gms/games/snapshot/Snapshot.html | 1412 -- .../gms/games/snapshot/SnapshotContents.html | 1529 -- .../gms/games/snapshot/SnapshotEntity.html | 2120 -- .../gms/games/snapshot/SnapshotMetadata.html | 2094 -- .../snapshot/SnapshotMetadataBuffer.html | 1816 -- .../SnapshotMetadataChange.Builder.html | 1611 -- .../snapshot/SnapshotMetadataChange.html | 1629 -- .../snapshot/SnapshotMetadataEntity.html | 2980 --- .../Snapshots.CommitSnapshotResult.html | 1166 -- .../Snapshots.DeleteSnapshotResult.html | 1159 -- .../Snapshots.LoadSnapshotsResult.html | 1215 -- .../Snapshots.OpenSnapshotResult.html | 1377 -- .../android/gms/games/snapshot/Snapshots.html | 2736 --- .../gms/games/snapshot/package-summary.html | 1033 - .../android/gms/gcm/GoogleCloudMessaging.html | 2302 --- .../android/gms/gcm/package-summary.html | 885 - .../intents/Address.AddressOptions.html | 1459 -- .../android/gms/identity/intents/Address.html | 1513 -- .../intents/AddressConstants.ErrorCodes.html | 1061 - .../intents/AddressConstants.Extras.html | 1119 -- .../intents/AddressConstants.ResultCodes.html | 1063 - .../intents/AddressConstants.Themes.html | 1239 -- .../identity/intents/AddressConstants.html | 1069 - .../intents/UserAddressRequest.Builder.html | 1431 -- .../identity/intents/UserAddressRequest.html | 1678 -- .../intents/model/CountrySpecification.html | 1739 -- .../identity/intents/model/UserAddress.html | 2442 --- .../intents/model/package-summary.html | 896 - .../gms/identity/intents/package-summary.html | 986 - .../gms/location/ActivityRecognition.html | 1425 -- .../gms/location/ActivityRecognitionApi.html | 1232 -- .../location/ActivityRecognitionResult.html | 2279 --- .../gms/location/DetectedActivity.html | 2268 --- .../location/FusedLocationProviderApi.html | 2124 -- .../gms/location/Geofence.Builder.html | 1823 -- .../google/android/gms/location/Geofence.html | 1329 -- .../gms/location/GeofenceStatusCodes.html | 1815 -- .../android/gms/location/GeofencingApi.html | 1469 -- .../android/gms/location/GeofencingEvent.html | 1646 -- .../location/GeofencingRequest.Builder.html | 1630 -- .../gms/location/GeofencingRequest.html | 1945 -- .../gms/location/LocationAvailability.html | 1888 -- .../gms/location/LocationCallback.html | 1470 -- .../gms/location/LocationListener.html | 1073 - .../android/gms/location/LocationRequest.html | 3185 --- .../android/gms/location/LocationResult.html | 1999 -- .../gms/location/LocationServices.html | 1450 -- .../LocationSettingsRequest.Builder.html | 1615 -- .../gms/location/LocationSettingsRequest.html | 1581 -- .../gms/location/LocationSettingsResult.html | 1738 -- .../gms/location/LocationSettingsStates.html | 2062 -- .../location/LocationSettingsStatusCodes.html | 1686 -- .../gms/location/LocationStatusCodes.html | 1540 -- .../android/gms/location/SettingsApi.html | 1196 -- .../android/gms/location/package-summary.html | 1170 -- .../gms/location/places/AddPlaceRequest.html | 2008 -- .../location/places/AutocompleteFilter.html | 1659 -- .../AutocompletePrediction.Substring.html | 1104 -- .../places/AutocompletePrediction.html | 1387 -- .../places/AutocompletePredictionBuffer.html | 1991 -- .../gms/location/places/GeoDataApi.html | 1244 -- .../android/gms/location/places/Place.html | 8532 -------- .../gms/location/places/PlaceBuffer.html | 2007 -- .../location/places/PlaceDetectionApi.html | 1168 -- .../gms/location/places/PlaceFilter.html | 1849 -- .../gms/location/places/PlaceLikelihood.html | 1236 -- .../places/PlaceLikelihoodBuffer.html | 2064 -- .../gms/location/places/PlaceReport.html | 1881 -- .../gms/location/places/PlaceTypes.html | 1306 -- .../android/gms/location/places/Places.html | 1448 -- .../places/PlacesOptions.Builder.html | 1367 -- .../gms/location/places/PlacesOptions.html | 1301 -- .../location/places/PlacesStatusCodes.html | 2024 -- .../gms/location/places/package-summary.html | 1084 -- .../places/ui/PlacePicker.IntentBuilder.html | 1468 -- .../gms/location/places/ui/PlacePicker.html | 1610 -- .../location/places/ui/package-summary.html | 897 - .../google/android/gms/maps/CameraUpdate.html | 1254 -- .../android/gms/maps/CameraUpdateFactory.html | 2112 -- .../maps/GoogleMap.CancelableCallback.html | 1116 -- .../gms/maps/GoogleMap.InfoWindowAdapter.html | 1173 -- .../GoogleMap.OnCameraChangeListener.html | 1073 - ...GoogleMap.OnIndoorStateChangeListener.html | 1143 -- .../GoogleMap.OnInfoWindowClickListener.html | 1069 - .../maps/GoogleMap.OnMapClickListener.html | 1074 - .../maps/GoogleMap.OnMapLoadedCallback.html | 1064 - .../GoogleMap.OnMapLongClickListener.html | 1074 - .../maps/GoogleMap.OnMarkerClickListener.html | 1076 - .../maps/GoogleMap.OnMarkerDragListener.html | 1203 -- ...leMap.OnMyLocationButtonClickListener.html | 1070 - .../GoogleMap.OnMyLocationChangeListener.html | 1081 -- .../maps/GoogleMap.SnapshotReadyCallback.html | 1070 - .../google/android/gms/maps/GoogleMap.html | 4871 ----- .../android/gms/maps/GoogleMapOptions.html | 2905 --- ...ationSource.OnLocationChangedListener.html | 1069 - .../android/gms/maps/LocationSource.html | 1187 -- .../google/android/gms/maps/MapFragment.html | 3989 ---- .../com/google/android/gms/maps/MapView.html | 15814 --------------- .../android/gms/maps/MapsInitializer.html | 1334 -- .../android/gms/maps/OnMapReadyCallback.html | 1079 - .../OnStreetViewPanoramaReadyCallback.html | 1082 -- .../google/android/gms/maps/Projection.html | 1464 -- ...treetViewPanoramaCameraChangeListener.html | 1072 - ...ma.OnStreetViewPanoramaChangeListener.html | 1077 - ...ama.OnStreetViewPanoramaClickListener.html | 1076 - ...OnStreetViewPanoramaLongClickListener.html | 1077 - .../android/gms/maps/StreetViewPanorama.html | 2659 --- .../gms/maps/StreetViewPanoramaFragment.html | 3988 ---- .../gms/maps/StreetViewPanoramaOptions.html | 2518 --- .../gms/maps/StreetViewPanoramaView.html | 15814 --------------- .../android/gms/maps/SupportMapFragment.html | 3795 ---- .../SupportStreetViewPanoramaFragment.html | 3794 ---- .../google/android/gms/maps/UiSettings.html | 2507 --- .../gms/maps/model/BitmapDescriptor.html | 1251 -- .../maps/model/BitmapDescriptorFactory.html | 2272 --- .../maps/model/CameraPosition.Builder.html | 1678 -- .../gms/maps/model/CameraPosition.html | 2186 --- .../google/android/gms/maps/model/Circle.html | 2348 --- .../android/gms/maps/model/CircleOptions.html | 2405 --- .../android/gms/maps/model/GroundOverlay.html | 2610 --- .../gms/maps/model/GroundOverlayOptions.html | 2966 --- .../gms/maps/model/IndoorBuilding.html | 1587 -- .../android/gms/maps/model/IndoorLevel.html | 1528 -- .../google/android/gms/maps/model/LatLng.html | 1796 -- .../gms/maps/model/LatLngBounds.Builder.html | 1463 -- .../android/gms/maps/model/LatLngBounds.html | 2093 -- .../google/android/gms/maps/model/Marker.html | 2868 --- .../android/gms/maps/model/MarkerOptions.html | 3038 --- .../android/gms/maps/model/Polygon.html | 2522 --- .../gms/maps/model/PolygonOptions.html | 2603 --- .../android/gms/maps/model/Polyline.html | 2336 --- .../gms/maps/model/PolylineOptions.html | 2354 --- .../maps/model/RuntimeRemoteException.html | 1617 -- .../StreetViewPanoramaCamera.Builder.html | 1826 -- .../maps/model/StreetViewPanoramaCamera.html | 2052 -- .../maps/model/StreetViewPanoramaLink.html | 1699 -- .../model/StreetViewPanoramaLocation.html | 1840 -- ...StreetViewPanoramaOrientation.Builder.html | 1660 -- .../model/StreetViewPanoramaOrientation.html | 1938 -- .../google/android/gms/maps/model/Tile.html | 1692 -- .../android/gms/maps/model/TileOverlay.html | 1961 -- .../gms/maps/model/TileOverlayOptions.html | 2003 -- .../android/gms/maps/model/TileProvider.html | 1219 -- .../gms/maps/model/UrlTileProvider.html | 1632 -- .../android/gms/maps/model/VisibleRegion.html | 1975 -- .../gms/maps/model/package-summary.html | 1254 -- .../android/gms/maps/package-summary.html | 1299 -- .../com/google/android/gms/nearby/Nearby.html | 1355 -- .../gms/nearby/connection/AppIdentifier.html | 1693 -- .../gms/nearby/connection/AppMetadata.html | 1681 -- ...Connections.ConnectionRequestListener.html | 1081 -- ...onnections.ConnectionResponseCallback.html | 1082 -- ...Connections.EndpointDiscoveryListener.html | 1150 -- .../Connections.MessageListener.html | 1144 -- .../Connections.StartAdvertisingResult.html | 1168 -- .../gms/nearby/connection/Connections.html | 2534 --- .../connection/ConnectionsStatusCodes.html | 2085 -- .../nearby/connection/package-summary.html | 986 - .../android/gms/nearby/package-summary.html | 885 - .../google/android/gms/package-summary.html | 984 - .../google/android/gms/panorama/Panorama.html | 1353 -- .../panorama/PanoramaApi.PanoramaResult.html | 1148 -- .../android/gms/panorama/PanoramaApi.html | 1165 -- .../android/gms/panorama/package-summary.html | 917 - .../com/google/android/gms/plus/Account.html | 1241 -- .../gms/plus/Moments.LoadMomentsResult.html | 1319 -- .../com/google/android/gms/plus/Moments.html | 1364 -- .../gms/plus/People.LoadPeopleResult.html | 1262 -- .../android/gms/plus/People.OrderBy.html | 1121 -- .../com/google/android/gms/plus/People.html | 1534 -- .../gms/plus/Plus.PlusOptions.Builder.html | 1498 -- .../android/gms/plus/Plus.PlusOptions.html | 1365 -- .../com/google/android/gms/plus/Plus.html | 1584 -- ...eButton.DefaultOnPlusOneClickListener.html | 1556 -- .../PlusOneButton.OnPlusOneClickListener.html | 1134 -- .../android/gms/plus/PlusOneButton.html | 16196 ---------------- .../android/gms/plus/PlusOneDummyView.html | 15192 --------------- .../android/gms/plus/PlusShare.Builder.html | 2143 -- .../google/android/gms/plus/PlusShare.html | 2228 --- .../plus/model/moments/ItemScope.Builder.html | 4429 ----- .../gms/plus/model/moments/ItemScope.html | 7206 ------- .../plus/model/moments/Moment.Builder.html | 1665 -- .../gms/plus/model/moments/Moment.html | 1703 -- .../gms/plus/model/moments/MomentBuffer.html | 1816 -- .../plus/model/moments/package-summary.html | 939 - .../plus/model/people/Person.AgeRange.html | 1341 -- .../model/people/Person.Cover.CoverInfo.html | 1345 -- .../model/people/Person.Cover.CoverPhoto.html | 1453 -- .../model/people/Person.Cover.Layout.html | 1312 -- .../gms/plus/model/people/Person.Cover.html | 1517 -- .../gms/plus/model/people/Person.Gender.html | 1420 -- .../gms/plus/model/people/Person.Image.html | 1230 -- .../gms/plus/model/people/Person.Name.html | 1789 -- .../plus/model/people/Person.ObjectType.html | 1366 -- .../people/Person.Organizations.Type.html | 1366 -- .../model/people/Person.Organizations.html | 2154 -- .../plus/model/people/Person.PlacesLived.html | 1337 -- .../people/Person.RelationshipStatus.html | 1744 -- .../plus/model/people/Person.Urls.Type.html | 1474 -- .../gms/plus/model/people/Person.Urls.html | 1481 -- .../android/gms/plus/model/people/Person.html | 4000 ---- .../gms/plus/model/people/PersonBuffer.html | 1816 -- .../plus/model/people/package-summary.html | 1071 - .../android/gms/plus/package-summary.html | 1059 - .../android/gms/safetynet/SafetyNet.html | 1359 -- .../SafetyNetApi.AttestationResult.html | 1154 -- .../android/gms/safetynet/SafetyNetApi.html | 1099 -- .../gms/safetynet/package-summary.html | 917 - .../gms/search/GoogleNowAuthState.html | 1574 -- .../gms/search/SearchAuth.StatusCodes.html | 1599 -- .../google/android/gms/search/SearchAuth.html | 1383 -- .../SearchAuthApi.GoogleNowAuthResult.html | 1151 -- .../android/gms/search/SearchAuthApi.html | 1145 -- .../android/gms/search/package-summary.html | 946 - ...iderInstaller.ProviderInstallListener.html | 1136 -- .../gms/security/ProviderInstaller.html | 1559 -- .../android/gms/security/package-summary.html | 907 - .../Container.FunctionCallMacroCallback.html | 1075 - .../Container.FunctionCallTagCallback.html | 1070 - .../android/gms/tagmanager/Container.html | 1970 -- ...inerHolder.ContainerAvailableListener.html | 1071 - .../gms/tagmanager/ContainerHolder.html | 1387 -- .../android/gms/tagmanager/DataLayer.html | 1926 -- .../tagmanager/InstallReferrerReceiver.html | 1727 -- .../tagmanager/InstallReferrerService.html | 6246 ------ .../gms/tagmanager/PreviewActivity.html | 10264 ---------- .../android/gms/tagmanager/TagManager.html | 2181 --- .../gms/tagmanager/package-summary.html | 995 - .../google/android/gms/wallet/Address.html | 2185 --- .../android/gms/wallet/Cart.Builder.html | 1530 -- .../com/google/android/gms/wallet/Cart.html | 1834 -- .../gms/wallet/CountrySpecification.html | 1740 -- .../EnableWalletOptimizationReceiver.html | 1708 -- .../google/android/gms/wallet/FullWallet.html | 2189 --- .../gms/wallet/FullWalletRequest.Builder.html | 1477 -- .../android/gms/wallet/FullWalletRequest.html | 1834 -- .../gms/wallet/GiftCardWalletObject.html | 1652 -- .../android/gms/wallet/InstrumentInfo.html | 1749 -- .../android/gms/wallet/LineItem.Builder.html | 1649 -- .../android/gms/wallet/LineItem.Role.html | 1172 -- .../google/android/gms/wallet/LineItem.html | 2014 -- .../gms/wallet/LoyaltyWalletObject.html | 2025 -- .../gms/wallet/MaskedWallet.Builder.html | 1832 -- .../android/gms/wallet/MaskedWallet.html | 2318 --- .../wallet/MaskedWalletRequest.Builder.html | 2109 -- .../gms/wallet/MaskedWalletRequest.html | 2419 --- ...otifyTransactionStatusRequest.Builder.html | 1478 -- ...TransactionStatusRequest.Status.Error.html | 1377 -- ...NotifyTransactionStatusRequest.Status.html | 1084 -- .../NotifyTransactionStatusRequest.html | 1858 -- .../android/gms/wallet/OfferWalletObject.html | 1710 -- .../gms/wallet/PaymentInstrumentType.html | 1710 -- .../google/android/gms/wallet/Payments.html | 1482 -- .../google/android/gms/wallet/ProxyCard.html | 1811 -- .../wallet/Wallet.WalletOptions.Builder.html | 1463 -- .../gms/wallet/Wallet.WalletOptions.html | 1413 -- .../com/google/android/gms/wallet/Wallet.html | 1709 -- .../android/gms/wallet/WalletConstants.html | 2827 --- .../wallet/fragment/BuyButtonAppearance.html | 1424 -- .../gms/wallet/fragment/BuyButtonText.html | 1482 -- .../gms/wallet/fragment/Dimension.html | 1698 -- ...WalletFragment.OnStateChangedListener.html | 1048 - .../fragment/SupportWalletFragment.html | 3874 ---- ...WalletFragment.OnStateChangedListener.html | 1048 - .../gms/wallet/fragment/WalletFragment.html | 4068 ---- .../WalletFragmentInitParams.Builder.html | 1532 -- .../fragment/WalletFragmentInitParams.html | 1828 -- .../wallet/fragment/WalletFragmentMode.html | 1366 -- .../WalletFragmentOptions.Builder.html | 1637 -- .../fragment/WalletFragmentOptions.html | 1833 -- .../wallet/fragment/WalletFragmentState.html | 1531 -- .../wallet/fragment/WalletFragmentStyle.html | 2741 --- .../wallet/fragment/WalletLogoImageType.html | 1366 -- .../gms/wallet/fragment/package-summary.html | 1057 - .../android/gms/wallet/package-summary.html | 1221 -- .../google/android/gms/wearable/Asset.html | 2099 -- ...apabilityApi.AddLocalCapabilityResult.html | 1076 - .../CapabilityApi.CapabilityListener.html | 1111 -- ...apabilityApi.GetAllCapabilitiesResult.html | 1141 -- .../CapabilityApi.GetCapabilityResult.html | 1141 -- ...bilityApi.RemoveLocalCapabilityResult.html | 1076 - .../android/gms/wearable/CapabilityApi.html | 1594 -- .../android/gms/wearable/CapabilityInfo.html | 1117 -- .../Channel.GetInputStreamResult.html | 1211 -- .../Channel.GetOutputStreamResult.html | 1212 -- .../google/android/gms/wearable/Channel.html | 2016 -- .../wearable/ChannelApi.ChannelListener.html | 1590 -- .../gms/wearable/ChannelApi.CloseReason.html | 1126 -- .../ChannelApi.OpenChannelResult.html | 1152 -- .../android/gms/wearable/ChannelApi.html | 1302 -- .../gms/wearable/ChannelIOException.html | 1757 -- .../gms/wearable/DataApi.DataItemResult.html | 1148 -- .../gms/wearable/DataApi.DataListener.html | 1127 -- .../DataApi.DeleteDataItemsResult.html | 1149 -- .../wearable/DataApi.GetFdForAssetResult.html | 1259 -- .../google/android/gms/wearable/DataApi.html | 1929 -- .../android/gms/wearable/DataEvent.html | 1351 -- .../android/gms/wearable/DataEventBuffer.html | 1990 -- .../google/android/gms/wearable/DataItem.html | 1354 -- .../android/gms/wearable/DataItemAsset.html | 1225 -- .../android/gms/wearable/DataItemBuffer.html | 1985 -- .../google/android/gms/wearable/DataMap.html | 5176 ----- .../android/gms/wearable/DataMapItem.html | 1421 -- .../wearable/MessageApi.MessageListener.html | 1123 -- .../MessageApi.SendMessageResult.html | 1152 -- .../android/gms/wearable/MessageApi.html | 1327 -- .../android/gms/wearable/MessageEvent.html | 1224 -- .../com/google/android/gms/wearable/Node.html | 1172 -- .../NodeApi.GetConnectedNodesResult.html | 1150 -- .../wearable/NodeApi.GetLocalNodeResult.html | 1148 -- .../gms/wearable/NodeApi.NodeListener.html | 1192 -- .../google/android/gms/wearable/NodeApi.html | 1301 -- .../gms/wearable/PutDataMapRequest.html | 1592 -- .../android/gms/wearable/PutDataRequest.html | 2327 --- .../Wearable.WearableOptions.Builder.html | 1367 -- .../wearable/Wearable.WearableOptions.html | 1300 -- .../google/android/gms/wearable/Wearable.html | 1571 -- .../gms/wearable/WearableListenerService.html | 7388 ------- .../gms/wearable/WearableStatusCodes.html | 2074 -- .../android/gms/wearable/package-summary.html | 1393 -- docs/html/reference/gcm-packages.html | 690 - docs/html/reference/gcm_lists.js | 18 - docs/html/reference/gms-packages.html | 1263 -- docs/html/reference/gms_lists.js | 733 - 754 files changed, 1448183 deletions(-) delete mode 100644 docs/html/google/auth/api-client.jd delete mode 100644 docs/html/google/auth/http-auth.jd delete mode 100644 docs/html/google/play-services/auth.jd delete mode 100644 docs/html/google/play-services/index.jd delete mode 100644 docs/html/google/play-services/setup.jd delete mode 100644 docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html delete mode 100644 docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html delete mode 100644 docs/html/reference/com/google/android/gcm/GCMConstants.html delete mode 100644 docs/html/reference/com/google/android/gcm/GCMRegistrar.html delete mode 100644 docs/html/reference/com/google/android/gcm/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Constants.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Message.Builder.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Message.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/MulticastResult.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Result.Builder.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Result.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/Sender.html delete mode 100644 docs/html/reference/com/google/android/gcm/server/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/R.attr.html delete mode 100644 docs/html/reference/com/google/android/gms/R.color.html delete mode 100644 docs/html/reference/com/google/android/gms/R.drawable.html delete mode 100644 docs/html/reference/com/google/android/gms/R.html delete mode 100644 docs/html/reference/com/google/android/gms/R.id.html delete mode 100644 docs/html/reference/com/google/android/gms/R.integer.html delete mode 100644 docs/html/reference/com/google/android/gms/R.raw.html delete mode 100644 docs/html/reference/com/google/android/gms/R.string.html delete mode 100644 docs/html/reference/com/google/android/gms/R.style.html delete mode 100644 docs/html/reference/com/google/android/gms/R.styleable.html delete mode 100644 docs/html/reference/com/google/android/gms/actions/ItemListIntents.html delete mode 100644 docs/html/reference/com/google/android/gms/actions/NoteIntents.html delete mode 100644 docs/html/reference/com/google/android/gms/actions/ReserveIntents.html delete mode 100644 docs/html/reference/com/google/android/gms/actions/SearchIntents.html delete mode 100644 docs/html/reference/com/google/android/gms/actions/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/AdListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/AdRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/AdRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/AdSize.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/AdView.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/InterstitialAd.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/AppEventListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/CustomRenderedAd.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/OnCustomRenderedAdLoadedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdView.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherInterstitialAd.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/doubleclick/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/identifier/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationAdRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationAdapter.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerAdapter.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialAdapter.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/NetworkExtras.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/admob/AdMobExtras.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/admob/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBanner.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBannerListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventExtras.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitial.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitialListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/customevent/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/mediation/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchase.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseResult.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/purchase/PlayStorePurchaseListener.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/purchase/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/search/SearchAdView.html delete mode 100644 docs/html/reference/com/google/android/gms/ads/search/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/AnalyticsReceiver.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/AnalyticsService.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/CampaignTrackingReceiver.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/CampaignTrackingService.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ExceptionParser.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ExceptionReporter.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/GoogleAnalytics.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.AppViewBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.EventBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.ExceptionBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.HitBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.ItemBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.ScreenViewBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.SocialBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.TimingBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.TransactionBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/HitBuilders.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/Logger.LogLevel.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/Logger.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/StandardExceptionParser.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/Tracker.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ecommerce/Product.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ecommerce/ProductAction.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ecommerce/Promotion.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/ecommerce/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/analytics/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/Action.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/Action.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/AndroidAppUri.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/AppIndex.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.ActionResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.AppIndexingLink.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/Thing.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/Thing.html delete mode 100644 docs/html/reference/com/google/android/gms/appindexing/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppState.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateConflictResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateDeletedResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateListResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateLoadedResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateResult.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateManager.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/AppStateStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/appstate/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/AccountChangeEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/AccountChangeEventsRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/AccountChangeEventsResponse.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html delete mode 100644 docs/html/reference/com/google/android/gms/auth/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/ApplicationMetadata.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.ApplicationConnectionResult.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.CastApi.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.Listener.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.MessageReceivedCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/Cast.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/CastDevice.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/CastMediaControlIntent.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/CastStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/LaunchOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/LaunchOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaInfo.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaInfo.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaMetadata.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaStatus.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaTrack.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/MediaTrack.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.MediaChannelResult.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnMetadataUpdatedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnStatusUpdatedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/TextTrackStyle.html delete mode 100644 docs/html/reference/com/google/android/gms/cast/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/common/AccountPicker.html delete mode 100644 docs/html/reference/com/google/android/gms/common/ConnectionResult.html delete mode 100644 docs/html/reference/com/google/android/gms/common/ErrorDialogFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/common/GoogleApiAvailability.html delete mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html delete mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesRepairableException.html delete mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html delete mode 100644 docs/html/reference/com/google/android/gms/common/Scopes.html delete mode 100644 docs/html/reference/com/google/android/gms/common/SignInButton.html delete mode 100644 docs/html/reference/com/google/android/gms/common/SupportErrorDialogFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/common/UserRecoverableException.html delete mode 100644 docs/html/reference/com/google/android/gms/common/annotation/KeepName.html delete mode 100644 docs/html/reference/com/google/android/gms/common/annotation/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Api.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Batch.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Batch.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/BatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/BatchResultToken.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/CommonStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ConnectionCallbacks.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.OnConnectionFailedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.CheckResult.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/PendingResult.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/PendingResults.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Releasable.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Result.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/ResultCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Scope.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/Status.html delete mode 100644 docs/html/reference/com/google/android/gms/common/api/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/AbstractDataBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/DataBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.Observable.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/DataBufferObserverSet.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/DataBufferUtils.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/Freezable.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/FreezableUtils.html delete mode 100644 docs/html/reference/com/google/android/gms/common/data/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/common/images/ImageManager.OnImageLoadedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/common/images/ImageManager.html delete mode 100644 docs/html/reference/com/google/android/gms/common/images/WebImage.html delete mode 100644 docs/html/reference/com/google/android/gms/common/images/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/common/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/CreateFileActivityBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/Drive.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveApi.DriveContentsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveApi.DriveIdResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveApi.MetadataBufferResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveApi.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveContents.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveFile.DownloadProgressListener.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveFile.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFileResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFolderResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveFolder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveId.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.FileUploadPreferencesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveResource.MetadataResult.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveResource.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/DriveStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/ExecutionOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/ExecutionOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/FileUploadPreferences.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/Metadata.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/MetadataBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/OpenFileActivityBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/ChangeEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/ChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/CompletionEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/CompletionListener.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/DriveEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/DriveEventService.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/ResourceEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/events/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/CustomPropertyKey.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/MetadataField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/SearchableCollectionMetadataField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/SearchableMetadataField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/SearchableOrderedMetadataField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/SortableMetadataField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/metadata/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/Filter.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/Filters.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/Query.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/Query.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/SearchableField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/SortOrder.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/SortOrder.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/SortableField.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/query/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/widget/DataBufferAdapter.html delete mode 100644 docs/html/reference/com/google/android/gms/drive/widget/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/BleApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/ConfigApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/Fitness.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/FitnessActivities.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/FitnessStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/HistoryApi.ViewIntentBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/HistoryApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/RecordingApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/SensorsApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/SessionsApi.ViewIntentBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/SessionsApi.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/BleDevice.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Bucket.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/DataPoint.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/DataSet.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/DataSource.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/DataSource.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/DataType.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Device.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Field.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Session.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Session.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Subscription.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/Value.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/data/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/BleScanCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/OnDataPointListener.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/request/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/BleDevicesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/DailyTotalResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/DataReadResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/DataSourcesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/DataTypeResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/ListSubscriptionsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/SessionReadResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/SessionStopResult.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/result/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorService.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorServiceRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/service/SensorEventDispatcher.html delete mode 100644 docs/html/reference/com/google/android/gms/fitness/service/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Game.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GameBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GameEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Games.GamesOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Games.GamesOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Games.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GamesActivityResultCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GamesMetadata.LoadGamesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GamesMetadata.html delete mode 100644 docs/html/reference/com/google/android/gms/games/GamesStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Notifications.html delete mode 100644 docs/html/reference/com/google/android/gms/games/PageDirection.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Player.html delete mode 100644 docs/html/reference/com/google/android/gms/games/PlayerBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/PlayerEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/PlayerLevel.html delete mode 100644 docs/html/reference/com/google/android/gms/games/PlayerLevelInfo.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Players.LoadPlayersResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Players.LoadProfileSettingsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/Players.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/Achievement.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/AchievementBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/AchievementEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/Achievements.LoadAchievementsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/Achievements.UpdateAchievementResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/Achievements.html delete mode 100644 docs/html/reference/com/google/android/gms/games/achievement/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/Event.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/EventBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/EventEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/Events.LoadEventsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/Events.html delete mode 100644 docs/html/reference/com/google/android/gms/games/event/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboard.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScore.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScoreBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardVariant.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadPlayerScoreResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadScoresResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.SubmitScoreResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.Result.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.html delete mode 100644 docs/html/reference/com/google/android/gms/games/leaderboard/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Invitation.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/InvitationBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/InvitationEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.LoadInvitationsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Multiplayer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/OnInvitationReceivedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Participant.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantUtils.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/Participatable.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.ReliableMessageSentCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/LoadMatchesResponse.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/OnTurnBasedMatchUpdateReceivedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatch.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.CancelMatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.InitiateMatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LeaveMatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.UpdateMatchResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Milestone.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/MilestoneBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/MilestoneEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Quest.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/QuestBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/QuestEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/QuestUpdateListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Quests.AcceptQuestResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Quests.ClaimMilestoneResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Quests.LoadQuestsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/Quests.html delete mode 100644 docs/html/reference/com/google/android/gms/games/quest/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/GameRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/GameRequestBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/GameRequestEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/OnRequestReceivedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/Requests.LoadRequestsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/Requests.UpdateRequestsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/Requests.html delete mode 100644 docs/html/reference/com/google/android/gms/games/request/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshot.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotContents.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadata.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataEntity.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.CommitSnapshotResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.DeleteSnapshotResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.LoadSnapshotsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.OpenSnapshotResult.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.html delete mode 100644 docs/html/reference/com/google/android/gms/games/snapshot/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html delete mode 100644 docs/html/reference/com/google/android/gms/gcm/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/Address.AddressOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/Address.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ErrorCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Extras.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ResultCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Themes.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/model/CountrySpecification.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/model/UserAddress.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/model/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/identity/intents/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/location/ActivityRecognition.html delete mode 100644 docs/html/reference/com/google/android/gms/location/ActivityRecognitionApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/ActivityRecognitionResult.html delete mode 100644 docs/html/reference/com/google/android/gms/location/DetectedActivity.html delete mode 100644 docs/html/reference/com/google/android/gms/location/FusedLocationProviderApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/Geofence.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/location/Geofence.html delete mode 100644 docs/html/reference/com/google/android/gms/location/GeofenceStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/location/GeofencingApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/GeofencingEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/location/GeofencingRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/location/GeofencingRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationAvailability.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationListener.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationResult.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationServices.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationSettingsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationSettingsStates.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationSettingsStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/location/LocationStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/location/SettingsApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/AddPlaceRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/AutocompleteFilter.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.Substring.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/AutocompletePredictionBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/GeoDataApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/Place.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceDetectionApi.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceFilter.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceLikelihood.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceLikelihoodBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceReport.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlaceTypes.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/Places.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlacesOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlacesOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/PlacesStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.IntentBuilder.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.html delete mode 100644 docs/html/reference/com/google/android/gms/location/places/ui/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/CameraUpdate.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnIndoorStateChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLoadedCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationButtonClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.SnapshotReadyCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/LocationSource.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/MapFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/MapView.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/MapsInitializer.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/OnMapReadyCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/OnStreetViewPanoramaReadyCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/Projection.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaChangeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaLongClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaView.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/SupportStreetViewPanoramaFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/UiSettings.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/Circle.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/CircleOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/IndoorBuilding.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/IndoorLevel.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLng.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/Marker.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/Polygon.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/Polyline.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLink.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLocation.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/Tile.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileProvider.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/model/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/maps/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/Nearby.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/AppIdentifier.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/AppMetadata.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionRequestListener.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionResponseCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.EndpointDiscoveryListener.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.MessageListener.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.StartAdvertisingResult.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/Connections.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/ConnectionsStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/connection/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/nearby/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/panorama/Panorama.html delete mode 100644 docs/html/reference/com/google/android/gms/panorama/PanoramaApi.PanoramaResult.html delete mode 100644 docs/html/reference/com/google/android/gms/panorama/PanoramaApi.html delete mode 100644 docs/html/reference/com/google/android/gms/panorama/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Account.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Moments.LoadMomentsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Moments.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/People.LoadPeopleResult.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/People.OrderBy.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/People.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/Plus.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneButton.DefaultOnPlusOneClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneButton.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneDummyView.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/PlusShare.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/Moment.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/Moment.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/MomentBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/moments/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.AgeRange.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverInfo.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverPhoto.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.Layout.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Gender.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Image.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Name.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.ObjectType.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.Type.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.PlacesLived.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.RelationshipStatus.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.Type.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/Person.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/PersonBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/model/people/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/plus/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/safetynet/SafetyNet.html delete mode 100644 docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.AttestationResult.html delete mode 100644 docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.html delete mode 100644 docs/html/reference/com/google/android/gms/safetynet/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/search/GoogleNowAuthState.html delete mode 100644 docs/html/reference/com/google/android/gms/search/SearchAuth.StatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/search/SearchAuth.html delete mode 100644 docs/html/reference/com/google/android/gms/search/SearchAuthApi.GoogleNowAuthResult.html delete mode 100644 docs/html/reference/com/google/android/gms/search/SearchAuthApi.html delete mode 100644 docs/html/reference/com/google/android/gms/search/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/security/ProviderInstaller.ProviderInstallListener.html delete mode 100644 docs/html/reference/com/google/android/gms/security/ProviderInstaller.html delete mode 100644 docs/html/reference/com/google/android/gms/security/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallMacroCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallTagCallback.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/Container.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.ContainerAvailableListener.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/DataLayer.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerReceiver.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerService.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/PreviewActivity.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/TagManager.html delete mode 100644 docs/html/reference/com/google/android/gms/tagmanager/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Address.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Cart.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Cart.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/CountrySpecification.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/EnableWalletOptimizationReceiver.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/FullWallet.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/GiftCardWalletObject.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/InstrumentInfo.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/LineItem.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/LineItem.Role.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/LineItem.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/LoyaltyWalletObject.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/MaskedWallet.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/MaskedWallet.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.Error.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/OfferWalletObject.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/PaymentInstrumentType.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Payments.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/ProxyCard.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/Wallet.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/WalletConstants.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonAppearance.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonText.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/Dimension.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.OnStateChangedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.OnStateChangedListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentMode.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentState.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentStyle.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/WalletLogoImageType.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/fragment/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/wallet/package-summary.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Asset.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.AddLocalCapabilityResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.CapabilityListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetAllCapabilitiesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetCapabilityResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.RemoveLocalCapabilityResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityApi.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/CapabilityInfo.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Channel.GetInputStreamResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Channel.GetOutputStreamResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Channel.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/ChannelApi.ChannelListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/ChannelApi.CloseReason.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/ChannelApi.OpenChannelResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/ChannelApi.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/ChannelIOException.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataApi.DataItemResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataApi.DataListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataApi.DeleteDataItemsResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataApi.GetFdForAssetResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataApi.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataEventBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataItem.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataItemAsset.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataItemBuffer.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataMap.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/DataMapItem.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/MessageApi.MessageListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/MessageApi.SendMessageResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/MessageApi.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/MessageEvent.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Node.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/NodeApi.GetConnectedNodesResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/NodeApi.GetLocalNodeResult.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/NodeApi.NodeListener.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/NodeApi.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/PutDataMapRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/PutDataRequest.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.Builder.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/Wearable.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/WearableListenerService.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/WearableStatusCodes.html delete mode 100644 docs/html/reference/com/google/android/gms/wearable/package-summary.html delete mode 100644 docs/html/reference/gcm-packages.html delete mode 100644 docs/html/reference/gcm_lists.js delete mode 100644 docs/html/reference/gms-packages.html delete mode 100644 docs/html/reference/gms_lists.js diff --git a/docs/html/google/auth/api-client.jd b/docs/html/google/auth/api-client.jd deleted file mode 100644 index 8f926f571f6d..000000000000 --- a/docs/html/google/auth/api-client.jd +++ /dev/null @@ -1,654 +0,0 @@ -page.title=Accessing Google APIs -page.tags="oauth 2.0","GoogleAuthUtil" - -trainingnavtop=true -startpage=true - -@jd:body - -
- -
- - -

When you want to make a connection to one of the Google APIs provided in the Google Play services -library (such as Google+, Games, or Drive), you need to create an instance of {@code -GoogleApiClient} ("Google API Client"). The Google API Client provides a common entry point to all -the Google Play services and manages the network connection between the user's device and each -Google service.

- -
-

Connecting to REST APIs

-

If the Google API you want to use is not included in the Google Play services library, you can -connect using the appropriate REST API, but you must obtain an OAuth 2.0 token. For more -information, read Authorizing with Google -for REST APIs.

-
- -

This guide shows how you can use Google API Client to:

- - -

-Note: If you have an existing app that connects to Google Play services with a -subclass of {@code GooglePlayServicesClient}, you should migrate to {@code -GoogleApiClient} as soon as possible.

- - - -

-Figure 1. An illustration showing how the Google API Client provides an -interface for connecting and making calls to any of the available Google Play services such as -Google Play Games and Google Drive.

- - - -

To get started, you must first install the Google Play services library (revision 15 or higher) for -your Android SDK. If you haven't done so already, follow the instructions in Set Up Google -Play Services SDK.

- - - - -

Start a Connection

- -

Once your project is linked to the Google Play services library, create an instance of {@code -GoogleApiClient} using the {@code -GoogleApiClient.Builder} APIs in your activity's {@link -android.app.Activity#onCreate onCreate()} method. The {@code -GoogleApiClient.Builder} class -provides methods that allow you to specify the Google APIs you want to use and your desired OAuth -2.0 scopes. For example, here's a {@code -GoogleApiClient} instance that connects with the Google -Drive service:

-
-GoogleApiClient mGoogleApiClient = new GoogleApiClient.Builder(this)
-    .addApi(Drive.API)
-    .addScope(Drive.SCOPE_FILE)
-    .build();
-
- -

You can add multiple APIs and multiple scopes to the same {@code -GoogleApiClient} by appending -additional calls to -{@code addApi()} and -{@code addScope()}.

- -

-Important: If you are adding multiple APIs to a -GoogleApiClient, -you may run into client connection errors on devices that do not have the -Android -Wear app installed. To avoid connection errors, call the -{@code addApiIfAvailable()} -method and pass in the {@code -Wearable} API to indicate that your client should gracefully handle the missing API. -For more information, see Access the Wearable API.

- -

Before you can begin a connection by calling {@code connect()} on the {@code -GoogleApiClient}, you must specify an implementation for the callback interfaces, {@code ConnectionCallbacks} and {@code OnConnectionFailedListener}. These interfaces receive callbacks in -response to the asynchronous {@code connect()} method when the connection to Google Play services -succeeds, fails, or becomes suspended.

- -

For example, here's an activity that implements the callback interfaces and adds them to the Google -API Client:

- -
-import com.google.android.gms.common.api.GoogleApiClient;
-import com.google.android.gms.common.api.GoogleApiClient.ConnectionCallbacks;
-import com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener;
-import gms.drive.*;
-import android.support.v4.app.FragmentActivity;
-
-public class MyActivity extends FragmentActivity
-        implements ConnectionCallbacks, OnConnectionFailedListener {
-    private GoogleApiClient mGoogleApiClient;
-
-    @Override
-    protected void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
-
-        // Create a GoogleApiClient instance
-        mGoogleApiClient = new GoogleApiClient.Builder(this)
-                .addApi(Drive.API)
-                .addScope(Drive.SCOPE_FILE)
-                .addConnectionCallbacks(this)
-                .addOnConnectionFailedListener(this)
-                .build();
-        ...
-    }
-
-    @Override
-    public void onConnected(Bundle connectionHint) {
-        // Connected to Google Play services!
-        // The good stuff goes here.
-    }
-
-    @Override
-    public void onConnectionSuspended(int cause) {
-        // The connection has been interrupted.
-        // Disable any UI components that depend on Google APIs
-        // until onConnected() is called.
-    }
-
-    @Override
-    public void onConnectionFailed(ConnectionResult result) {
-        // This callback is important for handling errors that
-        // may occur while attempting to connect with Google.
-        //
-        // More about this in the next section.
-        ...
-    }
-}
-
- -

With the callback interfaces defined, you're ready to call {@code connect()}. To gracefully manage -the lifecycle of the connection, you should call {@code connect()} during the activity's {@link -android.app.Activity#onStart onStart()} (unless you want to connect later), then call {@code disconnect()} during the {@link android.app.Activity#onStop onStop()} method. For example:

-
-    @Override
-    protected void onStart() {
-        super.onStart();
-        if (!mResolvingError) {  // more about this later
-            mGoogleApiClient.connect();
-        }
-    }
-
-    @Override
-    protected void onStop() {
-        mGoogleApiClient.disconnect();
-        super.onStop();
-    }
-
- -

However, if you run this code, there's a good chance it will fail and your app will receive a call -to {@code onConnectionFailed()} with the {@code SIGN_IN_REQUIRED} error because the user account -has not been specified. The next section shows how to handle this error and others.

- - -

Handle connection failures

- -

When you receive a call to the - -{@code onConnectionFailed()} callback, you should call {@code hasResolution()} on the provided {@code ConnectionResult} object. If it returns true, you can -request the user take immediate action to resolve the error by calling {@code startResolutionForResult()} on the {@code ConnectionResult} object. The {@code startResolutionForResult()} behaves the same as {@link -android.app.Activity#startActivityForResult startActivityForResult()} and launches the -appropriate activity for the user -to resolve the error (such as an activity to select an account).

- -

If {@code hasResolution()} returns false, you should instead call {@code GooglePlayServicesUtil.getErrorDialog()}, passing it the error code. This returns a {@link -android.app.Dialog} provided by Google Play services that's appropriate for the given error. The -dialog may simply provide a message explaining the error, but it may also provide an action to -launch an activity that can resolve the error (such as when the user needs to install a newer -version of Google Play services).

- -

For example, your -{@code onConnectionFailed()} callback method should now look like this:

- -
-public class MyActivity extends FragmentActivity
-        implements ConnectionCallbacks, OnConnectionFailedListener {
-
-    // Request code to use when launching the resolution activity
-    private static final int REQUEST_RESOLVE_ERROR = 1001;
-    // Unique tag for the error dialog fragment
-    private static final String DIALOG_ERROR = "dialog_error";
-    // Bool to track whether the app is already resolving an error
-    private boolean mResolvingError = false;
-
-    ...
-
-    @Override
-    public void onConnectionFailed(ConnectionResult result) {
-        if (mResolvingError) {
-            // Already attempting to resolve an error.
-            return;
-        } else if (result.hasResolution()) {
-            try {
-                mResolvingError = true;
-                result.startResolutionForResult(this, REQUEST_RESOLVE_ERROR);
-            } catch (SendIntentException e) {
-                // There was an error with the resolution intent. Try again.
-                mGoogleApiClient.connect();
-            }
-        } else {
-            // Show dialog using GooglePlayServicesUtil.getErrorDialog()
-            showErrorDialog(result.getErrorCode());
-            mResolvingError = true;
-        }
-    }
-
-    // The rest of this code is all about building the error dialog
-
-    /* Creates a dialog for an error message */
-    private void showErrorDialog(int errorCode) {
-        // Create a fragment for the error dialog
-        ErrorDialogFragment dialogFragment = new ErrorDialogFragment();
-        // Pass the error that should be displayed
-        Bundle args = new Bundle();
-        args.putInt(DIALOG_ERROR, errorCode);
-        dialogFragment.setArguments(args);
-        dialogFragment.show(getSupportFragmentManager(), "errordialog");
-    }
-
-    /* Called from ErrorDialogFragment when the dialog is dismissed. */
-    public void onDialogDismissed() {
-        mResolvingError = false;
-    }
-
-    /* A fragment to display an error dialog */
-    public static class ErrorDialogFragment extends DialogFragment {
-        public ErrorDialogFragment() { }
-
-        @Override
-        public Dialog onCreateDialog(Bundle savedInstanceState) {
-            // Get the error code and retrieve the appropriate dialog
-            int errorCode = this.getArguments().getInt(DIALOG_ERROR);
-            return GooglePlayServicesUtil.getErrorDialog(errorCode,
-                    this.getActivity(), REQUEST_RESOLVE_ERROR);
-        }
-
-        @Override
-        public void onDismiss(DialogInterface dialog) {
-            ((MainActivity)getActivity()).onDialogDismissed();
-        }
-    }
-}
-
- -

Once the user completes the resolution provided by {@code startResolutionForResult()} or {@code GooglePlayServicesUtil.getErrorDialog()}, your activity receives the {@link -android.app.Activity#onActivityResult onActivityResult()} callback with the {@link -android.app.Activity#RESULT_OK} -result code. You can then call {@code connect()} again. For example:

- -
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-    if (requestCode == REQUEST_RESOLVE_ERROR) {
-        mResolvingError = false;
-        if (resultCode == RESULT_OK) {
-            // Make sure the app is not already connected or attempting to connect
-            if (!mGoogleApiClient.isConnecting() &&
-                    !mGoogleApiClient.isConnected()) {
-                mGoogleApiClient.connect();
-            }
-        }
-    }
-}
-
- -

In the above code, you probably noticed the boolean, {@code mResolvingError}. This keeps track of -the app state while the user is resolving the error to avoid repetitive attempts to resolve the -same error. For instance, while the account picker dialog is showing to resolve the {@code SIGN_IN_REQUIRED} error, the user may rotate the screen. This recreates your activity and causes -your {@link android.app.Activity#onStart onStart()} method to be called again, which then calls {@code connect()} again. This results in another call to {@code startResolutionForResult()}, which -creates another account picker dialog in front of the existing one.

- -

This boolean is effective only -if retained across activity instances, though. The next section explains further.

- - - -

Maintain state while resolving an error

- -

To avoid executing the code in - -{@code onConnectionFailed()} while a previous attempt to resolve an -error is ongoing, you need to retain a boolean that tracks whether your app is already attempting -to resolve an error.

- -

As shown in the code above, you should set a boolean to {@code true} each time you call {@code startResolutionForResult()} or display the dialog from {@code GooglePlayServicesUtil.getErrorDialog()}. Then when you -receive {@link android.app.Activity#RESULT_OK} in the {@link android.app.Activity#onActivityResult -onActivityResult()} callback, set the boolean to {@code false}.

- -

To keep track of the boolean across activity restarts (such as when the user rotates the screen), -save the boolean in the activity's saved instance data using {@link -android.app.Activity#onSaveInstanceState onSaveInstanceState()}:

- -
-private static final String STATE_RESOLVING_ERROR = "resolving_error";
-
-@Override
-protected void onSaveInstanceState(Bundle outState) {
-    super.onSaveInstanceState(outState);
-    outState.putBoolean(STATE_RESOLVING_ERROR, mResolvingError);
-}
-
- -

Then recover the saved state during {@link android.app.Activity#onCreate onCreate()}:

- -
-@Override
-protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-
-    ...
-    mResolvingError = savedInstanceState != null
-            && savedInstanceState.getBoolean(STATE_RESOLVING_ERROR, false);
-}
-
- -

Now you're ready to safely run your app and connect to Google Play services. -How you can perform read and write requests to any of the Google Play services -using {@code -GoogleApiClient} is discussed in the next section.

- -

For more information about each services's APIs available once you're connected, -consult the corresponding documentation, such as for -Google Play Games or -Google Drive. -

- - -

Access the Wearable API

- -

The Wearable API provides a communication channel for your handheld and wearable apps. The API -consists of a set of data objects that the system can send and synchronize over the wire and -listeners that notify your apps of important events with the data layer. The -{@code Wearable} -API is available on devices running Android 4.3 (API level 18) or higher when a wearable device is -connected. The API is not available under the following conditions: -

- - - -

Using only the Wearable API

- -

If your app uses the -{@code Wearable} -API but not other Google APIs, you can add this API by calling the -{@code addApi()} method. The following example shows how to add the -{@code Wearable} -API to your {@code -GoogleApiClient} instance:

- -
-GoogleApiClient mGoogleApiClient = new GoogleApiClient.Builder(this)
-    .addApi(Wearable.API)
-    .build();
-
- -

In situations where the -{@code Wearable} -API is not available, connection requests that include the {@code -Wearable} API fail with the -API_UNAVAILABLE error code.

- -

-The following example shows how to determine whether the -{@code Wearable} -API is available: -

- -
-// Connection failed listener method for a client that only
-// requests access to the Wearable API
-@Override
-public void onConnectionFailed(ConnectionResult result) {
-    if (result.getErrorCode() == ConnectionResult.API_UNAVAILABLE) {
-        // The Wearable API is unavailable
-    }
-    ...
-}
-
- - -

Using the Wearable API with other APIs

- -

-If your app uses the -{@code Wearable} -API in addition to other Google APIs, call the -addApiIfAvailable() -method and pass in the -{@code Wearable} -API to indicate that your client should gracefully handle the missing API.

- -

The following example shows how to access the -{@code Wearable} -API along with the -{@code Drive} -API:

- -
-// Create a GoogleApiClient instance
-mGoogleApiClient = new GoogleApiClient.Builder(this)
-        .addApi(Drive.API)
-        .addApiIfAvailable(Wearable.API)
-        .addScope(Drive.SCOPE_FILE)
-        .addConnectionCallbacks(this)
-        .addOnConnectionFailedListener(this)
-        .build();
-
- -

In the example above, the -{@code GoogleApiClient} -can successfully connect with the Google Drive service without connecting to the -{@code Wearable} -API if it is unavailable. After you connect your -{@code GoogleApiClient} -instance, ensure that the -{@code Wearable} -API is available before making the API calls: -

- -
-mGoogleApiClient.hasConnectedApi(Wearable.API);
-
- - -

Communicate with Google Services

- -

Once connected, your client can make read and write calls using the service-specific APIs for which -your app is authorized, as specified by the APIs and scopes you added to your {@code -GoogleApiClient} instance.

- -

-Note: Before making calls to specific Google services, you may first need to -register your app in the Google Developer Console. For specific instructions, refer to the -appropriate getting started guide for the API you're using, such as Google Drive or Google+.

- -

When you perform a read or write request using Google API Client, the immediate result is returned -as a {@code -PendingResult} object. This is an object representing the request, which hasn't yet -been delivered to the Google service.

- -

For example, here's a request to read a file from Google Drive that provides a -{@code -PendingResult} object:

- -
-Query query = new Query.Builder()
-        .addFilter(Filters.eq(SearchableField.TITLE, filename));
-PendingResult result = Drive.DriveApi.query(mGoogleApiClient, query);
-
- -

Once you have the -{@code -PendingResult}, you can continue by making the request either asynchronous -or synchronous.

- - -

Using asynchronous calls

- -

To make the request asynchronous, call {@code setResultCallback()} on the -{@code -PendingResult} and -provide an implementation of the {@code ResultCallback} interface. For example, here's the request -executed asynchronously:

- -
-private void loadFile(String filename) {
-    // Create a query for a specific filename in Drive.
-    Query query = new Query.Builder()
-            .addFilter(Filters.eq(SearchableField.TITLE, filename))
-            .build();
-    // Invoke the query asynchronously with a callback method
-    Drive.DriveApi.query(mGoogleApiClient, query)
-            .setResultCallback(new ResultCallback<DriveApi.MetadataBufferResult>() {
-        @Override
-        public void onResult(DriveApi.MetadataBufferResult result) {
-            // Success! Handle the query result.
-            ...
-        }
-    });
-}
-
- -

When your app receives a {@code Result} -object in the {@code onResult()} callback, it is delivered as an instance of the -appropriate subclass as specified by the API you're using, such as {@code DriveApi.MetadataBufferResult}.

- - -

Using synchronous calls

- -

If you want your code to execute in a strictly defined order, perhaps because the result of one -call is needed as an argument to another, you can make your request synchronous by calling {@code await()} on the -{@code -PendingResult}. This blocks the thread and returns the {@code Result} object -when the request completes, which is delivered as an instance of the -appropriate subclass as specified by the API you're using, such as {@code DriveApi.MetadataBufferResult}.

- -

Because calling {@code await()} blocks the thread until the result arrives, it's important that you -never perform this call on the UI thread. So, if you want to perform synchronous requests to a -Google Play service, you should create a new thread, such as with {@link android.os.AsyncTask} in -which to perform the request. For example, here's how to perform the same file request to Google -Drive as a synchronous call:

- -
-private void loadFile(String filename) {
-    new GetFileTask().execute(filename);
-}
-
-private class GetFileTask extends AsyncTask<String, Void, Void> {
-    protected void doInBackground(String filename) {
-        Query query = new Query.Builder()
-                .addFilter(Filters.eq(SearchableField.TITLE, filename))
-                .build();
-        // Invoke the query synchronously
-        DriveApi.MetadataBufferResult result =
-                Drive.DriveApi.query(mGoogleApiClient, query).await();
-
-        // Continue doing other stuff synchronously
-        ...
-    }
-}
-
- -

-Tip: You can also enqueue read requests while not connected to Google Play -services. For example, execute a method to read a file from Google Drive regardless of whether your -Google API Client is connected yet. Then once a connection is established, the read requests -execute and you'll receive the results. Any write requests, however, will generate an error if you -call them while your Google API Client is not connected.

- diff --git a/docs/html/google/auth/http-auth.jd b/docs/html/google/auth/http-auth.jd deleted file mode 100644 index 7d34d89d04bd..000000000000 --- a/docs/html/google/auth/http-auth.jd +++ /dev/null @@ -1,558 +0,0 @@ -page.title=Authorizing with Google for REST APIs -page.tags="oauth 2.0","GoogleAuthUtil" - -trainingnavtop=true -startpage=true - -@jd:body - - -
- -
- -

When you want your Android app to access Google APIs using the user's Google account over -HTTP, the {@code GoogleAuthUtil} -class and related APIs provide your users a secure and consistent experience for picking an -account and retrieving an OAuth 2.0 token for your app.

- -

You can then use that token in your HTTP-based communications with Google API services -that are not included in the Google Play -services library, such as the Blogger or Translate APIs.

- -

Note: An OAuth 2.0 token using {@code GoogleAuthUtil} -is required only for certain types of Google -APIs that you need to access over HTTP. If you're instead using the Google Play services library to access Google -APIs such as Google+ or Play Games, you don't need an OAuth 2.0 -token and you can instead access these services using the {@code GoogleApiClient}. For more -information, read Accessing Google Play -Services APIs.

- -

To get started with {@code GoogleAuthUtil} -for accessing Google's REST APIs, you must set up your Android app project with the Google Play -services library. Follow the procedures in Setup Google Play Services SDK.

- - - - -

Register Your App

- -

Before you can publish an app that retrieves an OAuth 2.0 token for Google REST APIs, -you must register your Android app with the Google Cloud Console by providing your app's -package name and the SHA1 fingerprint of the keystore with which you sign your release APK.

- -

Caution: While you are testing an APK that's signed with a -debug key, Google does not require that your app be registered in Google Cloud Console. However, -your app must be registered in Google Cloud Console in order to continue working once it is -signed -with a release key.

- -

To register your Android app with Google Cloud Console:

- -
    -
  1. Visit Google Cloud Console. -
  2. If you have an existing project to which you're adding an Android app, select the project. -Otherwise, click Create project at the top, enter your project name and ID, -then click Create. -

    Note: The name you provide for the project is the name that -appears to users in the Google Settings app in the list of Connected apps.

    -
  3. In the left-side navigation, select APIs & auth. -
  4. Enable the API you'd like to use by setting the Status to ON. - -
  5. In the left-side navigation, select Credentials. -
  6. Click Create new client ID or Create new key -as appropriate for your app.
    7. -
  7. Complete the form that appears by filling in your Android app details. -

    To get the SHA1 fingerprint for your app, run the following command in a terminal: -

    -keytool -exportcert -alias <keystore_alias> -keystore <keystore_path> -list -v
-
    -

    For example, you're using a debug-key with Eclipse, then the command looks like this:

    -
    -keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -list -v
-
    -

    Then the keystore password is "android".

    -
    8. -
  8. Click Create. -
- -

The Credentials page then provides the available credentials such as an OAuth 2.0 client ID and -an Android Key, but you don't need these to authorize your Android users. Simply registering your -app with the package name and SHA1 makes the Google services accessible by your app. - - -

To acquire the OAuth 2.0 token that will grant you access to Google APIs over HTTP, you need to -first identify the user's Google account with which you'll query the servers. For this task, the -Google Play services library provides a convenient account picker dialog you can invoke using -{@code -AccountPicker}. The result delivered to your activity from the account picker is the account -name you'll use to request the OAuth 2.0 token in the next lesson.

- -

Note: In order to use the APIs discussed here, you must -include the Google Play services library with your project. If you haven't set up your project -with the library yet, read the guide to Setup Google Play Services SDK.

- - - -

Invoke the Account Picker

- -

To open the account picker dialog that's managed by the Google Play services library, call -{@link android.app.Activity#startActivityForResult startActivityForResult()} using an {@link -android.content.Intent} returned by -{@code AccountPicker.newChooseAccountIntent}.

- - -

For example:

-
-static final int REQUEST_CODE_PICK_ACCOUNT = 1000;
-
-private void pickUserAccount() {
-    String[] accountTypes = new String[]{"com.google"};
-    Intent intent = AccountPicker.newChooseAccountIntent(null, null,
-            accountTypes, false, null, null, null, null);
-    startActivityForResult(intent, REQUEST_CODE_PICK_ACCOUNT);
-}
-
- -

When this code executes, a dialog appears for the user to pick an account. When the user -selects the account, your activity receives the result in the {@link -android.app.Activity#onActivityResult onActivityResult()} callback.

- -

Most apps should pass the -{@code newChooseAccountIntent()} method the same arguments shown in the above example, -which indicate that:

- - - - -

For more details about these arguments, see the -{@code newChooseAccountIntent()} method documentation.

- - - - -

Retrieve the Account Name

- -

Once the user selects an account, your activity receives a call to its -{@link android.app.Activity#onActivityResult onActivityResult()} method. The received -{@link android.content.Intent} includes an extra for -{@link android.accounts.AccountManager#KEY_ACCOUNT_NAME}, specifying the account name -(an email address) you must use to acquire the OAuth 2.0 token.

- -

Here's an example implementation of the callback {@link android.app.Activity#onActivityResult -onActivityResult()} that receives the selected account:

- -
-String mEmail; // Received from {@code newChooseAccountIntent()}; passed to {@code getToken()}
-
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-    if (requestCode == REQUEST_CODE_PICK_ACCOUNT) {
-        // Receiving a result from the AccountPicker
-        if (resultCode == RESULT_OK) {
-            mEmail = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
-            // With the account name acquired, go get the auth token
-            getUsername();
-        } else if (resultCode == RESULT_CANCELED) {
-            // The account picker dialog closed without selecting an account.
-            // Notify users that they must pick an account to proceed.
-            Toast.makeText(this, R.string.pick_account, Toast.LENGTH_SHORT).show();
-        }
-    }
-    // Later, more code will go here to handle the result from some exceptions...
-}
-
- -

You can now pass the account name held by {@code mEmail} to -{@code GoogleAuthUtil.getToken()} (which is what the {@code getUsername()} method -does), but because it performs network transactions, this method should not be called from the -UI thread. The next lesson shows how to create an {@link android.os.AsyncTask} to get the auth token -on a separate thread.

- - -

Once you have retrieved the account name for the user's Google account, you can call -{@code GoogleAuthUtil.getToken()}, which returns the access token string required by Google API -services.

- - -

Calling this method is generally a straightforward procedure, but you must be -aware that:

- - -

This lesson shows how you can gracefully handle these concerns by performing authentication in -an {@link android.os.AsyncTask} and providing users with the appropriate information and available -actions during known exceptions.

- -

Note: The code shown in this lesson, using {@code GoogleAuthUtil.getToken()}, -is appropriate when you will be requesting the OAuth token from an {@link android.app.Activity}. -However, if you need to request the OAuth token from a {@link android.app.Service}, then you -should instead use {@code -getTokenWithNotification()}. This method works the same as {@code GoogleAuthUtil.getToken()}, but if an error occurs, it -also creates an appropriate -notification -that allows the user can recover from the error. -The sample available for download above includes code showing how to use this method instead.

- - -

Extend AsyncTask to Get the Auth Token

- -

The {@link android.os.AsyncTask} class provides a simple way to create a worker thread for jobs -that should not run on your UI thread. This lesson focuses on how to create such a thread -to get your auth token; for a more complete discussion about {@link android.os.AsyncTask}, -read Keeping Your -App Responsive and the {@link android.os.AsyncTask} class reference.

- - -

The {@link android.os.AsyncTask#doInBackground doInBackground()} method in your {@link -android.os.AsyncTask} class is where you should call the -{@code GoogleAuthUtil.getToken()} method. You can also use it to catch some of the generic -exceptions that may occur during your network transactions.

- -

For example, here's part of an {@link android.os.AsyncTask} subclass that calls -{@code GoogleAuthUtil.getToken()}:

- -
-public class GetUsernameTask extends AsyncTask{
-    Activity mActivity;
-    String mScope;
-    String mEmail;
-
-    GetUsernameTask(Activity activity, String name, String scope) {
-        this.mActivity = activity;
-        this.mScope = scope;
-        this.mEmail = name;
-    }
-
-    /**
-     * Executes the asynchronous job. This runs when you call execute()
-     * on the AsyncTask instance.
-     */
-    @Override
-    protected Void doInBackground(Void... params) {
-        try {
-            String token = fetchToken();
-            if (token != null) {
-                // Insert the good stuff here.
-                // Use the token to access the user's Google data.
-                ...
-            }
-        } catch (IOException e) {
-            // The fetchToken() method handles Google-specific exceptions,
-            // so this indicates something went wrong at a higher level.
-            // TIP: Check for network connectivity before starting the AsyncTask.
-            ...
-        }
-        return null;
-    }
-
-    /**
-     * Gets an authentication token from Google and handles any
-     * GoogleAuthException that may occur.
-     */
-    protected String fetchToken() throws IOException {
-        try {
-            return GoogleAuthUtil.getToken(mActivity, mEmail, mScope);
-        } catch (UserRecoverableAuthException userRecoverableException) {
-            // GooglePlayServices.apk is either old, disabled, or not present
-            // so we need to show the user some UI in the activity to recover.
-            mActivity.handleException(userRecoverableException);
-        } catch (GoogleAuthException fatalException) {
-            // Some other type of unrecoverable exception has occurred.
-            // Report and log the error as appropriate for your app.
-            ...
-        }
-        return null;
-    }
-    ...
-}
-
- -

In order to call -{@code GoogleAuthUtil.getToken()}, you must provide the app {@link android.content.Context}, -the account name retrieved from the account picker, and the scope for your auth -token request. The above sample code (and the attached sample) defines these -arguments with class members that the host activity passes to the {@link android.os.AsyncTask} class constructor. For more information about setting the scope, see -the Specifying Scopes section below.

- -

Note: -As shown by the {@code fetchToken()} method above, you must handle -special exceptions that may occur during the -{@code GoogleAuthUtil.getToken()} method. The next section shows how you should -respond to these exceptions.

- -

Once you have an {@link android.os.AsyncTask} subclass defined, -you can instantiate and execute an instance after you get the user's -account name from the account picker. -For example, back in the {@link android.app.Activity} class you can do something like this:

- -
-String mEmail; // Received from {@code newChooseAccountIntent()}; passed to {@code getToken()}
-private static final String SCOPE =
-        "oauth2:https://www.googleapis.com/auth/userinfo.profile";
-
-/**
- * Attempts to retrieve the username.
- * If the account is not yet known, invoke the picker. Once the account is known,
- * start an instance of the AsyncTask to get the auth token and do work with it.
- */
-private void getUsername() {
-    if (mEmail == null) {
-        pickUserAccount();
-    } else {
-        if (isDeviceOnline()) {
-            new GetUsernameTask(HelloActivity.this, mEmail, SCOPE).execute();
-        } else {
-            Toast.makeText(this, R.string.not_online, Toast.LENGTH_LONG).show();
-        }
-    }
-}
-
- -

The {@code pickUserAccount()} method is shown in the first lesson, Picking the User's Account. - -

For information about how to check whether the device is currently online (as performed by -the {@code isDeviceOnline()} method above), see the attached sample app or the -Connecting to the Network lesson.

- -

The only part left is how you should handle the exceptions that may occur when you call - -{@code GoogleAuthUtil.getToken()}.

- -

Specifying scopes

-

The scope string is used to specify which Google services can be accessed by - an app using the requested auth token. An auth token can be associated with - multiple scopes.

-

When specifying the scopes in your auth token request, prefix the - scope string with {@code "oauth2:"} followed by a list of one or more OAuth scope - values. Use a space to separate each scope value in the list. To see a list of - valid OAuth scope values for Google services, browse - the OAuth 2.0 Playground.

-

Tip: Specify {@code "oauth2:<scope>"} - for a single scope. Specify - {@code "oauth2:<scope1> <scope2> <scopeN>"} for multiple - scopes (using a space to separate each scope).

-

For example, to access the Google Books API, the scope is - {@code "oauth2:https://www.googleapis.com/auth/books"}. To add an additional - scope, say for Google+ login, your code might look like this:

-
-private final static String BOOKS_API_SCOPE
-        = "https://www.googleapis.com/auth/books";
-private fina; static String GPLUS_SCOPE
-        = "https://www.googleapis.com/auth/plus.login";
-private final static String mScopes
-        = "oauth2:" + BOOKS_API_SCOPE + " " + GPLUS_SCOPE;
-String token = GoogleAuthUtil.getToken(mActivity, mEmail, mScopes);
-
- -

Handle Exceptions

- -

As shown in the fetchToken() method above, you must catch all occurrences of {@code -GoogleAuthException} when you call -{@code GoogleAuthUtil.getToken()}.

- -

To provide users information and a proper solution to issues that may occur while acquiring the -auth token, it's important that you properly handle the following subclasses of {@code -GoogleAuthException}:

- - -
-
{@code UserRecoverableAuthException}
-
This is an error that users can resolve through some verification. For example, users may - need to confirm that your app is allowed to access their Google data or they may need to re-enter - their account password. When you receive this exception, call {@code -getIntent()} on the instance and pass the returned {@link android.content.Intent} to {@link -android.app.Activity#startActivityForResult startActivityForResult()} to give users the opportunity -to solve the problem, such as by logging in.
- -
{@code GooglePlayServicesAvailabilityException}
-
This is a specific type of {@code - UserRecoverableAuthException} indicating that the user's current version -of Google Play services is outdated. Although the recommendation above for -{@code - UserRecoverableAuthException} also works for this exception, calling {@link -android.app.Activity#startActivityForResult startActivityForResult()} will immediately send users - to Google Play Store to install an update, which may be confusing. So you should instead call -{@code getConnectionStatusCode()} and pass the result to -{@code GooglePlayServicesUtil.getErrorDialog()}. This returns a {@link android.app.Dialog} -that includes an appropriate message and a button to take users to Google Play Store so they -can install an update.
-
- -

For example, the fetchToken() method in the above sample code catches any -occurrence of {@code -UserRecoverableAuthException} and passes it back to the activity with a method called -{@code handleException()}. Here's what that method in the activity may look like:

- - -
-static final int REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR = 1001;
-
-/**
- * This method is a hook for background threads and async tasks that need to
- * provide the user a response UI when an exception occurs.
- */
-public void handleException(final Exception e) {
-    // Because this call comes from the AsyncTask, we must ensure that the following
-    // code instead executes on the UI thread.
-    runOnUiThread(new Runnable() {
-        @Override
-        public void run() {
-            if (e instanceof GooglePlayServicesAvailabilityException) {
-                // The Google Play services APK is old, disabled, or not present.
-                // Show a dialog created by Google Play services that allows
-                // the user to update the APK
-                int statusCode = ((GooglePlayServicesAvailabilityException)e)
-                        .getConnectionStatusCode();
-                Dialog dialog = GooglePlayServicesUtil.getErrorDialog(statusCode,
-                        HelloActivity.this,
-                        REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR);
-                dialog.show();
-            } else if (e instanceof UserRecoverableAuthException) {
-                // Unable to authenticate, such as when the user has not yet granted
-                // the app access to the account, but the user can fix this.
-                // Forward the user to an activity in Google Play services.
-                Intent intent = ((UserRecoverableAuthException)e).getIntent();
-                startActivityForResult(intent,
-                        REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR);
-            }
-        }
-    });
-}
-
- -

Notice that in both cases, the {@code REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR} -request code is passed with the request to handle the exception with a dialog or activity. -This way, when the user completes the appropriate action to resolve the exception, -your {@link android.app.Activity#onActivityResult onActivityResult()} method receives an -intent that includes this request code and you can try to acquire the auth -token again.

- - -

For example, the following code is a complete implementation of {@link -android.app.Activity#onActivityResult onActivityResult()} that handles results for -both the {@code REQUEST_CODE_PICK_ACCOUNT} action (shown in the previous lesson, Picking the User's Account) -and the {@code REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR} action, which occurs after the user -completes one of the actions above to resolve an exception.

- - -
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-    if (requestCode == REQUEST_CODE_PICK_ACCOUNT) {
-        // Receiving a result from the AccountPicker
-        if (resultCode == RESULT_OK) {
-            mEmail = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
-            // With the account name acquired, go get the auth token
-            getUsername();
-        } else if (resultCode == RESULT_CANCELED) {
-            // The account picker dialog closed without selecting an account.
-            // Notify users that they must pick an account to proceed.
-            Toast.makeText(this, R.string.pick_account, Toast.LENGTH_SHORT).show();
-        }
-    } else if ((requestCode == REQUEST_CODE_RECOVER_FROM_AUTH_ERROR ||
-            requestCode == REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR)
-            && resultCode == RESULT_OK) {
-        // Receiving a result that follows a GoogleAuthException, try auth again
-        getUsername();
-    }
-}
-
- -

For a complete set of code that acquires the OAuth token and queries a Google service -over HTTP (including how to use {@code -getTokenWithNotification()} when you need to acquire the token from -a {@link android.app.Service}), see the sample app available for download at the top -of this page.

- - - diff --git a/docs/html/google/play-services/auth.jd b/docs/html/google/play-services/auth.jd deleted file mode 100644 index dded5998c282..000000000000 --- a/docs/html/google/play-services/auth.jd +++ /dev/null @@ -1,239 +0,0 @@ -page.title=Authorization -page.tags=AccountManager,oauth2 -@jd:body - -
- -
- -

- Google Play services offers a standard authorization flow for all Google APIs and - all components of Google Play services. In addition, you can leverage the authorization - portion of the Google Play services SDK to gain authorization to services that are not yet supported - in the Google Play services platform by using the access token to manually make API - requests or using a client library provided by the service provider. -

- -

For implementation details, see the sample in <android-sdk>/extras/google-play-services/samples/auth, -which shows you how to carry out these basic steps for obtaining an access token.

- -

Choosing an Account

-

- Google Play services leverage existing accounts on an Android-powered device - to gain authorization to the services that you want to use. To obtain an access token, - a valid Google account is required and it must exist on the device. You can ask your users which - account they want to use by enumerating the Google accounts on the device or using the - built-in -{@code -AccountPicker} - class to display a standard account picker view. You'll need the - {@link android.Manifest.permission#GET_ACCOUNTS} - permission set in your manifest file for both methods. -

-

- For example, here's how to gather all of the Google accounts on a device and return them - in an array. When obtaining an access token, only the email address of the account is - needed, so that is what the array stores: -

- -
-private String[] getAccountNames() {
-    mAccountManager = AccountManager.get(this);
-    Account[] accounts = mAccountManager.getAccountsByType(
-            GoogleAuthUtil.GOOGLE_ACCOUNT_TYPE);
-    String[] names = new String[accounts.length];
-    for (int i = 0; i < names.length; i++) {
-        names[i] = accounts[i].name;
-    }
-    return names;
-}
-
-

Obtaining an Access Token

-

- With an email address and the service scope you can now obtain an access token. -

-

Note: Specify "oauth2:scope" for a single scope or - "oauth2:scope1 scope2 scope3" for multiple scopes.

- -There are two general - ways to get a token:

- - - -

Using getToken()

- The following code snippet obtains an access token with an email address, the scope that you want to use for the service, and a {@link android.content.Context}: - -
-HelloActivity mActivity;
-String mEmail;
-String mScope;
-String token;
-
-...
-try {
-    token = GoogleAuthUtil.getToken(mActivity, mEmail, mScope);
-} catch {
-    ...
-}
-
- -

Call this method off of the main UI thread since it executes network transactions. An easy way to do this - is in an {@link android.os.AsyncTask}. - The sample in the Google Play services SDK shows you how to wrap this call in an AsyncTask. - If authorization is successful, the token is returned. If not, the exceptions described in -Handling Exceptions - are thrown that you can catch and handle appropriately. -

- -

Using getTokenWithNotification()

-

If you are obtaining access tokens in a background service or sync adapter, there - are three overloaded - {@code getTokenWithNotification()} methods - that you can use:

- - -

See the sample in <android-sdk>/extras/google-play-services/samples/auth for implementation details.

- - - - -

Handling Exceptions

-

- When requesting an access token with - {@code GoogleAuthUtil.getToken()}, - the following exceptions can be thrown: -

- -

- For more information on how to handle these exceptions and code snippets, see the reference - documentation for the -{@code -GoogleAuthUtil} class. -

- - - - -

Using the Access Token

-

- Once you have successfully obtained a token, you can use it to access Google services. - Many Google services provide client libraries, so it is recommended that you use these when - possible, but you can make raw HTTP requests as well with the token. The following example - shows you how to do this and handle HTTP error and success responses accordingly: -

- -
-URL url = new URL("https://www.googleapis.com/oauth2/v1/userinfo?access_token="
-        + token);
-HttpURLConnection con = (HttpURLConnection) url.openConnection();
-int serverCode = con.getResponseCode();
-//successful query
-if (serverCode == 200) {
-    InputStream is = con.getInputStream();
-    String name = getFirstName(readResponse(is));
-    mActivity.show("Hello " + name + "!");
-    is.close();
-    return;
-//bad token, invalidate and get a new one
-} else if (serverCode == 401) {
-    GoogleAuthUtil.invalidateToken(mActivity, token);
-    onError("Server auth error, please try again.", null);
-    Log.e(TAG, "Server auth error: " + readResponse(con.getErrorStream()));
-    return;
-//unknown error, do something else
-} else {
-    Log.e("Server returned the following error code: " + serverCode, null);
-    return;
-}
-
- -

- Notice that you must manually invalidate the token if the response from the server - signifies an authorization error (401). This could mean the access token - being used is invalid for the service's scope or the token may have expired. If this is the - case, obtain a new token using {@code GoogleAuthUtil.getToken()}. -

diff --git a/docs/html/google/play-services/index.jd b/docs/html/google/play-services/index.jd deleted file mode 100644 index 11060e8448e4..000000000000 --- a/docs/html/google/play-services/index.jd +++ /dev/null @@ -1,706 +0,0 @@ -page.title=Google Play Services -header.hide=1 -page.metaDescription=With Google Play services, your app can take advantage of the latest Google-powered features such as Maps, Analytics, and more: platform updates are distributed automatically as an APK through the Google Play Store. - -@jd:body - -
- -
- -
-
- -

Google Play Services

-

Give your apps more features to attract users - on a wider range of devices. - With Google Play services, your app can take advantage - of the latest, Google-powered features such as Maps, Google+, and more, - with automatic platform updates distributed as an APK through - the Google Play store. This makes it faster for your users to receive updates - and easier for you to integrate the newest that Google has to offer. -

- -
-
- -
-
- -

Google Technology

-

Google Play services provides you with easy access to Google services and is -tightly integrated with the Android OS. Easy-to-use client libraries are -provided for each service that let you implement the functionality you want -easier and faster.

- -
-
- -

Standard Authorization

-

All products in Google Play services share a common authorization API - that leverages the existing Google accounts on the device. You and your - users have a consistent and safe way to grant and receive OAuth2 access tokens - to Google services.

- -
-
- -

Automatic Updates

-

Devices running Android 2.3 or higher that have the Google Play Store -app will automatically receive updates to Google Play services. Enhance -your app with the most recent version of Google Play services without worrying -about your users' Android version.

- -
-

To start integrating Google Play services into your app, - follow the Setup guide.

-
- -

New Features

- -
-

- Google Play services, Version 7.3 (April 2015) -

- -
-
-
Highlights in Version 7.3
-
-

For a summary of the feature highlights in Google Play services 7.3, see the -announcement -blog post.

- -
-
-
-
- -
-

- Google Play services, Version 7.0 (March 2015) -

- -
-
-
Highlights in Version 7.0
-
-

For a summary of the feature highlights in Google Play services 7.0, see the -announcement -blog post.

- -
-
-
-
- -
-

- Google Play services, Version 6.5 (December 2014) -

- -
-
-
Highlights in Version 6.5
- -
-

For a summary of the feature highlights in Google Play services 6.5, see the -announcement -blog post.

- -
-
-
-
- -
-

- Google Play services, Version 6.1 (October 2014) -

- -
-
-
Highlights in Version 6.1
- -
-

For a summary of the feature highlights in Google Play services 6.1, see the -announcement -blog post.

- -
-
- -
-
- -
-

- Google Play services, Version 5.0 (July 2014) -

- -
-
-
Highlights in Version 5.0
- -
-

For a summary of the feature highlights in Google Play services 5.0, see the -announcement -blog post.

-
    -
  • Analytics - The Enhanced Ecommerce API allows your app -to send product related information and actions to Google Analytics. Use this -API to measure impressions of products seen by users, checkout steps, and -products purchased. This information can be analyzed for the effectiveness of -marketing and merchandising efforts, including the impact of internal -promotions, coupons, and affiliate marketing programs. - -
    • - -
  • App Indexing - The App Indexing API provides a way -for developers to notify Google about deep links in their native apps and -allows the Google Search App, version 3.6 and above, to drive re-engagement -through Google Search -query autocompletions, providing fast and easy access to -inner pages in apps. - -
    • - -
  • Drive - The Query APIs now allow your app to retrieve -Drive files by sorted order, according to a developer-specified sorting criteria. - -
    • - -
  • Play Games - This release introduces the Quests and -Saved Games services. The Quests service gives you the ability to issue -time-bound in-game challenges based on Events data sent from your game, without -republishing your game (for example: Your game sends an event each time a -“gem” is found by a player, and you create a quest to “Find 20 gems”). Players -can complete a quest to earn rewards. Saved Games offers improved functionality -for saving game state information and visually displaying player game progression. - -
    • - -
  • Security - The Security API allows you to easily -install a dynamic security provider. New versions of Google Play Services will -keep the security provider up-to-date with the latest security fixes as those -become available. - -
    • - -
  • Wallet - The Save to Google API for Android lets users -save Wallet Objects to their Google Wallet with the click of a button displayed -in your Android app. - -
    • - - -
  • Wearables - The Wearable Data Layer API provides a - communication channel between your handheld and wearable apps. The API - consists of a set of data objects that the system can send and synchronize - and listeners that notify your apps of important events from the other - device. - -
    • - -
-
-
- -
-
- -
-

- Google Play services, Version 4.4 (May 2014) -

- -
-
-
Highlights in Version 4.4
- -
-

For a summary of the feature highlights in Google Play services 4.4, see the -announcement blog post.

-
    -
  • Maps - New features for Street View and enhanced control of - Indoor Maps. - -
    • - -
  • Activity recognition - The Location API has been updated with new activity detectors for running and walking. - -
    • - -
  • Mobile Ads - The new in-app purchase APIs allow - publishers to display in-app purchase ads, which enables users to purchase - advertised items directly. - -
    • - -
  • Wallet Fragment - The new Wallet Fragment API allows you - to easily integrate Google Wallet Instant Buy with an existing app. - -
    • -
-
-
- -
-
- -
-

- Google Play services, Version 4.3 (March 2014) -

- -
-
-
Highlights in Version 4.3
-
-

For a summary of the feature highlights in Google Play services 4.3, see the -announcement blog post.

- -
-
-
-
- -

How It Works

- -

The Google Play services client library

-

- The client library contains the interfaces to the individual Google - services and allows you to obtain authorization from users to gain access - to these services with their credentials. It also contains APIs that allow - you to resolve any issues at runtime, such as a missing, disabled, or out-of-date - Google Play services APK. The client library has a light footprint if you use - ProGuard as part of your build process, so it won't have - an adverse impact on your app's file size. -

-

- If you want to access added features or products, you can upgrade to a new version of the - client library as they are released. However, upgrading is not - necessary if you don't care about new features or bug fixes. - We anticipate more Google services to be continuously added, so be on the lookout for - these updates. -

- -
 
- -
-
-

The Google Play services APK

-

- The Google Play services APK contains the individual Google services and runs - as a background service in the Android OS. You interact with the background service - through the client library and the service carries out the actions on your behalf. - An easy-to-use authorization flow is also - provided to gain access to the each Google service, which provides consistency for both - you and your users. -

-

- The Google Play services APK is delivered through the Google Play Store, so - updates to the services are not dependent on carrier or OEM system image updates. In general, devices - running Android 2.3 (Gingerbread) or later and have the Google Play Store app installed receive updates within a - few days. This allows you to use the newest APIs in Google Play services and reach most of the - devices in the Android ecosystem (devices older than Android 2.3 or devices without the Google - Play Store app are not supported). -

-
- -
- -

The Google Play services APK on user devices receives regular updates - for new APIs, features, and bug fixes.

-
-
- -

The benefits for your app

- -

Google Play services gives you the freedom to use the newest APIs for popular -Google services without worrying about device support. Updates to Google Play -services are distributed automatically by the Google Play Store and new versions -of the client library are delivered through the Android SDK Manager. This makes it -easy for you to focus on what's important: your users' experience.

- -

To get started, set up the SDK and check out -the various products in the Google Play services platform now!

diff --git a/docs/html/google/play-services/setup.jd b/docs/html/google/play-services/setup.jd deleted file mode 100644 index 313e59118eab..000000000000 --- a/docs/html/google/play-services/setup.jd +++ /dev/null @@ -1,398 +0,0 @@ -page.title=Setting Up Google Play Services -@jd:body - - - -
- -
- - - - -

To develop an app using the Google -Play services APIs, you need to set up your project with the Google Play services SDK. -

If you haven't installed the Google Play services SDK yet, go get it now by following the guide -to Adding SDK Packages.

- -

To test your app when using the Google Play services SDK, you must use either:

- - - - -

Add Google Play Services to Your Project

- -

- -

- - -
-

To make the Google Play services APIs available to your app:

-
    -
  1. Open the build.gradle file inside your application module directory. -

    Note: Android Studio projects contain a top-level - build.gradle file and a build.gradle file for each module. - Be sure to edit the file for your application module. See - Building Your Project with - Gradle for more information about Gradle.

    2. -
  2. Add a new build rule under dependencies for the latest version of -play-services. For example: -
    -apply plugin: 'com.android.application'
-...
-
-dependencies {
-    compile 'com.android.support:appcompat-v7:21.0.3'
-    compile 'com.google.android.gms:play-services:7.3.0'
-}
-
    -

    Be sure you update this version number each time Google Play services is updated.

    -

    Note: If the number of method references in your app exceeds the -65K limit, your app may fail to compile. You -may be able to mitigate this problem when compiling your app by specifying only the specific Google -Play services APIs your app uses, instead of all of them. For information on how to do this, -see Selectively compiling APIs into your executable. - -

    3. -
  3. Save the changes and click Sync Project with Gradle Files - -in the toolbar. -
    4. -
- -

You can now begin developing features with the -Google Play services APIs.

- -

Selectively compiling APIs into your executable

- -

In versions of Google Play services prior to 6.5, you had to compile the entire package of APIs -into your app. In some cases, doing so made it more difficult to keep the number of methods -in your app (including framework APIs, library methods, and your own code) under the 65,536 limit.

- -

From version 6.5, you can instead selectively compile Google Play service APIs into your app. For -example, to include only the Google Fit and Android Wear APIs, replace the following line in your -build.gradle file:

- -
-compile 'com.google.android.gms:play-services:7.3.0'
-
- -

with these lines:

- -
-compile 'com.google.android.gms:play-services-fitness:7.3.0'
-compile 'com.google.android.gms:play-services-wearable:7.3.0'
-
- -

Table 1 shows a list of the separate APIs that you can include when compiling your app, and -how to describe them in your build.gradle file. Some APIs do not have a separate -library; include them by including the base library. (This lib is automatically included when -you include an API that does have a separate library.)

- -

-Table 1. Individual APIs and corresponding build.gradle descriptions.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Google Play services APIDescription in build.gradle
Google+com.google.android.gms:play-services-plus:7.3.0
Google Account Logincom.google.android.gms:play-services-identity:7.3.0
Google Actions, Base Client Librarycom.google.android.gms:play-services-base:7.3.0
Google App Indexingcom.google.android.gms:play-services-appindexing:7.3.0
Google Analyticscom.google.android.gms:play-services-analytics:7.3.0
Google Castcom.google.android.gms:play-services-cast:7.3.0
Google Cloud Messagingcom.google.android.gms:play-services-gcm:7.3.0
Google Drivecom.google.android.gms:play-services-drive:7.3.0
Google Fitcom.google.android.gms:play-services-fitness:7.3.0
Google Location, Activity Recognition, and Placescom.google.android.gms:play-services-location:7.3.0
Google Mapscom.google.android.gms:play-services-maps:7.3.0
Google Mobile Adscom.google.android.gms:play-services-ads:7.3.0
Google Nearbycom.google.android.gms:play-services-nearby:7.3.0
Google Panorama Viewercom.google.android.gms:play-services-panorama:7.3.0
Google Play Game servicescom.google.android.gms:play-services-games:7.3.0
SafetyNetcom.google.android.gms:play-services-safetynet:7.3.0
Google Walletcom.google.android.gms:play-services-wallet:7.3.0
Android Wearcom.google.android.gms:play-services-wearable:7.3.0
- -

Note: ProGuard directives are included in the Play services -client libraries to preserve the required classes. The -Android Plugin for Gradle -automatically appends ProGuard configuration files in an AAR (Android ARchive) package and appends -that package to your ProGuard configuration. During project creation, Android Studio automatically -creates the ProGuard configuration files and build.gradle properties for ProGuard use. -To use ProGuard with Android Studio, you must enable the ProGuard setting in your -build.gradle buildTypes. For more information, see the -ProGuard topic.

- - -
- -
- -

To make the Google Play services APIs available to your app:

-
    -
  1. Copy the library project at -{@code <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/} - to the location where you maintain your Android app projects.
    2. -
  2. Import the library project into your Eclipse workspace. Click - File > Import, select Android > Existing Android Code into -Workspace, and browse to the copy of the library project to import it.
    3. -
  3. In your app project, reference Google Play services library project. See - - Referencing a Library Project for Eclipse for more information on how to - do this. -

    Note: You should be referencing a copy of the - library that you copied to your development workspace—you should not - reference the library directly from the Android SDK directory.

    -
    4. -
  4. After you've added the Google Play services library as a dependency for your app project, - open your app's manifest file and add the following tag as a child of the - {@code <application>} -element: - 
    -<meta-data android:name="com.google.android.gms.version"
-        android:value="@integer/google_play_services_version" />
-
    -
    5. -
- -

Once you've set up your project to reference the library project, -you can begin developing features with the -Google Play services APIs.

- - -

Create a ProGuard Exception

- -

To prevent ProGuard from stripping away -required classes, add the following lines in the -<project_directory>/proguard-project.txt file: -

--keep class * extends java.util.ListResourceBundle {
-    protected Object[][] getContents();
-}
-
--keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
-    public static final *** NULL;
-}
-
--keepnames @com.google.android.gms.common.annotation.KeepName class *
--keepclassmembernames class * {
-    @com.google.android.gms.common.annotation.KeepName *;
-}
-
--keepnames class * implements android.os.Parcelable {
-    public static final ** CREATOR;
-}
-
- - - -
- -
- -

To make the Google Play services APIs available to your app:

-
    -
  1. Copy the library project at -{@code <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/} -to the location where you maintain your Android app projects.
    2. - -
  2. In your app project, reference the Google Play services library project. See - Referencing - a Library Project on the Command Line for more information on how to do this. -

    Note: -You should be referencing a copy of the library that you copied to your development -workspace—you should not reference the library directly from the Android SDK directory.

    -
    3. -
  3. After you've added the Google Play services library as a dependency for - your app project, open your app's manifest file and add the following tag as - a child of the - {@code <application>} - element: - 
    -<meta-data android:name="com.google.android.gms.version"
-        android:value="@integer/google_play_services_version" />
-
    -
    4. -
- -

Once you've set up your project to reference the library project, -you can begin developing features with the -Google Play services APIs.

- - -

Create a Proguard Exception

- -

To prevent ProGuard from stripping away -required classes, add the following lines in the -<project_directory>/proguard-project.txt file: -

--keep class * extends java.util.ListResourceBundle {
-    protected Object[][] getContents();
-}
-
--keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
-    public static final *** NULL;
-}
-
--keepnames @com.google.android.gms.common.annotation.KeepName class *
--keepclassmembernames class * {
-    @com.google.android.gms.common.annotation.KeepName *;
-}
-
--keepnames class * implements android.os.Parcelable {
-    public static final ** CREATOR;
-}
-
- - -
- - - -

Ensure Devices Have the Google Play services APK

- -

As described in the Google Play services -introduction, Google Play delivers service updates for users on -Android 2.3 and higher through the Google Play Store app. However, updates might not reach -all users immediately, so your app should verify the version available before attempting to -perform API transactions.

- -

-Important: - Because it is hard to anticipate the state of each device, you must always check for a - compatible Google Play services APK before you access Google Play services - features. -

- -

Because each app uses Google Play services differently, it's up to you decide the appropriate -place in your app to verify the Google Play services version. For example, if Google Play -services is required for your app at all times, you might want to do it when your app first -launches. On the other hand, if Google Play services is an optional part of your app, you can check -the version only once the user navigates to that portion of your app.

- -

You are strongly encouraged to use the - -{@code GoogleApiClient} class to access Google Play services features. This approach allows -you to attach an - -{@code OnConnectionFailedListener} object to your client. -To detect if the device has the appropriate version of the Google Play services APK, implement the - -{@code onConnectionFailed()} -callback method. If the connection fails due to a missing or out-of-date version of -the Google Play APK, the callback receives an error code such as - -{@code SERVICE_MISSING}, - -{@code SERVICE_VERSION_UPDATE_REQUIRED}, or - -{@code SERVICE_DISABLED}. To learn more about how to build your client and handle such -connection errors, see Accessing Google APIs. -

- -

Another approach is to use the -{@code isGooglePlayServicesAvailable()} method. You might call this method in the -{@link android.app.Activity#onResume onResume()} method of the main activity. If the result code is -{@code SUCCESS}, - then the Google Play services APK is up-to-date and you can continue to make a connection. -If, however, the result code is -{@code SERVICE_MISSING}, -{@code SERVICE_VERSION_UPDATE_REQUIRED}, - or -{@code SERVICE_DISABLED}, then the user needs to install an update. In this case, call the - -{@code getErrorDialog()} method and pass it the result error code. The method returns a -{@link android.app.Dialog} you should show, which provides an appropriate message about the error -and provides an action that takes the user to Google Play Store to install the update.

- - -

To then begin a connection to Google Play services (required by most Google APIs such -as Google Drive, Google+, and Games), read Accessing Google APIs.

diff --git a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html deleted file mode 100644 index 5ef2947a803f..000000000000 --- a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html +++ /dev/null @@ -1,6576 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GCMBaseIntentService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - | Protected Ctors - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

GCMBaseIntentService

- - - - - - - - - - - - - - - - - - - - - extends IntentService
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳android.app.IntentService
       ↳com.google.android.gcm.GCMBaseIntentService
- - - - - - - -
-

-

- This class is deprecated.
- Please use the - GoogleCloudMessaging API instead. - -

- -

Class Overview

-

Skeleton for application-specific IntentServices responsible for - handling communication from Google Cloud Messaging service. -

- The abstract methods in this class are called from its worker thread, and - hence should run in a limited amount of time. If they execute long - operations, they should spawn new threads, otherwise the worker thread will - be blocked. -

- Subclasses must provide a public no-arg constructor.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringTAGOld TAG used for logging.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Constructors
- - - - - - - - GCMBaseIntentService() - -
Constructor that does not set a sender id, useful when the sender id - is context-specific.
- -
- - - - - - - - GCMBaseIntentService(String... senderIds) - -
Constructor used when the sender id(s) is fixed.
- -
- - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - void - - onHandleIntent(Intent intent) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - String[] - - getSenderIds(Context context) - -
Gets the sender ids.
- -
- - - - - - void - - onDeletedMessages(Context context, int total) - -
Called when the GCM server tells pending messages have been deleted - because the device was idle.
- -
- abstract - - - - - void - - onError(Context context, String errorId) - -
Called on registration or unregistration error.
- -
- abstract - - - - - void - - onMessage(Context context, Intent intent) - -
Called when a cloud message has been received.
- -
- - - - - - boolean - - onRecoverableError(Context context, String errorId) - -
Called on a registration error that could be retried.
- -
- abstract - - - - - void - - onRegistered(Context context, String registrationId) - -
Called after a device has been registered.
- -
- abstract - - - - - void - - onUnregistered(Context context, String registrationId) - -
Called after a device has been unregistered.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.IntentService - -
- - -
-
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - TAG -

-
- - - - -
-
- -

Old TAG used for logging. Marked as deprecated since it should have - been private at first place. -

- - -
- Constant Value: - - - "GCMBaseIntentService" - - -
- -
-
- - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - GCMBaseIntentService - () -

-
-
- - - -
-
- -

Constructor that does not set a sender id, useful when the sender id - is context-specific. -

- When using this constructor, the subclass must - override getSenderIds(Context), otherwise methods such as - onHandleIntent(Intent) will throw an - IllegalStateException on runtime. -

- -
-
- - - - -
-

- - protected - - - - - - - GCMBaseIntentService - (String... senderIds) -

-
-
- - - -
-
- -

Constructor used when the sender id(s) is fixed. -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - void - - onHandleIntent - (Intent intent) -

-
-
- - - -
-
- -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - String[] - - getSenderIds - (Context context) -

-
-
- - - -
-
- -

Gets the sender ids. - -

By default, it returns the sender ids passed in the constructor, but - it could be overridden to provide a dynamic sender id.

-
-
Throws
- - - - -
IllegalStateException - if sender id was not set on constructor. -
-
- -
-
- - - - -
-

- - protected - - - - - void - - onDeletedMessages - (Context context, int total) -

-
-
- - - -
-
- -

Called when the GCM server tells pending messages have been deleted - because the device was idle.

-
-
Parameters
- - - - - - - -
context - application's context.
total - total number of collapsed messages -
-
- -
-
- - - - -
-

- - protected - - - abstract - - void - - onError - (Context context, String errorId) -

-
-
- - - -
-
- -

Called on registration or unregistration error.

-
-
Parameters
- - - - - - - -
context - application's context.
errorId - error id returned by the GCM service. -
-
- -
-
- - - - -
-

- - protected - - - abstract - - void - - onMessage - (Context context, Intent intent) -

-
-
- - - -
-
- -

Called when a cloud message has been received.

-
-
Parameters
- - - - - - - -
context - application's context.
intent - intent containing the message payload as extras. -
-
- -
-
- - - - -
-

- - protected - - - - - boolean - - onRecoverableError - (Context context, String errorId) -

-
-
- - - -
-
- -

Called on a registration error that could be retried. - -

By default, it does nothing and returns true, but could be - overridden to change that behavior and/or display the error.

-
-
Parameters
- - - - - - - -
context - application's context.
errorId - error id returned by the GCM service.
-
-
-
Returns
-
  • if true, failed operation will be retried (using - exponential backoff). -
-
- -
-
- - - - -
-

- - protected - - - abstract - - void - - onRegistered - (Context context, String registrationId) -

-
-
- - - -
-
- -

Called after a device has been registered.

-
-
Parameters
- - - - - - - -
context - application's context.
registrationId - the registration id returned by the GCM service. -
-
- -
-
- - - - -
-

- - protected - - - abstract - - void - - onUnregistered - (Context context, String registrationId) -

-
-
- - - -
-
- -

Called after a device has been unregistered.

-
-
Parameters
- - - - - - - -
context - application's context. -
registrationId - the registration id that was previously registered.
-
- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html deleted file mode 100644 index 38e68f496799..000000000000 --- a/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html +++ /dev/null @@ -1,1662 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GCMBroadcastReceiver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GCMBroadcastReceiver

- - - - - - - - - extends BroadcastReceiver
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.BroadcastReceiver
    ↳com.google.android.gcm.GCMBroadcastReceiver
- - - - - - - -
-

-

- This class is deprecated.
- Please use the - GoogleCloudMessaging API instead. - -

- -

Class Overview

-

BroadcastReceiver that receives GCM messages and delivers them to - an application-specific GCMBaseIntentService subclass. -

- By default, the GCMBaseIntentService class belongs to the application - main package and is named - DEFAULT_INTENT_SERVICE_CLASS_NAME. To use a new class, - the getGCMIntentServiceClassName(Context) must be overridden.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GCMBroadcastReceiver() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - void - - onReceive(Context context, Intent intent) - -
- - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - String - - getGCMIntentServiceClassName(Context context) - -
Gets the class name of the intent service that will handle GCM messages.
- -
- - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.content.BroadcastReceiver - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GCMBroadcastReceiver - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - void - - onReceive - (Context context, Intent intent) -

-
-
- - - -
-
- -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - String - - getGCMIntentServiceClassName - (Context context) -

-
-
- - - -
-
- -

Gets the class name of the intent service that will handle GCM messages. -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/GCMConstants.html b/docs/html/reference/com/google/android/gcm/GCMConstants.html deleted file mode 100644 index 097a24f4af2f..000000000000 --- a/docs/html/reference/com/google/android/gcm/GCMConstants.html +++ /dev/null @@ -1,2139 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GCMConstants | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GCMConstants

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.GCMConstants
- - - - - - - -
-

-

- This class is deprecated.
- Please use the - GoogleCloudMessaging API instead. - -

- -

Class Overview

-

Constants used by the GCM library.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringDEFAULT_INTENT_SERVICE_CLASS_NAME
StringERROR_ACCOUNT_MISSINGThere is no Google account on the phone.
StringERROR_AUTHENTICATION_FAILEDBad password.
StringERROR_INVALID_PARAMETERSThe request sent by the phone does not contain the expected parameters.
StringERROR_INVALID_SENDERThe sender account is not recognized.
StringERROR_PHONE_REGISTRATION_ERRORIncorrect phone registration with Google.
StringERROR_SERVICE_NOT_AVAILABLEThe device can't read the response, or there was a 500/503 from the - server that can be retried later.
StringEXTRA_APPLICATION_PENDING_INTENTExtra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION - to get the application info.
StringEXTRA_ERRORExtra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate an error when the registration fails.
StringEXTRA_FROMExtra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE - to indicate which sender (Google API project id) sent the message.
StringEXTRA_REGISTRATION_IDExtra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate the registration id when the registration succeeds.
StringEXTRA_SENDERExtra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION - to indicate which senders (Google API project ids) can send messages to - the application.
StringEXTRA_SPECIAL_MESSAGEType of message present in the - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE - intent.
StringEXTRA_TOTAL_DELETEDNumber of messages deleted by the server because the device was idle.
StringEXTRA_UNREGISTEREDExtra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate that the application has been unregistered.
StringINTENT_FROM_GCM_LIBRARY_RETRYIntent used by the GCM library to indicate that the registration call - should be retried.
StringINTENT_FROM_GCM_MESSAGEIntent sent by GCM containing a message.
StringINTENT_FROM_GCM_REGISTRATION_CALLBACKIntent sent by GCM indicating with the result of a registration request.
StringINTENT_TO_GCM_REGISTRATIONIntent sent to GCM to register the application.
StringINTENT_TO_GCM_UNREGISTRATIONIntent sent to GCM to unregister the application.
StringPERMISSION_GCM_INTENTSPermission necessary to receive GCM intents.
StringVALUE_DELETED_MESSAGESSpecial message indicating the server deleted the pending messages.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - DEFAULT_INTENT_SERVICE_CLASS_NAME -

-
- - - - -
-
- -

-
-
See Also
- -
- - -
- Constant Value: - - - ".GCMIntentService" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_ACCOUNT_MISSING -

-
- - - - -
-
- -

There is no Google account on the phone. The application should ask the - user to open the account manager and add a Google account. -

- - -
- Constant Value: - - - "ACCOUNT_MISSING" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_AUTHENTICATION_FAILED -

-
- - - - -
-
- -

Bad password. The application should ask the user to enter his/her - password, and let user retry manually later. Fix on the device side. -

- - -
- Constant Value: - - - "AUTHENTICATION_FAILED" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_INVALID_PARAMETERS -

-
- - - - -
-
- -

The request sent by the phone does not contain the expected parameters. - This phone doesn't currently support GCM. -

- - -
- Constant Value: - - - "INVALID_PARAMETERS" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_INVALID_SENDER -

-
- - - - -
-
- -

The sender account is not recognized. Fix on the device side. -

- - -
- Constant Value: - - - "INVALID_SENDER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_PHONE_REGISTRATION_ERROR -

-
- - - - -
-
- -

Incorrect phone registration with Google. This phone doesn't currently - support GCM. -

- - -
- Constant Value: - - - "PHONE_REGISTRATION_ERROR" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_SERVICE_NOT_AVAILABLE -

-
- - - - -
-
- -

The device can't read the response, or there was a 500/503 from the - server that can be retried later. The application should use exponential - back off and retry. -

- - -
- Constant Value: - - - "SERVICE_NOT_AVAILABLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_APPLICATION_PENDING_INTENT -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION - to get the application info. -

- - -
- Constant Value: - - - "app" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ERROR -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate an error when the registration fails. - See constants starting with ERROR_ for possible values. -

- - -
- Constant Value: - - - "error" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_FROM -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE - to indicate which sender (Google API project id) sent the message. -

- - -
- Constant Value: - - - "from" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_REGISTRATION_ID -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate the registration id when the registration succeeds. -

- - -
- Constant Value: - - - "registration_id" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_SENDER -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_TO_GCM_REGISTRATION - to indicate which senders (Google API project ids) can send messages to - the application. -

- - -
- Constant Value: - - - "sender" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_SPECIAL_MESSAGE -

-
- - - - -
-
- -

Type of message present in the - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE - intent. - This extra is only set for special messages sent from GCM, not for - messages originated from the application. -

- - -
- Constant Value: - - - "message_type" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_TOTAL_DELETED -

-
- - - - -
-
- -

Number of messages deleted by the server because the device was idle. - Present only on messages of special type - com.google.android.gcm.GCMConstants.VALUE_DELETED_MESSAGES -

- - -
- Constant Value: - - - "total_deleted" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_UNREGISTERED -

-
- - - - -
-
- -

Extra used on - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK - to indicate that the application has been unregistered. -

- - -
- Constant Value: - - - "unregistered" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - INTENT_FROM_GCM_LIBRARY_RETRY -

-
- - - - -
-
- -

Intent used by the GCM library to indicate that the registration call - should be retried. -

- - -
- Constant Value: - - - "com.google.android.gcm.intent.RETRY" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - INTENT_FROM_GCM_MESSAGE -

-
- - - - -
-
- -

Intent sent by GCM containing a message. -

- - -
- Constant Value: - - - "com.google.android.c2dm.intent.RECEIVE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - INTENT_FROM_GCM_REGISTRATION_CALLBACK -

-
- - - - -
-
- -

Intent sent by GCM indicating with the result of a registration request. -

- - -
- Constant Value: - - - "com.google.android.c2dm.intent.REGISTRATION" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - INTENT_TO_GCM_REGISTRATION -

-
- - - - -
-
- -

Intent sent to GCM to register the application. -

- - -
- Constant Value: - - - "com.google.android.c2dm.intent.REGISTER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - INTENT_TO_GCM_UNREGISTRATION -

-
- - - - -
-
- -

Intent sent to GCM to unregister the application. -

- - -
- Constant Value: - - - "com.google.android.c2dm.intent.UNREGISTER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PERMISSION_GCM_INTENTS -

-
- - - - -
-
- -

Permission necessary to receive GCM intents. -

- - -
- Constant Value: - - - "com.google.android.c2dm.permission.SEND" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - VALUE_DELETED_MESSAGES -

-
- - - - -
-
- -

Special message indicating the server deleted the pending messages. -

- - -
- Constant Value: - - - "deleted_messages" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html deleted file mode 100644 index 89f7646a91fd..000000000000 --- a/docs/html/reference/com/google/android/gcm/GCMRegistrar.html +++ /dev/null @@ -1,1818 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GCMRegistrar | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GCMRegistrar

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.GCMRegistrar
- - - - - - - -
-

-

- This class is deprecated.
- Please use the - GoogleCloudMessaging API instead. - -

- -

Class Overview

-

Utilities for device registration. -

- Note: this class uses a private SharedPreferences - object to keep track of the registration token.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
longDEFAULT_ON_SERVER_LIFESPAN_MSDefault lifespan (7 days) of the isRegisteredOnServer(Context) - flag until it is considered expired.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - void - - checkDevice(Context context) - -
Checks if the device has the proper dependencies installed.
- -
- - - - static - - void - - checkManifest(Context context) - -
Checks that the application manifest is properly configured.
- -
- - - - static - - long - - getRegisterOnServerLifespan(Context context) - -
Gets how long (in milliseconds) the isRegistered(Context) - property is valid.
- -
- - - - static - - String - - getRegistrationId(Context context) - -
Gets the current registration id for application on GCM service.
- -
- - - - static - - boolean - - isRegistered(Context context) - -
Checks whether the application was successfully registered on GCM - service.
- -
- - - - static - - boolean - - isRegisteredOnServer(Context context) - -
Checks whether the device was successfully registered in the server side, - as set by setRegisteredOnServer(Context, boolean).
- -
- - synchronized - - static - - void - - onDestroy(Context context) - -
Clear internal resources.
- -
- - - - static - - void - - register(Context context, String... senderIds) - -
Initiate messaging registration for the current application.
- -
- - - - static - - void - - setRegisterOnServerLifespan(Context context, long lifespan) - -
Sets how long (in milliseconds) the isRegistered(Context) - flag is valid.
- -
- - - - static - - void - - setRegisteredOnServer(Context context, boolean flag) - -
Sets whether the device was successfully registered in the server side.
- -
- - - - static - - void - - unregister(Context context) - -
Unregister the application.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - long - - DEFAULT_ON_SERVER_LIFESPAN_MS -

-
- - - - -
-
- -

Default lifespan (7 days) of the isRegisteredOnServer(Context) - flag until it is considered expired. -

- - -
- Constant Value: - - - 604800000 - (0x00000000240c8400) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - checkDevice - (Context context) -

-
-
- - - -
-
- -

Checks if the device has the proper dependencies installed. -

- This method should be called when the application starts to verify that - the device supports GCM.

-
-
Parameters
- - - - -
context - application context.
-
-
-
Throws
- - - - -
UnsupportedOperationException - if the device does not support GCM. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - checkManifest - (Context context) -

-
-
- - - -
-
- -

Checks that the application manifest is properly configured. -

- A proper configuration means: -

    -
  1. It creates a custom permission called - PACKAGE_NAME.permission.C2D_MESSAGE. -
  2. It defines at least one BroadcastReceiver with category - PACKAGE_NAME. -
  3. The BroadcastReceiver(s) uses the - com.google.android.gcm.GCMConstants.PERMISSION_GCM_INTENTS - permission. -
  4. The BroadcastReceiver(s) handles the 2 GCM intents - (com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE - and - com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK). -
- ...where PACKAGE_NAME is the application package. -

- This method should be used during development time to verify that the - manifest is properly set up, but it doesn't need to be called once the - application is deployed to the users' devices.

-
-
Parameters
- - - - -
context - application context.
-
-
-
Throws
- - - - -
IllegalStateException - if any of the conditions above is not met. -
-
- -
-
- - - - -
-

- - public - static - - - - long - - getRegisterOnServerLifespan - (Context context) -

-
-
- - - -
-
- -

Gets how long (in milliseconds) the isRegistered(Context) - property is valid.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - String - - getRegistrationId - (Context context) -

-
-
- - - -
-
- -

Gets the current registration id for application on GCM service. -

- If result is empty, the registration has failed.

-
-
Returns
-
  • registration id, or empty string if the registration is not - complete. -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - isRegistered - (Context context) -

-
-
- - - -
-
- -

Checks whether the application was successfully registered on GCM - service. -

- -
-
- - - - -
-

- - public - static - - - - boolean - - isRegisteredOnServer - (Context context) -

-
-
- - - -
-
- -

Checks whether the device was successfully registered in the server side, - as set by setRegisteredOnServer(Context, boolean). - -

To avoid the scenario where the device sends the registration to the - server but the server loses it, this flag has an expiration date, which - is DEFAULT_ON_SERVER_LIFESPAN_MS by default (but can be changed - by setRegisterOnServerLifespan(Context, long)). -

- -
-
- - - - -
-

- - public - static - - - synchronized - void - - onDestroy - (Context context) -

-
-
- - - -
-
- -

Clear internal resources. - -

- This method should be called by the main activity's onDestroy() - method. -

- -
-
- - - - -
-

- - public - static - - - - void - - register - (Context context, String... senderIds) -

-
-
- - - -
-
- -

Initiate messaging registration for the current application. -

- The result will be returned as an - INTENT_FROM_GCM_REGISTRATION_CALLBACK intent with - either a EXTRA_REGISTRATION_ID or - EXTRA_ERROR.

-
-
Parameters
- - - - - - - -
context - application context.
senderIds - Google Project ID of the accounts authorized to send - messages to this application.
-
-
-
Throws
- - - - -
IllegalStateException - if device does not have all GCM - dependencies installed. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setRegisterOnServerLifespan - (Context context, long lifespan) -

-
-
- - - -
-
- -

Sets how long (in milliseconds) the isRegistered(Context) - flag is valid. -

- -
-
- - - - -
-

- - public - static - - - - void - - setRegisteredOnServer - (Context context, boolean flag) -

-
-
- - - -
-
- -

Sets whether the device was successfully registered in the server side. -

- -
-
- - - - -
-

- - public - static - - - - void - - unregister - (Context context) -

-
-
- - - -
-
- -

Unregister the application. -

- The result will be returned as an - INTENT_FROM_GCM_REGISTRATION_CALLBACK intent with an - EXTRA_UNREGISTERED extra. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/package-summary.html b/docs/html/reference/com/google/android/gcm/package-summary.html deleted file mode 100644 index d46d1d7c18d6..000000000000 --- a/docs/html/reference/com/google/android/gcm/package-summary.html +++ /dev/null @@ -1,750 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gcm | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gcm

-
- -
- -
- - -
-

DEPRECATED — please use the GoogleCloudMessaging API instead of this client helper library — see GCM Client for more information.

- - -
- - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - -
GCMBaseIntentService - This class is deprecated. - Please use the - GoogleCloudMessaging API instead. - 
GCMBroadcastReceiver - This class is deprecated. - Please use the - GoogleCloudMessaging API instead. - 
GCMConstants - This class is deprecated. - Please use the - GoogleCloudMessaging API instead. - 
GCMRegistrar - This class is deprecated. - Please use the - GoogleCloudMessaging API instead. - 
-
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Constants.html b/docs/html/reference/com/google/android/gcm/server/Constants.html deleted file mode 100644 index def0254eb2db..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Constants.html +++ /dev/null @@ -1,2510 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Constants | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Constants

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Constants
- - - - - - - -
- - -

Class Overview

-

Constants used on GCM service communication. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringERROR_DEVICE_QUOTA_EXCEEDEDToo many messages sent by the sender to a specific device.
StringERROR_INTERNAL_SERVER_ERRORA particular message could not be sent because the GCM servers encountered - an error.
StringERROR_INVALID_REGISTRATIONBad registration_id.
StringERROR_INVALID_TTLTime to Live value passed is less than zero or more than maximum.
StringERROR_MESSAGE_TOO_BIGThe payload of the message is too big, see the limitations.
StringERROR_MISMATCH_SENDER_IDThe sender_id contained in the registration_id does not match the - sender_id used to register with the GCM servers.
StringERROR_MISSING_COLLAPSE_KEYCollapse key is required.
StringERROR_MISSING_REGISTRATIONMissing registration_id.
StringERROR_NOT_REGISTEREDThe user has uninstalled the application or turned off notifications.
StringERROR_QUOTA_EXCEEDEDToo many messages sent by the sender.
StringERROR_UNAVAILABLEA particular message could not be sent because the GCM servers were not - available.
StringGCM_SEND_ENDPOINTEndpoint for sending messages.
StringJSON_CANONICAL_IDSJSON-only field representing the number of messages with a canonical - registration id.
StringJSON_ERRORJSON-only field representing the error field of an individual request.
StringJSON_FAILUREJSON-only field representing the number of failed messages.
StringJSON_MESSAGE_IDJSON-only field sent by GCM when a message was successfully sent.
StringJSON_MULTICAST_IDJSON-only field representing the id of the multicast request.
StringJSON_PAYLOADJSON-only field representing the payload data.
StringJSON_REGISTRATION_IDSJSON-only field representing the registration ids.
StringJSON_RESULTSJSON-only field representing the result of each individual request.
StringJSON_SUCCESSJSON-only field representing the number of successful messages.
StringPARAM_COLLAPSE_KEYHTTP parameter for collapse key.
StringPARAM_DELAY_WHILE_IDLEHTTP parameter for delaying the message delivery if the device is idle.
StringPARAM_DRY_RUNHTTP parameter for telling gcm to validate the message without actually sending it.
StringPARAM_PAYLOAD_PREFIXPrefix to HTTP parameter used to pass key-values in the message payload.
StringPARAM_REGISTRATION_IDHTTP parameter for registration id.
StringPARAM_RESTRICTED_PACKAGE_NAMEHTTP parameter for package name that can be used to restrict message delivery by matching - against the package name used to generate the registration id.
StringPARAM_TIME_TO_LIVEPrefix to HTTP parameter used to set the message time-to-live.
StringTOKEN_CANONICAL_REG_IDToken returned by GCM when the requested registration id has a canonical - value.
StringTOKEN_ERRORToken returned by GCM when there was an error sending a message.
StringTOKEN_MESSAGE_IDToken returned by GCM when a message was successfully sent.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ERROR_DEVICE_QUOTA_EXCEEDED -

-
- - - - -
-
- -

Too many messages sent by the sender to a specific device. - Retry after a while. -

- - -
- Constant Value: - - - "DeviceQuotaExceeded" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_INTERNAL_SERVER_ERROR -

-
- - - - -
-
- -

A particular message could not be sent because the GCM servers encountered - an error. Used only on JSON requests, as in plain text requests internal - errors are indicated by a 500 response. -

- - -
- Constant Value: - - - "InternalServerError" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_INVALID_REGISTRATION -

-
- - - - -
-
- -

Bad registration_id. Sender should remove this registration_id. -

- - -
- Constant Value: - - - "InvalidRegistration" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_INVALID_TTL -

-
- - - - -
-
- -

Time to Live value passed is less than zero or more than maximum. -

- - -
- Constant Value: - - - "InvalidTtl" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_MESSAGE_TOO_BIG -

-
- - - - -
-
- -

The payload of the message is too big, see the limitations. - Reduce the size of the message. -

- - -
- Constant Value: - - - "MessageTooBig" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_MISMATCH_SENDER_ID -

-
- - - - -
-
- -

The sender_id contained in the registration_id does not match the - sender_id used to register with the GCM servers. -

- - -
- Constant Value: - - - "MismatchSenderId" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_MISSING_COLLAPSE_KEY -

-
- - - - -
-
- -

Collapse key is required. Include collapse key in the request. -

- - -
- Constant Value: - - - "MissingCollapseKey" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_MISSING_REGISTRATION -

-
- - - - -
-
- -

Missing registration_id. - Sender should always add the registration_id to the request. -

- - -
- Constant Value: - - - "MissingRegistration" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_NOT_REGISTERED -

-
- - - - -
-
- -

The user has uninstalled the application or turned off notifications. - Sender should stop sending messages to this device and delete the - registration_id. The client needs to re-register with the GCM servers to - receive notifications again. -

- - -
- Constant Value: - - - "NotRegistered" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_QUOTA_EXCEEDED -

-
- - - - -
-
- -

Too many messages sent by the sender. Retry after a while. -

- - -
- Constant Value: - - - "QuotaExceeded" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_UNAVAILABLE -

-
- - - - -
-
- -

A particular message could not be sent because the GCM servers were not - available. Used only on JSON requests, as in plain text requests - unavailability is indicated by a 503 response. -

- - -
- Constant Value: - - - "Unavailable" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GCM_SEND_ENDPOINT -

-
- - - - -
-
- -

Endpoint for sending messages. -

- - -
- Constant Value: - - - "https://android.googleapis.com/gcm/send" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_CANONICAL_IDS -

-
- - - - -
-
- -

JSON-only field representing the number of messages with a canonical - registration id. -

- - -
- Constant Value: - - - "canonical_ids" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_ERROR -

-
- - - - -
-
- -

JSON-only field representing the error field of an individual request. -

- - -
- Constant Value: - - - "error" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_FAILURE -

-
- - - - -
-
- -

JSON-only field representing the number of failed messages. -

- - -
- Constant Value: - - - "failure" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_MESSAGE_ID -

-
- - - - -
-
- -

JSON-only field sent by GCM when a message was successfully sent. -

- - -
- Constant Value: - - - "message_id" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_MULTICAST_ID -

-
- - - - -
-
- -

JSON-only field representing the id of the multicast request. -

- - -
- Constant Value: - - - "multicast_id" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_PAYLOAD -

-
- - - - -
-
- -

JSON-only field representing the payload data. -

- - -
- Constant Value: - - - "data" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_REGISTRATION_IDS -

-
- - - - -
-
- -

JSON-only field representing the registration ids. -

- - -
- Constant Value: - - - "registration_ids" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_RESULTS -

-
- - - - -
-
- -

JSON-only field representing the result of each individual request. -

- - -
- Constant Value: - - - "results" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JSON_SUCCESS -

-
- - - - -
-
- -

JSON-only field representing the number of successful messages. -

- - -
- Constant Value: - - - "success" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_COLLAPSE_KEY -

-
- - - - -
-
- -

HTTP parameter for collapse key. -

- - -
- Constant Value: - - - "collapse_key" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_DELAY_WHILE_IDLE -

-
- - - - -
-
- -

HTTP parameter for delaying the message delivery if the device is idle. -

- - -
- Constant Value: - - - "delay_while_idle" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_DRY_RUN -

-
- - - - -
-
- -

HTTP parameter for telling gcm to validate the message without actually sending it. -

- - -
- Constant Value: - - - "dry_run" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_PAYLOAD_PREFIX -

-
- - - - -
-
- -

Prefix to HTTP parameter used to pass key-values in the message payload. -

- - -
- Constant Value: - - - "data." - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_REGISTRATION_ID -

-
- - - - -
-
- -

HTTP parameter for registration id. -

- - -
- Constant Value: - - - "registration_id" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_RESTRICTED_PACKAGE_NAME -

-
- - - - -
-
- -

HTTP parameter for package name that can be used to restrict message delivery by matching - against the package name used to generate the registration id. -

- - -
- Constant Value: - - - "restricted_package_name" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_TIME_TO_LIVE -

-
- - - - -
-
- -

Prefix to HTTP parameter used to set the message time-to-live. -

- - -
- Constant Value: - - - "time_to_live" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TOKEN_CANONICAL_REG_ID -

-
- - - - -
-
- -

Token returned by GCM when the requested registration id has a canonical - value. -

- - -
- Constant Value: - - - "registration_id" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TOKEN_ERROR -

-
- - - - -
-
- -

Token returned by GCM when there was an error sending a message. -

- - -
- Constant Value: - - - "Error" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TOKEN_MESSAGE_ID -

-
- - - - -
-
- -

Token returned by GCM when a message was successfully sent. -

- - -
- Constant Value: - - - "id" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html b/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html deleted file mode 100644 index 66cf7ce10c28..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html +++ /dev/null @@ -1,1578 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InvalidRequestException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InvalidRequestException

- - - - - - - - - - - - - - - - - extends IOException
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳java.io.IOException
      ↳com.google.android.gcm.server.InvalidRequestException
- - - - - - - -
- - -

Class Overview

-

Exception thrown when GCM returned an error due to an invalid request. -

- This is equivalent to GCM posts that return an HTTP error different of 200. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - InvalidRequestException(int status) - -
- - - - - - - - InvalidRequestException(int status, String description) - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getDescription() - -
Gets the error description.
- -
- - - - - - int - - getHttpStatusCode() - -
Gets the HTTP Status Code.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - InvalidRequestException - (int status) -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - - - InvalidRequestException - (int status, String description) -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- -

Gets the error description. -

- -
-
- - - - -
-

- - public - - - - - int - - getHttpStatusCode - () -

-
-
- - - -
-
- -

Gets the HTTP Status Code. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Message.Builder.html b/docs/html/reference/com/google/android/gcm/server/Message.Builder.html deleted file mode 100644 index 99b43375610f..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Message.Builder.html +++ /dev/null @@ -1,1486 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Message.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Message.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Message.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Message.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Message.Builder - - addData(String key, String value) - -
Adds a key/value pair to the payload data.
- -
- - - - - - Message - - build() - -
- - - - - - Message.Builder - - collapseKey(String value) - -
Sets the collapseKey property.
- -
- - - - - - Message.Builder - - delayWhileIdle(boolean value) - -
Sets the delayWhileIdle property (default value is false).
- -
- - - - - - Message.Builder - - dryRun(boolean value) - -
Sets the dryRun property (default value is false).
- -
- - - - - - Message.Builder - - restrictedPackageName(String value) - -
Sets the restrictedPackageName property.
- -
- - - - - - Message.Builder - - timeToLive(int value) - -
Sets the time to live, in seconds.
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Message.Builder - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Message.Builder - - addData - (String key, String value) -

-
-
- - - -
-
- -

Adds a key/value pair to the payload data. -

- -
-
- - - - -
-

- - public - - - - - Message - - build - () -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - Message.Builder - - collapseKey - (String value) -

-
-
- - - -
-
- -

Sets the collapseKey property. -

- -
-
- - - - -
-

- - public - - - - - Message.Builder - - delayWhileIdle - (boolean value) -

-
-
- - - -
-
- -

Sets the delayWhileIdle property (default value is false). -

- -
-
- - - - -
-

- - public - - - - - Message.Builder - - dryRun - (boolean value) -

-
-
- - - -
-
- -

Sets the dryRun property (default value is false). -

- -
-
- - - - -
-

- - public - - - - - Message.Builder - - restrictedPackageName - (String value) -

-
-
- - - -
-
- -

Sets the restrictedPackageName property. -

- -
-
- - - - -
-

- - public - - - - - Message.Builder - - timeToLive - (int value) -

-
-
- - - -
-
- -

Sets the time to live, in seconds. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Message.html b/docs/html/reference/com/google/android/gcm/server/Message.html deleted file mode 100644 index 653136014d25..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Message.html +++ /dev/null @@ -1,1494 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Message | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Message

- - - - - extends Object
- - - - - - - implements - - Serializable - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Message
- - - - - - - -
- - -

Class Overview

-

GCM message. - -

- Instances of this class are immutable and should be created using a - Message.Builder. Examples: - - Simplest message: - 


- Message message = new Message.Builder().build();
-
- - Message with optional attributes: - 

- Message message = new Message.Builder()
-    .collapseKey(collapseKey)
-    .timeToLive(3)
-    .delayWhileIdle(true)
-    .dryRun(true)
-    .restrictedPackageName(restrictedPackageName)
-    .build();
-
- - Message with optional attributes and payload data: - 

- Message message = new Message.Builder()
-    .collapseKey(collapseKey)
-    .timeToLive(3)
-    .delayWhileIdle(true)
-    .dryRun(true)
-    .restrictedPackageName(restrictedPackageName)
-    .addData("key1", "value1")
-    .addData("key2", "value2")
-    .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMessage.Builder 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getCollapseKey() - -
Gets the collapse key.
- -
- - - - - - Map<String, String> - - getData() - -
Gets the payload data, which is immutable.
- -
- - - - - - String - - getRestrictedPackageName() - -
Gets the restricted package name.
- -
- - - - - - Integer - - getTimeToLive() - -
Gets the time to live (in seconds).
- -
- - - - - - Boolean - - isDelayWhileIdle() - -
Gets the delayWhileIdle flag.
- -
- - - - - - Boolean - - isDryRun() - -
Gets the dryRun flag.
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getCollapseKey - () -

-
-
- - - -
-
- -

Gets the collapse key. -

- -
-
- - - - -
-

- - public - - - - - Map<String, String> - - getData - () -

-
-
- - - -
-
- -

Gets the payload data, which is immutable. -

- -
-
- - - - -
-

- - public - - - - - String - - getRestrictedPackageName - () -

-
-
- - - -
-
- -

Gets the restricted package name. -

- -
-
- - - - -
-

- - public - - - - - Integer - - getTimeToLive - () -

-
-
- - - -
-
- -

Gets the time to live (in seconds). -

- -
-
- - - - -
-

- - public - - - - - Boolean - - isDelayWhileIdle - () -

-
-
- - - -
-
- -

Gets the delayWhileIdle flag. -

- -
-
- - - - -
-

- - public - - - - - Boolean - - isDryRun - () -

-
-
- - - -
-
- -

Gets the dryRun flag. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html b/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html deleted file mode 100644 index e400a43803e2..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/MulticastResult.Builder.html +++ /dev/null @@ -1,1288 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MulticastResult.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

MulticastResult.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.MulticastResult.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MulticastResult.Builder(int success, int failure, int canonicalIds, long multicastId) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MulticastResult.Builder - - addResult(Result result) - -
- - - - - - MulticastResult - - build() - -
- - - - - - MulticastResult.Builder - - retryMulticastIds(List<Long> retryMulticastIds) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MulticastResult.Builder - (int success, int failure, int canonicalIds, long multicastId) -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MulticastResult.Builder - - addResult - (Result result) -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - MulticastResult - - build - () -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - MulticastResult.Builder - - retryMulticastIds - (List<Long> retryMulticastIds) -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/MulticastResult.html b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html deleted file mode 100644 index ceeccd11fe6b..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/MulticastResult.html +++ /dev/null @@ -1,1511 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MulticastResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MulticastResult

- - - - - extends Object
- - - - - - - implements - - Serializable - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.MulticastResult
- - - - - - - -
- - -

Class Overview

-

Result of a GCM multicast message request . -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMulticastResult.Builder 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getCanonicalIds() - -
Gets the number of successful messages that also returned a canonical - registration id.
- -
- - - - - - int - - getFailure() - -
Gets the number of failed messages.
- -
- - - - - - long - - getMulticastId() - -
Gets the multicast id.
- -
- - - - - - List<Result> - - getResults() - -
Gets the results of each individual message, which is immutable.
- -
- - - - - - List<Long> - - getRetryMulticastIds() - -
Gets additional ids if more than one multicast message was sent.
- -
- - - - - - int - - getSuccess() - -
Gets the number of successful messages.
- -
- - - - - - int - - getTotal() - -
Gets the total number of messages sent, regardless of the status.
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getCanonicalIds - () -

-
-
- - - -
-
- -

Gets the number of successful messages that also returned a canonical - registration id. -

- -
-
- - - - -
-

- - public - - - - - int - - getFailure - () -

-
-
- - - -
-
- -

Gets the number of failed messages. -

- -
-
- - - - -
-

- - public - - - - - long - - getMulticastId - () -

-
-
- - - -
-
- -

Gets the multicast id. -

- -
-
- - - - -
-

- - public - - - - - List<Result> - - getResults - () -

-
-
- - - -
-
- -

Gets the results of each individual message, which is immutable. -

- -
-
- - - - -
-

- - public - - - - - List<Long> - - getRetryMulticastIds - () -

-
-
- - - -
-
- -

Gets additional ids if more than one multicast message was sent. -

- -
-
- - - - -
-

- - public - - - - - int - - getSuccess - () -

-
-
- - - -
-
- -

Gets the number of successful messages. -

- -
-
- - - - -
-

- - public - - - - - int - - getTotal - () -

-
-
- - - -
-
- -

Gets the total number of messages sent, regardless of the status. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Result.Builder.html b/docs/html/reference/com/google/android/gcm/server/Result.Builder.html deleted file mode 100644 index 035d2bf5b646..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Result.Builder.html +++ /dev/null @@ -1,1333 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Result.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Result.Builder

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Result.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Result.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Result - - build() - -
- - - - - - Result.Builder - - canonicalRegistrationId(String value) - -
- - - - - - Result.Builder - - errorCode(String value) - -
- - - - - - Result.Builder - - messageId(String value) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Result.Builder - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Result - - build - () -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - Result.Builder - - canonicalRegistrationId - (String value) -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - Result.Builder - - errorCode - (String value) -

-
-
- - - -
-
- -

- -
-
- - - - -
-

- - public - - - - - Result.Builder - - messageId - (String value) -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Result.html b/docs/html/reference/com/google/android/gcm/server/Result.html deleted file mode 100644 index bf004d1855d1..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Result.html +++ /dev/null @@ -1,1340 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Result | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Result

- - - - - extends Object
- - - - - - - implements - - Serializable - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Result
- - - - - - - -
- - -

Class Overview

-

Result of a GCM message request that returned HTTP status code 200. - -

- If the message is successfully created, the getMessageId() returns - the message id and getErrorCodeName() returns null; - otherwise, getMessageId() returns null and - getErrorCodeName() returns the code of the error. - -

- There are cases when a request is accept and the message successfully - created, but GCM has a canonical registration id for that device. In this - case, the server should update the registration id to avoid rejected requests - in the future. - -

- In a nutshell, the workflow to handle a result is: - 

-   - Call getMessageId():
-     - null means error, call getErrorCodeName()
-     - non-null means the message was created:
-       - Call getCanonicalRegistrationId()
-         - if it returns null, do nothing.
-         - otherwise, update the server datastore with the new id.
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classResult.Builder 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getCanonicalRegistrationId() - -
Gets the canonical registration id, if any.
- -
- - - - - - String - - getErrorCodeName() - -
Gets the error code, if any.
- -
- - - - - - String - - getMessageId() - -
Gets the message id, if any.
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getCanonicalRegistrationId - () -

-
-
- - - -
-
- -

Gets the canonical registration id, if any. -

- -
-
- - - - -
-

- - public - - - - - String - - getErrorCodeName - () -

-
-
- - - -
-
- -

Gets the error code, if any. -

- -
-
- - - - -
-

- - public - - - - - String - - getMessageId - () -

-
-
- - - -
-
- -

Gets the message id, if any. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/Sender.html b/docs/html/reference/com/google/android/gcm/server/Sender.html deleted file mode 100644 index acba818692bf..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/Sender.html +++ /dev/null @@ -1,2204 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Sender | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Sender

- - - - - extends Object
- - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gcm.server.Sender
- - - - - - - -
- - -

Class Overview

-

Helper class to send messages to the GCM service using an API Key. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBACKOFF_INITIAL_DELAYInitial delay before first retry, without jitter.
intMAX_BACKOFF_DELAYMaximum delay before a retry.
StringUTF8
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- protected - static - final - Loggerlogger
- protected - - final - Randomrandom
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Sender(String key) - -
Default constructor.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MulticastResult - - send(Message message, List<String> regIds, int retries) - -
Sends a message to many devices, retrying in case of unavailability.
- -
- - - - - - Result - - send(Message message, String registrationId, int retries) - -
Sends a message to one device, retrying in case of unavailability.
- -
- - - - - - Result - - sendNoRetry(Message message, String registrationId) - -
Sends a message without retrying in case of service unavailability.
- -
- - - - - - MulticastResult - - sendNoRetry(Message message, List<String> registrationIds) - -
Sends a message without retrying in case of service unavailability.
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - static - - void - - addParameter(StringBuilder body, String name, String value) - -
Adds a new parameter to the HTTP POST body.
- -
- - - - - - HttpURLConnection - - getConnection(String url) - -
Gets an HttpURLConnection given an URL.
- -
- - - - static - - String - - getString(InputStream stream) - -
Convenience method to convert an InputStream to a String.
- -
- - - - static - - StringBuilder - - newBody(String name, String value) - -
Creates a StringBuilder to be used as the body of an HTTP POST.
- -
- - - final - static - - Map<String, String> - - newKeyValues(String key, String value) - -
Creates a map with just one key-value pair.
- -
- - - - - - HttpURLConnection - - post(String url, String contentType, String body) - -
Makes an HTTP POST request to a given endpoint.
- -
- - - - - - HttpURLConnection - - post(String url, String body) - -
Make an HTTP post to a given URL.
- -
- - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - protected - static - final - int - - BACKOFF_INITIAL_DELAY -

-
- - - - -
-
- -

Initial delay before first retry, without jitter. -

- - -
- Constant Value: - - - 1000 - (0x000003e8) - - -
- -
-
- - - - - -
-

- - protected - static - final - int - - MAX_BACKOFF_DELAY -

-
- - - - -
-
- -

Maximum delay before a retry. -

- - -
- Constant Value: - - - 1024000 - (0x000fa000) - - -
- -
-
- - - - - -
-

- - protected - static - final - String - - UTF8 -

-
- - - - -
-
- -

- - -
- Constant Value: - - - "UTF-8" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - protected - static - final - Logger - - logger -

-
- - - - -
-
- -

- - -
-
- - - - - -
-

- - protected - - final - Random - - random -

-
- - - - -
-
- -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Sender - (String key) -

-
-
- - - -
-
- -

Default constructor.

-
-
Parameters
- - - - -
key - API key obtained through the Google API Console. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MulticastResult - - send - (Message message, List<String> regIds, int retries) -

-
-
- - - -
-
- -

Sends a message to many devices, retrying in case of unavailability. - -

- Note: this method uses exponential back-off to retry in - case of service unavailability and hence could block the calling thread - for many seconds.

-
-
Parameters
- - - - - - - - - - -
message - message to be sent.
regIds - registration id of the devices that will receive - the message.
retries - number of retries in case of service unavailability errors.
-
-
-
Returns
-
  • combined result of all requests made.
-
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if registrationIds is null or - empty.
InvalidRequestException - if GCM didn't returned a 200 or 503 status.
IOException - if message could not be sent. -
-
- -
-
- - - - -
-

- - public - - - - - Result - - send - (Message message, String registrationId, int retries) -

-
-
- - - -
-
- -

Sends a message to one device, retrying in case of unavailability. - -

- Note: this method uses exponential back-off to retry in - case of service unavailability and hence could block the calling thread - for many seconds.

-
-
Parameters
- - - - - - - - - - -
message - message to be sent, including the device's registration id.
registrationId - device where the message will be sent.
retries - number of retries in case of service unavailability errors.
-
-
-
Returns
-
  • result of the request (see its javadoc for more details).
-
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if registrationId is null.
InvalidRequestException - if GCM didn't returned a 200 or 5xx status.
IOException - if message could not be sent. -
-
- -
-
- - - - -
-

- - public - - - - - Result - - sendNoRetry - (Message message, String registrationId) -

-
-
- - - -
-
- -

Sends a message without retrying in case of service unavailability. See - send(Message, String, int) for more info.

-
-
Returns
-
  • result of the post, or null if the GCM service was - unavailable or any network exception caused the request to fail.
-
-
-
Throws
- - - - - - - - - - -
InvalidRequestException - if GCM didn't returned a 200 or 5xx status.
IllegalArgumentException - if registrationId is null. -
IOException -
-
- -
-
- - - - -
-

- - public - - - - - MulticastResult - - sendNoRetry - (Message message, List<String> registrationIds) -

-
-
- - - -
-
- -

Sends a message without retrying in case of service unavailability. See - send(Message, List, int) for more info.

-
-
Returns
-
  • multicast results if the message was sent successfully, - null if it failed but could be retried.
-
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if registrationIds is null or - empty.
InvalidRequestException - if GCM didn't returned a 200 status.
IOException - if there was a JSON parsing error -
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - static - - - - void - - addParameter - (StringBuilder body, String name, String value) -

-
-
- - - -
-
- -

Adds a new parameter to the HTTP POST body.

-
-
Parameters
- - - - - - - - - - -
body - HTTP POST body.
name - parameter's name.
value - parameter's value. -
-
- -
-
- - - - -
-

- - protected - - - - - HttpURLConnection - - getConnection - (String url) -

-
-
- - - -
-
- -

Gets an HttpURLConnection given an URL. -

-
-
Throws
- - - - -
IOException -
-
- -
-
- - - - -
-

- - protected - static - - - - String - - getString - (InputStream stream) -

-
-
- - - -
-
- -

Convenience method to convert an InputStream to a String. -

- If the stream ends in a newline character, it will be stripped. -

- If the stream is null, returns an empty string. -

-
-
Throws
- - - - -
IOException -
-
- -
-
- - - - -
-

- - protected - static - - - - StringBuilder - - newBody - (String name, String value) -

-
-
- - - -
-
- -

Creates a StringBuilder to be used as the body of an HTTP POST.

-
-
Parameters
- - - - - - - -
name - initial parameter for the POST.
value - initial value for that parameter.
-
-
-
Returns
-
  • StringBuilder to be used an HTTP POST body. -
-
- -
-
- - - - -
-

- - protected - static - final - - - Map<String, String> - - newKeyValues - (String key, String value) -

-
-
- - - -
-
- -

Creates a map with just one key-value pair. -

- -
-
- - - - -
-

- - protected - - - - - HttpURLConnection - - post - (String url, String contentType, String body) -

-
-
- - - -
-
- -

Makes an HTTP POST request to a given endpoint. - -

- Note: the returned connected should not be disconnected, - otherwise it would kill persistent connections made using Keep-Alive.

-
-
Parameters
- - - - - - - - - - -
url - endpoint to post the request.
contentType - type of request.
body - body of the request.
-
-
-
Returns
-
  • the underlying connection.
-
-
-
Throws
- - - - -
IOException - propagated from underlying methods. -
-
- -
-
- - - - -
-

- - protected - - - - - HttpURLConnection - - post - (String url, String body) -

-
-
- - - -
-
- -

Make an HTTP post to a given URL.

-
-
Returns
-
  • HTTP response. -
-
-
-
Throws
- - - - -
IOException -
-
- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gcm/server/package-summary.html b/docs/html/reference/com/google/android/gcm/server/package-summary.html deleted file mode 100644 index 773c0b5cc56b..000000000000 --- a/docs/html/reference/com/google/android/gcm/server/package-summary.html +++ /dev/null @@ -1,757 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gcm.server | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gcm.server

-
- -
- -
- - -
-

Helper library for GCM HTTP server operations — see GCM Server for more information.

- - -
- - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ConstantsConstants used on GCM service communication. 
MessageGCM message. 
Message.Builder 
MulticastResultResult of a GCM multicast message request . 
MulticastResult.Builder 
ResultResult of a GCM message request that returned HTTP status code 200. 
Result.Builder 
SenderHelper class to send messages to the GCM service using an API Key. 
-
- - - - - - - -

Exceptions

-
- - - - - - -
InvalidRequestExceptionException thrown when GCM returned an error due to an invalid request. 
-
- - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.attr.html b/docs/html/reference/com/google/android/gms/R.attr.html deleted file mode 100644 index ce786628384c..000000000000 --- a/docs/html/reference/com/google/android/gms/R.attr.html +++ /dev/null @@ -1,3380 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.attr | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.attr

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.attr
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intadSize -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. - - - -

- public - static - - intadSizes -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. - - - -

- public - static - - intadUnitId -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. - - - -

- public - static - - intappTheme -

Must be one of the following constant values. - - - -

- public - static - - intbuyButtonAppearance -

Must be one of the following constant values. - - - -

- public - static - - intbuyButtonHeight -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". - - - -

- public - static - - intbuyButtonText -

Must be one of the following constant values. - - - -

- public - static - - intbuyButtonWidth -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". - - - -

- public - static - - intcameraBearing -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intcameraTargetLat -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intcameraTargetLng -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intcameraTilt -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intcameraZoom -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intcircleCrop -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intenvironment -

Must be one of the following constant values. - - - -

- public - static - - intfragmentMode -

Must be one of the following constant values. - - - -

- public - static - - intfragmentStyle -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intimageAspectRatio -

Must be a floating point value, such as "1.2". - - - -

- public - static - - intimageAspectRatioAdjust -

Must be one of the following constant values. - - - -

- public - static - - intliteMode -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intmapType -

Must be one of the following constant values. - - - -

- public - static - - intmaskedWalletDetailsBackground -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intmaskedWalletDetailsButtonBackground -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intmaskedWalletDetailsButtonTextAppearance -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intmaskedWalletDetailsHeaderTextAppearance -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intmaskedWalletDetailsLogoImageType -

Must be one of the following constant values. - - - -

- public - static - - intmaskedWalletDetailsLogoTextColor -

Must be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb". - - - -

- public - static - - intmaskedWalletDetailsTextAppearance -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". - - - -

- public - static - - intuiCompass -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiMapToolbar -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiRotateGestures -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiScrollGestures -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiTiltGestures -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiZoomControls -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuiZoomGestures -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intuseViewLifecycle -

Must be a boolean value, either "true" or "false". - - - -

- public - static - - intwindowTransitionStyle -

Must be one of the following constant values. - - - -

- public - static - - intzOrderOnTop -

Must be a boolean value, either "true" or "false". - - - -

- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.attr() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - adSize -

-
- - - - -
-
- - - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - adSizes -

-
- - - - -
-
- - - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - adUnitId -

-
- - - - -
-
- - - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - appTheme -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
holo_dark0
holo_light1
-

- - -
-
- - - - - -
-

- - public - static - - int - - buyButtonAppearance -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
classic1
grayscale2
monochrome3
-

- - -
-
- - - - - -
-

- - public - static - - int - - buyButtonHeight -

-
- - - - -
-
- - - - -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". -Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), -in (inches), mm (millimeters). -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

May be one of the following constant values.

- ---- - - -
ConstantValueDescription
match_parent-1
wrap_content-2
-

- - -
-
- - - - - -
-

- - public - static - - int - - buyButtonText -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - - - -
ConstantValueDescription
buy_with_google1
buy_now2
book_now3
donate_with_google4
-

- - -
-
- - - - - -
-

- - public - static - - int - - buyButtonWidth -

-
- - - - -
-
- - - - -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". -Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), -in (inches), mm (millimeters). -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

May be one of the following constant values.

- ---- - - -
ConstantValueDescription
match_parent-1
wrap_content-2
-

- - -
-
- - - - - -
-

- - public - static - - int - - cameraBearing -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - cameraTargetLat -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - cameraTargetLng -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - cameraTilt -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - cameraZoom -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - circleCrop -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - environment -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
production1
sandbox0
strict_sandbox2
-

- - -
-
- - - - - -
-

- - public - static - - int - - fragmentMode -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
buyButton1
selectionDetails2
-

- - -
-
- - - - - -
-

- - public - static - - int - - fragmentStyle -

-
- - - - -
-
- - - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

- - -
-
- - - - - -
-

- - public - static - - int - - imageAspectRatio -

-
- - - - -
-
- - - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - imageAspectRatioAdjust -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
none0
adjust_width1
adjust_height2
-

- - -
-
- - - - - -
-

- - public - static - - int - - liteMode -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - mapType -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - - - - -
ConstantValueDescription
none0
normal1
satellite2
terrain3
hybrid4
-

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsBackground -

-
- - - - -
-
- - - - -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

May be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb". -

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsButtonBackground -

-
- - - - -
-
- - - - -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

May be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb". -

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsButtonTextAppearance -

-
- - - - -
-
- - - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsHeaderTextAppearance -

-
- - - - -
-
- - - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsLogoImageType -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
classic1
monochrome2
-

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsLogoTextColor -

-
- - - - -
-
- - - - -

Must be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - maskedWalletDetailsTextAppearance -

-
- - - - -
-
- - - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

- - -
-
- - - - - -
-

- - public - static - - int - - uiCompass -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiMapToolbar -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiRotateGestures -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiScrollGestures -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiTiltGestures -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiZoomControls -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - uiZoomGestures -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - useViewLifecycle -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - -
-

- - public - static - - int - - windowTransitionStyle -

-
- - - - -
-
- - - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
slide1
none2
-

- - -
-
- - - - - -
-

- - public - static - - int - - zOrderOnTop -

-
- - - - -
-
- - - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.attr - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.color.html b/docs/html/reference/com/google/android/gms/R.color.html deleted file mode 100644 index 5e327e4a49ad..000000000000 --- a/docs/html/reference/com/google/android/gms/R.color.html +++ /dev/null @@ -1,2590 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.color | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.color

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.color
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intcommon_action_bar_splitter - - - - -
- public - static - - intcommon_signin_btn_dark_text_default - - - - -
- public - static - - intcommon_signin_btn_dark_text_disabled - - - - -
- public - static - - intcommon_signin_btn_dark_text_focused - - - - -
- public - static - - intcommon_signin_btn_dark_text_pressed - - - - -
- public - static - - intcommon_signin_btn_default_background - - - - -
- public - static - - intcommon_signin_btn_light_text_default - - - - -
- public - static - - intcommon_signin_btn_light_text_disabled - - - - -
- public - static - - intcommon_signin_btn_light_text_focused - - - - -
- public - static - - intcommon_signin_btn_light_text_pressed - - - - -
- public - static - - intcommon_signin_btn_text_dark - - - - -
- public - static - - intcommon_signin_btn_text_light - - - - -
- public - static - - intwallet_bright_foreground_disabled_holo_light - - - - -
- public - static - - intwallet_bright_foreground_holo_dark - - - - -
- public - static - - intwallet_bright_foreground_holo_light - - - - -
- public - static - - intwallet_dim_foreground_disabled_holo_dark - - - - -
- public - static - - intwallet_dim_foreground_holo_dark - - - - -
- public - static - - intwallet_dim_foreground_inverse_disabled_holo_dark - - - - -
- public - static - - intwallet_dim_foreground_inverse_holo_dark - - - - -
- public - static - - intwallet_highlighted_text_holo_dark - - - - -
- public - static - - intwallet_highlighted_text_holo_light - - - - -
- public - static - - intwallet_hint_foreground_holo_dark - - - - -
- public - static - - intwallet_hint_foreground_holo_light - - - - -
- public - static - - intwallet_holo_blue_light - - - - -
- public - static - - intwallet_link_text_light - - - - -
- public - static - - intwallet_primary_text_holo_light - - - - -
- public - static - - intwallet_secondary_text_holo_dark - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.color() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - common_action_bar_splitter -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_dark_text_default -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_dark_text_disabled -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_dark_text_focused -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_dark_text_pressed -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_default_background -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_light_text_default -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_light_text_disabled -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_light_text_focused -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_light_text_pressed -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_bright_foreground_disabled_holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_bright_foreground_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_bright_foreground_holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_dim_foreground_disabled_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_dim_foreground_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_dim_foreground_inverse_disabled_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_dim_foreground_inverse_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_highlighted_text_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_highlighted_text_holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_hint_foreground_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_hint_foreground_holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_holo_blue_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_link_text_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_primary_text_holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_secondary_text_holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.color - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.drawable.html b/docs/html/reference/com/google/android/gms/R.drawable.html deleted file mode 100644 index 47f0c82342f2..000000000000 --- a/docs/html/reference/com/google/android/gms/R.drawable.html +++ /dev/null @@ -1,2825 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.drawable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.drawable

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.drawable
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intcommon_full_open_on_phone - - - - -
- public - static - - intcommon_ic_googleplayservices - - - - -
- public - static - - intcommon_signin_btn_icon_dark - - - - -
- public - static - - intcommon_signin_btn_icon_disabled_dark - - - - -
- public - static - - intcommon_signin_btn_icon_disabled_focus_dark - - - - -
- public - static - - intcommon_signin_btn_icon_disabled_focus_light - - - - -
- public - static - - intcommon_signin_btn_icon_disabled_light - - - - -
- public - static - - intcommon_signin_btn_icon_focus_dark - - - - -
- public - static - - intcommon_signin_btn_icon_focus_light - - - - -
- public - static - - intcommon_signin_btn_icon_light - - - - -
- public - static - - intcommon_signin_btn_icon_normal_dark - - - - -
- public - static - - intcommon_signin_btn_icon_normal_light - - - - -
- public - static - - intcommon_signin_btn_icon_pressed_dark - - - - -
- public - static - - intcommon_signin_btn_icon_pressed_light - - - - -
- public - static - - intcommon_signin_btn_text_dark - - - - -
- public - static - - intcommon_signin_btn_text_disabled_dark - - - - -
- public - static - - intcommon_signin_btn_text_disabled_focus_dark - - - - -
- public - static - - intcommon_signin_btn_text_disabled_focus_light - - - - -
- public - static - - intcommon_signin_btn_text_disabled_light - - - - -
- public - static - - intcommon_signin_btn_text_focus_dark - - - - -
- public - static - - intcommon_signin_btn_text_focus_light - - - - -
- public - static - - intcommon_signin_btn_text_light - - - - -
- public - static - - intcommon_signin_btn_text_normal_dark - - - - -
- public - static - - intcommon_signin_btn_text_normal_light - - - - -
- public - static - - intcommon_signin_btn_text_pressed_dark - - - - -
- public - static - - intcommon_signin_btn_text_pressed_light - - - - -
- public - static - - intic_plusone_medium_off_client - - - - -
- public - static - - intic_plusone_small_off_client - - - - -
- public - static - - intic_plusone_standard_off_client - - - - -
- public - static - - intic_plusone_tall_off_client - - - - -
- public - static - - intpowered_by_google_dark - - - - -
- public - static - - intpowered_by_google_light - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.drawable() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - common_full_open_on_phone -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_ic_googleplayservices -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_disabled_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_disabled_focus_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_disabled_focus_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_disabled_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_focus_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_focus_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_normal_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_normal_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_pressed_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_icon_pressed_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_disabled_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_disabled_focus_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_disabled_focus_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_disabled_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_focus_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_focus_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_normal_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_normal_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_pressed_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_btn_text_pressed_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - ic_plusone_medium_off_client -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - ic_plusone_small_off_client -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - ic_plusone_standard_off_client -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - ic_plusone_tall_off_client -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - powered_by_google_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - powered_by_google_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.drawable - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.html b/docs/html/reference/com/google/android/gms/R.html deleted file mode 100644 index 0a6f69859632..000000000000 --- a/docs/html/reference/com/google/android/gms/R.html +++ /dev/null @@ -1,1466 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

R

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classR.attr -   - - - -
- - - - - classR.color -   - - - -
- - - - - classR.drawable -   - - - -
- - - - - classR.id -   - - - -
- - - - - classR.integer -   - - - -
- - - - - classR.raw -   - - - -
- - - - - classR.string -   - - - -
- - - - - classR.style -   - - - -
- - - - - classR.styleable -   - - - -
- - - - - - - - - - -
Public Constructors
- - - - - - - - R() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.id.html b/docs/html/reference/com/google/android/gms/R.id.html deleted file mode 100644 index ed698f75f806..000000000000 --- a/docs/html/reference/com/google/android/gms/R.id.html +++ /dev/null @@ -1,2449 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.id | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.id

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.id
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intadjust_height - - - - -
- public - static - - intadjust_width - - - - -
- public - static - - intbook_now - - - - -
- public - static - - intbuyButton - - - - -
- public - static - - intbuy_now - - - - -
- public - static - - intbuy_with_google - - - - -
- public - static - - intclassic - - - - -
- public - static - - intdonate_with_google - - - - -
- public - static - - intgrayscale - - - - -
- public - static - - intholo_dark - - - - -
- public - static - - intholo_light - - - - -
- public - static - - inthybrid - - - - -
- public - static - - intmatch_parent - - - - -
- public - static - - intmonochrome - - - - -
- public - static - - intnone - - - - -
- public - static - - intnormal - - - - -
- public - static - - intproduction - - - - -
- public - static - - intsandbox - - - - -
- public - static - - intsatellite - - - - -
- public - static - - intselectionDetails - - - - -
- public - static - - intslide - - - - -
- public - static - - intstrict_sandbox - - - - -
- public - static - - intterrain - - - - -
- public - static - - intwrap_content - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.id() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - adjust_height -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - adjust_width -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - book_now -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - buyButton -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - buy_now -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - buy_with_google -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - classic -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - donate_with_google -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - grayscale -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - holo_dark -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - holo_light -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - hybrid -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - match_parent -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - monochrome -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - none -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - normal -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - production -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - sandbox -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - satellite -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - selectionDetails -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - slide -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - strict_sandbox -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - terrain -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wrap_content -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.id - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.integer.html b/docs/html/reference/com/google/android/gms/R.integer.html deleted file mode 100644 index d0354eb34eda..000000000000 --- a/docs/html/reference/com/google/android/gms/R.integer.html +++ /dev/null @@ -1,1368 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.integer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.integer

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.integer
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intgoogle_play_services_version - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.integer() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - google_play_services_version -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.integer - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.raw.html b/docs/html/reference/com/google/android/gms/R.raw.html deleted file mode 100644 index 439cbcf37d88..000000000000 --- a/docs/html/reference/com/google/android/gms/R.raw.html +++ /dev/null @@ -1,1368 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.raw | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.raw

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.raw
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intgtm_analytics - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.raw() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - gtm_analytics -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.raw - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.string.html b/docs/html/reference/com/google/android/gms/R.string.html deleted file mode 100644 index ae849c8968fa..000000000000 --- a/docs/html/reference/com/google/android/gms/R.string.html +++ /dev/null @@ -1,3107 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.string | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.string

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.string
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intaccept - - - - -
- public - static - - intcommon_android_wear_notification_needs_update_text - - - - -
- public - static - - intcommon_android_wear_update_text - - - - -
- public - static - - intcommon_android_wear_update_title - - - - -
- public - static - - intcommon_google_play_services_enable_button - - - - -
- public - static - - intcommon_google_play_services_enable_text - - - - -
- public - static - - intcommon_google_play_services_enable_title - - - - -
- public - static - - intcommon_google_play_services_error_notification_requested_by_msg - - - - -
- public - static - - intcommon_google_play_services_install_button - - - - -
- public - static - - intcommon_google_play_services_install_text_phone - - - - -
- public - static - - intcommon_google_play_services_install_text_tablet - - - - -
- public - static - - intcommon_google_play_services_install_title - - - - -
- public - static - - intcommon_google_play_services_invalid_account_text - - - - -
- public - static - - intcommon_google_play_services_invalid_account_title - - - - -
- public - static - - intcommon_google_play_services_needs_enabling_title - - - - -
- public - static - - intcommon_google_play_services_network_error_text - - - - -
- public - static - - intcommon_google_play_services_network_error_title - - - - -
- public - static - - intcommon_google_play_services_notification_needs_installation_title - - - - -
- public - static - - intcommon_google_play_services_notification_needs_update_title - - - - -
- public - static - - intcommon_google_play_services_notification_ticker - - - - -
- public - static - - intcommon_google_play_services_sign_in_failed_text - - - - -
- public - static - - intcommon_google_play_services_sign_in_failed_title - - - - -
- public - static - - intcommon_google_play_services_unknown_issue - - - - -
- public - static - - intcommon_google_play_services_unsupported_text - - - - -
- public - static - - intcommon_google_play_services_unsupported_title - - - - -
- public - static - - intcommon_google_play_services_update_button - - - - -
- public - static - - intcommon_google_play_services_update_text - - - - -
- public - static - - intcommon_google_play_services_update_title - - - - -
- public - static - - intcommon_open_on_phone - - - - -
- public - static - - intcommon_signin_button_text - - - - -
- public - static - - intcommon_signin_button_text_long - - - - -
- public - static - - intcommono_google_play_services_api_unavailable_text - - - - -
- public - static - - intcreate_calendar_message - - - - -
- public - static - - intcreate_calendar_title - - - - -
- public - static - - intdecline - - - - -
- public - static - - intstore_picture_message - - - - -
- public - static - - intstore_picture_title - - - - -
- public - static - - intwallet_buy_button_place_holder - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.string() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - accept -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_android_wear_notification_needs_update_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_android_wear_update_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_android_wear_update_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_enable_button -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_enable_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_enable_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_error_notification_requested_by_msg -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_install_button -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_install_text_phone -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_install_text_tablet -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_install_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_invalid_account_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_invalid_account_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_needs_enabling_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_network_error_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_network_error_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_notification_needs_installation_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_notification_needs_update_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_notification_ticker -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_sign_in_failed_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_sign_in_failed_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_unknown_issue -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_unsupported_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_unsupported_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_update_button -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_update_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_google_play_services_update_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_open_on_phone -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_button_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - common_signin_button_text_long -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - commono_google_play_services_api_unavailable_text -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - create_calendar_message -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - create_calendar_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - decline -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - store_picture_message -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - store_picture_title -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - wallet_buy_button_place_holder -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.string - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.style.html b/docs/html/reference/com/google/android/gms/R.style.html deleted file mode 100644 index cf3f454b87a2..000000000000 --- a/docs/html/reference/com/google/android/gms/R.style.html +++ /dev/null @@ -1,1556 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.style | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.style

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.style
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - - intTheme_IAPTheme - - - - -
- public - static - - intWalletFragmentDefaultButtonTextAppearance - - - - -
- public - static - - intWalletFragmentDefaultDetailsHeaderTextAppearance - - - - -
- public - static - - intWalletFragmentDefaultDetailsTextAppearance - - - - -
- public - static - - intWalletFragmentDefaultStyle - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.style() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - - int - - Theme_IAPTheme -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentDefaultButtonTextAppearance -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentDefaultDetailsHeaderTextAppearance -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentDefaultDetailsTextAppearance -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentDefaultStyle -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.style - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/R.styleable.html b/docs/html/reference/com/google/android/gms/R.styleable.html deleted file mode 100644 index 7e55b71a4295..000000000000 --- a/docs/html/reference/com/google/android/gms/R.styleable.html +++ /dev/null @@ -1,3911 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R.styleable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

R.styleable

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.R.styleable
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - int[]AdsAttrs - Attributes that can be used with a AdsAttrs. - - - -
- public - static - - intAdsAttrs_adSize -

This symbol is the offset where the adSize - attribute's value can be found in the AdsAttrs array. - - - -

- public - static - - intAdsAttrs_adSizes -

This symbol is the offset where the adSizes - attribute's value can be found in the AdsAttrs array. - - - -

- public - static - - intAdsAttrs_adUnitId -

This symbol is the offset where the adUnitId - attribute's value can be found in the AdsAttrs array. - - - -

- public - static - final - int[]CustomWalletTheme - Attributes that can be used with a CustomWalletTheme. - - - -
- public - static - - intCustomWalletTheme_windowTransitionStyle -

This symbol is the offset where the windowTransitionStyle - attribute's value can be found in the CustomWalletTheme array. - - - -

- public - static - final - int[]LoadingImageView - Attributes that can be used with a LoadingImageView. - - - -
- public - static - - intLoadingImageView_circleCrop -

This symbol is the offset where the circleCrop - attribute's value can be found in the LoadingImageView array. - - - -

- public - static - - intLoadingImageView_imageAspectRatio -

This symbol is the offset where the imageAspectRatio - attribute's value can be found in the LoadingImageView array. - - - -

- public - static - - intLoadingImageView_imageAspectRatioAdjust -

This symbol is the offset where the imageAspectRatioAdjust - attribute's value can be found in the LoadingImageView array. - - - -

- public - static - final - int[]MapAttrs - Attributes that can be used with a MapAttrs. - - - -
- public - static - - intMapAttrs_cameraBearing -

This symbol is the offset where the cameraBearing - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_cameraTargetLat -

This symbol is the offset where the cameraTargetLat - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_cameraTargetLng -

This symbol is the offset where the cameraTargetLng - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_cameraTilt -

This symbol is the offset where the cameraTilt - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_cameraZoom -

This symbol is the offset where the cameraZoom - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_liteMode -

This symbol is the offset where the liteMode - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_mapType -

This symbol is the offset where the mapType - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiCompass -

This symbol is the offset where the uiCompass - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiMapToolbar -

This symbol is the offset where the uiMapToolbar - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiRotateGestures -

This symbol is the offset where the uiRotateGestures - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiScrollGestures -

This symbol is the offset where the uiScrollGestures - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiTiltGestures -

This symbol is the offset where the uiTiltGestures - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiZoomControls -

This symbol is the offset where the uiZoomControls - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_uiZoomGestures -

This symbol is the offset where the uiZoomGestures - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_useViewLifecycle -

This symbol is the offset where the useViewLifecycle - attribute's value can be found in the MapAttrs array. - - - -

- public - static - - intMapAttrs_zOrderOnTop -

This symbol is the offset where the zOrderOnTop - attribute's value can be found in the MapAttrs array. - - - -

- public - static - final - int[]WalletFragmentOptions - Attributes that can be used with a WalletFragmentOptions. - - - -
- public - static - - intWalletFragmentOptions_appTheme -

This symbol is the offset where the appTheme - attribute's value can be found in the WalletFragmentOptions array. - - - -

- public - static - - intWalletFragmentOptions_environment -

This symbol is the offset where the environment - attribute's value can be found in the WalletFragmentOptions array. - - - -

- public - static - - intWalletFragmentOptions_fragmentMode -

This symbol is the offset where the fragmentMode - attribute's value can be found in the WalletFragmentOptions array. - - - -

- public - static - - intWalletFragmentOptions_fragmentStyle -

This symbol is the offset where the fragmentStyle - attribute's value can be found in the WalletFragmentOptions array. - - - -

- public - static - final - int[]WalletFragmentStyle - Attributes that can be used with a WalletFragmentStyle. - - - -
- public - static - - intWalletFragmentStyle_buyButtonAppearance -

This symbol is the offset where the buyButtonAppearance - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_buyButtonHeight -

This symbol is the offset where the buyButtonHeight - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_buyButtonText -

This symbol is the offset where the buyButtonText - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_buyButtonWidth -

This symbol is the offset where the buyButtonWidth - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsBackground -

This symbol is the offset where the maskedWalletDetailsBackground - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsButtonBackground -

This symbol is the offset where the maskedWalletDetailsButtonBackground - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsButtonTextAppearance -

This symbol is the offset where the maskedWalletDetailsButtonTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsHeaderTextAppearance -

This symbol is the offset where the maskedWalletDetailsHeaderTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsLogoImageType -

This symbol is the offset where the maskedWalletDetailsLogoImageType - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsLogoTextColor -

This symbol is the offset where the maskedWalletDetailsLogoTextColor - attribute's value can be found in the WalletFragmentStyle array. - - - -

- public - static - - intWalletFragmentStyle_maskedWalletDetailsTextAppearance -

This symbol is the offset where the maskedWalletDetailsTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - - -

- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - R.styleable() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - int[] - - AdsAttrs -

-
- - - - -
-
- - - - -

Attributes that can be used with a AdsAttrs. -

Includes the following attributes:

- - - - - - - -
AttributeDescription
com.google.android.gms:adSize
com.google.android.gms:adSizes
com.google.android.gms:adUnitId

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - AdsAttrs_adSize -

-
- - - - -
-
- - - - -

This symbol is the offset where the adSize - attribute's value can be found in the AdsAttrs array. - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - AdsAttrs_adSizes -

-
- - - - -
-
- - - - -

This symbol is the offset where the adSizes - attribute's value can be found in the AdsAttrs array. - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - AdsAttrs_adUnitId -

-
- - - - -
-
- - - - -

This symbol is the offset where the adUnitId - attribute's value can be found in the AdsAttrs array. - - -

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character. -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - final - int[] - - CustomWalletTheme -

-
- - - - -
-
- - - - -

Attributes that can be used with a CustomWalletTheme. -

Includes the following attributes:

- - - - - -
AttributeDescription
com.google.android.gms:windowTransitionStyle

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - CustomWalletTheme_windowTransitionStyle -

-
- - - - -
-
- - - - -

This symbol is the offset where the windowTransitionStyle - attribute's value can be found in the CustomWalletTheme array. - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
slide1
none2

- - -
-
- - - - - -
-

- - public - static - final - int[] - - LoadingImageView -

-
- - - - -
-
- - - - -

Attributes that can be used with a LoadingImageView. -

Includes the following attributes:

- - - - - - - -
AttributeDescription
com.google.android.gms:circleCrop
com.google.android.gms:imageAspectRatio
com.google.android.gms:imageAspectRatioAdjust

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - LoadingImageView_circleCrop -

-
- - - - -
-
- - - - -

This symbol is the offset where the circleCrop - attribute's value can be found in the LoadingImageView array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - LoadingImageView_imageAspectRatio -

-
- - - - -
-
- - - - -

This symbol is the offset where the imageAspectRatio - attribute's value can be found in the LoadingImageView array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - LoadingImageView_imageAspectRatioAdjust -

-
- - - - -
-
- - - - -

This symbol is the offset where the imageAspectRatioAdjust - attribute's value can be found in the LoadingImageView array. - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
none0
adjust_width1
adjust_height2

- - -
-
- - - - - -
-

- - public - static - final - int[] - - MapAttrs -

-
- - - - -
-
- - - - -

Attributes that can be used with a MapAttrs. -

Includes the following attributes:

- - - - - - - - - - - - - - - - - - - - -
AttributeDescription
com.google.android.gms:cameraBearing
com.google.android.gms:cameraTargetLat
com.google.android.gms:cameraTargetLng
com.google.android.gms:cameraTilt
com.google.android.gms:cameraZoom
com.google.android.gms:liteMode
com.google.android.gms:mapType
com.google.android.gms:uiCompass
com.google.android.gms:uiMapToolbar
com.google.android.gms:uiRotateGestures
com.google.android.gms:uiScrollGestures
com.google.android.gms:uiTiltGestures
com.google.android.gms:uiZoomControls
com.google.android.gms:uiZoomGestures
com.google.android.gms:useViewLifecycle
com.google.android.gms:zOrderOnTop

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_cameraBearing -

-
- - - - -
-
- - - - -

This symbol is the offset where the cameraBearing - attribute's value can be found in the MapAttrs array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_cameraTargetLat -

-
- - - - -
-
- - - - -

This symbol is the offset where the cameraTargetLat - attribute's value can be found in the MapAttrs array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_cameraTargetLng -

-
- - - - -
-
- - - - -

This symbol is the offset where the cameraTargetLng - attribute's value can be found in the MapAttrs array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_cameraTilt -

-
- - - - -
-
- - - - -

This symbol is the offset where the cameraTilt - attribute's value can be found in the MapAttrs array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_cameraZoom -

-
- - - - -
-
- - - - -

This symbol is the offset where the cameraZoom - attribute's value can be found in the MapAttrs array. - - -

Must be a floating point value, such as "1.2". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_liteMode -

-
- - - - -
-
- - - - -

This symbol is the offset where the liteMode - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_mapType -

-
- - - - -
-
- - - - -

This symbol is the offset where the mapType - attribute's value can be found in the MapAttrs array. - - -

Must be one of the following constant values.

- ---- - - - - - -
ConstantValueDescription
none0
normal1
satellite2
terrain3
hybrid4

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiCompass -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiCompass - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiMapToolbar -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiMapToolbar - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiRotateGestures -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiRotateGestures - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiScrollGestures -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiScrollGestures - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiTiltGestures -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiTiltGestures - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiZoomControls -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiZoomControls - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_uiZoomGestures -

-
- - - - -
-
- - - - -

This symbol is the offset where the uiZoomGestures - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_useViewLifecycle -

-
- - - - -
-
- - - - -

This symbol is the offset where the useViewLifecycle - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - MapAttrs_zOrderOnTop -

-
- - - - -
-
- - - - -

This symbol is the offset where the zOrderOnTop - attribute's value can be found in the MapAttrs array. - - -

Must be a boolean value, either "true" or "false". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - final - int[] - - WalletFragmentOptions -

-
- - - - -
-
- - - - -

Attributes that can be used with a WalletFragmentOptions. -

Includes the following attributes:

- - - - - - - - -
AttributeDescription
com.google.android.gms:appTheme
com.google.android.gms:environment
com.google.android.gms:fragmentMode
com.google.android.gms:fragmentStyle

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentOptions_appTheme -

-
- - - - -
-
- - - - -

This symbol is the offset where the appTheme - attribute's value can be found in the WalletFragmentOptions array. - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
holo_dark0
holo_light1

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentOptions_environment -

-
- - - - -
-
- - - - -

This symbol is the offset where the environment - attribute's value can be found in the WalletFragmentOptions array. - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
production1
sandbox0
strict_sandbox2

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentOptions_fragmentMode -

-
- - - - -
-
- - - - -

This symbol is the offset where the fragmentMode - attribute's value can be found in the WalletFragmentOptions array. - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
buyButton1
selectionDetails2

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentOptions_fragmentStyle -

-
- - - - -
-
- - - - -

This symbol is the offset where the fragmentStyle - attribute's value can be found in the WalletFragmentOptions array. - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name".

- - -
-
- - - - - -
-

- - public - static - final - int[] - - WalletFragmentStyle -

-
- - - - -
-
- - - - -

Attributes that can be used with a WalletFragmentStyle. -

Includes the following attributes:

- - - - - - - - - - - - - - - -
AttributeDescription
com.google.android.gms:buyButtonAppearance
com.google.android.gms:buyButtonHeight
com.google.android.gms:buyButtonText
com.google.android.gms:buyButtonWidth
com.google.android.gms:maskedWalletDetailsBackground
com.google.android.gms:maskedWalletDetailsButtonBackground
com.google.android.gms:maskedWalletDetailsButtonTextAppearance
com.google.android.gms:maskedWalletDetailsHeaderTextAppearance
com.google.android.gms:maskedWalletDetailsLogoImageType
com.google.android.gms:maskedWalletDetailsLogoTextColor
com.google.android.gms:maskedWalletDetailsTextAppearance

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_buyButtonAppearance -

-
- - - - -
-
- - - - -

This symbol is the offset where the buyButtonAppearance - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be one of the following constant values.

- ---- - - - -
ConstantValueDescription
classic1
grayscale2
monochrome3

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_buyButtonHeight -

-
- - - - -
-
- - - - -

This symbol is the offset where the buyButtonHeight - attribute's value can be found in the WalletFragmentStyle array. - - -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". -Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), -in (inches), mm (millimeters). -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

May be one of the following constant values.

- ---- - - -
ConstantValueDescription
match_parent-1
wrap_content-2

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_buyButtonText -

-
- - - - -
-
- - - - -

This symbol is the offset where the buyButtonText - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be one of the following constant values.

- ---- - - - - -
ConstantValueDescription
buy_with_google1
buy_now2
book_now3
donate_with_google4

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_buyButtonWidth -

-
- - - - -
-
- - - - -

This symbol is the offset where the buyButtonWidth - attribute's value can be found in the WalletFragmentStyle array. - - -

May be a dimension value, which is a floating point number appended with a unit such as "14.5sp". -Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), -in (inches), mm (millimeters). -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type. -

May be one of the following constant values.

- ---- - - -
ConstantValueDescription
match_parent-1
wrap_content-2

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsBackground -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsBackground - attribute's value can be found in the WalletFragmentStyle array. - - -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

May be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb".

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsButtonBackground -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsButtonBackground - attribute's value can be found in the WalletFragmentStyle array. - - -

May be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name". -

May be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb".

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsButtonTextAppearance -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsButtonTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name".

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsHeaderTextAppearance -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsHeaderTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name".

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsLogoImageType -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsLogoImageType - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be one of the following constant values.

- ---- - - -
ConstantValueDescription
classic1
monochrome2

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsLogoTextColor -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsLogoTextColor - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be a color value, in the form of "#rgb", "#argb", -"#rrggbb", or "#aarrggbb". -

This may also be a reference to a resource (in the form -"@[package:]type:name") or -theme attribute (in the form -"?[package:][type:]name") -containing a value of this type.

- - -
-
- - - - - -
-

- - public - static - - int - - WalletFragmentStyle_maskedWalletDetailsTextAppearance -

-
- - - - -
-
- - - - -

This symbol is the offset where the maskedWalletDetailsTextAppearance - attribute's value can be found in the WalletFragmentStyle array. - - -

Must be a reference to another resource, in the form "@[+][package:]type:name" -or to a theme attribute in the form "?[package:][type:]name".

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - R.styleable - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/actions/ItemListIntents.html b/docs/html/reference/com/google/android/gms/actions/ItemListIntents.html deleted file mode 100644 index a3caaadf3f27..000000000000 --- a/docs/html/reference/com/google/android/gms/actions/ItemListIntents.html +++ /dev/null @@ -1,1891 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ItemListIntents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ItemListIntents

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.actions.ItemListIntents
- - - - - - - -
- - -

Class Overview

-

Constants for intents to create and modify item lists from a Search Action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_ACCEPT_ITEM - Intent action for marking an existing list item complete. - - - -
StringACTION_APPEND_ITEM_LIST - Intent action for appending to an existing item list. - - - -
StringACTION_CREATE_ITEM_LIST - Intent action for creating an item list. - - - -
StringACTION_DELETE_ITEM - Intent action for deleting an existing list item. - - - -
StringACTION_DELETE_ITEM_LIST - Intent action for removing an item list. - - - -
StringACTION_REJECT_ITEM - Intent action for marking an existing list item incomplete. - - - -
StringEXTRA_ITEM_NAME - Intent extra specifying the contents of a list item as a string. - - - -
StringEXTRA_ITEM_NAMES - Intent extra for specifying multiple items when creating a list with ACTION_CREATE_ITEM_LIST as a string array. - - - -
StringEXTRA_ITEM_QUERY - Intent extra specifying an unstructured query to identify a specific item as a string. - - - -
StringEXTRA_LIST_NAME - Intent extra specifying an optional name or title as a string describing what the list - contains (e.g. - - - -
StringEXTRA_LIST_QUERY - Intent extra specifying an unstructured query for an item list as a string. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_ACCEPT_ITEM -

-
- - - - -
-
- - - - -

Intent action for marking an existing list item complete. The intent can use extras to - specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with - EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using - setData(Uri) - the intent data will always be preferred over - using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity - MUST ask the user to disambiguate. -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.ACCEPT_ITEM" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_APPEND_ITEM_LIST -

-
- - - - -
-
- - - - -

Intent action for appending to an existing item list. The intent should include an extra to - specify the list to append with EXTRA_LIST_QUERY or specify the list - with setData(Uri). If both are specified, the intent data will - be preferred. If the name is ambiguous, the activity MUST ask the user to disambiguate. -

- The intent can optionally include an extra specifying the item EXTRA_ITEM_NAME to - add to the list. If the item is not specified, the activity should present a UI for the item - to add. -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.APPEND_ITEM_LIST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CREATE_ITEM_LIST -

-
- - - - -
-
- - - - -

Intent action for creating an item list. The intent can include optional extras to - specify the list name EXTRA_LIST_NAME and the initial list of items - EXTRA_ITEM_NAMES. For example, a shopping list might have a list name of "shopping - list" and item names of "ham" and "eggs". -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.CREATE_ITEM_LIST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_DELETE_ITEM -

-
- - - - -
-
- - - - -

Intent action for deleting an existing list item. The intent can use extras to - specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with - EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using - setData(Uri) - the intent data will always be preferred over - using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity - MUST ask the user to disambiguate. -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.DELETE_ITEM" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_DELETE_ITEM_LIST -

-
- - - - -
-
- - - - -

Intent action for removing an item list. The intent can include an optional extra to - specify a list query EXTRA_LIST_QUERY that is used to identify the note to be - removed. For example if the query is "shopping list" and there are two potentially matching - lists "food shopping list" and "clothes shopping list" then both should be presented. -

- The list to be deleted can also be specified with setData(Uri) - - the intent data will be preferred if EXTRA_LIST_QUERY is also specified. -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.DELETE_ITEM_LIST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_REJECT_ITEM -

-
- - - - -
-
- - - - -

Intent action for marking an existing list item incomplete. The intent can use extras to - specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with - EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using - setData(Uri) - the intent data will always be preferred over - using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity - MUST ask the user to disambiguate. -

- The activity MUST verify the operation with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.REJECT_ITEM" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ITEM_NAME -

-
- - - - -
-
- - - - -

Intent extra specifying the contents of a list item as a string. For example in - a shopping list, the item names might be "eggs" and "ham". -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.ITEM_NAME" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ITEM_NAMES -

-
- - - - -
-
- - - - -

Intent extra for specifying multiple items when creating a list with ACTION_CREATE_ITEM_LIST as a string array. The individual values should - be specied according to EXTRA_ITEM_NAME. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.ITEM_NAMES" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ITEM_QUERY -

-
- - - - -
-
- - - - -

Intent extra specifying an unstructured query to identify a specific item as a string. The - query should be matched against the name provided in EXTRA_ITEM_NAME. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.ITEM_QUERY" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_LIST_NAME -

-
- - - - -
-
- - - - -

Intent extra specifying an optional name or title as a string describing what the list - contains (e.g. "shopping" or "todo"). -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.LIST_NAME" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_LIST_QUERY -

-
- - - - -
-
- - - - -

Intent extra specifying an unstructured query for an item list as a string. This could - search the list title or the items in the list to find a match, although matching the title - should be preferred. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.LIST_QUERY" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/actions/NoteIntents.html b/docs/html/reference/com/google/android/gms/actions/NoteIntents.html deleted file mode 100644 index 24ec77f033fb..000000000000 --- a/docs/html/reference/com/google/android/gms/actions/NoteIntents.html +++ /dev/null @@ -1,1605 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NoteIntents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

NoteIntents

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.actions.NoteIntents
- - - - - - - -
- - -

Class Overview

-

Constants for intents to create and modify notes from a Search Action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_APPEND_NOTE - Intent action for appending to an existing note. - - - -
StringACTION_CREATE_NOTE - Intent action for creating a note. - - - -
StringACTION_DELETE_NOTE - Intent action for removing an existing note. - - - -
StringEXTRA_NAME - Intent extra specifying an optional title or subject for the note as a string. - - - -
StringEXTRA_NOTE_QUERY - Intent extra specifying an unstructured query for a note as a string. - - - -
StringEXTRA_TEXT - Intent extra specifying the text of the note as a string. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_APPEND_NOTE -

-
- - - - -
-
- - - - -

Intent action for appending to an existing note. The intent should include an extra to - specify the text EXTRA_TEXT to append. -

- The intent should specify the note to append to with the EXTRA_NOTE_QUERY extra. - Alternatively the note can be specified using setData(Uri) - - the intent data URI will always be preferred over EXTRA_NOTE_QUERY. If the note - is ambiguous, the activity MUST ask the user to disambiguate. -

- The activity MUST verify the result with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.APPEND_NOTE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CREATE_NOTE -

-
- - - - -
-
- - - - -

Intent action for creating a note. The intent may optionally include an extra to - specify the title or subject of the note EXTRA_NAME. -

- For a text note the data mimetype will be "text/plain" and the content will be - included in the EXTRA_TEXT. -

- For an audio note, the audio data will be attached as - ClipData with the data mimetype of "audio/<type>". -

- Activities should restrict the types of content they can handle in the - intent filter. -

- The activity MUST verify the result with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.CREATE_NOTE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_DELETE_NOTE -

-
- - - - -
-
- - - - -

Intent action for removing an existing note. -

- The intent should specify the note to append to with the EXTRA_NOTE_QUERY extra. - Alternatively the note can be specified using setData(Uri) - - the intent data URI will always be preferred over EXTRA_NOTE_QUERY. If the note - is ambiguous, the activity MUST ask the user to disambiguate. -

- The activity MUST verify the result with the user before committing the change. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.DELETE_NOTE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_NAME -

-
- - - - -
-
- - - - -

Intent extra specifying an optional title or subject for the note as a string. The name - can be used to locate the note later with EXTRA_NOTE_QUERY. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.NAME" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_NOTE_QUERY -

-
- - - - -
-
- - - - -

Intent extra specifying an unstructured query for a note as a string. This could - search the note name or the text content of the note. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.NOTE_QUERY" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_TEXT -

-
- - - - -
-
- - - - -

Intent extra specifying the text of the note as a string. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.extra.TEXT" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/actions/ReserveIntents.html b/docs/html/reference/com/google/android/gms/actions/ReserveIntents.html deleted file mode 100644 index 46d4764cc552..000000000000 --- a/docs/html/reference/com/google/android/gms/actions/ReserveIntents.html +++ /dev/null @@ -1,1312 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ReserveIntents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ReserveIntents

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.actions.ReserveIntents
- - - - - - - -
- - -

Class Overview

-

Constants for intents corresponding to Reserve Action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_RESERVE_TAXI_RESERVATION - Intent action for reserving a taxi. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_RESERVE_TAXI_RESERVATION -

-
- - - - -
-
- - - - -

Intent action for reserving a taxi. The application MUST confirm whatever action - will be taken with the user before completing the action (e.g. confirmation dialog). -

- - -
- Constant Value: - - - "com.google.android.gms.actions.RESERVE_TAXI_RESERVATION" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/actions/SearchIntents.html b/docs/html/reference/com/google/android/gms/actions/SearchIntents.html deleted file mode 100644 index 9f95e2b465c6..000000000000 --- a/docs/html/reference/com/google/android/gms/actions/SearchIntents.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchIntents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SearchIntents

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.actions.SearchIntents
- - - - - - - -
- - -

Class Overview

-

Constants for intents to perform in-app search from a Search Action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_SEARCH - Intent action for performing an in-app search. - - - -
StringEXTRA_QUERY - Intent extra specifying the text query to use as a string for ACTION_SEARCH. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_SEARCH -

-
- - - - -
-
- - - - -

Intent action for performing an in-app search. The intent should include an optional - extra to specify the text to search for EXTRA_QUERY. If no extras are - provided, the application should just show an Activity with the search UI activated. -

- - -
- Constant Value: - - - "com.google.android.gms.actions.SEARCH_ACTION" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_QUERY -

-
- - - - -
-
- - - - -

Intent extra specifying the text query to use as a string for ACTION_SEARCH. -

- - -
- Constant Value: - - - "query" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/actions/package-summary.html b/docs/html/reference/com/google/android/gms/actions/package-summary.html deleted file mode 100644 index 66d8c9176d6d..000000000000 --- a/docs/html/reference/com/google/android/gms/actions/package-summary.html +++ /dev/null @@ -1,923 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.actions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.actions

-
- -
- -
- - -
- Contains classes for Google Search Actions. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ItemListIntents - Constants for intents to create and modify item lists from a Search Action.  - - - -
NoteIntents - Constants for intents to create and modify notes from a Search Action.  - - - -
ReserveIntents - Constants for intents corresponding to Reserve Action.  - - - -
SearchIntents - Constants for intents to perform in-app search from a Search Action.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/AdListener.html b/docs/html/reference/com/google/android/gms/ads/AdListener.html deleted file mode 100644 index 25bf17e50714..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/AdListener.html +++ /dev/null @@ -1,1605 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

AdListener

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.AdListener
- - - - - - - -
- - -

Class Overview

-

A listener for receiving notifications during the lifecycle of an ad. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdListener() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onAdClosed() - -
- Called when the user is about to return to the application after clicking on an ad. - - - -
- -
- - - - - - void - - onAdFailedToLoad(int errorCode) - -
- Called when an ad request failed. - - - -
- -
- - - - - - void - - onAdLeftApplication() - -
- Called when an ad leaves the application (e.g., to go to the browser). - - - -
- -
- - - - - - void - - onAdLoaded() - -
- Called when an ad is received. - - - -
- -
- - - - - - void - - onAdOpened() - -
- Called when an ad opens an overlay that covers the screen. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdListener - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onAdClosed - () -

-
-
- - - -
-
- - - - -

Called when the user is about to return to the application after clicking on an ad. -

- -
-
- - - - -
-

- - public - - - - - void - - onAdFailedToLoad - (int errorCode) -

-
-
- - - -
-
- - - - -

Called when an ad request failed. The error code is usually - ERROR_CODE_INTERNAL_ERROR, ERROR_CODE_INVALID_REQUEST, - ERROR_CODE_NETWORK_ERROR, or ERROR_CODE_NO_FILL. -

- -
-
- - - - -
-

- - public - - - - - void - - onAdLeftApplication - () -

-
-
- - - -
-
- - - - -

Called when an ad leaves the application (e.g., to go to the browser). -

- -
-
- - - - -
-

- - public - - - - - void - - onAdLoaded - () -

-
-
- - - -
-
- - - - -

Called when an ad is received. -

- -
-
- - - - -
-

- - public - - - - - void - - onAdOpened - () -

-
-
- - - -
-
- - - - -

Called when an ad opens an overlay that covers the screen. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/AdRequest.Builder.html b/docs/html/reference/com/google/android/gms/ads/AdRequest.Builder.html deleted file mode 100644 index de63f03d9c57..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/AdRequest.Builder.html +++ /dev/null @@ -1,2083 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

AdRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.AdRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builds an AdRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - AdRequest.Builder - - addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) - -
- Add extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - AdRequest.Builder - - addKeyword(String keyword) - -
- Add a keyword for targeting purposes. - - - -
- -
- - - - - - AdRequest.Builder - - addNetworkExtras(NetworkExtras networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - AdRequest.Builder - - addNetworkExtrasBundle(Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - AdRequest.Builder - - addTestDevice(String deviceId) - -
- Causes a device to receive test ads. - - - -
- -
- - - - - - AdRequest - - build() - -
- Constructs an AdRequest with the specified attributes. - - - -
- -
- - - - - - AdRequest.Builder - - setBirthday(Date birthday) - -
- Sets the user's birthday for targeting purposes. - - - -
- -
- - - - - - AdRequest.Builder - - setContentUrl(String contentUrl) - -
- Sets the content URL for targeting purposes. - - - -
- -
- - - - - - AdRequest.Builder - - setGender(int gender) - -
- Sets the user's gender for targeting purposes. - - - -
- -
- - - - - - AdRequest.Builder - - setLocation(Location location) - -
- Sets the user's location for targeting purposes. - - - -
- -
- - - - - - AdRequest.Builder - - setRequestAgent(String requestAgent) - -
- Sets the request agent string to identify the ad request's origin. - - - -
- -
- - - - - - AdRequest.Builder - - tagForChildDirectedTreatment(boolean tagForChildDirectedTreatment) - -
- This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - AdRequest.Builder - - addCustomEventExtrasBundle - (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific custom event adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the custom event adapter for which you are - providing extras.
customEventExtras - A Bundle of extra information to pass to a custom event - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - addKeyword - (String keyword) -

-
-
- - - -
-
- - - - -

Add a keyword for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - addNetworkExtras - (NetworkExtras networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter. networkExtras - should be an instance of com.google.ads.mediation.NetworkExtras, which is - provided by ad network adapters. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - addNetworkExtrasBundle - (Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the adapter for the network for which you are - providing extras.
networkExtras - A Bundle of extra information to pass to a mediation - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - addTestDevice - (String deviceId) -

-
-
- - - -
-
- - - - -

Causes a device to receive test ads. The deviceId can be obtained by viewing the - logcat output after creating a new ad. -

- -
-
- - - - -
-

- - public - - - - - AdRequest - - build - () -

-
-
- - - -
-
- - - - -

Constructs an AdRequest with the specified attributes. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - setBirthday - (Date birthday) -

-
-
- - - -
-
- - - - -

Sets the user's birthday for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - setContentUrl - (String contentUrl) -

-
-
- - - -
-
- - - - -

Sets the content URL for targeting purposes.

-
-
Throws
- - - - - - - -
NullPointerException - If contentUrl is {code null}.
IllegalArgumentException - If contentUrl is empty, or if its - length exceeds 512. -
-
- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - setGender - (int gender) -

-
-
- - - -
-
- - - - -

Sets the user's gender for targeting purposes. This should be - GENDER_MALE, GENDER_FEMALE, or GENDER_UNKNOWN. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - setLocation - (Location location) -

-
-
- - - -
-
- - - - -

Sets the user's location for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - setRequestAgent - (String requestAgent) -

-
-
- - - -
-
- - - - -

Sets the request agent string to identify the ad request's origin. Third party libraries - that reference the Mobile Ads SDK should call this method to denote the platform from - which the ad request originated. For example, if a third party ad network called - "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method - with "CoolAds". -

- -
-
- - - - -
-

- - public - - - - - AdRequest.Builder - - tagForChildDirectedTreatment - (boolean tagForChildDirectedTreatment) -

-
-
- - - -
-
- - - - -

This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. -

- If you set this method to true, you will indicate that your app should be treated - as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA). -

- If you set this method to false, you will indicate that your app should not be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). -

- If you do not set this method, ad requests will include no indication of how you would - like your app treated with respect to COPPA. -

- By setting this method, you certify that this notification is accurate and you are - authorized to act on behalf of the owner of the app. You understand that abuse of this - setting may result in termination of your Google account. -

- Note: it may take some time for this designation to be fully implemented in applicable - Google services. -

- This designation will only apply to ad requests for which you have set this method.

-
-
Parameters
- - - - -
tagForChildDirectedTreatment - Set to true to indicate that your app should - be treated as child-directed. Set to false to indicate that your app - should not be treated as child-directed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/AdRequest.html b/docs/html/reference/com/google/android/gms/ads/AdRequest.html deleted file mode 100644 index 44f999001fef..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/AdRequest.html +++ /dev/null @@ -1,2320 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AdRequest

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.AdRequest
- - - - - - - -
- - -

Class Overview

-

An AdRequest contains targeting information used to fetch an ad. Ad requests are created - using AdRequest.Builder. -

- Publishers using DoubleClick for Publishers or Search Ads for Apps should use - PublisherAdRequest or - SearchAdRequest, respectively. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classAdRequest.Builder - Builds an AdRequest.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intERROR_CODE_INTERNAL_ERROR - Something happened internally; for instance, an invalid response was received from the ad - server. - - - -
intERROR_CODE_INVALID_REQUEST - The ad request was invalid; for instance, the ad unit ID was incorrect. - - - -
intERROR_CODE_NETWORK_ERROR - The ad request was unsuccessful due to network connectivity. - - - -
intERROR_CODE_NO_FILL - The ad request was successful, but no ad was returned due to lack of ad inventory. - - - -
intGENDER_FEMALE - Female gender. - - - -
intGENDER_MALE - Male gender. - - - -
intGENDER_UNKNOWN - Unknown gender. - - - -
intMAX_CONTENT_URL_LENGTH - The maximum content URL length. - - - -
- - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - StringDEVICE_ID_EMULATOR - The deviceId for emulators to be used with - addTestDevice(String). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Date - - getBirthday() - -
- Returns the user's birthday targeting information. - - - -
- -
- - - - - - String - - getContentUrl() - -
- Returns the content URL targeting information. - - - -
- -
- - - - - <T extends CustomEvent> - Bundle - - getCustomEventExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - int - - getGender() - -
- Returns the user's gender targeting information. - - - -
- -
- - - - - - Set<String> - - getKeywords() - -
- Returns targeting information keywords. - - - -
- -
- - - - - - Location - - getLocation() - -
- Returns the user's location targeting information. - - - -
- -
- - - - - <T extends NetworkExtras> - T - - getNetworkExtras(Class<T> networkExtrasClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - <T extends MediationAdapter> - Bundle - - getNetworkExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - boolean - - isTestDevice(Context context) - -
- Returns true if this device will receive test ads. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ERROR_CODE_INTERNAL_ERROR -

-
- - - - -
-
- - - - -

Something happened internally; for instance, an invalid response was received from the ad - server. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INVALID_REQUEST -

-
- - - - -
-
- - - - -

The ad request was invalid; for instance, the ad unit ID was incorrect. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NETWORK_ERROR -

-
- - - - -
-
- - - - -

The ad request was unsuccessful due to network connectivity. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NO_FILL -

-
- - - - -
-
- - - - -

The ad request was successful, but no ad was returned due to lack of ad inventory. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_FEMALE -

-
- - - - -
-
- - - - -

Female gender.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_MALE -

-
- - - - -
-
- - - - -

Male gender.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_UNKNOWN -

-
- - - - -
-
- - - - -

Unknown gender.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_CONTENT_URL_LENGTH -

-
- - - - -
-
- - - - -

The maximum content URL length.

- - -
- Constant Value: - - - 512 - (0x00000200) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - String - - DEVICE_ID_EMULATOR -

-
- - - - -
-
- - - - -

The deviceId for emulators to be used with - addTestDevice(String). -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Date - - getBirthday - () -

-
-
- - - -
-
- - - - -

Returns the user's birthday targeting information. Returns null if the birthday was - not set. -

- -
-
- - - - -
-

- - public - - - - - String - - getContentUrl - () -

-
-
- - - -
-
- - - - -

Returns the content URL targeting information. Returns null if the contentUrl was - not set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getCustomEventExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific custom event adapter. Returns null if - no custom event extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - int - - getGender - () -

-
-
- - - -
-
- - - - -

Returns the user's gender targeting information. Returns -1 if the gender was not - set. -

- -
-
- - - - -
-

- - public - - - - - Set<String> - - getKeywords - () -

-
-
- - - -
-
- - - - -

Returns targeting information keywords. Returns an empty Set if no - keywords were added. -

- -
-
- - - - -
-

- - public - - - - - Location - - getLocation - () -

-
-
- - - -
-
- - - - -

Returns the user's location targeting information. Returns null if the location was - not set. -

- -
-
- - - - -
-

- - public - - - - - T - - getNetworkExtras - (Class<T> networkExtrasClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Ad network adapters - provide a NetworkExtras class. Returns null if no network extras of the - provided type were set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getNetworkExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Returns null if no - network extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isTestDevice - (Context context) -

-
-
- - - -
-
- - - - -

Returns true if this device will receive test ads. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/AdSize.html b/docs/html/reference/com/google/android/gms/ads/AdSize.html deleted file mode 100644 index 539a2f639883..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/AdSize.html +++ /dev/null @@ -1,2330 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdSize | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AdSize

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.AdSize
- - - - - - - -
- - -

Class Overview

-

The size of a banner ad. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAUTO_HEIGHT - Constant that will cause the height of the ad to scale based on the height of the device in - the current orientation. - - - -
intFULL_WIDTH - Constant that will cause the width of the ad to match the width of the device in the current - orientation. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AdSizeBANNER - Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels). - - - -
- public - static - final - AdSizeFULL_BANNER - Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). - - - -
- public - static - final - AdSizeLARGE_BANNER - Large banner ad size (320x100 density-independent pixels). - - - -
- public - static - final - AdSizeLEADERBOARD - Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). - - - -
- public - static - final - AdSizeMEDIUM_RECTANGLE - Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent - pixels). - - - -
- public - static - final - AdSizeSMART_BANNER - A dynamically sized banner that is full-width and auto-height. - - - -
- public - static - final - AdSizeWIDE_SKYSCRAPER - IAB wide skyscraper ad size (160x600 density-independent pixels). - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdSize(int width, int height) - -
- Create a new AdSize. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- Compares this AdSize with the specified object and indicates if they are equal. - - - -
- -
- - - - - - int - - getHeight() - -
- Returns the height of this AdSize in density-independent pixels. - - - -
- -
- - - - - - int - - getHeightInPixels(Context context) - -
- Returns the height of this AdSize in physical pixels. - - - -
- -
- - - - - - int - - getWidth() - -
- Returns the width of this AdSize in density-independent pixels. - - - -
- -
- - - - - - int - - getWidthInPixels(Context context) - -
- Returns the width of this AdSize in physical pixels. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isAutoHeight() - -
- Returns whether this AdSize is auto-height. - - - -
- -
- - - - - - boolean - - isFullWidth() - -
- Returns whether this AdSize is full-width. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - AUTO_HEIGHT -

-
- - - - -
-
- - - - -

Constant that will cause the height of the ad to scale based on the height of the device in - the current orientation. An AUTO_HEIGHT ad determines its height during - initialization of the AdView and never changes after that. -

- - -
- Constant Value: - - - -2 - (0xfffffffe) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FULL_WIDTH -

-
- - - - -
-
- - - - -

Constant that will cause the width of the ad to match the width of the device in the current - orientation. A FULL_WIDTH ad determines its width during initialization of the - AdView and never changes after that. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AdSize - - BANNER -

-
- - - - -
-
- - - - -

Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - FULL_BANNER -

-
- - - - -
-
- - - - -

Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels). -

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - LARGE_BANNER -

-
- - - - -
-
- - - - -

Large banner ad size (320x100 density-independent pixels). -

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - LEADERBOARD -

-
- - - - -
-
- - - - -

Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels). -

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - MEDIUM_RECTANGLE -

-
- - - - -
-
- - - - -

Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent - pixels). -

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - SMART_BANNER -

-
- - - - -
-
- - - - -

A dynamically sized banner that is full-width and auto-height.

- - -
-
- - - - - -
-

- - public - static - final - AdSize - - WIDE_SKYSCRAPER -

-
- - - - -
-
- - - - -

IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not - supported by the Google Mobile Ads network; this is intended for mediation ad networks only. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdSize - (int width, int height) -

-
-
- - - -
-
- - - - -

Create a new AdSize.

-
-
Parameters
- - - - - - - -
width - The width of the ad in density-independent pixels.
height - The height of the ad in density-independent pixels.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the width or height is negative. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

Compares this AdSize with the specified object and indicates if they are equal. -

- -
-
- - - - -
-

- - public - - - - - int - - getHeight - () -

-
-
- - - -
-
- - - - -

Returns the height of this AdSize in density-independent pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - getHeightInPixels - (Context context) -

-
-
- - - -
-
- - - - -

Returns the height of this AdSize in physical pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - getWidth - () -

-
-
- - - -
-
- - - - -

Returns the width of this AdSize in density-independent pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - getWidthInPixels - (Context context) -

-
-
- - - -
-
- - - - -

Returns the width of this AdSize in physical pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isAutoHeight - () -

-
-
- - - -
-
- - - - -

Returns whether this AdSize is auto-height. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isFullWidth - () -

-
-
- - - -
-
- - - - -

Returns whether this AdSize is full-width. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/AdView.html b/docs/html/reference/com/google/android/gms/ads/AdView.html deleted file mode 100644 index e561b90bdf7b..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/AdView.html +++ /dev/null @@ -1,15904 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - XML Attrs - - - - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AdView

- - - - - - - - - - - - - extends ViewGroup
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳com.google.android.gms.ads.AdView
- - - - - - - -
- - -

Class Overview

-

The View to display banner ads. The ad size and ad unit ID must be set - prior to calling loadAd(AdRequest). -

- Publishers using DoubleClick for Publishers or Search Ads for Apps should use - PublisherAdView or - SearchAdView, respectively. -

- Sample code: - 

- public class MyActivity extends Activity {
-     private AdView mAdView;
-
-     @Override
-     public void onCreate(Bundle savedInstanceState) {
-         super.onCreate(savedInstanceState);
-
-         LinearLayout layout = new LinearLayout(this);
-         layout.setOrientation(LinearLayout.VERTICAL);
-
-         // Create a banner ad. The ad size and ad unit ID must be set before calling loadAd.
-         mAdView = new AdView(this);
-         mAdView.setAdSize(AdSize.SMART_BANNER);
-         mAdView.setAdUnitId("myAdUnitId");
-
-         // Create an ad request.
-         AdRequest.Builder adRequestBuilder = new AdRequest.Builder();
-
-         // Optionally populate the ad request builder.
-         adRequestBuilder.addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
-
-         // Add the AdView to the view hierarchy.
-         layout.addView(mAdView);
-
-         // Start loading the ad.
-         mAdView.loadAd(adRequestBuilder.build());
-
-         setContentView(layout);
-     }
-
-     @Override
-     public void onResume() {
-         super.onResume();
-
-         // Resume the AdView.
-         mAdView.resume();
-     }
-
-     @Override
-     public void onPause() {
-         // Pause the AdView.
-         mAdView.pause();
-
-         super.onPause();
-     }
-
-     @Override
-     public void onDestroy() {
-         // Destroy the AdView.
-         mAdView.destroy();
-
-         super.onDestroy();
-     }
- }

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
XML Attributes
Attribute NameRelated MethodDescription
com.google.android.gms:adSize - setAdSize(AdSize) - - -   - - - -
com.google.android.gms:adUnitId - setAdUnitId(String) - - -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdView(Context context) - -
- Construct an AdView from code. - - - -
- -
- - - - - - - - AdView(Context context, AttributeSet attrs) - -
- Construct an AdView from an XML layout. - - - -
- -
- - - - - - - - AdView(Context context, AttributeSet attrs, int defStyle) - -
- Construct an AdView from an XML layout. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - destroy() - -
- Destroy the AdView. - - - -
- -
- - - - - - AdListener - - getAdListener() - -
- Returns the AdListener for this AdView. - - - -
- -
- - - - - - AdSize - - getAdSize() - -
- Returns the size of the banner ad. - - - -
- -
- - - - - - String - - getAdUnitId() - -
- Returns the ad unit ID. - - - -
- -
- - - - - - InAppPurchaseListener - - getInAppPurchaseListener() - -
- Returns the InAppPurchaseListener for this AdView. - - - -
- -
- - - - - - String - - getMediationAdapterClassName() - -
- Returns the mediation adapter class name. - - - -
- -
- - - - - - void - - loadAd(AdRequest adRequest) - -
- Starts loading the ad on a background thread. - - - -
- -
- - - - - - void - - pause() - -
- Pauses any extra processing associated with this AdView. - - - -
- -
- - - - - - void - - resume() - -
- Resumes an AdView after a previous call to pause(). - - - -
- -
- - - - - - void - - setAdListener(AdListener adListener) - -
- Sets an AdListener for this AdView. - - - -
- -
- - - - - - void - - setAdSize(AdSize adSize) - -
- Sets the size of the banner ad. - - - -
- -
- - - - - - void - - setAdUnitId(String adUnitId) - -
- Sets the ad unit ID. - - - -
- -
- - - - - - void - - setInAppPurchaseListener(InAppPurchaseListener inAppPurchaseListener) - -
- Sets an InAppPurchaseListener for this AdView. - - - -
- -
- - - - - - void - - setPlayStorePurchaseParams(PlayStorePurchaseListener playStorePurchaseListener, String publicKey) - -
- Set a PlayStorePurchaseListener and app's public key for this AdView. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - void - - onLayout(boolean changed, int left, int top, int right, int bottom) - -
- - - - - - void - - onMeasure(int widthMeasureSpec, int heightMeasureSpec) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - -

XML Attributes

- - - - -
-

com.google.android.gms:adSize -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - -
-

com.google.android.gms:adUnitId -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdView - (Context context) -

-
-
- - - -
-
- - - - -

Construct an AdView from code.

-
-
Parameters
- - - - -
context - The Context the AdView is running in. -
-
- -
-
- - - - -
-

- - public - - - - - - - AdView - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Construct an AdView from an XML layout. -

- -
-
- - - - -
-

- - public - - - - - - - AdView - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

Construct an AdView from an XML layout. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - destroy - () -

-
-
- - - -
-
- - - - -

Destroy the AdView. This method should be called in the parent Activity's - onDestroy() method. No other methods should be called on the - AdView after destroy() is called. -

- -
-
- - - - -
-

- - public - - - - - AdListener - - getAdListener - () -

-
-
- - - -
-
- - - - -

Returns the AdListener for this AdView. -

- -
-
- - - - -
-

- - public - - - - - AdSize - - getAdSize - () -

-
-
- - - -
-
- - - - -

Returns the size of the banner ad. Returns null if setAdSize(AdSize) hasn't been - called yet.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - String - - getAdUnitId - () -

-
-
- - - -
-
- - - - -

Returns the ad unit ID.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - InAppPurchaseListener - - getInAppPurchaseListener - () -

-
-
- - - -
-
- - - - -

Returns the InAppPurchaseListener for this AdView. Returns - null if it is not set. -

- -
-
- - - - -
-

- - public - - - - - String - - getMediationAdapterClassName - () -

-
-
- - - -
-
- - - - -

Returns the mediation adapter class name. In the case of a mediated ad response, this is the - name of the class that was responsible for performing the ad request and rendering the ad. - For non-mediated responses, this value will be null. -

- -
-
- - - - -
-

- - public - - - - - void - - loadAd - (AdRequest adRequest) -

-
-
- - - -
-
- - - - -

Starts loading the ad on a background thread.

-
-
Throws
- - - - -
IllegalStateException - If the size of the banner ad or the ad unit ID have not been - set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - pause - () -

-
-
- - - -
-
- - - - -

Pauses any extra processing associated with this AdView. This method should be called - in the parent Activity's onPause() method. -

- -
-
- - - - -
-

- - public - - - - - void - - resume - () -

-
-
- - - -
-
- - - - -

Resumes an AdView after a previous call to pause(). This method should be - called in the parent Activity's onResume() method. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdListener - (AdListener adListener) -

-
-
- - - -
-
- - - - -

Sets an AdListener for this AdView. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdSize - (AdSize adSize) -

-
-
- - - -
-
- - - - -

Sets the size of the banner ad.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalStateException - If the size of the banner ad was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAdUnitId - (String adUnitId) -

-
-
- - - -
-
- - - - -

Sets the ad unit ID.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalStateException - If the ad unit ID was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setInAppPurchaseListener - (InAppPurchaseListener inAppPurchaseListener) -

-
-
- - - -
-
- - - - -

Sets an InAppPurchaseListener for this AdView. null is acceptable but - InAppPurchaseListener is not set in this case.

-
-
Throws
- - - - -
IllegalStateException - If - setPlayStorePurchaseParams(PlayStorePurchaseListener, String) was already called. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPlayStorePurchaseParams - (PlayStorePurchaseListener playStorePurchaseListener, String publicKey) -

-
-
- - - -
-
- - - - -

Set a PlayStorePurchaseListener and app's public key for this AdView. - null for parameter palyStorePurchaseListener is acceptable but - PlayStorePurchaseListener is not set in this case. - null for parameter publicKey is acceptable but SDK will work in developer mode and - skip verifying purchase data signature with public key.

-
-
Throws
- - - - -
IllegalStateException - If setInAppPurchaseListener(InAppPurchaseListener) was - already called. -
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - void - - onLayout - (boolean changed, int left, int top, int right, int bottom) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - protected - - - - - void - - onMeasure - (int widthMeasureSpec, int heightMeasureSpec) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/InterstitialAd.html b/docs/html/reference/com/google/android/gms/ads/InterstitialAd.html deleted file mode 100644 index dfc3d140cf71..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/InterstitialAd.html +++ /dev/null @@ -1,2082 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InterstitialAd | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InterstitialAd

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.InterstitialAd
- - - - - - - -
- - -

Class Overview

-

Full-screen interstitial ads. The ad unit ID must be set prior to calling loadAd(AdRequest). -

- Publishers using DoubleClick for Publishers should use - PublisherInterstitialAd. -

- Sample code: - 

- public class MyActivity extends Activity {
-     private InterstitialAd mInterstitialAd;
-     private Button mNextLevelButton;
-     private TextView mTextView;
-
-     @Override
-     public void onCreate(Bundle savedInstanceState) {
-         super.onCreate(savedInstanceState);
-
-         // Create an interstitial ad. When a natural transition in the app occurs (such as a
-         // level ending in a game), show the interstitial. In this simple example, the press of a
-         // button is used instead.
-         //
-         // If the button is clicked before the interstitial is loaded, the user should proceed to
-         // the next part of the app (in this case, the next level).
-         //
-         // If the interstitial is finished loading, the user will view the interstitial before
-         // proceeding.
-         mInterstitialAd = new InterstitialAd(this);
-         mInterstitialAd.setAdUnitId("myAdUnitId");
-
-         // Create an ad request.
-         AdRequest.Builder adRequestBuilder = new AdRequest.Builder();
-
-         // Optionally populate the ad request builder.
-         adRequestBuilder.addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
-
-         // Set an AdListener.
-         mInterstitialAd.setAdListener(new AdListener() {
-             @Override
-             public void onAdLoaded() {
-                 Toast.makeText(MyActivity.this,
-                         "The interstitial is loaded", Toast.LENGTH_SHORT).show();
-             }
-
-             @Override
-             public void onAdClosed() {
-                 // Proceed to the next level.
-                 goToNextLevel();
-             }
-         });
-
-         // Start loading the ad now so that it is ready by the time the user is ready to go to
-         // the next level.
-         mInterstitialAd.loadAd(adRequestBuilder.build());
-
-         // Create the button to go to the next level.
-         mNextLevelButton = new Button(this);
-         mNextLevelButton.setText("Next Level");
-         mNextLevelButton.setOnClickListener(new View.OnClickListener() {
-             @Override
-             public void onClick(View view) {
-                 // Show the interstitial if it is ready. Otherwise, proceed to the next level
-                 // without ever showing it.
-                 if (mInterstitialAd.isLoaded()) {
-                     mInterstitialAd.show();
-                 } else {
-                     // Proceed to the next level.
-                     goToNextLevel();
-                 }
-             }
-         });
-
-         // Add the next level button to the layout.
-         LinearLayout layout = new LinearLayout(this);
-         layout.setOrientation(LinearLayout.VERTICAL);
-         layout.addView(mNextLevelButton);
-
-         // Create a TextView to display the current level.
-         mTextView = new TextView(this);
-         mTextView.setText("Level 1");
-         layout.addView(mTextView);
-
-         setContentView(layout);
-     }
-
-     public void goToNextLevel() {
-         // Show the next level (and disable the next level button since there are no more levels.
-         mNextLevelButton.setEnabled(false);
-         mTextView.setText("Level 2");
-     }
- }
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - InterstitialAd(Context context) - -
- Construct an InterstitialAd. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - AdListener - - getAdListener() - -
- Returns the AdListener for this InterstitialAd. - - - -
- -
- - - - - - String - - getAdUnitId() - -
- Returns the ad unit ID. - - - -
- -
- - - - - - InAppPurchaseListener - - getInAppPurchaseListener() - -
- Returns the InAppPurchaseListener for this InterstitialAd. - - - -
- -
- - - - - - String - - getMediationAdapterClassName() - -
- Returns the mediation adapter class name. - - - -
- -
- - - - - - boolean - - isLoaded() - -
- Returns true if the ad was successfully loaded and is ready to be shown. - - - -
- -
- - - - - - void - - loadAd(AdRequest adRequest) - -
- Start loading the ad on a background thread. - - - -
- -
- - - - - - void - - setAdListener(AdListener adListener) - -
- Sets an AdListener for this InterstitialAd. - - - -
- -
- - - - - - void - - setAdUnitId(String adUnitId) - -
- Sets the ad unit ID. - - - -
- -
- - - - - - void - - setInAppPurchaseListener(InAppPurchaseListener inAppPurchaseListener) - -
- Set a InAppPurchaseListener for this InterstitialAd. - - - -
- -
- - - - - - void - - setPlayStorePurchaseParams(PlayStorePurchaseListener playStorePurchaseListener, String publicKey) - -
- Set an PlayStorePurchaseListener and app's public key for this - InterstitialAd. - - - -
- -
- - - - - - void - - show() - -
- Show the interstitial ad. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - InterstitialAd - (Context context) -

-
-
- - - -
-
- - - - -

Construct an InterstitialAd. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - AdListener - - getAdListener - () -

-
-
- - - -
-
- - - - -

Returns the AdListener for this InterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - String - - getAdUnitId - () -

-
-
- - - -
-
- - - - -

Returns the ad unit ID. -

- -
-
- - - - -
-

- - public - - - - - InAppPurchaseListener - - getInAppPurchaseListener - () -

-
-
- - - -
-
- - - - -

Returns the InAppPurchaseListener for this InterstitialAd. Returns - null if it is not set. -

- -
-
- - - - -
-

- - public - - - - - String - - getMediationAdapterClassName - () -

-
-
- - - -
-
- - - - -

Returns the mediation adapter class name. In the case of a mediated ad response, this is the - name of the class that was responsible for performing the ad request and rendering the ad. - For non-mediated responses, this value will be null. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isLoaded - () -

-
-
- - - -
-
- - - - -

Returns true if the ad was successfully loaded and is ready to be shown. -

- -
-
- - - - -
-

- - public - - - - - void - - loadAd - (AdRequest adRequest) -

-
-
- - - -
-
- - - - -

Start loading the ad on a background thread.

-
-
Throws
- - - - -
IllegalStateException - If the the ad unit ID has not been set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAdListener - (AdListener adListener) -

-
-
- - - -
-
- - - - -

Sets an AdListener for this InterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdUnitId - (String adUnitId) -

-
-
- - - -
-
- - - - -

Sets the ad unit ID.

-
-
Throws
- - - - -
IllegalStateException - If the ad unit ID was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setInAppPurchaseListener - (InAppPurchaseListener inAppPurchaseListener) -

-
-
- - - -
-
- - - - -

Set a InAppPurchaseListener for this InterstitialAd. null is - acceptable but InAppPurchaseListener is not set in this case.

-
-
Throws
- - - - -
IllegalStateException - If - setPlayStorePurchaseParams(PlayStorePurchaseListener, String) was already called. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPlayStorePurchaseParams - (PlayStorePurchaseListener playStorePurchaseListener, String publicKey) -

-
-
- - - -
-
- - - - -

Set an PlayStorePurchaseListener and app's public key for this - InterstitialAd. null for parameter palyStorePurchaseListener is acceptable - but PlayStorePurchaseListener is not set in this case. - null for parameter publicKey is acceptable but SDK will work in developer mode and - skip verifying purchase data signature with public key.

-
-
Throws
- - - - -
IllegalStateException - If setInAppPurchaseListener(InAppPurchaseListener) was - already called. -
-
- -
-
- - - - -
-

- - public - - - - - void - - show - () -

-
-
- - - -
-
- - - - -

Show the interstitial ad. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/AppEventListener.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/AppEventListener.html deleted file mode 100644 index 8e324ca29e44..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/AppEventListener.html +++ /dev/null @@ -1,1075 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppEventListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

AppEventListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.doubleclick.AppEventListener
- - - - - - - -
- - -

Class Overview

-

A listener interface for app events triggered by ads. App events allow JavaScript within an ad to - trigger events in the application. The ad can trigger the app event with a name and optional - data. It is then up to the application to decide how to handle the event. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAppEvent(String name, String data) - -
- Called when an app event occurs. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAppEvent - (String name, String data) -

-
-
- - - -
-
- - - - -

Called when an app event occurs.

-
-
Parameters
- - - - - - - -
name - The name of the app event.
data - Extra data included with the app event. The data can be null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/CustomRenderedAd.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/CustomRenderedAd.html deleted file mode 100644 index 9888f0768fa2..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/CustomRenderedAd.html +++ /dev/null @@ -1,1295 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomRenderedAd | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomRenderedAd

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.doubleclick.CustomRenderedAd
- - - - - - - -
- - -

Class Overview

-

Interface that contains information about custom rendered ads. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getBaseUrl() - -
- Returns the base URL as a String value. - - - -
- -
- abstract - - - - - String - - getContent() - -
- Returns the ad content string. - - - -
- -
- abstract - - - - - void - - onAdRendered(View view) - -
- Notifies the SDK that ad has finished rendering. - - - -
- -
- abstract - - - - - void - - recordClick() - -
- Records the click of the ad. - - - -
- -
- abstract - - - - - void - - recordImpression() - -
- Records the impression of the ad. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getBaseUrl - () -

-
-
- - - -
-
- - - - -

Returns the base URL as a String value. The base URL can be used to get an absolute path when - the ad content assets use relative links. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getContent - () -

-
-
- - - -
-
- - - - -

Returns the ad content string. This can be an HTML or JSON string, or any server template - which contains assets for the ad. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdRendered - (View view) -

-
-
- - - -
-
- - - - -

Notifies the SDK that ad has finished rendering.

-
-
Parameters
- - - - -
view - The rendered view of the ad. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - recordClick - () -

-
-
- - - -
-
- - - - -

Records the click of the ad. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - recordImpression - () -

-
-
- - - -
-
- - - - -

Records the impression of the ad. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/OnCustomRenderedAdLoadedListener.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/OnCustomRenderedAdLoadedListener.html deleted file mode 100644 index 96030c023f3b..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/OnCustomRenderedAdLoadedListener.html +++ /dev/null @@ -1,1071 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnCustomRenderedAdLoadedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnCustomRenderedAdLoadedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.doubleclick.OnCustomRenderedAdLoadedListener
- - - - - - - -
- - -

Class Overview

-

A listener for when a custom rendered ad has loaded. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onCustomRenderedAdLoaded(CustomRenderedAd ad) - -
- Called when a CustomRenderedAd has loaded. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onCustomRenderedAdLoaded - (CustomRenderedAd ad) -

-
-
- - - -
-
- - - - -

Called when a CustomRenderedAd has loaded. Publishers should render the ad, and call - onAdRendered(View) when the rendering is complete. -

-
-
Parameters
- - - - -
ad - The CustomRenderedAd which contains information about this ad. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.Builder.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.Builder.html deleted file mode 100644 index 9145b46383a0..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.Builder.html +++ /dev/null @@ -1,2368 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PublisherAdRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

PublisherAdRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.doubleclick.PublisherAdRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builds a PublisherAdRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PublisherAdRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PublisherAdRequest.Builder - - addCategoryExclusion(String categoryExclusion) - -
- Sets a slot-level ad category exclusion label. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) - -
- Add extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addCustomTargeting(String key, String value) - -
- Adds a custom targeting parameter. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addCustomTargeting(String key, List<String> values) - -
- Adds a custom targeting parameter. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addKeyword(String keyword) - -
- Add a keyword for targeting purposes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addNetworkExtras(NetworkExtras networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addNetworkExtrasBundle(Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - addTestDevice(String deviceId) - -
- Causes a device to receive test ads. - - - -
- -
- - - - - - PublisherAdRequest - - build() - -
- Constructs PublisherAdRequest with the specified attributes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setBirthday(Date birthday) - -
- Sets the user's birthday for targeting purposes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setContentUrl(String contentUrl) - -
- Sets the content URL for targeting purposes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setGender(int gender) - -
- Sets the user's gender for targeting purposes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setLocation(Location location) - -
- Sets the user's location for targeting purposes. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setManualImpressionsEnabled(boolean manualImpressionsEnabled) - -
- Enables manual impression reporting. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setPublisherProvidedId(String publisherProvidedId) - -
- Sets an identifier for use in frequency capping, audience segmentation and targeting, - sequential ad rotation, and other audience-based ad delivery controls across devices. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - setRequestAgent(String requestAgent) - -
- Sets the request agent string to identify the ad request's origin. - - - -
- -
- - - - - - PublisherAdRequest.Builder - - tagForChildDirectedTreatment(boolean tagForChildDirectedTreatment) - -
- This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PublisherAdRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addCategoryExclusion - (String categoryExclusion) -

-
-
- - - -
-
- - - - -

Sets a slot-level ad category exclusion label. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addCustomEventExtrasBundle - (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific custom event adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the custom event adapter for which you are - providing extras.
customEventExtras - A Bundle of extra information to pass to a custom event - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addCustomTargeting - (String key, String value) -

-
-
- - - -
-
- - - - -

Adds a custom targeting parameter. Calling this multiple times for the - same key will overwrite old values. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addCustomTargeting - (String key, List<String> values) -

-
-
- - - -
-
- - - - -

Adds a custom targeting parameter. Calling this multiple times for the - same key will overwrite old values. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addKeyword - (String keyword) -

-
-
- - - -
-
- - - - -

Add a keyword for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addNetworkExtras - (NetworkExtras networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter. networkExtras - should be an instance of com.google.ads.mediation.NetworkExtras, which is - provided by ad network adapters. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addNetworkExtrasBundle - (Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the adapter for the network for which you are - providing extras.
networkExtras - A Bundle of extra information to pass to a mediation - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - addTestDevice - (String deviceId) -

-
-
- - - -
-
- - - - -

Causes a device to receive test ads. The deviceId can be obtained by viewing the - logcat output after creating a new ad. For emulators, use - DEVICE_ID_EMULATOR. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest - - build - () -

-
-
- - - -
-
- - - - -

Constructs PublisherAdRequest with the specified attributes. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setBirthday - (Date birthday) -

-
-
- - - -
-
- - - - -

Sets the user's birthday for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setContentUrl - (String contentUrl) -

-
-
- - - -
-
- - - - -

Sets the content URL for targeting purposes.

-
-
Throws
- - - - - - - -
NullPointerException - If contentUrl is {code null}.
IllegalArgumentException - If contentUrl is empty, or if its - length exceeds 512. -
-
- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setGender - (int gender) -

-
-
- - - -
-
- - - - -

Sets the user's gender for targeting purposes. This should be - GENDER_MALE, GENDER_FEMALE, or GENDER_UNKNOWN. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setLocation - (Location location) -

-
-
- - - -
-
- - - - -

Sets the user's location for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setManualImpressionsEnabled - (boolean manualImpressionsEnabled) -

-
-
- - - -
-
- - - - -

Enables manual impression reporting. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setPublisherProvidedId - (String publisherProvidedId) -

-
-
- - - -
-
- - - - -

Sets an identifier for use in frequency capping, audience segmentation and targeting, - sequential ad rotation, and other audience-based ad delivery controls across devices. -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - setRequestAgent - (String requestAgent) -

-
-
- - - -
-
- - - - -

Sets the request agent string to identify the ad request's origin. Third party libraries - that reference the Mobile Ads SDK should call this method to denote the platform from - which the ad request originated. For example, if a third party ad network called - "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method - with "CoolAds". -

- -
-
- - - - -
-

- - public - - - - - PublisherAdRequest.Builder - - tagForChildDirectedTreatment - (boolean tagForChildDirectedTreatment) -

-
-
- - - -
-
- - - - -

This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. -

- If you set this method to true, you will indicate that your app should be treated - as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA). -

- If you set this method to false, you will indicate that your app should not be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). -

- If you do not set this method, ad requests will include no indication of how you would - like your app treated with respect to COPPA. -

- By setting this method, you certify that this notification is accurate and you are - authorized to act on behalf of the owner of the app. You understand that abuse of this - setting may result in termination of your Google account. -

- Note: it may take some time for this designation to be fully implemented in applicable - Google services. -

- This designation will only apply to ad requests for which you have set this method.

-
-
Parameters
- - - - -
tagForChildDirectedTreatment - Set to true to indicate that your app should - be treated as child-directed. Set to false to indicate that your app - should not be treated as child-directed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.html deleted file mode 100644 index b1a50eda2624..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.html +++ /dev/null @@ -1,2492 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PublisherAdRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PublisherAdRequest

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.doubleclick.PublisherAdRequest
- - - - - - - -
- - -

Class Overview

-

A PublisherAdRequest contains targeting information used to fetch an ad from DoubleClick - for Publishers. Ad requests are created using PublisherAdRequest.Builder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPublisherAdRequest.Builder - Builds a PublisherAdRequest.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intERROR_CODE_INTERNAL_ERROR - Something happened internally; for instance, an invalid response was received from the ad - server. - - - -
intERROR_CODE_INVALID_REQUEST - The ad request was invalid; for instance, the ad unit ID was incorrect. - - - -
intERROR_CODE_NETWORK_ERROR - The ad request was unsuccessful due to network connectivity. - - - -
intERROR_CODE_NO_FILL - The ad request was successful, but no ad was returned due to lack of ad inventory. - - - -
intGENDER_FEMALE - Female gender. - - - -
intGENDER_MALE - Male gender. - - - -
intGENDER_UNKNOWN - Unknown gender. - - - -
- - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - StringDEVICE_ID_EMULATOR - The deviceId for emulators to be used with - addTestDevice(String). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Date - - getBirthday() - -
- Returns the user's birthday targeting information. - - - -
- -
- - - - - - String - - getContentUrl() - -
- Returns the content url targeting information. - - - -
- -
- - - - - <T extends CustomEvent> - Bundle - - getCustomEventExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - Bundle - - getCustomTargeting() - -
- Returns the custom targeting parameters. - - - -
- -
- - - - - - int - - getGender() - -
- Returns the user's gender targeting information. - - - -
- -
- - - - - - Set<String> - - getKeywords() - -
- Returns targeting information keywords. - - - -
- -
- - - - - - Location - - getLocation() - -
- Returns the user's location targeting information. - - - -
- -
- - - - - - boolean - - getManualImpressionsEnabled() - -
- Returns true if manual impression reporting is enabled. - - - -
- -
- - - - - <T extends NetworkExtras> - T - - getNetworkExtras(Class<T> networkExtrasClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - <T extends MediationAdapter> - Bundle - - getNetworkExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - String - - getPublisherProvidedId() - -
- Returns the identifier used for frequency capping, audience segmentation and targeting, - sequential ad rotation, and other audience-based ad delivery controls across devices. - - - -
- -
- - - - - - boolean - - isTestDevice(Context context) - -
- Returns true if this device will receive test ads. - - - -
- -
- - - - static - - void - - updateCorrelator() - -
- Changes the correlator that is sent with ad requests, effectively starting a new page view. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ERROR_CODE_INTERNAL_ERROR -

-
- - - - -
-
- - - - -

Something happened internally; for instance, an invalid response was received from the ad - server. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INVALID_REQUEST -

-
- - - - -
-
- - - - -

The ad request was invalid; for instance, the ad unit ID was incorrect. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NETWORK_ERROR -

-
- - - - -
-
- - - - -

The ad request was unsuccessful due to network connectivity. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NO_FILL -

-
- - - - -
-
- - - - -

The ad request was successful, but no ad was returned due to lack of ad inventory. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_FEMALE -

-
- - - - -
-
- - - - -

Female gender.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_MALE -

-
- - - - -
-
- - - - -

Male gender.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GENDER_UNKNOWN -

-
- - - - -
-
- - - - -

Unknown gender.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - String - - DEVICE_ID_EMULATOR -

-
- - - - -
-
- - - - -

The deviceId for emulators to be used with - addTestDevice(String). -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Date - - getBirthday - () -

-
-
- - - -
-
- - - - -

Returns the user's birthday targeting information. Returns null if the birthday was - not set. -

- -
-
- - - - -
-

- - public - - - - - String - - getContentUrl - () -

-
-
- - - -
-
- - - - -

Returns the content url targeting information. Returns null if the contentUrl was - not set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getCustomEventExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific custom event adapter. Returns null if - no custom event extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getCustomTargeting - () -

-
-
- - - -
-
- - - - -

Returns the custom targeting parameters. -

- -
-
- - - - -
-

- - public - - - - - int - - getGender - () -

-
-
- - - -
-
- - - - -

Returns the user's gender targeting information. Returns -1 if the gender was not - set. -

- -
-
- - - - -
-

- - public - - - - - Set<String> - - getKeywords - () -

-
-
- - - -
-
- - - - -

Returns targeting information keywords. Returns an empty Set if no - keywords were added. -

- -
-
- - - - -
-

- - public - - - - - Location - - getLocation - () -

-
-
- - - -
-
- - - - -

Returns the user's location targeting information. Returns null if the location was - not set. -

- -
-
- - - - -
-

- - public - - - - - boolean - - getManualImpressionsEnabled - () -

-
-
- - - -
-
- - - - -

Returns true if manual impression reporting is enabled. -

- -
-
- - - - -
-

- - public - - - - - T - - getNetworkExtras - (Class<T> networkExtrasClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Ad network adapters - provide a NetworkExtras class. Returns null if no network extras of the - provided type were set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getNetworkExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Returns null if no - network extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - String - - getPublisherProvidedId - () -

-
-
- - - -
-
- - - - -

Returns the identifier used for frequency capping, audience segmentation and targeting, - sequential ad rotation, and other audience-based ad delivery controls across devices. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isTestDevice - (Context context) -

-
-
- - - -
-
- - - - -

Returns true if this device will receive test ads. -

- -
-
- - - - -
-

- - public - static - - - - void - - updateCorrelator - () -

-
-
- - - -
-
- - - - -

Changes the correlator that is sent with ad requests, effectively starting a new page view. - The correlator is the same for all the ad requests coming from one page view, and unique - across page views. After updating the correlator, ads must be refreshed for the new - correlator to take effect. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdView.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdView.html deleted file mode 100644 index 39df2f63dfcc..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherAdView.html +++ /dev/null @@ -1,16057 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PublisherAdView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - XML Attrs - - - - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PublisherAdView

- - - - - - - - - - - - - extends ViewGroup
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳com.google.android.gms.ads.doubleclick.PublisherAdView
- - - - - - - -
- - -

Class Overview

-

The View to display banner ads for use with DoubleClick for Publishers. The - ad size and ad unit ID must be set prior to calling loadAd(PublisherAdRequest). -

- Sample code: - 

- public class MyActivity extends Activity {
-     private PublisherAdView mPublisherAdView;
-
-     @Override
-     public void onCreate(Bundle savedInstanceState) {
-         super.onCreate(savedInstanceState);
-
-         LinearLayout layout = new LinearLayout(this);
-         layout.setOrientation(LinearLayout.VERTICAL);
-
-         // Create a banner ad. The ad size and ad unit ID must be set before calling loadAd.
-         mPublisherAdView = new PublisherAdView(this);
-         mPublisherAdView.setAdSize(AdSize.SMART_BANNER);
-         mPublisherAdView.setAdUnitId("myAdUnitId");
-
-         // Create an ad request.
-         PublisherAdRequest.Builder publisherAdRequestBuilder = new PublisherAdRequest.Builder();
-
-         // Optionally populate the ad request builder.
-         publisherAdRequestBuilder.addTestDevice(PublisherAdRequest.DEVICE_ID_EMULATOR);
-
-         // Add the PublisherAdView to the view hierarchy.
-         layout.addView(mPublisherAdView);
-
-         // Start loading the ad.
-         mPublisherAdView.loadAd(PublisherAdRequestBuilder.build());
-
-         setContentView(layout);
-     }
-
-     @Override
-     public void onResume() {
-         super.onResume();
-
-         // Resume the PublisherAdView.
-         mPublisherAdView.resume();
-     }
-
-     @Override
-     public void onPause() {
-         // Pause the PublisherAdView.
-         mPublisherAdView.pause();
-
-         super.onPause();
-     }
-
-     @Override
-     public void onDestroy() {
-         // Destroy the PublisherAdView.
-         mPublisherAdView.destroy();
-
-         super.onDestroy();
-     }
- }

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
XML Attributes
Attribute NameRelated MethodDescription
com.google.android.gms:adSizes - setAdSizes(AdSize) - - -   - - - -
com.google.android.gms:adUnitId - setAdUnitId(String) - - -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PublisherAdView(Context context) - -
- Construct an PublisherAdView from code. - - - -
- -
- - - - - - - - PublisherAdView(Context context, AttributeSet attrs) - -
- Construct a PublisherAdView from an XML layout. - - - -
- -
- - - - - - - - PublisherAdView(Context context, AttributeSet attrs, int defStyle) - -
- Construct an PublisherAdView from an XML layout. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - destroy() - -
- Destroy the PublisherAdView. - - - -
- -
- - - - - - AdListener - - getAdListener() - -
- Returns the AdListener for this PublisherAdView. - - - -
- -
- - - - - - AdSize - - getAdSize() - -
- Returns the size of the currently displayed banner ad. - - - -
- -
- - - - - - AdSize[] - - getAdSizes() - -
- Returns the ad sizes supported by this PublisherAdView. - - - -
- -
- - - - - - String - - getAdUnitId() - -
- Returns the ad unit ID. - - - -
- -
- - - - - - AppEventListener - - getAppEventListener() - -
- Returns the AppEventListener for this PublisherAdView. - - - -
- -
- - - - - - String - - getMediationAdapterClassName() - -
- Returns the mediation adapter class name. - - - -
- -
- - - - - - OnCustomRenderedAdLoadedListener - - getOnCustomRenderedAdLoadedListener() - -
- Returns the OnCustomRenderedAdLoadedListener for this PublisherAdView. - - - -
- -
- - - - - - void - - loadAd(PublisherAdRequest publisherAdRequest) - -
- Start loading the ad on a background thread. - - - -
- -
- - - - - - void - - pause() - -
- Pause any extra processing associated with this PublisherAdView. - - - -
- -
- - - - - - void - - recordManualImpression() - -
- Record a manual impression. - - - -
- -
- - - - - - void - - resume() - -
- Resume a PublisherAdView after a previous call to pause(). - - - -
- -
- - - - - - void - - setAdListener(AdListener adListener) - -
- Sets an AdListener for this PublisherAdView. - - - -
- -
- - - - - - void - - setAdSizes(AdSize... adSizes) - -
- Sets the supported sizes of the banner ad. - - - -
- -
- - - - - - void - - setAdUnitId(String adUnitId) - -
- Sets the ad unit ID. - - - -
- -
- - - - - - void - - setAppEventListener(AppEventListener appEventListener) - -
- Sets an AppEventListener for this PublisherAdView. - - - -
- -
- - - - - - void - - setOnCustomRenderedAdLoadedListener(OnCustomRenderedAdLoadedListener onCustomRenderedAdLoadedListener) - -
- Sets an OnCustomRenderedAdLoadedListener for this PublisherAdView. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - void - - onLayout(boolean changed, int left, int top, int right, int bottom) - -
- - - - - - void - - onMeasure(int widthMeasureSpec, int heightMeasureSpec) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - -

XML Attributes

- - - - -
-

com.google.android.gms:adSizes -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - -
-

com.google.android.gms:adUnitId -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PublisherAdView - (Context context) -

-
-
- - - -
-
- - - - -

Construct an PublisherAdView from code.

-
-
Parameters
- - - - -
context - The Context the PublisherAdView is running in. -
-
- -
-
- - - - -
-

- - public - - - - - - - PublisherAdView - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Construct a PublisherAdView from an XML layout. -

- -
-
- - - - -
-

- - public - - - - - - - PublisherAdView - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

Construct an PublisherAdView from an XML layout. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - destroy - () -

-
-
- - - -
-
- - - - -

Destroy the PublisherAdView. This method should be called in the parent Activity's - onDestroy() method. No other methods should be called on the - PublisherAdView after destroy() is called. -

- -
-
- - - - -
-

- - public - - - - - AdListener - - getAdListener - () -

-
-
- - - -
-
- - - - -

Returns the AdListener for this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - AdSize - - getAdSize - () -

-
-
- - - -
-
- - - - -

Returns the size of the currently displayed banner ad. Returns null if - setAdSizes(AdSize...) hasn't been called yet. See getAdSizes() for the ad sizes - supported by this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - AdSize[] - - getAdSizes - () -

-
-
- - - -
-
- - - - -

Returns the ad sizes supported by this PublisherAdView. See getAdSize() for - the size of the currently displayed banner ad.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - String - - getAdUnitId - () -

-
-
- - - -
-
- - - - -

Returns the ad unit ID.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - AppEventListener - - getAppEventListener - () -

-
-
- - - -
-
- - - - -

Returns the AppEventListener for this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - String - - getMediationAdapterClassName - () -

-
-
- - - -
-
- - - - -

Returns the mediation adapter class name. In the case of a mediated ad response, this is the - name of the class that was responsible for performing the ad request and rendering the ad. - For non-mediated responses, this value will be null. -

- -
-
- - - - -
-

- - public - - - - - OnCustomRenderedAdLoadedListener - - getOnCustomRenderedAdLoadedListener - () -

-
-
- - - -
-
- - - - -

Returns the OnCustomRenderedAdLoadedListener for this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - void - - loadAd - (PublisherAdRequest publisherAdRequest) -

-
-
- - - -
-
- - - - -

Start loading the ad on a background thread.

-
-
Throws
- - - - -
IllegalStateException - If the size of the banner ad or the ad unit ID have not been - set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - pause - () -

-
-
- - - -
-
- - - - -

Pause any extra processing associated with this PublisherAdView. This method should - be called in the parent Activity's onPause() method. -

- -
-
- - - - -
-

- - public - - - - - void - - recordManualImpression - () -

-
-
- - - -
-
- - - - -

Record a manual impression. setManualImpressionsEnabled(boolean) - must be enabled for this method to have any effect. -

- -
-
- - - - -
-

- - public - - - - - void - - resume - () -

-
-
- - - -
-
- - - - -

Resume a PublisherAdView after a previous call to pause(). This method should - be called in the parent Activity's onResume() method. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdListener - (AdListener adListener) -

-
-
- - - -
-
- - - - -

Sets an AdListener for this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdSizes - (AdSize... adSizes) -

-
-
- - - -
-
- - - - -

Sets the supported sizes of the banner ad. In most cases, only one ad size will be specified. -

- Multiple ad sizes can be specified if your application can appropriately handle multiple - ad sizes. For example, your application might call getAdSize() during the - onAdLoaded() callback and change the layout according to the size of the ad - that was loaded. If multiple ad sizes are specified, the PublisherAdView will - assume the size of the first ad size until an ad is loaded. -

- This method also immediately resizes the currently displayed ad, so calling this method after an - ad has been loaded is not recommended unless you know for certain that the content of the - ad will render correctly in the new ad size. This can be used if an ad needs to be resized - after it has been loaded. If more than one ad size is specified, the currently displayed ad - will be resized to the first ad size.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalArgumentException - If adSizes is null or empty. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAdUnitId - (String adUnitId) -

-
-
- - - -
-
- - - - -

Sets the ad unit ID.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalStateException - If the ad unit ID was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppEventListener - (AppEventListener appEventListener) -

-
-
- - - -
-
- - - - -

Sets an AppEventListener for this PublisherAdView. -

- -
-
- - - - -
-

- - public - - - - - void - - setOnCustomRenderedAdLoadedListener - (OnCustomRenderedAdLoadedListener onCustomRenderedAdLoadedListener) -

-
-
- - - -
-
- - - - -

Sets an OnCustomRenderedAdLoadedListener for this PublisherAdView. -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - void - - onLayout - (boolean changed, int left, int top, int right, int bottom) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - protected - - - - - void - - onMeasure - (int widthMeasureSpec, int heightMeasureSpec) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherInterstitialAd.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherInterstitialAd.html deleted file mode 100644 index 8003263a486d..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/PublisherInterstitialAd.html +++ /dev/null @@ -1,2120 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PublisherInterstitialAd | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PublisherInterstitialAd

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.doubleclick.PublisherInterstitialAd
- - - - - - - -
- - -

Class Overview

-

Full-screen interstitial ads for use with DoubleClick for Publishers. The ad unit ID must be set - prior to calling loadAd(PublisherAdRequest). -

- Sample code: - 

- public class MyActivity extends Activity {
-     private PublisherInterstitialAd mPublisherInterstitialAd;
-     private Button mNextLevelButton;
-     private TextView mTextView;
-
-     @Override
-     public void onCreate(Bundle savedInstanceState) {
-         super.onCreate(savedInstanceState);
-
-         // Create an interstitial ad. When a natural transition in the app occurs (such as a
-         // level ending in a game), show the interstitial. In this simple example, the press of a
-         // button is used instead.
-         //
-         // If the button is clicked before the interstitial is loaded, the user should proceed to
-         // the next part of the app (in this case, the next level).
-         //
-         // If the interstitial is finished loading, the user will view the interstitial before
-         // proceeding.
-         mPublisherInterstitialAd = new PublisherInterstitialAd(this);
-         mPublisherInterstitialAd.setAdUnitId("myAdUnitId");
-
-         // Create an ad request.
-         PublisherAdRequest.Builder publisherAdRequestBuilder = new PublisherAdRequest.Builder();
-
-         // Optionally populate the ad request builder.
-         publisherAdRequestBuilder.addTestDevice(PublisherAdRequest.DEVICE_ID_EMULATOR);
-
-         // Set an AdListener.
-         mPublisherInterstitialAd.setAdListener(new AdListener() {
-             @Override
-             public void onAdLoaded() {
-                 Toast.makeText(MyActivity.this,
-                         "The interstitial is loaded", Toast.LENGTH_SHORT).show();
-             }
-
-             @Override
-             public void onAdClosed() {
-                 // Proceed to the next level.
-                 goToNextLevel();
-             }
-         });
-
-         // Start loading the ad now so that it is ready by the time the user is ready to go to
-         // the next level.
-         mPublisherInterstitialAd.loadAd(publisherAdRequestBuilder.build());
-
-         // Create the button to go to the next level.
-         mNextLevelButton = new Button(this);
-         mNextLevelButton.setText("Next Level");
-         mNextLevelButton.setOnClickListener(new View.OnClickListener() {
-             @Override
-             public void onClick(View view) {
-                 // Show the interstitial if it is ready. Otherwise, proceed to the next level
-                 // without ever showing it.
-                 if (mPublisherInterstitialAd.isLoaded()) {
-                     mPublisherInterstitialAd.show();
-                 } else {
-                     // Proceed to the next level.
-                     goToNextLevel();
-                 }
-             }
-         });
-
-         // Add the next level button to the layout.
-         LinearLayout layout = new LinearLayout(this);
-         layout.setOrientation(LinearLayout.VERTICAL);
-         layout.addView(mNextLevelButton);
-
-         // Create a TextView to display the current level.
-         mTextView = new TextView(this);
-         mTextView.setText("Level 1");
-         layout.addView(mTextView);
-
-         setContentView(layout);
-     }
-
-     public void goToNextLevel() {
-         // Show the next level (and disable the next level button since there are no more levels.
-         mNextLevelButton.setEnabled(false);
-         mTextView.setText("Level 2");
-     }
- }
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PublisherInterstitialAd(Context context) - -
- Construct an PublisherInterstitialAd. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - AdListener - - getAdListener() - -
- Returns the AdListener for this PublisherInterstitialAd. - - - -
- -
- - - - - - String - - getAdUnitId() - -
- Returns the ad unit ID. - - - -
- -
- - - - - - AppEventListener - - getAppEventListener() - -
- Returns the AppEventListener for this PublisherInterstitialAd. - - - -
- -
- - - - - - String - - getMediationAdapterClassName() - -
- Returns the mediation adapter class name. - - - -
- -
- - - - - - OnCustomRenderedAdLoadedListener - - getOnCustomRenderedAdLoadedListener() - -
- Returns the OnCustomRenderedAdLoadedListener for this - PublisherInterstitialAd. - - - -
- -
- - - - - - boolean - - isLoaded() - -
- Returns true if the ad was successfully loaded and is ready to be shown. - - - -
- -
- - - - - - void - - loadAd(PublisherAdRequest publisherAdRequest) - -
- Start loading the ad on a background thread. - - - -
- -
- - - - - - void - - setAdListener(AdListener adListener) - -
- Sets an AdListener for this PublisherInterstitialAd. - - - -
- -
- - - - - - void - - setAdUnitId(String adUnitId) - -
- Sets the ad unit ID. - - - -
- -
- - - - - - void - - setAppEventListener(AppEventListener appEventListener) - -
- Sets an AppEventListener for this PublisherInterstitialAd. - - - -
- -
- - - - - - void - - setOnCustomRenderedAdLoadedListener(OnCustomRenderedAdLoadedListener onCustomRenderedAdLoadedListener) - -
- Sets an OnCustomRenderedAdLoadedListener for this PublisherInterstitialAd. - - - -
- -
- - - - - - void - - show() - -
- Show the interstitial ad. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PublisherInterstitialAd - (Context context) -

-
-
- - - -
-
- - - - -

Construct an PublisherInterstitialAd.

-
-
Parameters
- - - - -
context - The Context the PublisherInterstitialAd is running in. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - AdListener - - getAdListener - () -

-
-
- - - -
-
- - - - -

Returns the AdListener for this PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - String - - getAdUnitId - () -

-
-
- - - -
-
- - - - -

Returns the ad unit ID. -

- -
-
- - - - -
-

- - public - - - - - AppEventListener - - getAppEventListener - () -

-
-
- - - -
-
- - - - -

Returns the AppEventListener for this PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - String - - getMediationAdapterClassName - () -

-
-
- - - -
-
- - - - -

Returns the mediation adapter class name. In the case of a mediated ad response, this is the - name of the class that was responsible for performing the ad request and rendering the ad. - For non-mediated responses, this value will be null. -

- -
-
- - - - -
-

- - public - - - - - OnCustomRenderedAdLoadedListener - - getOnCustomRenderedAdLoadedListener - () -

-
-
- - - -
-
- - - - -

Returns the OnCustomRenderedAdLoadedListener for this - PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isLoaded - () -

-
-
- - - -
-
- - - - -

Returns true if the ad was successfully loaded and is ready to be shown. -

- -
-
- - - - -
-

- - public - - - - - void - - loadAd - (PublisherAdRequest publisherAdRequest) -

-
-
- - - -
-
- - - - -

Start loading the ad on a background thread.

-
-
Throws
- - - - -
IllegalStateException - If the the ad unit ID has not been set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAdListener - (AdListener adListener) -

-
-
- - - -
-
- - - - -

Sets an AdListener for this PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdUnitId - (String adUnitId) -

-
-
- - - -
-
- - - - -

Sets the ad unit ID.

-
-
Throws
- - - - -
IllegalStateException - If the ad unit ID was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppEventListener - (AppEventListener appEventListener) -

-
-
- - - -
-
- - - - -

Sets an AppEventListener for this PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - void - - setOnCustomRenderedAdLoadedListener - (OnCustomRenderedAdLoadedListener onCustomRenderedAdLoadedListener) -

-
-
- - - -
-
- - - - -

Sets an OnCustomRenderedAdLoadedListener for this PublisherInterstitialAd. -

- -
-
- - - - -
-

- - public - - - - - void - - show - () -

-
-
- - - -
-
- - - - -

Show the interstitial ad. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/doubleclick/package-summary.html b/docs/html/reference/com/google/android/gms/ads/doubleclick/package-summary.html deleted file mode 100644 index 732c2e9e1f8d..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/doubleclick/package-summary.html +++ /dev/null @@ -1,967 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.doubleclick | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.doubleclick

-
- -
- -
- - -
- Contains classes for DoubleClick for Publishers. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - -
AppEventListener - A listener interface for app events triggered by ads.  - - - -
CustomRenderedAd - Interface that contains information about custom rendered ads.  - - - -
OnCustomRenderedAdLoadedListener - A listener for when a custom rendered ad has loaded.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PublisherAdRequest - A PublisherAdRequest contains targeting information used to fetch an ad from DoubleClick - for Publishers.  - - - -
PublisherAdRequest.Builder - Builds a PublisherAdRequest.  - - - -
PublisherAdView - The View to display banner ads for use with DoubleClick for Publishers.  - - - -
PublisherInterstitialAd - Full-screen interstitial ads for use with DoubleClick for Publishers.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info.html b/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info.html deleted file mode 100644 index db7a2fa7a1d6..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info.html +++ /dev/null @@ -1,1481 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdvertisingIdClient.Info | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

AdvertisingIdClient.Info

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.identifier.AdvertisingIdClient.Info
- - - - - - - -
- - -

Class Overview

-

Includes both the advertising ID as well as the limit ad tracking setting. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdvertisingIdClient.Info(String advertisingId, boolean limitAdTrackingEnabled) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getId() - -
- Retrieves the advertising ID. - - - -
- -
- - - - - - boolean - - isLimitAdTrackingEnabled() - -
- Retrieves whether the user has limit ad tracking enabled or not. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdvertisingIdClient.Info - (String advertisingId, boolean limitAdTrackingEnabled) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Retrieves the advertising ID.

- -
-
- - - - -
-

- - public - - - - - boolean - - isLimitAdTrackingEnabled - () -

-
-
- - - -
-
- - - - -

Retrieves whether the user has limit ad tracking enabled or not.

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.html b/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.html deleted file mode 100644 index f9034ad51640..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.html +++ /dev/null @@ -1,1387 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdvertisingIdClient | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AdvertisingIdClient

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.identifier.AdvertisingIdClient
- - - - - - - -
- - -

Class Overview

-

Helper library for retrieval of advertising ID and related information such as the - limit ad tracking setting. -

- It is intended that the advertising ID completely replace existing usage of other - identifiers for ads purposes (such as use of ANDROID_ID in - Settings.Secure) when Google Play Services is available. Cases where - Google Play Services is unavailable are indicated by a - GooglePlayServicesNotAvailableException being thrown by getAdvertisingIdInfo(). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classAdvertisingIdClient.Info - Includes both the advertising ID as well as the limit ad tracking setting.  - - - -
- - - - - - - - - - -
Public Methods
- - - - static - - AdvertisingIdClient.Info - - getAdvertisingIdInfo(Context context) - -
- Retrieves the user's advertising ID and limit ad tracking preference. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - AdvertisingIdClient.Info - - getAdvertisingIdInfo - (Context context) -

-
-
- - - -
-
- - - - -

Retrieves the user's advertising ID and limit ad tracking preference. -

- This method cannot be called in the main thread as it may block leading - to ANRs. An IllegalStateException will be thrown if this is called - on the main thread.

-
-
Parameters
- - - - -
context - Current Context (such as the current Activity).
-
-
-
Returns
-
  • AdvertisingIdClient.Info with user's advertising ID and limit ad tracking preference.
-
-
-
Throws
- - - - - - - - - - - - - -
IOException - signaling connection to Google Play Services failed.
IllegalStateException - indicating this method was called on the main thread.
GooglePlayServicesNotAvailableException - indicating that Google Play - is not installed on this device.
GooglePlayServicesRepairableException - indicating that there was - a recoverable error connecting to Google Play Services. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/identifier/package-summary.html b/docs/html/reference/com/google/android/gms/ads/identifier/package-summary.html deleted file mode 100644 index af77d7ac6d17..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/identifier/package-summary.html +++ /dev/null @@ -1,897 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.identifier | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.identifier

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - -
AdvertisingIdClient - Helper library for retrieval of advertising ID and related information such as the - limit ad tracking setting.  - - - -
AdvertisingIdClient.Info - Includes both the advertising ID as well as the limit ad tracking setting.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdRequest.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdRequest.html deleted file mode 100644 index 228f4388a44d..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdRequest.html +++ /dev/null @@ -1,1559 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationAdRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationAdRequest

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationAdRequest
- - - - - - - -
- - -

Class Overview

-

Information about the ad to fetch for a single publisher. The information is passed through to - the ad network's adapter. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE - As returned by taggedForChildDirectedTreatment(), indicates that the app should not be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). - - - -
intTAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE - As returned by taggedForChildDirectedTreatment(), indicates that the app should be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). - - - -
intTAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED - As returned by taggedForChildDirectedTreatment(), indicates that the publisher has not - specified whether the app should be treated as child-directed for purposes of the Children’s - Online Privacy Protection Act (COPPA). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Date - - getBirthday() - -
- Returns the birthday of the user, if defined by the - AdRequest. - - - -
- -
- abstract - - - - - int - - getGender() - -
- Returns the gender of the user, if defined by the - AdRequest. - - - -
- -
- abstract - - - - - Set<String> - - getKeywords() - -
- Returns the set of keywords requested by the user, if defined by the - AdRequest. - - - -
- -
- abstract - - - - - Location - - getLocation() - -
- Returns the location of the user, if defined by the - AdRequest. - - - -
- -
- abstract - - - - - boolean - - isTesting() - -
- Returns true if the publisher is asking for test ads. - - - -
- -
- abstract - - - - - int - - taggedForChildDirectedTreatment() - -
- Returns whether the publisher indicated that the app is to be treated as child-directed for - purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE -

-
- - - - -
-
- - - - -

As returned by taggedForChildDirectedTreatment(), indicates that the app should not be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE -

-
- - - - -
-
- - - - -

As returned by taggedForChildDirectedTreatment(), indicates that the app should be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED -

-
- - - - -
-
- - - - -

As returned by taggedForChildDirectedTreatment(), indicates that the publisher has not - specified whether the app should be treated as child-directed for purposes of the Children’s - Online Privacy Protection Act (COPPA). -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Date - - getBirthday - () -

-
-
- - - -
-
- - - - -

Returns the birthday of the user, if defined by the - AdRequest. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getGender - () -

-
-
- - - -
-
- - - - -

Returns the gender of the user, if defined by the - AdRequest. -

- -
-
- - - - -
-

- - public - - - abstract - - Set<String> - - getKeywords - () -

-
-
- - - -
-
- - - - -

Returns the set of keywords requested by the user, if defined by the - AdRequest. -

- -
-
- - - - -
-

- - public - - - abstract - - Location - - getLocation - () -

-
-
- - - -
-
- - - - -

Returns the location of the user, if defined by the - AdRequest. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isTesting - () -

-
-
- - - -
-
- - - - -

Returns true if the publisher is asking for test ads. Publishers request test ads by - specifying a device ID, but this information is resolved to a boolean for convenience. If no - Context was provided to this class' constructor, this will always return true. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - taggedForChildDirectedTreatment - () -

-
-
- - - -
-
- - - - -

Returns whether the publisher indicated that the app is to be treated as child-directed for - purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. -

- If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_TRUE, it indicates that the - app should be treated as child-directed for purposes of the Children’s Online Privacy - Protection Act (COPPA). -

- If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_FALSE, it indicates that the - app should not be treated as child-directed for purposes of the Children’s Online Privacy - Protection Act (COPPA). -

- If this method returns TAG_FOR_CHILD_DIRECTED_TREATMENT_UNSPECIFIED, it indicates - that the publisher has not specified whether the app should be treated as child-directed for - purposes of the Children’s Online Privacy Protection Act (COPPA). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdapter.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdapter.html deleted file mode 100644 index 0e0d367db141..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationAdapter.html +++ /dev/null @@ -1,1263 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationAdapter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationAdapter

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationAdapter
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Adapter for third party ad networks. - -

This class is the common interface of MediationBannerAdapter and - MediationInterstitialAdapter and it defines common methods. There is no reason to - implement this interface directly. Instead, adapters should implement - MediationBannerAdapter and MediationInterstitialAdapter. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDestroy() - -
- Tears down the adapter control. - - - -
- -
- abstract - - - - - void - - onPause() - -
- Called when the application calls onPause on the - AdView. - - - -
- -
- abstract - - - - - void - - onResume() - -
- Called when the application calls onResume on the - AdView. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

Tears down the adapter control. - -

This is called at the end of the mediator's life cycle. The adapter is expected to - release any resources and shut down. After this method is called, any subsequent calls to - any other method on this adapter may throw an IllegalStateException. - -

This method is not guaranteed to be called. There are a number of reasons that this - method can be skipped, such as a force close of the application. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onPause - () -

-
-
- - - -
-
- - - - -

Called when the application calls onPause on the - AdView. The adapter is expected to pause any processing - associated with the ad being shown. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onResume - () -

-
-
- - - -
-
- - - - -

Called when the application calls onResume on the - AdView. The adapter is expected to resume any processing - associated with the ad being shown. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerAdapter.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerAdapter.html deleted file mode 100644 index a655287d5f99..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerAdapter.html +++ /dev/null @@ -1,1322 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationBannerAdapter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationBannerAdapter

- - - - - - implements - - MediationAdapter - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationBannerAdapter
- - - - - - - -
- - -

Class Overview

-

Adapter for third party ad networks that support banner ads. - -

- The typical life-cycle for an adapter is to have requestBannerAd(Context, MediationBannerListener, Bundle, AdSize, MediationAdRequest, Bundle) called once. At this - point the adapter should request an ad from the ad network and report to the listener either - onAdLoaded(MediationBannerAdapter) or onAdFailedToLoad(MediationBannerAdapter, int). - Subsequent requests will be made with a new instance of the adapter. At the end of the life - cycle, a best effort is made to call onDestroy(), though this is not guaranteed. Note that - requestBannerAd(Context, MediationBannerListener, Bundle, AdSize, MediationAdRequest, Bundle) is called on the UI thread so all the standard precautions of writing - code on that thread apply. In particular, the code should not call any blocking methods. - -

- The adapter is expected to expose events via the MediationBannerListener passed in the - requestBannerAd(Context, MediationBannerListener, Bundle, AdSize, MediationAdRequest, Bundle) call. All parameters necessary to make an ad request should be passed in - the serverParameters, MediationAdRequest, and mediationExtras parameters. - -

- Adapters should make an effort to disable automatic ad refreshing on the client side. Ads that - are refreshed may be ignored, not displayed, and counted incorrectly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - View - - getBannerView() - -
- Returns a View that can be rendered to display the ad. - - - -
- -
- abstract - - - - - void - - requestBannerAd(Context context, MediationBannerListener listener, Bundle serverParameters, AdSize adSize, MediationAdRequest mediationAdRequest, Bundle mediationExtras) - -
- Called by the mediation library to request a banner ad from the adapter. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.MediationAdapter - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - View - - getBannerView - () -

-
-
- - - -
-
- - - - -

Returns a View that can be rendered to display the ad. - -

- This must not be null after a requestBannerAd(Context, MediationBannerListener, Bundle, AdSize, MediationAdRequest, Bundle) call and before a - onDestroy() call. It may be null any other time. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - requestBannerAd - (Context context, MediationBannerListener listener, Bundle serverParameters, AdSize adSize, MediationAdRequest mediationAdRequest, Bundle mediationExtras) -

-
-
- - - -
-
- - - - -

Called by the mediation library to request a banner ad from the adapter. - -

- If the request is successful, the onAdLoaded(MediationBannerAdapter) method should be - called. - -

If the request is unsuccessful, the onAdFailedToLoad(MediationBannerAdapter, int) - method should be called on the listener with an appropriate error cause. - -

- This method is called on the UI thread so all the standard precautions of writing code on - that thread apply. In particular your code should not call any blocking methods.

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
context - The Context of the AdView which will contain the banner View. The - Activity is preferred.
listener - Listener to adapter with callbacks for various events
serverParameters - Additional parameters defined by the publisher on the mediation - server side
adSize - The size of the ad to fetch. The ad size returned should have size as close as - possible to the size specified in this parameter. If this ad size is not supported the - request should fail and onAdFailedToLoad(MediationBannerAdapter, int) should be - called.
mediationAdRequest - Generic parameters for this publisher to use when making his ad - request
mediationExtras - Additional parameters set by the publisher on a per-request basis -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerListener.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerListener.html deleted file mode 100644 index 8b75a63e2010..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationBannerListener.html +++ /dev/null @@ -1,1448 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationBannerListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationBannerListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationBannerListener
- - - - - - - -
- - -

Class Overview

-

Callback for an adapter to communicate back to the mediation library. Events must - be communicated back for the mediation library to properly manage ad flow. - -

The onAdClicked(MediationBannerAdapter) method in particular is required - for metrics to operate correctly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAdClicked(MediationBannerAdapter adapter) - -
- Indicates that the user has clicked on this ad. - - - -
- -
- abstract - - - - - void - - onAdClosed(MediationBannerAdapter adapter) - -
- Indicates that the ad control rendered something in full screen and is now transferring - control back to the application. - - - -
- -
- abstract - - - - - void - - onAdFailedToLoad(MediationBannerAdapter adapter, int error) - -
- Indicates that an ad request has failed along with the underlying cause. - - - -
- -
- abstract - - - - - void - - onAdLeftApplication(MediationBannerAdapter adapter) - -
- Indicates that the ad is causing the device to switch to a different application (such as a - web browser). - - - -
- -
- abstract - - - - - void - - onAdLoaded(MediationBannerAdapter adapter) - -
- Indicates that an ad has been requested and successfully received. - - - -
- -
- abstract - - - - - void - - onAdOpened(MediationBannerAdapter adapter) - -
- Indicates that the ad control is rendering something that is full screen. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAdClicked - (MediationBannerAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the user has clicked on this ad. This is used for publisher metrics, and - must be called in addition to any other events; this event is never inferred by the mediation - library. For example, onAdLeftApplication(MediationBannerAdapter) would generally - mean that the user has clicked on an ad, but onAdClicked(MediationBannerAdapter) - must be called regardless.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdClosed - (MediationBannerAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad control rendered something in full screen and is now transferring - control back to the application. This may be the user returning from a different application.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdFailedToLoad - (MediationBannerAdapter adapter, int error) -

-
-
- - - -
-
- - - - -

Indicates that an ad request has failed along with the underlying cause. A failure may be an - actual error or just a lack of fill. - -

- Once an ad is requested, the adapter must report either success or failure. If no response is - heard within a time limit, the mediation library may move on to another adapter, resulting in - a potentially successful ad not being shown.

-
-
Parameters
- - - - - - - -
adapter - The mediation adapter which raised the event.
error - An error code detailing the cause of the failure. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdLeftApplication - (MediationBannerAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad is causing the device to switch to a different application (such as a - web browser). This must be called before the current application is put in the background.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdLoaded - (MediationBannerAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that an ad has been requested and successfully received. Banner ads may be - automatically displayed after this method has been called. - -

- Once an ad is requested, the adapter must report either success or failure. If no response is - heard within a time limit, the mediation library may move on to another adapter, resulting in - a potentially successful ad not being shown. - -

- From the point when this method is called until the adapter is destroyed, - getBannerView() must return a View - object; null is not permitted. The same View object must be - returned on every request.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdOpened - (MediationBannerAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad control is rendering something that is full screen. This may be an - Activity, or it may be a precursor to switching to a different - application. - -

- Once this screen is dismissed, onAdClosed(MediationBannerAdapter) must be called.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialAdapter.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialAdapter.html deleted file mode 100644 index c83efba124af..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialAdapter.html +++ /dev/null @@ -1,1313 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationInterstitialAdapter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationInterstitialAdapter

- - - - - - implements - - MediationAdapter - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationInterstitialAdapter
- - - - - - - -
- - -

Class Overview

-

Adapter for third party ad networks that support interstitial ads. - -

The typical life-cycle for an adapter is to have requestInterstitialAd(Context, MediationInterstitialListener, Bundle, MediationAdRequest, Bundle) called once. - At this point the adapter should request an ad from the ad network and report to the listener - either onAdLoaded(MediationInterstitialAdapter) or - onAdFailedToLoad(MediationInterstitialAdapter, int). Subsequent requests will be made - with a new instance of the adapter. At the end of the life cycle, a best effort is made to call - onDestroy(), though this is not guaranteed. Note that requestInterstitialAd(Context, MediationInterstitialListener, Bundle, MediationAdRequest, Bundle) is - called on the UI thread so all the standard precautions of writing code on that thread apply. - In particular, the code should not call any blocking methods. - -

The adapter is expected to forward events via the MediationInterstitialListener passed - in the requestInterstitialAd(Context, MediationInterstitialListener, Bundle, MediationAdRequest, Bundle) call. All parameters necessary to make an ad request - should be passed in the serverParameters, MediationAdRequest, and - mediationExtras parameters. - -

Adapters should make an effort to disable automatic ad refreshing on the client side. Ads - that are refreshed may be ignored, not displayed, and counted incorrectly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - requestInterstitialAd(Context context, MediationInterstitialListener listener, Bundle serverParameters, MediationAdRequest mediationAdRequest, Bundle mediationExtras) - -
- Called by the mediation library to request an ad from the adapter. - - - -
- -
- abstract - - - - - void - - showInterstitial() - -
- Shows the interstitial. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.MediationAdapter - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - requestInterstitialAd - (Context context, MediationInterstitialListener listener, Bundle serverParameters, MediationAdRequest mediationAdRequest, Bundle mediationExtras) -

-
-
- - - -
-
- - - - -

Called by the mediation library to request an ad from the adapter. - -

If the request is successful, the - onAdLoaded(MediationInterstitialAdapter) method should be called. The interstitial - should *NOT* be automatically shown at this point. The mediation library will call the - showInterstitial() method when the interstitial should be shown. - -

If the request is unsuccessful, the - onAdFailedToLoad(MediationInterstitialAdapter, int) method should be called on the - listener with an appropriate error cause. - -

Note that this method is called on the UI thread, so all the general precautions of - writing code on that thread apply. In particular, the code should not call any blocking - methods.

-
-
Parameters
- - - - - - - - - - - - - - - - -
context - The Context of the AdView which will contain the banner View. The - Activity is preferred.
listener - Listener to adapter with callbacks for various events
serverParameters - Additional parameters defined by the publisher on the mediation - server side
mediationAdRequest - Generic parameters for this publisher to use when making his ad - request
mediationExtras - Additional parameters set by the publisher on a per-request basis -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - showInterstitial - () -

-
-
- - - -
-
- - - - -

Shows the interstitial. This may be called any time after a call to - onAdLoaded(MediationInterstitialAdapter). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialListener.html b/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialListener.html deleted file mode 100644 index 08da9503904c..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/MediationInterstitialListener.html +++ /dev/null @@ -1,1444 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediationInterstitialListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

MediationInterstitialListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.MediationInterstitialListener
- - - - - - - -
- - -

Class Overview

-

Callback for an adapter to communicate back to the mediation library. Events must be - communicated back for the mediation library to properly manage ad flow. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAdClicked(MediationInterstitialAdapter adapter) - -
- Indicates that the user has clicked on this ad. - - - -
- -
- abstract - - - - - void - - onAdClosed(MediationInterstitialAdapter adapter) - -
- Indicates that the ad control rendered something in full screen and is now transferring - control back to the application. - - - -
- -
- abstract - - - - - void - - onAdFailedToLoad(MediationInterstitialAdapter adapter, int error) - -
- Indicates that an ad request has failed along with the underlying cause. - - - -
- -
- abstract - - - - - void - - onAdLeftApplication(MediationInterstitialAdapter adapter) - -
- Indicates that the ad is causing the device to switch to a different application (such as a - web browser). - - - -
- -
- abstract - - - - - void - - onAdLoaded(MediationInterstitialAdapter adapter) - -
- Indicates that an ad has been requested and successfully received. - - - -
- -
- abstract - - - - - void - - onAdOpened(MediationInterstitialAdapter adapter) - -
- Indicates that the ad control is rendering something that is full screen. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAdClicked - (MediationInterstitialAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the user has clicked on this ad. This is used for publisher metrics, and - must be called in addition to any other events; this event is never inferred by the mediation - library. For example, onAdLeftApplication(MediationInterstitialAdapter) would - generally mean that the user has clicked on an ad, but - onAdClicked(MediationInterstitialAdapter) must be called regardless.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdClosed - (MediationInterstitialAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad control rendered something in full screen and is now transferring - control back to the application. This may be the user returning from a different application.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdFailedToLoad - (MediationInterstitialAdapter adapter, int error) -

-
-
- - - -
-
- - - - -

Indicates that an ad request has failed along with the underlying cause. A failure may be an - actual error or just a lack of fill. - -

- Once an ad is requested, the adapter must report either success or failure. If no response is - heard within a time limit, the mediation library may move on to another adapter, resulting in - a potentially successful ad not being shown.

-
-
Parameters
- - - - - - - -
adapter - The mediation adapter which raised the event.
error - An error code detailing the cause of the failure. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdLeftApplication - (MediationInterstitialAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad is causing the device to switch to a different application (such as a - web browser). This must be called before the current application is put in the background.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdLoaded - (MediationInterstitialAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that an ad has been requested and successfully received. Interstitials must wait - for a show() call. - -

- Once an ad is requested, the adapter must report either success or failure. If no response is - heard within a time limit, the mediation library may move on to another adapter, resulting in - a potentially successful ad not being shown. - -

- From the point when this method is called until the adapter is destroyed, - showInterstitial() should open the interstitial.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdOpened - (MediationInterstitialAdapter adapter) -

-
-
- - - -
-
- - - - -

Indicates that the ad control is rendering something that is full screen. This may be an - Activity, or it may be a precursor to switching to a different - application. - -

- Once this screen is dismissed, onAdClosed(MediationInterstitialAdapter) must be - called.

-
-
Parameters
- - - - -
adapter - The mediation adapter which raised the event. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/NetworkExtras.html b/docs/html/reference/com/google/android/gms/ads/mediation/NetworkExtras.html deleted file mode 100644 index 5b4fdf0c5295..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/NetworkExtras.html +++ /dev/null @@ -1,1056 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NetworkExtras | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

NetworkExtras

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.NetworkExtras
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
-

-

- This interface is deprecated.
- This interface is only used by implementations of - com.google.ads.mediation.MediationAdapter, which has been deprecated in - favor of MediationAdapter. Extras for - new mediation adapters are passed in as a Bundle through - addNetworkExtrasBundle(Class, Bundle). - -

- -

Class Overview

-

An empty interface for use by Google Mobile Ads mediation adapters. There are intentionally no - methods to implement. This interface is deprecated.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/admob/AdMobExtras.html b/docs/html/reference/com/google/android/gms/ads/mediation/admob/AdMobExtras.html deleted file mode 100644 index 0bc5904167b4..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/admob/AdMobExtras.html +++ /dev/null @@ -1,1407 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AdMobExtras | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AdMobExtras

- - - - - extends Object
- - - - - - - implements - - NetworkExtras - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.mediation.admob.AdMobExtras
- - - - - - - -
-

-

- This class is deprecated.
- Instead of using this class in conjunction with - addNetworkExtras(NetworkExtras), pass a Bundle - to addNetworkExtrasBundle(Class, Bundle) along - with com.google.ads.mediation.admob.AdMobAdapter.class. - -

- -

Class Overview

-

NetworkExtras for the AdMob mediation adapter. This - class is deprecated.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AdMobExtras(Bundle extras) - -
- Constructs an AdMobExtras with the provided extra ad request parameters. - - - -
- -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Bundle - - getExtras() - -
- Returns the extra ad request parameters. - - - -
- -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AdMobExtras - (Bundle extras) -

-
-
- - - -
-
- - - - -

Constructs an AdMobExtras with the provided extra ad request parameters. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Bundle - - getExtras - () -

-
-
- - - -
-
- - - - -

Returns the extra ad request parameters. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/admob/package-summary.html b/docs/html/reference/com/google/android/gms/ads/mediation/admob/package-summary.html deleted file mode 100644 index e1bd0aa34d11..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/admob/package-summary.html +++ /dev/null @@ -1,896 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.mediation.admob | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.mediation.admob

-
- -
- -
- - -
- Contains classes for the AdMob mediation adapter. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - -
AdMobExtras - - This class is deprecated. - Instead of using this class in conjunction with - addNetworkExtras(NetworkExtras), pass a Bundle - to addNetworkExtrasBundle(Class, Bundle) along - with com.google.ads.mediation.admob.AdMobAdapter.class. -  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEvent.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEvent.html deleted file mode 100644 index 9aaf9b92baab..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEvent.html +++ /dev/null @@ -1,1258 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEvent

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEvent
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

A CustomEvent is similar to a - MediationAdapter except that it is a completely - self-service mechanism for publishers to create their own adapter. -

The most common use case for a CustomEvent is to add support for an ad network that - doesn't already provide its own MediationAdapter. -

There is no reason to implement this interface directly. Instead, custom events should - implement CustomEventBanner and CustomEventInterstitial. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDestroy() - -
- Tears down the adapter control. - - - -
- -
- abstract - - - - - void - - onPause() - -
- Called when the application calls pause(). - - - -
- -
- abstract - - - - - void - - onResume() - -
- Called when the application calls resume(). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

Tears down the adapter control. -

This is called at the end of the custom event's life cycle. The adapter is expected to - release any resources and shut down. After this method is called, any subsequent calls to any - other method on this adapter may throw an IllegalStateException. -

This method is not guaranteed to be called. There are a number of reasons that this method - can be skipped, such as a force close of the application. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onPause - () -

-
-
- - - -
-
- - - - -

Called when the application calls pause(). The - custom event is expected to pause any processing associated with the ad being shown. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onResume - () -

-
-
- - - -
-
- - - - -

Called when the application calls resume(). The - adapter is expected to resume any processing associated with the ad being shown. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBanner.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBanner.html deleted file mode 100644 index 392093cce075..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBanner.html +++ /dev/null @@ -1,1250 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventBanner | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEventBanner

- - - - - - implements - - CustomEvent - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEventBanner
- - - - - - - -
- - -

Class Overview

-

A custom event to support banner ads. -

The typical life-cycle for a custom event is to have requestBannerAd(Context, CustomEventBannerListener, String, AdSize, MediationAdRequest, Bundle) called once. At - this point the adapter should create a View and report to the - CustomEventBannerListener either onAdLoaded(View) or - onAdFailedToLoad(int). Subsequent requests will be made with a new - instance of the custom event. At the end of the life cycle, a best effort is made to call - onDestroy(), though this is not guaranteed. Note that requestBannerAd(Context, CustomEventBannerListener, String, AdSize, MediationAdRequest, Bundle) - is called on the UI thread so all the standard precautions of writing code on that thread apply. - In particular, the code should not call any blocking methods. -

The adapter is expected to expose events via the CustomEventBannerListener passed in - the requestBannerAd(Context, CustomEventBannerListener, String, AdSize, MediationAdRequest, Bundle) call. All parameters necessary to make an ad request should be - passed in the serverParameter, MediationAdRequest, and customEventExtras - parameters. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - requestBannerAd(Context context, CustomEventBannerListener listener, String serverParameter, AdSize size, MediationAdRequest mediationAdRequest, Bundle customEventExtras) - -
- Called by the mediation library to request a view from the custom event. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.customevent.CustomEvent - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - requestBannerAd - (Context context, CustomEventBannerListener listener, String serverParameter, AdSize size, MediationAdRequest mediationAdRequest, Bundle customEventExtras) -

-
-
- - - -
-
- - - - -

Called by the mediation library to request a view from the custom event. - -

If the request is successful, onAdLoaded(View) should be - called. - -

If the request is unsuccessful, onAdFailedToLoad(int) should be - called on the listener with an appropriate error cause. - -

This method is called on the UI thread so all the standard precautions of writing code on - that thread apply. In particular your code should not call any blocking methods.

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
context - The Context of the AdView which will contain the custom event View. An Activity is preferred.
listener - Listener to custom event with callbacks for various events.
serverParameter - The string configured in the publisher UI as the parameter for the - custom event.
size - The size of the view to fetch. The size of the view should be as close as - possible to the size specified in this parameter. If this view size is not - supported, the request should fail and onAdFailedToLoad(int) should be called.
mediationAdRequest - Generic targeting parameters to use when requesting a view.
customEventExtras - A Bundle of parameters set by the publisher on a per-request - basis. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBannerListener.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBannerListener.html deleted file mode 100644 index e9d1602a7225..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventBannerListener.html +++ /dev/null @@ -1,1259 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventBannerListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEventBannerListener

- - - - - - implements - - CustomEventListener - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEventBannerListener
- - - - - - - -
- - -

Class Overview

-

Custom events that implement CustomEventBanner should use this listener to send callbacks - to the mediation library to properly manage ad flow. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAdLoaded(View view) - -
- Indicates that a view has been requested and successfully received. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.customevent.CustomEventListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAdLoaded - (View view) -

-
-
- - - -
-
- - - - -

Indicates that a view has been requested and successfully received. This view may be - displayed after this method has been called. -

Once an ad view is requested, the custom event must report either onAdLoaded or - onAdFailedToLoad(int). If no response is received within a time limit, - the mediation library may move on to another adapter, resulting in the custom event's view - not being shown.

-
-
Parameters
- - - - -
view - The view to be displayed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventExtras.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventExtras.html deleted file mode 100644 index 007666fff028..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventExtras.html +++ /dev/null @@ -1,1463 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventExtras | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CustomEventExtras

- - - - - extends Object
- - - - - - - implements - - NetworkExtras - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.mediation.customevent.CustomEventExtras
- - - - - - - -
-

-

- This class is deprecated.
- This class will only work with implementations of the old - CustomEventAdapter which has been deprecated in favor of - CustomEventBanner and - CustomEventInterstitial. - To pass extras to custom events that implement - CustomEventBanner or - CustomEventInterstitial, - call addCustomEventExtrasBundle(Class, Bundle) - with the class of your - CustomEventBanner or - CustomEventInterstitial - implementation and a Bundle. - -

- -

Class Overview

-

Extra parameters for mediation custom events. The extra parameters are stored using the label of - the custom event.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CustomEventExtras() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Object - - getExtra(String label) - -
- Returns the extra parameter for the custom event with the provided label. - - - -
- -
- - - - - - void - - setExtra(String label, Object value) - -
- Sets an extra parameter for the custom event with the provided label. - - - -
- -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CustomEventExtras - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Object - - getExtra - (String label) -

-
-
- - - -
-
- - - - -

Returns the extra parameter for the custom event with the provided label. -

- -
-
- - - - -
-

- - public - - - - - void - - setExtra - (String label, Object value) -

-
-
- - - -
-
- - - - -

Sets an extra parameter for the custom event with the provided label. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitial.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitial.html deleted file mode 100644 index 9de2f0c922cd..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitial.html +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventInterstitial | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEventInterstitial

- - - - - - implements - - CustomEvent - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEventInterstitial
- - - - - - - -
- - -

Class Overview

-

A custom event that supports interstitial ads. -

The typical life-cycle for a custom event is to have requestInterstitialAd(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle) called - once. At this point the adapter should request an ad and report either - onAdLoaded() or - onAdFailedToLoad(int) to the listener. Subsequent requests - will be made with a new instance of the custom event. At the end of the life cycle, a best effort - is made to call onDestroy(), though this is not guaranteed. Note that - requestInterstitialAd(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle) is called on the UI thread so all the standard precautions of - writing code on that thread apply. In particular, the code should not call any blocking methods. -

The custom event is expected to forward events via the - CustomEventInterstitialListener passed in the requestInterstitialAd(Context, CustomEventInterstitialListener, String, MediationAdRequest, Bundle) call. All - parameters necessary to make an ad request should be passed in the serverParameter, - MediationAdRequest, and customEventExtras parameters. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - requestInterstitialAd(Context context, CustomEventInterstitialListener listener, String serverParameter, MediationAdRequest mediationAdRequest, Bundle customEventExtras) - -
- Called by the mediation library to request an interstitial. - - - -
- -
- abstract - - - - - void - - showInterstitial() - -
- Show the interstitial. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.customevent.CustomEvent - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - requestInterstitialAd - (Context context, CustomEventInterstitialListener listener, String serverParameter, MediationAdRequest mediationAdRequest, Bundle customEventExtras) -

-
-
- - - -
-
- - - - -

Called by the mediation library to request an interstitial. - -

If the request is successful, onAdLoaded() should be - called. - -

If the request is unsuccessful, onAdFailedToLoad(int) should be - called on the listener with an appropriate error cause. - -

This method is called on the UI thread so all the standard precautions of writing code on - that thread apply. In particular your code should not call any blocking methods.

-
-
Parameters
- - - - - - - - - - - - - - - - -
context - The Context of the InterstitialAd - that requested the custom event interstitial. An Activity - is preferred.
listener - Listener to custom event with callbacks for various events.
serverParameter - The string configured in the publisher UI as the parameter for the - custom event.
mediationAdRequest - Generic targeting parameters to use when requesting an - interstitial.
customEventExtras - A Bundle of parameters set by the publisher on a per-request - basis. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - showInterstitial - () -

-
-
- - - -
-
- - - - -

Show the interstitial. This may be called any time after a call to onAdLoaded(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitialListener.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitialListener.html deleted file mode 100644 index 72f2d38bfed7..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitialListener.html +++ /dev/null @@ -1,1252 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventInterstitialListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEventInterstitialListener

- - - - - - implements - - CustomEventListener - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEventInterstitialListener
- - - - - - - -
- - -

Class Overview

-

A custom event interstitial listener. Custom events that implement - CustomEventInterstitial should use this listener to send callbacks to the mediation - library to properly manage ad flow. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAdLoaded() - -
- Indicates that an interstitial has been requested and successfully received. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.ads.mediation.customevent.CustomEventListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAdLoaded - () -

-
-
- - - -
-
- - - - -

Indicates that an interstitial has been requested and successfully received. Interstitials - must wait for a showInterstitial() call. -

Once an interstitial is requested, the custom event must report either success or - failure. If no response is received within a time limit, the mediation library may move on to - another adapter, resulting in a potentially successful interstitial not being shown. -

From the point when this method is called until the adapter is destroyed, - showInterstitial() should open the interstitial. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventListener.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventListener.html deleted file mode 100644 index e4b30fb4dce7..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/CustomEventListener.html +++ /dev/null @@ -1,1392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomEventListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CustomEventListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.mediation.customevent.CustomEventListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

A base custom event listener for banner and interstitial ads. Do not implement this interface - directly. Instead, implement CustomEventBannerListener and/or - CustomEventInterstitialListener. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onAdClicked() - -
- Indicates that the user has clicked on this custom event. - - - -
- -
- abstract - - - - - void - - onAdClosed() - -
- Indicates that the custom event rendered something in full screen and is now transferring - control back to the application. - - - -
- -
- abstract - - - - - void - - onAdFailedToLoad(int errorCode) - -
- Indicates that an custom event request has failed along with the underlying cause. - - - -
- -
- abstract - - - - - void - - onAdLeftApplication() - -
- Indicates that user interaction with the custom event is causing the device to switch to a - different application (such as a web browser). - - - -
- -
- abstract - - - - - void - - onAdOpened() - -
- Indicates that the custom event is rendering something that is full screen. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onAdClicked - () -

-
-
- - - -
-
- - - - -

Indicates that the user has clicked on this custom event. This is used for publisher metrics, - and must be called in addition to any other events; this event is never inferred by the - mediation library. For example, onAdLeftApplication() would generally mean that the - user has clicked on an ad, but onAdClicked() must be called regardless. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdClosed - () -

-
-
- - - -
-
- - - - -

Indicates that the custom event rendered something in full screen and is now transferring - control back to the application. This may be the user returning from a different application.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdFailedToLoad - (int errorCode) -

-
-
- - - -
-
- - - - -

Indicates that an custom event request has failed along with the underlying cause. A failure - may be an actual error or just a lack of fill. -

Once an ad is requested, the custom event must report either success or failure. If no - response is received within a time limit, the mediation library may move on to another - adapter, resulting in a potentially successful ad not being shown.

-
-
Parameters
- - - - -
errorCode - An error code detailing the cause of the failure. This may be any of - ERROR_CODE_INTERNAL_ERROR, - ERROR_CODE_INVALID_REQUEST, - ERROR_CODE_NETWORK_ERROR, or - ERROR_CODE_NO_FILL. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdLeftApplication - () -

-
-
- - - -
-
- - - - -

Indicates that user interaction with the custom event is causing the device to switch to a - different application (such as a web browser). This must be called before the current - application is put in the background. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onAdOpened - () -

-
-
- - - -
-
- - - - -

Indicates that the custom event is rendering something that is full screen. This may be an - Activity, or it may be a precursor to switching to a different - application. -

Once this screen is dismissed, onAdClosed() must be called. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/package-summary.html b/docs/html/reference/com/google/android/gms/ads/mediation/customevent/package-summary.html deleted file mode 100644 index de959783e288..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/customevent/package-summary.html +++ /dev/null @@ -1,983 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.mediation.customevent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.mediation.customevent

-
- -
- -
- - -
- Contains classes for Google Mobile Ads mediation custom events. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CustomEvent - A CustomEvent is similar to a - MediationAdapter except that it is a completely - self-service mechanism for publishers to create their own adapter.  - - - -
CustomEventBanner - A custom event to support banner ads.  - - - -
CustomEventBannerListener - Custom events that implement CustomEventBanner should use this listener to send callbacks - to the mediation library to properly manage ad flow.  - - - -
CustomEventInterstitial - A custom event that supports interstitial ads.  - - - -
CustomEventInterstitialListener - A custom event interstitial listener.  - - - -
CustomEventListener - A base custom event listener for banner and interstitial ads.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - -
CustomEventExtras - - This class is deprecated. - This class will only work with implementations of the old - CustomEventAdapter which has been deprecated in favor of - CustomEventBanner and - CustomEventInterstitial. - To pass extras to custom events that implement - CustomEventBanner or - CustomEventInterstitial, - call addCustomEventExtrasBundle(Class, Bundle) - with the class of your - CustomEventBanner or - CustomEventInterstitial - implementation and a Bundle. -  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/mediation/package-summary.html b/docs/html/reference/com/google/android/gms/ads/mediation/package-summary.html deleted file mode 100644 index 7bf8feb82c39..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/mediation/package-summary.html +++ /dev/null @@ -1,963 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.mediation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.mediation

-
- -
- -
- - -
- Contains classes for Google Mobile Ads mediation adapters. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MediationAdapter - Adapter for third party ad networks.  - - - -
MediationAdRequest - Information about the ad to fetch for a single publisher.  - - - -
MediationBannerAdapter - Adapter for third party ad networks that support banner ads.  - - - -
MediationBannerListener - Callback for an adapter to communicate back to the mediation library.  - - - -
MediationInterstitialAdapter - Adapter for third party ad networks that support interstitial ads.  - - - -
MediationInterstitialListener - Callback for an adapter to communicate back to the mediation library.  - - - -
NetworkExtras - - This interface is deprecated. - This interface is only used by implementations of - com.google.ads.mediation.MediationAdapter, which has been deprecated in - favor of MediationAdapter. Extras for - new mediation adapters are passed in as a Bundle through - addNetworkExtrasBundle(Class, Bundle). -  - - - -
- -
- - - - - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/package-summary.html b/docs/html/reference/com/google/android/gms/ads/package-summary.html deleted file mode 100644 index ef7cb00fead6..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/package-summary.html +++ /dev/null @@ -1,945 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads

-
- -
- -
- - -
- Contains classes for Google Mobile Ads. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AdListener - A listener for receiving notifications during the lifecycle of an ad.  - - - -
AdRequest - An AdRequest contains targeting information used to fetch an ad.  - - - -
AdRequest.Builder - Builds an AdRequest.  - - - -
AdSize - The size of a banner ad.  - - - -
AdView - The View to display banner ads.  - - - -
InterstitialAd - Full-screen interstitial ads.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchase.html b/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchase.html deleted file mode 100644 index ff68e3fb5cbb..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchase.html +++ /dev/null @@ -1,1439 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InAppPurchase | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

InAppPurchase

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.purchase.InAppPurchase
- - - - - - - -
- - -

Class Overview

-

Contains information about a purchase. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRESOLUTION_CANCELED - A resolution indicating the purchase was canceled. - - - -
intRESOLUTION_FAILURE - A resolution indicating the purchase failed. - - - -
intRESOLUTION_INVALID_PRODUCT - A resolution indicating the product is invalid. - - - -
intRESOLUTION_SUCCESS - A resolution indicating the purchase was successful. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getProductId() - -
- Returns the product ID (SKU). - - - -
- -
- abstract - - - - - void - - recordPlayBillingResolution(int billingResponseCode) - -
- Records the purchase status and conversion events for a play billing purchase. - - - -
- -
- abstract - - - - - void - - recordResolution(int resolution) - -
- Records the purchase status and conversion events. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESOLUTION_CANCELED -

-
- - - - -
-
- - - - -

A resolution indicating the purchase was canceled.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_FAILURE -

-
- - - - -
-
- - - - -

A resolution indicating the purchase failed.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_INVALID_PRODUCT -

-
- - - - -
-
- - - - -

A resolution indicating the product is invalid.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_SUCCESS -

-
- - - - -
-
- - - - -

A resolution indicating the purchase was successful.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getProductId - () -

-
-
- - - -
-
- - - - -

Returns the product ID (SKU). -

- -
-
- - - - -
-

- - public - - - abstract - - void - - recordPlayBillingResolution - (int billingResponseCode) -

-
-
- - - -
-
- - - - -

Records the purchase status and conversion events for a play billing purchase. If this method - is not called, conversion events will be lost. -

- If the purchase is made fulfilled by a billing service other than Google Play billing, use - recordResolution(int) instead. -

-

- The Google Conversion Tracking SDK is required to report conversion events. -

-
-
Parameters
- - -
billingResponseCode - The result of a play billing purchase. The value can be any - billing response code from - - -
-

- - public - - - abstract - - void - - recordResolution - (int resolution) -

-
-
- - - -
-
- - - - -

Records the purchase status and conversion events. If this method is not called, conversion - events will be lost. -

- If the purchase is made fulfilled by Google Play billing, use - recordPlayBillingResolution(int) instead. -

-

- The Google Conversion Tracking SDK is required to report conversion events. -

-
-
Parameters
- - - - -
resolution - The result of a purchase. The value can be - RESOLUTION_SUCCESS, RESOLUTION_FAILURE, - RESOLUTION_INVALID_PRODUCT or RESOLUTION_CANCELED -
-
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseListener.html b/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseListener.html deleted file mode 100644 index 1957d93148e4..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseListener.html +++ /dev/null @@ -1,1076 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InAppPurchaseListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

InAppPurchaseListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.purchase.InAppPurchaseListener
- - - - - - - -
- - -

Class Overview

-

A listener interface for In-App Purchase triggered by ads. The ad can trigger an In-App Purchase - with an InAppPurchase containing product id(SKU). The application then decides how to - conduct the purchase. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onInAppPurchaseRequested(InAppPurchase inAppPurchase) - -
- Called when the user clicks an In-App purchase ad. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onInAppPurchaseRequested - (InAppPurchase inAppPurchase) -

-
-
- - - -
-
- - - - -

Called when the user clicks an In-App purchase ad. - - The publisher is responsible for starting an In-App purchase flow, and calling - recordResolution(int) or - recordPlayBillingResolution(int) when the In-App purchase flow is - completed to report the resolution.

-
-
Parameters
- - - - -
inAppPurchase - The InAppPurchase containing the information about the purchase. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseResult.html b/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseResult.html deleted file mode 100644 index c1e45c770feb..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/purchase/InAppPurchaseResult.html +++ /dev/null @@ -1,1285 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InAppPurchaseResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

InAppPurchaseResult

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.purchase.InAppPurchaseResult
- - - - - - - -
- - -

Class Overview

-

Contains information about the result of a default purchase. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - finishPurchase() - -
- Call this method after you finish delivering the product. - - - -
- -
- abstract - - - - - String - - getProductId() - -
- Returns the product ID (SKU). - - - -
- -
- abstract - - - - - Intent - - getPurchaseData() - -
- Returns the response Intent. - - - -
- -
- abstract - - - - - int - - getResultCode() - -
- Returns the Activity result code of in-app billing request. - - - -
- -
- abstract - - - - - boolean - - isVerified() - -
- Returns true if the purchase is successfully verified. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - finishPurchase - () -

-
-
- - - -
-
- - - - -

Call this method after you finish delivering the product. If this method is not called, the - purchase will not get consumed. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getProductId - () -

-
-
- - - -
-
- - - - -

Returns the product ID (SKU). -

- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getPurchaseData - () -

-
-
- - - -
-
- - - - -

Returns the response Intent. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getResultCode - () -

-
-
- - - -
-
- - - - -

Returns the Activity result code of in-app billing request. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isVerified - () -

-
-
- - - -
-
- - - - -

Returns true if the purchase is successfully verified. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/purchase/PlayStorePurchaseListener.html b/docs/html/reference/com/google/android/gms/ads/purchase/PlayStorePurchaseListener.html deleted file mode 100644 index 80352ec4f0b8..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/purchase/PlayStorePurchaseListener.html +++ /dev/null @@ -1,1139 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlayStorePurchaseListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

PlayStorePurchaseListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.ads.purchase.PlayStorePurchaseListener
- - - - - - - -
- - -

Class Overview

-

Interface definition for implementing an in-app purchase using the default purchase flow. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - isValidPurchase(String productId) - -
- Called when the user triggers an in-app purchase. - - - -
- -
- abstract - - - - - void - - onInAppPurchaseFinished(InAppPurchaseResult inAppPurchaseResult) - -
- Called when the user has completed an in-app purchase transaction. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - isValidPurchase - (String productId) -

-
-
- - - -
-
- - - - -

Called when the user triggers an in-app purchase. Return true if this purchase is - valid.

-
-
Parameters
- - - - -
productId - The product ID (SKU) of the requested product. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onInAppPurchaseFinished - (InAppPurchaseResult inAppPurchaseResult) -

-
-
- - - -
-
- - - - -

Called when the user has completed an in-app purchase transaction. - - The publisher is responsible for crediting the user with the product, and calling - finishPurchase() to consume the purchase.

-
-
Parameters
- - - - -
inAppPurchaseResult - The InAppPurchaseResult containing the result of the - purchase. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/purchase/package-summary.html b/docs/html/reference/com/google/android/gms/ads/purchase/package-summary.html deleted file mode 100644 index 6e827a6ee407..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/purchase/package-summary.html +++ /dev/null @@ -1,923 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.purchase | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.purchase

-
- -
- -
- - -
- Contains classes for In-App Purchase Ads. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
InAppPurchase - Contains information about a purchase.  - - - -
InAppPurchaseListener - A listener interface for In-App Purchase triggered by ads.  - - - -
InAppPurchaseResult - Contains information about the result of a default purchase.  - - - -
PlayStorePurchaseListener - Interface definition for implementing an in-app purchase using the default purchase flow.  - - - -
- -
- - - - - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.Builder.html b/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.Builder.html deleted file mode 100644 index 42e1c5a43084..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.Builder.html +++ /dev/null @@ -1,2614 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAdRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

SearchAdRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.search.SearchAdRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builds a SearchAdRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SearchAdRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SearchAdRequest.Builder - - addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) - -
- Add extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - SearchAdRequest.Builder - - addNetworkExtras(NetworkExtras networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - SearchAdRequest.Builder - - addNetworkExtrasBundle(Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) - -
- Add extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - SearchAdRequest.Builder - - addTestDevice(String deviceId) - -
- Causes a device to receive test ads. - - - -
- -
- - - - - - SearchAdRequest - - build() - -
- Constructs a SearchAdRequest with the specified attributes. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setAnchorTextColor(int anchorTextColor) - -
- Sets the color of the ad URL. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setBackgroundColor(int backgroundColor) - -
- Sets the background color of the ad. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setBackgroundGradient(int top, int bottom) - -
- Sets a gradient for the ad background. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setBorderColor(int borderColor) - -
- Sets the border color of the ad container. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setBorderThickness(int borderThickness) - -
- Sets the thickness of the border in pixels around the ad container. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setBorderType(int borderType) - -
- Sets the type of border around the ad container. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setCallButtonColor(int callButtonColor) - -
- Sets the color of the call button when a call extension is shown. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setCustomChannels(String channelIds) - -
- Sets custom channels for the ad request. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setDescriptionTextColor(int descriptionTextColor) - -
- Sets the color of the ad description. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setFontFace(String fontFace) - -
- Sets the font used to render the ad. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setHeaderTextColor(int headerTextColor) - -
- Sets the text color of the ad header. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setHeaderTextSize(int headerTextSize) - -
- Sets the font size of the header text in pixels. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setLocation(Location location) - -
- Sets the user's location for targeting purposes. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setQuery(String query) - -
- Sets the query for requesting a search ad. - - - -
- -
- - - - - - SearchAdRequest.Builder - - setRequestAgent(String requestAgent) - -
- Sets the request agent string to identify the ad request's origin. - - - -
- -
- - - - - - SearchAdRequest.Builder - - tagForChildDirectedTreatment(boolean tagForChildDirectedTreatment) - -
- This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SearchAdRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SearchAdRequest.Builder - - addCustomEventExtrasBundle - (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific custom event adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the custom event adapter for which you are - providing extras.
customEventExtras - A Bundle of extra information to pass to a custom event - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - addNetworkExtras - (NetworkExtras networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter. networkExtras - should be an instance of com.google.ads.mediation.NetworkExtras, which is - provided by ad network adapters. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - addNetworkExtrasBundle - (Class<? extends MediationAdapter> adapterClass, Bundle networkExtras) -

-
-
- - - -
-
- - - - -

Add extra parameters to pass to a specific ad network adapter.

-
-
Parameters
- - - - - - - -
adapterClass - The Class of the adapter for the network for which you are - providing extras.
networkExtras - A Bundle of extra information to pass to a mediation - adapter. -
-
- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - addTestDevice - (String deviceId) -

-
-
- - - -
-
- - - - -

Causes a device to receive test ads. The deviceId can be obtained by viewing the - logcat output after creating a new ad. For emulators, use - DEVICE_ID_EMULATOR. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest - - build - () -

-
-
- - - -
-
- - - - -

Constructs a SearchAdRequest with the specified attributes. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setAnchorTextColor - (int anchorTextColor) -

-
-
- - - -
-
- - - - -

Sets the color of the ad URL. Transparency is not supported. rgb(int, int, int) can be - used to specify this color. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setBackgroundColor - (int backgroundColor) -

-
-
- - - -
-
- - - - -

Sets the background color of the ad. Calling this method will override any previous calls - to setBackgroundColor(int) or setBackgroundGradient(int, int). Transparency is not - supported. rgb(int, int, int) can be used to specify this color. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setBackgroundGradient - (int top, int bottom) -

-
-
- - - -
-
- - - - -

Sets a gradient for the ad background. Calling this method will override any previous - calls to setBackgroundColor(int) or setBackgroundGradient(int, int). Transparency is - not supported. rgb(int, int, int) can be used to specify these colors.

-
-
Parameters
- - - - - - - -
top - The color of the gradient at the top of the ad.
bottom - The color of the gradient at the bottom of the ad. -
-
- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setBorderColor - (int borderColor) -

-
-
- - - -
-
- - - - -

Sets the border color of the ad container. Transparency is not supported. - rgb(int, int, int) can be used to specify this color. This setting is ignored if - setBorderType(int) is set to BORDER_TYPE_NONE. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setBorderThickness - (int borderThickness) -

-
-
- - - -
-
- - - - -

Sets the thickness of the border in pixels around the ad container. This setting is - ignored if setBorderType(int) is set to BORDER_TYPE_NONE. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setBorderType - (int borderType) -

-
-
- - - -
-
- - - - -

Sets the type of border around the ad container. This value must be one of - BORDER_TYPE_NONE, BORDER_TYPE_DASHED, BORDER_TYPE_DOTTED, - BORDER_TYPE_SOLID. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setCallButtonColor - (int callButtonColor) -

-
-
- - - -
-
- - - - -

Sets the color of the call button when a call extension is shown. This value must be one - of CALL_BUTTON_COLOR_DARK, CALL_BUTTON_COLOR_LIGHT, - CALL_BUTTON_COLOR_MEDIUM. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setCustomChannels - (String channelIds) -

-
-
- - - -
-
- - - - -

Sets custom channels for the ad request. Custom channels allow publishers to track the - performance of specific groups of ads. These custom channels need to created on the - AdSense website. Reports can then be created based on the channels.

-
-
Parameters
- - - - -
channelIds - A list of channel IDs separated by '+'. -
-
- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setDescriptionTextColor - (int descriptionTextColor) -

-
-
- - - -
-
- - - - -

Sets the color of the ad description. Transparency is not supported. rgb(int, int, int) - can be used to specify this color. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setFontFace - (String fontFace) -

-
-
- - - -
-
- - - - -

Sets the font used to render the ad. The same font is used in the header, the description - and the anchor. Fonts are specified using the same value that would be used in CSS (e.g., - "arial"). -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setHeaderTextColor - (int headerTextColor) -

-
-
- - - -
-
- - - - -

Sets the text color of the ad header. Transparency is not supported. rgb(int, int, int) - can be used to specify this color. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setHeaderTextSize - (int headerTextSize) -

-
-
- - - -
-
- - - - -

Sets the font size of the header text in pixels. The font sizes for the description and - the anchor are determined from the header size. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setLocation - (Location location) -

-
-
- - - -
-
- - - - -

Sets the user's location for targeting purposes. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setQuery - (String query) -

-
-
- - - -
-
- - - - -

Sets the query for requesting a search ad. The query must be set to receive an ad. -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - setRequestAgent - (String requestAgent) -

-
-
- - - -
-
- - - - -

Sets the request agent string to identify the ad request's origin. Third party libraries - that reference the Mobile Ads SDK should call this method to denote the platform from - which the ad request originated. For example, if a third party ad network called - "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method - with "CoolAds". -

- -
-
- - - - -
-

- - public - - - - - SearchAdRequest.Builder - - tagForChildDirectedTreatment - (boolean tagForChildDirectedTreatment) -

-
-
- - - -
-
- - - - -

This method allows you to specify whether you would like your app to be treated as - child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - - - http://business.ftc.gov/privacy-and-security/childrens-privacy. -

- If you set this method to true, you will indicate that your app should be treated - as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA). -

- If you set this method to false, you will indicate that your app should not be - treated as child-directed for purposes of the Children’s Online Privacy Protection Act - (COPPA). -

- If you do not set this method, ad requests will include no indication of how you would - like your app treated with respect to COPPA. -

- By setting this method, you certify that this notification is accurate and you are - authorized to act on behalf of the owner of the app. You understand that abuse of this - setting may result in termination of your Google account. -

- Note: it may take some time for this designation to be fully implemented in applicable - Google services. -

- This designation will only apply to ad requests for which you have set this method.

-
-
Parameters
- - - - -
tagForChildDirectedTreatment - Set to true to indicate that your app should - be treated as child-directed. Set to false to indicate that your app - should not be treated as child-directed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.html b/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.html deleted file mode 100644 index 4ff404c3f469..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/search/SearchAdRequest.html +++ /dev/null @@ -1,3035 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAdRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SearchAdRequest

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.ads.search.SearchAdRequest
- - - - - - - -
- - -

Class Overview

-

A SearchAdRequest contains targeting information used to fetch an ad from Search Ads for - Apps. Ad requests are created using SearchAdRequest.Builder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSearchAdRequest.Builder - Builds a SearchAdRequest.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBORDER_TYPE_DASHED - Dashed border. - - - -
intBORDER_TYPE_DOTTED - Dotted border. - - - -
intBORDER_TYPE_NONE - No border. - - - -
intBORDER_TYPE_SOLID - Solid border. - - - -
intCALL_BUTTON_COLOR_DARK - Dark-colored call button. - - - -
intCALL_BUTTON_COLOR_LIGHT - Light-colored call button. - - - -
intCALL_BUTTON_COLOR_MEDIUM - Medium-colored call button. - - - -
intERROR_CODE_INTERNAL_ERROR - Something happened internally; for instance, an invalid response was received from the ad - server. - - - -
intERROR_CODE_INVALID_REQUEST - The ad request was invalid; for instance, the ad unit ID was incorrect. - - - -
intERROR_CODE_NETWORK_ERROR - The ad request was unsuccessful due to network connectivity. - - - -
intERROR_CODE_NO_FILL - The ad request was successful, but no ad was returned due to lack of ad inventory. - - - -
- - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - StringDEVICE_ID_EMULATOR - The deviceId for emulators to be used with - addTestDevice(String). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getAnchorTextColor() - -
- Returns the color of the ad URL. - - - -
- -
- - - - - - int - - getBackgroundColor() - -
- Returns the background color of the ad. - - - -
- -
- - - - - - int - - getBackgroundGradientBottom() - -
- Returns the color of the background gradient at the bottom of the ad. - - - -
- -
- - - - - - int - - getBackgroundGradientTop() - -
- Returns the color of the background gradient at the top of the ad. - - - -
- -
- - - - - - int - - getBorderColor() - -
- Returns the border color of the ad container. - - - -
- -
- - - - - - int - - getBorderThickness() - -
- Returns the thickness of the border in pixels around the ad container. - - - -
- -
- - - - - - int - - getBorderType() - -
- Returns the type of border around the ad container. - - - -
- -
- - - - - - int - - getCallButtonColor() - -
- Returns the color of the call button when a call extension is shown. - - - -
- -
- - - - - - String - - getCustomChannels() - -
- Returns the custom channels for the ad request. - - - -
- -
- - - - - <T extends CustomEvent> - Bundle - - getCustomEventExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific custom event adapter. - - - -
- -
- - - - - - int - - getDescriptionTextColor() - -
- Returns the color of the ad description. - - - -
- -
- - - - - - String - - getFontFace() - -
- Returns the font used to render the ad. - - - -
- -
- - - - - - int - - getHeaderTextColor() - -
- Returns the font size of the header text in pixels. - - - -
- -
- - - - - - int - - getHeaderTextSize() - -
- Returns the font size of the header text in pixels. - - - -
- -
- - - - - - Location - - getLocation() - -
- Returns the user's location targeting information. - - - -
- -
- - - - - <T extends NetworkExtras> - T - - getNetworkExtras(Class<T> networkExtrasClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - <T extends MediationAdapter> - Bundle - - getNetworkExtrasBundle(Class<T> adapterClass) - -
- Returns extra parameters to pass to a specific ad network adapter. - - - -
- -
- - - - - - String - - getQuery() - -
- Returns the query of the search ad request. - - - -
- -
- - - - - - boolean - - isTestDevice(Context context) - -
- Returns true if this device will receive test ads. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - BORDER_TYPE_DASHED -

-
- - - - -
-
- - - - -

Dashed border.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BORDER_TYPE_DOTTED -

-
- - - - -
-
- - - - -

Dotted border.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BORDER_TYPE_NONE -

-
- - - - -
-
- - - - -

No border.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BORDER_TYPE_SOLID -

-
- - - - -
-
- - - - -

Solid border.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CALL_BUTTON_COLOR_DARK -

-
- - - - -
-
- - - - -

Dark-colored call button.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CALL_BUTTON_COLOR_LIGHT -

-
- - - - -
-
- - - - -

Light-colored call button.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CALL_BUTTON_COLOR_MEDIUM -

-
- - - - -
-
- - - - -

Medium-colored call button.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INTERNAL_ERROR -

-
- - - - -
-
- - - - -

Something happened internally; for instance, an invalid response was received from the ad - server. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INVALID_REQUEST -

-
- - - - -
-
- - - - -

The ad request was invalid; for instance, the ad unit ID was incorrect. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NETWORK_ERROR -

-
- - - - -
-
- - - - -

The ad request was unsuccessful due to network connectivity. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_NO_FILL -

-
- - - - -
-
- - - - -

The ad request was successful, but no ad was returned due to lack of ad inventory. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - String - - DEVICE_ID_EMULATOR -

-
- - - - -
-
- - - - -

The deviceId for emulators to be used with - addTestDevice(String). -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getAnchorTextColor - () -

-
-
- - - -
-
- - - - -

Returns the color of the ad URL. -

- -
-
- - - - -
-

- - public - - - - - int - - getBackgroundColor - () -

-
-
- - - -
-
- - - - -

Returns the background color of the ad. -

- -
-
- - - - -
-

- - public - - - - - int - - getBackgroundGradientBottom - () -

-
-
- - - -
-
- - - - -

Returns the color of the background gradient at the bottom of the ad. -

- -
-
- - - - -
-

- - public - - - - - int - - getBackgroundGradientTop - () -

-
-
- - - -
-
- - - - -

Returns the color of the background gradient at the top of the ad. -

- -
-
- - - - -
-

- - public - - - - - int - - getBorderColor - () -

-
-
- - - -
-
- - - - -

Returns the border color of the ad container. -

- -
-
- - - - -
-

- - public - - - - - int - - getBorderThickness - () -

-
-
- - - -
-
- - - - -

Returns the thickness of the border in pixels around the ad container. -

- -
-
- - - - -
-

- - public - - - - - int - - getBorderType - () -

-
-
- - - -
-
- - - - -

Returns the type of border around the ad container. -

- -
-
- - - - -
-

- - public - - - - - int - - getCallButtonColor - () -

-
-
- - - -
-
- - - - -

Returns the color of the call button when a call extension is shown. -

- -
-
- - - - -
-

- - public - - - - - String - - getCustomChannels - () -

-
-
- - - -
-
- - - - -

Returns the custom channels for the ad request. Custom channels allow publishers to track the - performance of specific groups of ads. These custom channels need to created on the AdSense - website. Reports can then be created based on the channels. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getCustomEventExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific custom event adapter. Returns null if - no custom event extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - int - - getDescriptionTextColor - () -

-
-
- - - -
-
- - - - -

Returns the color of the ad description. -

- -
-
- - - - -
-

- - public - - - - - String - - getFontFace - () -

-
-
- - - -
-
- - - - -

Returns the font used to render the ad. The same font is used in the header, the description - and the anchor. -

- -
-
- - - - -
-

- - public - - - - - int - - getHeaderTextColor - () -

-
-
- - - -
-
- - - - -

Returns the font size of the header text in pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - getHeaderTextSize - () -

-
-
- - - -
-
- - - - -

Returns the font size of the header text in pixels. The font sizes for the description and - the anchor are determined from the header size. -

- -
-
- - - - -
-

- - public - - - - - Location - - getLocation - () -

-
-
- - - -
-
- - - - -

Returns the user's location targeting information. Returns null if the location was - not set. -

- -
-
- - - - -
-

- - public - - - - - T - - getNetworkExtras - (Class<T> networkExtrasClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Ad network adapters - provide a NetworkExtras class. Returns null if no network extras of the - provided type were set. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - getNetworkExtrasBundle - (Class<T> adapterClass) -

-
-
- - - -
-
- - - - -

Returns extra parameters to pass to a specific ad network adapter. Returns null if no - network extras of the provided type were set. -

- -
-
- - - - -
-

- - public - - - - - String - - getQuery - () -

-
-
- - - -
-
- - - - -

Returns the query of the search ad request. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isTestDevice - (Context context) -

-
-
- - - -
-
- - - - -

Returns true if this device will receive test ads. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/search/SearchAdView.html b/docs/html/reference/com/google/android/gms/ads/search/SearchAdView.html deleted file mode 100644 index 07443aa072af..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/search/SearchAdView.html +++ /dev/null @@ -1,15648 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAdView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - XML Attrs - - - - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SearchAdView

- - - - - - - - - - - - - extends ViewGroup
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳com.google.android.gms.ads.search.SearchAdView
- - - - - - - -
- - -

Class Overview

-

The View to display search banner ads for use with Search Ads for Apps. The - ad size and ad unit ID must be set prior to calling loadAd(SearchAdRequest). -

- Sample code: - 

- public class MyActivity extends Activity {
-     private SearchAdView mSearchAdView;
-
-     @Override
-     public void onCreate(Bundle savedInstanceState) {
-         super.onCreate(savedInstanceState);
-
-         LinearLayout layout = new LinearLayout(this);
-         layout.setOrientation(LinearLayout.VERTICAL);
-
-         // Create a banner ad. The ad size and ad unit ID must be set before calling loadAd.
-         mSearchAdView = new SearchAdView(this);
-         mSearchAdView.setAdSize(AdSize.SMART_BANNER);
-         mSearchAdView.setAdUnitId("myAdUnitId");
-
-         // Create an ad request.
-         SearchAdRequest.Builder searchAdRequestBuilder = new SearchAdRequest.Builder();
-
-         // Optionally populate the ad request builder.
-         searchAdRequestBuilder.addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
-
-         // Add the SearchAdView to the view hierarchy.
-         layout.addView(mSearchAdView);
-
-         // Start loading the ad.
-         mSearchAdView.loadAd(searchAdRequestBuilder.build());
-
-         setContentView(layout);
-     }
-
-     @Override
-     public void onResume() {
-         super.onResume();
-
-         // Resume the SearchAdView.
-         mSearchAdView.resume();
-     }
-
-     @Override
-     public void onPause() {
-         // Pause the SearchAdView.
-         mSearchAdView.pause();
-
-         super.onPause();
-     }
-
-     @Override
-     public void onDestroy() {
-         // Destroy the SearchAdView.
-         mSearchAdView.destroy();
-
-         super.onDestroy();
-     }
- }

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
XML Attributes
Attribute NameRelated MethodDescription
com.google.android.gms:adSize - setAdSize(AdSize) - - -   - - - -
com.google.android.gms:adUnitId - setAdUnitId(String) - - -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SearchAdView(Context context) - -
- Construct a SearchAdView from code. - - - -
- -
- - - - - - - - SearchAdView(Context context, AttributeSet attrs) - -
- Construct a SearchAdView from an XML layout. - - - -
- -
- - - - - - - - SearchAdView(Context context, AttributeSet attrs, int defStyle) - -
- Construct a SearchAdView from an XML layout. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - destroy() - -
- Destroy the SearchAdView. - - - -
- -
- - - - - - AdListener - - getAdListener() - -
- Returns the AdListener for this SearchAdView. - - - -
- -
- - - - - - AdSize - - getAdSize() - -
- Returns the size of the banner ad. - - - -
- -
- - - - - - String - - getAdUnitId() - -
- Returns the ad unit ID. - - - -
- -
- - - - - - void - - loadAd(SearchAdRequest searchAdRequest) - -
- Start loading the ad on a background thread. - - - -
- -
- - - - - - void - - pause() - -
- Pause any extra processing associated with this SearchAdView. - - - -
- -
- - - - - - void - - resume() - -
- Resume an SearchAdView after a previous call to pause(). - - - -
- -
- - - - - - void - - setAdListener(AdListener adListener) - -
- Sets an AdListener for this SearchAdView. - - - -
- -
- - - - - - void - - setAdSize(AdSize adSize) - -
- Sets the size of the banner ad. - - - -
- -
- - - - - - void - - setAdUnitId(String adUnitId) - -
- Sets the ad unit ID. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - void - - onLayout(boolean changed, int left, int top, int right, int bottom) - -
- - - - - - void - - onMeasure(int widthMeasureSpec, int heightMeasureSpec) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - -

XML Attributes

- - - - -
-

com.google.android.gms:adSize -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - -
-

com.google.android.gms:adUnitId -

-
- - - - -

- - -
-
Related Methods
- -
-
-
- - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SearchAdView - (Context context) -

-
-
- - - -
-
- - - - -

Construct a SearchAdView from code.

-
-
Parameters
- - - - -
context - The Context the SearchAdView is running in. -
-
- -
-
- - - - -
-

- - public - - - - - - - SearchAdView - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Construct a SearchAdView from an XML layout. -

- -
-
- - - - -
-

- - public - - - - - - - SearchAdView - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

Construct a SearchAdView from an XML layout. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - destroy - () -

-
-
- - - -
-
- - - - -

Destroy the SearchAdView. This method should be called in the parent Activity's - onDestroy() method. No other methods should be called on the - SearchAdView after destroy() is called. -

- -
-
- - - - -
-

- - public - - - - - AdListener - - getAdListener - () -

-
-
- - - -
-
- - - - -

Returns the AdListener for this SearchAdView. -

- -
-
- - - - -
-

- - public - - - - - AdSize - - getAdSize - () -

-
-
- - - -
-
- - - - -

Returns the size of the banner ad. Returns null if setAdSize(AdSize) hasn't been - called yet.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - String - - getAdUnitId - () -

-
-
- - - -
-
- - - - -

Returns the ad unit ID.

-
-
Related XML Attributes
- -
- -
-
- - - - -
-

- - public - - - - - void - - loadAd - (SearchAdRequest searchAdRequest) -

-
-
- - - -
-
- - - - -

Start loading the ad on a background thread.

-
-
Throws
- - - - -
IllegalStateException - If the size of the banner ad or the ad unit ID have not been - set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - pause - () -

-
-
- - - -
-
- - - - -

Pause any extra processing associated with this SearchAdView. This method should be - called in the parent Activity's onPause() method. -

- -
-
- - - - -
-

- - public - - - - - void - - resume - () -

-
-
- - - -
-
- - - - -

Resume an SearchAdView after a previous call to pause(). This method should - be called in the parent Activity's onResume() method. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdListener - (AdListener adListener) -

-
-
- - - -
-
- - - - -

Sets an AdListener for this SearchAdView. -

- -
-
- - - - -
-

- - public - - - - - void - - setAdSize - (AdSize adSize) -

-
-
- - - -
-
- - - - -

Sets the size of the banner ad.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalStateException - If the size of the banner ad was already set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAdUnitId - (String adUnitId) -

-
-
- - - -
-
- - - - -

Sets the ad unit ID.

-
-
Related XML Attributes
- -
-
-
Throws
- - - - -
IllegalStateException - If the ad unit ID was already set. -
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - void - - onLayout - (boolean changed, int left, int top, int right, int bottom) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - protected - - - - - void - - onMeasure - (int widthMeasureSpec, int heightMeasureSpec) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/ads/search/package-summary.html b/docs/html/reference/com/google/android/gms/ads/search/package-summary.html deleted file mode 100644 index dbdd34d8cb3d..000000000000 --- a/docs/html/reference/com/google/android/gms/ads/search/package-summary.html +++ /dev/null @@ -1,913 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.ads.search | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.ads.search

-
- -
- -
- - -
- Contains classes for Search Ads for Apps. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
SearchAdRequest - A SearchAdRequest contains targeting information used to fetch an ad from Search Ads for - Apps.  - - - -
SearchAdRequest.Builder - Builds a SearchAdRequest.  - - - -
SearchAdView - The View to display search banner ads for use with Search Ads for Apps.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/AnalyticsReceiver.html b/docs/html/reference/com/google/android/gms/analytics/AnalyticsReceiver.html deleted file mode 100644 index 413d112c6414..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/AnalyticsReceiver.html +++ /dev/null @@ -1,1722 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AnalyticsReceiver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AnalyticsReceiver

- - - - - - - - - extends BroadcastReceiver
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.BroadcastReceiver
    ↳com.google.android.gms.analytics.AnalyticsReceiver
- - - - - - - -
- - -

Class Overview

-

A BroadcastReceiver used by Google Analytics. It will only be used when - the receiver is correctly declared in the manifest and enabled:

- 

<manifest>
-   <application>
-     <!-- ... -->
-
-     <receiver android:name="com.google.android.gms.analytics.AnalyticsReceiver"
-         android:enabled="true">
-         <intent-filter>
-             <action android:name="com.google.android.gms.analytics.ANALYTICS_DISPATCH" />
-         </intent-filter>
-     </receiver>
-
-     <!-- ... -->
-   </application>
- </manifest>
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AnalyticsReceiver() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onReceive(Context context, Intent intent) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.content.BroadcastReceiver - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AnalyticsReceiver - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onReceive - (Context context, Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/AnalyticsService.html b/docs/html/reference/com/google/android/gms/analytics/AnalyticsService.html deleted file mode 100644 index c69cffc55f8c..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/AnalyticsService.html +++ /dev/null @@ -1,6137 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AnalyticsService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AnalyticsService

- - - - - - - - - - - - - - - - - extends Service
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.analytics.AnalyticsService
- - - - - - - -
- - -

Class Overview

-

An Service used by Google Analytics. It will only be used when the service - is correctly declared in the manifest:

- 

<manifest>
-   <application>
-     <!-- ... -->
-
-     <service android:name="com.google.android.gms.analytics.AnalyticsService"
-         android:enabled="true"
-         android:exported="false"/>
-
-     <!-- ... -->
-   </application>
- </manifest>
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - IBinder - - onBind(Intent intent) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - IBinder - - onBind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingReceiver.html b/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingReceiver.html deleted file mode 100644 index cb5e6775c080..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingReceiver.html +++ /dev/null @@ -1,1778 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CampaignTrackingReceiver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CampaignTrackingReceiver

- - - - - - - - - extends BroadcastReceiver
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.BroadcastReceiver
    ↳com.google.android.gms.analytics.CampaignTrackingReceiver
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Google Analytics receiver for com.android.vending.INSTALL_REFERRER. Google Play will - broadcast the intent when an app is installed from the Google Play Store and has campaign data - available (i.e. the app was installed from a link to the Google Play Store). - This BroadcastReceiver registers for that Intent and passes the campaign data - to Google Analytics. - -

To enable installation campaign reporting register both CampaignTrackingReceiver and - CampaignTrackingService in your AndroidManifest.xml file: - - 

<manifest>
-   <application>
-     <!-- ... -->
-
-     <receiver android:name="com.google.android.gms.analytics.CampaignTrackingReceiver"
-         android:enabled="true">
-         <intent-filter>
-             <action android:name="com.android.vending.INSTALL_REFERRER" />
-         </intent-filter>
-     </receiver>
-     <service android:name="com.google.android.gms.analytics.CampaignTrackingService"
-         android:enabled="true"
-         android:exported="false"/>
-
-     <!-- ... -->
-   </application>
- </manifest>
-
- - Only one receiver can receive the install referrer setting. If Google Tag Manager is being used - by the application, then only the Google Tag Manager receiver needs to be enabled. The Google Tag - Manager receiver will invoke the Google Analytics receiver automatically. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CampaignTrackingReceiver() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onReceive(Context context, Intent intent) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.content.BroadcastReceiver - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CampaignTrackingReceiver - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onReceive - (Context context, Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingService.html b/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingService.html deleted file mode 100644 index b8f9d39699c7..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/CampaignTrackingService.html +++ /dev/null @@ -1,6377 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CampaignTrackingService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CampaignTrackingService

- - - - - - - - - - - - - - - - - extends Service
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.analytics.CampaignTrackingService
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Service for processing Google Play Store's INSTALL_REFERRER intent. This service will be - launched by CampaignTrackingReceiver. See CampaignTrackingReceiver class for details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CampaignTrackingService() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - IBinder - - onBind(Intent intent) - -
- - - - - - void - - onCreate() - -
- - - - - - void - - onDestroy() - -
- - - - - - int - - onStartCommand(Intent intent, int flags, int startId) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CampaignTrackingService - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - IBinder - - onBind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - onStartCommand - (Intent intent, int flags, int startId) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ExceptionParser.html b/docs/html/reference/com/google/android/gms/analytics/ExceptionParser.html deleted file mode 100644 index b66b9675b843..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ExceptionParser.html +++ /dev/null @@ -1,1154 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ExceptionParser | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

ExceptionParser

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.analytics.ExceptionParser
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

This interface is responsible for parsing a Throwable and providing - a short, meaningful description to report to Google Analytics. - - This class can be used in conjugation with the ExceptionReporter. - 

-
- UncaughtExceptionHandler myHandler = new ExceptionReporter(
-   myTracker,                                     // Currently used Tracker.
-   GAServiceManager.getInstance(),                // GAServiceManager singleton.
-   Thread.getDefaultUncaughtExceptionHandler(),   // Current default uncaught exception handler.
-   context);                                      // Context of the application.
-
- myHandler.setExceptionParser(new MyExceptionParser());
- // Where MyExceptionParser provides a custom description for various exceptions.
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDescription(String threadName, Throwable t) - -
- Return a short description of a Throwable suitable for - reporting to Google Analytics. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDescription - (String threadName, Throwable t) -

-
-
- - - -
-
- - - - -

Return a short description of a Throwable suitable for - reporting to Google Analytics.

-
-
Parameters
- - - - - - - -
threadName - the name of the Thread that got the exception, or null
t - the Throwable
-
-
-
Returns
-
  • the description -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ExceptionReporter.html b/docs/html/reference/com/google/android/gms/analytics/ExceptionReporter.html deleted file mode 100644 index a64e3563aebf..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ExceptionReporter.html +++ /dev/null @@ -1,1554 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ExceptionReporter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ExceptionReporter

- - - - - extends Object
- - - - - - - implements - - Thread.UncaughtExceptionHandler - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.ExceptionReporter
- - - - - - - -
- - -

Class Overview

-

Used to catch any uncaught exceptions and report them to Google Analytics. This class will call - dispatchLocalHits() after calling send(Map).

The exact - message reported is determined by the ExceptionParser set via the setExceptionParser(ExceptionParser) method. See StandardExceptionParser for an example of an - implementation of ExceptionParser.

All exceptions reported via this class will be - reported as fatal exceptions.

- - Usage: - 

- UncaughtExceptionHandler myHandler = new ExceptionReporter(
-   myTracker,                                     // Currently used Tracker.
-   Thread.getDefaultUncaughtExceptionHandler(),   // Current default uncaught exception handler.
-   context);                                      // Context of the application.
-
- // Make myHandler the new default uncaught exception handler.
- Thread.setDefaultUncaughtExceptionHandler(myHandler);
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ExceptionReporter(Tracker tracker, Thread.UncaughtExceptionHandler originalHandler, Context context) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - ExceptionParser - - getExceptionParser() - -
- - - - - - void - - setExceptionParser(ExceptionParser exceptionParser) - -
- - - - - - void - - uncaughtException(Thread t, Throwable e) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - java.lang.Thread.UncaughtExceptionHandler - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ExceptionReporter - (Tracker tracker, Thread.UncaughtExceptionHandler originalHandler, Context context) -

-
-
- - - -
-
- - - - -

-
-
Parameters
- - - - - - - - - - -
tracker - an active Tracker instance. Should not be null.
originalHandler - the current DefaultUncaughtExceptionHandler.
context - the current app context. Should not be null. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - ExceptionParser - - getExceptionParser - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setExceptionParser - (ExceptionParser exceptionParser) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - uncaughtException - (Thread t, Throwable e) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/GoogleAnalytics.html b/docs/html/reference/com/google/android/gms/analytics/GoogleAnalytics.html deleted file mode 100644 index 6be5003725b5..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/GoogleAnalytics.html +++ /dev/null @@ -1,2309 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleAnalytics | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GoogleAnalytics

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.GoogleAnalytics
- - - - - - - -
- - -

Class Overview

-

The top level Google Analytics singleton that provides methods for configuring Google Analytics - and creating Tracker objects. - -

Applications can get an instance of this class by calling getInstance(Context). - getInstance(Context) is thread safe and can be called from any thread. It is recommended that - Google Analytics be initialized early in the application lifecycle to correctly report unhandled - exceptions. - Application.onCreate() is the recommended place for configuring - Google Analytics. - -

A basic configuration of Google Analytics look like this: - 

- package com.example;
-
- class MyApp extends Application {
-   public static GoogleAnalytics analytics;
-   public static Tracker tracker;
-
-   @Overwrite
-   public void onCreate() {
-     analytics = GoogleAnalytics.getInstance(this);
-     analytics.setLocalDispatchPeriod(1800);
-
-     tracker = analytics.newTracker("UA-000-1"); // Replace with actual tracker id
-     tracker.enableExceptionReporting(true);
-     tracker.enableAdvertisingIdCollection(true);
-     tracker.enableAutoActivityTracking(true);
-   }
- }
-
- Analytics requires INTERNET and ACCESS_NETWORK_STATE permissions. Optionally a WAKE_LOCK - permission can be requested to improve dispatching on non-Google Play devices. - - To use a custom application class such as MyApp, it needs to be set in the AndroidManifest as - the application name attribute. - - A snippet for common GoogleAnalytics configuration in ApplicationManifest.xml looks - like this: - - 
- <manifest>
-   <!-- Google Analytics required permissions -->
-   <uses-permission android:name="android.permission.INTERNET" />
-   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-
-   <!-- Optional permission for reliable local dispatching on non-Google Play devices -->
-   <uses-permission android:name="android.permission.WAKE_LOCK" />
-
-   <application
-     name="com.example.MyApp"> <!-- Replace with the custom app class when applicable -->
-
-     <!-- Add the following meta-data for devices running Google Play service. -->
-     <meta-data
-       android:name="com.google.android.gms.version"
-       android:value="@integer/google_play_services_version" />
-
-     <!-- Optionally, register AnalyticsReceiver and AnalyticsService to support background
-          dispatching on non-Google Play devices -->
-     <receiver android:name="com.google.android.gms.analytics.AnalyticsReceiver"
-         android:enabled="true">
-         <intent-filter>
-             <action android:name="com.google.android.gms.analytics.ANALYTICS_DISPATCH" />
-         </intent-filter>
-     </receiver>
-     <service android:name="com.google.android.gms.analytics.AnalyticsService"
-         android:enabled="true"
-         android:exported="false"/>
-
-     <!-- Optionally, register CampaignTrackingReceiver and CampaignTrackingService to enable
-          installation campaign reporting -->
-     <receiver android:name="com.google.android.gms.analytics.CampaignTrackingReceiver"
-         android:exported="true">
-         <intent-filter>
-             <action android:name="com.android.vending.INSTALL_REFERRER" />
-         </intent-filter>
-     </receiver>
-     <service android:name="com.google.android.gms.analytics.CampaignTrackingService" />
-
-     <!-- ... -->
-   </application>
- </manifest>
-
- -

Applications can optionally provide a metadata reference to a global configuration XML - resource file in the <application> element of their AndroidManifest.xml: - - 

- <manifest>
-   <application>
-     <!-- ... -->
-
-     <meta-data
-       android:name="com.google.android.gms.analytics.globalConfigResource"
-       android:resource="@xml/analytics_global_config" />
-
-     <!-- ... -->
-   </application>
- </manifest>
-
- - The configuration file should be stored in the applications res/xml directory and it - should look like this: - - 
- <?xml version="1.0" encoding="utf-8" ?>
- <resources>
-     <!-- The application name. Defaults to name specified for the application label -->
-     <string name="ga_appName">My App</string>
-
-     <!-- The application version. Defaults to android:versionName specified in the
-       AndroidManifest.xml -->
-     <string name="ga_appVersion">1.0</string>
-
-     <!-- The dispatching period in seconds when Google Play services is unavailable. The
-     default period is 1800 seconds or 30 minutes -->
-     <integer name="ga_dispatchPeriod">1800</integer>
-
-     <!-- Enable dry run mode. Default is false -->
-     <bool name="ga_dryRun">false</bool>
- </resources>
-
- -

ga_logLevel setting is deprecated. See Logger interface for details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - dispatchLocalHits() - -
- Dispatches hits queued in the application store (views, events, or transactions) to Google - Analytics if a network connection is available. - - - -
- -
- - - - - - void - - enableAutoActivityReports(Application application) - -
- On devices running API level 14 (ICE_CREAM_SANDWICH) or above, applications can call this - method in lieu of making explicit calls to reportActivityStart(Activity) and reportActivityStop(Activity). - - - -
- -
- - - - - - boolean - - getAppOptOut() - -
- Returns whether the state of the application-level opt is on. - - - -
- -
- - - - static - - GoogleAnalytics - - getInstance(Context context) - -
- Gets the instance of the GoogleAnalytics, creating it when necessary. - - - -
- -
- - - - - - Logger - - getLogger() - -
- - This method is deprecated. - Logger interface is deprecated. See Logger interface for - details. - - - - -
- -
- - - - - - boolean - - isDryRunEnabled() - -
- Returns whether dry run mode is on. - - - -
- -
- - - - - - Tracker - - newTracker(String trackingId) - -
- Returns a Tracker instance with the given trackingId. - - - -
- -
- - - - - - Tracker - - newTracker(int configResId) - -
- Returns a Tracker instance preconfigured with the values specified in configResId. - - - -
- -
- - - - - - void - - reportActivityStart(Activity activity) - -
- Report the start of an Activity, so that it can be tracked by any Trackers - that have enabled auto activity tracking (see enableAutoActivityTracking(boolean).) - This will also start a new session if necessary. - - - -
- -
- - - - - - void - - reportActivityStop(Activity activity) - -
- Report the end of an Activity. - - - -
- -
- - - - - - void - - setAppOptOut(boolean optOut) - -
- Sets or resets the application-level opt out flag. - - - -
- -
- - - - - - void - - setDryRun(boolean dryRun) - -
- Toggles dry run mode. - - - -
- -
- - - - - - void - - setLocalDispatchPeriod(int dispatchPeriodInSeconds) - -
- Sets dispatch period for the local dispatcher. - - - -
- -
- - - - - - void - - setLogger(Logger logger) - -
- - This method is deprecated. - Logger interface is deprecated. See Logger interface for - details. - - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - dispatchLocalHits - () -

-
-
- - - -
-
- - - - -

Dispatches hits queued in the application store (views, events, or transactions) to Google - Analytics if a network connection is available. This method only works when Google Play - service is not available on the device and local dispatching is used. In general, - applications should not rely on the ability to dispatch hits manually. -

- -
-
- - - - -
-

- - public - - - - - void - - enableAutoActivityReports - (Application application) -

-
-
- - - -
-
- - - - -

On devices running API level 14 (ICE_CREAM_SANDWICH) or above, applications can call this - method in lieu of making explicit calls to reportActivityStart(Activity) and reportActivityStop(Activity). This method is a noop if called on a device running API level - less than 14.

-
-
Parameters
- - - - -
application - The Application whose activities starts and stops should be - automatically reported. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - getAppOptOut - () -

-
-
- - - -
-
- - - - -

Returns whether the state of the application-level opt is on. -

- -
-
- - - - -
-

- - public - static - - - - GoogleAnalytics - - getInstance - (Context context) -

-
-
- - - -
-
- - - - -

Gets the instance of the GoogleAnalytics, creating it when necessary. It is safe to - call this method from any thread. -

- -
-
- - - - -
-

- - public - - - - - Logger - - getLogger - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Logger interface is deprecated. See Logger interface for - details. - -

-

Return the current Logger implementation in use. If no Logger has been set, - a default Logger is provided that logs to android.util.Log - with Logger.LogLevel set to WARNING.

- -
-
- - - - -
-

- - public - - - - - boolean - - isDryRunEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether dry run mode is on. -

- -
-
- - - - -
-

- - public - - - - - Tracker - - newTracker - (String trackingId) -

-
-
- - - -
-
- - - - -

Returns a Tracker instance with the given trackingId. If the given trackingId is not null or empty, it will be set on the tracker and it is ready to send hits. - Calling newTracker() multiple times with the same trackingId will create multiple - Tracker objects with the same trackingId. - - If the trackingId is empty, you can still get a tracker, but you must set the - tracking id before sending any hits. This is useful if you do not know the tracking id at the - time of tracker creation, or if you want to use the same tracker instance to track multiple - tracking ids. Using the same instance to track multiple tracking ids is not recommended since - you need to be careful about not mixing the data you are sending to multiple profiles. It can - be useful if you have a lot of tracking ids and you want to avoid object creation overhead - involved in instantiating one tracker per tracking id.

-
-
Parameters
- - - - -
trackingId - string of the form UA-xxxx-y -
-
- -
-
- - - - -
-

- - public - - - - - Tracker - - newTracker - (int configResId) -

-
-
- - - -
-
- - - - -

Returns a Tracker instance preconfigured with the values specified in configResId. Calling newTracker() multiple times with the same trackingId will - create multiple Tracker objects with the same configuration. - - If the trackingId is empty, you can still get a tracker, but you must set the - tracking id before sending any hits. This is useful if you do not know the tracking id at the - time of tracker creation, or if you want to use the same tracker instance to track multiple - tracking ids. Using the same instance to track multiple tracking ids is not recommended since - you need to be careful about not mixing the data you are sending to multiple profiles. It can - be useful if you have a lot of tracking ids and you want to avoid object creation overhead - involved in instantiating one tracker per tracking id.

-
-
Parameters
- - - - -
configResId - The resource id of your tracker configuration file. See Tracker - for more information about what configuration elements can be included in - that file. -
-
- -
-
- - - - -
-

- - public - - - - - void - - reportActivityStart - (Activity activity) -

-
-
- - - -
-
- - - - -

Report the start of an Activity, so that it can be tracked by any Trackers - that have enabled auto activity tracking (see enableAutoActivityTracking(boolean).) - This will also start a new session if necessary. This method should be called from the onStart() method in each Activity in your application that you'd like to - track. - - If auto activity reports are enabled (see enableAutoActivityReports(Application)) on - a device running API level 14 or above, this method will be a noop.

-
-
Parameters
- - - - -
activity - the Activity that is to be tracked. -
-
- -
-
- - - - -
-

- - public - - - - - void - - reportActivityStop - (Activity activity) -

-
-
- - - -
-
- - - - -

Report the end of an Activity. Note that this method should be called from the onStop() method in each Activity in your application that you'd like to - track. For proper operation, this method must be called in all Activities where reportActivityStart(Activity) is called. - - If auto activity reports are enabled (see enableAutoActivityReports(Application)) on - a device running API level 14 or above, this method will be a noop.

-
-
Parameters
- - - - -
activity - the Activity that is to be tracked. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppOptOut - (boolean optOut) -

-
-
- - - -
-
- - - - -

Sets or resets the application-level opt out flag. If set, no hits will be sent to Google - Analytics. The value of this flag will not persist across application starts. The - correct value should thus be set in application initialization code.

-
-
Parameters
- - - - -
optOut - true if application-level opt out should be enforced. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setDryRun - (boolean dryRun) -

-
-
- - - -
-
- - - - -

Toggles dry run mode. In dry run mode, the normal code paths are executed locally, but hits - are not sent to Google Analytics servers. This is useful for debugging calls to the Google - Analytics SDK without polluting recorded data.

By default, this flag is disabled. -

- -
-
- - - - -
-

- - public - - - - - void - - setLocalDispatchPeriod - (int dispatchPeriodInSeconds) -

-
-
- - - -
-
- - - - -

Sets dispatch period for the local dispatcher. The dispatcher will check for hits to dispatch - every dispatchPeriod seconds. If zero or a negative dispatch period is given, - automatic dispatch will be disabled, and the application will need to dispatch events - manually using dispatchLocalHits(). - - This method only works if local dispatching is in use. Local dispatching is only used in the - absence of Google Play services on the device. In general, applications should not rely on - the ability to dispatch hits manually.

-
-
Parameters
- - - - -
dispatchPeriodInSeconds - the new dispatch period in seconds -
-
- -
-
- - - - -
-

- - public - - - - - void - - setLogger - (Logger logger) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Logger interface is deprecated. See Logger interface for - details. - -

-

Return the current Logger implementation in use. If no Logger has been set, - a default Logger is provided that logs to android.util.Log - with Logger.LogLevel set to WARNING.

-
-
Parameters
- - - - -
logger - The Logger implementation to use for logging.
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.AppViewBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.AppViewBuilder.html deleted file mode 100644 index 5fb36b34d74f..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.AppViewBuilder.html +++ /dev/null @@ -1,1686 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.AppViewBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.AppViewBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.AppViewBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.AppViewBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.AppViewBuilder
- - - - - - - -
-

-

- This class is deprecated.
- This class has been deprecated in favor of the new ScreenViewBuilder class. The - two classes are semantically similar but the latter is consistent across all the Google - Analytics platforms. - -

- -

Class Overview

-

Class to build a basic app view hit. You can add any of the other fields to the builder - using common set and get methods.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.AppViewBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.AppViewBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.EventBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.EventBuilder.html deleted file mode 100644 index eb5b315aff38..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.EventBuilder.html +++ /dev/null @@ -1,1959 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.EventBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.EventBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.EventBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.EventBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.EventBuilder
- - - - - - - -
- - -

Class Overview

-

A Builder object to build event hits. For meaningful data, event hits should contain at least - the event category and the event action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.EventBuilder() - -
- - - - - - - - HitBuilders.EventBuilder(String category, String action) - -
- Convenience constructor for creating an event hit. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.EventBuilder - - setAction(String action) - -
- - - - - - HitBuilders.EventBuilder - - setCategory(String category) - -
- - - - - - HitBuilders.EventBuilder - - setLabel(String label) - -
- - - - - - HitBuilders.EventBuilder - - setValue(long value) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.EventBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - HitBuilders.EventBuilder - (String category, String action) -

-
-
- - - -
-
- - - - -

Convenience constructor for creating an event hit. Additional fields can be specified - using the setter methods.

-
-
Parameters
- - - - - - - -
category - Category in which the event will be filed. Example: "Video"
action - Action associated with the event. Example: "Play" -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.EventBuilder - - setAction - (String action) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.EventBuilder - - setCategory - (String category) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.EventBuilder - - setLabel - (String label) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.EventBuilder - - setValue - (long value) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ExceptionBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ExceptionBuilder.html deleted file mode 100644 index a966a5c745d0..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ExceptionBuilder.html +++ /dev/null @@ -1,1793 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.ExceptionBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.ExceptionBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.ExceptionBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.ExceptionBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.ExceptionBuilder
- - - - - - - -
- - -

Class Overview

-

Exception builder allows you to measure the number and type of caught and uncaught crashes - and exceptions that occur in your app. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.ExceptionBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.ExceptionBuilder - - setDescription(String description) - -
- - - - - - HitBuilders.ExceptionBuilder - - setFatal(boolean fatal) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.ExceptionBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.ExceptionBuilder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ExceptionBuilder - - setFatal - (boolean fatal) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.HitBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.HitBuilder.html deleted file mode 100644 index 1c237c5b0e9b..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.HitBuilder.html +++ /dev/null @@ -1,2443 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.HitBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - Protected Ctors - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- protected - static - - - class -

HitBuilders.HitBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<T extends com.google.android.gms.analytics.HitBuilders.HitBuilder>
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Internal class to provide common builder class methods. The most important methods from this - class are the setXYZ and build methods. These methods can be used to set individual - properties on the hit and then build it so that it is ready to be passed into the tracker. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Constructors
- - - - - - - - HitBuilders.HitBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - T - - addImpression(Product product, String impressionList) - -
- Adds a product impression to the hit. - - - -
- -
- - - - - - T - - addProduct(Product product) - -
- Adds product information to be sent with a given hit. - - - -
- -
- - - - - - T - - addPromotion(Promotion promotion) - -
- Adds promotion related information to the hit. - - - -
- -
- - - - - - Map<String, String> - - build() - -
- Builds a Map of parameters and values that can be set on the Tracker - object. - - - -
- -
- - - final - - - T - - set(String paramName, String paramValue) - -
- Sets the value for the given parameter name. - - - -
- -
- - - final - - - T - - setAll(Map<String, String> params) - -
- Adds a set of key, value pairs to the hit builder. - - - -
- -
- - - - - - T - - setCampaignParamsFromUrl(String utmParams) - -
- Parses and translates utm campaign parameters to analytics campaign param - and returns them as a map. - - - -
- -
- - - - - - T - - setCustomDimension(int index, String dimension) - -
- Adds a custom dimension to the current hit builder. - - - -
- -
- - - - - - T - - setCustomMetric(int index, float metric) - -
- Adds a custom metric to the current hit builder. - - - -
- -
- - - - - - T - - setNewSession() - -
- - - - - - T - - setNonInteraction(boolean nonInteraction) - -
- - - - - - T - - setProductAction(ProductAction action) - -
- Sets a product action for all the products included in this hit. - - - -
- -
- - - - - - T - - setPromotionAction(String action) - -
- Adds an action associated with the promotions in a given hit. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - String - - get(String paramName) - -
- - - - - - T - - setHitType(String hitType) - -
- Sets the type of the hit to be sent. - - - -
- -
- - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - HitBuilders.HitBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - T - - addImpression - (Product product, String impressionList) -

-
-
- - - -
-
- - - - -

Adds a product impression to the hit. The product can be optionally associated with a - named impression list. -

- -
-
- - - - -
-

- - public - - - - - T - - addProduct - (Product product) -

-
-
- - - -
-
- - - - -

Adds product information to be sent with a given hit. The action provided in - setProductAction(ProductAction) affects how the products passed in through this method get - processed. -

- -
-
- - - - -
-

- - public - - - - - T - - addPromotion - (Promotion promotion) -

-
-
- - - -
-
- - - - -

Adds promotion related information to the hit. -

- -
-
- - - - -
-

- - public - - - - - Map<String, String> - - build - () -

-
-
- - - -
-
- - - - -

Builds a Map of parameters and values that can be set on the Tracker - object.

-
-
Returns
-
  • A map of string keys to string values that can be passed into the tracker for one - or more hits. -
-
- -
-
- - - - -
-

- - public - - final - - - T - - set - (String paramName, String paramValue) -

-
-
- - - -
-
- - - - -

Sets the value for the given parameter name. These values will be added to the hit when - it is built. This function should only be used for advanced cases where none of the - explicit setters do not work. This function should usually be called after all the - explicit setter have been called.

-
-
Parameters
- - - - - - - -
paramName - The name of the parameter that should be sent over wire. This value - should start with "&".
paramValue - The value to be sent over the wire for the given parameter.
-
-
-
Returns
-
  • The builder object that you can use to chain calls. -
-
- -
-
- - - - -
-

- - public - - final - - - T - - setAll - (Map<String, String> params) -

-
-
- - - -
-
- - - - -

Adds a set of key, value pairs to the hit builder. These values will be added to the hit - when it is built. This function should only be used for advanced cases where none of the - explicit setters work. This function should usually be called after all the - explicit setter have been called.

-
-
Parameters
- - - - -
params - A map of all the values to be added to the builder.
-
-
-
Returns
-
  • The builder object that you can use to chain calls. -
-
- -
-
- - - - -
-

- - public - - - - - T - - setCampaignParamsFromUrl - (String utmParams) -

-
-
- - - -
-
- - - - -

Parses and translates utm campaign parameters to analytics campaign param - and returns them as a map.

-
-
Parameters
- - - - -
utmParams - url containing utm campaign parameters.
-
-
-
Returns
-
  • The builder object that you can use to chain calls. - - Valid campaign parameters are: -
      -
    • utm_id
      • -
    • utm_campaign
      • -
    • utm_content
      • -
    • utm_medium
      • -
    • utm_source
      • -
    • utm_term
      • -
    • dclid
      • -
    • gclid
      • -
    • gmob_t
      • -
    -

    - Example: - http://my.site.com/index.html?utm_campaign=wow&utm_source=source - utm_campaign=wow&utm_source=source. -

    - For more information on auto-tagging, see - http://support.google.com/googleanalytics/bin/answer.py?hl=en&answer=55590 -

    - For more information on manual tagging, see - http://support.google.com/googleanalytics/bin/answer.py?hl=en&answer=55518 * -

-
- -
-
- - - - -
-

- - public - - - - - T - - setCustomDimension - (int index, String dimension) -

-
-
- - - -
-
- - - - -

Adds a custom dimension to the current hit builder. Calling this method with the same - index will overwrite the previous dimension with the new one. Refer - http://goo.gl/igziD2 for details on how to set the - custom dimensions up.

-
-
Parameters
- - - - - - - -
index - The index/slot in which the dimension will be set.
dimension - The value of the dimension for the given index.
-
-
-
Returns
-
  • The builder object that you can use to chain calls. -
-
- -
-
- - - - -
-

- - public - - - - - T - - setCustomMetric - (int index, float metric) -

-
-
- - - -
-
- - - - -

Adds a custom metric to the current hit builder. Calling this method with the same - index will overwrite the previous metric with the new one. Refer - http://goo.gl/igziD2 for details on how to set the - custom metrics up.

-
-
Parameters
- - - - - - - -
index - The index/slot in which the metric will be set.
metric - The value of the metric for the given index.
-
-
-
Returns
-
  • The builder object that you can use to chain calls. -
-
- -
-
- - - - -
-

- - public - - - - - T - - setNewSession - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - T - - setNonInteraction - (boolean nonInteraction) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - T - - setProductAction - (ProductAction action) -

-
-
- - - -
-
- - - - -

Sets a product action for all the products included in this hit. The action and its - associated properties affect how the products added through addProduct(Product) are - processed. -

- -
-
- - - - -
-

- - public - - - - - T - - setPromotionAction - (String action) -

-
-
- - - -
-
- - - - -

Adds an action associated with the promotions in a given hit. Valid values for an action - are defined in Promotion class. -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - String - - get - (String paramName) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - protected - - - - - T - - setHitType - (String hitType) -

-
-
- - - -
-
- - - - -

Sets the type of the hit to be sent. This can be used to reuse the builder object for - multiple hit types. See http://goo.gl/kMRwhS for - possible hit values.

-
-
Parameters
- - - - -
hitType - The value of the Hit. -
-
- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ItemBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ItemBuilder.html deleted file mode 100644 index 42f4d7d33c15..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ItemBuilder.html +++ /dev/null @@ -1,2039 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.ItemBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.ItemBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.ItemBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.ItemBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.ItemBuilder
- - - - - - - -
-

-

- This class is deprecated.
- This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. - -

- -

Class Overview

-

Item hit builder allows you to send item level sales data to Google Analytics. Transaction - Id, Item Name, SKU price and quantity are required for meaningful reports on item data.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.ItemBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.ItemBuilder - - setCategory(String category) - -
- - - - - - HitBuilders.ItemBuilder - - setCurrencyCode(String currencyCode) - -
- - - - - - HitBuilders.ItemBuilder - - setName(String name) - -
- - - - - - HitBuilders.ItemBuilder - - setPrice(double price) - -
- - - - - - HitBuilders.ItemBuilder - - setQuantity(long quantity) - -
- - - - - - HitBuilders.ItemBuilder - - setSku(String sku) - -
- - - - - - HitBuilders.ItemBuilder - - setTransactionId(String transactionid) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.ItemBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setCategory - (String category) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setCurrencyCode - (String currencyCode) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setName - (String name) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setPrice - (double price) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setQuantity - (long quantity) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setSku - (String sku) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.ItemBuilder - - setTransactionId - (String transactionid) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ScreenViewBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ScreenViewBuilder.html deleted file mode 100644 index 1228e19cd47c..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.ScreenViewBuilder.html +++ /dev/null @@ -1,1680 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.ScreenViewBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.ScreenViewBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.ScreenViewBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.ScreenViewBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.ScreenViewBuilder
- - - - - - - -
- - -

Class Overview

-

Class to build a screen view hit. You can add any of the other fields to the builder - using common set and get methods. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.ScreenViewBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.ScreenViewBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.SocialBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.SocialBuilder.html deleted file mode 100644 index 148c7f61b03d..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.SocialBuilder.html +++ /dev/null @@ -1,1841 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.SocialBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.SocialBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.SocialBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.SocialBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.SocialBuilder
- - - - - - - -
- - -

Class Overview

-

A Builder object to build social event hits. See - http://goo.gl/iydW9O for description of all social fields. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.SocialBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.SocialBuilder - - setAction(String action) - -
- - - - - - HitBuilders.SocialBuilder - - setNetwork(String network) - -
- - - - - - HitBuilders.SocialBuilder - - setTarget(String target) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.SocialBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.SocialBuilder - - setAction - (String action) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.SocialBuilder - - setNetwork - (String network) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.SocialBuilder - - setTarget - (String target) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TimingBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TimingBuilder.html deleted file mode 100644 index 3021c5f5345a..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TimingBuilder.html +++ /dev/null @@ -1,1974 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.TimingBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.TimingBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.TimingBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.TimingBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.TimingBuilder
- - - - - - - -
- - -

Class Overview

-

Hit builder used to collect timing related data. For example, this hit type can be useful to - measure resource load times. For meaningful data, at least the category and the value should - be set before sending the hit. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.TimingBuilder() - -
- - - - - - - - HitBuilders.TimingBuilder(String category, String variable, long value) - -
- Convenience constructor for creating a timing hit. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.TimingBuilder - - setCategory(String category) - -
- - - - - - HitBuilders.TimingBuilder - - setLabel(String label) - -
- - - - - - HitBuilders.TimingBuilder - - setValue(long value) - -
- - - - - - HitBuilders.TimingBuilder - - setVariable(String variable) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.TimingBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - HitBuilders.TimingBuilder - (String category, String variable, long value) -

-
-
- - - -
-
- - - - -

Convenience constructor for creating a timing hit. Additional fields can be specified - using the setter methods.

-
-
Parameters
- - - - - - - - - - -
category - The type of variable being measured. Example: AssetLoader
variable - The variable being measured. Example: AssetLoader.load
value - The value associated with the variable. Example: 1000 -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.TimingBuilder - - setCategory - (String category) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TimingBuilder - - setLabel - (String label) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TimingBuilder - - setValue - (long value) -

-
-
- - - -
-
- - - - -

-
-
Parameters
- - - - -
value - A timing value, in milliseconds. -
-
- -
-
- - - - -
-

- - public - - - - - HitBuilders.TimingBuilder - - setVariable - (String variable) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TransactionBuilder.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TransactionBuilder.html deleted file mode 100644 index 1adfea6428bc..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.TransactionBuilder.html +++ /dev/null @@ -1,1992 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders.TransactionBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HitBuilders.TransactionBuilder

- - - - - - - - - extends HitBuilder<HitBuilders.TransactionBuilder>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders.HitBuilder<com.google.android.gms.analytics.HitBuilders.TransactionBuilder>
    ↳com.google.android.gms.analytics.HitBuilders.TransactionBuilder
- - - - - - - -
-

-

- This class is deprecated.
- This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. - -

- -

Class Overview

-

Transaction hit builder allows you to send in-app purchases and sales to Google Analytics. - Transaction Id, affiliation and revenue are required for meaningful reports on transaction - data.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders.TransactionBuilder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - HitBuilders.TransactionBuilder - - setAffiliation(String affiliation) - -
- - - - - - HitBuilders.TransactionBuilder - - setCurrencyCode(String currencyCode) - -
- - - - - - HitBuilders.TransactionBuilder - - setRevenue(double revenue) - -
- - - - - - HitBuilders.TransactionBuilder - - setShipping(double shipping) - -
- - - - - - HitBuilders.TransactionBuilder - - setTax(double tax) - -
- - - - - - HitBuilders.TransactionBuilder - - setTransactionId(String transactionid) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.HitBuilders.HitBuilder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders.TransactionBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setAffiliation - (String affiliation) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setCurrencyCode - (String currencyCode) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setRevenue - (double revenue) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setShipping - (double shipping) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setTax - (double tax) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - HitBuilders.TransactionBuilder - - setTransactionId - (String transactionid) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.html b/docs/html/reference/com/google/android/gms/analytics/HitBuilders.html deleted file mode 100644 index 3bc025652b3b..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/HitBuilders.html +++ /dev/null @@ -1,1538 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HitBuilders | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

HitBuilders

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.HitBuilders
- - - - - - - -
- - -

Class Overview

-

Helper class to build a map of hit parameters and values. -

- Examples: -
- This will send a event hit type with the specified parameters - and a custom dimension parameter. - 

- Tracker t = // get a tracker.
- t.send(new HitBuilders.EventBuilder()
-         .setCategory("EventCategory")
-         .setAction("EventAction")
-         .setCustomDimension(1, "dimension1")
-         .build());
-
-

- If you want to send a parameter with all hits, set it on Tracker directly. - 

- t.setScreenName("Home");
- t.send(new HitBuilders.SocialBuilder()
-         .setNetwork("Google+")
-         .setAction("PlusOne")
-         .setTarget("SOME_URL")
-         .build());
- t.send(new HitBuilders.SocialBuilder()
-         .setNetwork("Google+")
-         .setAction("Share")
-         .setTarget("SOME_POST")
-         .build());
- t.send(new HitBuilders.SocialBuilder()
-         .setNetwork("Google+")
-         .setAction("HangOut")
-         .setTarget("SOME_CIRCLE")
-         .build());
-
-

- You can override a value set on the tracker by adding it to the map. - 

- t.setScreenName("Home");
- t.send(new HitBuilders.EventBuilder()
-         .setScreenName("Popup Screen")
-         .setCategory("click")
-         .setLabel("popup")
-         .build());
-
- Additionally, The builder objects can be re-used to build values to be sent with multiple hits. - 
- HitBuilders.TimingBuilder tb = new HitBuilders.TimingBuilder()
-         .setCategory("category")
-         .setValue(0L)
-         .setVariable("name");
- t.send(tb.setValue(10).build());
- t.send(tb.setValue(20).build());
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classHitBuilders.AppViewBuilder - - This class is deprecated. - This class has been deprecated in favor of the new ScreenViewBuilder class. The - two classes are semantically similar but the latter is consistent across all the Google - Analytics platforms. -  - - - -
- - - - - classHitBuilders.EventBuilder - A Builder object to build event hits.  - - - -
- - - - - classHitBuilders.ExceptionBuilder - Exception builder allows you to measure the number and type of caught and uncaught crashes - and exceptions that occur in your app.  - - - -
- - - - - classHitBuilders.HitBuilder<T extends HitBuilder> - Internal class to provide common builder class methods.  - - - -
- - - - - classHitBuilders.ItemBuilder - - This class is deprecated. - This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. -  - - - -
- - - - - classHitBuilders.ScreenViewBuilder - Class to build a screen view hit.  - - - -
- - - - - classHitBuilders.SocialBuilder - A Builder object to build social event hits.  - - - -
- - - - - classHitBuilders.TimingBuilder - Hit builder used to collect timing related data.  - - - -
- - - - - classHitBuilders.TransactionBuilder - - This class is deprecated. - This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. -  - - - -
- - - - - - - - - - -
Public Constructors
- - - - - - - - HitBuilders() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HitBuilders - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/Logger.LogLevel.html b/docs/html/reference/com/google/android/gms/analytics/Logger.LogLevel.html deleted file mode 100644 index a556b33563e7..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/Logger.LogLevel.html +++ /dev/null @@ -1,1541 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Logger.LogLevel | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Logger.LogLevel

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.Logger.LogLevel
- - - - - - - -
-

-

- This class is deprecated.
- See Logger interface for details. - -

- -

Class Overview

-

Log level settings. The log level is provided to the Logger through the setLogLevel(int) method.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intERROR - - - - -
intINFO - - - - -
intVERBOSE - - - - -
intWARNING - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Logger.LogLevel() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ERROR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INFO -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - VERBOSE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WARNING -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Logger.LogLevel - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/Logger.html b/docs/html/reference/com/google/android/gms/analytics/Logger.html deleted file mode 100644 index 4fe88c10fb7f..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/Logger.html +++ /dev/null @@ -1,1542 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Logger | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Logger

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.analytics.Logger
- - - - - - - -
-

-

- This interface is deprecated.
- Logger interface is deprecated. Use adb shell setprop log.tag.GAv4 DEBUG to - enable debug logging for Google Analytics. - -

- -

Class Overview

-

Deprecated Analytics Logger interface. Google Analytics will log to logcat under - GAv4 tag using Android Log system. By default only ERROR, WARN - and INFO levels are enabled. To enable DEBUG level run the following adb command on your - device or emulator: - -

- 

adb shell setprop log.tag.GAv4 DEBUG
- -
To see only Google Analytics messages from logcat use the following command: - -

- 
adb logcat -v time -s GAv4
- -
For more information consult the - logcat and - adb developer documentation.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classLogger.LogLevel - - This class is deprecated. - See Logger interface for details. -  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - error(String message) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - void - - error(Exception exception) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - int - - getLogLevel() - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - void - - info(String message) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - void - - setLogLevel(int level) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - void - - verbose(String message) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- abstract - - - - - void - - warn(String message) - -
- - This method is deprecated. - See Logger interface for details. - - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - error - (String message) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Used to log runtime errors or unexpected conditions. These errors will likely result in data - not being sent to the GA servers.

-
-
Parameters
- - - - -
message - A string describing the error that occurred.
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - error - (Exception exception) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Used to log runtime errors or unexpected conditions. These errors will likely result in data - not being sent to the GA servers.

-
-
Parameters
- - - - -
exception - The exception that was thrown that caused the error.
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getLogLevel - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Return the current log level.

- -
-
- - - - -
-

- - public - - - abstract - - void - - info - (String message) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Used to log information on the flow through the system and other interesting events.

-
-
Parameters
- - - - -
message - the message to log
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setLogLevel - (int level) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Logger is deprecated. Setting log level is ignored.

- -
-
- - - - -
-

- - public - - - abstract - - void - - verbose - (String message) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Used to log detailed information. This information will probably only be useful during - development and debugging.

-
-
Parameters
- - - - -
message - the message to log
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - warn - (String message) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See Logger interface for details. - -

-

Used in situations like use of deprecated APIs, poor use of API, near errors, other runtime - situations that are undesirable or unexpected, but not necessarily "wrong".

-
-
Parameters
- - - - -
message - the message to log
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/StandardExceptionParser.html b/docs/html/reference/com/google/android/gms/analytics/StandardExceptionParser.html deleted file mode 100644 index d4158de688c8..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/StandardExceptionParser.html +++ /dev/null @@ -1,1762 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StandardExceptionParser | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StandardExceptionParser

- - - - - extends Object
- - - - - - - implements - - ExceptionParser - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.StandardExceptionParser
- - - - - - - -
- - -

Class Overview

-

This class will capture the root cause (last in a chain of causes) Throwable and report the exception type, class name, method name and thread - name. -

- This class will attempt to report a class and method name that is relevant to - the application if at all possible. It does this by finding the root cause - Throwable, then checking each StackTraceElement for a class - that is in a package list created by setIncludedPackages(Context, Collection), starting - with the first StackTraceElement. -

- The String returned by getDescription(String, Throwable) will take on the form - Exception class(@classname:methodname){threadname}. -

- See getBestStackTraceElement(Throwable) and setIncludedPackages(Context, Collection) for - details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StandardExceptionParser(Context context, Collection<String> additionalPackages) - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getDescription(String threadName, Throwable t) - -
- Return a short description of a Throwable suitable for - reporting to Google Analytics. - - - -
- -
- - - - - - void - - setIncludedPackages(Context context, Collection<String> additionalPackages) - -
- Sets the list of packages considered relevant to the list of packages in - the Context and the list of packages provided in the - input parameter additionalPackages. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - StackTraceElement - - getBestStackTraceElement(Throwable t) - -
- Return the first StackTraceElement found that has a className in - any packageName found in includedPackages. - - - -
- -
- - - - - - Throwable - - getCause(Throwable t) - -
- Get the root cause of the input Throwable. - - - -
- -
- - - - - - String - - getDescription(Throwable cause, StackTraceElement element, String threadName) - -
- Given input of a Throwable, a StackTraceElement and the - name of the Thread, return a String describing the - Throwable and the name of the Class and method where the - Throwable happened. - - - -
- -
- - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.analytics.ExceptionParser - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StandardExceptionParser - (Context context, Collection<String> additionalPackages) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getDescription - (String threadName, Throwable t) -

-
-
- - - -
-
- - - - -

Return a short description of a Throwable suitable for - reporting to Google Analytics.

-
-
Parameters
- - - - - - - -
threadName - the name of the Thread that got the exception, or null
t - the Throwable
-
-
-
Returns
-
  • the description -
-
- -
-
- - - - -
-

- - public - - - - - void - - setIncludedPackages - (Context context, Collection<String> additionalPackages) -

-
-
- - - -
-
- - - - -

Sets the list of packages considered relevant to the list of packages in - the Context and the list of packages provided in the - input parameter additionalPackages. Either parameter can be null. -

- Any package names stored from a previous call to this method will be - cleared.

-
-
Parameters
- - - - - - - -
context - any Context for the application
additionalPackages - a collection of additional package names to add -
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - StackTraceElement - - getBestStackTraceElement - (Throwable t) -

-
-
- - - -
-
- - - - -

Return the first StackTraceElement found that has a className in - any packageName found in includedPackages. If none have a - className in any packageName found in includedPackages, return - the first StackTraceElement found. If the Throwable does - not contain any StackTraceElements, return null. -

- -
-
- - - - -
-

- - protected - - - - - Throwable - - getCause - (Throwable t) -

-
-
- - - -
-
- - - - -

Get the root cause of the input Throwable. This method chains - through each cause of the original input and returns the last cause in the - chain.

-
-
Parameters
- - - - -
t - the initial Throwable
-
-
-
Returns
-
  • the root cause -
-
- -
-
- - - - -
-

- - protected - - - - - String - - getDescription - (Throwable cause, StackTraceElement element, String threadName) -

-
-
- - - -
-
- - - - -

Given input of a Throwable, a StackTraceElement and the - name of the Thread, return a String describing the - Throwable and the name of the Class and method where the - Throwable happened. The String returned will also have - the name of the thread appended (as provided in the input parameter - threadName. -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/Tracker.html b/docs/html/reference/com/google/android/gms/analytics/Tracker.html deleted file mode 100644 index aec98292323d..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/Tracker.html +++ /dev/null @@ -1,2938 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Tracker | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Tracker

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.Tracker
- - - - - - - -
- - -

Class Overview

-

Composes and sends hits to Google Analytics. You can get an instance of this class by calling - newTracker(int). A Tracker must be initialized with a tracking id of an app - profile before you can send any hits. Use this class to set values for measurement protocol - parameters using the provided set methods. A param value set using set(String, String) method is sent - with all subsequent hits until you overwrite it with another value or clear it by setting it to - null. You can also override it by specifying a different value in a send(Map) call. - The values passed in the send(Map) are sent only with that hit. The following example uses - the HitBuilders.EventBuilder helper class to build a param map to pass to the send(Map) method.

- 

- GoogleAnalytics analytics = GoogleAnalytics.getInstance(context);
- Tracker tracker = analytics.newTracker("UA-000-1"); // Send hits to tracker id UA-000-1
-
- // All subsequent hits will be send with screen name = "main screen"
- tracker.setScreenName("main screen");
-
- tracker.send(new HitBuilders.EventBuilder()
-         .setCategory("UX")
-         .setAction("click")
-         .setLabel("submit")
-         .build());
-
- // Builder parameters can overwrite the screen name set on the tracker
- tracker.send(new HitBuilders.EventBuilder()
-         .setCategory("UX")
-         .setAction("click")
-         .setLabel("help popup")
-         .setScreenName("help popup dialog")
-         .build());
- A Tracker can also be initialized with configuration values from an XML resource file - like this: - 
- Tracker tracker = analytics.newTracker(R.xml.tracker_config);
- Where R.xml.tracker_config is the resource id for an XML configuration file. The file should be - stored in the app's res/xml/ directory and look like this:

- 

- <?xml version="1.0" encoding="utf-8" ?>
- <resources>
-     <string name="ga_trackingId">UA-0000-1</string>
-     <string name="ga_sampleFrequency">100.0</string>
-     <integer name="ga_sessionTimeout">1800</integer>
-     <bool name="ga_autoActivityTracking">true</bool>
-     <bool name="ga_anonymizeIp">false</bool>
-     <bool name="ga_reportUncaughtExceptions">true</bool>
-
-     <screenName name="com.example.MainActivity">Home Screen</screenName>
-     <screenName name="com.example.SecondActivity">Second Screen</screenName>
- </resources>
- The following tracker configuration values can be specified:
  • ga_trackingId(string) - - tracking id to send the reports to. Required.
  • ga_sampleFrequency(string) - sampling rate - in percents. Default is 100.0. It can be any value between 0.0 and 100.0.
    • -
  • ga_autoActivityTracking(bool) - if true, views (Activities) will be tracked. Default is - false.
  • ga_anonymizeIp(bool) - if true, anonymizeIp will be set for each hit. Default is - false.
  • ga_reportUncaughtExceptions(bool) - if true, uncaught exceptions will be tracked. - Default is false. NOTE: This value can only be set to true for a single Tracker. If specified for - multiple Trackers, then the last one to be initialized will be used.
    • -
  • ga_sessionTimeout(int) - time (in seconds) an app can stay in the background before a new - session is started. Setting this to a negative number will result in a new session never being - started. Default is 1800 seconds (30 minutes).

If ga_autoActivityTracking is - enabled, an alternate screen name can be specified to substitute for the full canonical Activity class name. In order to specify an alternate screen name use an <screenName> - element, with the name attribute specifying the full class name, and the screen name as element - content. - 

- <screenName name="com.example.MainActivity">Home Screen</screenName>
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - enableAdvertisingIdCollection(boolean enabled) - -
- Sets whether the advertising id and ad targeting preference should be collected while sending - hits to GA servers. - - - -
- -
- - - - - - void - - enableAutoActivityTracking(boolean enabled) - -
- Specify whether Activity starts should automatically generate screen - views from this Tracker. - - - -
- -
- - - - - - void - - enableExceptionReporting(boolean enable) - -
- Enables or disables uncaught exception reporting for a given tracker. - - - -
- -
- - - - - - String - - get(String key) - -
- Gets the model value for the given key. - - - -
- -
- - - - - - void - - send(Map<String, String> params) - -
- Merges the model values set on this Tracker via send(Map) with params and - generates a hit to be sent. - - - -
- -
- - - - - - void - - set(String key, String value) - -
- Sets the model value for the given key. - - - -
- -
- - - - - - void - - setAnonymizeIp(boolean anonymize) - -
- - - - - - void - - setAppId(String appId) - -
- Sets the id of the App for analytics reports. - - - -
- -
- - - - - - void - - setAppInstallerId(String appInstallerId) - -
- Sets the Installer Id of the App for analytics reports. - - - -
- -
- - - - - - void - - setAppName(String appName) - -
- Sets the name of the App for analytics reports. - - - -
- -
- - - - - - void - - setAppVersion(String appVersion) - -
- Sets the version identifier of the App for analytics reports. - - - -
- -
- - - - - - void - - setCampaignParamsOnNextHit(Uri uri) - -
- Includes the campaign parameters contained in the URI referrer in the next hit. - - - -
- -
- - - - - - void - - setClientId(String clientId) - -
- Sets a particular client Id for the device. - - - -
- -
- - - - - - void - - setEncoding(String encoding) - -
- - - - - - void - - setHostname(String hostname) - -
- - - - - - void - - setLanguage(String language) - -
- Sets the language based on user's preferred locale. - - - -
- -
- - - - - - void - - setLocation(String location) - -
- - - - - - void - - setPage(String page) - -
- - - - - - void - - setReferrer(String referrer) - -
- - - - - - void - - setSampleRate(double sampleRate) - -
- Set the sample rate for all hits generated by the app. - - - -
- -
- - - - - - void - - setScreenColors(String screenColors) - -
- - - - - - void - - setScreenName(String screenName) - -
- Set the screen name to be associated with all subsequent hits. - - - -
- -
- - - - - - void - - setScreenResolution(int width, int height) - -
- Sets the screen resolution of the device. - - - -
- -
- - - - - - void - - setSessionTimeout(long sessionTimeout) - -
- Specify the time (in seconds) an app can stay in the background before a new session is - started. - - - -
- -
- - - - - - void - - setTitle(String title) - -
- - - - - - void - - setUseSecure(boolean useSecure) - -
- Sets whether hits should be sent securely over https. - - - -
- -
- - - - - - void - - setViewportSize(String viewportSize) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - enableAdvertisingIdCollection - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets whether the advertising id and ad targeting preference should be collected while sending - hits to GA servers. The collection of advertising id and the ad targeting preference is - disabled by default and needs to be turned on for mobile audience features and any other - features that require advertising id.

-
-
Parameters
- - - - -
enabled - true if the advertising information should be collected. False otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - void - - enableAutoActivityTracking - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specify whether Activity starts should automatically generate screen - views from this Tracker.

-
-
Parameters
- - - - -
enabled - True if screen views should be automatically generated. -
-
- -
-
- - - - -
-

- - public - - - - - void - - enableExceptionReporting - (boolean enable) -

-
-
- - - -
-
- - - - -

Enables or disables uncaught exception reporting for a given tracker. This method is - equivalent to using 'ga_reportUncaughtExceptions' in the tracker configuration file. Note - that as with the configuration setting, only the uncaught exceptions are reported using this - method. -

- -
-
- - - - -
-

- - public - - - - - String - - get - (String key) -

-
-
- - - -
-
- - - - -

Gets the model value for the given key. Returns null if no model value has been set. -

- -
-
- - - - -
-

- - public - - - - - void - - send - (Map<String, String> params) -

-
-
- - - -
-
- - - - -

Merges the model values set on this Tracker via send(Map) with params and - generates a hit to be sent. The hit may not be dispatched immediately. Note that the hit type - must set for the hit to be considered valid. More information on this can be found at - http://goo.gl/HVIXHR.

-
-
Parameters
- - - - -
params - map of hit data to values which are merged with the existing values which are - already set (using set(String, String)). Values in this map will override the values - set earlier. The values in this map will not be reused for the subsequent hits. - If you need to send a value in multiple hits, you can use the set(String, String) method. -
-
- -
-
- - - - -
-

- - public - - - - - void - - set - (String key, String value) -

-
-
- - - -
-
- - - - -

Sets the model value for the given key. All subsequent track or send calls will send this - key-value pair along as well. To remove a particular field, simply set the value to null.

-
-
Parameters
- - - - - - - -
key - The key of the field that needs to be set. It starts with "&" followed by the - parameter name. The complete list of fields can be found at - http://goo.gl/M6dK2U.
value - A string value to be sent to Google servers. A null value denotes that the value - should not be sent over wire. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAnonymizeIp - (boolean anonymize) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setAppId - (String appId) -

-
-
- - - -
-
- - - - -

Sets the id of the App for analytics reports. This value is populated by default using the - information provided by the android package manager. This value is usually the package name - used by the app.

-
-
Parameters
- - - - -
appId - String representing the name of the app. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppInstallerId - (String appInstallerId) -

-
-
- - - -
-
- - - - -

Sets the Installer Id of the App for analytics reports. This value is populated by default - using the information provided by the android package manager and the play store.

-
-
Parameters
- - - - -
appInstallerId - String representing the name of the app. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppName - (String appName) -

-
-
- - - -
-
- - - - -

Sets the name of the App for analytics reports. This value is populated by default using the - information provided by the android package manager.

-
-
Parameters
- - - - -
appName - String representing the name of the app. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAppVersion - (String appVersion) -

-
-
- - - -
-
- - - - -

Sets the version identifier of the App for analytics reports. This value is populated by - default using the information provided by the android package manager.

-
-
Parameters
- - - - -
appVersion - String representing the version of the app. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setCampaignParamsOnNextHit - (Uri uri) -

-
-
- - - -
-
- - - - -

Includes the campaign parameters contained in the URI referrer in the next hit. If there is - no referrer, or the referrer does not contain campaign parameters, this method does not add - anything to the next hit. - -

Use this method to track in-app events driven by advertising with deep linking - campaigns.

- -

Valid campaign parameters are:

  • utm_id
  • utm_campaign
    • -
  • utm_content
  • utm_medium
  • utm_source
  • utm_term
  • dclid
    • -
  • gclid

- - Example: http://my.site.com/index.html?referrer=utm_source%3Dsource%26utm_campaign%3Dwow

-
-
Parameters
- - - - -
uri - the uri containing the referrer -
-
- -
-
- - - - -
-

- - public - - - - - void - - setClientId - (String clientId) -

-
-
- - - -
-
- - - - -

Sets a particular client Id for the device. This Id should be a valid UUID (version 4) string - as described in http://goo.gl/0dlrGx. If not specified, the SDK automatically generates one - for you and sets it.

-
-
Parameters
- - - - -
clientId - A valid version 4 UUID string. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setEncoding - (String encoding) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setHostname - (String hostname) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setLanguage - (String language) -

-
-
- - - -
-
- - - - -

Sets the language based on user's preferred locale. The string should be of the format ll-cc - where ll is the language and cc is the country. If no value is provided, the default value - from the android SDK is used.

-
-
Parameters
- - - - -
language - string that denotes a particular language/locale. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setLocation - (String location) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setPage - (String page) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setReferrer - (String referrer) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setSampleRate - (double sampleRate) -

-
-
- - - -
-
- - - - -

Set the sample rate for all hits generated by the app. The sampling is done at app level. The - default value is 100. To enable sampling, the minimum rate required is 0.01%.

-
-
Parameters
- - - - -
sampleRate - A value between 0 and 100, specifying the percentage of devices that should - send hits. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setScreenColors - (String screenColors) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setScreenName - (String screenName) -

-
-
- - - -
-
- - - - -

Set the screen name to be associated with all subsequent hits. -

- -
-
- - - - -
-

- - public - - - - - void - - setScreenResolution - (int width, int height) -

-
-
- - - -
-
- - - - -

Sets the screen resolution of the device. If no resolution is specified, the default - resolution from the android SDK is used.

-
-
Parameters
- - - - - - - -
width - integer representing the width in pixels.
height - integer representing the height in pixels. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setSessionTimeout - (long sessionTimeout) -

-
-
- - - -
-
- - - - -

Specify the time (in seconds) an app can stay in the background before a new session is - started. Setting this to a negative number will result in a new session never being started. - Default is 30 seconds.

-
-
Parameters
- - - - -
sessionTimeout - Session timeout time in seconds. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setTitle - (String title) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setUseSecure - (boolean useSecure) -

-
-
- - - -
-
- - - - -

Sets whether hits should be sent securely over https. The default value is true. -

- -
-
- - - - -
-

- - public - - - - - void - - setViewportSize - (String viewportSize) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ecommerce/Product.html b/docs/html/reference/com/google/android/gms/analytics/ecommerce/Product.html deleted file mode 100644 index c26ec77d61fa..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ecommerce/Product.html +++ /dev/null @@ -1,2161 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Product | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Product

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.ecommerce.Product
- - - - - - - -
- - -

Class Overview

-

Class to construct product related information for a Google Analytics hit. Use this class to - report information about products sold by merchants or impressions of products seen by users. - Instances of this class can be associated with both ProductActions via - addProduct(Product) and Product - Impressions via - addImpression(Product, String). - - Typical usage: -

- 

-          ScreenViewBuilder builder = new HitBuilders.ScreenViewBuilder();
-          builder.addImpression(
-              new Product()
-                  .setId("PID-1234")
-                  .setName("Space Monkeys!")
-                  .setPrice(100), "listName");
-
-          builder.setProductAction(
-              new ProductAction(ProductAction.ACTION_PURCHASE))
-                  .addProduct(new Product().setId("PID-4321").setName("Water Monkeys!"));
-          tracker.send(builder.build());
-
-

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Product() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Product - - setBrand(String value) - -
- Sets the brand associated with the product in GA reports. - - - -
- -
- - - - - - Product - - setCategory(String value) - -
- Sets the category associated with the product in GA reports. - - - -
- -
- - - - - - Product - - setCouponCode(String value) - -
- Sets the coupon code associated with the product. - - - -
- -
- - - - - - Product - - setCustomDimension(int index, String value) - -
- Sets the custom dimensions associated with the product. - - - -
- -
- - - - - - Product - - setCustomMetric(int index, int value) - -
- Sets the custom metrics associated with the product. - - - -
- -
- - - - - - Product - - setId(String value) - -
- Sets the id that is used to identify a product in GA reports. - - - -
- -
- - - - - - Product - - setName(String value) - -
- Sets the name that is used to identify the product in GA reports. - - - -
- -
- - - - - - Product - - setPosition(int value) - -
- Sets the position of the product on the page/product impression list etc. - - - -
- -
- - - - - - Product - - setPrice(double value) - -
- Sets the price of the product. - - - -
- -
- - - - - - Product - - setQuantity(int value) - -
- Sets the quantity of the product. - - - -
- -
- - - - - - Product - - setVariant(String value) - -
- Sets the variant of the product. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Product - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Product - - setBrand - (String value) -

-
-
- - - -
-
- - - - -

Sets the brand associated with the product in GA reports.

-
-
Parameters
- - - - -
value - The product's brand. Example: "Acme Toys"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setCategory - (String value) -

-
-
- - - -
-
- - - - -

Sets the category associated with the product in GA reports.

-
-
Parameters
- - - - -
value - The product's category. Example: "Toys"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setCouponCode - (String value) -

-
-
- - - -
-
- - - - -

Sets the coupon code associated with the product. This field is usually not used with - product impressions.

-
-
Parameters
- - - - -
value - The product's coupon code. Example: "EXTRA10"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setCustomDimension - (int index, String value) -

-
-
- - - -
-
- - - - -

Sets the custom dimensions associated with the product.

-
-
Parameters
- - - - - - - -
index - The dimension's index as configured in Google Analytics Account. Example: 3
value - The product's custom dimension. Example: "Foo Reseller"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setCustomMetric - (int index, int value) -

-
-
- - - -
-
- - - - -

Sets the custom metrics associated with the product.

-
-
Parameters
- - - - - - - -
index - The metric's index as configured in Google Analytics Account. Example: 4
value - The product's custom metric. Example: 5
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setId - (String value) -

-
-
- - - -
-
- - - - -

Sets the id that is used to identify a product in GA reports.

-
-
Parameters
- - - - -
value - The product id.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setName - (String value) -

-
-
- - - -
-
- - - - -

Sets the name that is used to identify the product in GA reports.

-
-
Parameters
- - - - -
value - The product's name. Example: "Space Monkeys"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setPosition - (int value) -

-
-
- - - -
-
- - - - -

Sets the position of the product on the page/product impression list etc.

-
-
Parameters
- - - - -
value - The product's position. Example: 1 or 30
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setPrice - (double value) -

-
-
- - - -
-
- - - - -

Sets the price of the product.

-
-
Parameters
- - - - -
value - The product's price. Example: 3.14
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setQuantity - (int value) -

-
-
- - - -
-
- - - - -

Sets the quantity of the product. This field is usually not used with product impressions.

-
-
Parameters
- - - - -
value - The product's quantity. Example: 42
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Product - - setVariant - (String value) -

-
-
- - - -
-
- - - - -

Sets the variant of the product.

-
-
Parameters
- - - - -
value - The product's variant. Example: "Yellow" or "Red"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ecommerce/ProductAction.html b/docs/html/reference/com/google/android/gms/analytics/ecommerce/ProductAction.html deleted file mode 100644 index 561815aed85a..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ecommerce/ProductAction.html +++ /dev/null @@ -1,2626 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ProductAction | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ProductAction

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.ecommerce.ProductAction
- - - - - - - -
- - -

Class Overview

-

Class to construct transaction/checkout or other product interaction related information for a - Google Analytics hit. Use this class to report information about products sold, viewed or - refunded. This class is intended to be used with Product. - Instances of this class can be associated with - setProductAction(ProductAction). - - Typical usage: -

- 

-          HitBuilders.ScreenViewBuilder builder = new HitBuilders.ScreenViewBuilder();
-
-          builder.setProductAction(
-              new ProductAction(ProductAction.ACTION_PURCHASE)
-                  .setTransactionId("TT-1234")
-                  .setTransactionRevenue(3.14)
-                  .setTransactionCouponCode("EXTRA100"))
-              .addProduct(new Product().setId("PID-4321").setName("Water Monkeys!"));
-          tracker.send(builder.build());
-
-

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_ADD - Action to use when a product is added to the cart. - - - -
StringACTION_CHECKOUT - Action to use for hits with checkout data. - - - -
StringACTION_CHECKOUT_OPTION - Action to be used for supplemental checkout data that needs to be provided after a checkout - hit. - - - -
StringACTION_CHECKOUT_OPTIONS - - This constant is deprecated. - Use ACTION_CHECKOUT_OPTION instead. - - - - -
StringACTION_CLICK - Action to use when the user clicks on a set of products. - - - -
StringACTION_DETAIL - Action to use when the user views detailed descriptions of products. - - - -
StringACTION_PURCHASE - Action that is used to report all the transaction data to GA. - - - -
StringACTION_REFUND - Action to use while reporting refunded transactions to GA. - - - -
StringACTION_REMOVE - Action to use when a product is removed from the cart. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ProductAction(String action) - -
- Sets the product action for all the products included in the hit. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - ProductAction - - setCheckoutOptions(String value) - -
- Sets the label associated with the checkout. - - - -
- -
- - - - - - ProductAction - - setCheckoutStep(int value) - -
- Sets the checkout processes's progress. - - - -
- -
- - - - - - ProductAction - - setProductActionList(String value) - -
- Sets the list name associated with the products in the analytics hit. - - - -
- -
- - - - - - ProductAction - - setProductListSource(String value) - -
- Sets the list source name associated with the products in the analytics hit. - - - -
- -
- - - - - - ProductAction - - setTransactionAffiliation(String value) - -
- Sets the transaction's affiliation value. - - - -
- -
- - - - - - ProductAction - - setTransactionCouponCode(String value) - -
- Sets the coupon code used in a transaction. - - - -
- -
- - - - - - ProductAction - - setTransactionId(String value) - -
- The unique id associated with the transaction. - - - -
- -
- - - - - - ProductAction - - setTransactionRevenue(double value) - -
- Sets the transaction's total revenue. - - - -
- -
- - - - - - ProductAction - - setTransactionShipping(double value) - -
- Sets the transaction's shipping costs. - - - -
- -
- - - - - - ProductAction - - setTransactionTax(double value) - -
- Sets the transaction's total tax. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_ADD -

-
- - - - -
-
- - - - -

Action to use when a product is added to the cart. -

- - -
- Constant Value: - - - "add" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CHECKOUT -

-
- - - - -
-
- - - - -

Action to use for hits with checkout data. This action can have accompanying fields like - checkout step setCheckoutStep(int), checkout label setCheckoutOptions(String) and - checkout options setCheckoutOptions(String). -

- - -
- Constant Value: - - - "checkout" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CHECKOUT_OPTION -

-
- - - - -
-
- - - - -

Action to be used for supplemental checkout data that needs to be provided after a checkout - hit. This action can additionally have the same fields as the checkout action. -

- - -
- Constant Value: - - - "checkout_option" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CHECKOUT_OPTIONS -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- Use ACTION_CHECKOUT_OPTION instead. - -

-

Action to be used for supplemental checkout data that needs to be provided after a checkout - hit. This action can additionally have the same fields as the checkout action.

- - -
- Constant Value: - - - "checkout_options" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_CLICK -

-
- - - - -
-
- - - - -

Action to use when the user clicks on a set of products. This action can have accompanying - fields like product action list name setProductActionList(String) and product list source - setProductListSource(String). -

- - -
- Constant Value: - - - "click" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_DETAIL -

-
- - - - -
-
- - - - -

Action to use when the user views detailed descriptions of products. This action can have - accompanying fields like product action list name setProductActionList(String) and product - list source setProductListSource(String). -

- - -
- Constant Value: - - - "detail" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_PURCHASE -

-
- - - - -
-
- - - - -

Action that is used to report all the transaction data to GA. This is equivalent to the - transaction hit type which was available in previous versions of the SDK. This action can - can also have accompanying fields like transaction id, affiliation, revenue, tax, shipping - and coupon code. These fields can be specified with methods defined in this class. -

- - -
- Constant Value: - - - "purchase" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_REFUND -

-
- - - - -
-
- - - - -

Action to use while reporting refunded transactions to GA. -

- - -
- Constant Value: - - - "refund" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_REMOVE -

-
- - - - -
-
- - - - -

Action to use when a product is removed from the cart. -

- - -
- Constant Value: - - - "remove" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ProductAction - (String action) -

-
-
- - - -
-
- - - - -

Sets the product action for all the products included in the hit. Valid values include - "detail", "click", "add", "remove", "checkout", "checkout_option", "purchase" and "refund". - All these values are also defined in this class for ease of use. You also also send - additional values with the hit for some specific actions. See the action documentation for - details.

-
-
Parameters
- - - - -
action - The value of product action. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - ProductAction - - setCheckoutOptions - (String value) -

-
-
- - - -
-
- - - - -

Sets the label associated with the checkout. This value is used with ACTION_CHECKOUT - and ACTION_CHECKOUT_OPTION actions.

-
-
Parameters
- - - - -
value - A string label/option associated with the checkout.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setCheckoutStep - (int value) -

-
-
- - - -
-
- - - - -

Sets the checkout processes's progress. This value is used with ACTION_CHECKOUT and - ACTION_CHECKOUT_OPTION actions.

-
-
Parameters
- - - - -
value - An integer representing the progress of the checkout flow. example: 4 or 5.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setProductActionList - (String value) -

-
-
- - - -
-
- - - - -

Sets the list name associated with the products in the analytics hit. This value is used - with ACTION_DETAIL and ACTION_CLICK actions.

-
-
Parameters
- - - - -
value - A string name identifying the product list.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setProductListSource - (String value) -

-
-
- - - -
-
- - - - -

Sets the list source name associated with the products in the analytics hit. This value is - used with ACTION_DETAIL and ACTION_CLICK actions.

-
-
Parameters
- - - - -
value - A string name identifying the product list's source.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionAffiliation - (String value) -

-
-
- - - -
-
- - - - -

Sets the transaction's affiliation value. This value is used for ACTION_PURCHASE and - ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A string identifying the transaction affiliation.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionCouponCode - (String value) -

-
-
- - - -
-
- - - - -

Sets the coupon code used in a transaction. This value is used for ACTION_PURCHASE - and ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A string representing the coupon code used in a transaction.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionId - (String value) -

-
-
- - - -
-
- - - - -

The unique id associated with the transaction. This value is used for - ACTION_PURCHASE and ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A string id identifying a transaction
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionRevenue - (double value) -

-
-
- - - -
-
- - - - -

Sets the transaction's total revenue. This value is used for ACTION_PURCHASE and - ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A number representing the revenue from a transaction.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionShipping - (double value) -

-
-
- - - -
-
- - - - -

Sets the transaction's shipping costs. This value is used for ACTION_PURCHASE and - ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A number representing the shipping costs from a transaction.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - ProductAction - - setTransactionTax - (double value) -

-
-
- - - -
-
- - - - -

Sets the transaction's total tax. This value is used for ACTION_PURCHASE and - ACTION_REFUND actions.

-
-
Parameters
- - - - -
value - A number representing the revenue from a transaction.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ecommerce/Promotion.html b/docs/html/reference/com/google/android/gms/analytics/ecommerce/Promotion.html deleted file mode 100644 index 6ec0dcc7432c..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ecommerce/Promotion.html +++ /dev/null @@ -1,1785 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Promotion | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Promotion

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.analytics.ecommerce.Promotion
- - - - - - - -
- - -

Class Overview

-

Class to construct promotion related fields for Google Analytics hits. The fields from this class - can be used to represent internal promotions that run within an app, such as banners, banner ads - etc. - - Typical usage: -

- 

-          ScreenViewBuilder builder = new HitBuilders.ScreenViewBuilder();
-
-          builder.setPromotionAction(Promotion.ACTION_CLICK)
-              .addPromotion(new Promotion().setId("PROMO-ID1234").setName("Home screen banner."))
-          tracker.send(builder.build());
-
-

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_CLICK - Action to use when the user clicks/taps on a promotion. - - - -
StringACTION_VIEW - Action to use when the user views a promotion. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Promotion() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Promotion - - setCreative(String value) - -
- Sets the name of the creative associated with the promotion. - - - -
- -
- - - - - - Promotion - - setId(String value) - -
- Sets the id that is used to identify a promotion in GA reports. - - - -
- -
- - - - - - Promotion - - setName(String value) - -
- Sets the name that is used to identify the promotion in GA reports. - - - -
- -
- - - - - - Promotion - - setPosition(String value) - -
- Sets the position of the promotion. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_CLICK -

-
- - - - -
-
- - - - -

Action to use when the user clicks/taps on a promotion. -

- - -
- Constant Value: - - - "click" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_VIEW -

-
- - - - -
-
- - - - -

Action to use when the user views a promotion. -

- - -
- Constant Value: - - - "view" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Promotion - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Promotion - - setCreative - (String value) -

-
-
- - - -
-
- - - - -

Sets the name of the creative associated with the promotion.

-
-
Parameters
- - - - -
value - The promotion creative's name. Example: "Cool pets creative"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Promotion - - setId - (String value) -

-
-
- - - -
-
- - - - -

Sets the id that is used to identify a promotion in GA reports.

-
-
Parameters
- - - - -
value - The promotion's id.
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Promotion - - setName - (String value) -

-
-
- - - -
-
- - - - -

Sets the name that is used to identify the promotion in GA reports.

-
-
Parameters
- - - - -
value - The promotion's name. Example: "Home Banner"
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - Promotion - - setPosition - (String value) -

-
-
- - - -
-
- - - - -

Sets the position of the promotion.

-
-
Parameters
- - - - -
value - The promotion's position. Example: "top" or "bottom".
-
-
-
Returns
-
  • Returns the same object to enable chaining of methods. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/ecommerce/package-summary.html b/docs/html/reference/com/google/android/gms/analytics/ecommerce/package-summary.html deleted file mode 100644 index 7ca0b687e86f..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/ecommerce/package-summary.html +++ /dev/null @@ -1,908 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.analytics.ecommerce | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.analytics.ecommerce

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
Product - Class to construct product related information for a Google Analytics hit.  - - - -
ProductAction - Class to construct transaction/checkout or other product interaction related information for a - Google Analytics hit.  - - - -
Promotion - Class to construct promotion related fields for Google Analytics hits.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/analytics/package-summary.html b/docs/html/reference/com/google/android/gms/analytics/package-summary.html deleted file mode 100644 index 59826acd2425..000000000000 --- a/docs/html/reference/com/google/android/gms/analytics/package-summary.html +++ /dev/null @@ -1,1141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.analytics | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.analytics

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
ExceptionParser - This interface is responsible for parsing a Throwable and providing - a short, meaningful description to report to Google Analytics.  - - - -
Logger - - This interface is deprecated. - Logger interface is deprecated. Use adb shell setprop log.tag.GAv4 DEBUG to - enable debug logging for Google Analytics. -  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AnalyticsReceiver - A BroadcastReceiver used by Google Analytics.  - - - -
AnalyticsService - An Service used by Google Analytics.  - - - -
CampaignTrackingReceiver - Google Analytics receiver for com.android.vending.INSTALL_REFERRER.  - - - -
CampaignTrackingService - Service for processing Google Play Store's INSTALL_REFERRER intent.  - - - -
ExceptionReporter - Used to catch any uncaught exceptions and report them to Google Analytics.  - - - -
GoogleAnalytics - The top level Google Analytics singleton that provides methods for configuring Google Analytics - and creating Tracker objects.  - - - -
HitBuilders - Helper class to build a map of hit parameters and values.  - - - -
HitBuilders.AppViewBuilder - - This class is deprecated. - This class has been deprecated in favor of the new ScreenViewBuilder class. The - two classes are semantically similar but the latter is consistent across all the Google - Analytics platforms. -  - - - -
HitBuilders.EventBuilder - A Builder object to build event hits.  - - - -
HitBuilders.ExceptionBuilder - Exception builder allows you to measure the number and type of caught and uncaught crashes - and exceptions that occur in your app.  - - - -
HitBuilders.HitBuilder<T extends HitBuilder> - Internal class to provide common builder class methods.  - - - -
HitBuilders.ItemBuilder - - This class is deprecated. - This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. -  - - - -
HitBuilders.ScreenViewBuilder - Class to build a screen view hit.  - - - -
HitBuilders.SocialBuilder - A Builder object to build social event hits.  - - - -
HitBuilders.TimingBuilder - Hit builder used to collect timing related data.  - - - -
HitBuilders.TransactionBuilder - - This class is deprecated. - This class has been deprecated in favor of a richer set of APIs on all the HitBuilder - classes. With the new approach, simply use addProduct, addImpression, addPromo and setAction - to add ecommerce data to any of the hits. -  - - - -
Logger.LogLevel - - This class is deprecated. - See Logger interface for details. -  - - - -
StandardExceptionParser - This class will capture the root cause (last in a chain of causes) Throwable and report the exception type, class name, method name and thread - name.  - - - -
Tracker - Composes and sends hits to Google Analytics.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/Action.Builder.html b/docs/html/reference/com/google/android/gms/appindexing/Action.Builder.html deleted file mode 100644 index 69bc4482ba4b..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/Action.Builder.html +++ /dev/null @@ -1,2002 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Action.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Action.Builder

- - - - - - - - - extends Thing.Builder
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.Thing.Builder
    ↳com.google.android.gms.appindexing.Action.Builder
- - - - - - - -
- - -

Class Overview

-

Create a builder for an Action. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Action.Builder(String actionType) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Action - - build() - -
- Build the Action object. - - - -
- -
- - - - - - Action.Builder - - put(String key, Thing value) - -
- Sets a property of the action. - - - -
- -
- - - - - - Action.Builder - - put(String key, String value) - -
- Sets a property of the action. - - - -
- -
- - - - - - Action.Builder - - setActionStatus(String actionStatusType) - -
- Specify the status of the action. - - - -
- -
- - - - - - Action.Builder - - setName(String name) - -
- Sets the name of the action. - - - -
- -
- - - - - - Action.Builder - - setObject(Thing thing) - -
- Sets the object of the action. - - - -
- -
- - - - - - Action.Builder - - setUrl(Uri url) - -
- Sets the app URI of the action. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.appindexing.Thing.Builder - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Action.Builder - (String actionType) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Action - - build - () -

-
-
- - - -
-
- - - - -

Build the Action object. -

- -
-
- - - - -
-

- - public - - - - - Action.Builder - - put - (String key, Thing value) -

-
-
- - - -
-
- - - - -

Sets a property of the action.

-
-
Parameters
- - - - - - - -
key - The schema.org property. Must not be null.
value - The value of the schema.org property represented as a Thing. - If null, the value will be ignored. -
-
- -
-
- - - - -
-

- - public - - - - - Action.Builder - - put - (String key, String value) -

-
-
- - - -
-
- - - - -

Sets a property of the action.

-
-
Parameters
- - - - - - - -
key - The schema.org property. Must not be null.
value - The value of the schema.org property. - If null, the value will be ignored. -
-
- -
-
- - - - -
-

- - public - - - - - Action.Builder - - setActionStatus - (String actionStatusType) -

-
-
- - - -
-
- - - - -

Specify the status of the action. -

- -
-
- - - - -
-

- - public - - - - - Action.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

Sets the name of the action.

-
-
Parameters
- - - - -
name - The name of the action. -
-
- -
-
- - - - -
-

- - public - - - - - Action.Builder - - setObject - (Thing thing) -

-
-
- - - -
-
- - - - -

Sets the object of the action.

-
-
Parameters
- - - - -
thing - The object of the action. Must not be null. -
-
- -
-
- - - - -
-

- - public - - - - - Action.Builder - - setUrl - (Uri url) -

-
-
- - - -
-
- - - - -

Sets the app URI of the action.

-
-
Parameters
- - - - -
url - The app URI of the action in the - App Indexing format. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/Action.html b/docs/html/reference/com/google/android/gms/appindexing/Action.html deleted file mode 100644 index 4d98a4425ef9..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/Action.html +++ /dev/null @@ -1,2317 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Action | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Action

- - - - - - - - - extends Thing
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.Thing
    ↳com.google.android.gms.appindexing.Action
- - - - - - - -
- - -

Class Overview

-

Represents an action performed by a user. -

- To use this API, add the following to your Activity: - 

- Action action = Action.newAction(actionType, title, appUri);
- AppIndex.AppIndexApi.action(mGoogleApiClient, action);
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classAction.Builder - Create a builder for an Action.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringSTATUS_TYPE_ACTIVE - The status of an active action (i.e. - - - -
StringSTATUS_TYPE_COMPLETED - The status of a completed action. - - - -
StringSTATUS_TYPE_FAILED - The status of a failed action. - - - -
StringTYPE_ACTIVATE - The act of starting or activating a device or application. - - - -
StringTYPE_ADD - The act of editing by adding an object to a collection. - - - -
StringTYPE_BOOKMARK - The act of bookmarking an object. - - - -
StringTYPE_COMMUNICATE - The act of conveying information to another person via a communication medium (instrument) - such as speech, email, or telephone conversation. - - - -
StringTYPE_FILM - The act of capturing sound and moving images on film, video, or digitally. - - - -
StringTYPE_LIKE - The act of liking an object. - - - -
StringTYPE_LISTEN - The act of consuming audio content. - - - -
StringTYPE_PHOTOGRAPH - The act of capturing still images of objects using a camera. - - - -
StringTYPE_RESERVE - The act of making a reservation at a business such as a restaurant. - - - -
StringTYPE_SEARCH - The act of searching for an object. - - - -
StringTYPE_VIEW - The act of consuming static visual content. - - - -
StringTYPE_WANT - The act of expressing a desire about the object. - - - -
StringTYPE_WATCH - The act of watching an object. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Action - - newAction(String actionType, String objectName, Uri objectId, Uri objectAppUri) - -
- Creates a new action. - - - -
- -
- - - - static - - Action - - newAction(String actionType, String objectName, Uri objectAppUri) - -
- Creates a new action. - - - -
- -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - STATUS_TYPE_ACTIVE -

-
- - - - -
-
- - - - -

The status of an active action (i.e. an action that has started but not yet completed).

- - -
- Constant Value: - - - "http://schema.org/ActiveActionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STATUS_TYPE_COMPLETED -

-
- - - - -
-
- - - - -

The status of a completed action.

- - -
- Constant Value: - - - "http://schema.org/CompletedActionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STATUS_TYPE_FAILED -

-
- - - - -
-
- - - - -

The status of a failed action.

- - -
- Constant Value: - - - "http://schema.org/FailedActionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_ACTIVATE -

-
- - - - -
-
- - - - -

The act of starting or activating a device or application.

- - -
- Constant Value: - - - "http://schema.org/ActivateAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_ADD -

-
- - - - -
-
- - - - -

The act of editing by adding an object to a collection.

- - -
- Constant Value: - - - "http://schema.org/AddAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_BOOKMARK -

-
- - - - -
-
- - - - -

The act of bookmarking an object.

- - -
- Constant Value: - - - "http://schema.org/BookmarkAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_COMMUNICATE -

-
- - - - -
-
- - - - -

The act of conveying information to another person via a communication medium (instrument) - such as speech, email, or telephone conversation. -

- - -
- Constant Value: - - - "http://schema.org/CommunicateAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_FILM -

-
- - - - -
-
- - - - -

The act of capturing sound and moving images on film, video, or digitally.

- - -
- Constant Value: - - - "http://schema.org/FilmAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_LIKE -

-
- - - - -
-
- - - - -

The act of liking an object.

- - -
- Constant Value: - - - "http://schema.org/LikeAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_LISTEN -

-
- - - - -
-
- - - - -

The act of consuming audio content.

- - -
- Constant Value: - - - "http://schema.org/ListenAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_PHOTOGRAPH -

-
- - - - -
-
- - - - -

The act of capturing still images of objects using a camera.

- - -
- Constant Value: - - - "http://schema.org/PhotographAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_RESERVE -

-
- - - - -
-
- - - - -

The act of making a reservation at a business such as a restaurant.

- - -
- Constant Value: - - - "http://schema.org/ReserveAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_SEARCH -

-
- - - - -
-
- - - - -

The act of searching for an object.

- - -
- Constant Value: - - - "http://schema.org/SearchAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_VIEW -

-
- - - - -
-
- - - - -

The act of consuming static visual content.

- - -
- Constant Value: - - - "http://schema.org/ViewAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_WANT -

-
- - - - -
-
- - - - -

The act of expressing a desire about the object.

- - -
- Constant Value: - - - "http://schema.org/WantAction" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TYPE_WATCH -

-
- - - - -
-
- - - - -

The act of watching an object.

- - -
- Constant Value: - - - "http://schema.org/WatchAction" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Action - - newAction - (String actionType, String objectName, Uri objectId, Uri objectAppUri) -

-
-
- - - -
-
- - - - -

Creates a new action.

-
-
Parameters
- - - - - - - - - - - - - -
actionType - The schema.org action type (e.g. "http://schema.org/ListenAction").
objectName - Name of the content.
objectId - The equivalent web url for the content, if available. Can be null.
objectAppUri - The app URI of the content in the - App Indexing format. -
-
- -
-
- - - - -
-

- - public - static - - - - Action - - newAction - (String actionType, String objectName, Uri objectAppUri) -

-
-
- - - -
-
- - - - -

Creates a new action.

-
-
Parameters
- - - - - - - - - - -
actionType - The schema.org action type (e.g. "http://schema.org/ListenAction").
objectName - The name of the content.
objectAppUri - The app URI of the content in the - App Indexing format. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/AndroidAppUri.html b/docs/html/reference/com/google/android/gms/appindexing/AndroidAppUri.html deleted file mode 100644 index 1b3fd8e381f8..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/AndroidAppUri.html +++ /dev/null @@ -1,1725 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AndroidAppUri | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AndroidAppUri

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.AndroidAppUri
- - - - - - - -
- - -

Class Overview

-

Represents an Android app URI. -

- An Android app URI can refer to an Android app or a deep link into an Android app. The following - format is used: android-app://{package_id}/{scheme}/{host_path}, where the scheme and host_path - parts are optional. See the - App Indexing - documentation for more information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object object) - -
- - - - - - Uri - - getDeepLinkUri() - -
- - - - - - String - - getPackageName() - -
- - - - - - int - - hashCode() - -
- - - - static - - AndroidAppUri - - newAndroidAppUri(Uri uri) - -
- Creates a new AndroidAppUri object. - - - -
- -
- - - - static - - AndroidAppUri - - newAndroidAppUri(String packageName, Uri deepLink) - -
- Creates a new AndroidAppUri object. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - Uri - - toUri() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object object) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Uri - - getDeepLinkUri - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • deep link Uri or null, if it does not have a deep link. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPackageName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • package name. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - AndroidAppUri - - newAndroidAppUri - (Uri uri) -

-
-
- - - -
-
- - - - -

Creates a new AndroidAppUri object.

-
-
Parameters
- - - - -
uri - Uri with android-app scheme.
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if the provided URI is not a valid android-app URI. -
-
- -
-
- - - - -
-

- - public - static - - - - AndroidAppUri - - newAndroidAppUri - (String packageName, Uri deepLink) -

-
-
- - - -
-
- - - - -

Creates a new AndroidAppUri object.

-
-
Parameters
- - - - - - - -
packageName - package name for android-app Uri.
deepLink - deep link for android-app Uri.
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if the provided packageName or deepLink is not valid. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Uri - - toUri - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/AppIndex.html b/docs/html/reference/com/google/android/gms/appindexing/AppIndex.html deleted file mode 100644 index 0eab0f9d182a..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/AppIndex.html +++ /dev/null @@ -1,1410 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppIndex | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppIndex

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.AppIndex
- - - - - - - -
- - -

Class Overview

-

Main entry point for the App Indexing API. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Token to pass to addApi(Api) to enable the AppIndex features. - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>APP_INDEX_API - - This field is deprecated. - Use API instead. - - - - -
- public - static - final - AppIndexApiAppIndexApi - Methods for indexing actions that users are performing in your app to Google. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the AppIndex features. -

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - APP_INDEX_API -

-
- - - - -
-
- - - -

-

- This field is deprecated.
- Use API instead. - -

-

- - -
-
- - - - - -
-

- - public - static - final - AppIndexApi - - AppIndexApi -

-
- - - - -
-
- - - - -

Methods for indexing actions that users are performing in your app to Google. To use this - API, API must be enabled on your GoogleApiClient. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.ActionResult.html b/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.ActionResult.html deleted file mode 100644 index 2c02f71bb670..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.ActionResult.html +++ /dev/null @@ -1,1138 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppIndexApi.ActionResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppIndexApi.ActionResult

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appindexing.AppIndexApi.ActionResult
- - - - - - - -
-

-

- This interface is deprecated.
- Use start(GoogleApiClient, Action) and - end(GoogleApiClient, Action). - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - end(GoogleApiClient apiClient) - -
- Indicates that a user completed an action. - - - -
- -
- abstract - - - - - PendingResult<Status> - - getPendingResult() - -
- Represents the result of a call to the action(GoogleApiClient, Action) API. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - end - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Indicates that a user completed an action.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient configured to use the - API. The client should be connecting or connected.
-
-
-
Returns
-
  • The PendingResult which can optionally be used to determine if the call - succeeded. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - getPendingResult - () -

-
-
- - - -
-
- - - - -

Represents the result of a call to the action(GoogleApiClient, Action) API.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.AppIndexingLink.html b/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.AppIndexingLink.html deleted file mode 100644 index 19931fa75f39..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.AppIndexingLink.html +++ /dev/null @@ -1,1519 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppIndexApi.AppIndexingLink | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

AppIndexApi.AppIndexingLink

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.AppIndexApi.AppIndexingLink
- - - - - - - -
- - -

Class Overview

-

An outbound link attached to viewed content. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - UriappIndexingUrl - App URI in the App Indexing - format. - - - -
- public - - final - intviewId - View id of this link in the rendered content. - - - -
- public - - final - UriwebUrl - Optional equivalent web URL of this content. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AppIndexApi.AppIndexingLink(Uri appUri, Uri webUrl, View view) - -
- - - - - - - - AppIndexApi.AppIndexingLink(Uri appUri, View view) - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - Uri - - appIndexingUrl -

-
- - - - -
-
- - - - -

App URI in the App Indexing - format. -

- - -
-
- - - - - -
-

- - public - - final - int - - viewId -

-
- - - - -
-
- - - - -

View id of this link in the rendered content. -

- - -
-
- - - - - -
-

- - public - - final - Uri - - webUrl -

-
- - - - -
-
- - - - -

Optional equivalent web URL of this content. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AppIndexApi.AppIndexingLink - (Uri appUri, Uri webUrl, View view) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - AppIndexApi.AppIndexingLink - (Uri appUri, View view) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.html b/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.html deleted file mode 100644 index a078f8f82d5d..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/AppIndexApi.html +++ /dev/null @@ -1,1546 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppIndexApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

AppIndexApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appindexing.AppIndexApi
- - - - - - - -
- - -

Class Overview

-

Provides methods for indexing actions that users are performing in your app to Google. -

- This API can be used to personalize users' Google Search experience based on usage of your app. -

- To use this API, add the following to your Activity: - 
- protected void onCreate(...) {
-      mClient = new GoogleApiClient.Builder(getActivity())
-          .addApi(AppIndex.API).build();
-      ...
- }
-
- protected void onStart() {
-     super.onStart();
-     mClient.connect();
-     Action viewAction = Action.newAction(Action.TYPE_VIEW, title, appUri);
-     AppIndex.AppIndexApi.start(mClient, viewAction);
-     ...
- }
-
- protected void onStop() {
-  *  Action viewAction = Action.newAction(Action.TYPE_VIEW, title, appUri);
-     AppIndex.AppIndexApi.end(mClient, viewAction);
-     mClient.disconnect();
-     super.onStop();
-     ...
- }
- 
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceAppIndexApi.ActionResult - - This interface is deprecated. - Use start(GoogleApiClient, Action) and - end(GoogleApiClient, Action). -  - - - -
- - - - - classAppIndexApi.AppIndexingLink - An outbound link attached to viewed content.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - AppIndexApi.ActionResult - - action(GoogleApiClient apiClient, Action action) - -
- - This method is deprecated. - Use start(GoogleApiClient, Action) instead. - - - - -
- -
- abstract - - - - - PendingResult<Status> - - end(GoogleApiClient apiClient, Action action) - -
- Indicates that the user has ended a specific action in your app. - - - -
- -
- abstract - - - - - PendingResult<Status> - - start(GoogleApiClient apiClient, Action action) - -
- Indicates that the user has started a specific action in your app. - - - -
- -
- abstract - - - - - PendingResult<Status> - - view(GoogleApiClient apiClient, Activity activity, Intent viewIntent, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) - -
- - This method is deprecated. - Use start(GoogleApiClient, Action) instead. - - - - -
- -
- abstract - - - - - PendingResult<Status> - - view(GoogleApiClient apiClient, Activity activity, Uri appUri, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) - -
- - This method is deprecated. - Use start(GoogleApiClient, Action) instead. - - - - -
- -
- abstract - - - - - PendingResult<Status> - - viewEnd(GoogleApiClient apiClient, Activity activity, Uri appUri) - -
- - This method is deprecated. - Use start(GoogleApiClient, Action) instead. - - - - -
- -
- abstract - - - - - PendingResult<Status> - - viewEnd(GoogleApiClient apiClient, Activity activity, Intent viewIntent) - -
- - This method is deprecated. - Use end(GoogleApiClient, Action) instead. - - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - AppIndexApi.ActionResult - - action - (GoogleApiClient apiClient, Action action) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use start(GoogleApiClient, Action) instead. - -

-

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - end - (GoogleApiClient apiClient, Action action) -

-
-
- - - -
-
- - - - -

Indicates that the user has ended a specific action in your app. -

- This method should be called for instantaneous actions such as TYPE_BOOKMARK, - TYPE_LIKE, TYPE_WANT.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient configured to use the - API. The client should be connecting or connected.
action - The Action performed by the user within the app.
-
-
-
Returns
-
  • The PendingResult which can optionally be used to determine if the call - succeeded. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - start - (GoogleApiClient apiClient, Action action) -

-
-
- - - -
-
- - - - -

Indicates that the user has started a specific action in your app.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient configured to use the - API. The client should be connecting or connected.
action - The Action performed by the user within the app.
-
-
-
Returns
-
  • The PendingResult which can optionally be used to determine if the call - succeeded. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - view - (GoogleApiClient apiClient, Activity activity, Intent viewIntent, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use start(GoogleApiClient, Action) instead. - -

-

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - view - (GoogleApiClient apiClient, Activity activity, Uri appUri, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use start(GoogleApiClient, Action) instead. - -

-

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - viewEnd - (GoogleApiClient apiClient, Activity activity, Uri appUri) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use start(GoogleApiClient, Action) instead. - -

-

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - viewEnd - (GoogleApiClient apiClient, Activity activity, Intent viewIntent) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use end(GoogleApiClient, Action) instead. - -

-

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/Thing.Builder.html b/docs/html/reference/com/google/android/gms/appindexing/Thing.Builder.html deleted file mode 100644 index 33021d39733c..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/Thing.Builder.html +++ /dev/null @@ -1,1886 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Thing.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Thing.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.Thing.Builder
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Create a builder for a Thing. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Thing.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Thing - - build() - -
- Build the Thing object. - - - -
- -
- - - - - - Thing.Builder - - put(String key, Thing value) - -
- Sets a property of the content. - - - -
- -
- - - - - - Thing.Builder - - put(String key, String value) - -
- Sets a property of the content. - - - -
- -
- - - - - - Thing.Builder - - setDescription(String description) - -
- Sets the optional description of the content. - - - -
- -
- - - - - - Thing.Builder - - setId(String id) - -
- Sets the optional web URL of the content. - - - -
- -
- - - - - - Thing.Builder - - setName(String name) - -
- Sets the name of the content. - - - -
- -
- - - - - - Thing.Builder - - setType(String type) - -
- Sets the schema.org type of the content. - - - -
- -
- - - - - - Thing.Builder - - setUrl(Uri url) - -
- Sets the app URI of the content. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Thing.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Thing - - build - () -

-
-
- - - -
-
- - - - -

Build the Thing object. -

- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - put - (String key, Thing value) -

-
-
- - - -
-
- - - - -

Sets a property of the content.

-
-
Parameters
- - - - - - - -
key - The schema.org property. Must not be null.
value - The value of the schema.org property represented as a Thing. - If null, the value will be ignored. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - put - (String key, String value) -

-
-
- - - -
-
- - - - -

Sets a property of the content.

-
-
Parameters
- - - - - - - -
key - The schema.org property. Must not be null.
value - The value of the schema.org property. - If null, the value will be ignored. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

Sets the optional description of the content.

-
-
Parameters
- - - - -
description - The description of the content. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - setId - (String id) -

-
-
- - - -
-
- - - - -

Sets the optional web URL of the content.

-
-
Parameters
- - - - -
id - Set the equivalent web url for the content. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

Sets the name of the content.

-
-
Parameters
- - - - -
name - The name of the content. Must not be null. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - setType - (String type) -

-
-
- - - -
-
- - - - -

Sets the schema.org type of the content.

-
-
Parameters
- - - - -
type - The schema.org type. -
-
- -
-
- - - - -
-

- - public - - - - - Thing.Builder - - setUrl - (Uri url) -

-
-
- - - -
-
- - - - -

Sets the app URI of the content.

-
-
Parameters
- - - - -
url - The app URI of the content in the - App Indexing format. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/Thing.html b/docs/html/reference/com/google/android/gms/appindexing/Thing.html deleted file mode 100644 index 552f6e2d36c6..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/Thing.html +++ /dev/null @@ -1,1308 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Thing | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Thing

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appindexing.Thing
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Represents a generic schema.org object. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classThing.Builder - Create a builder for a Thing.  - - - -
- - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appindexing/package-summary.html b/docs/html/reference/com/google/android/gms/appindexing/package-summary.html deleted file mode 100644 index 4dcfab9d3b39..000000000000 --- a/docs/html/reference/com/google/android/gms/appindexing/package-summary.html +++ /dev/null @@ -1,987 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.appindexing | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.appindexing

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
AppIndexApi - Provides methods for indexing actions that users are performing in your app to Google.  - - - -
AppIndexApi.ActionResult - - This interface is deprecated. - Use start(GoogleApiClient, Action) and - end(GoogleApiClient, Action). -  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Action - Represents an action performed by a user.  - - - -
Action.Builder - Create a builder for an Action.  - - - -
AndroidAppUri - Represents an Android app URI.  - - - -
AppIndex - Main entry point for the App Indexing API.  - - - -
AppIndexApi.AppIndexingLink - An outbound link attached to viewed content.  - - - -
Thing - Represents a generic schema.org object.  - - - -
Thing.Builder - Create a builder for a Thing.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppState.html b/docs/html/reference/com/google/android/gms/appstate/AppState.html deleted file mode 100644 index 5ae7b656edb4..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppState.html +++ /dev/null @@ -1,1440 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppState | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

AppState

- - - - - - implements - - Freezable<AppState> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppState
- - - - - - - -
-

-

- This interface is deprecated.
- App State APIs are now deprecated. Please use Saved Games instead - (https://developers.google.com/games/services/common/concepts/savedgames). - -

- -

Class Overview

-

Data interface for retrieving app state information.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - byte[] - - getConflictData() - -
- abstract - - - - - String - - getConflictVersion() - -
- abstract - - - - - int - - getKey() - -
- abstract - - - - - byte[] - - getLocalData() - -
- abstract - - - - - String - - getLocalVersion() - -
- abstract - - - - - boolean - - hasConflict() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - byte[] - - getConflictData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - String - - getConflictVersion - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The latest known version of conflicting data from the server. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getKey - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The key associated with this app state blob. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getLocalData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The local data for this app state blob, or null if none present. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getLocalVersion - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The local version of the app state data. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasConflict - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether or not this app state has conflict data to resolve. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateBuffer.html b/docs/html/reference/com/google/android/gms/appstate/AppStateBuffer.html deleted file mode 100644 index cc5c563deba8..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppStateBuffer

- - - - - - - - - extends AbstractDataBuffer<AppState>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.appstate.AppState>
    ↳com.google.android.gms.appstate.AppStateBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of app states. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - AppState - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - AppState - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateConflictResult.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateConflictResult.html deleted file mode 100644 index a5d37b7bc1a7..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateConflictResult.html +++ /dev/null @@ -1,1359 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager.StateConflictResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppStateManager.StateConflictResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppStateManager.StateConflictResult
- - - - - - - -
- - -

Class Overview

-

Result retrieved from AppStateManager.StateResult when a conflict is detected while loading app - state. To resolve the conflict, call resolve(GoogleApiClient, int, String, byte[]) with the new desired - data and the value of StateConflictResult#getResolvedVersion provided here. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - byte[] - - getLocalData() - -
- abstract - - - - - String - - getResolvedVersion() - -
- abstract - - - - - byte[] - - getServerData() - -
- abstract - - - - - int - - getStateKey() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - byte[] - - getLocalData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Byte array containing the data that was saved locally on the device. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getResolvedVersion - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Version token to pass for resolution. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getServerData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Byte array containing the latest known data from the server. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStateKey - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The state key that had the conflict. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateDeletedResult.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateDeletedResult.html deleted file mode 100644 index 8ea1cb13c110..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateDeletedResult.html +++ /dev/null @@ -1,1156 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager.StateDeletedResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppStateManager.StateDeletedResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppStateManager.StateDeletedResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when app state data has been deleted. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getStateKey() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getStateKey - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The state key that the delete operation was applied to. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateListResult.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateListResult.html deleted file mode 100644 index 1f7e9937da7b..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateListResult.html +++ /dev/null @@ -1,1159 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager.StateListResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppStateManager.StateListResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppStateManager.StateListResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when app state data has been loaded. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - AppStateBuffer - - getStateBuffer() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - AppStateBuffer - - getStateBuffer - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Buffer containing the AppState objects for this app. Guaranteed to be - non-null, but may be empty. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateLoadedResult.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateLoadedResult.html deleted file mode 100644 index c426c2ead082..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateLoadedResult.html +++ /dev/null @@ -1,1267 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager.StateLoadedResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppStateManager.StateLoadedResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppStateManager.StateLoadedResult
- - - - - - - -
- - -

Class Overview

-

Result retrieved from AppStateManager.StateResult when app state data has been loaded successfully. - Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - byte[] - - getLocalData() - -
- abstract - - - - - int - - getStateKey() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - byte[] - - getLocalData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The data that was loaded. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStateKey - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The state key that was loaded. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateResult.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateResult.html deleted file mode 100644 index 360f63147145..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.StateResult.html +++ /dev/null @@ -1,1256 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager.StateResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AppStateManager.StateResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.appstate.AppStateManager.StateResult
- - - - - - - -
- - -

Class Overview

-

Result of an operation that could potentially generate a state conflict. Note that at most - one of getLoadedResult or getConflictResult will ever return a non-null - value. In the event of a INTERRUPTED status, both getLoadedResult - and getConflictResult will return null. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - AppStateManager.StateConflictResult - - getConflictResult() - -
- abstract - - - - - AppStateManager.StateLoadedResult - - getLoadedResult() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - AppStateManager.StateConflictResult - - getConflictResult - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - AppStateManager.StateLoadedResult - - getLoadedResult - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.html b/docs/html/reference/com/google/android/gms/appstate/AppStateManager.html deleted file mode 100644 index 88a5c7b1813d..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateManager.html +++ /dev/null @@ -1,2189 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateManager | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppStateManager

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appstate.AppStateManager
- - - - - - - -
-

-

- This class is deprecated.
- App State APIs are now deprecated. Please use Saved Games instead - (https://developers.google.com/games/services/common/concepts/savedgames). - -

- -

Class Overview

-

Main public API entry point for the AppState APIs.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceAppStateManager.StateConflictResult - Result retrieved from AppStateManager.StateResult when a conflict is detected while loading app - state.  - - - -
- - - - - interfaceAppStateManager.StateDeletedResult - Result delivered when app state data has been deleted.  - - - -
- - - - - interfaceAppStateManager.StateListResult - Result delivered when app state data has been loaded.  - - - -
- - - - - interfaceAppStateManager.StateLoadedResult - Result retrieved from AppStateManager.StateResult when app state data has been loaded successfully.  - - - -
- - - - - interfaceAppStateManager.StateResult - Result of an operation that could potentially generate a state conflict.  - - - -
- - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Token to pass to addApi(Api) to enable AppState features. - - - -
- public - static - final - ScopeSCOPE_APP_STATE - Scope for using the App State service. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - PendingResult<AppStateManager.StateDeletedResult> - - delete(GoogleApiClient googleApiClient, int stateKey) - -
- Delete the state data for the current app. - - - -
- -
- - - - static - - int - - getMaxNumKeys(GoogleApiClient googleApiClient) - -
- Gets the maximum number of keys that an app can store data in simultaneously. - - - -
- -
- - - - static - - int - - getMaxStateSize(GoogleApiClient googleApiClient) - -
- Gets the maximum app state size per state key in bytes. - - - -
- -
- - - - static - - PendingResult<AppStateManager.StateListResult> - - list(GoogleApiClient googleApiClient) - -
- Asynchronously lists all the saved states for the current app. - - - -
- -
- - - - static - - PendingResult<AppStateManager.StateResult> - - load(GoogleApiClient googleApiClient, int stateKey) - -
- Asynchronously loads saved state for the current app. - - - -
- -
- - - - static - - PendingResult<AppStateManager.StateResult> - - resolve(GoogleApiClient googleApiClient, int stateKey, String resolvedVersion, byte[] resolvedData) - -
- Resolve a previously detected conflict in app state data. - - - -
- -
- - - - static - - PendingResult<Status> - - signOut(GoogleApiClient googleApiClient) - -
- Asynchronously signs the current user out. - - - -
- -
- - - - static - - void - - update(GoogleApiClient googleApiClient, int stateKey, byte[] data) - -
- Updates app state for the current app. - - - -
- -
- - - - static - - PendingResult<AppStateManager.StateResult> - - updateImmediate(GoogleApiClient googleApiClient, int stateKey, byte[] data) - -
- Updates app state for the current app. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable AppState features.

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_APP_STATE -

-
- - - - -
-
- - - - -

Scope for using the App State service. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - PendingResult<AppStateManager.StateDeletedResult> - - delete - (GoogleApiClient googleApiClient, int stateKey) -

-
-
- - - -
-
- - - - -

Delete the state data for the current app. This method will delete all data associated with - the provided key, as well as removing the key itself. -

- Note that this API is not version safe. This means that it is possible to accidentally delete - a user's data using this API. For a version safe alternative, consider using - update(GoogleApiClient, int, byte[]) with null data instead. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
stateKey - The key to clear data for. Must be a non-negative integer less than - getMaxNumKeys(GoogleApiClient).
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - int - - getMaxNumKeys - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum number of keys that an app can store data in simultaneously. -

- If the service cannot be reached for some reason, this will return - STATUS_CLIENT_RECONNECT_REQUIRED. In this case, no further - operations should be attempted until after the client has reconnected. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum number of keys that an app can use for data. -
-
- -
-
- - - - -
-

- - public - static - - - - int - - getMaxStateSize - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum app state size per state key in bytes. Guaranteed to be at least 256 KB. May - increase in the future. -

- If the service cannot be reached for some reason, this will return - STATUS_CLIENT_RECONNECT_REQUIRED. In this case, no further - operations should be attempted until after the client has reconnected. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum state size that can be stored with a given state key in bytes. -
-
- -
-
- - - - -
-

- - public - static - - - - PendingResult<AppStateManager.StateListResult> - - list - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Asynchronously lists all the saved states for the current app. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - PendingResult<AppStateManager.StateResult> - - load - (GoogleApiClient googleApiClient, int stateKey) -

-
-
- - - -
-
- - - - -

Asynchronously loads saved state for the current app. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
stateKey - The key to load data for. Must be a non-negative integer less than - getMaxNumKeys(GoogleApiClient).
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - PendingResult<AppStateManager.StateResult> - - resolve - (GoogleApiClient googleApiClient, int stateKey, String resolvedVersion, byte[] resolvedData) -

-
-
- - - -
-
- - - - -

Resolve a previously detected conflict in app state data. Note that it is still possible to - receive a conflict callback after this call. This will occur if data on the server continues - to change. In this case, resolution should be retried until a successful status is returned. -

- The value of resolvedVersion passed here must correspond to the value returned from - getResolvedVersion(). -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - - - - - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
stateKey - The key to resolve data for. Must be a non-negative integer less than - getMaxNumKeys(GoogleApiClient).
resolvedVersion - Version code from previous onStateConflict call.
resolvedData - Data to submit as the current data. null is a valid value here. - May be a maximum of getMaxStateSize(GoogleApiClient) bytes.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - PendingResult<Status> - - signOut - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Asynchronously signs the current user out. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - void - - update - (GoogleApiClient googleApiClient, int stateKey, byte[] data) -

-
-
- - - -
-
- - - - -

Updates app state for the current app. The data provided here is developer-specified and can - be in any format appropriate for the app. This method updates the local copy of the app state - and syncs the changes to the server. If the local data conflicts with the data on the server, - this will be indicated the next time you call load(GoogleApiClient, int). -

- This is the fire-and-forget form of the API. Use this form if you don't need to know the - results of the operation immediately. For most applications, this will be the preferred API - to use. See updateImmediate(GoogleApiClient, int, byte[]) if you need the results - delivered to your application. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
stateKey - The key to update data for. Must be a non-negative integer less than - getMaxNumKeys(GoogleApiClient).
data - The data to store. May be a maximum of getMaxStateSize(GoogleApiClient) - bytes. -
-
- -
-
- - - - -
-

- - public - static - - - - PendingResult<AppStateManager.StateResult> - - updateImmediate - (GoogleApiClient googleApiClient, int stateKey, byte[] data) -

-
-
- - - -
-
- - - - -

Updates app state for the current app. The data provided here is developer-specified and can - be in any format appropriate for the app. This method will attempt to update the data on the - server immediately. The results of this operation will be returned via a PendingResult. -

- Required API: API
- Required Scopes: SCOPE_APP_STATE

-
-
Parameters
- - - - - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
stateKey - The key to update data for. Must be a non-negative integer less than - getMaxNumKeys(GoogleApiClient).
data - The data to store. May be a maximum of getMaxStateSize(GoogleApiClient) - bytes.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/AppStateStatusCodes.html b/docs/html/reference/com/google/android/gms/appstate/AppStateStatusCodes.html deleted file mode 100644 index 2213d0fb253e..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/AppStateStatusCodes.html +++ /dev/null @@ -1,2035 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppStateStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppStateStatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.appstate.AppStateStatusCodes
- - - - - - - -
- - -

Class Overview

-

Status codes for AppState results. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATUS_CLIENT_RECONNECT_REQUIRED - The GoogleApiClient is in an inconsistent state and must reconnect to the service to resolve - the issue. - - - -
intSTATUS_DEVELOPER_ERROR - Your application is incorrectly configured. - - - -
intSTATUS_INTERNAL_ERROR - An unspecified error occurred; no more specific information is available. - - - -
intSTATUS_INTERRUPTED - Was interrupted while waiting for the result. - - - -
intSTATUS_NETWORK_ERROR_NO_DATA - A network error occurred while attempting to retrieve fresh data, and no data was available - locally. - - - -
intSTATUS_NETWORK_ERROR_OPERATION_DEFERRED - A network error occurred while attempting to modify data, but the data was successfully - modified locally and will be updated on the network the next time the device is able to sync. - - - -
intSTATUS_NETWORK_ERROR_OPERATION_FAILED - A network error occurred while attempting to perform an operation that requires network - access. - - - -
intSTATUS_NETWORK_ERROR_STALE_DATA - A network error occurred while attempting to retrieve fresh data, but some locally cached - data was available. - - - -
intSTATUS_OK - The operation was successful. - - - -
intSTATUS_STATE_KEY_LIMIT_EXCEEDED - The application already has data in the maximum number of keys (data slots) and is attempting - to create a new one. - - - -
intSTATUS_STATE_KEY_NOT_FOUND - The requested state key was not found. - - - -
intSTATUS_TIMEOUT - The operation timed out while awaiting the result. - - - -
intSTATUS_WRITE_OUT_OF_DATE_VERSION - A version conflict was detected. - - - -
intSTATUS_WRITE_SIZE_EXCEEDED - A write request was submitted which contained too much data for the server. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATUS_CLIENT_RECONNECT_REQUIRED -

-
- - - - -
-
- - - - -

The GoogleApiClient is in an inconsistent state and must reconnect to the service to resolve - the issue. Further calls to the service using the current connection are unlikely to succeed. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_DEVELOPER_ERROR -

-
- - - - -
-
- - - - -

Your application is incorrectly configured. This is a hard error, since retrying will not fix - this. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INTERNAL_ERROR -

-
- - - - -
-
- - - - -

An unspecified error occurred; no more specific information is available. The device logs may - provide additional data. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INTERRUPTED -

-
- - - - -
-
- - - - -

Was interrupted while waiting for the result. Only returned if using an - PendingResult directly. -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_NO_DATA -

-
- - - - -
-
- - - - -

A network error occurred while attempting to retrieve fresh data, and no data was available - locally. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_OPERATION_DEFERRED -

-
- - - - -
-
- - - - -

A network error occurred while attempting to modify data, but the data was successfully - modified locally and will be updated on the network the next time the device is able to sync. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_OPERATION_FAILED -

-
- - - - -
-
- - - - -

A network error occurred while attempting to perform an operation that requires network - access. The operation may be retried later. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_STALE_DATA -

-
- - - - -
-
- - - - -

A network error occurred while attempting to retrieve fresh data, but some locally cached - data was available. The data returned may be stale and/or incomplete. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_OK -

-
- - - - -
-
- - - - -

The operation was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_STATE_KEY_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

The application already has data in the maximum number of keys (data slots) and is attempting - to create a new one. This is a hard error. Subsequent writes to this same key will only - succeed after some number of keys have been deleted. -

- - -
- Constant Value: - - - 2003 - (0x000007d3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_STATE_KEY_NOT_FOUND -

-
- - - - -
-
- - - - -

The requested state key was not found. This means that the server did not have data for us - when we successfully made a network request. -

- - -
- Constant Value: - - - 2002 - (0x000007d2) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_TIMEOUT -

-
- - - - -
-
- - - - -

The operation timed out while awaiting the result. Only returned if using an - PendingResult directly. -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_WRITE_OUT_OF_DATE_VERSION -

-
- - - - -
-
- - - - -

A version conflict was detected. This means that we have a local version of the data which is - out of sync with the server. -

- - -
- Constant Value: - - - 2000 - (0x000007d0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_WRITE_SIZE_EXCEEDED -

-
- - - - -
-
- - - - -

A write request was submitted which contained too much data for the server. This should only - occur if we change the app state size restrictions, or if someone is modifying their database - directly. -

- - -
- Constant Value: - - - 2001 - (0x000007d1) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/appstate/package-summary.html b/docs/html/reference/com/google/android/gms/appstate/package-summary.html deleted file mode 100644 index c8420a14dc69..000000000000 --- a/docs/html/reference/com/google/android/gms/appstate/package-summary.html +++ /dev/null @@ -1,997 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.appstate | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.appstate

-
- -
- -
- - -
- Contains classes for manipulating saved app state data. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AppState - - This interface is deprecated. - App State APIs are now deprecated. Please use Saved Games instead - (https://developers.google.com/games/services/common/concepts/savedgames). -  - - - -
AppStateManager.StateConflictResult - Result retrieved from AppStateManager.StateResult when a conflict is detected while loading app - state.  - - - -
AppStateManager.StateDeletedResult - Result delivered when app state data has been deleted.  - - - -
AppStateManager.StateListResult - Result delivered when app state data has been loaded.  - - - -
AppStateManager.StateLoadedResult - Result retrieved from AppStateManager.StateResult when app state data has been loaded successfully.  - - - -
AppStateManager.StateResult - Result of an operation that could potentially generate a state conflict.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
AppStateBuffer - Data structure providing access to a list of app states.  - - - -
AppStateManager - - This class is deprecated. - App State APIs are now deprecated. Please use Saved Games instead - (https://developers.google.com/games/services/common/concepts/savedgames). -  - - - -
AppStateStatusCodes - Status codes for AppState results.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/AccountChangeEvent.html b/docs/html/reference/com/google/android/gms/auth/AccountChangeEvent.html deleted file mode 100644 index 7cbcd468dfbe..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/AccountChangeEvent.html +++ /dev/null @@ -1,1980 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AccountChangeEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AccountChangeEvent

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.auth.AccountChangeEvent
- - - - - - - -
- - -

Class Overview

-

AccountChangeEvent instances are Parcelables that contain data - about an event for an account (e.g., the account was added, modified, etc.). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AccountChangeEventCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AccountChangeEvent(long id, String accountName, int changeType, int eventIndex, String changeData) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - String - - getAccountName() - -
- - - - - - String - - getChangeData() - -
- Extra data about the change, if any. - - - -
- -
- - - - - - int - - getChangeType() - -
- The change type of this event. - - - -
- -
- - - - - - int - - getEventIndex() - -
- The index of the event. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AccountChangeEventCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AccountChangeEvent - (long id, String accountName, int changeType, int eventIndex, String changeData) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAccountName - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getChangeData - () -

-
-
- - - -
-
- - - - -

Extra data about the change, if any. For example, in the case of a rename, this will - contain the new account name. May be null if no extra data is available. -

- -
-
- - - - -
-

- - public - - - - - int - - getChangeType - () -

-
-
- - - -
-
- - - - -

The change type of this event. Maps to constants in GoogleAuthUtil. -

- -
-
- - - - -
-

- - public - - - - - int - - getEventIndex - () -

-
-
- - - -
-
- - - - -

The index of the event. Can be used to determine if the event has been seen or not. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsRequest.html b/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsRequest.html deleted file mode 100644 index 03de1cc1b916..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsRequest.html +++ /dev/null @@ -1,1952 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AccountChangeEventsRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AccountChangeEventsRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.auth.AccountChangeEventsRequest
- - - - - - - -
- - -

Class Overview

-

Requests for AccountChangeEvents. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AccountChangeEventsRequestCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AccountChangeEventsRequest() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - Account - - getAccount() - -
- - - - - - String - - getAccountName() - -
- - This method is deprecated. - use getAccount() instead. - - - - -
- -
- - - - - - int - - getEventIndex() - -
- - - - - - AccountChangeEventsRequest - - setAccount(Account account) - -
- Sets the account to fetch events for. - - - -
- -
- - - - - - AccountChangeEventsRequest - - setAccountName(String accountName) - -
- - This method is deprecated. - use setAccount(android.accounts.Account) instead. - - - - -
- -
- - - - - - AccountChangeEventsRequest - - setEventIndex(int eventIndex) - -
- Sets the event index to restrict the results by. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AccountChangeEventsRequestCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AccountChangeEventsRequest - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Account - - getAccount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAccountName - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use getAccount() instead. - -

-

- -
-
- - - - -
-

- - public - - - - - int - - getEventIndex - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - AccountChangeEventsRequest - - setAccount - (Account account) -

-
-
- - - -
-
- - - - -

Sets the account to fetch events for. -

- -
-
- - - - -
-

- - public - - - - - AccountChangeEventsRequest - - setAccountName - (String accountName) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use setAccount(android.accounts.Account) instead. - -

-

- -
-
- - - - -
-

- - public - - - - - AccountChangeEventsRequest - - setEventIndex - (int eventIndex) -

-
-
- - - -
-
- - - - -

Sets the event index to restrict the results by. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsResponse.html b/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsResponse.html deleted file mode 100644 index 07cd7e0b68a2..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/AccountChangeEventsResponse.html +++ /dev/null @@ -1,1666 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AccountChangeEventsResponse | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AccountChangeEventsResponse

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.auth.AccountChangeEventsResponse
- - - - - - - -
- - -

Class Overview

-

Response to a AccountChangeEventsRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AccountChangeEventsResponseCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AccountChangeEventsResponse(List<AccountChangeEvent> events) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - List<AccountChangeEvent> - - getEvents() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AccountChangeEventsResponseCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AccountChangeEventsResponse - (List<AccountChangeEvent> events) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<AccountChangeEvent> - - getEvents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html b/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html deleted file mode 100644 index 44fa0c3786f2..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html +++ /dev/null @@ -1,1836 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleAuthException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GoogleAuthException

- - - - - - - - - - - - - extends Exception
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.auth.GoogleAuthException
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

GoogleAuthExceptions signal Google authentication errors. In contrast to IOExceptions, - GoogleAuthExceptions imply that authentication shouldn't simply be retried. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GoogleAuthException() - -
- - - - - - - - GoogleAuthException(String err) - -
- - - - - - - - GoogleAuthException(String msg, Throwable throwable) - -
- - - - - - - - GoogleAuthException(Throwable throwable) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GoogleAuthException - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - GoogleAuthException - (String err) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - GoogleAuthException - (String msg, Throwable throwable) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - GoogleAuthException - (Throwable throwable) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html b/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html deleted file mode 100644 index 456d4a342713..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html +++ /dev/null @@ -1,3533 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleAuthUtil | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GoogleAuthUtil

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.auth.GoogleAuthUtil
- - - - - - - -
- - -

Class Overview

-

GoogleAuthUtil provides static utility methods to acquire and invalidate - authentication tokens. - - 

-   public void onCreate {
-       // onCreate is called on the main thread, so you must do the work in
-       // a background thread, which AsyncTask makes easy to do.
-       getAndUseAuthTokenInAsyncTask();
-   }
-
-   ...
-
-   protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-       if (requestCode == MY_ACTIVITYS_AUTH_REQUEST_CODE) {
-           if (resultCode == RESULT_OK) {
-               getAndUseAuthTokenInAsyncTask();
-           }
-       }
-   }
-
-   // Example of how to use the GoogleAuthUtil in a blocking, non-main thread context
-   void getAndUseAuthTokenBlocking() {
-       try {
-          // Retrieve a token for the given account and scope. It will always return either
-          // a non-empty String or throw an exception.
-          final String token = GoogleAuthUtil.getToken(context, email, scope);
-          // Do work with token.
-          ...
-          if (server indicates token is invalid) {
-              // invalidate the token that we found is bad so that GoogleAuthUtil won't
-              // return it next time (it may have cached it)
-              GoogleAuthUtil.invalidateToken(Context, String)(context, token);
-              // consider retrying getAndUseTokenBlocking() once more
-              return;
-          }
-          return;
-       } catch (GooglePlayServicesAvailabilityException playEx) {
-         Dialog alert = GooglePlayServicesUtil.getErrorDialog(
-             playEx.getConnectionStatusCode(),
-             this,
-             MY_ACTIVITYS_AUTH_REQUEST_CODE);
-         ...
-       } catch (UserRecoverableAuthException userAuthEx) {
-          // Start the user recoverable action using the intent returned by
-          // getIntent()
-          myActivity.startActivityForResult(
-                  userAuthEx.getIntent(),
-                  MY_ACTIVITYS_AUTH_REQUEST_CODE);
-          return;
-       } catch (IOException transientEx) {
-          // network or server error, the call is expected to succeed if you try again later.
-          // Don't attempt to call again immediately - the request is likely to
-          // fail, you'll hit quotas or back-off.
-          ...
-          return;
-       } catch (GoogleAuthException authEx) {
-          // Failure. The call is not expected to ever succeed so it should not be
-          // retried.
-          ...
-          return;
-       }
-   }
-
-   // Example of how to use AsyncTask to call blocking code on a background thread.
-   void getAndUseAuthTokenInAsyncTask() {
-       AsyncTask task = new AsyncTask() {
-           @Override
-           protected Void doInBackground(Void... params) {
-               getAndUseAuthTokenBlocking();
-           }
-       };
-       task.execute((Void)null);
-   }
-
- -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCHANGE_TYPE_ACCOUNT_ADDED - Change types that can be represented in an AccountChangeEvent. - - - -
intCHANGE_TYPE_ACCOUNT_REMOVED - - - - -
intCHANGE_TYPE_ACCOUNT_RENAMED_FROM - A rename event that will contain extra data indicating the original account name. - - - -
intCHANGE_TYPE_ACCOUNT_RENAMED_TO - A rename event that will contain extra data indicating the new account name. - - - -
StringGOOGLE_ACCOUNT_TYPE - Google Account type string. - - - -
StringKEY_REQUEST_ACTIONS - Bundle key for specifying which user's app activity (moment) types can - be written to Google. - - - -
StringKEY_REQUEST_VISIBLE_ACTIVITIES - See KEY_REQUEST_ACTIONS - - - - -
StringKEY_SUPPRESS_PROGRESS_SCREEN - Adding KEY_SUPPRESS_PROGRESS will suppress the progress screen shown - when getting a token when added as a boolean true option while - calling getToken(Context, String, String, Bundle). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - void - - clearToken(Context context, String token) - -
- Clear the specified token in local cache with respect to the Context. - - - -
- -
- - - - static - - List<AccountChangeEvent> - - getAccountChangeEvents(Context ctx, int eventIndex, String accountName) - -
- Get a list of events for the given account. - - - -
- -
- - - - static - - String - - getAccountId(Context ctx, String accountName) - -
- Gets a stable account id for the given account name. - - - -
- -
- - - - static - - String - - getToken(Context context, String accountName, String scope) - -
- - This method is deprecated. - Use getToken(Context, Account, String) instead. - - - - -
- -
- - - - static - - String - - getToken(Context context, Account account, String scope, Bundle extras) - -
- Gets a token to be consumed by some specified services on behalf of a - specified user account. - - - -
- -
- - - - static - - String - - getToken(Context context, String accountName, String scope, Bundle extras) - -
- - This method is deprecated. - Use getToken(Context, Account, String, Bundle) instead. - - - - -
- -
- - - - static - - String - - getToken(Context context, Account account, String scope) - -
- - - - static - - String - - getTokenWithNotification(Context context, String accountName, String scope, Bundle extras, Intent callback) - -
- - This method is deprecated. - Use getTokenWithNotification(Context, Account, String, Bundle, Intent) - instead. - - - - -
- -
- - - - static - - String - - getTokenWithNotification(Context context, String accountName, String scope, Bundle extras, String authority, Bundle syncBundle) - -
- - This method is deprecated. - Use - getTokenWithNotification(Context, Account, String, Bundle, String, Bundle) - instead. - - - - -
- -
- - - - static - - String - - getTokenWithNotification(Context context, Account account, String scope, Bundle extras, String authority, Bundle syncBundle) - -
- Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. - - - -
- -
- - - - static - - String - - getTokenWithNotification(Context context, String accountName, String scope, Bundle extras) - -
- - This method is deprecated. - Use getTokenWithNotification(Context, Account, String, Bundle) instead. - - - - -
- -
- - - - static - - String - - getTokenWithNotification(Context context, Account account, String scope, Bundle extras) - -
- Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. - - - -
- -
- - - - static - - String - - getTokenWithNotification(Context context, Account account, String scope, Bundle extras, Intent callback) - -
- Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. - - - -
- -
- - - - static - - void - - invalidateToken(Context context, String token) - -
- - This method is deprecated. - Deprecated because this function needs permissions - MANAGE_ACCOUNTS and USE_CREDENTIALS to run. Please call - clearToken(Context, String) instead. - - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CHANGE_TYPE_ACCOUNT_ADDED -

-
- - - - -
-
- - - - -

Change types that can be represented in an AccountChangeEvent. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CHANGE_TYPE_ACCOUNT_REMOVED -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CHANGE_TYPE_ACCOUNT_RENAMED_FROM -

-
- - - - -
-
- - - - -

A rename event that will contain extra data indicating the original account name.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CHANGE_TYPE_ACCOUNT_RENAMED_TO -

-
- - - - -
-
- - - - -

A rename event that will contain extra data indicating the new account name.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GOOGLE_ACCOUNT_TYPE -

-
- - - - -
-
- - - - -

Google Account type string. Used for various calls to AccountManager. -

- - -
- Constant Value: - - - "com.google" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_REQUEST_ACTIONS -

-
- - - - -
-
- - - - -

Bundle key for specifying which user's app activity (moment) types can - be written to Google. The list of activity types are represented as a - space-separated string passed in the extras Bundle when calling getToken(Context, String, String, Bundle). - -

- This bundle key should be included in the extras Bundle when calling - getToken(Context, String, String, Bundle) and - should only be used when requesting the PLUS_LOGIN OAuth 2.0 scope. - - See Types of - moments for the full list of valid activity types. Example usage: - 

-     Bundle bundle = new Bundle();
-     bundle.putString(GoogleAuthUtil.KEY_REQUEST_ACTIONS,
-              "http://schemas.google.com/AddActivity http://schemas.google.com/BuyActivity");
-     String token = GoogleAuthUtil.getToken(context, account, Scopes.PLUS_LOGIN, bundle);
-
-

- - -
- Constant Value: - - - "request_visible_actions" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_REQUEST_VISIBLE_ACTIVITIES -

-
- - - - -
-
- - - - -

See KEY_REQUEST_ACTIONS -

- - -
- Constant Value: - - - "request_visible_actions" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_SUPPRESS_PROGRESS_SCREEN -

-
- - - - -
-
- - - - -

Adding KEY_SUPPRESS_PROGRESS will suppress the progress screen shown - when getting a token when added as a boolean true option while - calling getToken(Context, String, String, Bundle). This is - useful for apps that provide their own splash screens on initialization. -

- - -
- Constant Value: - - - "suppressProgressScreen" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - clearToken - (Context context, String token) -

-
-
- - - -
-
- - - - -

Clear the specified token in local cache with respect to the Context. - Note that the context must be the same as that used to initialize - the token in a previous call to - getToken(Context, String, String) or - getToken(Context, String, String, Bundle).

-
-
Parameters
- - - - - - - -
context - Context of the token.
token - The token to clear. -
-
-
-
Throws
- - - - - - - - - - -
GooglePlayServicesAvailabilityException -
GoogleAuthException -
IOException -
-
- -
-
- - - - -
-

- - public - static - - - - List<AccountChangeEvent> - - getAccountChangeEvents - (Context ctx, int eventIndex, String accountName) -

-
-
- - - -
-
- - - - -

Get a list of events for the given account. The result is in reverse chronological order.

-
-
Parameters
- - - - - - - -
eventIndex - An event index to restrict results by. If 0 then all events will - be fetched. Otherwise, events greater than this index will be fetched. Callers can - store the last event index seen and use this field to limit results to only events - more recent than the ones seen prior.
accountName - The account name to restrict the event list to. -
-
-
-
Throws
- - - - - - - -
GoogleAuthException -
IOException -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getAccountId - (Context ctx, String accountName) -

-
-
- - - -
-
- - - - -

Gets a stable account id for the given account name. - In the event of a missing id, user intervention may be required. In such - cases, a UserRecoverableAuthException will be thrown. - To initiate the user recovery workflow, clients must start the - Intent returned by - getIntent() for result. Upon - successfully returning a client should invoke this method again to get - an id.

-
-
Throws
- - - - - - - - - - - - - - - - -
GooglePlayServicesAvailabilityException - containing the appropriate - connection status error code.
UserRecoverableAuthException - wrapping an Intent for initiating - user intervention. The wrapped intent must be called with startActivityForResult(Intent, int).
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getToken - (Context context, String accountName, String scope) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getToken(Context, Account, String) instead. - -

-

-
-
Throws
- - - - - - - - - - -
IOException -
UserRecoverableAuthException -
GoogleAuthException -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - String - - getToken - (Context context, Account account, String scope, Bundle extras) -

-
-
- - - -
-
- - - - -

Gets a token to be consumed by some specified services on behalf of a - specified user account. How the token is consumed depends - on the scope string provided. Note that this method requires substantial - network IO and thus should be run off the UI thread. In the event of an - error, one of several Exceptions will be thrown. -

- In the case of a transient (typically network related) error a - IOException will be thrown. It is left to clients to implement - a backoff/abandonment strategy appropriate to their latency - requirements. If user intervention is required to provide consent, enter - a password, etc, a UserRecoverableAuthException will be thrown. - To initiate the user recovery workflow, clients must start the - Intent returned by - getIntent() for result. Upon - successfully returning a client should invoke this method again to get - a token. In the cases of errors that are neither transient nor - recoverable by the the user, a GoogleAuthException will be - thrown. These errors will typically result from client errors (e.g. - providing an invalid scope). -

- By way of example, client code might have a block of code executing in a - locally declared implementation of Thread or - AsyncTask as follows: - 

- String token = null;
- try {
-     token = GoogleAuthUtil.getToken(context, account, scope, bundle);
- } catch (GooglePlayServicesAvailabilityException playEx) {
-     Dialog dialog = GooglePlayServicesUtil.getErrorDialog(
-         playEx.getConnectionStatusCode(),
-         Activity.this,
-         AUTH_REQUEST_CODE);
-     // Use the dialog to present to the user.
- } catch (UserRecoverableAuthException recoverableException) {
-     Intent recoveryIntent = recoverableException.getIntent();
-     // Use the intent in a custom dialog or just startActivityForResult.
-     Activity.this.startActivityForResult(recoveryIntent, REQUEST_CODE);
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
-     return;
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
-     return;
- }
- if (token != null) {
-     makeNetworkApiCallwithToken(token);
- }
-
-

- Those clients that have their own splash screens may wish to suppress - the progress screen provided by Google Play services. The - "Signing in..." progress screen provided by Google Play services by - including setting KEY_SUPPRESS_PROGRESS_SCREEN to true - in the supplied options Bundle.

-
-
Parameters
- - - - - - - - - - - - - -
context - Context associated with the desired token.
account - Authenticating user account.
scope - String representing the authentication scope. To specify - multiple scopes, separate them with a space (for example, - "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - - - - -
GooglePlayServicesAvailabilityException - containing the appropriate - connection status error code.
UserRecoverableAuthException - wrapping an Intent for initiating - user intervention. The wrapped intent must be called with startActivityForResult(Intent, int).
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getToken - (Context context, String accountName, String scope, Bundle extras) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getToken(Context, Account, String, Bundle) instead. - -

-

Gets a token to be consumed by some specified services on behalf of a - specified user account. How the token is consumed depends - on the scope string provided. Note that this method requires substantial - network IO and thus should be run off the UI thread. In the event of an - error, one of several Exceptions will be thrown. -

- In the case of a transient (typically network related) error a - IOException will be thrown. It is left to clients to implement - a backoff/abandonment strategy appropriate to their latency - requirements. If user intervention is required to provide consent, enter - a password, etc, a UserRecoverableAuthException will be thrown. - To initiate the user recovery workflow, clients must start the - Intent returned by - getIntent() for result. Upon - successfully returning a client should invoke this method again to get - a token. In the cases of errors that are neither transient nor - recoverable by the the user, a GoogleAuthException will be - thrown. These errors will typically result from client errors (e.g. - providing an invalid scope). -

- By way of example, client code might have a block of code executing in a - locally declared implementation of Thread or - AsyncTask as follows: - 

- String token = null;
- try {
-     token = GoogleAuthUtil.getToken(context, accountName, scope, bundle);
- } catch (GooglePlayServicesAvailabilityException playEx) {
-     Dialog dialog = GooglePlayServicesUtil.getErrorDialog(
-         playEx.getConnectionStatusCode(),
-         Activity.this,
-         AUTH_REQUEST_CODE);
-     // Use the dialog to present to the user.
- } catch (UserRecoverableAuthException recoverableException) {
-     Intent recoveryIntent = recoverableException.getIntent();
-     // Use the intent in a custom dialog or just startActivityForResult.
-     Activity.this.startActivityForResult(recoveryIntent, REQUEST_CODE);
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
-     return;
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
-     return;
- }
- if (token != null) {
-     makeNetworkApiCallwithToken(token);
- }
-
-

- Those clients that have their own splash screens may wish to suppress - the progress screen provided by Google Play services. The - "Signing in..." progress screen provided by Google Play services by - including setting KEY_SUPPRESS_PROGRESS_SCREEN to true - in the supplied options Bundle.

-
-
Parameters
- - - - - - - - - - - - - -
context - Context associated with the desired token.
accountName - String representing the authenticating user account.
scope - String representing the authentication scope. To specify - multiple scopes, separate them with a space (for example, - "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - - - - -
GooglePlayServicesAvailabilityException - containing the appropriate - connection status error code.
UserRecoverableAuthException - wrapping an Intent for initiating - user intervention. The wrapped intent must be called with startActivityForResult(Intent, int).
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread.
-
- -
-
- - - - -
-

- - public - static - - - - String - - getToken - (Context context, Account account, String scope) -

-
-
- - - -
-
- - - - -

-
-
Throws
- - - - - - - - - - -
IOException -
UserRecoverableAuthException -
GoogleAuthException -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, String accountName, String scope, Bundle extras, Intent callback) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getTokenWithNotification(Context, Account, String, Bundle, Intent) - instead. - -

-

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for background tasks. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. After the - user addresses the notification, the callback is broadcasted. If the user cancels then the - callback is not fired. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(
-         context, accountName, scope, extras, callback);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - - - - -
context - Context associated with the desired token.
accountName - String representing the authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
callback - A broadcast intent with a valid receiver that has been exported for other - apps to send broadcasts to it. This intent must be serializable using - toUri(Intent.URI_INTENT_SCHEME) and Intent.parseUri(intentUri, Intent.URI_INTENT_SCHEME). - Cannot be null.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread.
-
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, String accountName, String scope, Bundle extras, String authority, Bundle syncBundle) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use - getTokenWithNotification(Context, Account, String, Bundle, String, Bundle) - instead. - -

-

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for sync adaptors. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. After the - user addresses the notification, a sync request will be kicked off using the given params. - If the user cancels then the sync is not fired. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(
-         context, accountName, scope, extras, authority, syncBundle);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
context - Context associated with the desired token.
accountName - String representing the authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
authority - Authority for firing a sync request. Must not be empty or null.
syncBundle - extras for firing a sync request. This bundle must pass - ContentResolver.validateSyncExtrasBundle(). If no extras are needed can a null value - can be passed.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread.
-
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, Account account, String scope, Bundle extras, String authority, Bundle syncBundle) -

-
-
- - - -
-
- - - - -

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for sync adaptors. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. After the - user addresses the notification, a sync request will be kicked off using the given params. - If the user cancels then the sync is not fired. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(
-         context, account, scope, extras, authority, syncBundle);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
context - Context associated with the desired token.
account - Authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
authority - Authority for firing a sync request. Must not be empty or null.
syncBundle - extras for firing a sync request. This bundle must pass - ContentResolver.validateSyncExtrasBundle(). If no extras are needed can a null value - can be passed.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, String accountName, String scope, Bundle extras) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getTokenWithNotification(Context, Account, String, Bundle) instead. - -

-

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for background tasks. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(context, accountName, scope, extras);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - -
context - Context associated with the desired token.
accountName - String representing the authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread.
-
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, Account account, String scope, Bundle extras) -

-
-
- - - -
-
- - - - -

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for background tasks. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(context, account, scope, extras);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - -
context - Context associated with the desired token.
account - Authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getTokenWithNotification - (Context context, Account account, String scope, Bundle extras, Intent callback) -

-
-
- - - -
-
- - - - -

Authenticates the user and returns a valid Google authentication token, or throws an - Exception if there was an error while getting the token. -

- This method is specifically provided for background tasks. In the event of an error that - needs user intervention, this method takes care of pushing relevant notification. After the - user addresses the notification, the callback is broadcasted. If the user cancels then the - callback is not fired. -

- The exception thrown depends upon the underlying error and support for - recovery. UserRecoverableNotifiedException will be thrown if the error can be - resolved by user intervention and a notification has already been posted to address it. - IOExceptions will be thrown if the underlying error - might be solved by some intelligent retry strategy. Alternatively, - GoogleAuthExceptions represent a broad class of - Exceptions that cannot be recovered programmatically. - - 

- String token;
- try {
-     token = GoogleAuthUtil.getTokenWithNotification(
-         context, account, scope, extras, callback);
- } catch (UserRecoverableNotifiedException userNotifiedException) {
-     // Notification has already been pushed.
-     // Continue without token or stop background task.
- } catch (GoogleAuthException authEx) {
-     // This is likely unrecoverable.
-     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMessage(), authEx);
- } catch (IOException ioEx) {
-     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
-     doExponentialBackoff();
- }
-

-
-
Parameters
- - - - - - - - - - - - - - - - -
context - Context associated with the desired token.
account - Authenticating user account.
scope - String representing the authentication scope. To specify multiple scopes, - separate them with a space (for example, "oauth2:scope1 scope2 scope3").
extras - Bundle containing additional information that may be - relevant to the authentication scope.
callback - A broadcast intent with a valid receiver that has been exported for other - apps to send broadcasts to it. This intent must be serializable using - toUri(Intent.URI_INTENT_SCHEME) and Intent.parseUri(intentUri, Intent.URI_INTENT_SCHEME). - Cannot be null.
-
-
-
Returns
-
  • String containing a valid token.
-
-
-
Throws
- - - - - - - - - - - - - -
UserRecoverableNotifiedException - if a user addressable error occurred and a - notification was pushed.
GoogleAuthException - signaling a potentially unrecoverable - authentication error.
IOException - signaling a potentially transient error.
IllegalStateException - if the method is invoked in the main - event thread. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - invalidateToken - (Context context, String token) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Deprecated because this function needs permissions - MANAGE_ACCOUNTS and USE_CREDENTIALS to run. Please call - clearToken(Context, String) instead. - -

-

Invalidates the specified token with respect to the Context. - Note that the context must be the same as that used to initialize - the token in a previous call to - getToken(Context, String, String) or - getToken(Context, String, String, Bundle).

-
-
Parameters
- - - - - - - -
context - Context of the token.
token - String containing the token to invalidate.
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html b/docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html deleted file mode 100644 index 24cde9fc6324..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html +++ /dev/null @@ -1,1696 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GooglePlayServicesAvailabilityException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GooglePlayServicesAvailabilityException

- - - - - - - - - - - - - - - - - - - - - extends UserRecoverableAuthException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.auth.GoogleAuthException
      ↳com.google.android.gms.auth.UserRecoverableAuthException
       ↳com.google.android.gms.auth.GooglePlayServicesAvailabilityException
- - - - - - - -
- - -

Class Overview

-

GooglePlayServicesAvailabilityExceptions are special instances of - UserRecoverableAuthExceptions which are thrown when the expected Google Play services app - is not available for some reason. In these cases client code can use - getConnectionStatusCode() in conjunction with - getErrorDialog(int, android.app.Activity, int) - to provide users with a localized Dialog that will allow users to install, - update, or otherwise enable Google Play services. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getConnectionStatusCode() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.auth.UserRecoverableAuthException - -
- - -
-
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getConnectionStatusCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html b/docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html deleted file mode 100644 index 8ef23240f66e..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html +++ /dev/null @@ -1,1737 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserRecoverableAuthException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

UserRecoverableAuthException

- - - - - - - - - - - - - - - - - extends GoogleAuthException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.auth.GoogleAuthException
      ↳com.google.android.gms.auth.UserRecoverableAuthException
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

UserRecoverableAuthExceptions signal Google authentication errors that can be recovered with user - action, such as a user login. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - UserRecoverableAuthException(String msg, Intent intent) - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Intent - - getIntent() - -
- Getter for an Intent that when supplied to startActivityForResult(Intent, int), will allow user intervention. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - UserRecoverableAuthException - (String msg, Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Intent - - getIntent - () -

-
-
- - - -
-
- - - - -

Getter for an Intent that when supplied to startActivityForResult(Intent, int), will allow user intervention.

-
-
Returns
-
  • Intent representing the ameliorating user action. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html b/docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html deleted file mode 100644 index f68780c848d4..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html +++ /dev/null @@ -1,1618 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserRecoverableNotifiedException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

UserRecoverableNotifiedException

- - - - - - - - - - - - - - - - - extends GoogleAuthException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.auth.GoogleAuthException
      ↳com.google.android.gms.auth.UserRecoverableNotifiedException
- - - - - - - -
- - -

Class Overview

-

UserRecoverableNotifiedException signals that there was a Google authentication error which can - be recovered with user action and has been handled by publishing a notification for the user - to act on. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - UserRecoverableNotifiedException(String err) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - UserRecoverableNotifiedException - (String err) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/auth/package-summary.html b/docs/html/reference/com/google/android/gms/auth/package-summary.html deleted file mode 100644 index d875b6b6e2b6..000000000000 --- a/docs/html/reference/com/google/android/gms/auth/package-summary.html +++ /dev/null @@ -1,984 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.auth | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.auth

-
- -
- -
- - -
- Contains classes for authenticating Google accounts. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AccountChangeEvent - AccountChangeEvent instances are Parcelables that contain data - about an event for an account (e.g., the account was added, modified, etc.).  - - - -
AccountChangeEventsRequest - Requests for AccountChangeEvents.  - - - -
AccountChangeEventsResponse - Response to a AccountChangeEventsRequest.  - - - -
GoogleAuthUtil - GoogleAuthUtil provides static utility methods to acquire and invalidate - authentication tokens.  - - - -
- -
- - - - - - - -

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GoogleAuthException - GoogleAuthExceptions signal Google authentication errors.  - - - -
GooglePlayServicesAvailabilityException - GooglePlayServicesAvailabilityExceptions are special instances of - UserRecoverableAuthExceptions which are thrown when the expected Google Play services app - is not available for some reason.  - - - -
UserRecoverableAuthException - UserRecoverableAuthExceptions signal Google authentication errors that can be recovered with user - action, such as a user login.  - - - -
UserRecoverableNotifiedException - UserRecoverableNotifiedException signals that there was a Google authentication error which can - be recovered with user action and has been handled by publishing a notification for the user - to act on.  - - - -
- -
- - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/ApplicationMetadata.html b/docs/html/reference/com/google/android/gms/cast/ApplicationMetadata.html deleted file mode 100644 index a5051fc7c168..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/ApplicationMetadata.html +++ /dev/null @@ -1,2054 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ApplicationMetadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ApplicationMetadata

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.ApplicationMetadata
- - - - - - - -
- - -

Class Overview

-

Cast application metadata. -

- Contains metadata about the receiver application, supplied in - Cast.ApplicationConnectionResult. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<ApplicationMetadata>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - areNamespacesSupported(List<String> namespaces) - -
- Tests if the application supports all of the given namespaces. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - String - - getApplicationId() - -
- Returns the application's ID. - - - -
- -
- - - - - - List<WebImage> - - getImages() - -
- Returns the list of images. - - - -
- -
- - - - - - String - - getName() - -
- Returns the application's human-readable name. - - - -
- -
- - - - - - String - - getSenderAppIdentifier() - -
- Returns the identifier of the sender application that is the counterpart to the receiver - application, if any. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isNamespaceSupported(String namespace) - -
- Tests if the application supports the given namespace. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<ApplicationMetadata> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - areNamespacesSupported - (List<String> namespaces) -

-
-
- - - -
-
- - - - -

Tests if the application supports all of the given namespaces.

-
-
Parameters
- - - - -
namespaces - The list of namespaces. -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getApplicationId - () -

-
-
- - - -
-
- - - - -

Returns the application's ID. -

- -
-
- - - - -
-

- - public - - - - - List<WebImage> - - getImages - () -

-
-
- - - -
-
- - - - -

Returns the list of images. If there are no images, returns an empty list. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the application's human-readable name. -

- -
-
- - - - -
-

- - public - - - - - String - - getSenderAppIdentifier - () -

-
-
- - - -
-
- - - - -

Returns the identifier of the sender application that is the counterpart to the receiver - application, if any. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isNamespaceSupported - (String namespace) -

-
-
- - - -
-
- - - - -

Tests if the application supports the given namespace.

-
-
Parameters
- - - - -
namespace - The namespace. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.ApplicationConnectionResult.html b/docs/html/reference/com/google/android/gms/cast/Cast.ApplicationConnectionResult.html deleted file mode 100644 index 132a2ad20353..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.ApplicationConnectionResult.html +++ /dev/null @@ -1,1320 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.ApplicationConnectionResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Cast.ApplicationConnectionResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.Cast.ApplicationConnectionResult
- - - - - - - -
- - -

Class Overview

-

When a connection to a receiver application has been established, this object contains - information about that application, including its ApplicationMetadata and current - status. If the connection fails, then all values except getStatus() will be invalid. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ApplicationMetadata - - getApplicationMetadata() - -
- Returns the current application's metadata. - - - -
- -
- abstract - - - - - String - - getApplicationStatus() - -
- Returns the current application's status. - - - -
- -
- abstract - - - - - String - - getSessionId() - -
- Returns the current application's session ID. - - - -
- -
- abstract - - - - - boolean - - getWasLaunched() - -
- Returns whether the application was freshly launched. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ApplicationMetadata - - getApplicationMetadata - () -

-
-
- - - -
-
- - - - -

Returns the current application's metadata. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getApplicationStatus - () -

-
-
- - - -
-
- - - - -

Returns the current application's status. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getSessionId - () -

-
-
- - - -
-
- - - - -

Returns the current application's session ID. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - getWasLaunched - () -

-
-
- - - -
-
- - - - -

Returns whether the application was freshly launched. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.CastApi.html b/docs/html/reference/com/google/android/gms/cast/Cast.CastApi.html deleted file mode 100644 index c54d2c8911a2..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.CastApi.html +++ /dev/null @@ -1,2677 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.CastApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Cast.CastApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.Cast.CastApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with a Google Cast device. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getActiveInputState(GoogleApiClient client) - -
- Returns the device's active-input state. - - - -
- -
- abstract - - - - - ApplicationMetadata - - getApplicationMetadata(GoogleApiClient client) - -
- Returns the metadata for the currently running receiver application, if any. - - - -
- -
- abstract - - - - - String - - getApplicationStatus(GoogleApiClient client) - -
- Returns the current receiver application status, if any. - - - -
- -
- abstract - - - - - int - - getStandbyState(GoogleApiClient client) - -
- Returns the device's standby state. - - - -
- -
- abstract - - - - - double - - getVolume(GoogleApiClient client) - -
- Returns the device's volume, in the range [0.0, 1.0]. - - - -
- -
- abstract - - - - - boolean - - isMute(GoogleApiClient client) - -
- Returns the device's mute state. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication(GoogleApiClient client) - -
- Joins (connects to) the currently running application on the receiver. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication(GoogleApiClient client, String applicationId, String sessionId) - -
- Joins (connects to) an application on the receiver. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication(GoogleApiClient client, String applicationId) - -
- Joins (connects to) the currently running application on the receiver. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication(GoogleApiClient client, String applicationId, LaunchOptions launchOptions) - -
- Launches an application on the receiver. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication(GoogleApiClient client, String applicationId) - -
- Launches an application on the receiver. - - - -
- -
- abstract - - - - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication(GoogleApiClient client, String applicationId, boolean relaunchIfRunning) - -
- - This method is deprecated. - Use - launchApplication(GoogleApiClient, String, LaunchOptions). - - - - -
- -
- abstract - - - - - PendingResult<Status> - - leaveApplication(GoogleApiClient client) - -
- Leaves (disconnects from) the receiver application. - - - -
- -
- abstract - - - - - void - - removeMessageReceivedCallbacks(GoogleApiClient client, String namespace) - -
- Removes a Cast.MessageReceivedCallback from this controller for a given namespace. - - - -
- -
- abstract - - - - - void - - requestStatus(GoogleApiClient client) - -
- Requests the receiver's current status. - - - -
- -
- abstract - - - - - PendingResult<Status> - - sendMessage(GoogleApiClient client, String namespace, String message) - -
- Sends a message to the currently connected application. - - - -
- -
- abstract - - - - - void - - setMessageReceivedCallbacks(GoogleApiClient client, String namespace, Cast.MessageReceivedCallback callbacks) - -
- Sets a new Cast.MessageReceivedCallback listener on this controller for a given - namespace. - - - -
- -
- abstract - - - - - void - - setMute(GoogleApiClient client, boolean mute) - -
- Mutes or unmutes the device's audio. - - - -
- -
- abstract - - - - - void - - setVolume(GoogleApiClient client, double volume) - -
- Sets the device volume. - - - -
- -
- abstract - - - - - PendingResult<Status> - - stopApplication(GoogleApiClient client) - -
- Stops any running receiver application(s). - - - -
- -
- abstract - - - - - PendingResult<Status> - - stopApplication(GoogleApiClient client, String sessionId) - -
- Stops the currently running receiver application, optionally doing so only if its session - ID matches the supplied one. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getActiveInputState - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the device's active-input state.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ApplicationMetadata - - getApplicationMetadata - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the metadata for the currently running receiver application, if any.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Returns
-
  • The application metadata, or null if no application is currently running - on the receiver.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getApplicationStatus - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the current receiver application status, if any. Message text is localized to the - Google Cast device's locale.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Returns
-
  • The application status text, or null if no application is currently - running on the receiver or if the receiver application has not provided any - status text.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStandbyState - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the device's standby state. The returned value is - STANDBY_STATE_UNKNOWN, STANDBY_STATE_NO, or - STANDBY_STATE_YES.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - double - - getVolume - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the device's volume, in the range [0.0, 1.0].

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isMute - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the device's mute state.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Throws
- - - - -
IllegalStateException - If there is no active service connection. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Joins (connects to) the currently running application on the receiver. The previous - PendingResult will be canceled with the Cast.ApplicationConnectionResult's - status code being CANCELED.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication - (GoogleApiClient client, String applicationId, String sessionId) -

-
-
- - - -
-
- - - - -

Joins (connects to) an application on the receiver. The previous PendingResult - will be canceled with the Cast.ApplicationConnectionResult's status code being - CANCELED.

-
-
Parameters
- - - - - - - - - - -
client - The API client with which to perform this request. Must not be - null.
applicationId - The ID of the receiver application to connect to, or null to - connect to the currently running application.
sessionId - The expected session ID of the receiver application, or null to - connect without checking for a matching session ID.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - joinApplication - (GoogleApiClient client, String applicationId) -

-
-
- - - -
-
- - - - -

Joins (connects to) the currently running application on the receiver. The previous - PendingResult will be canceled with the Cast.ApplicationConnectionResult's - status code being CANCELED.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
applicationId - The ID of the receiver application to connect to, or null to - connect to the currently running application.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication - (GoogleApiClient client, String applicationId, LaunchOptions launchOptions) -

-
-
- - - -
-
- - - - -

Launches an application on the receiver. The previous PendingResult will be - canceled with the Cast.ApplicationConnectionResult's status code being - CANCELED.

-
-
Parameters
- - - - - - - - - - -
client - The API client with which to perform this request. Must not be - null.
applicationId - The ID of the receiver application to launch.
launchOptions - The launch options for the request.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication - (GoogleApiClient client, String applicationId) -

-
-
- - - -
-
- - - - -

Launches an application on the receiver. If the application is already running, it is - joined (not relaunched). The previous PendingResult will be canceled with the - Cast.ApplicationConnectionResult's status code being CANCELED.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
applicationId - The ID of the receiver application to launch.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Cast.ApplicationConnectionResult> - - launchApplication - (GoogleApiClient client, String applicationId, boolean relaunchIfRunning) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use - launchApplication(GoogleApiClient, String, LaunchOptions). - -

-

Launches an application on the receiver. The previous PendingResult will be - canceled with the Cast.ApplicationConnectionResult's status code being - CANCELED.

-
-
Parameters
- - - - - - - - - - -
client - The API client with which to perform this request. Must not be - null.
applicationId - The ID of the receiver application to launch.
relaunchIfRunning - If true, relaunches the application if it is already - running.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve connection information.
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - leaveApplication - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Leaves (disconnects from) the receiver application. If there is no currently active - application session, this method does nothing. If this method is called while - stopApplication(GoogleApiClient) is pending, then this method does nothing. The Status's - status code will be INVALID_REQUEST.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve if the command was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - removeMessageReceivedCallbacks - (GoogleApiClient client, String namespace) -

-
-
- - - -
-
- - - - -

Removes a Cast.MessageReceivedCallback from this controller for a given namespace.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
namespace - The namespace of the Cast channel. Namespaces must begin with the prefix - "urn:x-cast:".
-
-
-
Throws
- - - - - - - -
IOException - If an I/O error occurs while performing the request.
IllegalArgumentException - If namespace is null or empty. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - requestStatus - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Requests the receiver's current status.

-
-
Throws
- - - - - - - -
IllegalStateException - If there is no active service connection.
IOException - If an I/O error occurs while performing the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - sendMessage - (GoogleApiClient client, String namespace, String message) -

-
-
- - - -
-
- - - - -

Sends a message to the currently connected application.

-
-
Parameters
- - - - - - - - - - -
client - The API client with which to perform this request. Must not be - null.
namespace - The namespace for the message. Namespaces must begin with the prefix " - urn:x-cast:".
message - The message payload.
-
-
-
Returns
-
  • A PendingResult which can be used to see whether the message has been - enqueued to be sent to a Google Cast device. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setMessageReceivedCallbacks - (GoogleApiClient client, String namespace, Cast.MessageReceivedCallback callbacks) -

-
-
- - - -
-
- - - - -

Sets a new Cast.MessageReceivedCallback listener on this controller for a given - namespace. The new listener will replace an existing listener for a given - namespace. Messages received by the controller for the given namespace - will be forwarded to this listener. The caller must have already called - connect() and received - onConnected(Bundle) callback.

-
-
Parameters
- - - - - - - - - - -
client - The API client with which to perform this request. Must not be - null.
namespace - The namespace of the Cast channel. Namespaces must begin with the prefix - "urn:x-cast:".
callbacks - The Cast.MessageReceivedCallback to perform callbacks on. May not be - null.
-
-
-
Throws
- - - - - - - - - - -
IOException - If an I/O error occurs while performing the request.
IllegalStateException - Thrown when the controller is not connected to a - CastDevice.
IllegalArgumentException - If namespace is null or empty, or if the - namespace doesn't start with the prefix "urn:x-cast:". -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setMute - (GoogleApiClient client, boolean mute) -

-
-
- - - -
-
- - - - -

Mutes or unmutes the device's audio.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
mute - Whether to mute or unmute the audio.
-
-
-
Throws
- - - - - - - -
IllegalStateException - If there is no active service connection.
IOException - If an I/O error occurs while performing the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setVolume - (GoogleApiClient client, double volume) -

-
-
- - - -
-
- - - - -

Sets the device volume. If volume is outside of the range [0.0, 1.0], then the - value will be clipped.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
volume - The new volume, in the range [0.0, 1.0].
-
-
-
Throws
- - - - - - - - - - -
IllegalStateException - If there is no active service connection.
IllegalArgumentException - If the volume is infinity or NaN.
IOException - If an I/O error occurs while performing the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - stopApplication - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Stops any running receiver application(s). If this method is called while - leaveApplication(GoogleApiClient) is pending, then this method does nothing. The - Status's status code will be INVALID_REQUEST.

-
-
Parameters
- - - - -
client - The API client with which to perform this request. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve if the command was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - stopApplication - (GoogleApiClient client, String sessionId) -

-
-
- - - -
-
- - - - -

Stops the currently running receiver application, optionally doing so only if its session - ID matches the supplied one. If this method is called while - leaveApplication(GoogleApiClient) is pending, then this method does nothing. The - Status's status code will be INVALID_REQUEST.

-
-
Parameters
- - - - - - - -
client - The API client with which to perform this request. Must not be - null.
sessionId - The session ID of the application to stop. sessionId cannot be - null or an empty string.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve if the command was - successful. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.Builder.html b/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.Builder.html deleted file mode 100644 index 02275f22381a..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.Builder.html +++ /dev/null @@ -1,1370 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.CastOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Cast.CastOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.Cast.CastOptions.Builder
- - - - - - - -
- - -

Class Overview

-

A builder to create an instance of Cast.CastOptions to set - API configuration parameters for Cast. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Cast.CastOptions - - build() - -
- Builds a CastOptions with the arguments supplied to this builder. - - - -
- -
- - - - - - Cast.CastOptions.Builder - - setVerboseLoggingEnabled(boolean enabled) - -
- Enables or disables verbose logging for this Cast session. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Cast.CastOptions - - build - () -

-
-
- - - -
-
- - - - -

Builds a CastOptions with the arguments supplied to this builder. -

- -
-
- - - - -
-

- - public - - - - - Cast.CastOptions.Builder - - setVerboseLoggingEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Enables or disables verbose logging for this Cast session. This option is provided - to aid in testing and debugging, and should not be enabled in release builds. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.html b/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.html deleted file mode 100644 index efb786f3a969..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.CastOptions.html +++ /dev/null @@ -1,1379 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.CastOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Cast.CastOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.HasOptions - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.Cast.CastOptions
- - - - - - - -
- - -

Class Overview

-

API configuration parameters for Cast. The Cast.CastOptions.Builder is used - to create an instance of Cast.CastOptions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classCast.CastOptions.Builder - A builder to create an instance of Cast.CastOptions to set - API configuration parameters for Cast.  - - - -
- - - - - - - - - - -
Public Methods
- - - - static - - Cast.CastOptions.Builder - - builder(CastDevice castDevice, Cast.Listener castListener) - -
- Configures the Cast API to connect to this Google Cast device. - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Cast.CastOptions.Builder - - builder - (CastDevice castDevice, Cast.Listener castListener) -

-
-
- - - -
-
- - - - -

Configures the Cast API to connect to this Google Cast device.

-
-
Parameters
- - - - - - - -
castDevice - The Cast receiver device returned from the MediaRouteProvider. May not - be null.
castListener - The listener for Cast events. May not be null.
-
-
-
Returns
-
  • A builder for the Cast ApiOptions. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.Listener.html b/docs/html/reference/com/google/android/gms/cast/Cast.Listener.html deleted file mode 100644 index 543f421d1336..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.Listener.html +++ /dev/null @@ -1,1706 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.Listener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Cast.Listener

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.Cast.Listener
- - - - - - - -
- - -

Class Overview

-

The list of Cast callbacks. These callbacks may get called at any time, when - connected to a Google Cast device. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Cast.Listener() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onActiveInputStateChanged(int activeInputState) - -
- Called when the active-input state of the device has changed. - - - -
- -
- - - - - - void - - onApplicationDisconnected(int statusCode) - -
- Called when the connection to the receiver application has been lost, such as when - another client has launched a new application. - - - -
- -
- - - - - - void - - onApplicationMetadataChanged(ApplicationMetadata applicationMetadata) - -
- Called when the application metadata of the currently running receiver application has - changed. - - - -
- -
- - - - - - void - - onApplicationStatusChanged() - -
- Called when the status of the connected application has changed. - - - -
- -
- - - - - - void - - onStandbyStateChanged(int standbyState) - -
- Called when the standby state of the device has changed. - - - -
- -
- - - - - - void - - onVolumeChanged() - -
- Called when the device's volume or mute state has changed. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Cast.Listener - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onActiveInputStateChanged - (int activeInputState) -

-
-
- - - -
-
- - - - -

Called when the active-input state of the device has changed.

-
-
Parameters
- - - - -
activeInputState - The new active-input state. One of the constants - ACTIVE_INPUT_STATE_UNKNOWN, ACTIVE_INPUT_STATE_NO, - ACTIVE_INPUT_STATE_YES. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onApplicationDisconnected - (int statusCode) -

-
-
- - - -
-
- - - - -

Called when the connection to the receiver application has been lost, such as when - another client has launched a new application.

-
-
Parameters
- - - - -
statusCode - A status code indicating the reason for the disconnect. One of the - error constants defined in CastStatusCodes. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onApplicationMetadataChanged - (ApplicationMetadata applicationMetadata) -

-
-
- - - -
-
- - - - -

Called when the application metadata of the currently running receiver application has - changed. This will happen whenever a receiver application launches or terminates.

-
-
Parameters
- - - - -
applicationMetadata - The new application metadata. May be null if - no application is currently running. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onApplicationStatusChanged - () -

-
-
- - - -
-
- - - - -

Called when the status of the connected application has changed. -

- -
-
- - - - -
-

- - public - - - - - void - - onStandbyStateChanged - (int standbyState) -

-
-
- - - -
-
- - - - -

Called when the standby state of the device has changed.

-
-
Parameters
- - - - -
standbyState - The new standby state. One of the constants - STANDBY_STATE_UNKNOWN, STANDBY_STATE_NO, or - STANDBY_STATE_YES. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onVolumeChanged - () -

-
-
- - - -
-
- - - - -

Called when the device's volume or mute state has changed. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.MessageReceivedCallback.html b/docs/html/reference/com/google/android/gms/cast/Cast.MessageReceivedCallback.html deleted file mode 100644 index 18f963053b1a..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.MessageReceivedCallback.html +++ /dev/null @@ -1,1137 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast.MessageReceivedCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Cast.MessageReceivedCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.Cast.MessageReceivedCallback
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

The interface to process received messages from a CastDevice. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMessageReceived(CastDevice castDevice, String namespace, String message) - -
- Called when a message is received from a given CastDevice. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMessageReceived - (CastDevice castDevice, String namespace, String message) -

-
-
- - - -
-
- - - - -

Called when a message is received from a given CastDevice.

-
-
Parameters
- - - - - - - - - - -
castDevice - The castDevice from whence the message originated.
namespace - The namespace of the received message.
message - The received payload for the message. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/Cast.html b/docs/html/reference/com/google/android/gms/cast/Cast.html deleted file mode 100644 index 7c4eedf76c28..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/Cast.html +++ /dev/null @@ -1,1993 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cast | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Cast

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.Cast
- - - - - - - -
- - -

Class Overview

-

Main entry point for the Cast APIs. This class provides APIs and interfaces to access Google Cast - devices. -

- To use the service, construct a GoogleApiClient.Builder and pass API to - addApi(Api). Once you have your GoogleApiClient, call - connect() and wait for the - onConnected(Bundle) method to be called. -

- Device discovery on Android is performed using the Android MediaRouter APIs that debuted in - Jellybean MR2 (API level 18). The MediaRouter APIs are implemented in the Android v7 Support - Library. These APIs provide a simple mechanism for discovering media destinations, such as - Chromecasts, bluetooth speakers, Android-powered smart TVs, and other media playback devices; and - for routing media content to and controlling playback on those endpoints. These endpoints are - referred to as “media routes.” -

    -
  1. The first step to using these APIs is to acquire the MediaRouter singleton. It is important - for the application to hold on to the reference to this singleton for as long as the application - will be using the MediaRouter APIs; otherwise it may get garbage collected at an inopportune - time.
    2. -
  2. Next, an appropriate route selector must be constructed. The purpose of the route selector is - to filter the routes down to only those that the application is interested in such as Cast - devices. It is also possible to filter the routes further by supported receiver application, in - the (typical) case where the sender application expects to use a specific one.
    3. -
  3. Third, a MediaRouter callback is constructed. This callback has methods that will be called - by the MediaRouter whenever a route becomes available or unavailable or a route is selected by - the user.
    4. -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceCast.ApplicationConnectionResult - When a connection to a receiver application has been established, this object contains - information about that application, including its ApplicationMetadata and current - status.  - - - -
- - - - - interfaceCast.CastApi - The main entry point for interacting with a Google Cast device.  - - - -
- - - - - classCast.CastOptions - API configuration parameters for Cast.  - - - -
- - - - - classCast.Listener - The list of Cast callbacks.  - - - -
- - - - - interfaceCast.MessageReceivedCallback - The interface to process received messages from a CastDevice.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intACTIVE_INPUT_STATE_NO - A constant indicating that the Google Cast device is not the currently active video input. - - - -
intACTIVE_INPUT_STATE_UNKNOWN - A constant indicating that it is not known (and/or not possible to know) whether the Google - Cast device is the currently active video input. - - - -
intACTIVE_INPUT_STATE_YES - A constant indicating that the Google Cast device is the currently active video input. - - - -
StringEXTRA_APP_NO_LONGER_RUNNING - A boolean extra for the connection hint bundle passed to onConnected(Bundle) - that indicates that the connection was re-established, but the receiver application that - was in use at the time of the connection loss is no longer running on the receiver. - - - -
intMAX_MESSAGE_LENGTH - The maximum raw message length (in bytes) that is supported by a Cast channel. - - - -
intMAX_NAMESPACE_LENGTH - The maximum length (in characters) of a namespace name. - - - -
intSTANDBY_STATE_NO - A constant indicating that the Google Cast device is not currently in standby. - - - -
intSTANDBY_STATE_UNKNOWN - A constant indicating that it is not known (and/or not possible to know) whether the Google - Cast device is currently in standby. - - - -
intSTANDBY_STATE_YES - A constant indicating that the Google Cast device is currently in standby. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Cast.CastOptions>API - Token to pass to addApi(Api) to enable the Cast features. - - - -
- public - static - final - Cast.CastApiCastApi - An implementation of the CastApi interface. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ACTIVE_INPUT_STATE_NO -

-
- - - - -
-
- - - - -

A constant indicating that the Google Cast device is not the currently active video input. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ACTIVE_INPUT_STATE_UNKNOWN -

-
- - - - -
-
- - - - -

A constant indicating that it is not known (and/or not possible to know) whether the Google - Cast device is the currently active video input. Active input state can only be reported when - the Google Cast device is connected to a TV or AVR with CEC support. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ACTIVE_INPUT_STATE_YES -

-
- - - - -
-
- - - - -

A constant indicating that the Google Cast device is the currently active video input. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_APP_NO_LONGER_RUNNING -

-
- - - - -
-
- - - - -

A boolean extra for the connection hint bundle passed to onConnected(Bundle) - that indicates that the connection was re-established, but the receiver application that - was in use at the time of the connection loss is no longer running on the receiver. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_APP_NO_LONGER_RUNNING" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_MESSAGE_LENGTH -

-
- - - - -
-
- - - - -

The maximum raw message length (in bytes) that is supported by a Cast channel. -

- - -
- Constant Value: - - - 65536 - (0x00010000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_NAMESPACE_LENGTH -

-
- - - - -
-
- - - - -

The maximum length (in characters) of a namespace name. -

- - -
- Constant Value: - - - 128 - (0x00000080) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STANDBY_STATE_NO -

-
- - - - -
-
- - - - -

A constant indicating that the Google Cast device is not currently in standby. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STANDBY_STATE_UNKNOWN -

-
- - - - -
-
- - - - -

A constant indicating that it is not known (and/or not possible to know) whether the Google - Cast device is currently in standby. Standby state can only be reported when the Google - Cast device is connected to a TV or AVR with CEC support. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STANDBY_STATE_YES -

-
- - - - -
-
- - - - -

A constant indicating that the Google Cast device is currently in standby. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Cast.CastOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the Cast features. -

- - -
-
- - - - - -
-

- - public - static - final - Cast.CastApi - - CastApi -

-
- - - - -
-
- - - - -

An implementation of the CastApi interface. The interface is used to interact with a cast - device. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/CastDevice.html b/docs/html/reference/com/google/android/gms/cast/CastDevice.html deleted file mode 100644 index 2e0e16ab331d..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/CastDevice.html +++ /dev/null @@ -1,2824 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CastDevice | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CastDevice

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.CastDevice
- - - - - - - -
- - -

Class Overview

-

An object representing a Cast receiver device. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCAPABILITY_AUDIO_IN - Audio-input device capability. - - - -
intCAPABILITY_AUDIO_OUT - Audio-output device capability. - - - -
intCAPABILITY_VIDEO_IN - Video-input device capability. - - - -
intCAPABILITY_VIDEO_OUT - Video-output device capability. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<CastDevice>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - String - - getDeviceId() - -
- Gets the unique ID for the device. - - - -
- -
- - - - - - String - - getDeviceVersion() - -
- Gets the device's version. - - - -
- -
- - - - - - String - - getFriendlyName() - -
- Gets the friendly name for the device. - - - -
- -
- - - - static - - CastDevice - - getFromBundle(Bundle extras) - -
- Returns the CastDevice from extras, otherwise null. - - - -
- -
- - - - - - WebImage - - getIcon(int preferredWidth, int preferredHeight) - -
- Returns a best-fit icon for the requested icon size. - - - -
- -
- - - - - - List<WebImage> - - getIcons() - -
- Returns a list of all of the device's icons. - - - -
- -
- - - - - - Inet4Address - - getIpAddress() - -
- Gets the IPv4 address of the device. - - - -
- -
- - - - - - String - - getModelName() - -
- Gets the model name for the device. - - - -
- -
- - - - - - int - - getServicePort() - -
- Gets the device's service port. - - - -
- -
- - - - - - boolean - - hasCapabilities(int[] capabilities) - -
- Tests if the device supports a given set of capabilities. - - - -
- -
- - - - - - boolean - - hasCapability(int capability) - -
- Tests if the device supports a given capability. - - - -
- -
- - - - - - boolean - - hasIcons() - -
- Checks if the device has any icons. - - - -
- -
- - - - - - int - - hashCode() - -
- Overridden to return a hashcode of the device ID. - - - -
- -
- - - - - - boolean - - isOnLocalNetwork() - -
- Returns true if this CastDevice is on the local network. - - - -
- -
- - - - - - boolean - - isSameDevice(CastDevice castDevice) - -
- Tests if this device refers to the same physical Cast device as castDevice. - - - -
- -
- - - - - - void - - putInBundle(Bundle bundle) - -
- Writes the CastDevice to bundle. - - - -
- -
- - - - - - String - - toString() - -
- Returns a string representation of the device. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CAPABILITY_AUDIO_IN -

-
- - - - -
-
- - - - -

Audio-input device capability. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CAPABILITY_AUDIO_OUT -

-
- - - - -
-
- - - - -

Audio-output device capability. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CAPABILITY_VIDEO_IN -

-
- - - - -
-
- - - - -

Video-input device capability. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CAPABILITY_VIDEO_OUT -

-
- - - - -
-
- - - - -

Video-output device capability. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<CastDevice> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getDeviceId - () -

-
-
- - - -
-
- - - - -

Gets the unique ID for the device. -

- -
-
- - - - -
-

- - public - - - - - String - - getDeviceVersion - () -

-
-
- - - -
-
- - - - -

Gets the device's version. -

- -
-
- - - - -
-

- - public - - - - - String - - getFriendlyName - () -

-
-
- - - -
-
- - - - -

Gets the friendly name for the device. -

- -
-
- - - - -
-

- - public - static - - - - CastDevice - - getFromBundle - (Bundle extras) -

-
-
- - - -
-
- - - - -

Returns the CastDevice from extras, otherwise null. -

- -
-
- - - - -
-

- - public - - - - - WebImage - - getIcon - (int preferredWidth, int preferredHeight) -

-
-
- - - -
-
- - - - -

Returns a best-fit icon for the requested icon size. -

- -
-
- - - - -
-

- - public - - - - - List<WebImage> - - getIcons - () -

-
-
- - - -
-
- - - - -

Returns a list of all of the device's icons. If there are no images, returns an empty list. -

- -
-
- - - - -
-

- - public - - - - - Inet4Address - - getIpAddress - () -

-
-
- - - -
-
- - - - -

Gets the IPv4 address of the device. -

- -
-
- - - - -
-

- - public - - - - - String - - getModelName - () -

-
-
- - - -
-
- - - - -

Gets the model name for the device. -

- -
-
- - - - -
-

- - public - - - - - int - - getServicePort - () -

-
-
- - - -
-
- - - - -

Gets the device's service port. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasCapabilities - (int[] capabilities) -

-
-
- - - -
-
- - - - -

Tests if the device supports a given set of capabilities.

-
-
Parameters
- - - - -
capabilities - The set capabilities for which to test. The expected value is one or more - of the following constants: CAPABILITY_AUDIO_IN, - CAPABILITY_AUDIO_OUT, CAPABILITY_VIDEO_IN, or - CAPABILITY_VIDEO_OUT. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasCapability - (int capability) -

-
-
- - - -
-
- - - - -

Tests if the device supports a given capability.

-
-
Parameters
- - - - -
capability - The capability to test for. The expected value is one of the following - constants: CAPABILITY_AUDIO_IN, CAPABILITY_AUDIO_OUT, - CAPABILITY_VIDEO_IN, or CAPABILITY_VIDEO_OUT. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasIcons - () -

-
-
- - - -
-
- - - - -

Checks if the device has any icons. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

Overridden to return a hashcode of the device ID. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isOnLocalNetwork - () -

-
-
- - - -
-
- - - - -

Returns true if this CastDevice is on the local network. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isSameDevice - (CastDevice castDevice) -

-
-
- - - -
-
- - - - -

Tests if this device refers to the same physical Cast device as castDevice. Two - CastDevices are considered to refer to the same physical device if they have the same - device ID.

-
-
Parameters
- - - - -
castDevice - The CastDevice to test.
-
-
-
Returns
-
  • true if the device IDs are the same, else false. -
-
- -
-
- - - - -
-

- - public - - - - - void - - putInBundle - (Bundle bundle) -

-
-
- - - -
-
- - - - -

Writes the CastDevice to bundle. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

Returns a string representation of the device. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/CastMediaControlIntent.html b/docs/html/reference/com/google/android/gms/cast/CastMediaControlIntent.html deleted file mode 100644 index c3b8ada46c57..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/CastMediaControlIntent.html +++ /dev/null @@ -1,2424 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CastMediaControlIntent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CastMediaControlIntent

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.CastMediaControlIntent
- - - - - - - -
- - -

Class Overview

-

Intent constants for use with the Cast MediaRouteProvider. This class also contains utility - methods for creating a control category for discovering Cast media routes that support a specific - app and/or set of namespaces, to be used with MediaRouteSelector. - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_SYNC_STATUS - A Cast extension action for requesting the current media status when the current item ID is - not known to the client application. - - - -
StringCATEGORY_CAST - - This constant is deprecated. - use categoryForCast(String) instead. - - - - -
StringDEFAULT_MEDIA_RECEIVER_APPLICATION_ID - The application ID for the Cast Default Media Receiver. - - - -
intERROR_CODE_REQUEST_FAILED - An error code indicating that a Cast request has failed. - - - -
intERROR_CODE_SESSION_START_FAILED - An error code indicating that the request could not be processed because the session could - not be started. - - - -
intERROR_CODE_TEMPORARILY_DISCONNECTED - An error code indicating that the connection to the Cast device has been lost, but the system - is actively trying to re-establish the connection. - - - -
StringEXTRA_CAST_APPLICATION_ID - The extra that contains the ID of the application to launch for an - ACTION_START_SESSION - request. - - - -
StringEXTRA_CAST_LANGUAGE_CODE - The extra that indicates the language to be used by the receiver application. - - - -
StringEXTRA_CAST_RELAUNCH_APPLICATION - The extra that indicates whether the application should be relaunched if it is already - running (the default behavior) or whether an attempt should be made to join the application - first. - - - -
StringEXTRA_CAST_STOP_APPLICATION_WHEN_SESSION_ENDS - The extra that indicates that the receiver application should be stopped when the session - ends. - - - -
StringEXTRA_CUSTOM_DATA - The extra that contains a compact JSON string of custom data to pass with a media request. - - - -
StringEXTRA_DEBUG_LOGGING_ENABLED - The extra that indicates whether debug logging should be enabled for the Cast session. - - - -
StringEXTRA_ERROR_CODE - An error bundle extra for the error code. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - categoryForCast(String applicationId) - -
- Returns a custom control category for discovering Cast devices that support running the - specified app, independent of whether the app is running or not. - - - -
- -
- - - - static - - String - - categoryForCast(String applicationId, Collection<String> namespaces) - -
- Returns a custom control category for discovering Cast devices meeting both - application ID and namespace restrictions. - - - -
- -
- - - - static - - String - - categoryForCast(Collection<String> namespaces) - -
- Returns a custom control category for discovering Cast devices currently running an - application which supports the specified namespaces. - - - -
- -
- - - - static - - String - - categoryForRemotePlayback(String applicationId) - -
- Returns a custom control category for discovering Cast devices which support the default - Android remote playback actions using the specified Cast player. - - - -
- -
- - - - static - - String - - categoryForRemotePlayback() - -
- Returns a custom control category for discovering Cast devices which support the Default - Media Receiver. - - - -
- -
- - - - static - - String - - languageTagForLocale(Locale locale) - -
- Returns an RFC-5646 language tag string fo the given locale. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_SYNC_STATUS -

-
- - - - -
-
- - - - -

A Cast extension action for requesting the current media status when the current item ID is - not known to the client application. -

- The extra EXTRA_SESSION_ID - must be supplied in the request. The request will fail with an error if the current session - does not match this session ID, or if there is no current session. -

- The extra EXTRA_ITEM_STATUS_UPDATE_RECEIVER - may optionally be supplied in the request to attach an update receiver for the current media - item, if there is any. -

- If any media is currently loaded, the result intent will contain the extras - EXTRA_ITEM_ID, - EXTRA_ITEM_STATUS, and - EXTRA_ITEM_METADATA. - Otherwise, the result intent will be empty. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.ACTION_SYNC_STATUS" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CATEGORY_CAST -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- use categoryForCast(String) instead. - -

-

A control category for discovering Cast devices. When used as-is, matches any Cast device, - independent of app or namespace support. For restricting Cast devices by app and/or - namespaces support, use categoryForCast(String).

- - -
- Constant Value: - - - "com.google.android.gms.cast.CATEGORY_CAST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - DEFAULT_MEDIA_RECEIVER_APPLICATION_ID -

-
- - - - -
-
- - - - -

The application ID for the Cast Default Media Receiver. -

- - -
- Constant Value: - - - "CC1AD845" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_REQUEST_FAILED -

-
- - - - -
-
- - - - -

An error code indicating that a Cast request has failed. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_SESSION_START_FAILED -

-
- - - - -
-
- - - - -

An error code indicating that the request could not be processed because the session could - not be started. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_TEMPORARILY_DISCONNECTED -

-
- - - - -
-
- - - - -

An error code indicating that the connection to the Cast device has been lost, but the system - is actively trying to re-establish the connection. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CAST_APPLICATION_ID -

-
- - - - -
-
- - - - -

The extra that contains the ID of the application to launch for an - ACTION_START_SESSION - request. The value is expected to be a String. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_CAST_APPLICATION_ID" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CAST_LANGUAGE_CODE -

-
- - - - -
-
- - - - -

The extra that indicates the language to be used by the receiver application. May be - included in an - ACTION_START_SESSION - request. The value is expected to be a language tag in RFC-5646 format; a tag can be - constructed from an Locale object using - languageTagForLocale(Locale). -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_CAST_LANGUAGE_CODE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CAST_RELAUNCH_APPLICATION -

-
- - - - -
-
- - - - -

The extra that indicates whether the application should be relaunched if it is already - running (the default behavior) or whether an attempt should be made to join the application - first. May be included in an - ACTION_START_SESSION - request. The value is expected to be a boolean. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_CAST_RELAUNCH_APPLICATION" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CAST_STOP_APPLICATION_WHEN_SESSION_ENDS -

-
- - - - -
-
- - - - -

The extra that indicates that the receiver application should be stopped when the session - ends. May be included in an - ACTION_START_SESSION - request. The value is expected to be a boolean. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_CAST_STOP_APPLICATION_WHEN_SESSION_ENDS" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CUSTOM_DATA -

-
- - - - -
-
- - - - -

The extra that contains a compact JSON string of custom data to pass with a media request. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_CUSTOM_DATA" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_DEBUG_LOGGING_ENABLED -

-
- - - - -
-
- - - - -

The extra that indicates whether debug logging should be enabled for the Cast session. The - value is expected to be a boolean. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_DEBUG_LOGGING_ENABLED" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ERROR_CODE -

-
- - - - -
-
- - - - -

An error bundle extra for the error code. The value is an integer, and will be one of the - ERROR_CODE_* constants declared in this class. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.EXTRA_ERROR_CODE" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - categoryForCast - (String applicationId) -

-
-
- - - -
-
- - - - -

Returns a custom control category for discovering Cast devices that support running the - specified app, independent of whether the app is running or not.

-
-
Parameters
- - - - -
applicationId - The application ID of the receiver application.
-
-
-
Throws
- - - - -
IllegalArgumentException - If applicationId is null. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - categoryForCast - (String applicationId, Collection<String> namespaces) -

-
-
- - - -
-
- - - - -

Returns a custom control category for discovering Cast devices meeting both - application ID and namespace restrictions. See categoryForCast(Collection) and - categoryForCast(String) for more details.

-
-
Throws
- - - - -
IllegalArgumentException - If either of the parameters is null. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - categoryForCast - (Collection<String> namespaces) -

-
-
- - - -
-
- - - - -

Returns a custom control category for discovering Cast devices currently running an - application which supports the specified namespaces. Apps supporting additional namespaces - beyond those specified here are still considered supported.

-
-
Throws
- - - - -
IllegalArgumentException - If namespaces is null. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - categoryForRemotePlayback - (String applicationId) -

-
-
- - - -
-
- - - - -

Returns a custom control category for discovering Cast devices which support the default - Android remote playback actions using the specified Cast player. If the Default Media - Receiver is desired, use DEFAULT_MEDIA_RECEIVER_APPLICATION_ID as the - applicationId.

-
-
Parameters
- - - - -
applicationId - The application ID of the receiver application.
-
-
-
Throws
- - - - -
IllegalArgumentException - If applicationId is null. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - categoryForRemotePlayback - () -

-
-
- - - -
-
- - - - -

Returns a custom control category for discovering Cast devices which support the Default - Media Receiver. -

- -
-
- - - - -
-

- - public - static - - - - String - - languageTagForLocale - (Locale locale) -

-
-
- - - -
-
- - - - -

Returns an RFC-5646 language tag string fo the given locale. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/CastStatusCodes.html b/docs/html/reference/com/google/android/gms/cast/CastStatusCodes.html deleted file mode 100644 index a91ee85af271..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/CastStatusCodes.html +++ /dev/null @@ -1,2133 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CastStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CastStatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.CastStatusCodes
- - - - - - - -
- - -

Class Overview

-

Status codes for the Cast APIs. -

- Status codes for the Cast API that are returned in various callbacks as error parameter - values. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAPPLICATION_NOT_FOUND - Status code indicating that a requested application could not be found. - - - -
intAPPLICATION_NOT_RUNNING - Status code indicating that a requested application is not currently running. - - - -
intAUTHENTICATION_FAILED - Status code indicating an authentication failure. - - - -
intCANCELED - Status code indicating that an in-progress request has been canceled, most likely because - another action has preempted it. - - - -
intFAILED - Status code indicating that the in-progress request failed. - - - -
intINTERNAL_ERROR - Status code indicating that an internal error has occurred. - - - -
intINTERRUPTED - Status code indicating a blocking call was interrupted while waiting and did not run to - completion. - - - -
intINVALID_REQUEST - Status code indicating that an invalid request was made. - - - -
intMESSAGE_SEND_BUFFER_TOO_FULL - Status code indicating that a message could not be sent because there is not enough room - in the send buffer at this time. - - - -
intMESSAGE_TOO_LARGE - Status code indicating that a message could not be sent because it is too large. - - - -
intNETWORK_ERROR - Status code indicating a network I/O error. - - - -
intNOT_ALLOWED - Status code indicating that the request was disallowed and could not be completed. - - - -
intREPLACED - Status code indicating that the request's progress is no longer being tracked because another - request of the same type has been made before the first request completed. - - - -
intSUCCESS - Status code indicating no error (success). - - - -
intTIMEOUT - Status code indicating that an operation has timed out. - - - -
intUNKNOWN_ERROR - Status code indicating that an unknown, unexpected error has occurred. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - APPLICATION_NOT_FOUND -

-
- - - - -
-
- - - - -

Status code indicating that a requested application could not be found. -

- - -
- Constant Value: - - - 2004 - (0x000007d4) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - APPLICATION_NOT_RUNNING -

-
- - - - -
-
- - - - -

Status code indicating that a requested application is not currently running. -

- - -
- Constant Value: - - - 2005 - (0x000007d5) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - AUTHENTICATION_FAILED -

-
- - - - -
-
- - - - -

Status code indicating an authentication failure. -

- - -
- Constant Value: - - - 2000 - (0x000007d0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CANCELED -

-
- - - - -
-
- - - - -

Status code indicating that an in-progress request has been canceled, most likely because - another action has preempted it. -

- - -
- Constant Value: - - - 2002 - (0x000007d2) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FAILED -

-
- - - - -
-
- - - - -

Status code indicating that the in-progress request failed. -

- - -
- Constant Value: - - - 2100 - (0x00000834) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERNAL_ERROR -

-
- - - - -
-
- - - - -

Status code indicating that an internal error has occurred. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERRUPTED -

-
- - - - -
-
- - - - -

Status code indicating a blocking call was interrupted while waiting and did not run to - completion. -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVALID_REQUEST -

-
- - - - -
-
- - - - -

Status code indicating that an invalid request was made. -

- - -
- Constant Value: - - - 2001 - (0x000007d1) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MESSAGE_SEND_BUFFER_TOO_FULL -

-
- - - - -
-
- - - - -

Status code indicating that a message could not be sent because there is not enough room - in the send buffer at this time. -

- - -
- Constant Value: - - - 2007 - (0x000007d7) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MESSAGE_TOO_LARGE -

-
- - - - -
-
- - - - -

Status code indicating that a message could not be sent because it is too large. -

- - -
- Constant Value: - - - 2006 - (0x000007d6) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NETWORK_ERROR -

-
- - - - -
-
- - - - -

Status code indicating a network I/O error. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOT_ALLOWED -

-
- - - - -
-
- - - - -

Status code indicating that the request was disallowed and could not be completed. -

- - -
- Constant Value: - - - 2003 - (0x000007d3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REPLACED -

-
- - - - -
-
- - - - -

Status code indicating that the request's progress is no longer being tracked because another - request of the same type has been made before the first request completed. -

- - -
- Constant Value: - - - 2103 - (0x00000837) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

Status code indicating no error (success). -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIMEOUT -

-
- - - - -
-
- - - - -

Status code indicating that an operation has timed out. -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN_ERROR -

-
- - - - -
-
- - - - -

Status code indicating that an unknown, unexpected error has occurred. -

- - -
- Constant Value: - - - 13 - (0x0000000d) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/LaunchOptions.Builder.html b/docs/html/reference/com/google/android/gms/cast/LaunchOptions.Builder.html deleted file mode 100644 index f0f8794c0bfa..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/LaunchOptions.Builder.html +++ /dev/null @@ -1,1498 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LaunchOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

LaunchOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.LaunchOptions.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for LaunchOptions objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LaunchOptions.Builder() - -
- Constructs a new LaunchOptions.Builder. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LaunchOptions - - build() - -
- Builds and returns the LaunchOptions object. - - - -
- -
- - - - - - LaunchOptions.Builder - - setLocale(Locale locale) - -
- Sets the desired application locale. - - - -
- -
- - - - - - LaunchOptions.Builder - - setRelaunchIfRunning(boolean relaunchIfRunning) - -
- Sets the "relaunch if running" flag. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LaunchOptions.Builder - () -

-
-
- - - -
-
- - - - -

Constructs a new LaunchOptions.Builder.

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LaunchOptions - - build - () -

-
-
- - - -
-
- - - - -

Builds and returns the LaunchOptions object. -

- -
-
- - - - -
-

- - public - - - - - LaunchOptions.Builder - - setLocale - (Locale locale) -

-
-
- - - -
-
- - - - -

Sets the desired application locale. -

- -
-
- - - - -
-

- - public - - - - - LaunchOptions.Builder - - setRelaunchIfRunning - (boolean relaunchIfRunning) -

-
-
- - - -
-
- - - - -

Sets the "relaunch if running" flag. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/LaunchOptions.html b/docs/html/reference/com/google/android/gms/cast/LaunchOptions.html deleted file mode 100644 index 15511fffe1a4..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/LaunchOptions.html +++ /dev/null @@ -1,2042 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LaunchOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

LaunchOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.LaunchOptions
- - - - - - - -
- - -

Class Overview

-

An object that holds options that affect how a receiver application is launched. See - launchApplication(GoogleApiClient, String, LaunchOptions). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classLaunchOptions.Builder - A builder for LaunchOptions objects.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<LaunchOptions>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LaunchOptions() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - String - - getLanguage() - -
- Returns the language, or null if none was specified. - - - -
- -
- - - - - - boolean - - getRelaunchIfRunning() - -
- Returns the "relaunch if running" flag. - - - -
- -
- - - - - - int - - hashCode() - -
- Overridden to return a hashcode of the device ID. - - - -
- -
- - - - - - void - - setLanguage(String language) - -
- Sets the language to be used by the receiver application. - - - -
- -
- - - - - - void - - setRelaunchIfRunning(boolean relaunchIfRunning) - -
- Sets the "relaunch if running" flag. - - - -
- -
- - - - - - String - - toString() - -
- Returns a string representation of this object. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<LaunchOptions> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LaunchOptions - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getLanguage - () -

-
-
- - - -
-
- - - - -

Returns the language, or null if none was specified. -

- -
-
- - - - -
-

- - public - - - - - boolean - - getRelaunchIfRunning - () -

-
-
- - - -
-
- - - - -

Returns the "relaunch if running" flag. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

Overridden to return a hashcode of the device ID. -

- -
-
- - - - -
-

- - public - - - - - void - - setLanguage - (String language) -

-
-
- - - -
-
- - - - -

Sets the language to be used by the receiver application. If not specified, the sender - device's default language is used.

-
-
Parameters
- - - - -
language - The language -
-
- -
-
- - - - -
-

- - public - - - - - void - - setRelaunchIfRunning - (boolean relaunchIfRunning) -

-
-
- - - -
-
- - - - -

Sets the "relaunch if running" flag. If the flag is set, the receiver application will be - relaunched even if it is already running. The flag is not set by default. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

Returns a string representation of this object. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaInfo.Builder.html b/docs/html/reference/com/google/android/gms/cast/MediaInfo.Builder.html deleted file mode 100644 index 6eb0237009c7..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaInfo.Builder.html +++ /dev/null @@ -1,1828 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaInfo.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

MediaInfo.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaInfo.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for MediaInfo objects. MediaInfo is used by - RemoteMediaPlayer to load media on the receiver application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MediaInfo.Builder(String contentId) - -
- Constructs a new Builder with the given content ID. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MediaInfo - - build() - -
- Builds and returns the MediaInfo object. - - - -
- -
- - - - - - MediaInfo.Builder - - setContentType(String contentType) - -
- Sets the content (MIME) type. - - - -
- -
- - - - - - MediaInfo.Builder - - setCustomData(JSONObject customData) - -
- Sets the custom application-specific data. - - - -
- -
- - - - - - MediaInfo.Builder - - setMediaTracks(List<MediaTrack> mediaTracks) - -
- Sets the media tracks. - - - -
- -
- - - - - - MediaInfo.Builder - - setMetadata(MediaMetadata metadata) - -
- Sets the media item metadata. - - - -
- -
- - - - - - MediaInfo.Builder - - setStreamDuration(long duration) - -
- Sets the stream duration, in milliseconds. - - - -
- -
- - - - - - MediaInfo.Builder - - setStreamType(int streamType) - -
- Sets the stream type; one of the STREAM_TYPE_ constants. - - - -
- -
- - - - - - MediaInfo.Builder - - setTextTrackStyle(TextTrackStyle textTrackStyle) - -
- Sets the text track style. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MediaInfo.Builder - (String contentId) -

-
-
- - - -
-
- - - - -

Constructs a new Builder with the given content ID.

-
-
Throws
- - - - -
IllegalArgumentException - If the content ID is null or empty. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MediaInfo - - build - () -

-
-
- - - -
-
- - - - -

Builds and returns the MediaInfo object.

-
-
Throws
- - - - -
IllegalArgumentException - If all required fields have not been populated with - valid values. -
-
- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setContentType - (String contentType) -

-
-
- - - -
-
- - - - -

Sets the content (MIME) type. This is a required field.

-
-
Throws
- - - - -
IllegalArgumentException - If the content type is null or empty. -
-
- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setCustomData - (JSONObject customData) -

-
-
- - - -
-
- - - - -

Sets the custom application-specific data. -

- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setMediaTracks - (List<MediaTrack> mediaTracks) -

-
-
- - - -
-
- - - - -

Sets the media tracks. -

- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setMetadata - (MediaMetadata metadata) -

-
-
- - - -
-
- - - - -

Sets the media item metadata. -

- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setStreamDuration - (long duration) -

-
-
- - - -
-
- - - - -

Sets the stream duration, in milliseconds.

-
-
Throws
- - - - -
IllegalArgumentException - If the duration is negative. -
-
- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setStreamType - (int streamType) -

-
-
- - - -
-
- - - - -

Sets the stream type; one of the STREAM_TYPE_ constants. This is a required - field.

-
-
Throws
- - - - -
IllegalArgumentException - If the value is not one of the predefined stream type - constants. -
-
- -
-
- - - - -
-

- - public - - - - - MediaInfo.Builder - - setTextTrackStyle - (TextTrackStyle textTrackStyle) -

-
-
- - - -
-
- - - - -

Sets the text track style. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaInfo.html b/docs/html/reference/com/google/android/gms/cast/MediaInfo.html deleted file mode 100644 index 7487f427bb46..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaInfo.html +++ /dev/null @@ -1,2171 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaInfo | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MediaInfo

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaInfo
- - - - - - - -
- - -

Class Overview

-

A class that aggregates information about a media item. Use MediaInfo.Builder to - build an instance of this class. MediaInfo is used by RemoteMediaPlayer to - load media on the receiver application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMediaInfo.Builder - A builder for MediaInfo objects.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTREAM_TYPE_BUFFERED - A buffered stream type. - - - -
intSTREAM_TYPE_INVALID - An invalid (unknown) stream type. - - - -
intSTREAM_TYPE_LIVE - A live stream type. - - - -
intSTREAM_TYPE_NONE - A stream type of "none". - - - -
longUNKNOWN_DURATION - A constant indicating an unknown duration, such as for a live stream. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - String - - getContentId() - -
- Returns the content ID. - - - -
- -
- - - - - - String - - getContentType() - -
- Returns the content (MIME) type. - - - -
- -
- - - - - - JSONObject - - getCustomData() - -
- Returns the custom data, if any. - - - -
- -
- - - - - - List<MediaTrack> - - getMediaTracks() - -
- Returns the list of media tracks, or null if none have been specified. - - - -
- -
- - - - - - MediaMetadata - - getMetadata() - -
- Returns the media item metadata. - - - -
- -
- - - - - - long - - getStreamDuration() - -
- Returns the stream duration, in milliseconds. - - - -
- -
- - - - - - int - - getStreamType() - -
- Returns the stream type; one of the STREAM_TYPE_ constants. - - - -
- -
- - - - - - TextTrackStyle - - getTextTrackStyle() - -
- Returns the text track style, or null if none has been specified. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - void - - setTextTrackStyle(TextTrackStyle textTrackStyle) - -
- Sets the text track style. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STREAM_TYPE_BUFFERED -

-
- - - - -
-
- - - - -

A buffered stream type.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STREAM_TYPE_INVALID -

-
- - - - -
-
- - - - -

An invalid (unknown) stream type.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STREAM_TYPE_LIVE -

-
- - - - -
-
- - - - -

A live stream type.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STREAM_TYPE_NONE -

-
- - - - -
-
- - - - -

A stream type of "none".

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - UNKNOWN_DURATION -

-
- - - - -
-
- - - - -

A constant indicating an unknown duration, such as for a live stream.

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getContentId - () -

-
-
- - - -
-
- - - - -

Returns the content ID. -

- -
-
- - - - -
-

- - public - - - - - String - - getContentType - () -

-
-
- - - -
-
- - - - -

Returns the content (MIME) type. -

- -
-
- - - - -
-

- - public - - - - - JSONObject - - getCustomData - () -

-
-
- - - -
-
- - - - -

Returns the custom data, if any. -

- -
-
- - - - -
-

- - public - - - - - List<MediaTrack> - - getMediaTracks - () -

-
-
- - - -
-
- - - - -

Returns the list of media tracks, or null if none have been specified. -

- -
-
- - - - -
-

- - public - - - - - MediaMetadata - - getMetadata - () -

-
-
- - - -
-
- - - - -

Returns the media item metadata. -

- -
-
- - - - -
-

- - public - - - - - long - - getStreamDuration - () -

-
-
- - - -
-
- - - - -

Returns the stream duration, in milliseconds. Returns UNKNOWN_DURATION for live - streams. -

- -
-
- - - - -
-

- - public - - - - - int - - getStreamType - () -

-
-
- - - -
-
- - - - -

Returns the stream type; one of the STREAM_TYPE_ constants. -

- -
-
- - - - -
-

- - public - - - - - TextTrackStyle - - getTextTrackStyle - () -

-
-
- - - -
-
- - - - -

Returns the text track style, or null if none has been specified. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setTextTrackStyle - (TextTrackStyle textTrackStyle) -

-
-
- - - -
-
- - - - -

Sets the text track style. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaMetadata.html b/docs/html/reference/com/google/android/gms/cast/MediaMetadata.html deleted file mode 100644 index 277f34377a3c..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaMetadata.html +++ /dev/null @@ -1,4101 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaMetadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

MediaMetadata

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaMetadata
- - - - - - - -
- - -

Class Overview

-

Container class for media metadata. Metadata has a media type, an optional - list of images, and a collection of metadata fields. Keys for common - metadata fields are predefined as constants, but the application is free to - define and use additional fields of its own. -

- The values of the predefined fields have predefined types. For example, a track number is - an int and a creation date is a String containing an ISO-8601 - representation of a date and time. Attempting to store a value of an incorrect type in a field - will result in a IllegalArgumentException. -

- Note that the Cast protocol limits which metadata fields can be used for a given media type. - When a MediaMetadata object is serialized to JSON for delivery to a Cast receiver, any - predefined fields which are not supported for a given media type will not be included in the - serialized form, but any application-defined fields will always be included. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringKEY_ALBUM_ARTIST - String key: Album artist. - - - -
StringKEY_ALBUM_TITLE - String key: Album title. - - - -
StringKEY_ARTIST - String key: Artist. - - - -
StringKEY_BROADCAST_DATE - String key: Broadcast date. - - - -
StringKEY_COMPOSER - String key: Composer. - - - -
StringKEY_CREATION_DATE - String key: Creation date. - - - -
StringKEY_DISC_NUMBER - Integer key: Disc number. - - - -
StringKEY_EPISODE_NUMBER - Integer key: Episode number. - - - -
StringKEY_HEIGHT - Integer key: Height. - - - -
StringKEY_LOCATION_LATITUDE - Double key: Location latitude. - - - -
StringKEY_LOCATION_LONGITUDE - Double key: Location longitude. - - - -
StringKEY_LOCATION_NAME - String key: Location name. - - - -
StringKEY_RELEASE_DATE - String key: Release date. - - - -
StringKEY_SEASON_NUMBER - Integer key: Season number. - - - -
StringKEY_SERIES_TITLE - String key: Series title. - - - -
StringKEY_STUDIO - String key: Studio. - - - -
StringKEY_SUBTITLE - String key: Subtitle. - - - -
StringKEY_TITLE - String key: Title. - - - -
StringKEY_TRACK_NUMBER - Integer key: Track number. - - - -
StringKEY_WIDTH - Integer key: Width. - - - -
intMEDIA_TYPE_GENERIC - A media type representing generic media content. - - - -
intMEDIA_TYPE_MOVIE - A media type representing a movie. - - - -
intMEDIA_TYPE_MUSIC_TRACK - A media type representing a music track. - - - -
intMEDIA_TYPE_PHOTO - A media type representing a photo. - - - -
intMEDIA_TYPE_TV_SHOW - A media type representing an TV show. - - - -
intMEDIA_TYPE_USER - The smallest media type value that can be assigned for application-defined media types. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MediaMetadata() - -
- Constructs a new, empty, MediaMetadata with a media type of MEDIA_TYPE_GENERIC. - - - -
- -
- - - - - - - - MediaMetadata(int mediaType) - -
- Constructs a new, empty, MediaMetadata with the given media type. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - addImage(WebImage image) - -
- Adds an image to the list of images. - - - -
- -
- - - - - - void - - clear() - -
- Clears this object. - - - -
- -
- - - - - - void - - clearImages() - -
- Clears the list of images. - - - -
- -
- - - - - - boolean - - containsKey(String key) - -
- Tests if the object contains a field with the given key. - - - -
- -
- - - - - - boolean - - equals(Object other) - -
- - - - - - Calendar - - getDate(String key) - -
- Reads the value of a date field. - - - -
- -
- - - - - - String - - getDateAsString(String key) - -
- Reads the value of a date field, as a string. - - - -
- -
- - - - - - double - - getDouble(String key) - -
- Reads the value of a double field. - - - -
- -
- - - - - - List<WebImage> - - getImages() - -
- Returns the list of images. - - - -
- -
- - - - - - int - - getInt(String key) - -
- Reads the value of an int field. - - - -
- -
- - - - - - int - - getMediaType() - -
- Gets the media type. - - - -
- -
- - - - - - String - - getString(String key) - -
- Reads the value of a String field. - - - -
- -
- - - - - - boolean - - hasImages() - -
- Checks if the metadata includes any images. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - Set<String> - - keySet() - -
- Returns a set of keys for all fields that are present in the object. - - - -
- -
- - - - - - void - - putDate(String key, Calendar value) - -
- Stores a value in a date field. - - - -
- -
- - - - - - void - - putDouble(String key, double value) - -
- Stores a value in a double field. - - - -
- -
- - - - - - void - - putInt(String key, int value) - -
- Stores a value in an int field. - - - -
- -
- - - - - - void - - putString(String key, String value) - -
- Stores a value in a String field. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - KEY_ALBUM_ARTIST -

-
- - - - -
-
- - - - -

String key: Album artist. -

- The name of the artist who produced an album. For example, in compilation albums such as DJ - mixes, the album artist is not necessarily the same as the artist(s) of the individual songs - on the album. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.ALBUM_ARTIST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_ALBUM_TITLE -

-
- - - - -
-
- - - - -

String key: Album title. -

- The title of the album that a music track belongs to. This value is suitable for display - purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.ALBUM_TITLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_ARTIST -

-
- - - - -
-
- - - - -

String key: Artist. -

- The name of the artist who created the media. For example, this could be the name of a - musician, performer, or photographer. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.ARTIST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_BROADCAST_DATE -

-
- - - - -
-
- - - - -

String key: Broadcast date. -

- The value is the date and/or time at which the media was first broadcast, in ISO-8601 format. - For example, this could be the date that a TV show episode was first aired. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.BROADCAST_DATE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_COMPOSER -

-
- - - - -
-
- - - - -

String key: Composer. -

- The name of the composer of a music track. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.COMPOSER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CREATION_DATE -

-
- - - - -
-
- - - - -

String key: Creation date. -

- The value is the date and/or time at which the media was created, in ISO-8601 format. - For example, this could be the date and time at which a photograph was taken or a piece of - music was recorded. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.CREATION_DATE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_DISC_NUMBER -

-
- - - - -
-
- - - - -

Integer key: Disc number. -

- The disc number (counting from 1) that a music track belongs to in a multi-disc album. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.DISC_NUMBER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_EPISODE_NUMBER -

-
- - - - -
-
- - - - -

Integer key: Episode number. -

- The number of an episode in a given season of a TV show. Typically episode numbers are - counted starting from 1, however this value may be 0 if it is a "pilot" episode that is not - considered to be an official episode of the first season. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.EPISODE_NUMBER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_HEIGHT -

-
- - - - -
-
- - - - -

Integer key: Height. - - The height of a piece of media, in pixels. This would typically be used for providing the - dimensions of a photograph. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.HEIGHT" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_LOCATION_LATITUDE -

-
- - - - -
-
- - - - -

Double key: Location latitude. -

- The latitude component of the geographical location where a piece of media was created. - For example, this could be the location of a photograph or the principal filming location of - a movie. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.LOCATION_LATITUDE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_LOCATION_LONGITUDE -

-
- - - - -
-
- - - - -

Double key: Location longitude. -

- The longitude component of the geographical location where a piece of media was created. - For example, this could be the location of a photograph or the principal filming location of - a movie. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.LOCATION_LONGITUDE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_LOCATION_NAME -

-
- - - - -
-
- - - - -

String key: Location name. -

- The name of a location where a piece of media was created. For example, this could be the - location of a photograph or the principal filming location of a movie. This value is - suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.LOCATION_NAME" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_RELEASE_DATE -

-
- - - - -
-
- - - - -

String key: Release date. -

- The value is the date and/or time at which the media was released, in ISO-8601 format. - For example, this could be the date that a movie or music album was released. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.RELEASE_DATE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_SEASON_NUMBER -

-
- - - - -
-
- - - - -

Integer key: Season number. -

- The season number that a TV show episode belongs to. Typically season numbers are counted - starting from 1, however this value may be 0 if it is a "pilot" episode that predates the - official start of a TV series. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.SEASON_NUMBER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_SERIES_TITLE -

-
- - - - -
-
- - - - -

String key: Series title. -

- The name of a series. For example, this could be the name of a TV show or series of related - music albums. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.SERIES_TITLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_STUDIO -

-
- - - - -
-
- - - - -

String key: Studio. -

- The name of a recording studio that produced a piece of media. For example, this could be - the name of a movie studio or music label. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.STUDIO" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_SUBTITLE -

-
- - - - -
-
- - - - -

String key: Subtitle. -

- The subtitle of the media. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.SUBTITLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_TITLE -

-
- - - - -
-
- - - - -

String key: Title. -

- The title of the media. For example, this could be the title of a song, movie, or TV show - episode. This value is suitable for display purposes. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.TITLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_TRACK_NUMBER -

-
- - - - -
-
- - - - -

Integer key: Track number. -

- The track number of a music track on an album disc. Typically track numbers are counted - starting from 1, however this value may be 0 if it is a "hidden track" at the beginning of - an album. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.TRACK_NUMBER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_WIDTH -

-
- - - - -
-
- - - - -

Integer key: Width. - - The width of a piece of media, in pixels. This would typically be used for providing the - dimensions of a photograph. -

- - -
- Constant Value: - - - "com.google.android.gms.cast.metadata.WIDTH" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_GENERIC -

-
- - - - -
-
- - - - -

A media type representing generic media content.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_MOVIE -

-
- - - - -
-
- - - - -

A media type representing a movie.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_MUSIC_TRACK -

-
- - - - -
-
- - - - -

A media type representing a music track.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_PHOTO -

-
- - - - -
-
- - - - -

A media type representing a photo.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_TV_SHOW -

-
- - - - -
-
- - - - -

A media type representing an TV show.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEDIA_TYPE_USER -

-
- - - - -
-
- - - - -

The smallest media type value that can be assigned for application-defined media types.

- - -
- Constant Value: - - - 100 - (0x00000064) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MediaMetadata - () -

-
-
- - - -
-
- - - - -

Constructs a new, empty, MediaMetadata with a media type of MEDIA_TYPE_GENERIC. -

- -
-
- - - - -
-

- - public - - - - - - - MediaMetadata - (int mediaType) -

-
-
- - - -
-
- - - - -

Constructs a new, empty, MediaMetadata with the given media type.

-
-
Parameters
- - - - -
mediaType - The media type; one of the MEDIA_TYPE_* constants, or a value - greater than or equal to MEDIA_TYPE_USER for custom media types. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - addImage - (WebImage image) -

-
-
- - - -
-
- - - - -

Adds an image to the list of images. -

- -
-
- - - - -
-

- - public - - - - - void - - clear - () -

-
-
- - - -
-
- - - - -

Clears this object. The media type is left unchanged. -

- -
-
- - - - -
-

- - public - - - - - void - - clearImages - () -

-
-
- - - -
-
- - - - -

Clears the list of images. -

- -
-
- - - - -
-

- - public - - - - - boolean - - containsKey - (String key) -

-
-
- - - -
-
- - - - -

Tests if the object contains a field with the given key. -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Calendar - - getDate - (String key) -

-
-
- - - -
-
- - - - -

Reads the value of a date field.

-
-
Parameters
- - - - -
key - The field name.
-
-
-
Returns
-
  • The date, as a Calendar, or null if this field has not been set.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or the specified field's - predefined type is not a date. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDateAsString - (String key) -

-
-
- - - -
-
- - - - -

Reads the value of a date field, as a string.

-
-
Parameters
- - - - -
key - The field name.
-
-
-
Returns
-
  • The date, as a String containing hte ISO-8601 representation of the date, - or null if this field has not been set.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or the specified field's - predefined type is not a date. -
-
- -
-
- - - - -
-

- - public - - - - - double - - getDouble - (String key) -

-
-
- - - -
-
- - - - -

Reads the value of a double field.

-
-
Returns
-
  • The value of the field, or null if the field has not been set.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not a double field. -
-
- -
-
- - - - -
-

- - public - - - - - List<WebImage> - - getImages - () -

-
-
- - - -
-
- - - - -

Returns the list of images. If there are no images, returns an empty list. -

- -
-
- - - - -
-

- - public - - - - - int - - getInt - (String key) -

-
-
- - - -
-
- - - - -

Reads the value of an int field.

-
-
Returns
-
  • The value of the field, or null if the field has not been set.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not an int field. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getMediaType - () -

-
-
- - - -
-
- - - - -

Gets the media type. -

- -
-
- - - - -
-

- - public - - - - - String - - getString - (String key) -

-
-
- - - -
-
- - - - -

Reads the value of a String field.

-
-
Returns
-
  • The value of the field, or null if the field has not been set.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not a String field. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasImages - () -

-
-
- - - -
-
- - - - -

Checks if the metadata includes any images. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Set<String> - - keySet - () -

-
-
- - - -
-
- - - - -

Returns a set of keys for all fields that are present in the object. -

- -
-
- - - - -
-

- - public - - - - - void - - putDate - (String key, Calendar value) -

-
-
- - - -
-
- - - - -

Stores a value in a date field.

-
-
Parameters
- - - - - - - -
key - The key for the field.
value - The new value for the field.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not a date field. -
-
- -
-
- - - - -
-

- - public - - - - - void - - putDouble - (String key, double value) -

-
-
- - - -
-
- - - - -

Stores a value in a double field.

-
-
Parameters
- - - - - - - -
key - The key for the field.
value - The new value for the field.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not a double field. -
-
- -
-
- - - - -
-

- - public - - - - - void - - putInt - (String key, int value) -

-
-
- - - -
-
- - - - -

Stores a value in an int field.

-
-
Parameters
- - - - - - - -
key - The key for the field.
value - The new value for the field.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not an int field. -
-
- -
-
- - - - -
-

- - public - - - - - void - - putString - (String key, String value) -

-
-
- - - -
-
- - - - -

Stores a value in a String field.

-
-
Parameters
- - - - - - - -
key - The key for the field.
value - The new value for the field.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the key is null or empty or refers to a - predefined field which is not a String field. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaStatus.html b/docs/html/reference/com/google/android/gms/cast/MediaStatus.html deleted file mode 100644 index 72bf9315db07..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaStatus.html +++ /dev/null @@ -1,2708 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaStatus | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MediaStatus

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaStatus
- - - - - - - -
- - -

Class Overview

-

A class that holds status information about some media. The current MediaStatus can be - obtained from the RemoteMediaPlayer. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
longCOMMAND_PAUSE - A flag (bitmask) indicating that a media item can be paused. - - - -
longCOMMAND_SEEK - A flag (bitmask) indicating that a media item supports seeking. - - - -
longCOMMAND_SET_VOLUME - A flag (bitmask) indicating that a media item's audio volume can be changed. - - - -
longCOMMAND_SKIP_BACKWARD - A flag (bitmask) indicating that a media item supports skipping backward. - - - -
longCOMMAND_SKIP_FORWARD - A flag (bitmask) indicating that a media item supports skipping forward. - - - -
longCOMMAND_TOGGLE_MUTE - A flag (bitmask) indicating that a media item's audio can be muted. - - - -
intIDLE_REASON_CANCELED - Constant indicating that the player is idle because playback has been canceled in - response to a STOP command. - - - -
intIDLE_REASON_ERROR - Constant indicating that the player is idle because a playback error has occurred. - - - -
intIDLE_REASON_FINISHED - Constant indicating that the player is idle because playback has finished. - - - -
intIDLE_REASON_INTERRUPTED - Constant indicating that the player is idle because playback has been interrupted by - a LOAD command. - - - -
intIDLE_REASON_NONE - Constant indicating that the player currently has no idle reason. - - - -
intPLAYER_STATE_BUFFERING - Constant indicating that the media player is buffering. - - - -
intPLAYER_STATE_IDLE - Constant indicating that the media player is idle. - - - -
intPLAYER_STATE_PAUSED - Constant indicating that the media player is paused. - - - -
intPLAYER_STATE_PLAYING - Constant indicating that the media player is playing. - - - -
intPLAYER_STATE_UNKNOWN - Constant indicating unknown player state. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - long[] - - getActiveTrackIds() - -
- Returns the list of active track IDs set by the cast receiver, if any, otherwise - null. - - - -
- -
- - - - - - JSONObject - - getCustomData() - -
- Returns any custom data that is associated with the media item. - - - -
- -
- - - - - - int - - getIdleReason() - -
- Gets the player state idle reason. - - - -
- -
- - - - - - MediaInfo - - getMediaInfo() - -
- Returns the MediaInfo for this item. - - - -
- -
- - - - - - double - - getPlaybackRate() - -
- Gets the current stream playback rate. - - - -
- -
- - - - - - int - - getPlayerState() - -
- Gets the current media player state. - - - -
- -
- - - - - - long - - getStreamPosition() - -
- Returns the current stream position, in milliseconds. - - - -
- -
- - - - - - double - - getStreamVolume() - -
- Returns the stream's volume. - - - -
- -
- - - - - - boolean - - isMediaCommandSupported(long mediaCommand) - -
- Tests if the stream supports a given control command. - - - -
- -
- - - - - - boolean - - isMute() - -
- Returns the stream's mute state. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - long - - COMMAND_PAUSE -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item can be paused.

- - -
- Constant Value: - - - 1 - (0x0000000000000001) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - COMMAND_SEEK -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item supports seeking.

- - -
- Constant Value: - - - 2 - (0x0000000000000002) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - COMMAND_SET_VOLUME -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item's audio volume can be changed.

- - -
- Constant Value: - - - 4 - (0x0000000000000004) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - COMMAND_SKIP_BACKWARD -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item supports skipping backward.

- - -
- Constant Value: - - - 32 - (0x0000000000000020) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - COMMAND_SKIP_FORWARD -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item supports skipping forward.

- - -
- Constant Value: - - - 16 - (0x0000000000000010) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - COMMAND_TOGGLE_MUTE -

-
- - - - -
-
- - - - -

A flag (bitmask) indicating that a media item's audio can be muted.

- - -
- Constant Value: - - - 8 - (0x0000000000000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IDLE_REASON_CANCELED -

-
- - - - -
-
- - - - -

Constant indicating that the player is idle because playback has been canceled in - response to a STOP command. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IDLE_REASON_ERROR -

-
- - - - -
-
- - - - -

Constant indicating that the player is idle because a playback error has occurred.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IDLE_REASON_FINISHED -

-
- - - - -
-
- - - - -

Constant indicating that the player is idle because playback has finished.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IDLE_REASON_INTERRUPTED -

-
- - - - -
-
- - - - -

Constant indicating that the player is idle because playback has been interrupted by - a LOAD command. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IDLE_REASON_NONE -

-
- - - - -
-
- - - - -

Constant indicating that the player currently has no idle reason.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_STATE_BUFFERING -

-
- - - - -
-
- - - - -

Constant indicating that the media player is buffering.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_STATE_IDLE -

-
- - - - -
-
- - - - -

Constant indicating that the media player is idle.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_STATE_PAUSED -

-
- - - - -
-
- - - - -

Constant indicating that the media player is paused.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_STATE_PLAYING -

-
- - - - -
-
- - - - -

Constant indicating that the media player is playing.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_STATE_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating unknown player state.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - long[] - - getActiveTrackIds - () -

-
-
- - - -
-
- - - - -

Returns the list of active track IDs set by the cast receiver, if any, otherwise - null. -

- -
-
- - - - -
-

- - public - - - - - JSONObject - - getCustomData - () -

-
-
- - - -
-
- - - - -

Returns any custom data that is associated with the media item. -

- -
-
- - - - -
-

- - public - - - - - int - - getIdleReason - () -

-
-
- - - -
-
- - - - -

Gets the player state idle reason. This value is only meaningful if the player state is - in fact PLAYER_STATE_IDLE. -

- -
-
- - - - -
-

- - public - - - - - MediaInfo - - getMediaInfo - () -

-
-
- - - -
-
- - - - -

Returns the MediaInfo for this item. -

- -
-
- - - - -
-

- - public - - - - - double - - getPlaybackRate - () -

-
-
- - - -
-
- - - - -

Gets the current stream playback rate. This will be negative if the stream is seeking - backwards, 0 if the stream is paused, 1 if the stream is playing normally, and some other - postive value if the stream is seeking forwards. -

- -
-
- - - - -
-

- - public - - - - - int - - getPlayerState - () -

-
-
- - - -
-
- - - - -

Gets the current media player state. -

- -
-
- - - - -
-

- - public - - - - - long - - getStreamPosition - () -

-
-
- - - -
-
- - - - -

Returns the current stream position, in milliseconds. -

- -
-
- - - - -
-

- - public - - - - - double - - getStreamVolume - () -

-
-
- - - -
-
- - - - -

Returns the stream's volume. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isMediaCommandSupported - (long mediaCommand) -

-
-
- - - -
-
- - - - -

Tests if the stream supports a given control command.

-
-
Parameters
- - - - -
mediaCommand - The media command.
-
-
-
Returns
-
  • true if the command is supported, false otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isMute - () -

-
-
- - - -
-
- - - - -

Returns the stream's mute state. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaTrack.Builder.html b/docs/html/reference/com/google/android/gms/cast/MediaTrack.Builder.html deleted file mode 100644 index 60a0e57231ab..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaTrack.Builder.html +++ /dev/null @@ -1,1814 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaTrack.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

MediaTrack.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaTrack.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for MediaTrack objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MediaTrack.Builder(long trackId, int trackType) - -
- Constructs a new Builder with the given track ID and type. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MediaTrack - - build() - -
- Builds and returns the MediaTrack object. - - - -
- -
- - - - - - MediaTrack.Builder - - setContentId(String contentId) - -
- Sets the track content ID. - - - -
- -
- - - - - - MediaTrack.Builder - - setContentType(String contentType) - -
- Sets the track content type. - - - -
- -
- - - - - - MediaTrack.Builder - - setCustomData(JSONObject customData) - -
- Sets the track's custom data object. - - - -
- -
- - - - - - MediaTrack.Builder - - setLanguage(Locale locale) - -
- Sets the track language from a Locale in - RFC-5464 format. - - - -
- -
- - - - - - MediaTrack.Builder - - setLanguage(String language) - -
- Sets the RFC-5464 formatted - track language. - - - -
- -
- - - - - - MediaTrack.Builder - - setName(String trackName) - -
- Sets the track name. - - - -
- -
- - - - - - MediaTrack.Builder - - setSubtype(int subtype) - -
- Sets the track subtype with one of the SUBTYPE_ constants. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MediaTrack.Builder - (long trackId, int trackType) -

-
-
- - - -
-
- - - - -

Constructs a new Builder with the given track ID and type.

-
-
Parameters
- - - - - - - -
trackId - The unique ID of the media track.
trackType - The type of the track; one of the TYPE_ constants.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the track type is invalid. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MediaTrack - - build - () -

-
-
- - - -
-
- - - - -

Builds and returns the MediaTrack object. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setContentId - (String contentId) -

-
-
- - - -
-
- - - - -

Sets the track content ID. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setContentType - (String contentType) -

-
-
- - - -
-
- - - - -

Sets the track content type. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setCustomData - (JSONObject customData) -

-
-
- - - -
-
- - - - -

Sets the track's custom data object. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setLanguage - (Locale locale) -

-
-
- - - -
-
- - - - -

Sets the track language from a Locale in - RFC-5464 format. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setLanguage - (String language) -

-
-
- - - -
-
- - - - -

Sets the RFC-5464 formatted - track language. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setName - (String trackName) -

-
-
- - - -
-
- - - - -

Sets the track name. -

- -
-
- - - - -
-

- - public - - - - - MediaTrack.Builder - - setSubtype - (int subtype) -

-
-
- - - -
-
- - - - -

Sets the track subtype with one of the SUBTYPE_ constants.

-
-
Throws
- - - - -
IllegalArgumentException - If the subtype is invalid. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/MediaTrack.html b/docs/html/reference/com/google/android/gms/cast/MediaTrack.html deleted file mode 100644 index 228ea1e3ccd5..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/MediaTrack.html +++ /dev/null @@ -1,2551 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MediaTrack | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MediaTrack

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.MediaTrack
- - - - - - - -
- - -

Class Overview

-

A class that represents a media track, such as a language track or closed caption text track - in a video. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMediaTrack.Builder - A builder for MediaTrack objects.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSUBTYPE_CAPTIONS - A media track subtype indicating closed captions. - - - -
intSUBTYPE_CHAPTERS - A media track subtype indicating chapters. - - - -
intSUBTYPE_DESCRIPTIONS - A media track subtype indicating descriptions. - - - -
intSUBTYPE_METADATA - A media track subtype indicating metadata. - - - -
intSUBTYPE_NONE - A media track subtype indicating no subtype. - - - -
intSUBTYPE_SUBTITLES - A media track subtype indicating subtitles. - - - -
intSUBTYPE_UNKNOWN - A media track subtype indicating an unknown subtype. - - - -
intTYPE_AUDIO - A media track type indicating an audio track. - - - -
intTYPE_TEXT - A media track type indicating a text track. - - - -
intTYPE_UNKNOWN - A media track type indicating an unknown track type. - - - -
intTYPE_VIDEO - A media track type indicating a video track. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - String - - getContentId() - -
- Returns the content ID of the media track. - - - -
- -
- - - - - - String - - getContentType() - -
- Returns the content type (MIME type) of the media track, or null if none was - specified. - - - -
- -
- - - - - - JSONObject - - getCustomData() - -
- Returns the custom data object for this media track, or null if none was - specified. - - - -
- -
- - - - - - long - - getId() - -
- Returns the unique ID of the media track. - - - -
- -
- - - - - - String - - getLanguage() - -
- Returns the language of this media track in - RFC-5464 format, or - null if none was specified. - - - -
- -
- - - - - - String - - getName() - -
- Returns the name of the media track, or null if none was specified. - - - -
- -
- - - - - - int - - getSubtype() - -
- Returns the subtype of this media track; one of the SUBTYPE_ constants. - - - -
- -
- - - - - - int - - getType() - -
- Returns the type of the track; one of the TYPE_ constants. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - void - - setContentId(String contentId) - -
- Sets the content ID for the media track. - - - -
- -
- - - - - - void - - setContentType(String contentType) - -
- Sets the content type (MIME type) of the media track. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - SUBTYPE_CAPTIONS -

-
- - - - -
-
- - - - -

A media track subtype indicating closed captions.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_CHAPTERS -

-
- - - - -
-
- - - - -

A media track subtype indicating chapters.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_DESCRIPTIONS -

-
- - - - -
-
- - - - -

A media track subtype indicating descriptions.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_METADATA -

-
- - - - -
-
- - - - -

A media track subtype indicating metadata.

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_NONE -

-
- - - - -
-
- - - - -

A media track subtype indicating no subtype.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_SUBTITLES -

-
- - - - -
-
- - - - -

A media track subtype indicating subtitles.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUBTYPE_UNKNOWN -

-
- - - - -
-
- - - - -

A media track subtype indicating an unknown subtype.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_AUDIO -

-
- - - - -
-
- - - - -

A media track type indicating an audio track.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TEXT -

-
- - - - -
-
- - - - -

A media track type indicating a text track.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_UNKNOWN -

-
- - - - -
-
- - - - -

A media track type indicating an unknown track type.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_VIDEO -

-
- - - - -
-
- - - - -

A media track type indicating a video track.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getContentId - () -

-
-
- - - -
-
- - - - -

Returns the content ID of the media track. -

- -
-
- - - - -
-

- - public - - - - - String - - getContentType - () -

-
-
- - - -
-
- - - - -

Returns the content type (MIME type) of the media track, or null if none was - specified. -

- -
-
- - - - -
-

- - public - - - - - JSONObject - - getCustomData - () -

-
-
- - - -
-
- - - - -

Returns the custom data object for this media track, or null if none was - specified. -

- -
-
- - - - -
-

- - public - - - - - long - - getId - () -

-
-
- - - -
-
- - - - -

Returns the unique ID of the media track. -

- -
-
- - - - -
-

- - public - - - - - String - - getLanguage - () -

-
-
- - - -
-
- - - - -

Returns the language of this media track in - RFC-5464 format, or - null if none was specified. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name of the media track, or null if none was specified. -

- -
-
- - - - -
-

- - public - - - - - int - - getSubtype - () -

-
-
- - - -
-
- - - - -

Returns the subtype of this media track; one of the SUBTYPE_ constants. -

- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Returns the type of the track; one of the TYPE_ constants. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setContentId - (String contentId) -

-
-
- - - -
-
- - - - -

Sets the content ID for the media track. -

- -
-
- - - - -
-

- - public - - - - - void - - setContentType - (String contentType) -

-
-
- - - -
-
- - - - -

Sets the content type (MIME type) of the media track. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.MediaChannelResult.html b/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.MediaChannelResult.html deleted file mode 100644 index 44cd96dca2c6..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.MediaChannelResult.html +++ /dev/null @@ -1,1151 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteMediaPlayer.MediaChannelResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

RemoteMediaPlayer.MediaChannelResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.RemoteMediaPlayer.MediaChannelResult
- - - - - - - -
- - -

Class Overview

-

Result of a media command. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - JSONObject - - getCustomData() - -
- Custom data received from the receiver application, when a media command fails. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - JSONObject - - getCustomData - () -

-
-
- - - -
-
- - - - -

Custom data received from the receiver application, when a media command fails. If no - custom data was received, this method returns null. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnMetadataUpdatedListener.html b/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnMetadataUpdatedListener.html deleted file mode 100644 index afcd0cd34722..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnMetadataUpdatedListener.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteMediaPlayer.OnMetadataUpdatedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

RemoteMediaPlayer.OnMetadataUpdatedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.RemoteMediaPlayer.OnMetadataUpdatedListener
- - - - - - - -
- - -

Class Overview

-

The listener interface for tracking metadata changes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMetadataUpdated() - -
- Called when updated media metadata is received. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMetadataUpdated - () -

-
-
- - - -
-
- - - - -

Called when updated media metadata is received. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnStatusUpdatedListener.html b/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnStatusUpdatedListener.html deleted file mode 100644 index 5fefa453dd5d..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.OnStatusUpdatedListener.html +++ /dev/null @@ -1,1060 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteMediaPlayer.OnStatusUpdatedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

RemoteMediaPlayer.OnStatusUpdatedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.cast.RemoteMediaPlayer.OnStatusUpdatedListener
- - - - - - - -
- - -

Class Overview

-

The listener interface for tracking player status changes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStatusUpdated() - -
- Called when updated player status information is received. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStatusUpdated - () -

-
-
- - - -
-
- - - - -

Called when updated player status information is received. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.html b/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.html deleted file mode 100644 index 2c55c867ba1c..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/RemoteMediaPlayer.html +++ /dev/null @@ -1,4038 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RemoteMediaPlayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

RemoteMediaPlayer

- - - - - extends Object
- - - - - - - implements - - Cast.MessageReceivedCallback - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.RemoteMediaPlayer
- - - - - - - -
- - -

Class Overview

-

Class for controlling a media player application running on a receiver. -

- Some operations, like loading of media or adjusting volume, can be tracked. The corresponding - methods return a PendingResult for this purpose. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceRemoteMediaPlayer.MediaChannelResult - Result of a media command.  - - - -
- - - - - interfaceRemoteMediaPlayer.OnMetadataUpdatedListener - The listener interface for tracking metadata changes.  - - - -
- - - - - interfaceRemoteMediaPlayer.OnStatusUpdatedListener - The listener interface for tracking player status changes.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRESUME_STATE_PAUSE - A resume state indicating that the player should be paused, regardless of its current state. - - - -
intRESUME_STATE_PLAY - A resume state indicating that the player should be playing, regardless of its current state. - - - -
intRESUME_STATE_UNCHANGED - A resume state indicating that the player state should be left unchanged. - - - -
intSTATUS_CANCELED - A status indicating that a request was canceled. - - - -
intSTATUS_FAILED - A status indicating that a request failed. - - - -
intSTATUS_REPLACED - A status indicating that the request's progress is no longer being tracked because another - request of the same type has been made before the first request completed. - - - -
intSTATUS_SUCCEEDED - A status indicating that a request completed successfully. - - - -
intSTATUS_TIMED_OUT - A status indicating that a request has timed out. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - RemoteMediaPlayer() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - long - - getApproximateStreamPosition() - -
- Returns the approximate stream position as calculated from the last received stream - information and the elapsed wall-time since that update. - - - -
- -
- - - - - - MediaInfo - - getMediaInfo() - -
- Returns the current media information, if any. - - - -
- -
- - - - - - MediaStatus - - getMediaStatus() - -
- Returns the current media status, if any. - - - -
- -
- - - - - - String - - getNamespace() - -
- Returns the media control namespace. - - - -
- -
- - - - - - long - - getStreamDuration() - -
- Convenience method for getting the stream duration. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load(GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay) - -
- Loads and optionally starts playback of a new media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load(GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition, long[] activeTrackIds, JSONObject customData) - -
- Loads and optionally starts playback of a new media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load(GoogleApiClient apiClient, MediaInfo mediaInfo) - -
- Loads and automatically starts playback of a new media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load(GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition) - -
- Loads and optionally starts playback of a new media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load(GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition, JSONObject customData) - -
- Loads and optionally starts playback of a new media item. - - - -
- -
- - - - - - void - - onMessageReceived(CastDevice castDevice, String namespace, String message) - -
- Called when a message is received from a given CastDevice. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - pause(GoogleApiClient apiClient) - -
- Pauses playback of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - pause(GoogleApiClient apiClient, JSONObject customData) - -
- Pauses playback of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - play(GoogleApiClient apiClient, JSONObject customData) - -
- Begins (or resumes) playback of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - play(GoogleApiClient apiClient) - -
- Begins (or resumes) playback of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - requestStatus(GoogleApiClient apiClient) - -
- Requests updated media status information from the receiver. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek(GoogleApiClient apiClient, long position) - -
- Seeks to a new position within the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek(GoogleApiClient apiClient, long position, int resumeState, JSONObject customData) - -
- Seeks to a new position within the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek(GoogleApiClient apiClient, long position, int resumeState) - -
- Seeks to a new position within the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setActiveMediaTracks(GoogleApiClient apiClient, long[] trackIds) - -
- Sets the active media tracks. - - - -
- -
- - - - - - void - - setOnMetadataUpdatedListener(RemoteMediaPlayer.OnMetadataUpdatedListener listener) - -
- Sets the RemoteMediaPlayer.OnMetadataUpdatedListener to get metadata updates. - - - -
- -
- - - - - - void - - setOnStatusUpdatedListener(RemoteMediaPlayer.OnStatusUpdatedListener listener) - -
- Sets the RemoteMediaPlayer.OnStatusUpdatedListener to get status updates. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamMute(GoogleApiClient apiClient, boolean muteState, JSONObject customData) - -
- Toggles the stream muting. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamMute(GoogleApiClient apiClient, boolean muteState) - -
- Toggles the stream muting. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamVolume(GoogleApiClient apiClient, double volume, JSONObject customData) - -
- Sets the stream volume. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamVolume(GoogleApiClient apiClient, double volume) - -
- Sets the stream volume of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setTextTrackStyle(GoogleApiClient apiClient, TextTrackStyle trackStyle) - -
- Sets the text track style. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - stop(GoogleApiClient apiClient) - -
- Stops playback of the current media item. - - - -
- -
- - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - stop(GoogleApiClient apiClient, JSONObject customData) - -
- Stops playback of the current media item. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.cast.Cast.MessageReceivedCallback - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESUME_STATE_PAUSE -

-
- - - - -
-
- - - - -

A resume state indicating that the player should be paused, regardless of its current state. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESUME_STATE_PLAY -

-
- - - - -
-
- - - - -

A resume state indicating that the player should be playing, regardless of its current state. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESUME_STATE_UNCHANGED -

-
- - - - -
-
- - - - -

A resume state indicating that the player state should be left unchanged.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_CANCELED -

-
- - - - -
-
- - - - -

A status indicating that a request was canceled. -

- - -
- Constant Value: - - - 2101 - (0x00000835) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_FAILED -

-
- - - - -
-
- - - - -

A status indicating that a request failed. Equivalent to CastStatusCodes.FAILED. -

- - -
- Constant Value: - - - 2100 - (0x00000834) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REPLACED -

-
- - - - -
-
- - - - -

A status indicating that the request's progress is no longer being tracked because another - request of the same type has been made before the first request completed. This applies to - requests such as volume change, where a new request invalidates the results of a previous - one. Equivalent to CastStatusCodes.REPLACED. -

- - -
- Constant Value: - - - 2103 - (0x00000837) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SUCCEEDED -

-
- - - - -
-
- - - - -

A status indicating that a request completed successfully. Equivalent to - CastStatusCodes.SUCCESS. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_TIMED_OUT -

-
- - - - -
-
- - - - -

A status indicating that a request has timed out. -

- - -
- Constant Value: - - - 2102 - (0x00000836) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - RemoteMediaPlayer - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - long - - getApproximateStreamPosition - () -

-
-
- - - -
-
- - - - -

Returns the approximate stream position as calculated from the last received stream - information and the elapsed wall-time since that update.

-
-
Returns
-
  • The approximate stream position, in milliseconds. -
-
- -
-
- - - - -
-

- - public - - - - - MediaInfo - - getMediaInfo - () -

-
-
- - - -
-
- - - - -

Returns the current media information, if any. -

- -
-
- - - - -
-

- - public - - - - - MediaStatus - - getMediaStatus - () -

-
-
- - - -
-
- - - - -

Returns the current media status, if any. -

- -
-
- - - - -
-

- - public - - - - - String - - getNamespace - () -

-
-
- - - -
-
- - - - -

Returns the media control namespace. -

- -
-
- - - - -
-

- - public - - - - - long - - getStreamDuration - () -

-
-
- - - -
-
- - - - -

Convenience method for getting the stream duration.

-
-
Returns
-
  • The stream duration, in milliseconds. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load - (GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay) -

-
-
- - - -
-
- - - - -

Loads and optionally starts playback of a new media item.

-
-
Parameters
- - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
mediaInfo - An object describing the media item to load. Must not be null.
autoplay - Whether playback should start immediately.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load - (GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition, long[] activeTrackIds, JSONObject customData) -

-
-
- - - -
-
- - - - -

Loads and optionally starts playback of a new media item. The media item starts playback at - playPosition. This method optionally sends custom data as a JSONObject with - the load request. Also, it optionally sends an array of track IDs that should be active. If - the array is not provided, the default tracks will be used.

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
mediaInfo - An object describing the media item to load. Must not be null.
autoplay - Whether playback should start immediately.
playPosition - The initial playback position, in milliseconds from the beginning of the - stream.
activeTrackIds - The list of track IDs to use when loading the media, may be - null.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load - (GoogleApiClient apiClient, MediaInfo mediaInfo) -

-
-
- - - -
-
- - - - -

Loads and automatically starts playback of a new media item.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
mediaInfo - An object describing the media item to load. Must not be null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load - (GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition) -

-
-
- - - -
-
- - - - -

Loads and optionally starts playback of a new media item. The media item starts playback at - playPosition.

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
mediaInfo - An object describing the media item to load. Must not be null.
autoplay - Whether playback should start immediately.
playPosition - The initial playback position, in milliseconds from the beginning of the - stream.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - load - (GoogleApiClient apiClient, MediaInfo mediaInfo, boolean autoplay, long playPosition, JSONObject customData) -

-
-
- - - -
-
- - - - -

Loads and optionally starts playback of a new media item. The media item starts playback at - playPosition. This method optionally sends custom data as a JSONObject with - the load request.

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
mediaInfo - An object describing the media item to load. Must not be null.
autoplay - Whether playback should start immediately.
playPosition - The initial playback position, in milliseconds from the beginning of the - stream.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onMessageReceived - (CastDevice castDevice, String namespace, String message) -

-
-
- - - -
-
- - - - -

Called when a message is received from a given CastDevice.

-
-
Parameters
- - - - - - - - - - -
castDevice - The castDevice from whence the message originated.
namespace - The namespace of the received message.
message - The received payload for the message. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - pause - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Pauses playback of the current media item.

-
-
Parameters
- - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - pause - (GoogleApiClient apiClient, JSONObject customData) -

-
-
- - - -
-
- - - - -

Pauses playback of the current media item.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - play - (GoogleApiClient apiClient, JSONObject customData) -

-
-
- - - -
-
- - - - -

Begins (or resumes) playback of the current media item.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - play - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Begins (or resumes) playback of the current media item.

-
-
Parameters
- - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - requestStatus - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Requests updated media status information from the receiver. RemoteMediaPlayer.OnStatusUpdatedListener - callback will be triggered, when the updated media status has been received. This will also - update the internal state of the RemoteMediaPlayer object with the current state of - the receiver, including the current session ID. This method should be called when joining an - application that supports the media control namespace.

-
-
Parameters
- - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek - (GoogleApiClient apiClient, long position) -

-
-
- - - -
-
- - - - -

Seeks to a new position within the current media item.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
position - The new position, in milliseconds from the beginning of the stream.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek - (GoogleApiClient apiClient, long position, int resumeState, JSONObject customData) -

-
-
- - - -
-
- - - - -

Seeks to a new position within the current media item.

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
position - The new position, in milliseconds from the beginning of the stream.
resumeState - The action to take after the seek operation has finished.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - seek - (GoogleApiClient apiClient, long position, int resumeState) -

-
-
- - - -
-
- - - - -

Seeks to a new position within the current media item.

-
-
Parameters
- - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
position - The new position, in milliseconds from the beginning of the stream.
resumeState - The action to take after the seek operation has finished.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setActiveMediaTracks - (GoogleApiClient apiClient, long[] trackIds) -

-
-
- - - -
-
- - - - -

Sets the active media tracks.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
trackIds - The media track IDs. If an empty array, the current set of active - trackIds will be removed.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request.
-
-
-
Throws
- - - - -
IllegalArgumentException - If trackIds is null. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setOnMetadataUpdatedListener - (RemoteMediaPlayer.OnMetadataUpdatedListener listener) -

-
-
- - - -
-
- - - - -

Sets the RemoteMediaPlayer.OnMetadataUpdatedListener to get metadata updates. -

- -
-
- - - - -
-

- - public - - - - - void - - setOnStatusUpdatedListener - (RemoteMediaPlayer.OnStatusUpdatedListener listener) -

-
-
- - - -
-
- - - - -

Sets the RemoteMediaPlayer.OnStatusUpdatedListener to get status updates. -

- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamMute - (GoogleApiClient apiClient, boolean muteState, JSONObject customData) -

-
-
- - - -
-
- - - - -

Toggles the stream muting.

-
-
Parameters
- - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
muteState - Whether the stream should be muted or unmuted.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamMute - (GoogleApiClient apiClient, boolean muteState) -

-
-
- - - -
-
- - - - -

Toggles the stream muting.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
muteState - Whether the stream should be muted or unmuted.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamVolume - (GoogleApiClient apiClient, double volume, JSONObject customData) -

-
-
- - - -
-
- - - - -

Sets the stream volume. If volume is outside of the range [0.0, 1.0], then the value - will be clipped.

-
-
Parameters
- - - - - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
volume - The new volume, in the range [0.0 - 1.0].
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the volume is infinity or NaN. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setStreamVolume - (GoogleApiClient apiClient, double volume) -

-
-
- - - -
-
- - - - -

Sets the stream volume of the current media item. When the stream volume has been updated, - onStatusUpdated() will be called.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
volume - The new volume, in the range [0.0 - 1.0].
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the volume is infinity or NaN. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - setTextTrackStyle - (GoogleApiClient apiClient, TextTrackStyle trackStyle) -

-
-
- - - -
-
- - - - -

Sets the text track style.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
trackStyle - The track style. Must not be null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the trackStyle is null. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - stop - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Stops playback of the current media item.

-
-
Parameters
- - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<RemoteMediaPlayer.MediaChannelResult> - - stop - (GoogleApiClient apiClient, JSONObject customData) -

-
-
- - - -
-
- - - - -

Stops playback of the current media item.

-
-
Parameters
- - - - - - - -
apiClient - The API client with which to perform the operation. Must not be - null.
customData - Custom application-specific data to pass along with the request, may be - null.
-
-
-
Returns
-
  • A PendingResult which can be used to track the progress of the request. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/TextTrackStyle.html b/docs/html/reference/com/google/android/gms/cast/TextTrackStyle.html deleted file mode 100644 index eb6a3fdb5f35..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/TextTrackStyle.html +++ /dev/null @@ -1,4285 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TextTrackStyle | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

TextTrackStyle

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.cast.TextTrackStyle
- - - - - - - -
- - -

Class Overview

-

A class that specifies how a text track's text will be displayed on-screen. The text is - displayed inside a rectangular "window". The appearance of both the text and the window are - configurable. -

- With the exception of the font scale, which has a predefined default value, any attribute that - is not explicitly set will remain "unspecified", and the Cast Receiver will select an appropriate - value. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCOLOR_UNSPECIFIED - A color value that indicates an unspecified (unset) color. - - - -
floatDEFAULT_FONT_SCALE - The default font scale. - - - -
intEDGE_TYPE_DEPRESSED - An edge type indicating a depressed edge. - - - -
intEDGE_TYPE_DROP_SHADOW - An edge type indicating a drop shadow edge. - - - -
intEDGE_TYPE_NONE - An edge type indicating no edge. - - - -
intEDGE_TYPE_OUTLINE - An edge type indicating an outline edge. - - - -
intEDGE_TYPE_RAISED - An edge type indicating a raised edge. - - - -
intEDGE_TYPE_UNSPECIFIED - An edge type indicating an unspecified edge type. - - - -
intFONT_FAMILY_CASUAL - A font family indicating Casual. - - - -
intFONT_FAMILY_CURSIVE - A font family indicating Cursive. - - - -
intFONT_FAMILY_MONOSPACED_SANS_SERIF - A font family indicating Monospaced Sans Serif. - - - -
intFONT_FAMILY_MONOSPACED_SERIF - A font family indicating Monospaced Serif. - - - -
intFONT_FAMILY_SANS_SERIF - A font family indicating Sans Serif. - - - -
intFONT_FAMILY_SERIF - A font family indicating Serif. - - - -
intFONT_FAMILY_SMALL_CAPITALS - A font family indicating Small Capitals. - - - -
intFONT_FAMILY_UNSPECIFIED - A font family indicating an unspecified font family. - - - -
intFONT_STYLE_BOLD - A font style indicating a bold style. - - - -
intFONT_STYLE_BOLD_ITALIC - A font style indicating a bold and italic style. - - - -
intFONT_STYLE_ITALIC - A font style indicating an italic style. - - - -
intFONT_STYLE_NORMAL - A font style indicating a normal style. - - - -
intFONT_STYLE_UNSPECIFIED - A font style indicating an unspecified style. - - - -
intWINDOW_TYPE_NONE - A window type indicating no window type. - - - -
intWINDOW_TYPE_NORMAL - A window type indicating a normal window. - - - -
intWINDOW_TYPE_ROUNDED - A window type indicating a window with rounded corners. - - - -
intWINDOW_TYPE_UNSPECIFIED - A window type indicating an unspecified window type. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - TextTrackStyle() - -
- Constructs a new TextTrackStyle. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - static - - TextTrackStyle - - fromSystemSettings(Context context) - -
- Constructs a new TextTrackStyle based on the system's current closed caption style settings. - - - -
- -
- - - - - - int - - getBackgroundColor() - -
- Gets the text's background color. - - - -
- -
- - - - - - JSONObject - - getCustomData() - -
- Gets the custom data object. - - - -
- -
- - - - - - int - - getEdgeColor() - -
- Gets the window's edge color. - - - -
- -
- - - - - - int - - getEdgeType() - -
- Gets the caption window's edge type. - - - -
- -
- - - - - - String - - getFontFamily() - -
- Gets the text's font family. - - - -
- -
- - - - - - int - - getFontGenericFamily() - -
- Gets the text's generic font family. - - - -
- -
- - - - - - float - - getFontScale() - -
- Gets the font scale factor. - - - -
- -
- - - - - - int - - getFontStyle() - -
- Gets the text font style. - - - -
- -
- - - - - - int - - getForegroundColor() - -
- Gets the text's foreground color. - - - -
- -
- - - - - - int - - getWindowColor() - -
- Gets the window's color. - - - -
- -
- - - - - - int - - getWindowCornerRadius() - -
- Gets the window corner radius. - - - -
- -
- - - - - - int - - getWindowType() - -
- Gets the caption window type. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - void - - setBackgroundColor(int backgroundColor) - -
- Sets the text's background color. - - - -
- -
- - - - - - void - - setCustomData(JSONObject customData) - -
- Sets the custom data object. - - - -
- -
- - - - - - void - - setEdgeColor(int edgeColor) - -
- Sets the window's edge color. - - - -
- -
- - - - - - void - - setEdgeType(int edgeType) - -
- Sets the caption window's edge type. - - - -
- -
- - - - - - void - - setFontFamily(String fontFamily) - -
- Sets the text's font family. - - - -
- -
- - - - - - void - - setFontGenericFamily(int fontGenericFamily) - -
- Sets the text's generic font family. - - - -
- -
- - - - - - void - - setFontScale(float fontScale) - -
- Sets the font scale factor. - - - -
- -
- - - - - - void - - setFontStyle(int fontStyle) - -
- Sets the text font style. - - - -
- -
- - - - - - void - - setForegroundColor(int foregroundColor) - -
- Sets the text's foreground color. - - - -
- -
- - - - - - void - - setWindowColor(int windowColor) - -
- Sets the window's color. - - - -
- -
- - - - - - void - - setWindowCornerRadius(int windowCornerRadius) - -
- If the window type is WINDOW_TYPE_ROUNDED, sets the radius for the window's - corners. - - - -
- -
- - - - - - void - - setWindowType(int windowType) - -
- Sets the window type. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - COLOR_UNSPECIFIED -

-
- - - - -
-
- - - - -

A color value that indicates an unspecified (unset) color.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - float - - DEFAULT_FONT_SCALE -

-
- - - - -
-
- - - - -

The default font scale.

- - -
- Constant Value: - - - 1.0 - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_DEPRESSED -

-
- - - - -
-
- - - - -

An edge type indicating a depressed edge.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_DROP_SHADOW -

-
- - - - -
-
- - - - -

An edge type indicating a drop shadow edge.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_NONE -

-
- - - - -
-
- - - - -

An edge type indicating no edge.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_OUTLINE -

-
- - - - -
-
- - - - -

An edge type indicating an outline edge.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_RAISED -

-
- - - - -
-
- - - - -

An edge type indicating a raised edge.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EDGE_TYPE_UNSPECIFIED -

-
- - - - -
-
- - - - -

An edge type indicating an unspecified edge type.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_CASUAL -

-
- - - - -
-
- - - - -

A font family indicating Casual.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_CURSIVE -

-
- - - - -
-
- - - - -

A font family indicating Cursive.

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_MONOSPACED_SANS_SERIF -

-
- - - - -
-
- - - - -

A font family indicating Monospaced Sans Serif.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_MONOSPACED_SERIF -

-
- - - - -
-
- - - - -

A font family indicating Monospaced Serif.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_SANS_SERIF -

-
- - - - -
-
- - - - -

A font family indicating Sans Serif.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_SERIF -

-
- - - - -
-
- - - - -

A font family indicating Serif.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_SMALL_CAPITALS -

-
- - - - -
-
- - - - -

A font family indicating Small Capitals.

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_FAMILY_UNSPECIFIED -

-
- - - - -
-
- - - - -

A font family indicating an unspecified font family.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_STYLE_BOLD -

-
- - - - -
-
- - - - -

A font style indicating a bold style.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_STYLE_BOLD_ITALIC -

-
- - - - -
-
- - - - -

A font style indicating a bold and italic style.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_STYLE_ITALIC -

-
- - - - -
-
- - - - -

A font style indicating an italic style.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_STYLE_NORMAL -

-
- - - - -
-
- - - - -

A font style indicating a normal style.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FONT_STYLE_UNSPECIFIED -

-
- - - - -
-
- - - - -

A font style indicating an unspecified style.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WINDOW_TYPE_NONE -

-
- - - - -
-
- - - - -

A window type indicating no window type.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WINDOW_TYPE_NORMAL -

-
- - - - -
-
- - - - -

A window type indicating a normal window.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WINDOW_TYPE_ROUNDED -

-
- - - - -
-
- - - - -

A window type indicating a window with rounded corners.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WINDOW_TYPE_UNSPECIFIED -

-
- - - - -
-
- - - - -

A window type indicating an unspecified window type.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - TextTrackStyle - () -

-
-
- - - -
-
- - - - -

Constructs a new TextTrackStyle. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - TextTrackStyle - - fromSystemSettings - (Context context) -

-
-
- - - -
-
- - - - -

Constructs a new TextTrackStyle based on the system's current closed caption style settings. - On platform levels below 19, this returns an object with "unspecified" values for all - fields.

-
-
Parameters
- - - - -
context - The calling context.
-
-
-
Returns
-
  • The new TextTrackStyle. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getBackgroundColor - () -

-
-
- - - -
-
- - - - -

Gets the text's background color. -

- -
-
- - - - -
-

- - public - - - - - JSONObject - - getCustomData - () -

-
-
- - - -
-
- - - - -

Gets the custom data object. -

- -
-
- - - - -
-

- - public - - - - - int - - getEdgeColor - () -

-
-
- - - -
-
- - - - -

Gets the window's edge color. -

- -
-
- - - - -
-

- - public - - - - - int - - getEdgeType - () -

-
-
- - - -
-
- - - - -

Gets the caption window's edge type. -

- -
-
- - - - -
-

- - public - - - - - String - - getFontFamily - () -

-
-
- - - -
-
- - - - -

Gets the text's font family. -

- -
-
- - - - -
-

- - public - - - - - int - - getFontGenericFamily - () -

-
-
- - - -
-
- - - - -

Gets the text's generic font family. -

- -
-
- - - - -
-

- - public - - - - - float - - getFontScale - () -

-
-
- - - -
-
- - - - -

Gets the font scale factor. -

- -
-
- - - - -
-

- - public - - - - - int - - getFontStyle - () -

-
-
- - - -
-
- - - - -

Gets the text font style. -

- -
-
- - - - -
-

- - public - - - - - int - - getForegroundColor - () -

-
-
- - - -
-
- - - - -

Gets the text's foreground color. -

- -
-
- - - - -
-

- - public - - - - - int - - getWindowColor - () -

-
-
- - - -
-
- - - - -

Gets the window's color. -

- -
-
- - - - -
-

- - public - - - - - int - - getWindowCornerRadius - () -

-
-
- - - -
-
- - - - -

Gets the window corner radius. -

- -
-
- - - - -
-

- - public - - - - - int - - getWindowType - () -

-
-
- - - -
-
- - - - -

Gets the caption window type. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setBackgroundColor - (int backgroundColor) -

-
-
- - - -
-
- - - - -

Sets the text's background color.

-
-
Parameters
- - - - -
backgroundColor - The color, as an ARGB value. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setCustomData - (JSONObject customData) -

-
-
- - - -
-
- - - - -

Sets the custom data object. -

- -
-
- - - - -
-

- - public - - - - - void - - setEdgeColor - (int edgeColor) -

-
-
- - - -
-
- - - - -

Sets the window's edge color.

-
-
Parameters
- - - - -
edgeColor - The color, as an ARGB value. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setEdgeType - (int edgeType) -

-
-
- - - -
-
- - - - -

Sets the caption window's edge type.

-
-
Parameters
- - - - -
edgeType - The edge type; one of the EDGE_TYPE_ constants defined above. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setFontFamily - (String fontFamily) -

-
-
- - - -
-
- - - - -

Sets the text's font family.

-
-
Parameters
- - - - -
fontFamily - The text font family. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setFontGenericFamily - (int fontGenericFamily) -

-
-
- - - -
-
- - - - -

Sets the text's generic font family. This will be used if the font family specified with - setFontFamily(String) (if any) is unavailable.

-
-
Parameters
- - - - -
fontGenericFamily - The generic family; one of the FONT_FAMILY_ constants - defined above. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setFontScale - (float fontScale) -

-
-
- - - -
-
- - - - -

Sets the font scale factor. The default is DEFAULT_FONT_SCALE. -

- -
-
- - - - -
-

- - public - - - - - void - - setFontStyle - (int fontStyle) -

-
-
- - - -
-
- - - - -

Sets the text font style.

-
-
Parameters
- - - - -
fontStyle - The font style; one of the FONT_STYLE_ constants defined above. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setForegroundColor - (int foregroundColor) -

-
-
- - - -
-
- - - - -

Sets the text's foreground color.

-
-
Parameters
- - - - -
foregroundColor - The color, as an ARGB value. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setWindowColor - (int windowColor) -

-
-
- - - -
-
- - - - -

Sets the window's color.

-
-
Parameters
- - - - -
windowColor - The color, as an ARGB value. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setWindowCornerRadius - (int windowCornerRadius) -

-
-
- - - -
-
- - - - -

If the window type is WINDOW_TYPE_ROUNDED, sets the radius for the window's - corners.

-
-
Parameters
- - - - -
windowCornerRadius - The radius, in pixels. Must be a positive value. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setWindowType - (int windowType) -

-
-
- - - -
-
- - - - -

Sets the window type.

-
-
Parameters
- - - - -
windowType - The window type; one of the WINDOW_TYPE_ constants defined above. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/cast/package-summary.html b/docs/html/reference/com/google/android/gms/cast/package-summary.html deleted file mode 100644 index 4b881558e2e5..000000000000 --- a/docs/html/reference/com/google/android/gms/cast/package-summary.html +++ /dev/null @@ -1,1157 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.cast | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.cast

-
- -
- -
- - -
- Contains classes for interacting with Google Cast devices. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Cast.ApplicationConnectionResult - When a connection to a receiver application has been established, this object contains - information about that application, including its ApplicationMetadata and current - status.  - - - -
Cast.CastApi - The main entry point for interacting with a Google Cast device.  - - - -
Cast.MessageReceivedCallback - The interface to process received messages from a CastDevice.  - - - -
RemoteMediaPlayer.MediaChannelResult - Result of a media command.  - - - -
RemoteMediaPlayer.OnMetadataUpdatedListener - The listener interface for tracking metadata changes.  - - - -
RemoteMediaPlayer.OnStatusUpdatedListener - The listener interface for tracking player status changes.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ApplicationMetadata - Cast application metadata.  - - - -
Cast - Main entry point for the Cast APIs.  - - - -
Cast.CastOptions - API configuration parameters for Cast.  - - - -
Cast.CastOptions.Builder - A builder to create an instance of Cast.CastOptions to set - API configuration parameters for Cast.  - - - -
Cast.Listener - The list of Cast callbacks.  - - - -
CastDevice - An object representing a Cast receiver device.  - - - -
CastMediaControlIntent - Intent constants for use with the Cast MediaRouteProvider.  - - - -
CastStatusCodes - Status codes for the Cast APIs.  - - - -
LaunchOptions - An object that holds options that affect how a receiver application is launched.  - - - -
LaunchOptions.Builder - A builder for LaunchOptions objects.  - - - -
MediaInfo - A class that aggregates information about a media item.  - - - -
MediaInfo.Builder - A builder for MediaInfo objects.  - - - -
MediaMetadata - Container class for media metadata.  - - - -
MediaStatus - A class that holds status information about some media.  - - - -
MediaTrack - A class that represents a media track, such as a language track or closed caption text track - in a video.  - - - -
MediaTrack.Builder - A builder for MediaTrack objects.  - - - -
RemoteMediaPlayer - Class for controlling a media player application running on a receiver.  - - - -
TextTrackStyle - A class that specifies how a text track's text will be displayed on-screen.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/AccountPicker.html b/docs/html/reference/com/google/android/gms/common/AccountPicker.html deleted file mode 100644 index f1dabbaaf0d8..000000000000 --- a/docs/html/reference/com/google/android/gms/common/AccountPicker.html +++ /dev/null @@ -1,1389 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AccountPicker | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AccountPicker

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.AccountPicker
- - - - - - - -
- - -

Class Overview

-

Common account picker similar to the standard framework account picker introduced in ICS: - newChooseAccountIntent. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Intent - - newChooseAccountIntent(Account selectedAccount, ArrayList<Account> allowableAccounts, String[] allowableAccountTypes, boolean alwaysPromptForAccount, String descriptionOverrideText, String addAccountAuthTokenType, String[] addAccountRequiredFeatures, Bundle addAccountOptions) - -
- Returns an intent to an Activity that prompts the user to choose from a list of - accounts. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Intent - - newChooseAccountIntent - (Account selectedAccount, ArrayList<Account> allowableAccounts, String[] allowableAccountTypes, boolean alwaysPromptForAccount, String descriptionOverrideText, String addAccountAuthTokenType, String[] addAccountRequiredFeatures, Bundle addAccountOptions) -

-
-
- - - -
-
- - - - -

Returns an intent to an Activity that prompts the user to choose from a list of - accounts. - The caller will then typically start the activity by calling - startActivityForResult(intent, ...);. -

- On success the activity returns a Bundle with the account name and type specified using - keys KEY_ACCOUNT_NAME and KEY_ACCOUNT_TYPE. -

- The most common case is to call this with one account type, e.g.: -

- 

- Intent intent = AccountPicker.newChooseAccountIntent(null, null, new String[]{"com.google"},
-         false, null, null, null, null);
- startActivityForResult(intent, SOME_REQUEST_CODE);
-
- - The account picker activity will return when the user has selected and/or created an account, - and the resulting account name can be retrieved as follows: - 
- protected void onActivityResult(final int requestCode, final int resultCode,
-         final Intent data) {
-     if (requestCode == SOME_REQUEST_CODE && resultCode == RESULT_OK) {
-         String accountName = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
-   }
- }
-

-
-
Parameters
- - - - - - - - - - - - - - - - - - - - - - - - - -
selectedAccount - if specified, indicates that the Account is the currently - selected one, according to the caller's definition of selected.
allowableAccounts - an optional ArrayList of accounts that are allowed to be - shown. If not specified then this field will not limit the displayed accounts.
allowableAccountTypes - an optional string array of account types. These are used - both to filter the shown accounts and to filter the list of account types that are shown - when adding an account.
alwaysPromptForAccount - if set, the account chooser screen is always shown, otherwise - it is only shown when there is more than one account from which to choose.
descriptionOverrideText - if non-null this string is used as the description in the - accounts chooser screen rather than the default.
addAccountAuthTokenType - this string is passed as the addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback, Handler) - authTokenType parameter.
addAccountRequiredFeatures - this string array is passed as the - addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback, Handler) requiredFeatures parameter.
addAccountOptions - This Bundle is passed as the - addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback, Handler) options parameter.
-
-
-
Returns
-
  • an Intent that can be used to launch the ChooseAccount activity flow. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/ConnectionResult.html b/docs/html/reference/com/google/android/gms/common/ConnectionResult.html deleted file mode 100644 index c165b023584d..000000000000 --- a/docs/html/reference/com/google/android/gms/common/ConnectionResult.html +++ /dev/null @@ -1,3213 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ConnectionResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ConnectionResult

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.ConnectionResult
- - - - - - - -
- - -

Class Overview

-

Contains all possible error codes for when a client fails to connect to Google Play services. - These error codes are used by GoogleApiClient.OnConnectionFailedListener. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAPI_UNAVAILABLE - One of the API components you attempted to connect to is not available. - - - -
intCANCELED - The connection was canceled. - - - -
intDEVELOPER_ERROR - The application is misconfigured. - - - -
intDRIVE_EXTERNAL_STORAGE_REQUIRED - - This constant is deprecated. - External storage is no longer required. - - - - -
intINTERNAL_ERROR - An internal error occurred. - - - -
intINTERRUPTED - An interrupt occurred while waiting for the connection complete. - - - -
intINVALID_ACCOUNT - The client attempted to connect to the service with an invalid account name - specified. - - - -
intLICENSE_CHECK_FAILED - The application is not licensed to the user. - - - -
intNETWORK_ERROR - A network error occurred. - - - -
intRESOLUTION_REQUIRED - Completing the connection requires some form of resolution. - - - -
intSERVICE_DISABLED - The installed version of Google Play services has been disabled on this device. - - - -
intSERVICE_INVALID - The version of the Google Play services installed on this device is not authentic. - - - -
intSERVICE_MISSING - Google Play services is missing on this device. - - - -
intSERVICE_UPDATING - Google Play service is currently being updated on this device. - - - -
intSERVICE_VERSION_UPDATE_REQUIRED - The installed version of Google Play services is out of date. - - - -
intSIGN_IN_FAILED - The client attempted to connect to the service but the user is not signed in. - - - -
intSIGN_IN_REQUIRED - The client attempted to connect to the service but the user is not - signed in. - - - -
intSUCCESS - The connection was successful. - - - -
intTIMEOUT - The timeout was exceeded while waiting for the connection to complete. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - ConnectionResultCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ConnectionResult(int statusCode, PendingIntent pendingIntent) - -
- Creates a connection result. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - getErrorCode() - -
- Indicates the type of error that interrupted connection. - - - -
- -
- - - - - - PendingIntent - - getResolution() - -
- A pending intent to resolve the connection failure. - - - -
- -
- - - - - - boolean - - hasResolution() - -
- Returns true if calling startResolutionForResult(Activity, int) - will start any intents requiring user interaction. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isSuccess() - -
- Returns true if the connection was successful. - - - -
- -
- - - - - - void - - startResolutionForResult(Activity activity, int requestCode) - -
- Resolves an error by starting any intents requiring user - interaction. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - API_UNAVAILABLE -

-
- - - - -
-
- - - - -

One of the API components you attempted to connect to is not available. The API will not - work on this device, and updating Google Play services will not likely solve the problem. - Using the API on the device should be avoided. -

- - -
- Constant Value: - - - 16 - (0x00000010) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CANCELED -

-
- - - - -
-
- - - - -

The connection was canceled. This is returned in two situations: -

-

- - -
- Constant Value: - - - 13 - (0x0000000d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DEVELOPER_ERROR -

-
- - - - -
-
- - - - -

The application is misconfigured. This error is not recoverable and will be treated as fatal. - The developer should look at the logs after this to determine more actionable information. -

- - -
- Constant Value: - - - 10 - (0x0000000a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DRIVE_EXTERNAL_STORAGE_REQUIRED -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- External storage is no longer required. - -

-

The Drive API requires external storage (such as an SD card), but no external storage is - mounted. This error is recoverable if the user installs external storage (if none is present) - and ensures that it is mounted (which may involve disabling USB storage mode, formatting the - storage, or other initialization as required by the device). - -

This error should never be returned on a device with emulated external storage. On devices - with emulated external storage, the emulated "external storage" is always present regardless - of whether the device also has removable storage.

- - -
- Constant Value: - - - 1500 - (0x000005dc) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERNAL_ERROR -

-
- - - - -
-
- - - - -

An internal error occurred. Retrying should resolve the problem. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERRUPTED -

-
- - - - -
-
- - - - -

An interrupt occurred while waiting for the connection complete. Only returned by - blockingConnect(). -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVALID_ACCOUNT -

-
- - - - -
-
- - - - -

The client attempted to connect to the service with an invalid account name - specified. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - LICENSE_CHECK_FAILED -

-
- - - - -
-
- - - - -

The application is not licensed to the user. This error is not recoverable and will be - treated as fatal. -

- - -
- Constant Value: - - - 11 - (0x0000000b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NETWORK_ERROR -

-
- - - - -
-
- - - - -

A network error occurred. Retrying should resolve the problem. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_REQUIRED -

-
- - - - -
-
- - - - -

Completing the connection requires some form of resolution. A resolution will be available - to be started with startResolutionForResult(Activity, int). - If the result returned is RESULT_OK, then further attempts to connect - should either complete or continue on to the next issue that needs to be resolved. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_DISABLED -

-
- - - - -
-
- - - - -

The installed version of Google Play services has been disabled on this device. - The calling activity should pass this error code to - getErrorDialog(int, Activity, int) to get a localized error dialog - that will resolve the error when shown. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_INVALID -

-
- - - - -
-
- - - - -

The version of the Google Play services installed on this device is not authentic. -

- - -
- Constant Value: - - - 9 - (0x00000009) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_MISSING -

-
- - - - -
-
- - - - -

Google Play services is missing on this device. - The calling activity should pass this error code to - getErrorDialog(int, Activity, int) to get a localized error dialog - that will resolve the error when shown. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_UPDATING -

-
- - - - -
-
- - - - -

Google Play service is currently being updated on this device. -

- - -
- Constant Value: - - - 18 - (0x00000012) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_VERSION_UPDATE_REQUIRED -

-
- - - - -
-
- - - - -

The installed version of Google Play services is out of date. - The calling activity should pass this error code to - getErrorDialog(int, Activity, int) to get a localized error dialog - that will resolve the error when shown. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIGN_IN_FAILED -

-
- - - - -
-
- - - - -

The client attempted to connect to the service but the user is not signed in. An error may - have occurred when signing in the user and the error can not be recovered with any user - interaction. Alternately, the API may have been requested with - addApiIfAvailable(Api, Scope...) and - it may be the case that no required APIs needed authentication, so authentication did not - occur. -

- When seeing this error code,there is no resolution for the sign-in failure. -

- - -
- Constant Value: - - - 17 - (0x00000011) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIGN_IN_REQUIRED -

-
- - - - -
-
- - - - -

The client attempted to connect to the service but the user is not - signed in. The client may choose to continue without using the API or it - may call startResolutionForResult(Activity, int) to - prompt the user to sign in. After the sign in - activity returns with RESULT_OK further attempts to connect - should succeed. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

The connection was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIMEOUT -

-
- - - - -
-
- - - - -

The timeout was exceeded while waiting for the connection to complete. Only returned by - blockingConnect(). -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - ConnectionResultCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ConnectionResult - (int statusCode, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - - -

Creates a connection result.

-
-
Parameters
- - - - - - - -
statusCode - The status code.
pendingIntent - A pending intent that will resolve the issue when started, or null. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getErrorCode - () -

-
-
- - - -
-
- - - - -

Indicates the type of error that interrupted connection.

-
-
Returns
-
  • the error code, or SUCCESS if no error occurred. -
-
- -
-
- - - - -
-

- - public - - - - - PendingIntent - - getResolution - () -

-
-
- - - -
-
- - - - -

A pending intent to resolve the connection failure. This intent can be started with - startIntentSenderForResult(IntentSender, int, Intent, int, int, int) - to present UI to solve the issue.

-
-
Returns
-
  • The pending intent to resolve the connection failure. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasResolution - () -

-
-
- - - -
-
- - - - -

Returns true if calling startResolutionForResult(Activity, int) - will start any intents requiring user interaction.

-
-
Returns
-
  • true if there is a resolution that can be started. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isSuccess - () -

-
-
- - - -
-
- - - - -

Returns true if the connection was successful.

-
-
Returns
-
  • true if the connection was successful, false if there was an error. -
-
- -
-
- - - - -
-

- - public - - - - - void - - startResolutionForResult - (Activity activity, int requestCode) -

-
-
- - - -
-
- - - - -

Resolves an error by starting any intents requiring user - interaction. See SIGN_IN_REQUIRED, and - RESOLUTION_REQUIRED.

-
-
Parameters
- - - - - - - -
activity - An Activity context to use to resolve the issue. The activity's - onActivityResult method will be invoked after the user is done. If the - resultCode is RESULT_OK, the application should try to - connect again.
requestCode - The request code to pass to onActivityResult.
-
-
-
Throws
- - - - -
IntentSender.SendIntentException - If the resolution intent has been canceled or is - no longer able to execute the request. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/ErrorDialogFragment.html b/docs/html/reference/com/google/android/gms/common/ErrorDialogFragment.html deleted file mode 100644 index b1f2a566104a..000000000000 --- a/docs/html/reference/com/google/android/gms/common/ErrorDialogFragment.html +++ /dev/null @@ -1,4015 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ErrorDialogFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ErrorDialogFragment

- - - - - - - - - - - - - extends DialogFragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.app.Fragment
    ↳android.app.DialogFragment
     ↳com.google.android.gms.common.ErrorDialogFragment
- - - - - - - -
- - -

Class Overview

-

Wraps the Dialog returned by - getErrorDialog(int, Activity, int) by using - DialogFragment so that it can be properly managed by the - Activity. -

- Use this class only if you are targeting API 12 and above. Otherwise, use - SupportErrorDialogFragment. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.DialogFragment -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ErrorDialogFragment() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - ErrorDialogFragment - - newInstance(Dialog dialog, DialogInterface.OnCancelListener cancelListener) - -
- Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int) with an OnCancelListener. - - - -
- -
- - - - static - - ErrorDialogFragment - - newInstance(Dialog dialog) - -
- Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int). - - - -
- -
- - - - - - void - - onCancel(DialogInterface dialog) - -
- - - - - - Dialog - - onCreateDialog(Bundle savedInstanceState) - -
- Returns a Dialog created by - getErrorDialog(int, Activity, int) with the provided - errorCode, activity, request code, and cancel listener. - - - -
- -
- - - - - - void - - show(FragmentManager manager, String tag) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.DialogFragment - -
- - -
-
- -From class - - android.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.DialogInterface.OnCancelListener - -
- - -
-
- -From interface - - android.content.DialogInterface.OnDismissListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ErrorDialogFragment - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ErrorDialogFragment - - newInstance - (Dialog dialog, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - - -

Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int) with an OnCancelListener.

-
-
Parameters
- - - - - - - -
dialog - The Dialog created by - getErrorDialog(int, Activity, int).
cancelListener - A DialogInterface.OnCancelListener for when a user cancels the - DialogFragment.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - ErrorDialogFragment - - newInstance - (Dialog dialog) -

-
-
- - - -
-
- - - - -

Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int).

-
-
Parameters
- - - - -
dialog - The Dialog created by - getErrorDialog(int, Activity, int).
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - onCancel - (DialogInterface dialog) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Dialog - - onCreateDialog - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Returns a Dialog created by - getErrorDialog(int, Activity, int) with the provided - errorCode, activity, request code, and cancel listener.

-
-
Parameters
- - - - -
savedInstanceState - Not used. -
-
- -
-
- - - - -
-

- - public - - - - - void - - show - (FragmentManager manager, String tag) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/GoogleApiAvailability.html b/docs/html/reference/com/google/android/gms/common/GoogleApiAvailability.html deleted file mode 100644 index 38c00a6fbd0d..000000000000 --- a/docs/html/reference/com/google/android/gms/common/GoogleApiAvailability.html +++ /dev/null @@ -1,2204 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiAvailability | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GoogleApiAvailability

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.GoogleApiAvailability
- - - - - - - -
- - -

Class Overview

-

Helper class for verifying that the Google Play services APK is available and - up-to-date on this device. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringGOOGLE_PLAY_SERVICES_PACKAGE - Package name for Google Play services. - - - -
intGOOGLE_PLAY_SERVICES_VERSION_CODE - Google Play services client library version (declared in library's - AndroidManifest.xml android:versionCode). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Dialog - - getErrorDialog(Activity activity, int errorCode, int requestCode, DialogInterface.OnCancelListener cancelListener) - -
- Returns a dialog to address the provided errorCode. - - - -
- -
- - - - - - Dialog - - getErrorDialog(Activity activity, int errorCode, int requestCode) - -
- Returns a dialog to address the provided errorCode. - - - -
- -
- - - - - - PendingIntent - - getErrorResolutionPendingIntent(Context context, int errorCode, int requestCode) - -
- Returns a PendingIntent to address the provided errorCode. - - - -
- -
- - - final - - - String - - getErrorString(int errorCode) - -
- Returns a human-readable string of the error code returned from - isGooglePlayServicesAvailable(Context). - - - -
- -
- - - - static - - GoogleApiAvailability - - getInstance() - -
- Returns the singleton instance of GoogleApiAvailability. - - - -
- -
- - - - - - String - - getOpenSourceSoftwareLicenseInfo(Context context) - -
- Returns the open source software license information for the Google Play services - application, or null if Google Play services is not available on this device. - - - -
- -
- - - - - - int - - isGooglePlayServicesAvailable(Context context) - -
- Verifies that Google Play services is installed and enabled on this device, and that the - version installed on this device is no older than the one required by this client. - - - -
- -
- - - final - - - boolean - - isUserResolvableError(int errorCode) - -
- Determines whether an error can be resolved via user action. - - - -
- -
- - - - - - boolean - - showErrorDialogFragment(Activity activity, int errorCode, int requestCode, DialogInterface.OnCancelListener cancelListener) - -
- Displays a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context). - - - -
- -
- - - - - - boolean - - showErrorDialogFragment(Activity activity, int errorCode, int requestCode) - -
- Displays a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context). - - - -
- -
- - - - - - void - - showErrorNotification(Context context, int errorCode) - -
- Displays a notification relevant to the provided error code. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - GOOGLE_PLAY_SERVICES_PACKAGE -

-
- - - - -
-
- - - - -

Package name for Google Play services. -

- - -
- Constant Value: - - - "com.google.android.gms" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GOOGLE_PLAY_SERVICES_VERSION_CODE -

-
- - - - -
-
- - - - -

Google Play services client library version (declared in library's - AndroidManifest.xml android:versionCode). -

- - -
- Constant Value: - - - 7329000 - (0x006fd4e8) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Dialog - - getErrorDialog - (Activity activity, int errorCode, int requestCode, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - - -

Returns a dialog to address the provided errorCode. The returned dialog displays a localized - message about the error and upon user confirmation (by tapping on dialog) will direct them to - the Play Store if Google Play services is out of date or missing, or to system settings if - Google Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - - - - -
activity - parent activity for creating the dialog, also used for identifying language - to display dialog in.
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
requestCode - The requestCode given when calling startActivityForResult.
cancelListener - The DialogInterface.OnCancelListener to invoke if the dialog is - canceled. -
-
- -
-
- - - - -
-

- - public - - - - - Dialog - - getErrorDialog - (Activity activity, int errorCode, int requestCode) -

-
-
- - - -
-
- - - - -

Returns a dialog to address the provided errorCode. The returned dialog displays a localized - message about the error and upon user confirmation (by tapping on dialog) will direct them to - the Play Store if Google Play services is out of date or missing, or to system settings if - Google Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - -
activity - parent activity for creating the dialog, also used for identifying language - to display dialog in.
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
requestCode - The requestCode given when calling startActivityForResult. -
-
- -
-
- - - - -
-

- - public - - - - - PendingIntent - - getErrorResolutionPendingIntent - (Context context, int errorCode, int requestCode) -

-
-
- - - -
-
- - - - -

Returns a PendingIntent to address the provided errorCode. It will direct them to either the - Play Store if Google Play services is out of date or missing, or system settings if Google - Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - -
context - parent context for creating the PendingIntent.
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
requestCode - The requestCode given when calling startActivityForResult. -
-
- -
-
- - - - -
-

- - public - - final - - - String - - getErrorString - (int errorCode) -

-
-
- - - -
-
- - - - -

Returns a human-readable string of the error code returned from - isGooglePlayServicesAvailable(Context). -

- -
-
- - - - -
-

- - public - static - - - - GoogleApiAvailability - - getInstance - () -

-
-
- - - -
-
- - - - -

Returns the singleton instance of GoogleApiAvailability. -

- -
-
- - - - -
-

- - public - - - - - String - - getOpenSourceSoftwareLicenseInfo - (Context context) -

-
-
- - - -
-
- - - - -

Returns the open source software license information for the Google Play services - application, or null if Google Play services is not available on this device. -

- -
-
- - - - -
-

- - public - - - - - int - - isGooglePlayServicesAvailable - (Context context) -

-
-
- - - -
-
- - - - -

Verifies that Google Play services is installed and enabled on this device, and that the - version installed on this device is no older than the one required by this client.

-
-
Returns
-
  • status code indicating whether there was an error. Can be one of following in - ConnectionResult: SUCCESS, SERVICE_MISSING, SERVICE_UPDATING, - SERVICE_VERSION_UPDATE_REQUIRED, SERVICE_DISABLED, SERVICE_INVALID -
-
- -
-
- - - - -
-

- - public - - final - - - boolean - - isUserResolvableError - (int errorCode) -

-
-
- - - -
-
- - - - -

Determines whether an error can be resolved via user action. If true, proceed by calling - getErrorDialog(Activity, int, int) and showing the dialog.

-
-
Parameters
- - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context), or - returned to your application via - onConnectionFailed(ConnectionResult)
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - boolean - - showErrorDialogFragment - (Activity activity, int errorCode, int requestCode, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - - -

Displays a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context).

-
-
Parameters
- - - - - - - - - - - - - -
activity - parent activity for creating the dialog, also used for - identifying language to display dialog in.
errorCode - error code returned by - isGooglePlayServicesAvailable(Context) call. If - errorCode is SUCCESS then this - does nothing
requestCode - The requestCode given when calling - startActivityForResult.
cancelListener - The DialogInterface.OnCancelListener to - invoke if the dialog is canceled.
-
-
-
Returns
-
  • true if the dialog is shown, false otherwise.
-
-
-
Throws
- - - - -
RuntimeException - if API level is below 11 and activity is not a - FragmentActivity.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - boolean - - showErrorDialogFragment - (Activity activity, int errorCode, int requestCode) -

-
-
- - - -
-
- - - - -

Displays a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context).

-
-
Parameters
- - - - - - - - - - -
activity - parent activity for creating the dialog, also used for - identifying language to display dialog in.
errorCode - error code returned by - isGooglePlayServicesAvailable(Context) call. If - errorCode is SUCCESS then this - does nothing.
requestCode - The requestCode given when calling - startActivityForResult.
-
-
-
Returns
-
  • true if the dialog is shown, false otherwise
-
-
-
Throws
- - - - -
RuntimeException - if API level is below 11 and activity is not a - FragmentActivity.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - void - - showErrorNotification - (Context context, int errorCode) -

-
-
- - - -
-
- - - - -

Displays a notification relevant to the provided error code. This method is similar to - getErrorDialog(android.app.Activity, int, int), but is provided for background tasks - that cannot or should not display dialogs.

-
-
Parameters
- - - - - - - -
context - used for identifying language to display dialog in as well as accessing the - NotificationManager.
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html deleted file mode 100644 index 46a69c7032a2..000000000000 --- a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html +++ /dev/null @@ -1,1660 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GooglePlayServicesNotAvailableException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GooglePlayServicesNotAvailableException

- - - - - - - - - - - - - extends Exception
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.common.GooglePlayServicesNotAvailableException
- - - - - - - -
- - -

Class Overview

-

Indicates Google Play services is not available. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - interrorCode - The error code returned by - isGooglePlayServicesAvailable(Context) call. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GooglePlayServicesNotAvailableException(int errorCode) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - int - - errorCode -

-
- - - - -
-
- - - - -

The error code returned by - isGooglePlayServicesAvailable(Context) call. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GooglePlayServicesNotAvailableException - (int errorCode) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesRepairableException.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesRepairableException.html deleted file mode 100644 index b4253eb76869..000000000000 --- a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesRepairableException.html +++ /dev/null @@ -1,1669 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GooglePlayServicesRepairableException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GooglePlayServicesRepairableException

- - - - - - - - - - - - - - - - - extends UserRecoverableException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.common.UserRecoverableException
      ↳com.google.android.gms.common.GooglePlayServicesRepairableException
- - - - - - - -
- - -

Class Overview

-

GooglePlayServicesRepairableExceptions are special instances of - UserRecoverableExceptions which are thrown when Google Play Services is not installed, - up-to-date, or enabled. In these cases, client code can use - getConnectionStatusCode() in conjunction with - getErrorDialog(int, android.app.Activity, int) - to provide users with a localized Dialog that will allow users to install, - update, or otherwise enable Google Play services. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getConnectionStatusCode() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.UserRecoverableException - -
- - -
-
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getConnectionStatusCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html deleted file mode 100644 index 4484a15ee757..000000000000 --- a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html +++ /dev/null @@ -1,2573 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GooglePlayServicesUtil | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GooglePlayServicesUtil

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.GooglePlayServicesUtil
- - - - - - - -
- - -

Class Overview

-

Utility class for verifying that the Google Play services APK is available and - up-to-date on this device. The same checks are performed if one uses - AdvertisingIdClient or - GoogleAuthUtil to connect to the service. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringGMS_ERROR_DIALOG - - - - -
StringGOOGLE_PLAY_SERVICES_PACKAGE - - This constant is deprecated. - Use GOOGLE_PLAY_SERVICES_PACKAGE instead. - - - - -
intGOOGLE_PLAY_SERVICES_VERSION_CODE - - This constant is deprecated. - Use GOOGLE_PLAY_SERVICES_VERSION_CODE instead. - - - - -
StringGOOGLE_PLAY_STORE_PACKAGE - Package name for Google Play Store. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Dialog - - getErrorDialog(int errorCode, Activity activity, int requestCode) - -
- - This method is deprecated. - Use getErrorDialog(Activity, int, int) instead. - - - - -
- -
- - - - static - - Dialog - - getErrorDialog(int errorCode, Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener) - -
- - This method is deprecated. - Use #getErrorDialog(Activity, int, int, OnCancelListener) instead. - - - - -
- -
- - - - static - - PendingIntent - - getErrorPendingIntent(int errorCode, Context context, int requestCode) - -
- - This method is deprecated. - Use getErrorResolutionPendingIntent(Context, int, int) instead. - - - - -
- -
- - - - static - - String - - getErrorString(int errorCode) - -
- - This method is deprecated. - Use getErrorString(int) instead. - - - - -
- -
- - - - static - - String - - getOpenSourceSoftwareLicenseInfo(Context context) - -
- - This method is deprecated. - Use getOpenSourceSoftwareLicenseInfo(Context) instead. - - - - -
- -
- - - - static - - Context - - getRemoteContext(Context context) - -
- This gets the Context object of the Buddy APK. - - - -
- -
- - - - static - - Resources - - getRemoteResource(Context context) - -
- This gets the Resources object of the Buddy APK. - - - -
- -
- - - - static - - int - - isGooglePlayServicesAvailable(Context context) - -
- - This method is deprecated. - Use isGooglePlayServicesAvailable(Context) instead. - - - - -
- -
- - - - static - - boolean - - isUserRecoverableError(int errorCode) - -
- - This method is deprecated. - Use isUserResolvableError(int) instead. - - - - -
- -
- - - - static - - boolean - - showErrorDialogFragment(int errorCode, Activity activity, int requestCode) - -
- - This method is deprecated. - Use #showErrorDialogFragment(Activity, int, int) instead. - - - - -
- -
- - - - static - - boolean - - showErrorDialogFragment(int errorCode, Activity activity, Fragment fragment, int requestCode, DialogInterface.OnCancelListener cancelListener) - -
- - - - static - - boolean - - showErrorDialogFragment(int errorCode, Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener) - -
- - This method is deprecated. - Use #showErrorDialogFragment(Activity, int, int, OnCancelListener) instead. - - - - -
- -
- - - - static - - void - - showErrorNotification(int errorCode, Context context) - -
- - This method is deprecated. - Use {GoogleApiAvailability#showErrorNotification(Context, int)} instead. - - - - -
- -
- - - - - - - - - - - - - - - - -
Protected Methods
- - - - static - - int - - getErrorNotificationId(int errorCode) - -
- - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - GMS_ERROR_DIALOG -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - "GooglePlayServicesErrorDialog" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GOOGLE_PLAY_SERVICES_PACKAGE -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- Use GOOGLE_PLAY_SERVICES_PACKAGE instead. - -

-

Package name for Google Play services.

- - -
- Constant Value: - - - "com.google.android.gms" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GOOGLE_PLAY_SERVICES_VERSION_CODE -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- Use GOOGLE_PLAY_SERVICES_VERSION_CODE instead. - -

-

Google Play services client library version (declared in library's - AndroidManifest.xml android:versionCode).

- - -
- Constant Value: - - - 7329000 - (0x006fd4e8) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GOOGLE_PLAY_STORE_PACKAGE -

-
- - - - -
-
- - - - -

Package name for Google Play Store. -

- - -
- Constant Value: - - - "com.android.vending" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Dialog - - getErrorDialog - (int errorCode, Activity activity, int requestCode) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getErrorDialog(Activity, int, int) instead. - -

-

Returns a dialog to address the provided errorCode. The returned dialog displays a localized - message about the error and upon user confirmation (by tapping on dialog) will direct them to - the Play Store if Google Play services is out of date or missing, or to system settings if - Google Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
activity - parent activity for creating the dialog, also used for identifying language - to display dialog in.
requestCode - The requestCode given when calling startActivityForResult.
-
- -
-
- - - - -
-

- - public - static - - - - Dialog - - getErrorDialog - (int errorCode, Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use #getErrorDialog(Activity, int, int, OnCancelListener) instead. - -

-

Returns a dialog to address the provided errorCode. The returned dialog displays a localized - message about the error and upon user confirmation (by tapping on dialog) will direct them to - the Play Store if Google Play services is out of date or missing, or to system settings if - Google Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
activity - parent activity for creating the dialog, also used for identifying language - to display dialog in.
requestCode - The requestCode given when calling startActivityForResult.
cancelListener - The DialogInterface.OnCancelListener to invoke if the dialog is - canceled.
-
- -
-
- - - - -
-

- - public - static - - - - PendingIntent - - getErrorPendingIntent - (int errorCode, Context context, int requestCode) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getErrorResolutionPendingIntent(Context, int, int) instead. - -

-

Returns a PendingIntent to address the provided errorCode. It will direct them to one of the - following places to either the Play Store if Google Play services is out of date or missing, - or system settings if Google Play services is disabled on the device.

-
-
Parameters
- - - - - - - - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
context - parent context for creating the PendingIntent.
requestCode - The requestCode given when calling startActivityForResult.
-
- -
-
- - - - -
-

- - public - static - - - - String - - getErrorString - (int errorCode) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getErrorString(int) instead. - -

-

Returns a human-readable string of the error code returned from - isGooglePlayServicesAvailable(Context).

- -
-
- - - - -
-

- - public - static - - - - String - - getOpenSourceSoftwareLicenseInfo - (Context context) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getOpenSourceSoftwareLicenseInfo(Context) instead. - -

-

Returns the open source software license information for the Google Play services - application, or null if Google Play services is not available on this device.

- -
-
- - - - -
-

- - public - static - - - - Context - - getRemoteContext - (Context context) -

-
-
- - - -
-
- - - - -

This gets the Context object of the Buddy APK. This loads the Buddy APK code from the Buddy - APK into memory. This returned context can be used to create classes and obtain resources - defined in the Buddy APK.

-
-
Returns
-
  • The Context object of the Buddy APK or null if the Buddy APK is not installed on the - device. -
-
- -
-
- - - - -
-

- - public - static - - - - Resources - - getRemoteResource - (Context context) -

-
-
- - - -
-
- - - - -

This gets the Resources object of the Buddy APK.

-
-
Returns
-
  • The Resources object of the Buddy APK or null if the Buddy APK is not installed on - the device. -
-
- -
-
- - - - -
-

- - public - static - - - - int - - isGooglePlayServicesAvailable - (Context context) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use isGooglePlayServicesAvailable(Context) instead. - -

-

Verifies that Google Play services is installed and enabled on this device, and that the - version installed on this device is no older than the one required by this client.

-
-
Returns
-
  • status code indicating whether there was an error. Can be one of following in - ConnectionResult: SUCCESS, SERVICE_MISSING, - SERVICE_VERSION_UPDATE_REQUIRED, SERVICE_DISABLED, SERVICE_INVALID
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - isUserRecoverableError - (int errorCode) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use isUserResolvableError(int) instead. - -

-

Determines whether an error is user-recoverable. If true, proceed by calling - getErrorDialog(int, Activity, int) and showing the dialog.

-
-
Parameters
- - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context), or - returned to your application via - onConnectionFailed(ConnectionResult)
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - boolean - - showErrorDialogFragment - (int errorCode, Activity activity, int requestCode) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use #showErrorDialogFragment(Activity, int, int) instead. - -

-

Display a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context).

-
-
Parameters
- - - - - - - - - - -
errorCode - error code returned by - isGooglePlayServicesAvailable(Context) call. If - errorCode is SUCCESS then this - does nothing.
activity - parent activity for creating the dialog, also used for - identifying language to display dialog in.
requestCode - The requestCode given when calling - startActivityForResult.
-
-
-
Returns
-
  • true if the dialog is shown, false otherwise
-
-
-
Throws
- - - - -
RuntimeException - if API level is below 11 and activity is not a - FragmentActivity.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - boolean - - showErrorDialogFragment - (int errorCode, Activity activity, Fragment fragment, int requestCode, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - boolean - - showErrorDialogFragment - (int errorCode, Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use #showErrorDialogFragment(Activity, int, int, OnCancelListener) instead. - -

-

Display a DialogFragment for an error code returned by - isGooglePlayServicesAvailable(Context).

-
-
Parameters
- - - - - - - - - - - - - -
errorCode - error code returned by - isGooglePlayServicesAvailable(Context) call. If - errorCode is SUCCESS then this - does nothing
activity - parent activity for creating the dialog, also used for - identifying language to display dialog in.
requestCode - The requestCode given when calling - startActivityForResult.
cancelListener - The DialogInterface.OnCancelListener to - invoke if the dialog is canceled.
-
-
-
Returns
-
  • true if the dialog is shown, false otherwise.
-
-
-
Throws
- - - - -
RuntimeException - if API level is below 11 and activity is not a - FragmentActivity.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - void - - showErrorNotification - (int errorCode, Context context) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use {GoogleApiAvailability#showErrorNotification(Context, int)} instead. - -

-

Displays a notification relevant to the provided error code. This method is similar to - getErrorDialog(int, android.app.Activity, int), but is provided for background tasks - that cannot or shouldn't display dialogs.

-
-
Parameters
- - - - - - - -
errorCode - error code returned by isGooglePlayServicesAvailable(Context) call. - If errorCode is SUCCESS then null is returned.
context - used for identifying language to display dialog in as well as accessing the - NotificationManager.
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - static - - - - int - - getErrorNotificationId - (int errorCode) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/Scopes.html b/docs/html/reference/com/google/android/gms/common/Scopes.html deleted file mode 100644 index c103d842f5c8..000000000000 --- a/docs/html/reference/com/google/android/gms/common/Scopes.html +++ /dev/null @@ -1,2195 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Scopes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Scopes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.Scopes
- - - - - - - -
- - -

Class Overview

-

OAuth 2.0 scopes for use with Google Play services. - See the specific client methods for details on which scopes are required. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringAPP_STATE - Scope for using the App State service. - - - -
StringCLOUD_SAVE - Scope for using the CloudSave service. - - - -
StringDRIVE_APPFOLDER - Scope for accessing appfolder files from Google Drive. - - - -
StringDRIVE_FILE - Scope for access user-authorized files from Google Drive. - - - -
StringFITNESS_ACTIVITY_READ - Scope for read access to activity-related data types in Google Fit. - - - -
StringFITNESS_ACTIVITY_READ_WRITE - Scope for read/write access to activity-related data types in Google Fit. - - - -
StringFITNESS_BODY_READ - Scope for read access to biometric data types in Google Fit. - - - -
StringFITNESS_BODY_READ_WRITE - Scope for read/write access to biometric data types in Google Fit. - - - -
StringFITNESS_LOCATION_READ - Scope for read access to location-related data types in Google Fit. - - - -
StringFITNESS_LOCATION_READ_WRITE - Scope for read/write access to location-related data types in Google Fit. - - - -
StringFITNESS_NUTRITION_READ - Scope for read access to nutrition data types in Google Fit. - - - -
StringFITNESS_NUTRITION_READ_WRITE - Scope for read/write access to nutrition data types in Google Fit. - - - -
StringGAMES - Scope for accessing data from Google Play Games. - - - -
StringPLUS_LOGIN - OAuth 2.0 scope for accessing the user's name, basic profile info, list of people in the - user's circles, and writing app activities to Google. - - - -
StringPLUS_ME -

This scope was previously named PLUS_PROFILE. - - - -

StringPLUS_MOMENTS - Scope for writing app activities to Google. - - - -
StringPROFILE - OAuth 2.0 scope for accessing user's basic profile information. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - APP_STATE -

-
- - - - -
-
- - - - -

Scope for using the App State service. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/appstate" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CLOUD_SAVE -

-
- - - - -
-
- - - - -

Scope for using the CloudSave service. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/datastoremobile" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - DRIVE_APPFOLDER -

-
- - - - -
-
- - - - -

Scope for accessing appfolder files from Google Drive. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/drive.appdata" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - DRIVE_FILE -

-
- - - - -
-
- - - - -

Scope for access user-authorized files from Google Drive. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/drive.file" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_ACTIVITY_READ -

-
- - - - -
-
- - - - -

Scope for read access to activity-related data types in Google Fit. These include - activity type, calories consumed and expended, step counts, and others. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.activity.read" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_ACTIVITY_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to activity-related data types in Google Fit. These include - activity type, calories consumed and expended, step counts, and others. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.activity.write" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_BODY_READ -

-
- - - - -
-
- - - - -

Scope for read access to biometric data types in Google Fit. These include heart rate, - height, and weight. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.body.read" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_BODY_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to biometric data types in Google Fit. These include heart - rate, height, and weight. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.body.write" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_LOCATION_READ -

-
- - - - -
-
- - - - -

Scope for read access to location-related data types in Google Fit. These include - location, distance, and speed. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.location.read" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_LOCATION_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to location-related data types in Google Fit. These include - location, distance, and speed. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.location.write" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_NUTRITION_READ -

-
- - - - -
-
- - - - -

Scope for read access to nutrition data types in Google Fit. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.nutrition.read" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FITNESS_NUTRITION_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to nutrition data types in Google Fit. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/fitness.nutrition.write" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GAMES -

-
- - - - -
-
- - - - -

Scope for accessing data from Google Play Games. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/games" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PLUS_LOGIN -

-
- - - - -
-
- - - - -

OAuth 2.0 scope for accessing the user's name, basic profile info, list of people in the - user's circles, and writing app activities to Google. - -

When using this scope, your app will have access to:

-
    -
  • the user's full name, profile picture, Google+ profile ID, age range, and language
    • -
  • people the user has circled, represented as a list of public profiles
    • -
  • any other publicly available information on the user's Google+ profile
    • -
  • write app activities (moments) to Google.
    • -
-

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/plus.login" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PLUS_ME -

-
- - - - -
-
- - - - -

This scope was previously named PLUS_PROFILE.

-

When using this scope, it does the following:

-
    - -
  • It lets you know who the currently authenticated user is by letting you replace a - Google+ user ID with "me", which represents the authenticated user, in any call to the - Google+ API.
    • -
-

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/plus.me" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PLUS_MOMENTS -

-
- - - - -
-
- - - - -

Scope for writing app activities to Google. -

- This scope is not necessary if the PLUS_LOGIN scope is already used. -

- - -
- Constant Value: - - - "https://www.googleapis.com/auth/plus.moments.write" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PROFILE -

-
- - - - -
-
- - - - -

OAuth 2.0 scope for accessing user's basic profile information. - -

When using this scope, it does the following:

-
    -
  • It requests that your app be given access to the authenticated user's basic profile - information.
    • -
  • It lets you know who the currently authenticated user is by letting you replace a - Google+ user ID with "me", which represents the authenticated user, in any call to the - Google+ API.
    • -
  • It lets your web app access over-the-air Android app installs.
    • -
-

- - -
- Constant Value: - - - "profile" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/SignInButton.html b/docs/html/reference/com/google/android/gms/common/SignInButton.html deleted file mode 100644 index daae02bd92ce..000000000000 --- a/docs/html/reference/com/google/android/gms/common/SignInButton.html +++ /dev/null @@ -1,15933 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SignInButton | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SignInButton

- - - - - - - - - - - - - - - - - extends FrameLayout
- - - - - - - implements - - View.OnClickListener - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳android.widget.FrameLayout
      ↳com.google.android.gms.common.SignInButton
- - - - - - - -
- - -

Class Overview

-

The Google sign-in button to authenticate the user. Note that this class only handles the visual - aspects of the button. In order to trigger an action, register a listener using - setOnClickListener(OnClickListener). -

- Note that you must explicitly call setOnClickListener(OnClickListener). Do not register - a listener via XML, or you won't receive your callbacks. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCOLOR_DARK - The dark color scheme of the Google sign-in button. - - - -
intCOLOR_LIGHT - The light color scheme of the Google sign-in button. - - - -
intSIZE_ICON_ONLY - The icon-only size of the Google sign-in button. - - - -
intSIZE_STANDARD - The standard size of the Google sign-in button. - - - -
intSIZE_WIDE - The wide size of the Google sign-in button. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SignInButton(Context context) - -
- - - - - - - - SignInButton(Context context, AttributeSet attrs) - -
- - - - - - - - SignInButton(Context context, AttributeSet attrs, int defStyle) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onClick(View view) - -
- - - - - - void - - setColorScheme(int colorScheme) - -
- Set the color scheme of the button to use. - - - -
- -
- - - - - - void - - setEnabled(boolean enabled) - -
- - - - - - void - - setOnClickListener(View.OnClickListener listener) - -
- - - - - - void - - setSize(int buttonSize) - -
- Set the size of the button to use. - - - -
- -
- - - - - - void - - setStyle(int buttonSize, int colorScheme) - -
- Set the desired style of button to use. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.FrameLayout - -
- - -
-
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- -From interface - - android.view.View.OnClickListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - COLOR_DARK -

-
- - - - -
-
- - - - -

The dark color scheme of the Google sign-in button. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - COLOR_LIGHT -

-
- - - - -
-
- - - - -

The light color scheme of the Google sign-in button. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_ICON_ONLY -

-
- - - - -
-
- - - - -

The icon-only size of the Google sign-in button. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_STANDARD -

-
- - - - -
-
- - - - -

The standard size of the Google sign-in button. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_WIDE -

-
- - - - -
-
- - - - -

The wide size of the Google sign-in button. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SignInButton - (Context context) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - SignInButton - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - SignInButton - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onClick - (View view) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setColorScheme - (int colorScheme) -

-
-
- - - -
-
- - - - -

Set the color scheme of the button to use. The size will remain unchanged.

-
-
Parameters
- - - - -
colorScheme - The color scheme to use for the button. Valid values are - COLOR_DARK or COLOR_LIGHT. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setOnClickListener - (View.OnClickListener listener) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setSize - (int buttonSize) -

-
-
- - - -
-
- - - - -

Set the size of the button to use. The color scheme will remain unchanged.

-
-
Parameters
- - - - -
buttonSize - The size of the button to display. Valid values are SIZE_STANDARD, - SIZE_WIDE, or SIZE_ICON_ONLY. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStyle - (int buttonSize, int colorScheme) -

-
-
- - - -
-
- - - - -

Set the desired style of button to use. This will update the button to use the specified size - and color scheme.

-
-
Parameters
- - - - - - - -
buttonSize - The size of the button to display. Valid values are SIZE_STANDARD, - SIZE_WIDE, or SIZE_ICON_ONLY.
colorScheme - The color scheme to use for the button. Valid values are - COLOR_DARK or COLOR_LIGHT. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/SupportErrorDialogFragment.html b/docs/html/reference/com/google/android/gms/common/SupportErrorDialogFragment.html deleted file mode 100644 index 492c470e867f..000000000000 --- a/docs/html/reference/com/google/android/gms/common/SupportErrorDialogFragment.html +++ /dev/null @@ -1,3839 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SupportErrorDialogFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SupportErrorDialogFragment

- - - - - - - - - - - - - extends DialogFragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.support.v4.app.Fragment
    ↳android.support.v4.app.DialogFragment
     ↳com.google.android.gms.common.SupportErrorDialogFragment
- - - - - - - -
- - -

Class Overview

-

Wraps the Dialog returned by - getErrorDialog(int, Activity, int) by using - DialogFragment so that it can be properly managed by the - Activity. -

- To use this class, you must include the Android support library in your build path. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.support.v4.app.DialogFragment -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SupportErrorDialogFragment() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - SupportErrorDialogFragment - - newInstance(Dialog dialog, DialogInterface.OnCancelListener cancelListener) - -
- Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int) with an OnCancelListener. - - - -
- -
- - - - static - - SupportErrorDialogFragment - - newInstance(Dialog dialog) - -
- Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int). - - - -
- -
- - - - - - void - - onCancel(DialogInterface dialog) - -
- - - - - - Dialog - - onCreateDialog(Bundle savedInstanceState) - -
- Returns a Dialog created by - getErrorDialog(int, Activity, int) with the provided - errorCode, activity, request code, and cancel listener. - - - -
- -
- - - - - - void - - show(FragmentManager manager, String tag) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.support.v4.app.DialogFragment - -
- - -
-
- -From class - - android.support.v4.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.DialogInterface.OnCancelListener - -
- - -
-
- -From interface - - android.content.DialogInterface.OnDismissListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SupportErrorDialogFragment - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - SupportErrorDialogFragment - - newInstance - (Dialog dialog, DialogInterface.OnCancelListener cancelListener) -

-
-
- - - -
-
- - - - -

Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int) with an OnCancelListener.

-
-
Parameters
- - - - - - - -
dialog - The Dialog created by - getErrorDialog(int, Activity, int).
cancelListener - A DialogInterface.OnCancelListener for when a user cancels the - DialogFragment.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - SupportErrorDialogFragment - - newInstance - (Dialog dialog) -

-
-
- - - -
-
- - - - -

Create a DialogFragment for displaying the - getErrorDialog(int, Activity, int).

-
-
Parameters
- - - - -
dialog - The Dialog created by - getErrorDialog(int, Activity, int).
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - onCancel - (DialogInterface dialog) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Dialog - - onCreateDialog - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Returns a Dialog created by - getErrorDialog(int, Activity, int) with the provided - errorCode, activity, request code, and cancel listener.

-
-
Parameters
- - - - -
savedInstanceState - Not used. -
-
- -
-
- - - - -
-

- - public - - - - - void - - show - (FragmentManager manager, String tag) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/UserRecoverableException.html b/docs/html/reference/com/google/android/gms/common/UserRecoverableException.html deleted file mode 100644 index 3a3ce8cc732e..000000000000 --- a/docs/html/reference/com/google/android/gms/common/UserRecoverableException.html +++ /dev/null @@ -1,1712 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserRecoverableException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

UserRecoverableException

- - - - - - - - - - - - - extends Exception
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳com.google.android.gms.common.UserRecoverableException
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

UserRecoverableExceptions signal errors that can be recovered with user - action, such as a user login. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - UserRecoverableException(String msg, Intent intent) - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Intent - - getIntent() - -
- Getter for an Intent that when supplied to startActivityForResult(Intent, int), will allow user intervention. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - UserRecoverableException - (String msg, Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Intent - - getIntent - () -

-
-
- - - -
-
- - - - -

Getter for an Intent that when supplied to startActivityForResult(Intent, int), will allow user intervention.

-
-
Returns
-
  • Intent representing the ameliorating user action. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/annotation/KeepName.html b/docs/html/reference/com/google/android/gms/common/annotation/KeepName.html deleted file mode 100644 index 78b382958b7f..000000000000 --- a/docs/html/reference/com/google/android/gms/common/annotation/KeepName.html +++ /dev/null @@ -1,1118 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -KeepName | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - @interface -

KeepName

- - - - - - implements - - Annotation - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.annotation.KeepName
- - - - - - - -
- - -

Class Overview

-

Indicates that the name of this object (class, method, etc) should be retained when proguarding. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - java.lang.annotation.Annotation - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/annotation/package-summary.html b/docs/html/reference/com/google/android/gms/common/annotation/package-summary.html deleted file mode 100644 index 9c9c299e157d..000000000000 --- a/docs/html/reference/com/google/android/gms/common/annotation/package-summary.html +++ /dev/null @@ -1,885 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.common.annotation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.common.annotation

-
- -
- -
- - - - - - - -

Annotations

-
- - - - - - - - - - -
KeepName - Indicates that the name of this object (class, method, etc) should be retained when proguarding.  - - - -
- -
- - - - - - - - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions.html b/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions.html deleted file mode 100644 index 25d63259f307..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions.html +++ /dev/null @@ -1,1114 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api.ApiOptions.HasOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Api.ApiOptions.HasOptions

- - - - - - implements - - Api.ApiOptions - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Api.ApiOptions.HasOptions
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for Api.ApiOptions in Apis that have options.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions.html b/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions.html deleted file mode 100644 index ac131d593e89..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions.html +++ /dev/null @@ -1,1257 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api.ApiOptions.NoOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Api.ApiOptions.NoOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.NotRequiredOptions - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Api.ApiOptions.NoOptions
- - - - - - - -
- - -

Class Overview

-

Api.ApiOptions implementation for Apis that do not take any options.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions.html b/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions.html deleted file mode 100644 index 5fe27bacd77d..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions.html +++ /dev/null @@ -1,1088 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api.ApiOptions.NotRequiredOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Api.ApiOptions.NotRequiredOptions

- - - - - - implements - - Api.ApiOptions - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Api.ApiOptions.NotRequiredOptions
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for Api.ApiOptions that are not required, don't exist.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional.html b/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional.html deleted file mode 100644 index a5b60fb37803..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional.html +++ /dev/null @@ -1,1074 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api.ApiOptions.Optional | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Api.ApiOptions.Optional

- - - - - - implements - - Api.ApiOptions.HasOptions - - Api.ApiOptions.NotRequiredOptions - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Api.ApiOptions.Optional
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for Api.ApiOptions that are optional.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.html b/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.html deleted file mode 100644 index cf0a2315d0c9..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.ApiOptions.html +++ /dev/null @@ -1,1257 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api.ApiOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Api.ApiOptions

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Api.ApiOptions
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for API options. These are used to configure specific parameters for - individual API surfaces. The default implementation has no parameters. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Api.html b/docs/html/reference/com/google/android/gms/common/api/Api.html deleted file mode 100644 index bd5f90780fc4..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Api.html +++ /dev/null @@ -1,1281 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Api | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Api

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
-
Nested Classes
- - - - - interfaceApi.ApiOptions.HasOptions - Base interface for Api.ApiOptions in Apis that have options.  - - - -
- - - - - classApi.ApiOptions.NoOptions - Api.ApiOptions implementation for Apis that do not take any options.  - - - -
- - - - - interfaceApi.ApiOptions.NotRequiredOptions - Base interface for Api.ApiOptions that are not required, don't exist.  - - - -
- - - - - interfaceApi.ApiOptions.Optional - Base interface for Api.ApiOptions that are optional.  - - - -
- - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Api<O extends com.google.android.gms.common.api.Api.ApiOptions>
- - - - - - - -
- - -

Class Overview

-

Describes a section of the Google Play Services API that should be made available. - Instances of this should be passed into addApi(Api) to enable the - appropriate parts of Google Play Services. -

- Google APIs are partitioned into sections which allow your application to configure only the - services it requires. Each Google API provides an API object which can be passed to - addApi(Api) in order to configure and enable that functionality - in your GoogleApiClient instance. -

- See GoogleApiClient.Builder for usage examples. -

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceApi.ApiOptions - Base interface for API options.  - - - -
- - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Batch.Builder.html b/docs/html/reference/com/google/android/gms/common/api/Batch.Builder.html deleted file mode 100644 index 7803119f6557..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Batch.Builder.html +++ /dev/null @@ -1,1441 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Batch.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Batch.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Batch.Builder
- - - - - - - -
- - -

Class Overview

-

Builder for Batch objects. Note that this class is not thread-safe, by design. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Batch.Builder(GoogleApiClient googleApiClient) - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - <R extends Result> - BatchResultToken<R> - - add(PendingResult<R> pendingResult) - -
- Adds a PendingResult to the batch. - - - -
- -
- - - - - - Batch - - build() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Batch.Builder - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - BatchResultToken<R> - - add - (PendingResult<R> pendingResult) -

-
-
- - - -
-
- - - - -

Adds a PendingResult to the batch. The returned token can be used to retrieve - the result from the BatchResult passed to the result callback.

-
-
Parameters
- - - - -
pendingResult - Items to wait for completion of.
-
-
-
Returns
-
  • The result token to use to get the result from the BatchResult. -
-
- -
-
- - - - -
-

- - public - - - - - Batch - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Batch.html b/docs/html/reference/com/google/android/gms/common/api/Batch.html deleted file mode 100644 index 92a4c59da4e8..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Batch.html +++ /dev/null @@ -1,2280 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Batch | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Batch

- - - - - extends Object
- - - - - - - implements - - PendingResult<BatchResult> - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Batch
- - - - - - - -
- - -

Class Overview

-

Handles a batch of PendingResult items. Callbacks can be added and you can block to wait for all - items in the batch to complete like any other PendingResult item. A Batch can also be - canceled if the results are no longer needed. In this case, the onBatchComplete callback - will never be triggered. -

- The results can be taken either from the underlying PendingResults or via - take(BatchResultToken) but not both. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classBatch.Builder - Builder for Batch objects.  - - - -
- - - - - - - - - - - -
Fields
- protected - - final - CallbackHandler<R extends Result>mHandler - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - void - - addBatchCallback(PendingResult.BatchCallback callback) - -
- - - final - - - BatchResult - - await() - -
- Blocks until the task is completed. - - - -
- -
- - - final - - - BatchResult - - await(long time, TimeUnit units) - -
- Blocks until the task is completed or has timed out waiting for the result. - - - -
- -
- - - - - - void - - cancel() - -
- Requests that the batch be canceled. - - - -
- -
- - - - - - BatchResult - - createFailedResult(Status status) - -
- Creates a result of type that represents a failure with the specified - Status. - - - -
- -
- - - final - - - void - - forceFailureUnlessReady(Status status) - -
- Forces the result of the API call a failure, unless a result has otherwise already been set. - - - -
- -
- - - - - - boolean - - isCanceled() - -
- Indicates whether the pending result has been canceled either due to calling - disconnect() or calling cancel() directly on the pending result - or an enclosing Batch. - - - -
- -
- - - final - - - boolean - - isReady() - -
- - - final - - - void - - setResult(R result) - -
- Sets the result of the API call. - - - -
- -
- - - final - - - void - - setResultCallback(ResultCallback<R extends Result> callback, long time, TimeUnit units) - -
- Set the callback here if you want the result to be delivered via a callback when the result - is ready or has timed out waiting for the result. - - - -
- -
- - - final - - - void - - setResultCallback(ResultCallback<R extends Result> callback) - -
- Set the callback here if you want the result to be delivered via a callback when the - result is ready. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - void - - onResultConsumed() - -
- Called when the result is returned by await() or delivered via a - ResultCallback. - - - -
- -
- - - final - - - void - - setCancelToken(ICancelToken cancelToken) - -
- - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.PendingResult - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - protected - - final - CallbackHandler<R extends Result> - - mHandler -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - void - - addBatchCallback - (PendingResult.BatchCallback callback) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - final - - - BatchResult - - await - () -

-
-
- - - -
-
- - - - -

Blocks until the task is completed. This is not allowed on the UI thread. The returned - result object can have an additional failure mode of INTERRUPTED. -

- -
-
- - - - -
-

- - public - - final - - - BatchResult - - await - (long time, TimeUnit units) -

-
-
- - - -
-
- - - - -

Blocks until the task is completed or has timed out waiting for the result. This is not - allowed on the UI thread. The returned result object can have an additional failure mode of - either INTERRUPTED or TIMEOUT. -

- -
-
- - - - -
-

- - public - - - - - void - - cancel - () -

-
-
- - - -
-
- - - - -

Requests that the batch be canceled. Cancels all underlying PendingResults. -

- onResult(Result) will never be called, await() will return - a failed result with status CANCELED. -

- -
-
- - - - -
-

- - public - - - - - BatchResult - - createFailedResult - (Status status) -

-
-
- - - -
-
- - - - -

Creates a result of type that represents a failure with the specified - Status. -

- -
-
- - - - -
-

- - public - - final - - - void - - forceFailureUnlessReady - (Status status) -

-
-
- - - -
-
- - - - -

Forces the result of the API call a failure, unless a result has otherwise already been set. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isCanceled - () -

-
-
- - - -
-
- - - - -

Indicates whether the pending result has been canceled either due to calling - disconnect() or calling cancel() directly on the pending result - or an enclosing Batch. -

- -
-
- - - - -
-

- - public - - final - - - boolean - - isReady - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - final - - - void - - setResult - (R result) -

-
-
- - - -
-
- - - - -

Sets the result of the API call. Assuming that a failure or cancelation has not already - been set, the result will be returned to the client via await() or - onResult(R). - -

This method must called at most once. -

- -
-
- - - - -
-

- - public - - final - - - void - - setResultCallback - (ResultCallback<R extends Result> callback, long time, TimeUnit units) -

-
-
- - - -
-
- - - - -

Set the callback here if you want the result to be delivered via a callback when the result - is ready or has timed out waiting for the result. The returned result object can have an - additional failure mode of TIMEOUT. -

- -
-
- - - - -
-

- - public - - final - - - void - - setResultCallback - (ResultCallback<R extends Result> callback) -

-
-
- - - -
-
- - - - -

Set the callback here if you want the result to be delivered via a callback when the - result is ready. -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - void - - onResultConsumed - () -

-
-
- - - -
-
- - - - -

Called when the result is returned by await() or delivered via a - ResultCallback. -

- -
-
- - - - -
-

- - protected - - final - - - void - - setCancelToken - (ICancelToken cancelToken) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/BatchResult.html b/docs/html/reference/com/google/android/gms/common/api/BatchResult.html deleted file mode 100644 index 725865963f67..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/BatchResult.html +++ /dev/null @@ -1,1440 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BatchResult

- - - - - extends Object
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.BatchResult
- - - - - - - -
- - -

Class Overview

-

The result of a batch operation. The result status is successful if and only if all results - are successful. Individual results can be retrieved using BatchResultToken objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - <R extends Result> - R - - take(BatchResultToken<R> resultToken) - -
- Retrieves a result from the batch. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - R - - take - (BatchResultToken<R> resultToken) -

-
-
- - - -
-
- - - - -

Retrieves a result from the batch. - -

After the result has been retrieved, it is an error to attempt to retrieve it again. It is - the responsibility of the caller to release any resources associated with the returned - result. Some result types may implement Releasable, in which case - release() should be used to free the associated resources. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/BatchResultToken.html b/docs/html/reference/com/google/android/gms/common/api/BatchResultToken.html deleted file mode 100644 index 8257feac1c19..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/BatchResultToken.html +++ /dev/null @@ -1,1305 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BatchResultToken | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BatchResultToken

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.BatchResultToken<R extends com.google.android.gms.common.api.Result>
- - - - - - - -
- - -

Class Overview

-

Result token used to retrieve the result of individual operations from a batch. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- protected - - final - intmId - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - protected - - final - int - - mId -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/CommonStatusCodes.html b/docs/html/reference/com/google/android/gms/common/api/CommonStatusCodes.html deleted file mode 100644 index c60ce737abe4..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/CommonStatusCodes.html +++ /dev/null @@ -1,2505 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CommonStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CommonStatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Common status codes that are often shared across API surfaces. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAPI_NOT_AVAILABLE - The client attempted to call a method from an API that failed to connect. - - - -
intCANCELED - The result was canceled either due to client disconnect or cancel(). - - - -
intDEVELOPER_ERROR - The application is misconfigured. - - - -
intERROR - The operation failed with no more detailed information. - - - -
intINTERNAL_ERROR - An internal error occurred. - - - -
intINTERRUPTED - A blocking call was interrupted while waiting and did not run to completion. - - - -
intINVALID_ACCOUNT - The client attempted to connect to the service with an invalid account name specified. - - - -
intLICENSE_CHECK_FAILED - The application is not licensed to the user. - - - -
intNETWORK_ERROR - A network error occurred. - - - -
intRESOLUTION_REQUIRED - Completing the operation requires some form of resolution. - - - -
intSERVICE_DISABLED - The installed version of Google Play services has been disabled on this device. - - - -
intSERVICE_INVALID - The version of the Google Play services installed on this device is not authentic. - - - -
intSERVICE_MISSING - Google Play services is missing on this device. - - - -
intSERVICE_VERSION_UPDATE_REQUIRED - The installed version of Google Play services is out of date. - - - -
intSIGN_IN_REQUIRED - The client attempted to connect to the service but the user is not signed in. - - - -
intSUCCESS - The operation was successful. - - - -
intSUCCESS_CACHE - The operation was successful, but was used the device's cache. - - - -
intTIMEOUT - Timed out while awaiting the result. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CommonStatusCodes() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - API_NOT_AVAILABLE -

-
- - - - -
-
- - - - -

The client attempted to call a method from an API that failed to connect. See - addApiIfAvailable(Api, Scope...). -

- - -
- Constant Value: - - - 17 - (0x00000011) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CANCELED -

-
- - - - -
-
- - - - -

The result was canceled either due to client disconnect or cancel(). -

- - -
- Constant Value: - - - 16 - (0x00000010) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DEVELOPER_ERROR -

-
- - - - -
-
- - - - -

The application is misconfigured. This error is not recoverable and will be treated as fatal. - The developer should look at the logs after this to determine more actionable information. -

- - -
- Constant Value: - - - 10 - (0x0000000a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR -

-
- - - - -
-
- - - - -

The operation failed with no more detailed information. -

- - -
- Constant Value: - - - 13 - (0x0000000d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERNAL_ERROR -

-
- - - - -
-
- - - - -

An internal error occurred. Retrying should resolve the problem. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERRUPTED -

-
- - - - -
-
- - - - -

A blocking call was interrupted while waiting and did not run to completion. -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVALID_ACCOUNT -

-
- - - - -
-
- - - - -

The client attempted to connect to the service with an invalid account name specified. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - LICENSE_CHECK_FAILED -

-
- - - - -
-
- - - - -

The application is not licensed to the user. This error is not recoverable and will be - treated as fatal. -

- - -
- Constant Value: - - - 11 - (0x0000000b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NETWORK_ERROR -

-
- - - - -
-
- - - - -

A network error occurred. Retrying should resolve the problem. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_REQUIRED -

-
- - - - -
-
- - - - -

Completing the operation requires some form of resolution. A resolution will be available - to be started with startResolutionForResult(Activity, int). If the result - returned is RESULT_OK, then further attempts should either complete or - continue on to the next issue that needs to be resolved. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_DISABLED -

-
- - - - -
-
- - - - -

The installed version of Google Play services has been disabled on this device. The calling - activity should pass this error code to getErrorDialog(int, Activity, int) to get - a localized error dialog that will resolve the error when shown. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_INVALID -

-
- - - - -
-
- - - - -

The version of the Google Play services installed on this device is not authentic.

- - -
- Constant Value: - - - 9 - (0x00000009) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_MISSING -

-
- - - - -
-
- - - - -

Google Play services is missing on this device. The calling activity should pass this error - code to getErrorDialog(int, Activity, int) to get a localized error dialog that - will resolve the error when shown. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SERVICE_VERSION_UPDATE_REQUIRED -

-
- - - - -
-
- - - - -

The installed version of Google Play services is out of date. The calling activity should - pass this error code to getErrorDialog(int, Activity, int) to get a localized - error dialog that will resolve the error when shown. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIGN_IN_REQUIRED -

-
- - - - -
-
- - - - -

The client attempted to connect to the service but the user is not signed in. The client may - choose to continue without using the API or it may call - startResolutionForResult(Activity, int) to prompt the user to sign in. After the sign in - activity returns with RESULT_OK further attempts to connect should succeed. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

The operation was successful.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS_CACHE -

-
- - - - -
-
- - - - -

The operation was successful, but was used the device's cache. If this is a write, the data - will be written when the device is online; errors will be written to the logs. If this is a - read, the data was read from a device cache and may be stale. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIMEOUT -

-
- - - - -
-
- - - - -

Timed out while awaiting the result. -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CommonStatusCodes - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • untranslated debug (not user-friendly!) string based on the current status code. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.Builder.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.Builder.html deleted file mode 100644 index a9055600150f..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.Builder.html +++ /dev/null @@ -1,2496 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

GoogleApiClient.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.GoogleApiClient.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to configure a GoogleApiClient. -

- Example: - 

- GoogleApiClient client = new GoogleApiClient.Builder(this)
-         .addApi(Plus.API)
-         .addScope(Plus.SCOPE_PLUS_LOGIN)
-         .setAccountName("users.account.name@gmail.com")
-         .build();
- client.connect();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GoogleApiClient.Builder(Context context) - -
- Builder to help construct the GoogleApiClient object. - - - -
- -
- - - - - - - - GoogleApiClient.Builder(Context context, GoogleApiClient.ConnectionCallbacks connectedListener, GoogleApiClient.OnConnectionFailedListener connectionFailedListener) - -
- Builder to help construct the GoogleApiClient object. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - <O extends Api.ApiOptions.HasOptions> - GoogleApiClient.Builder - - addApi(Api<O> api, O options) - -
- Specify which Apis are requested by your app. - - - -
- -
- - - - - - GoogleApiClient.Builder - - addApi(Api<? extends Api.ApiOptions.NotRequiredOptions> api) - -
- Specify which Apis are requested by your app. - - - -
- -
- - - - - <O extends Api.ApiOptions.HasOptions> - GoogleApiClient.Builder - - addApiIfAvailable(Api<O> api, O options, Scope... scopes) - -
- Specify which Apis should attempt to connect, but are not strictly required for your app. - - - -
- -
- - - - - - GoogleApiClient.Builder - - addApiIfAvailable(Api<? extends Api.ApiOptions.NotRequiredOptions> api, Scope... scopes) - -
- Specify which Apis should attempt to connect, but are not strictly required for your app. - - - -
- -
- - - - - - GoogleApiClient.Builder - - addConnectionCallbacks(GoogleApiClient.ConnectionCallbacks listener) - -
- Registers a listener to receive connection events from this GoogleApiClient. - - - -
- -
- - - - - - GoogleApiClient.Builder - - addOnConnectionFailedListener(GoogleApiClient.OnConnectionFailedListener listener) - -
- Adds a listener to register to receive connection failed events from this - GoogleApiClient. - - - -
- -
- - - - - - GoogleApiClient.Builder - - addScope(Scope scope) - -
- Specify the OAuth 2.0 scopes requested by your app. - - - -
- -
- - - - - - GoogleApiClient - - build() - -
- Builds a new GoogleApiClient object for communicating with the Google - APIs. - - - -
- -
- - - - - - GoogleApiClient.Builder - - enableAutoManage(FragmentActivity fragmentActivity, int clientId, GoogleApiClient.OnConnectionFailedListener unresolvedConnectionFailedListener) - -
- Enables automatic lifecycle management in a support library FragmentActivity that - connects the client in onStart() and disconnects it in onStop(). - - - -
- -
- - - - - - GoogleApiClient.Builder - - requestServerAuthCode(String serverClientId, GoogleApiClient.ServerAuthCodeCallbacks callbacks) - -
- Specifies requesting of a server auth code for third party web server as part of - client connect() flow. - - - -
- -
- - - - - - GoogleApiClient.Builder - - setAccountName(String accountName) - -
- Specify an account name on the device that should be used. - - - -
- -
- - - - - - GoogleApiClient.Builder - - setGravityForPopups(int gravityForPopups) - -
- Specifies the part of the screen at which games service popups (for example, "welcome - back" or "achievement unlocked" popups) will be displayed using gravity. - - - -
- -
- - - - - - GoogleApiClient.Builder - - setHandler(Handler handler) - -
- Sets a Handler to indicate which thread to use when invoking callbacks. - - - -
- -
- - - - - - GoogleApiClient.Builder - - setViewForPopups(View viewForPopups) - -
- Sets the View to use as a content view for popups. - - - -
- -
- - - - - - GoogleApiClient.Builder - - useDefaultAccount() - -
- Specify that the default account should be used when connecting to services. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GoogleApiClient.Builder - (Context context) -

-
-
- - - -
-
- - - - -

Builder to help construct the GoogleApiClient object.

-
-
Parameters
- - - - -
context - The context to use for the connection. -
-
- -
-
- - - - -
-

- - public - - - - - - - GoogleApiClient.Builder - (Context context, GoogleApiClient.ConnectionCallbacks connectedListener, GoogleApiClient.OnConnectionFailedListener connectionFailedListener) -

-
-
- - - -
-
- - - - -

Builder to help construct the GoogleApiClient object.

-
-
Parameters
- - - - - - - - - - -
context - The context to use for the connection.
connectedListener - The listener where the results of the asynchronous - connect() call are delivered.
connectionFailedListener - The listener which will be notified if the connection - attempt fails. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addApi - (Api<O> api, O options) -

-
-
- - - -
-
- - - - -

Specify which Apis are requested by your app. See Api for more information.

-
-
Parameters
- - - - - - - -
api - The Api requested by your app.
options - Any additional parameters required for the specific AP
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addApi - (Api<? extends Api.ApiOptions.NotRequiredOptions> api) -

-
-
- - - -
-
- - - - -

Specify which Apis are requested by your app. See Api for more information.

-
-
Parameters
- - - - -
api - The Api requested by your app.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addApiIfAvailable - (Api<O> api, O options, Scope... scopes) -

-
-
- - - -
-
- - - - -

Specify which Apis should attempt to connect, but are not strictly required for your app. - The GoogleApiClient will try to connect to these Apis, but will not necessarily fail if - there are only errors when connecting to an unavailable Api added with this method. - See Api for more information.

-
-
Parameters
- - - - - - - -
api - The Api requested by your app.
scopes - Scopes required by this API.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addApiIfAvailable - (Api<? extends Api.ApiOptions.NotRequiredOptions> api, Scope... scopes) -

-
-
- - - -
-
- - - - -

Specify which Apis should attempt to connect, but are not strictly required for your app. - The GoogleApiClient will try to connect to these Apis, but will not necessarily fail if - there are only errors when connecting to an unavailable Api added with this method. - See Api for more information.

-
-
Parameters
- - - - - - - -
api - The Api requested by your app.
scopes - Scopes required by this API.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addConnectionCallbacks - (GoogleApiClient.ConnectionCallbacks listener) -

-
-
- - - -
-
- - - - -

Registers a listener to receive connection events from this GoogleApiClient. - Applications should balance calls to this method with calls to - unregisterConnectionCallbacks(ConnectionCallbacks) to avoid leaking resources. -

- If the specified listener is already registered to receive connection events, this - method will not add a duplicate entry for the same listener. -

- Note that the order of messages received here may not be stable, so clients should not - rely on the order that multiple listeners receive events in.

-
-
Parameters
- - - - -
listener - the listener where the results of the asynchronous connect() call - are delivered. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addOnConnectionFailedListener - (GoogleApiClient.OnConnectionFailedListener listener) -

-
-
- - - -
-
- - - - -

Adds a listener to register to receive connection failed events from this - GoogleApiClient. Applications should balance calls to this method with calls to - unregisterConnectionFailedListener(OnConnectionFailedListener) to avoid leaking - resources. -

- If the specified listener is already registered to receive connection failed events, this - method will not add a duplicate entry for the same listener. -

- Note that the order of messages received here may not be stable, so clients should not - rely on the order that multiple listeners receive events in.

-
-
Parameters
- - - - -
listener - the listener where the results of the asynchronous connect() call - are delivered. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - addScope - (Scope scope) -

-
-
- - - -
-
- - - - -

Specify the OAuth 2.0 scopes requested by your app. See Scopes for more - information.

-
-
Parameters
- - - - -
scope - The OAuth 2.0 scopes requested by your app.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient - - build - () -

-
-
- - - -
-
- - - - -

Builds a new GoogleApiClient object for communicating with the Google - APIs.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - enableAutoManage - (FragmentActivity fragmentActivity, int clientId, GoogleApiClient.OnConnectionFailedListener unresolvedConnectionFailedListener) -

-
-
- - - -
-
- - - - -

Enables automatic lifecycle management in a support library FragmentActivity that - connects the client in onStart() and disconnects it in onStop(). -

- It handles user recoverable errors appropriately and calls if the ConnectionResult has no resolution. - This eliminates most of the boiler plate associated with using GoogleApiClient. -

- When using this option, build() must be called from the main thread.

-
-
Parameters
- - - - - - - - - - -
fragmentActivity - The activity that uses the GoogleApiClient. For lifecycle management to - work correctly the activity must call its parent's onActivityResult(int, int, android.content.Intent).
clientId - A non-negative identifier for this client. At any given time, only one - auto-managed client is allowed per id. To reuse an id you must first call stopAutoManage(FragmentActivity) on the previous client.
unresolvedConnectionFailedListener - Called if the connection failed and there was no resolution or the user chose - not to complete the provided resolution. If this listener is called, the client - will no longer be auto-managed, and a new instance must be built. In the event - that the user chooses not to complete a resolution, the ConnectionResult - will have a status code of CANCELED.
-
-
-
Throws
- - - - - - - - - - -
NullPointerException - if fragmentActivity is null
IllegalArgumentException - if clientId is negative.
IllegalStateException - if clientId is already being auto-managed. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - requestServerAuthCode - (String serverClientId, GoogleApiClient.ServerAuthCodeCallbacks callbacks) -

-
-
- - - -
-
- - - - -

Specifies requesting of a server auth code for third party web server as part of - client connect() flow. This is useful for applications which have a web server component - that need to access a Google API after the user has left the (Android) application. -

- If server auth code is requested, you will be given the server auth code in - onUploadServerAuthCode(String, String) callback.

-
-
Parameters
- - - - - - - -
serverClientId - the 3rd party server client ID for offline access.
callbacks - the GoogleApiClient.ServerAuthCodeCallbacks delegate which will be called back - when communicating back to 3rd party web server is needed. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - setAccountName - (String accountName) -

-
-
- - - -
-
- - - - -

Specify an account name on the device that should be used. If this is never called, the - client will use the current default account for Google Play services for this - application.

-
-
Parameters
- - - - -
accountName - The account name on the device that should be used by - GoogleApiClient. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - setGravityForPopups - (int gravityForPopups) -

-
-
- - - -
-
- - - - -

Specifies the part of the screen at which games service popups (for example, "welcome - back" or "achievement unlocked" popups) will be displayed using gravity. -

- Default value is TOP|CENTER_HORIZONTAL.

-
-
Parameters
- - - - -
gravityForPopups - The gravity which controls the placement of games service popups. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - setHandler - (Handler handler) -

-
-
- - - -
-
- - - - -

Sets a Handler to indicate which thread to use when invoking callbacks. Will not - be used directly to handle callbacks. If this is not called then the application's main - thread will be used. -

- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - setViewForPopups - (View viewForPopups) -

-
-
- - - -
-
- - - - -

Sets the View to use as a content view for popups.

-
-
Parameters
- - - - -
viewForPopups - The view to use as a content view for popups. View cannot be null. -
-
- -
-
- - - - -
-

- - public - - - - - GoogleApiClient.Builder - - useDefaultAccount - () -

-
-
- - - -
-
- - - - -

Specify that the default account should be used when connecting to services. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ConnectionCallbacks.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ConnectionCallbacks.html deleted file mode 100644 index 3f89ffe57c57..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ConnectionCallbacks.html +++ /dev/null @@ -1,1276 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient.ConnectionCallbacks | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleApiClient.ConnectionCallbacks

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.GoogleApiClient.ConnectionCallbacks
- - - - - - - -
- - -

Class Overview

-

Provides callbacks that are called when the client is connected or disconnected from the - service. Most applications implement - onConnected(Bundle) to start making - requests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCAUSE_NETWORK_LOST - A suspension cause informing you that a peer device connection was lost. - - - -
intCAUSE_SERVICE_DISCONNECTED - A suspension cause informing that the service has been killed. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onConnected(Bundle connectionHint) - -
- After calling connect(), this method will be invoked - asynchronously when the connect request has successfully completed. - - - -
- -
- abstract - - - - - void - - onConnectionSuspended(int cause) - -
- Called when the client is temporarily in a disconnected state. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CAUSE_NETWORK_LOST -

-
- - - - -
-
- - - - -

A suspension cause informing you that a peer device connection was lost. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CAUSE_SERVICE_DISCONNECTED -

-
- - - - -
-
- - - - -

A suspension cause informing that the service has been killed. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onConnected - (Bundle connectionHint) -

-
-
- - - -
-
- - - - -

After calling connect(), this method will be invoked - asynchronously when the connect request has successfully completed. After this callback, - the application can make requests on other methods provided by the client and expect that - no user intervention is required to call methods that use account and scopes provided to - the client constructor. -

- Note that the contents of the connectionHint Bundle are defined by the specific - services. Please see the documentation of the specific implementation of - GoogleApiClient you are using for more information.

-
-
Parameters
- - - - -
connectionHint - Bundle of data provided to clients by Google Play services. May be - null if no content is provided by the service. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onConnectionSuspended - (int cause) -

-
-
- - - -
-
- - - - -

Called when the client is temporarily in a disconnected state. This can happen if there - is a problem with the remote service (e.g. a crash or resource problem causes it to be - killed by the system). When called, all requests have been canceled and no outstanding - listeners will be executed. GoogleApiClient will automatically attempt to restore the - connection. Applications should disable UI components that require the service, and wait - for a call to onConnected(Bundle) to re-enable them.

-
-
Parameters
- - - - -
cause - The reason for the disconnection. Defined by constants CAUSE_*. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.OnConnectionFailedListener.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.OnConnectionFailedListener.html deleted file mode 100644 index 5cf86e94f726..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.OnConnectionFailedListener.html +++ /dev/null @@ -1,1078 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient.OnConnectionFailedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleApiClient.OnConnectionFailedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener
- - - - - - - -
- - -

Class Overview

-

Provides callbacks for scenarios that result in a failed attempt to - connect the client to the service. See ConnectionResult - for a list of error codes and suggestions for resolution. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onConnectionFailed(ConnectionResult result) - -
- Called when there was an error connecting the client to the service. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onConnectionFailed - (ConnectionResult result) -

-
-
- - - -
-
- - - - -

Called when there was an error connecting the client to the service.

-
-
Parameters
- - - - -
result - A ConnectionResult that can be used for resolving the - error, and deciding what sort of error occurred. To resolve the error, - the resolution must be started from an activity - with a non-negative requestCode passed to - startResolutionForResult(Activity, int). - Applications should implement onActivityResult in their Activity to - call connect() again if the user has - resolved the issue (resultCode is RESULT_OK). -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.CheckResult.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.CheckResult.html deleted file mode 100644 index 92ccba5f85c4..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.CheckResult.html +++ /dev/null @@ -1,1403 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient.ServerAuthCodeCallbacks.CheckResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

GoogleApiClient.ServerAuthCodeCallbacks.CheckResult

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.GoogleApiClient.ServerAuthCodeCallbacks.CheckResult
- - - - - - - -
- - -

Class Overview

-

The result holder for onCheckServerAuthorization(String, Set) which contains below information: -

    -
  • Whether the server needs a server auth code to exchange for a refresh token. -
  • What scopes the server requires if it needs a new refresh token. -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - newAuthNotRequiredResult() - -
- Creates a CheckResult object indicating no further auth is needed, i.e. - - - -
- -
- - - - static - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - newAuthRequiredResult(Set<Scope> requiredScopes) - -
- Creates a CheckResult object indicating further auth is needed, i.e. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - newAuthNotRequiredResult - () -

-
-
- - - -
-
- - - - -

Creates a CheckResult object indicating no further auth is needed, i.e. server - doesn't need a (new) auth code to exchange for a (new) refresh token.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - newAuthRequiredResult - (Set<Scope> requiredScopes) -

-
-
- - - -
-
- - - - -

Creates a CheckResult object indicating further auth is needed, i.e. server needs - a (new) auth code to exchange for a (new) refresh token.

-
-
Parameters
- - - - -
requiredScopes - the scope set which server requires for offline access.
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if a null or empty set is passed in for the - requiredScopes parameter
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.html deleted file mode 100644 index 3b5a5669ddd7..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.html +++ /dev/null @@ -1,1214 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient.ServerAuthCodeCallbacks | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleApiClient.ServerAuthCodeCallbacks

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.GoogleApiClient.ServerAuthCodeCallbacks
- - - - - - - -
- - -

Class Overview

-

Provides callbacks to facilitate the server auth code retrieval and eliminates clients from - manipulating background threads to do network communications with their own server. -

- Server auth code retrieving flow will look like below: -

    -
  1. If client knows they have a server counterpart that needs offline access, - requestServerAuthCode(String, GoogleApiClient.ServerAuthCodeCallbacks) should be invoked. -
  2. If offline access is requested, onCheckServerAuthorization(String, Set) callback will allow - client to check their server whether it already has a refresh token so that server - auth code retrieval can be skipped. -
  3. If server auth code retrieval is necessary, framework will ask for it from auth - backend. -
  4. A consent will be shown to user to acknowledge granting offline access. -
  5. A server auth code will be returned from auth backend if user consents. -
  6. onUploadServerAuthCode(String, String) callback will allow client to send the auth code to - their own server. -
-

- Framework will invoke the callbacks on a background thread. It's NOT necessary to spawn - background thread on your own for the network communication. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGoogleApiClient.ServerAuthCodeCallbacks.CheckResult - The result holder for onCheckServerAuthorization(String, Set) which contains below information: -
    -
  • Whether the server needs a server auth code to exchange for a refresh token.  - - - -
- - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - onCheckServerAuthorization(String idToken, Set<Scope> scopeSet) - -
- Called when client should check with their own web server whether it needs a (new) server - auth code to exchange for a (new) refresh token for the given account. - - - -
- -
- abstract - - - - - boolean - - onUploadServerAuthCode(String idToken, String serverAuthCode) - -
- Called when server auth code has been fetched and client should upload it to their own - server. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - - onCheckServerAuthorization - (String idToken, Set<Scope> scopeSet) -

-
-
- - - -
-
- - - - -

Called when client should check with their own web server whether it needs a (new) server - auth code to exchange for a (new) refresh token for the given account. -

- This callback happens on a background thread and it's OK to do network communication in - this callback.

-
-
Parameters
- - - - - - - -
idToken - id token for the specific account.
scopeSet - an unmodifiable scope set which client side is planning to request access - with. If only your server does data access or your client side doesn't - user GoogleApiClient to do Google API access, then this scope set - will be empty. If your server / client have distinct functionality or - your server can figure out their required scopes without knowing what - your side is doing, then you can ignore this input as well.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - onUploadServerAuthCode - (String idToken, String serverAuthCode) -

-
-
- - - -
-
- - - - -

Called when server auth code has been fetched and client should upload it to their own - server. -

- This callback happens on a background thread and it's OK to do network communication in - this callback.

-
-
Parameters
- - - - - - - -
idToken - id token for the specific account.
serverAuthCode - the server auth code to be uploaded to the 3rd party web server.
-
-
-
Returns
-
  • Whether 3rd party web server successfully exchanged for a refresh token. Note - that returning false will fail the connect(). If client wants to - ignore their server auth code exchange failure, they should always return true. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.html b/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.html deleted file mode 100644 index eff823cb8cdc..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/GoogleApiClient.html +++ /dev/null @@ -1,2427 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleApiClient | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

GoogleApiClient

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.GoogleApiClient
- - - - - - - -
- - -

Class Overview

-

The main entry point for Google Play services integration. -

- GoogleApiClient is used with a variety of static methods. Some of these methods - require that GoogleApiClient be connected, some will queue up calls before - GoogleApiClient is connected; check the specific API documentation to determine - whether you need to be connected. -

- Before any operation is executed, the GoogleApiClient must be connected using the - connect() method. The client is not considered connected until the - onConnected(Bundle) callback has been called. -

- When your app is done using this client, call disconnect(), even if the async result from - connect() has not yet been delivered. -

- You should instantiate a client object in your Activity's onCreate(Bundle) method and - then call connect() in onStart() and disconnect() in - onStop(), regardless of the state. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGoogleApiClient.Builder - Builder to configure a GoogleApiClient.  - - - -
- - - - - interfaceGoogleApiClient.ConnectionCallbacks - Provides callbacks that are called when the client is connected or disconnected from the - service.  - - - -
- - - - - interfaceGoogleApiClient.OnConnectionFailedListener - Provides callbacks for scenarios that result in a failed attempt to - connect the client to the service.  - - - -
- - - - - interfaceGoogleApiClient.ServerAuthCodeCallbacks - Provides callbacks to facilitate the server auth code retrieval and eliminates clients from - manipulating background threads to do network communications with their own server.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ConnectionResult - - blockingConnect(long timeout, TimeUnit unit) - -
- Connects the client to Google Play services. - - - -
- -
- abstract - - - - - ConnectionResult - - blockingConnect() - -
- Connects the client to Google Play services. - - - -
- -
- abstract - - - - - PendingResult<Status> - - clearDefaultAccountAndReconnect() - -
- Clears the account selected by the user and reconnects the client asking the user to pick an - account again if useDefaultAccount() was set. - - - -
- -
- abstract - - - - - void - - connect() - -
- Connects the client to Google Play services. - - - -
- -
- abstract - - - - - void - - disconnect() - -
- Closes the connection to Google Play services. - - - -
- -
- abstract - - - - - void - - dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) - -
- Prints the GoogleApiClient's state into the given stream. - - - -
- -
- abstract - - - - - ConnectionResult - - getConnectionResult(Api<?> api) - -
- Returns the ConnectionResult for the GoogleApiClient's connection to the - specified API. - - - -
- -
- abstract - - - - - int - - getSessionId() - -
- Returns a unique session id for this GoogleApiClient instance, which should remain the same - even if the current connection state changes. - - - -
- -
- abstract - - - - - boolean - - hasConnectedApi(Api<?> api) - -
- Returns whether or not this GoogleApiClient has the specified API in a connected state. - - - -
- -
- abstract - - - - - boolean - - isConnected() - -
- Checks if the client is currently connected to the service, so that requests to other methods - will succeed. - - - -
- -
- abstract - - - - - boolean - - isConnecting() - -
- Checks if the client is attempting to connect to the service. - - - -
- -
- abstract - - - - - boolean - - isConnectionCallbacksRegistered(GoogleApiClient.ConnectionCallbacks listener) - -
- Returns true if the specified listener is currently registered to - receive connection events. - - - -
- -
- abstract - - - - - boolean - - isConnectionFailedListenerRegistered(GoogleApiClient.OnConnectionFailedListener listener) - -
- Returns true if the specified listener is currently registered to - receive connection failed events. - - - -
- -
- abstract - - - - - void - - reconnect() - -
- Closes the current connection to Google Play services and creates a new connection. - - - -
- -
- abstract - - - - - void - - registerConnectionCallbacks(GoogleApiClient.ConnectionCallbacks listener) - -
- Registers a listener to receive connection events from this GoogleApiClient. - - - -
- -
- abstract - - - - - void - - registerConnectionFailedListener(GoogleApiClient.OnConnectionFailedListener listener) - -
- Registers a listener to receive connection failed events from this - GoogleApiClient. - - - -
- -
- abstract - - - - - void - - stopAutoManage(FragmentActivity lifecycleActivity) - -
- Disconnects the client and stops automatic lifecycle management. - - - -
- -
- abstract - - - - - void - - unregisterConnectionCallbacks(GoogleApiClient.ConnectionCallbacks listener) - -
- Removes a connection listener from this GoogleApiClient. - - - -
- -
- abstract - - - - - void - - unregisterConnectionFailedListener(GoogleApiClient.OnConnectionFailedListener listener) - -
- Removes a connection failed listener from the GoogleApiClient. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ConnectionResult - - blockingConnect - (long timeout, TimeUnit unit) -

-
-
- - - -
-
- - - - -

Connects the client to Google Play services. Blocks until the connection either succeeds or - fails, or the timeout is reached. - -

If the client is already connected, this methods returns immediately. If the client is - already connecting (for example due to a prior call to connect()), this method - blocks until the existing connection attempt completes or the timeout is reached. If a - prior connection attempt has already failed, then a new connection attempt is started.

-
-
Parameters
- - - - - - - -
timeout - the maximum time to wait
unit - the time unit of the timeout argument
-
-
-
Returns
-
  • the result of the connection -
-
- -
-
- - - - -
-

- - public - - - abstract - - ConnectionResult - - blockingConnect - () -

-
-
- - - -
-
- - - - -

Connects the client to Google Play services. Blocks until the connection either succeeds or - fails. This is not allowed on the UI thread. - -

If the client is already connected, this methods returns immediately. If the client is - already connecting (for example due to a prior call to connect()), this method - blocks until the existing connection attempt completes. If a prior connection attempt has - already failed, then a new connection attempt is started.

-
-
Returns
-
  • the result of the connection -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - clearDefaultAccountAndReconnect - () -

-
-
- - - -
-
- - - - -

Clears the account selected by the user and reconnects the client asking the user to pick an - account again if useDefaultAccount() was set.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - connect - () -

-
-
- - - -
-
- - - - -

Connects the client to Google Play services. This method returns immediately, and connects to - the service in the background. If the connection is successful, - onConnected(Bundle) is called and enqueued items are executed. On a - failure, onConnectionFailed(ConnectionResult) is called. - -

If the client is already connected or connecting, this method does nothing. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - disconnect - () -

-
-
- - - -
-
- - - - -

Closes the connection to Google Play services. No calls can be made using this client after - calling this method. Any method calls that haven't executed yet will be canceled. - That is onResult(Result) won't be called, if connection to the service - hasn't been established yet all calls already made will be canceled.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - dump - (String prefix, FileDescriptor fd, PrintWriter writer, String[] args) -

-
-
- - - -
-
- - - - -

Prints the GoogleApiClient's state into the given stream.

-
-
Parameters
- - - - - - - - - - - - - -
prefix - Desired prefix to prepend at each line of output.
fd - The raw file descriptor that the dump is being sent to.
writer - The PrintWriter to use for writing the dump.
args - Additional arguments to the dump request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ConnectionResult - - getConnectionResult - (Api<?> api) -

-
-
- - - -
-
- - - - -

Returns the ConnectionResult for the GoogleApiClient's connection to the - specified API. This method must only be called after connect() has - been called and before disconnect() is called. -

- This method may return stale results if the GoogleApiClient is reconnecting due to a lost - network connection. It is guaranteed to return the most recent ConnectionResult from - attempting to connect the given API, but will throw an IllegalStateException if called before - calling connect or after calling disconnect. This method can be used to easily determine why - an API failed to connect if it was not available. To determine whether a given API is - currently connected (without potential stale results) see - hasConnectedApi(Api).

-
-
Parameters
- - - - -
api - The Api to retrieve the ConnectionResult of. Passing an API that was not - registered with the GoogleApiClient results in an IllegalArgumentException. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getSessionId - () -

-
-
- - - -
-
- - - - -

Returns a unique session id for this GoogleApiClient instance, which should remain the same - even if the current connection state changes. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasConnectedApi - (Api<?> api) -

-
-
- - - -
-
- - - - -

Returns whether or not this GoogleApiClient has the specified API in a connected state.

-
-
Parameters
- - - - -
api - The Api to test the connection of. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConnected - () -

-
-
- - - -
-
- - - - -

Checks if the client is currently connected to the service, so that requests to other methods - will succeed. Applications should guard client actions caused by the user with a call to - this method.

-
-
Returns
-
  • true if the client is connected to the service. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConnecting - () -

-
-
- - - -
-
- - - - -

Checks if the client is attempting to connect to the service.

-
-
Returns
-
  • true if the client is attempting to connect to the service. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConnectionCallbacksRegistered - (GoogleApiClient.ConnectionCallbacks listener) -

-
-
- - - -
-
- - - - -

Returns true if the specified listener is currently registered to - receive connection events.

-
-
Parameters
- - - - -
listener - The listener to check for.
-
-
-
Returns
-
  • true if the specified listener is currently registered to receive connection - events.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConnectionFailedListenerRegistered - (GoogleApiClient.OnConnectionFailedListener listener) -

-
-
- - - -
-
- - - - -

Returns true if the specified listener is currently registered to - receive connection failed events.

-
-
Parameters
- - - - -
listener - The listener to check for.
-
-
-
Returns
-
  • true if the specified listener is currently registered to receive connection - failed events.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - reconnect - () -

-
-
- - - -
-
- - - - -

Closes the current connection to Google Play services and creates a new connection. -

- This method closes the current connection then returns immediately and reconnects to the - service in the background. -

- After calling this method, your application will receive - onConnected(Bundle) if the connection is successful, or - onConnectionFailed(ConnectionResult) if the connection failed.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerConnectionCallbacks - (GoogleApiClient.ConnectionCallbacks listener) -

-
-
- - - -
-
- - - - -

Registers a listener to receive connection events from this GoogleApiClient. - If the service is already connected, the listener's onConnected(Bundle) - method will be called immediately. Applications should balance calls to this method with - calls to unregisterConnectionCallbacks(ConnectionCallbacks) to avoid leaking - resources. -

- If the specified listener is already registered to receive connection events, this - method will not add a duplicate entry for the same listener, but will - still call the listener's onConnected(Bundle) method if currently - connected. -

- Note that the order of messages received here may not be stable, so clients should not rely - on the order that multiple listeners receive events in.

-
-
Parameters
- - - - -
listener - the listener where the results of the asynchronous connect() call are - delivered. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerConnectionFailedListener - (GoogleApiClient.OnConnectionFailedListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to receive connection failed events from this - GoogleApiClient. Unlike registerConnectionCallbacks(GoogleApiClient.ConnectionCallbacks), if the service - is not already connected, the listener's - onConnectionFailed(ConnectionResult) method will not be called immediately. - Applications should balance calls to this method with calls to - unregisterConnectionFailedListener(OnConnectionFailedListener) to avoid leaking - resources. -

- If the specified listener is already registered to receive connection failed events, this - method will not add a duplicate entry for the same listener. -

- Note that the order of messages received here may not be stable, so clients should not rely - on the order that multiple listeners receive events in.

-
-
Parameters
- - - - -
listener - the listener where the results of the asynchronous connect() call are - delivered. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - stopAutoManage - (FragmentActivity lifecycleActivity) -

-
-
- - - -
-
- - - - -

Disconnects the client and stops automatic lifecycle management. Use this before creating a - new client (which might be necessary when switching accounts, changing the set of used APIs - etc.). -

- This method must be called from the main thread.

-
-
Parameters
- - - - -
lifecycleActivity - the activity managing the client's lifecycle.
-
-
-
Throws
- - - - -
IllegalStateException - if called from outside of the main thread.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterConnectionCallbacks - (GoogleApiClient.ConnectionCallbacks listener) -

-
-
- - - -
-
- - - - -

Removes a connection listener from this GoogleApiClient. Note that removing - a listener does not generate any callbacks. -

- If the specified listener is not currently registered to receive connection events, this - method will have no effect.

-
-
Parameters
- - - - -
listener - the listener to unregister. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterConnectionFailedListener - (GoogleApiClient.OnConnectionFailedListener listener) -

-
-
- - - -
-
- - - - -

Removes a connection failed listener from the GoogleApiClient. - Note that removing a listener does not generate any callbacks. -

- If the specified listener is not currently registered to receive connection failed events, - this method will have no effect.

-
-
Parameters
- - - - -
listener - the listener to unregister. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/PendingResult.html b/docs/html/reference/com/google/android/gms/common/api/PendingResult.html deleted file mode 100644 index fc117eba933a..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/PendingResult.html +++ /dev/null @@ -1,1429 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PendingResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

PendingResult

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.PendingResult<R extends com.google.android.gms.common.api.Result>
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Represents a pending result from calling an API method in Google Play services. The final result - object from a PendingResult is of type R, which can be retrieved in one of two ways. -

-

- After the result has been retrieved using await() or delivered to the - result callback, it is an error to attempt to retrieve the result again. It is the responsibility - of the caller or callback receiver to release any resources associated with the returned result. - Some result types may implement Releasable, in which case release() - should be used to free the associated resources. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - R - - await() - -
- Blocks until the task is completed. - - - -
- -
- abstract - - - - - R - - await(long time, TimeUnit units) - -
- Blocks until the task is completed or has timed out waiting for the result. - - - -
- -
- abstract - - - - - void - - cancel() - -
- Requests that the PendingResult be canceled. - - - -
- -
- abstract - - - - - boolean - - isCanceled() - -
- Indicates whether the pending result has been canceled either due to calling - disconnect() or calling cancel() directly on the pending result - or an enclosing Batch. - - - -
- -
- abstract - - - - - void - - setResultCallback(ResultCallback<R> callback, long time, TimeUnit units) - -
- Set the callback here if you want the result to be delivered via a callback when the result - is ready or has timed out waiting for the result. - - - -
- -
- abstract - - - - - void - - setResultCallback(ResultCallback<R> callback) - -
- Set the callback here if you want the result to be delivered via a callback when the - result is ready. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - R - - await - () -

-
-
- - - -
-
- - - - -

Blocks until the task is completed. This is not allowed on the UI thread. The returned - result object can have an additional failure mode of INTERRUPTED. -

- -
-
- - - - -
-

- - public - - - abstract - - R - - await - (long time, TimeUnit units) -

-
-
- - - -
-
- - - - -

Blocks until the task is completed or has timed out waiting for the result. This is not - allowed on the UI thread. The returned result object can have an additional failure mode of - either INTERRUPTED or TIMEOUT. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - cancel - () -

-
-
- - - -
-
- - - - -

Requests that the PendingResult be canceled. - If the result is available, but not consumed it will be released. - If the result is set after cancelation was requested it is immediately released. -

- onResult(Result) will never be called, await() will return - a failed result with CANCELED. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isCanceled - () -

-
-
- - - -
-
- - - - -

Indicates whether the pending result has been canceled either due to calling - disconnect() or calling cancel() directly on the pending result - or an enclosing Batch. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - setResultCallback - (ResultCallback<R> callback, long time, TimeUnit units) -

-
-
- - - -
-
- - - - -

Set the callback here if you want the result to be delivered via a callback when the result - is ready or has timed out waiting for the result. The returned result object can have an - additional failure mode of TIMEOUT. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - setResultCallback - (ResultCallback<R> callback) -

-
-
- - - -
-
- - - - -

Set the callback here if you want the result to be delivered via a callback when the - result is ready. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/PendingResults.html b/docs/html/reference/com/google/android/gms/common/api/PendingResults.html deleted file mode 100644 index d9736a02f0f0..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/PendingResults.html +++ /dev/null @@ -1,1500 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PendingResults | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PendingResults

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.PendingResults
- - - - - - - -
- - -

Class Overview

-

Provides factory methods for PendingResult instances, primarily for use in tests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - PendingResult<Status> - - canceledPendingResult() - -
- Returns a PendingResult that has been canceled. - - - -
- -
- - - - static - <R extends Result> - PendingResult<R> - - canceledPendingResult(R result) - -
- Returns a PendingResult that has been canceled. - - - -
- -
- - - - static - - PendingResult<Status> - - immediatePendingResult(Status result) - -
- Returns a PendingResult with the specified Status. - - - -
- -
- - - - static - <R extends Result> - PendingResult<R> - - immediatePendingResult(R result) - -
- Returns a PendingResult with the specified result. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - PendingResult<Status> - - canceledPendingResult - () -

-
-
- - - -
-
- - - - -

Returns a PendingResult that has been canceled. -

- -
-
- - - - -
-

- - public - static - - - - PendingResult<R> - - canceledPendingResult - (R result) -

-
-
- - - -
-
- - - - -

Returns a PendingResult that has been canceled.

-
-
Parameters
- - - - -
result - The canceled result. Must have a status code of - CANCELED. -
-
- -
-
- - - - -
-

- - public - static - - - - PendingResult<Status> - - immediatePendingResult - (Status result) -

-
-
- - - -
-
- - - - -

Returns a PendingResult with the specified Status. - -

If setResultCallback(ResultCallback) is called on the returned PendingResult then - onResult(R) will immediately be called on the main thread. If - await() is called it will immediate return result. -

- -
-
- - - - -
-

- - public - static - - - - PendingResult<R> - - immediatePendingResult - (R result) -

-
-
- - - -
-
- - - - -

Returns a PendingResult with the specified result. - -

If setResultCallback(ResultCallback) is called on the returned PendingResult then - onResult(R) will immediately be called on the main thread. If - await() is called it will immediate return result. - -

Calling cancel() on the returned PendingResult is not supported. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Releasable.html b/docs/html/reference/com/google/android/gms/common/api/Releasable.html deleted file mode 100644 index 0c38bba95b4a..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Releasable.html +++ /dev/null @@ -1,1673 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Releasable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Releasable

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Releasable
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Represents a resource, or a holder of resources, which may be released once they are no longer - needed. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - release() - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - release - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Result.html b/docs/html/reference/com/google/android/gms/common/api/Result.html deleted file mode 100644 index b7d80ca2d9ac..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Result.html +++ /dev/null @@ -1,2006 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Result | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Result

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.Result
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Represents the final result of invoking an API method in Google Play Services. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/ResultCallback.html b/docs/html/reference/com/google/android/gms/common/api/ResultCallback.html deleted file mode 100644 index c0899a0540ee..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/ResultCallback.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ResultCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

ResultCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.api.ResultCallback<R extends com.google.android.gms.common.api.Result>
- - - - - - - -
- - -

Class Overview

-

An interface for receiving a Result from a PendingResult as an asynchronous - callback. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onResult(R result) - -
- Called when the Result is ready. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onResult - (R result) -

-
-
- - - -
-
- - - - -

Called when the Result is ready. - -

It is the responsibility of the callback to release any resources associated with the - result. Some result types may implement Releasable, in which case - release() should be used to free the associated resources. - -

This method is called on the main thread, unless overridden by - {GoogleApiClient.Builder#setHandler}.

-
-
Parameters
- - - - -
result - The result from the API call. May not be null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Scope.html b/docs/html/reference/com/google/android/gms/common/api/Scope.html deleted file mode 100644 index d586d1b9d928..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Scope.html +++ /dev/null @@ -1,1771 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Scope | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Scope

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Scope
- - - - - - - -
- - -

Class Overview

-

Describes an OAuth 2.0 scope to request. This has security implications for the user, and - requesting additional scopes will result in authorization dialogs. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<Scope>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Scope(String scopeUri) - -
- Creates a new scope with the given URI. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<Scope> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Scope - (String scopeUri) -

-
-
- - - -
-
- - - - -

Creates a new scope with the given URI. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/Status.html b/docs/html/reference/com/google/android/gms/common/api/Status.html deleted file mode 100644 index 2ff8b96dc88a..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/Status.html +++ /dev/null @@ -1,2531 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Status | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Status

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.Status
- - - - - - - -
- - -

Class Overview

-

Represents the results of work. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - StatusCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Status(int statusCode) - -
- Creates a representation of the status resulting from a GoogleApiClient operation. - - - -
- -
- - - - - - - - Status(int statusCode, String statusMessage) - -
- Creates a representation of the status resulting from a GoogleApiClient operation. - - - -
- -
- - - - - - - - Status(int statusCode, String statusMessage, PendingIntent pendingIntent) - -
- Creates a representation of the status resulting from a GoogleApiClient operation. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - PendingIntent - - getResolution() - -
- A pending intent to resolve the failure. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - getStatusCode() - -
- Indicates the status of the operation. - - - -
- -
- - - - - - String - - getStatusMessage() - -
- - - - - - boolean - - hasResolution() - -
- Returns true if calling startResolutionForResult(Activity, int) - will start any intents requiring user interaction. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isCanceled() - -
- Returns true if the operation was canceled. - - - -
- -
- - - - - - boolean - - isInterrupted() - -
- Returns true if the operation was interrupted. - - - -
- -
- - - - - - boolean - - isSuccess() - -
- Returns true if the operation was successful. - - - -
- -
- - - - - - void - - startResolutionForResult(Activity activity, int requestCode) - -
- Resolves an error by starting any intents requiring user interaction. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - StatusCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Status - (int statusCode) -

-
-
- - - -
-
- - - - -

Creates a representation of the status resulting from a GoogleApiClient operation.

-
-
Parameters
- - - - -
statusCode - The status code. -
-
- -
-
- - - - -
-

- - public - - - - - - - Status - (int statusCode, String statusMessage) -

-
-
- - - -
-
- - - - -

Creates a representation of the status resulting from a GoogleApiClient operation.

-
-
Parameters
- - - - - - - -
statusCode - The status code.
statusMessage - The message associated with this status, or null. -
-
- -
-
- - - - -
-

- - public - - - - - - - Status - (int statusCode, String statusMessage, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - - -

Creates a representation of the status resulting from a GoogleApiClient operation.

-
-
Parameters
- - - - - - - - - - -
statusCode - The status code.
statusMessage - The message associated with this status, or null.
pendingIntent - A pending intent that will resolve the issue when started, or null. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - PendingIntent - - getResolution - () -

-
-
- - - -
-
- - - - -

A pending intent to resolve the failure. This intent can be started with - startIntentSenderForResult(IntentSender, int, Intent, int, int, int) to - present UI to solve the issue.

-
-
Returns
-
  • The pending intent to resolve the failure. -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - getStatusCode - () -

-
-
- - - -
-
- - - - -

Indicates the status of the operation.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getStatusMessage - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasResolution - () -

-
-
- - - -
-
- - - - -

Returns true if calling startResolutionForResult(Activity, int) - will start any intents requiring user interaction.

-
-
Returns
-
  • true if there is a resolution that can be started. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isCanceled - () -

-
-
- - - -
-
- - - - -

Returns true if the operation was canceled. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isInterrupted - () -

-
-
- - - -
-
- - - - -

Returns true if the operation was interrupted. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isSuccess - () -

-
-
- - - -
-
- - - - -

Returns true if the operation was successful.

-
-
Returns
-
  • true if the operation was successful, false if there was an error. -
-
- -
-
- - - - -
-

- - public - - - - - void - - startResolutionForResult - (Activity activity, int requestCode) -

-
-
- - - -
-
- - - - -

Resolves an error by starting any intents requiring user interaction. - See SIGN_IN_REQUIRED, and RESOLUTION_REQUIRED.

-
-
Parameters
- - - - - - - -
activity - An Activity context to use to resolve the issue. The activity's - onActivityResult method will be invoked after the user is done. If the - resultCode is RESULT_OK, the application should try to - connect again.
requestCode - The request code to pass to onActivityResult.
-
-
-
Throws
- - - - -
IntentSender.SendIntentException - If the resolution intent has been canceled or is - no longer able to execute the request. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/api/package-summary.html b/docs/html/reference/com/google/android/gms/common/api/package-summary.html deleted file mode 100644 index 166b2ef9d06f..000000000000 --- a/docs/html/reference/com/google/android/gms/common/api/package-summary.html +++ /dev/null @@ -1,1155 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.common.api | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.common.api

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Api.ApiOptions - Base interface for API options.  - - - -
Api.ApiOptions.HasOptions - Base interface for Api.ApiOptions in Apis that have options.  - - - -
Api.ApiOptions.NotRequiredOptions - Base interface for Api.ApiOptions that are not required, don't exist.  - - - -
Api.ApiOptions.Optional - Base interface for Api.ApiOptions that are optional.  - - - -
GoogleApiClient - The main entry point for Google Play services integration.  - - - -
GoogleApiClient.ConnectionCallbacks - Provides callbacks that are called when the client is connected or disconnected from the - service.  - - - -
GoogleApiClient.OnConnectionFailedListener - Provides callbacks for scenarios that result in a failed attempt to - connect the client to the service.  - - - -
GoogleApiClient.ServerAuthCodeCallbacks - Provides callbacks to facilitate the server auth code retrieval and eliminates clients from - manipulating background threads to do network communications with their own server.  - - - -
PendingResult<R extends Result> - Represents a pending result from calling an API method in Google Play services.  - - - -
Releasable - Represents a resource, or a holder of resources, which may be released once they are no longer - needed.  - - - -
Result - Represents the final result of invoking an API method in Google Play Services.  - - - -
ResultCallback<R extends Result> - An interface for receiving a Result from a PendingResult as an asynchronous - callback.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Api<O extends Api.ApiOptions> - Describes a section of the Google Play Services API that should be made available.  - - - -
Api.ApiOptions.NoOptions - Api.ApiOptions implementation for Apis that do not take any options.  - - - -
Batch - Handles a batch of PendingResult items.  - - - -
Batch.Builder - Builder for Batch objects.  - - - -
BatchResult - The result of a batch operation.  - - - -
BatchResultToken<R extends Result> - Result token used to retrieve the result of individual operations from a batch.  - - - -
CommonStatusCodes - Common status codes that are often shared across API surfaces.  - - - -
GoogleApiClient.Builder - Builder to configure a GoogleApiClient.  - - - -
GoogleApiClient.ServerAuthCodeCallbacks.CheckResult - The result holder for onCheckServerAuthorization(String, Set) which contains below information: -
    -
  • Whether the server needs a server auth code to exchange for a refresh token.  - - - -
PendingResults - Provides factory methods for PendingResult instances, primarily for use in tests.  - - - -
Scope - Describes an OAuth 2.0 scope to request.  - - - -
Status - Represents the results of work.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/AbstractDataBuffer.html b/docs/html/reference/com/google/android/gms/common/data/AbstractDataBuffer.html deleted file mode 100644 index 2882b97ccc83..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/AbstractDataBuffer.html +++ /dev/null @@ -1,2297 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AbstractDataBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

AbstractDataBuffer

- - - - - extends Object
- - - - - - - implements - - DataBuffer<T> - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<T>
- - - - -
- - Known Direct Subclasses - -
- - -
-
- - - - -
- - -

Class Overview

-

Default implementation of DataBuffer. An AbstractDataBuffer wraps data provided across - the binder from Google Play services. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - void - - close() - -
- - This method is deprecated. - use release() instead - - - - -
- -
- abstract - - - - - T - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - boolean - - isClosed() - -
- - This method is deprecated. - release() is idempotent, and so is safe to call multiple times - - - - -
- -
- - - - - - Iterator<T> - - iterator() - -
- - - - - - void - - release() - -
- Releases resources used by the buffer. - - - -
- -
- - - - - - Iterator<T> - - singleRefIterator() - -
- In order to use this one should correctly override setDataRow(int) - in his DataBufferRef implementation. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - void - - close - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use release() instead - -

-

- -
-
- - - - -
-

- - public - - - abstract - - T - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isClosed - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- release() is idempotent, and so is safe to call multiple times - -

-

- -
-
- - - - -
-

- - public - - - - - Iterator<T> - - iterator - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - release - () -

-
-
- - - -
-
- - - - -

Releases resources used by the buffer. This method is idempotent. -

- -
-
- - - - -
-

- - public - - - - - Iterator<T> - - singleRefIterator - () -

-
-
- - - -
-
- - - - -

In order to use this one should correctly override setDataRow(int) - in his DataBufferRef implementation. - Be careful: there will be single DataBufferRef while iterating. - If you are not sure - DO NOT USE this iterator.

-
-
See Also
-
  • SingleRefDataBufferIterator
    • -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/DataBuffer.html b/docs/html/reference/com/google/android/gms/common/data/DataBuffer.html deleted file mode 100644 index d7ae66c6aa17..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/DataBuffer.html +++ /dev/null @@ -1,1873 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataBuffer

- - - - - - implements - - Iterable<T> - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.data.DataBuffer<T>
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Interface for a buffer of typed data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - close() - -
- - This method is deprecated. - use release() instead - - - - -
- -
- abstract - - - - - T - - get(int position) - -
- Returns an element on specified position. - - - -
- -
- abstract - - - - - int - - getCount() - -
- abstract - - - - - boolean - - isClosed() - -
- - This method is deprecated. - release() is idempotent, and so is safe to call multiple times - - - - -
- -
- abstract - - - - - Iterator<T> - - iterator() - -
- abstract - - - - - void - - release() - -
- Releases resources used by the buffer. - - - -
- -
- abstract - - - - - Iterator<T> - - singleRefIterator() - -
- In order to use this iterator it should be supported by particular DataBuffer. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - close - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use release() instead - -

-

- -
-
- - - - -
-

- - public - - - abstract - - T - - get - (int position) -

-
-
- - - -
-
- - - - -

Returns an element on specified position. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isClosed - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- release() is idempotent, and so is safe to call multiple times - -

-

- -
-
- - - - -
-

- - public - - - abstract - - Iterator<T> - - iterator - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - abstract - - void - - release - () -

-
-
- - - -
-
- - - - -

Releases resources used by the buffer. This method is idempotent. -

- -
-
- - - - -
-

- - public - - - abstract - - Iterator<T> - - singleRefIterator - () -

-
-
- - - -
-
- - - - -

In order to use this iterator it should be supported by particular DataBuffer. - Be careful: there will be single reference while iterating. - If you are not sure - DO NOT USE this iterator. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.Observable.html b/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.Observable.html deleted file mode 100644 index d0b3db6ac24e..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.Observable.html +++ /dev/null @@ -1,1176 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBufferObserver.Observable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DataBufferObserver.Observable

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.data.DataBufferObserver.Observable
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Interface a data buffer can implement to expose the fact that it supports observation. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - addObserver(DataBufferObserver observer) - -
- Register the given observer for receiving change notifications. - - - -
- -
- abstract - - - - - void - - removeObserver(DataBufferObserver observer) - -
- Unregister the given observer from receiving change notifications. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - addObserver - (DataBufferObserver observer) -

-
-
- - - -
-
- - - - -

Register the given observer for receiving change notifications. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - removeObserver - (DataBufferObserver observer) -

-
-
- - - -
-
- - - - -

Unregister the given observer from receiving change notifications. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.html b/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.html deleted file mode 100644 index e6e274b29b35..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserver.html +++ /dev/null @@ -1,1380 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBufferObserver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataBufferObserver

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.data.DataBufferObserver
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

An interface for notifying an observer about changes to a DataBuffer. - - To support adding multiple observers, see DataBufferObserverSet. It allows you to - delegate addObserver and removeObserver to it and it will handle distributing all the - notifications to all registered observers.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDataBufferObserver.Observable - Interface a data buffer can implement to expose the fact that it supports observation.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDataChanged() - -
- Called when the overall data changes. - - - -
- -
- abstract - - - - - void - - onDataRangeChanged(int position, int count) - -
- Called when a range of items changes. - - - -
- -
- abstract - - - - - void - - onDataRangeInserted(int position, int count) - -
- Called when a range of items is inserted. - - - -
- -
- abstract - - - - - void - - onDataRangeMoved(int fromPosition, int toPosition, int count) - -
- Called when a range of items is moved. - - - -
- -
- abstract - - - - - void - - onDataRangeRemoved(int position, int count) - -
- Called when a range of items is removed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDataChanged - () -

-
-
- - - -
-
- - - - -

Called when the overall data changes. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onDataRangeChanged - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items changes. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onDataRangeInserted - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is inserted. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onDataRangeMoved - (int fromPosition, int toPosition, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is moved. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onDataRangeRemoved - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is removed. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserverSet.html b/docs/html/reference/com/google/android/gms/common/data/DataBufferObserverSet.html deleted file mode 100644 index 775d4b3b7da0..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/DataBufferObserverSet.html +++ /dev/null @@ -1,2065 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBufferObserverSet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DataBufferObserverSet

- - - - - extends Object
- - - - - - - implements - - DataBufferObserver - - DataBufferObserver.Observable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.DataBufferObserverSet
- - - - - - - -
- - -

Class Overview

-

Utility class for managing a set of observers and distributing their notifications.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataBufferObserverSet() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - addObserver(DataBufferObserver observer) - -
- Register the given observer for receiving change notifications. - - - -
- -
- - - - - - void - - clear() - -
- Clears the set of observers. - - - -
- -
- - - - - - boolean - - hasObservers() - -
- Returns true if this has any registered observers. - - - -
- -
- - - - - - void - - onDataChanged() - -
- Called when the overall data changes. - - - -
- -
- - - - - - void - - onDataRangeChanged(int position, int count) - -
- Called when a range of items changes. - - - -
- -
- - - - - - void - - onDataRangeInserted(int position, int count) - -
- Called when a range of items is inserted. - - - -
- -
- - - - - - void - - onDataRangeMoved(int fromPosition, int toPosition, int count) - -
- Called when a range of items is moved. - - - -
- -
- - - - - - void - - onDataRangeRemoved(int position, int count) - -
- Called when a range of items is removed. - - - -
- -
- - - - - - void - - removeObserver(DataBufferObserver observer) - -
- Unregister the given observer from receiving change notifications. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBufferObserver - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBufferObserver.Observable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataBufferObserverSet - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - addObserver - (DataBufferObserver observer) -

-
-
- - - -
-
- - - - -

Register the given observer for receiving change notifications. -

- -
-
- - - - -
-

- - public - - - - - void - - clear - () -

-
-
- - - -
-
- - - - -

Clears the set of observers. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasObservers - () -

-
-
- - - -
-
- - - - -

Returns true if this has any registered observers. -

- -
-
- - - - -
-

- - public - - - - - void - - onDataChanged - () -

-
-
- - - -
-
- - - - -

Called when the overall data changes. -

- -
-
- - - - -
-

- - public - - - - - void - - onDataRangeChanged - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items changes. -

- -
-
- - - - -
-

- - public - - - - - void - - onDataRangeInserted - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is inserted. -

- -
-
- - - - -
-

- - public - - - - - void - - onDataRangeMoved - (int fromPosition, int toPosition, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is moved. -

- -
-
- - - - -
-

- - public - - - - - void - - onDataRangeRemoved - (int position, int count) -

-
-
- - - -
-
- - - - -

Called when a range of items is removed. -

- -
-
- - - - -
-

- - public - - - - - void - - removeObserver - (DataBufferObserver observer) -

-
-
- - - -
-
- - - - -

Unregister the given observer from receiving change notifications. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/DataBufferUtils.html b/docs/html/reference/com/google/android/gms/common/data/DataBufferUtils.html deleted file mode 100644 index c802e3e6c0ac..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/DataBufferUtils.html +++ /dev/null @@ -1,1515 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBufferUtils | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DataBufferUtils

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.DataBufferUtils
- - - - - - - -
- - -

Class Overview

-

Utilities for working with DataBuffer objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - <T, E extends Freezable<T>> - ArrayList<T> - - freezeAndClose(DataBuffer<E> buffer) - -
- Utility helper method to freeze a DataBuffer into a list of concrete entities. - - - -
- -
- - - - static - - boolean - - hasData(DataBuffer<?> buffer) - -
- Utility function to determine whether a data buffer has data or not. - - - -
- -
- - - - static - - boolean - - hasNextPage(DataBuffer<?> buffer) - -
- Utility function to get the "next page" pagination token from a data buffer. - - - -
- -
- - - - static - - boolean - - hasPrevPage(DataBuffer<?> buffer) - -
- Utility function to get the "prev page" pagination token from a data buffer. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ArrayList<T> - - freezeAndClose - (DataBuffer<E> buffer) -

-
-
- - - -
-
- - - - -

Utility helper method to freeze a DataBuffer into a list of concrete entities. The DataBuffer - provided here must contain elements that implement the Freezable interface. -

- Note that this will close the buffer, so do not attempt to use it afterwards. -

- Type T is the type of object returned by freezing an element of the DataBuffer. In most - cases, this will be the same as E. - -

- Type E is the type of object contained by the DataBuffer. Must implement Freezable.

-
-
Parameters
- - - - -
buffer - DataBuffer to freeze contents from.
-
-
-
Returns
-
  • ArrayList of objects represented by the buffer. -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - hasData - (DataBuffer<?> buffer) -

-
-
- - - -
-
- - - - -

Utility function to determine whether a data buffer has data or not.

-
-
Parameters
- - - - -
buffer - The data buffer to check.
-
-
-
Returns
-
  • Whether the data buffer has data or not. -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - hasNextPage - (DataBuffer<?> buffer) -

-
-
- - - -
-
- - - - -

Utility function to get the "next page" pagination token from a data buffer. -

- -
-
- - - - -
-

- - public - static - - - - boolean - - hasPrevPage - (DataBuffer<?> buffer) -

-
-
- - - -
-
- - - - -

Utility function to get the "prev page" pagination token from a data buffer. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/Freezable.html b/docs/html/reference/com/google/android/gms/common/data/Freezable.html deleted file mode 100644 index d244b701e816..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/Freezable.html +++ /dev/null @@ -1,1783 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Freezable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Freezable

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.data.Freezable<T>
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Interface for data objects that support being frozen into immutable representations. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - T - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- abstract - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - T - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/FreezableUtils.html b/docs/html/reference/com/google/android/gms/common/data/FreezableUtils.html deleted file mode 100644 index e395261605c5..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/FreezableUtils.html +++ /dev/null @@ -1,1554 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FreezableUtils | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

FreezableUtils

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.FreezableUtils
- - - - - - - -
- - -

Class Overview

-

Utilities for working with Freezable objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - FreezableUtils() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - <T, E extends Freezable<T>> - ArrayList<T> - - freeze(E[] array) - -
- Utility helper method to freeze an array of freezable entities into a list of concrete - entities. - - - -
- -
- - - - static - <T, E extends Freezable<T>> - ArrayList<T> - - freeze(ArrayList<E> list) - -
- Utility helper method to freeze a list of freezable entities into a list of concrete - entities. - - - -
- -
- - - - static - <T, E extends Freezable<T>> - ArrayList<T> - - freezeIterable(Iterable<E> iterable) - -
- Utility helper method to freeze an array of freezable entities into a list of concrete - entities. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - FreezableUtils - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ArrayList<T> - - freeze - (E[] array) -

-
-
- - - -
-
- - - - -

Utility helper method to freeze an array of freezable entities into a list of concrete - entities. The array provided here must contain elements that implement the Freezable - interface. -

- Type T is the type of object returned by freezing an element of the array. In most cases, - this will be the same as E. -

- Type E is the type of object contained in the array. Must implement Freezable.

-
-
Parameters
- - - - -
array - Array to freeze contents from.
-
-
-
Returns
-
  • ArrayList of frozen representations of the object present in the provided array. -
-
- -
-
- - - - -
-

- - public - static - - - - ArrayList<T> - - freeze - (ArrayList<E> list) -

-
-
- - - -
-
- - - - -

Utility helper method to freeze a list of freezable entities into a list of concrete - entities. The list provided here must contain elements that implement the Freezable - interface. -

- Type T is the type of object returned by freezing an element of the list. In most cases, - this will be the same as E. -

- Type E is the type of object contained in the list. Must implement Freezable.

-
-
Parameters
- - - - -
list - ArrayList to freeze contents from.
-
-
-
Returns
-
  • ArrayList of frozen representations of the object present in the provided list. -
-
- -
-
- - - - -
-

- - public - static - - - - ArrayList<T> - - freezeIterable - (Iterable<E> iterable) -

-
-
- - - -
-
- - - - -

Utility helper method to freeze an array of freezable entities into a list of concrete - entities. The array provided here must contain elements that implement the Freezable - interface. -

- Type T is the type of object returned by freezing an element of the array. In most cases, - this will be the same as E. -

- Type E is the type of object contained in the array. Must implement Freezable.

-
-
Parameters
- - - - -
iterable - Iterable to freeze contents from.
-
-
-
Returns
-
  • ArrayList of frozen representations of the object present in the provided array. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/data/package-summary.html b/docs/html/reference/com/google/android/gms/common/data/package-summary.html deleted file mode 100644 index eaf375485f24..000000000000 --- a/docs/html/reference/com/google/android/gms/common/data/package-summary.html +++ /dev/null @@ -1,977 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.common.data | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.common.data

-
- -
- -
- - -
- Contains classes for accessing data from Google Play services. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DataBuffer<T> - Interface for a buffer of typed data.  - - - -
DataBufferObserver - An interface for notifying an observer about changes to a DataBuffer.  - - - -
DataBufferObserver.Observable - Interface a data buffer can implement to expose the fact that it supports observation.  - - - -
Freezable<T> - Interface for data objects that support being frozen into immutable representations.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AbstractDataBuffer<T> - Default implementation of DataBuffer.  - - - -
DataBufferObserverSet - Utility class for managing a set of observers and distributing their notifications.  - - - -
DataBufferUtils - Utilities for working with DataBuffer objects.  - - - -
FreezableUtils - Utilities for working with Freezable objects.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/images/ImageManager.OnImageLoadedListener.html b/docs/html/reference/com/google/android/gms/common/images/ImageManager.OnImageLoadedListener.html deleted file mode 100644 index a3a8ab877eea..000000000000 --- a/docs/html/reference/com/google/android/gms/common/images/ImageManager.OnImageLoadedListener.html +++ /dev/null @@ -1,1078 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ImageManager.OnImageLoadedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

ImageManager.OnImageLoadedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.common.images.ImageManager.OnImageLoadedListener
- - - - - - - -
- - -

Class Overview

-

Listener interface for handling when the image for a particular URI has been loaded. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onImageLoaded(Uri uri, Drawable drawable, boolean isRequestedDrawable) - -
- Listener method invoked when an image has been loaded. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onImageLoaded - (Uri uri, Drawable drawable, boolean isRequestedDrawable) -

-
-
- - - -
-
- - - - -

Listener method invoked when an image has been loaded.

-
-
Parameters
- - - - - - - - - - -
uri - The URI of the requested image.
drawable - Drawable containing the image.
isRequestedDrawable - True if this drawable was loaded from the provided URI, - or false if this drawable is a placeholder image instead. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/images/ImageManager.html b/docs/html/reference/com/google/android/gms/common/images/ImageManager.html deleted file mode 100644 index 901c08d5029a..000000000000 --- a/docs/html/reference/com/google/android/gms/common/images/ImageManager.html +++ /dev/null @@ -1,1749 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ImageManager | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ImageManager

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.images.ImageManager
- - - - - - - -
- - -

Class Overview

-

This class is used to load images from the network and handles local caching for you. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceImageManager.OnImageLoadedListener - Listener interface for handling when the image for a particular URI has been loaded.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - ImageManager - - create(Context context) - -
- Returns a new ImageManager for loading images from the network. - - - -
- -
- - - - - - void - - loadImage(ImageView imageView, Uri uri) - -
- Loads an image to display from a URI. - - - -
- -
- - - - - - void - - loadImage(ImageView imageView, int resId) - -
- Loads an image to display from the given resource ID. - - - -
- -
- - - - - - void - - loadImage(ImageManager.OnImageLoadedListener listener, Uri uri, int defaultResId) - -
- Load an image to display from a URI, using the given resource ID as the default if no image - is found for the given URI. - - - -
- -
- - - - - - void - - loadImage(ImageManager.OnImageLoadedListener listener, Uri uri) - -
- Load an image to display from a URI. - - - -
- -
- - - - - - void - - loadImage(ImageView imageView, Uri uri, int defaultResId) - -
- Loads an image to display from a URI, using the given resource ID as the default if no image - is found for the given URI. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ImageManager - - create - (Context context) -

-
-
- - - -
-
- - - - -

Returns a new ImageManager for loading images from the network.

-
-
Parameters
- - - - -
context - The context used by the ImageManager.
-
-
-
Returns
-
  • A new ImageManager. -
-
- -
-
- - - - -
-

- - public - - - - - void - - loadImage - (ImageView imageView, Uri uri) -

-
-
- - - -
-
- - - - -

Loads an image to display from a URI. Note that this does not support arbitrary URIs - the - URI must be something that was retrieved from another call to Google Play services. -

- The image view will be cleared out (the drawable set to null) if the image needs to be loaded - asynchronously. -

- The result (if non-null) is set on the given image view on the main thread. -

- Note that if the ImageView used for this call is hosted in a ListAdapter (or any - other class that recycles ImageView instances), then ALL calls to set the contents of - that ImageView must be done via one of the calls on this ImageManager.

-
-
Parameters
- - - - - - - -
imageView - The image view to populate with the image.
uri - URI to load the image data from. -
-
- -
-
- - - - -
-

- - public - - - - - void - - loadImage - (ImageView imageView, int resId) -

-
-
- - - -
-
- - - - -

Loads an image to display from the given resource ID. -

- If you also use ImageManagers for Views hosted in a ListAdapter (or any - other class that recycles Views instances), then this call should be used rather than - setting the resource directly. This avoids clobbering images when views are recycled.

-
-
Parameters
- - - - - - - -
imageView - The image view to populate with the image.
resId - Resource ID to use for the image. -
-
- -
-
- - - - -
-

- - public - - - - - void - - loadImage - (ImageManager.OnImageLoadedListener listener, Uri uri, int defaultResId) -

-
-
- - - -
-
- - - - -

Load an image to display from a URI, using the given resource ID as the default if no image - is found for the given URI. Note that this does not support arbitrary URIs - the URI must be - something that was retrieved from another call to Google Play services. -

- Note that you should hold a reference to the listener provided until the callback is - complete. For this reason, the use of anonymous implementations is discouraged. -

- The result is delivered to the given listener on the main thread. -

- If a result is not found, the image view will be set to the given default resource if the - image needs to be loaded asynchronously.

-
-
Parameters
- - - - - - - - - - -
listener - The listener that is called when the load is complete.
uri - URI to load the image data from.
defaultResId - Resource ID to use by default for the image. -
-
- -
-
- - - - -
-

- - public - - - - - void - - loadImage - (ImageManager.OnImageLoadedListener listener, Uri uri) -

-
-
- - - -
-
- - - - -

Load an image to display from a URI. Note that this does not support arbitrary URIs - the URI - must be something that was retrieved from another call to Google Play services. -

- Note that you should hold a reference to the listener provided until the callback is - complete. For this reason, the use of anonymous implementations is discouraged. -

- The result is delivered to the given listener on the main thread.

-
-
Parameters
- - - - - - - -
listener - The listener that is called when the load is complete.
uri - URI to load the image data from. -
-
- -
-
- - - - -
-

- - public - - - - - void - - loadImage - (ImageView imageView, Uri uri, int defaultResId) -

-
-
- - - -
-
- - - - -

Loads an image to display from a URI, using the given resource ID as the default if no image - is found for the given URI. Note that this does not support arbitrary URIs - the URI must be - something that was retrieved from another call to Google Play services. -

- The image view will be set to the given default resource if the image needs to be loaded - asynchronously. -

- The result (if non-null) is set on the given image view on the main thread. -

- Note that if the ImageView used for this call is hosted in a ListAdapter (or any - other class that recycles ImageView instances), then ALL calls to set the contents of - that ImageView must be done via one of the calls on this ImageManager.

-
-
Parameters
- - - - - - - - - - -
imageView - The image view to populate with the image.
uri - URI to load the image data from.
defaultResId - Resource ID to use by default for the image. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/images/WebImage.html b/docs/html/reference/com/google/android/gms/common/images/WebImage.html deleted file mode 100644 index a0cb182c2b78..000000000000 --- a/docs/html/reference/com/google/android/gms/common/images/WebImage.html +++ /dev/null @@ -1,2046 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WebImage | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WebImage

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.images.WebImage
- - - - - - - -
- - -

Class Overview

-

A class that represents an image that is located on a web server. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<WebImage>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WebImage(Uri url, int width, int height) - -
- Constructs a new WebImage with the given URL and dimensions. - - - -
- -
- - - - - - - - WebImage(Uri url) - -
- Constructs a new WebImage with the given URL. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object other) - -
- - - - - - int - - getHeight() - -
- Gets the image height, in pixels. - - - -
- -
- - - - - - Uri - - getUrl() - -
- Gets the image URL. - - - -
- -
- - - - - - int - - getWidth() - -
- Gets the image width, in pixels. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- Returns a string representation of this object. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<WebImage> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WebImage - (Uri url, int width, int height) -

-
-
- - - -
-
- - - - -

Constructs a new WebImage with the given URL and dimensions.

-
-
Parameters
- - - - - - - - - - -
url - The URL of the image.
width - The width of the image, in pixels.
height - The height of the image, in pixels.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the URL is null or empty, or the dimensions are invalid. -
-
- -
-
- - - - -
-

- - public - - - - - - - WebImage - (Uri url) -

-
-
- - - -
-
- - - - -

Constructs a new WebImage with the given URL.

-
-
Parameters
- - - - -
url - The URL of the image.
-
-
-
Throws
- - - - -
IllegalArgumentException - If the URL is null or empty. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getHeight - () -

-
-
- - - -
-
- - - - -

Gets the image height, in pixels. -

- -
-
- - - - -
-

- - public - - - - - Uri - - getUrl - () -

-
-
- - - -
-
- - - - -

Gets the image URL. -

- -
-
- - - - -
-

- - public - - - - - int - - getWidth - () -

-
-
- - - -
-
- - - - -

Gets the image width, in pixels. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

Returns a string representation of this object. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/images/package-summary.html b/docs/html/reference/com/google/android/gms/common/images/package-summary.html deleted file mode 100644 index 30dab1a6f8dd..000000000000 --- a/docs/html/reference/com/google/android/gms/common/images/package-summary.html +++ /dev/null @@ -1,922 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.common.images | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.common.images

-
- -
- -
- - -
- Contains classes for loading images from Google Play services. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
ImageManager.OnImageLoadedListener - Listener interface for handling when the image for a particular URI has been loaded.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - -
ImageManager - This class is used to load images from the network and handles local caching for you.  - - - -
WebImage - A class that represents an image that is located on a web server.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/common/package-summary.html b/docs/html/reference/com/google/android/gms/common/package-summary.html deleted file mode 100644 index 989bdd2b18aa..000000000000 --- a/docs/html/reference/com/google/android/gms/common/package-summary.html +++ /dev/null @@ -1,1022 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.common | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.common

-
- -
- -
- - -
- Contains utility classes for Google Play services. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AccountPicker - Common account picker similar to the standard framework account picker introduced in ICS: - newChooseAccountIntent.  - - - -
ConnectionResult - Contains all possible error codes for when a client fails to connect to Google Play services.  - - - -
ErrorDialogFragment - Wraps the Dialog returned by - getErrorDialog(int, Activity, int) by using - DialogFragment so that it can be properly managed by the - Activity.  - - - -
GoogleApiAvailability - Helper class for verifying that the Google Play services APK is available and - up-to-date on this device.  - - - -
GooglePlayServicesUtil - Utility class for verifying that the Google Play services APK is available and - up-to-date on this device.  - - - -
Scopes - OAuth 2.0 scopes for use with Google Play services.  - - - -
SignInButton - The Google sign-in button to authenticate the user.  - - - -
SupportErrorDialogFragment - Wraps the Dialog returned by - getErrorDialog(int, Activity, int) by using - DialogFragment so that it can be properly managed by the - Activity.  - - - -
- -
- - - - - - - -

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - - -
GooglePlayServicesNotAvailableException - Indicates Google Play services is not available.  - - - -
GooglePlayServicesRepairableException - GooglePlayServicesRepairableExceptions are special instances of - UserRecoverableExceptions which are thrown when Google Play Services is not installed, - up-to-date, or enabled.  - - - -
UserRecoverableException - UserRecoverableExceptions signal errors that can be recovered with user - action, such as a user login.  - - - -
- -
- - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/CreateFileActivityBuilder.html b/docs/html/reference/com/google/android/gms/drive/CreateFileActivityBuilder.html deleted file mode 100644 index d6c0dcbb1716..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/CreateFileActivityBuilder.html +++ /dev/null @@ -1,1691 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CreateFileActivityBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CreateFileActivityBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.CreateFileActivityBuilder
- - - - - - - -
- - -

Class Overview

-

A builder that is used to configure and display the create file activity. This dialog creates a - new file in the user's drive with a destination and file title selected by the user. If the - device is currently offline, the file will be created locally and committed to the server when - connectivity is restored. - -

- To create a new DriveFile, the following objects should be provided through the setters - in this class before build(GoogleApiClient) is called: -

- -

- To display the activity, pass the result of build(GoogleApiClient) to - #startIntentSenderForResult(). - When the activity completes, a successful response will include an extra - EXTRA_RESPONSE_DRIVE_ID that specifies the DriveId for the newly created file. - -

Note: you cannot use #startIntentSender to invoke the activity. This will fail. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_RESPONSE_DRIVE_ID - A successful result will return an extra by this name which will contain the DriveId - of the created file. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - IntentSender - - build(GoogleApiClient apiClient) - -
- Gets an Intent that can be used to start the Create File activity. - - - -
- -
- - - - - - CreateFileActivityBuilder - - setActivityStartFolder(DriveId folder) - -
- Sets the default folder that will be presented at activity startup as the location for - file creation. - - - -
- -
- - - - - - CreateFileActivityBuilder - - setActivityTitle(String title) - -
- Sets the title displayed in the activity. - - - -
- -
- - - - - - CreateFileActivityBuilder - - setInitialDriveContents(DriveContents driveContents) - -
- Sets the initial DriveContents for the new file. - - - -
- -
- - - - - - CreateFileActivityBuilder - - setInitialMetadata(MetadataChangeSet metadataChangeSet) - -
- Sets the initial metadata for the new file. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_RESPONSE_DRIVE_ID -

-
- - - - -
-
- - - - -

A successful result will return an extra by this name which will contain the DriveId - of the created file. -

- - -
- Constant Value: - - - "response_drive_id" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - IntentSender - - build - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets an Intent that can be used to start the Create File activity. Note that you must start - this activity with startIntentSenderForResult, not startIntentSender. Once - this is invoked, the provided contents are finalized and cannot be edited. To make additional - edits, reopen the contents with the returned DriveId.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method and must have a scope to create files in the - target directory (e.g. SCOPE_FILE). -
-
- -
-
- - - - -
-

- - public - - - - - CreateFileActivityBuilder - - setActivityStartFolder - (DriveId folder) -

-
-
- - - -
-
- - - - -

Sets the default folder that will be presented at activity startup as the location for - file creation. The activity supports navigation from this point to other folders. If not set, - defaults to the root folder in the user's Drive. - -

- If this method is called multiple times before build(GoogleApiClient), the last call will overwrite - any previous value. -

- -
-
- - - - -
-

- - public - - - - - CreateFileActivityBuilder - - setActivityTitle - (String title) -

-
-
- - - -
-
- - - - -

Sets the title displayed in the activity. - -

- If this method is called multiple times before build(GoogleApiClient), the last call will overwrite - any previous value.

-
-
Parameters
- - - - -
title - the title to set on the activity (may not be null) -
-
- -
-
- - - - -
-

- - public - - - - - CreateFileActivityBuilder - - setInitialDriveContents - (DriveContents driveContents) -

-
-
- - - -
-
- - - - -

Sets the initial DriveContents for the new file. This will persist the contents as - the initial contents for the file. To continue editing the contents, open them again through - open(GoogleApiClient, int, DriveFile.DownloadProgressListener) once the file has been created. - -

- This method must always be called or the build(GoogleApiClient) method will fail. If this method is - called multiple times before build(GoogleApiClient), the last call will overwrite any previous value.

-
-
Parameters
- - - - -
driveContents - The initial contents. The provided contents must have been obtained - through newDriveContents(GoogleApiClient). This DriveContents cannot be reused - after this method returns. This parameter may also be set to null to create an - empty file, but it is recommended to create non-empty files where the mime-type does not - support having a zero byte file (for example, image or PDF files). -
-
- -
-
- - - - -
-

- - public - - - - - CreateFileActivityBuilder - - setInitialMetadata - (MetadataChangeSet metadataChangeSet) -

-
-
- - - -
-
- - - - -

Sets the initial metadata for the new file. - -

- This method must be called or the build(GoogleApiClient) method will fail. A new - MetadataChangeSet can be created using MetadataChangeSet.Builder. If this - method is called multiple times before build(GoogleApiClient), the last call will overwrite any - previous value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/Drive.html b/docs/html/reference/com/google/android/gms/drive/Drive.html deleted file mode 100644 index 231c02f7784b..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/Drive.html +++ /dev/null @@ -1,1515 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Drive | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Drive

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.Drive
- - - - - - - -
- - -

Class Overview

-

The Drive API provides easy access to users' Google Drive contents. This API includes Activities - to open or create files in users' Drives, as well as the ability to programmatically interact - with contents, metadata, and the folder hierarchy. - -

To use Drive, enable the API and at least one scope of SCOPE_FILE or - SCOPE_APPFOLDER in a GoogleApiClient. - DriveApi, provides the entry point for interacting with Drive. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - The API necessary to use Drive. - - - -
- public - static - final - DriveApiDriveApi - The entry point for interacting with the Drive APIs which provides ways to access/update the - files and folders in users Drive. - - - -
- public - static - final - DrivePreferencesApiDrivePreferencesApi - The entry point for interacting with the Drive APIs which provides ways to access/update - Drive preferences. - - - -
- public - static - final - ScopeSCOPE_APPFOLDER - A Scope that gives 'drive.appfolder' access to a user's drive. - - - -
- public - static - final - ScopeSCOPE_FILE - A Scope that gives 'drive.file' access to a user's drive. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

The API necessary to use Drive. Provide this as an API to - addApi(Api). -

- - -
-
- - - - - -
-

- - public - static - final - DriveApi - - DriveApi -

-
- - - - -
-
- - - - -

The entry point for interacting with the Drive APIs which provides ways to access/update the - files and folders in users Drive. -

- - -
-
- - - - - -
-

- - public - static - final - DrivePreferencesApi - - DrivePreferencesApi -

-
- - - - -
-
- - - - -

The entry point for interacting with the Drive APIs which provides ways to access/update - Drive preferences. -

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_APPFOLDER -

-
- - - - -
-
- - - - -

A Scope that gives 'drive.appfolder' access to a user's drive. This scope gives access to - files that have been created by the app in the App Folder. -

This scope can be provided in - addScope(Scope) -

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_FILE -

-
- - - - -
-
- - - - -

A Scope that gives 'drive.file' access to a user's drive. This scope give per-file access to - files that have been created by, or specifically opened with the app. -

This scope can be provided in - addScope(Scope) -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveContentsResult.html b/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveContentsResult.html deleted file mode 100644 index d247c9956ba3..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveContentsResult.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveApi.DriveContentsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveApi.DriveContentsResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveApi.DriveContentsResult
- - - - - - - -
- - -

Class Overview

-

Result that contains a DriveContents. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DriveContents - - getDriveContents() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DriveContents - - getDriveContents - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The DriveContents result, or null if the status is not - success. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveIdResult.html b/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveIdResult.html deleted file mode 100644 index bc7b685cb64f..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveApi.DriveIdResult.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveApi.DriveIdResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveApi.DriveIdResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveApi.DriveIdResult
- - - - - - - -
- - -

Class Overview

-

Result that contains a DriveId. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DriveId - - getDriveId() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveApi.MetadataBufferResult.html b/docs/html/reference/com/google/android/gms/drive/DriveApi.MetadataBufferResult.html deleted file mode 100644 index baacca80fbd9..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveApi.MetadataBufferResult.html +++ /dev/null @@ -1,1199 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveApi.MetadataBufferResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveApi.MetadataBufferResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveApi.MetadataBufferResult
- - - - - - - -
- - -

Class Overview

-

Result that contains a MetadataBuffer. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - MetadataBuffer - - getMetadataBuffer() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - MetadataBuffer - - getMetadataBuffer - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The MetadataBuffer result, or null if the status is not - success. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveApi.html b/docs/html/reference/com/google/android/gms/drive/DriveApi.html deleted file mode 100644 index 0d0900778987..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveApi.html +++ /dev/null @@ -1,1842 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with Drive. This class provides methods for obtaining - a reference to a file or folder, or querying across the entire Drive. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDriveApi.DriveContentsResult - Result that contains a DriveContents.  - - - -
- - - - - interfaceDriveApi.DriveIdResult - Result that contains a DriveId.  - - - -
- - - - - interfaceDriveApi.MetadataBufferResult - Result that contains a MetadataBuffer.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - cancelPendingActions(GoogleApiClient apiClient, List<String> trackingTags) - -
- Requests a canceling of the actions identified by the specified tags. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.DriveIdResult> - - fetchDriveId(GoogleApiClient apiClient, String resourceId) - -
- Retrieves a DriveId object that can be used in further drive api operations (e.g. - - - -
- -
- abstract - - - - - DriveFolder - - getAppFolder(GoogleApiClient apiClient) - -
- Retrieves a DriveFolder object that can be used to interact with the App - Folder. - - - -
- -
- abstract - - - - - DriveFile - - getFile(GoogleApiClient apiClient, DriveId id) - -
- Retrieves a DriveFile object that can be used to interact with the file specified by - the provided DriveId. - - - -
- -
- abstract - - - - - DriveFolder - - getFolder(GoogleApiClient apiClient, DriveId id) - -
- Retrieves a DriveFolder object that can be used to interact with the folder specified - by the provided DriveId. - - - -
- -
- abstract - - - - - DriveFolder - - getRootFolder(GoogleApiClient apiClient) - -
- Retrieves a DriveFolder object that can be used to interact with the root folder. - - - -
- -
- abstract - - - - - CreateFileActivityBuilder - - newCreateFileActivityBuilder() - -
- Creates a builder for a Create File activity where a user can select a file name and - destination for a new binary file in their Drive with the contents and additional metadata - provided in the builder. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.DriveContentsResult> - - newDriveContents(GoogleApiClient apiClient) - -
- Retrieves a new DriveContents instance that can be used to provide initial contents - for a new file. - - - -
- -
- abstract - - - - - OpenFileActivityBuilder - - newOpenFileActivityBuilder() - -
- Creates a builder for an Open File activity that allows user selection of a Drive file. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.MetadataBufferResult> - - query(GoogleApiClient apiClient, Query query) - -
- Retrieves a collection of metadata for the files and folders that match the specified query. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestSync(GoogleApiClient apiClient) - -
- Requests synchronization a PendingResult that is ready when synchronization has - completed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - cancelPendingActions - (GoogleApiClient apiClient, List<String> trackingTags) -

-
-
- - - -
-
- - - - -

Requests a canceling of the actions identified by the specified tags. -

- This method does not guarantee that the requested actions will be canceled as some of - the actions may be in a state where they can't be canceled anymore. -

- Only actions originating from this application and from the account set on this client may - be canceled by this call. -

- It is recommended using this method with actions that were performed with - ExecutionOptions requesting completion notifications, so that for any canceled - action a CompletionEvent with status STATUS_CANCELED is - delivered to the application. This way the application may know which actions were actually - canceled.

-
-
Parameters
- - - - -
trackingTags - the list of tracking tags that identify the actions that should be - canceled.
-
-
-
Returns
-
  • A successful status only indicates that the API received the cancel request, but - not that all the requested actions were actually canceled. - CompletionEvent may be used to track the canceled actions. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.DriveIdResult> - - fetchDriveId - (GoogleApiClient apiClient, String resourceId) -

-
-
- - - -
-
- - - - -

Retrieves a DriveId object that can be used in further drive api operations (e.g. - getFile, getFolder). An error result will be returned if the given resource ID does not - exist.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
resourceId - The Drive resource id for the DriveId to retrieve.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the DriveId object. -
-
- -
-
- - - - -
-

- - public - - - abstract - - DriveFolder - - getAppFolder - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves a DriveFolder object that can be used to interact with the App - Folder. This method will return synchronously, and is safe to invoke from the UI thread. - The AppData scope is required to access this folder. If the app does not have - SCOPE_APPFOLDER it will return null.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - DriveFile - - getFile - (GoogleApiClient apiClient, DriveId id) -

-
-
- - - -
-
- - - - -

Retrieves a DriveFile object that can be used to interact with the file specified by - the provided DriveId.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - DriveFolder - - getFolder - (GoogleApiClient apiClient, DriveId id) -

-
-
- - - -
-
- - - - -

Retrieves a DriveFolder object that can be used to interact with the folder specified - by the provided DriveId.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - DriveFolder - - getRootFolder - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves a DriveFolder object that can be used to interact with the root folder. - This method will return synchronously, and is safe to invoke from the UI thread.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - CreateFileActivityBuilder - - newCreateFileActivityBuilder - () -

-
-
- - - -
-
- - - - -

Creates a builder for a Create File activity where a user can select a file name and - destination for a new binary file in their Drive with the contents and additional metadata - provided in the builder. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.DriveContentsResult> - - newDriveContents - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves a new DriveContents instance that can be used to provide initial contents - for a new file. The returned contents will be in MODE_WRITE_ONLY and can be - used to write the initial contents through the file APIs provided in DriveContents. - -

- To be persisted, the contents must be saved by being passed as initial contents to - createFile(GoogleApiClient, MetadataChangeSet, DriveContents) or - setInitialDriveContents(DriveContents). - -

- To discard the contents without saving them, invoke - discard(GoogleApiClient).

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the Contents object. -
-
- -
-
- - - - -
-

- - public - - - abstract - - OpenFileActivityBuilder - - newOpenFileActivityBuilder - () -

-
-
- - - -
-
- - - - -

Creates a builder for an Open File activity that allows user selection of a Drive file. - Upon completion, the result Intent will contain the DriveId for the selected file. - This activity will authorize the requesting app to interact with the selected file. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.MetadataBufferResult> - - query - (GoogleApiClient apiClient, Query query) -

-
-
- - - -
-
- - - - -

Retrieves a collection of metadata for the files and folders that match the specified query.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
query - The query that will restrict the contents of the result set.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the result set. Be sure to call - release() when you're done with the result. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestSync - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Requests synchronization a PendingResult that is ready when synchronization has - completed. - -

This operation may fail with DRIVE_RATE_LIMIT_EXCEEDED status, - which indicates that the operation may succeed if reattempted after a sufficient backoff - duration.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveContents.html b/docs/html/reference/com/google/android/gms/drive/DriveContents.html deleted file mode 100644 index 30fdb92d9eb7..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveContents.html +++ /dev/null @@ -1,1701 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveContents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveContents

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveContents
- - - - - - - -
- - -

Class Overview

-

A reference to a Drive file's contents. There are two types of DriveContents: -

- -

- Any changes made to the DriveContents through either their ParcelFileDescriptor - or OutputStream will not be visible until either commit(GoogleApiClient, MetadataChangeSet) is executed (for - existing contents already associated to a DriveFile), or a new file is created using this - contents (through createFile(GoogleApiClient, MetadataChangeSet, DriveContents) or CreateFileActivityBuilder, for new - contents). - -

- In both cases, the discard(GoogleApiClient) method can be used to discard any changes to any kind of - DriveContents, so those changes will never be applied to a DriveFile or persisted - in Drive. - -

- Once this DriveContents instance has been committed, used for creation, or discarded, it - becomes closed and any subsequent method call will throw an IllegalStateException. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - commit(GoogleApiClient apiClient, MetadataChangeSet changeSet, ExecutionOptions executionOptions) - -
- Advanced version of commit which commits this contents and updates the metadata (if provided) - of the file associated to this DriveContents instance and allows the client to - specify a conflict resolution strategy or request completion notifications via the - executionOptions parameter. - - - -
- -
- abstract - - - - - PendingResult<Status> - - commit(GoogleApiClient apiClient, MetadataChangeSet changeSet) - -
- Commits this contents and updates the metadata (if provided) of the file associated to this - DriveContents instance. - - - -
- -
- abstract - - - - - void - - discard(GoogleApiClient apiClient) - -
- Discards this contents and any changes that were performed. - - - -
- -
- abstract - - - - - DriveId - - getDriveId() - -
- Gets the DriveId for the file that owns these contents. - - - -
- -
- abstract - - - - - InputStream - - getInputStream() - -
- Returns an InputStream that allows you to read this file's contents. - - - -
- -
- abstract - - - - - int - - getMode() - -
- Gets the mode the contents are opened in. - - - -
- -
- abstract - - - - - OutputStream - - getOutputStream() - -
- Returns an OutputStream that allows you to write new contents. - - - -
- -
- abstract - - - - - ParcelFileDescriptor - - getParcelFileDescriptor() - -
- Returns a ParcelFileDescriptor that points to the Drive file's contents. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.DriveContentsResult> - - reopenForWrite(GoogleApiClient apiClient) - -
- Closes this contents and returns a new contents opened in MODE_WRITE_ONLY. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - commit - (GoogleApiClient apiClient, MetadataChangeSet changeSet, ExecutionOptions executionOptions) -

-
-
- - - -
-
- - - - -

Advanced version of commit which commits this contents and updates the metadata (if provided) - of the file associated to this DriveContents instance and allows the client to - specify a conflict resolution strategy or request completion notifications via the - executionOptions parameter. - -

- A file conflict happens when the written contents are not applied on top of the file revision - that Drive originally provided when the contents were read by the application. A conflict - could happen when an application reads contents at revision X, then writes revision X+1 and - by the time X+1 is committed (or uploaded to the server), the file version is not X anymore - (another app or a remote change already modified the file to revision X'). - -

- This method should only be used on DriveContents that are already associated to a - particular file. See setConflictStrategy(int) for - details on using each conflict strategy. - -

- After this method returns, this instance will be closed and will no longer be usable.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
changeSet - The set of changes that will be applied to the Metadata of the file - associated to this contents instance. Should only include the specific fields that should - be updated. Can be null if no metadata changes should be applied with this - commit.
executionOptions - Contains any extra settings for this commit action, such as the - strategy for handling conflicts or whether the client should be notified of failures when - applying this operation on the server. See ExecutionOptions for more info. When - null is provided, this method will use default ExecutionOptions, that is - CONFLICT_STRATEGY_OVERWRITE_REMOTE strategy, no completion event - requested and no operation tag.
-
-
-
Returns
-
  • A PendingResult which can be used to verify the success of the operation.
-
-
-
Throws
- - - - -
IllegalStateException - If one of the following is true: - -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - commit - (GoogleApiClient apiClient, MetadataChangeSet changeSet) -

-
-
- - - -
-
- - - - -

Commits this contents and updates the metadata (if provided) of the file associated to this - DriveContents instance. This method should only be used on DriveContents that - are already associated to a particular file (obtained through open(GoogleApiClient, int, DriveFile.DownloadProgressListener)). - -

- This method behaves like - commit(GoogleApiClient, MetadataChangeSet, ExecutionOptions) with null - ExecutionOptions, which means - CONFLICT_STRATEGY_OVERWRITE_REMOTE strategy, no completion event - requested and no operation tag. Use the advanced version of - commit if you'd like to - specify different ExecutionOptions. - -

- After this method returns, this instance will be closed and will no longer be usable.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
changeSet - The set of changes that will be applied to the Metadata of the file - associated to this contents instance. Should only include the specific fields that should - be updated. Can be null if no metadata changes should be applied with this - commit.
-
-
-
Returns
-
  • A PendingResult which can be used to verify the success of the operation.
-
-
-
Throws
- - - - -
IllegalStateException - If one of the following is true: - -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - discard - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Discards this contents and any changes that were performed. Calling this method will not save - any changes performed through this object. - -

- After this method returns, this instance will be closed and will no longer be usable.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Gets the DriveId for the file that owns these contents. Will be null if this - instance corresponds to new contents (obtained through newDriveContents(GoogleApiClient)}. -

- -
-
- - - - -
-

- - public - - - abstract - - InputStream - - getInputStream - () -

-
-
- - - -
-
- - - - -

Returns an InputStream that allows you to read this file's contents. This method may - only be used with files opened with MODE_READ_ONLY; to read/write from a - file opened with MODE_READ_WRITE, use the file descriptor returned by - getParcelFileDescriptor(). This method may only be called once per - DriveContents instance. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getMode - () -

-
-
- - - -
-
- - - - -

Gets the mode the contents are opened in. -

- -
-
- - - - -
-

- - public - - - abstract - - OutputStream - - getOutputStream - () -

-
-
- - - -
-
- - - - -

Returns an OutputStream that allows you to write new contents. This method may only - be used with files opened with MODE_WRITE_ONLY; to read/write from a file - opened with MODE_READ_WRITE, use the file descriptor returned by - getParcelFileDescriptor(). This method may only be called once per - DriveContents instance. -

- -
-
- - - - -
-

- - public - - - abstract - - ParcelFileDescriptor - - getParcelFileDescriptor - () -

-
-
- - - -
-
- - - - -

Returns a ParcelFileDescriptor that points to the Drive file's contents. If this file - was opened with MODE_READ_ONLY or MODE_READ_WRITE, the - file referenced by the returned file descriptor will contain the most recent version of the - file. Otherwise, the returned file descriptor will point to an empty file. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.DriveContentsResult> - - reopenForWrite - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Closes this contents and returns a new contents opened in MODE_WRITE_ONLY. - The returned DriveContents are usable for conflict detection. - -

- This method can only be called on MODE_READ_ONLY contents. Calling it on - MODE_WRITE_ONLY or MODE_READ_WRITE contents, or on closed - contents throws an IllegalStateException. - -

- This method is useful for conflict detection, and often used in conjunction with - commit(GoogleApiClient, MetadataChangeSet, ExecutionOptions), however it can also - be used to open contents in MODE_WRITE_ONLY from an existing instance of - MODE_READ_ONLY contents. - -

- After this method returns, this instance will be closed and will no longer be usable.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveFile.DownloadProgressListener.html b/docs/html/reference/com/google/android/gms/drive/DriveFile.DownloadProgressListener.html deleted file mode 100644 index 35dca508f97b..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveFile.DownloadProgressListener.html +++ /dev/null @@ -1,1052 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveFile.DownloadProgressListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveFile.DownloadProgressListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveFile.DownloadProgressListener
- - - - - - - -
- - -

Class Overview

-

A listener that listens for progress events on an active contents download. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onProgress(long bytesDownloaded, long bytesExpected) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onProgress - (long bytesDownloaded, long bytesExpected) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveFile.html b/docs/html/reference/com/google/android/gms/drive/DriveFile.html deleted file mode 100644 index 66f67e4ca7c7..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveFile.html +++ /dev/null @@ -1,1633 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveFile | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveFile

- - - - - - implements - - DriveResource - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveFile
- - - - - - - -
- - -

Class Overview

-

A file in Drive. This class provides access to the contents and metadata of the specified file. - To retrieve a DriveFile from a known drive id, use - getFile(GoogleApiClient, DriveId). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDriveFile.DownloadProgressListener - A listener that listens for progress events on an active contents download.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intMODE_READ_ONLY - A mode that opens the contents only for reading. - - - -
intMODE_READ_WRITE - A mode that opens the contents for reading and writing. - - - -
intMODE_WRITE_ONLY - A mode that opens the contents only for writing. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<DriveApi.DriveContentsResult> - - open(GoogleApiClient apiClient, int mode, DriveFile.DownloadProgressListener listener) - -
- Opens the DriveContents that are associated with this file for read and/or write. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.drive.DriveResource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - MODE_READ_ONLY -

-
- - - - -
-
- - - - -

A mode that opens the contents only for reading. -

- - -
- Constant Value: - - - 268435456 - (0x10000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MODE_READ_WRITE -

-
- - - - -
-
- - - - -

A mode that opens the contents for reading and writing. -

- - -
- Constant Value: - - - 805306368 - (0x30000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MODE_WRITE_ONLY -

-
- - - - -
-
- - - - -

A mode that opens the contents only for writing. -

- - -
- Constant Value: - - - 536870912 - (0x20000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.DriveContentsResult> - - open - (GoogleApiClient apiClient, int mode, DriveFile.DownloadProgressListener listener) -

-
-
- - - -
-
- - - - -

Opens the DriveContents that are associated with this file for read and/or write. - The returned file is a temporary copy available only to this app. The contents are returned - when they are available on the device in their entirety. To listen for progress, provide a - DriveFile.DownloadProgressListener. - -

The contents must be closed via commit(GoogleApiClient, MetadataChangeSet) or - discard(GoogleApiClient). - -

Note: to open the file in edit mode, the user must have edit access. See - isEditable().

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
mode - Describes the mode in which to open the file. Possible values are - MODE_READ_ONLY, MODE_READ_WRITE and MODE_WRITE_ONLY.
listener - An optional listener that will announce progress as the file is downloaded. - If you don't care about progress, provide null.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the DriveContents when they are - available. If isSuccess() returns true, it is recommended to check - getStatusCode(), since two possible values are considered success: - SUCCESS which means that the returned DriveContents is - up to date, or SUCCESS_CACHE which means that the returned - DriveContents is a cached version, since the most up to date version could not be - downloaded to the device (for example, due to connectivity). -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFileResult.html b/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFileResult.html deleted file mode 100644 index 4008b389b8b4..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFileResult.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveFolder.DriveFileResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveFolder.DriveFileResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveFolder.DriveFileResult
- - - - - - - -
- - -

Class Overview

-

A result that contains a DriveFile. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DriveFile - - getDriveFile() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DriveFile - - getDriveFile - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFolderResult.html b/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFolderResult.html deleted file mode 100644 index abd491abc8b1..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveFolder.DriveFolderResult.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveFolder.DriveFolderResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveFolder.DriveFolderResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveFolder.DriveFolderResult
- - - - - - - -
- - -

Class Overview

-

A result that contains a DriveFolder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DriveFolder - - getDriveFolder() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DriveFolder - - getDriveFolder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveFolder.html b/docs/html/reference/com/google/android/gms/drive/DriveFolder.html deleted file mode 100644 index 87188f609f56..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveFolder.html +++ /dev/null @@ -1,1850 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveFolder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveFolder

- - - - - - implements - - DriveResource - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveFolder
- - - - - - - -
- - -

Class Overview

-

A folder in Drive. This class provides methods to list or query the contents of the folder, or - create new resources within it. -

To retrieve a DriveFolder from a known Drive ID, use - getFolder(GoogleApiClient, DriveId). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDriveFolder.DriveFileResult - A result that contains a DriveFile.  - - - -
- - - - - interfaceDriveFolder.DriveFolderResult - A result that contains a DriveFolder.  - - - -
- - - - - - - - - - - -
Constants
StringMIME_TYPE - The MIME type associated with folder resources. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<DriveFolder.DriveFileResult> - - createFile(GoogleApiClient apiClient, MetadataChangeSet changeSet, DriveContents driveContents, ExecutionOptions executionOptions) - -
- Creates a new binary file within this folder, with the provided initial metadata and - DriveContents. - - - -
- -
- abstract - - - - - PendingResult<DriveFolder.DriveFileResult> - - createFile(GoogleApiClient apiClient, MetadataChangeSet changeSet, DriveContents driveContents) - -
- Creates a new binary file within this folder, with the provided initial metadata and - DriveContents. - - - -
- -
- abstract - - - - - PendingResult<DriveFolder.DriveFolderResult> - - createFolder(GoogleApiClient apiClient, MetadataChangeSet changeSet) - -
- Creates a new folder within this folder, with the provided initial metadata. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.MetadataBufferResult> - - listChildren(GoogleApiClient apiClient) - -
- Retrieves a collection of metadata for the direct children of this folder. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.MetadataBufferResult> - - queryChildren(GoogleApiClient apiClient, Query query) - -
- Retrieves a collection of metadata for the files and folders that match the specified query - and are direct children of this folder - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.drive.DriveResource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - MIME_TYPE -

-
- - - - -
-
- - - - -

The MIME type associated with folder resources. -

- - -
- Constant Value: - - - "application/vnd.google-apps.folder" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<DriveFolder.DriveFileResult> - - createFile - (GoogleApiClient apiClient, MetadataChangeSet changeSet, DriveContents driveContents, ExecutionOptions executionOptions) -

-
-
- - - -
-
- - - - -

Creates a new binary file within this folder, with the provided initial metadata and - DriveContents. See DriveFile for more details on binary files.

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
changeSet - A set of metadata fields that should be initially set.
driveContents - The initial contents. The provided contents must have been obtained - through newDriveContents(GoogleApiClient). This DriveContents cannot be reused - after this method returns. This parameter may also be set to null to create an - empty file, but it is recommended to create non-empty files where the mime-type does not - support having a zero byte file (for example, image or PDF files).
executionOptions - A set of options for this method execution, such as whether to send - an event when the action has completed on the server. See ExecutionOptions for - more details. setConflictStrategy(int) is not supported for - this method. When null is provided, this method will use default - ExecutionOptions, that is no completion event requested and no operation tag.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the newly created DriveFile. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveFolder.DriveFileResult> - - createFile - (GoogleApiClient apiClient, MetadataChangeSet changeSet, DriveContents driveContents) -

-
-
- - - -
-
- - - - -

Creates a new binary file within this folder, with the provided initial metadata and - DriveContents. See DriveFile for more details on binary files. - -

- This method behaves like createFile(GoogleApiClient, MetadataChangeSet, DriveContents, ExecutionOptions) with null ExecutionOptions, which means - no completion event requested and no operation tag.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
changeSet - A set of metadata fields that should be initially set.
driveContents - The initial contents. The provided contents must have been obtained - through newDriveContents(GoogleApiClient). This DriveContents cannot be reused - after this method returns. This parameter may also be set to null to create an - empty file, but it is recommended to create non-empty files where the mime-type does not - support having a zero byte file (for example, image or PDF files).
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the newly created DriveFile. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveFolder.DriveFolderResult> - - createFolder - (GoogleApiClient apiClient, MetadataChangeSet changeSet) -

-
-
- - - -
-
- - - - -

Creates a new folder within this folder, with the provided initial metadata.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
changeSet - A set of metadata fields that should be initially set. This must - minimally include a title. The mime type will be set to the folder mime type.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the newly created DriveFolder. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.MetadataBufferResult> - - listChildren - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves a collection of metadata for the direct children of this folder. The result will - include metadata for both files and folders.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the children list. Be sure to call - release() when you're done with the result. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.MetadataBufferResult> - - queryChildren - (GoogleApiClient apiClient, Query query) -

-
-
- - - -
-
- - - - -

Retrieves a collection of metadata for the files and folders that match the specified query - and are direct children of this folder

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
query - A query that will restrict the results of the retrieved children.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the children list. Be sure to call - release() when you're done with the result. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveId.html b/docs/html/reference/com/google/android/gms/drive/DriveId.html deleted file mode 100644 index ecd1fd77c9fc..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveId.html +++ /dev/null @@ -1,2208 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveId | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DriveId

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.DriveId
- - - - - - - -
- - -

Class Overview

-

A canonical identifier for a Drive resource. The identifier can be converted to a String - representation for storage using encodeToString() and then later converted back - to the ID representation using decodeFromString(String). - equals(Object) can be used to see if two different identifiers refer to the - same resource. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRESOURCE_TYPE_FILE - A file resource type, meaning the DriveId corresponds to a file. - - - -
intRESOURCE_TYPE_FOLDER - A folder resource type, meaning the DriveId corresponds to a folder. - - - -
intRESOURCE_TYPE_UNKNOWN - An unknown resource type, meaning the DriveId corresponds to either a file or a - folder. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DriveId>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - DriveId - - decodeFromString(String s) - -
- Decodes the result of encodeToString() back into a DriveId. - - - -
- -
- - - - - - int - - describeContents() - -
- - - final - - - String - - encodeToString() - -
- Returns a String representation of this DriveId that can be safely - persisted, and from which an equivalent DriveId can later be - reconstructed using decodeFromString(String). - - - -
- -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - String - - getResourceId() - -
- Returns the remote Drive resource id associated with the resource. - - - -
- -
- - - - - - int - - getResourceType() - -
- Returns the resource type corresponding to this DriveId. - - - -
- -
- - - - - - int - - hashCode() - -
- - - final - - - String - - toInvariantString() - -
- Returns an invariant string for this DriveId. - - - -
- -
- - - - - - String - - toString() - -
- Returns a String representation of the ID. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESOURCE_TYPE_FILE -

-
- - - - -
-
- - - - -

A file resource type, meaning the DriveId corresponds to a file. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOURCE_TYPE_FOLDER -

-
- - - - -
-
- - - - -

A folder resource type, meaning the DriveId corresponds to a folder. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOURCE_TYPE_UNKNOWN -

-
- - - - -
-
- - - - -

An unknown resource type, meaning the DriveId corresponds to either a file or a - folder. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DriveId> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - DriveId - - decodeFromString - (String s) -

-
-
- - - -
-
- - - - -

Decodes the result of encodeToString() back into a DriveId.

-
-
Throws
- - - - -
IllegalArgumentException - if the argument is not a valid result of - encodeToString(). -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - final - - - String - - encodeToString - () -

-
-
- - - -
-
- - - - -

Returns a String representation of this DriveId that can be safely - persisted, and from which an equivalent DriveId can later be - reconstructed using decodeFromString(String). -

- The String representation is not guaranteed to be stable over time for a given resource so - should never be compared for equality. Always use decodeFromString(String) and - then equals(Object) to compare two identifiers to see if they refer to the - same resource. Otherwise, toInvariantString() is stable and can be safely - used for DriveId comparison. -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getResourceId - () -

-
-
- - - -
-
- - - - -

Returns the remote Drive resource id associated with the resource. May be null for - local resources that have not yet been synchronized to the Drive service. -

- -
-
- - - - -
-

- - public - - - - - int - - getResourceType - () -

-
-
- - - -
-
- - - - -

Returns the resource type corresponding to this DriveId. Possible values are - RESOURCE_TYPE_FILE, RESOURCE_TYPE_FOLDER or RESOURCE_TYPE_UNKNOWN. - -

- The RESOURCE_TYPE_UNKNOWN will only be returned if the DriveId instance has - been created using decodeFromString(String), with an old string that was generated and - persisted by the client with an old version of Google Play Services. If the client is not - encoding, persisting and decoding DriveIds, this method will always return either - RESOURCE_TYPE_FILE or RESOURCE_TYPE_FOLDER. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - final - - - String - - toInvariantString - () -

-
-
- - - -
-
- - - - -

Returns an invariant string for this DriveId. This is stable over time, so for a - given DriveId, this value will always remain the same, and is guaranteed to be unique - for each DriveId. The client can use it directly to compare equality of - DriveIds, since two DriveIds are equal if and only if its invariant string - is equal. -

- Note: This value cannot be used to decodeFromString(String), since it's not meant - to encode a DriveId, but can be useful for client-side string-based DriveId - comparison, or for logging purposes. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

Returns a String representation of the ID. Use encodeToString() to obtain a - String representation that can decoded back to a DriveId. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.FileUploadPreferencesResult.html b/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.FileUploadPreferencesResult.html deleted file mode 100644 index 48902259f01d..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.FileUploadPreferencesResult.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DrivePreferencesApi.FileUploadPreferencesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DrivePreferencesApi.FileUploadPreferencesResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DrivePreferencesApi.FileUploadPreferencesResult
- - - - - - - -
- - -

Class Overview

-

Result that contains a FileUploadPreferences reference. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - FileUploadPreferences - - getFileUploadPreferences() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - FileUploadPreferences - - getFileUploadPreferences - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.html b/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.html deleted file mode 100644 index 1a3904f7801c..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DrivePreferencesApi.html +++ /dev/null @@ -1,1190 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DrivePreferencesApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

DrivePreferencesApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DrivePreferencesApi
- - - - - - - -
- - -

Class Overview

-

The entry point for retrieving and updating Drive preferences. The preferences set by these APIs - are applied only to the current user account and the calling application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDrivePreferencesApi.FileUploadPreferencesResult - Result that contains a FileUploadPreferences reference.  - - - -
- - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<DrivePreferencesApi.FileUploadPreferencesResult> - - getFileUploadPreferences(GoogleApiClient apiClient) - -
- Retrieves the file upload preferences for the file uploads performed by the calling - application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - setFileUploadPreferences(GoogleApiClient apiClient, FileUploadPreferences fileUploadPreferences) - -
- Sets the file upload preferences for the file uploads performed by the calling application. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<DrivePreferencesApi.FileUploadPreferencesResult> - - getFileUploadPreferences - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves the file upload preferences for the file uploads performed by the calling - application. These preferences control how the files that are created or edited by the - calling application are uploaded to the server from the current device. If the calling - application regularly uploads large files in the user's Drive, it is advisable to use these - preferences to control when the files should be uploaded to the server (based on network - connectivity or battery usage, etc.). See FileUploadPreferences for more details.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - setFileUploadPreferences - (GoogleApiClient apiClient, FileUploadPreferences fileUploadPreferences) -

-
-
- - - -
-
- - - - -

Sets the file upload preferences for the file uploads performed by the calling application. - These preferences control how the files that are created or edited by the calling application - are uploaded to the server from the current device. If the calling application regularly - uploads large files in the user's Drive, it is advisable to use these preferences to control - when the files should be uploaded to the server (based on network connectivity or battery - usage, etc.). See FileUploadPreferences for more details. - -

Note that the preferences will be applied to both future and pending file uploads - performed by the application. For example, if the application sets the preferences to upload - only on WiFi, and then uploads a file while the device is on mobile data, the file will not - be uploaded at that point. However, if later on the application changes the preferences to - upload on WiFi or mobile data, then the file becomes eligible to be uploaded.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this call.
fileUploadPreferences - The preferences to set for file upload operations.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveResource.MetadataResult.html b/docs/html/reference/com/google/android/gms/drive/DriveResource.MetadataResult.html deleted file mode 100644 index c8f7f70c5293..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveResource.MetadataResult.html +++ /dev/null @@ -1,1142 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveResource.MetadataResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DriveResource.MetadataResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveResource.MetadataResult
- - - - - - - -
- - -

Class Overview

-

Result that is returned in response to metadata requests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Metadata - - getMetadata() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Metadata - - getMetadata - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveResource.html b/docs/html/reference/com/google/android/gms/drive/DriveResource.html deleted file mode 100644 index ef01ea8ef214..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveResource.html +++ /dev/null @@ -1,1854 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveResource | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveResource

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.DriveResource
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

A Resource represents a file or folder in Drive. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDriveResource.MetadataResult - Result that is returned in response to metadata requests.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addChangeListener(GoogleApiClient apiClient, ChangeListener listener) - -
- Adds a new listener for changes on this resource. - - - -
- -
- abstract - - - - - PendingResult<Status> - - addChangeSubscription(GoogleApiClient apiClient) - -
- Adds a change subscription for this resource that will deliver events to the application - event service. - - - -
- -
- abstract - - - - - DriveId - - getDriveId() - -
- Returns the DriveId that uniquely identifies this resource. - - - -
- -
- abstract - - - - - PendingResult<DriveResource.MetadataResult> - - getMetadata(GoogleApiClient apiClient) - -
- Retrieves the Metadata associated with this resource. - - - -
- -
- abstract - - - - - PendingResult<DriveApi.MetadataBufferResult> - - listParents(GoogleApiClient apiClient) - -
- Retrieves a collection of metadata for all of the parents of this resource that the calling - app has been authorized to view. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeChangeListener(GoogleApiClient apiClient, ChangeListener listener) - -
- Removes a listener for changes on this resource that was previously added by - addChangeListener(GoogleApiClient, ChangeListener). - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeChangeSubscription(GoogleApiClient apiClient) - -
- Removes any existing change subscription for this resource. - - - -
- -
- abstract - - - - - PendingResult<Status> - - setParents(GoogleApiClient apiClient, Set<DriveId> parentIds) - -
- Sets the parents of this resource. - - - -
- -
- abstract - - - - - PendingResult<Status> - - trash(GoogleApiClient apiClient) - -
- Moves the resource to trash. - - - -
- -
- abstract - - - - - PendingResult<Status> - - untrash(GoogleApiClient apiClient) - -
- Moves the resource out of the trash. - - - -
- -
- abstract - - - - - PendingResult<DriveResource.MetadataResult> - - updateMetadata(GoogleApiClient apiClient, MetadataChangeSet changeSet) - -
- Updates the Metadata that is associated with this resource with the changes described - in the MetadataChangeSet. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addChangeListener - (GoogleApiClient apiClient, ChangeListener listener) -

-
-
- - - -
-
- - - - -

Adds a new listener for changes on this resource. The listener will remain active for - the duration of the current GoogleApiClient connection or until the - removeChangeListener(GoogleApiClient, ChangeListener) method is called with the same listener argument.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addChangeSubscription - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Adds a change subscription for this resource that will deliver events to the application - event service. The event service class implementation should contain an - implementation of ChangeListener and be - exported in the application manifest. The subscription is persistent until the next - device reboot and will be active until the removeChangeSubscription(GoogleApiClient) method is - called on the same resource.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Returns the DriveId that uniquely identifies this resource. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveResource.MetadataResult> - - getMetadata - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves the Metadata associated with this resource.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the Metadata when it is available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveApi.MetadataBufferResult> - - listParents - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Retrieves a collection of metadata for all of the parents of this resource that the calling - app has been authorized to view.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • A PendingResult which can be used to retrieve the parents list. Be sure to call - release() when you're done with the result. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeChangeListener - (GoogleApiClient apiClient, ChangeListener listener) -

-
-
- - - -
-
- - - - -

Removes a listener for changes on this resource that was previously added by - addChangeListener(GoogleApiClient, ChangeListener). -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeChangeSubscription - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Removes any existing change subscription for this resource. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - setParents - (GoogleApiClient apiClient, Set<DriveId> parentIds) -

-
-
- - - -
-
- - - - -

Sets the parents of this resource. If successful, the resource parent set will be changed to - the one specified in the parameter. The existing parent set will be overwritten. The caller - must make sure that the set contains all intended parents of the resource, including - existing parents that should remain as parents. - -

The parent set must contain at least one parent. All parents must be folders. - -

If this resource is in the App Folder or in one of its subfolders, all parents must also - belong to the App Folder or one of its subfolders. - -

If this resource is outside the App Folder every parent must also be outside the App - Folder. - -

This method is a generalized way of moving resources between folders.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
parentIds - The non-empty set of parents to move the item to. Do NOT modify the set - after calling this method. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - trash - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Moves the resource to trash. The user must be the owner. If the resource is a folder, the - app must have access to all descendants of the folder. - -

Resources inside the app folder cannot be trashed.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
-
-
-
Returns
-
  • A PendingResult which can be used to verify the success of the operation. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - untrash - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Moves the resource out of the trash. The user must be the owner. If the resource is a folder, - the app must have access to all descendants of the folder. - -

Resources inside the app folder cannot be untrashed (they cannot be trashed in the first - place).

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method.
-
-
-
Returns
-
  • A PendingResult which can be used to verify the success of the operation. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DriveResource.MetadataResult> - - updateMetadata - (GoogleApiClient apiClient, MetadataChangeSet changeSet) -

-
-
- - - -
-
- - - - -

Updates the Metadata that is associated with this resource with the changes described - in the MetadataChangeSet. - -

Note that the user must have edit access to update the metadata (see - isEditable()). Also, the metadata of the root folder cannot be updated.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected when this method is invoked.
changeSet - The set of changes that will be applied to the Metadata. Only include the - specific fields that should be updated.
-
-
-
Returns
-
  • A PendingResult which will return the updated Metadata when it is available. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/DriveStatusCodes.html b/docs/html/reference/com/google/android/gms/drive/DriveStatusCodes.html deleted file mode 100644 index 897ea2b5ce85..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/DriveStatusCodes.html +++ /dev/null @@ -1,1884 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DriveStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.drive.DriveStatusCodes
- - - - - - - -
- - -

Class Overview

-

Drive specific status codes, for use in getStatusCode(). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intDRIVE_CONTENTS_TOO_LARGE - The operation failed because the given contents exceeded the maximum allowed contents size. - - - -
intDRIVE_EXTERNAL_STORAGE_REQUIRED - - This constant is deprecated. - External storage is no longer required. - - - - -
intDRIVE_RATE_LIMIT_EXCEEDED - The operation failed because the application attempted the operation too often. - - - -
intDRIVE_RESOURCE_NOT_AVAILABLE - The operation failed because the requested resource does not exist or you are not authorized - to access it. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- Returns an untranslated debug (not user-friendly!) string based on the current status code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - DRIVE_CONTENTS_TOO_LARGE -

-
- - - - -
-
- - - - -

The operation failed because the given contents exceeded the maximum allowed contents size. -

- - -
- Constant Value: - - - 1508 - (0x000005e4) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DRIVE_EXTERNAL_STORAGE_REQUIRED -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- External storage is no longer required. - -

-

The Drive API requires external storage (such as an SD card), but no external storage is - mounted. This error is recoverable if the user installs external storage (if none is present) - and ensures that it is mounted (which may involve disabling USB storage mode, formatting the - storage, or other initialization as required by the device). - -

This error should never be returned on a device with emulated external storage. On devices - with emulated external storage, the emulated "external storage" is always present regardless - of whether the device also has removable storage.

- - -
- Constant Value: - - - 1500 - (0x000005dc) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DRIVE_RATE_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

The operation failed because the application attempted the operation too often. In general, - this is a temporary error and the operation may succeed once sufficient time has elapsed. - It is recommended that the application backs off with increasing duration every time the - operation fails with this error. -

- - -
- Constant Value: - - - 1507 - (0x000005e3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DRIVE_RESOURCE_NOT_AVAILABLE -

-
- - - - -
-
- - - - -

The operation failed because the requested resource does not exist or you are not authorized - to access it. -

- - -
- Constant Value: - - - 1502 - (0x000005de) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

Returns an untranslated debug (not user-friendly!) string based on the current status code. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.Builder.html b/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.Builder.html deleted file mode 100644 index 6b23f87eb2a9..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.Builder.html +++ /dev/null @@ -1,1604 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ExecutionOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

ExecutionOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.ExecutionOptions.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for creating a new ExecutionOptions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ExecutionOptions.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - ExecutionOptions - - build() - -
- - - - - - ExecutionOptions.Builder - - setConflictStrategy(int strategy) - -
- Sets a conflict resolution strategy for this action. - - - -
- -
- - - - - - ExecutionOptions.Builder - - setNotifyOnCompletion(boolean notify) - -
- Sets whether the client should be notified when the action associated with these - ExecutionOptions is applied on the server. - - - -
- -
- - - - - - ExecutionOptions.Builder - - setTrackingTag(String trackingTag) - -
- Sets a client-defined string that will be returned to the client through a completion - notification on DriveEventService after this - particular action either succeeds or fails when applied on the server. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ExecutionOptions.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - ExecutionOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - ExecutionOptions.Builder - - setConflictStrategy - (int strategy) -

-
-
- - - -
-
- - - - -

Sets a conflict resolution strategy for this action. - -

- The resulting behavior depends on the strategy selected. Check documentation on accepted - values (CONFLICT_STRATEGY_OVERWRITE_REMOTE and - CONFLICT_STRATEGY_KEEP_REMOTE) for more details.

-
-
Parameters
- - - - -
strategy - one of CONFLICT_STRATEGY_OVERWRITE_REMOTE and - CONFLICT_STRATEGY_KEEP_REMOTE
-
-
-
Returns
-
  • this builder -
-
- -
-
- - - - -
-

- - public - - - - - ExecutionOptions.Builder - - setNotifyOnCompletion - (boolean notify) -

-
-
- - - -
-
- - - - -

Sets whether the client should be notified when the action associated with these - ExecutionOptions is applied on the server. - -

- When clients set notify to true, they must also implement a - DriveEventService to receive the - completion event. See DriveEventService for - more details on how the service should be implemented and added to the manifest.

-
-
Parameters
- - - - -
notify - true if the API should deliver notifications about the completion of this - event to the client's DriveEventService, - false otherwise
-
-
-
Returns
-
  • this builder -
-
- -
-
- - - - -
-

- - public - - - - - ExecutionOptions.Builder - - setTrackingTag - (String trackingTag) -

-
-
- - - -
-
- - - - -

Sets a client-defined string that will be returned to the client through a completion - notification on DriveEventService after this - particular action either succeeds or fails when applied on the server. A notification - will only be delivered if setNotifyOnCompletion(boolean) is called. This tag may contain - any information that will be helpful to the caller in the event of a conflict or a - failure to apply an action on the server, for example, a commit identifier or a delta - representing the changes made in the commit.

-
-
Parameters
- - - - -
trackingTag - the tag that will be returned when a completion event is delivered - through DriveEventService. Must not be - null, and the length can never exceed MAX_TRACKING_TAG_STRING_LENGTH
-
-
-
Returns
-
  • this builder object -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.html b/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.html deleted file mode 100644 index d10aec5b5de2..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/ExecutionOptions.html +++ /dev/null @@ -1,1589 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ExecutionOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ExecutionOptions

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.ExecutionOptions
- - - - - - - -
- - -

Class Overview

-

Options that can be included with certain requests to the API to configure notification - and conflict resolution behavior. Use ExecutionOptions.Builder to create a new - ExecutionOptions object. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classExecutionOptions.Builder - A builder for creating a new ExecutionOptions.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCONFLICT_STRATEGY_KEEP_REMOTE - A conflict resolution strategy that keeps the remote version of the file instead of - overwriting it with the locally committed changes when a conflict is detected. - - - -
intCONFLICT_STRATEGY_OVERWRITE_REMOTE - A conflict resolution strategy that always overwrites any remote state and applies the - locally committed changes on top, even in case of conflicts. - - - -
intMAX_TRACKING_TAG_STRING_LENGTH - The maximum tracking tag size in string length. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - hashCode() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CONFLICT_STRATEGY_KEEP_REMOTE -

-
- - - - -
-
- - - - -

A conflict resolution strategy that keeps the remote version of the file instead of - overwriting it with the locally committed changes when a conflict is detected. - -

- When using this strategy, the caller must also request completion notifications, by calling - setNotifyOnCompletion(boolean). Then, in case of conflict the remote state of - the file will be preserved but through the CompletionEvent, the client will be able - to handle the conflict, access the locally committed changes that conflicted (and couldn't - be persisted on the server), and perform the desired conflict resolution with all the data. - See STATUS_CONFLICT for more information on how to resolve conflicts. - -

- This strategy can be used with DriveContents that were either opened in - MODE_READ_WRITE through open(GoogleApiClient, int, DriveFile.DownloadProgressListener), or reopened in - MODE_WRITE_ONLY but obtained through - reopenForWrite(GoogleApiClient). This is because the API can only - detect conflicts if the written contents are based upon a known revision. In both cases the - base revision is considered the one obtained through the first open(GoogleApiClient, int, DriveFile.DownloadProgressListener). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CONFLICT_STRATEGY_OVERWRITE_REMOTE -

-
- - - - -
-
- - - - -

A conflict resolution strategy that always overwrites any remote state and applies the - locally committed changes on top, even in case of conflicts. - -

- When this strategy is used, the Drive API will not even attempt to detect conflicts and will - always overwrite contents. This strategy can be used with DriveContents opened in any - mode (MODE_READ_ONLY, MODE_WRITE_ONLY or - MODE_READ_WRITE). -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_TRACKING_TAG_STRING_LENGTH -

-
- - - - -
-
- - - - -

The maximum tracking tag size in string length. -

- - -
- Constant Value: - - - 65536 - (0x00010000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/FileUploadPreferences.html b/docs/html/reference/com/google/android/gms/drive/FileUploadPreferences.html deleted file mode 100644 index 13ef20310a92..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/FileUploadPreferences.html +++ /dev/null @@ -1,1728 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FileUploadPreferences | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

FileUploadPreferences

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.FileUploadPreferences
- - - - - - - -
- - -

Class Overview

-

Represents the file upload preferences associated with the current account. The preferences set - by these APIs are applied only to the current user account and the calling application. - -

- For example, the preference values for the file upload operations of the calling - application can be fetched using getFileUploadPreferences(GoogleApiClient). These - preference values can be modified using setNetworkTypePreference(int), - setRoamingAllowed(boolean) or setBatteryUsagePreference(int) and then saved by executing the - setFileUploadPreferences(GoogleApiClient, FileUploadPreferences) method. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBATTERY_USAGE_CHARGING_ONLY - This value signifies that the operations by the calling application are allowed only when the - device is plugged into a power source. - - - -
intBATTERY_USAGE_UNRESTRICTED - This value signifies that the operations by the calling application are allowed immediately - without being restricted on the current battery status of the device. - - - -
intNETWORK_TYPE_ANY - This value signifies that the operations by the calling application are not restricted to any - specific network type and can be applied over any available network connection (i.e. - - - -
intNETWORK_TYPE_WIFI_ONLY - This value signifies that the operations by the calling application are allowed only over a - WIFI network connection. - - - -
intPREFERENCE_VALUE_UNKNOWN - This value signifies that the preference value is unknown to the calling application. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getBatteryUsagePreference() - -
- Returns the current battery usage preference value. - - - -
- -
- abstract - - - - - int - - getNetworkTypePreference() - -
- Returns the current network type preference value. - - - -
- -
- abstract - - - - - boolean - - isRoamingAllowed() - -
- Returns the current roaming preference value. - - - -
- -
- abstract - - - - - void - - setBatteryUsagePreference(int batteryUsagePreference) - -
- Sets the battery usage preference to be applied on operations performed by the calling - application. - - - -
- -
- abstract - - - - - void - - setNetworkTypePreference(int networkTypePreference) - -
- Sets the network type preference to be applied on operations performed by the calling - application. - - - -
- -
- abstract - - - - - void - - setRoamingAllowed(boolean allowRoaming) - -
- Sets whether the operations by the calling application are allowed while the device is on - roaming. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - BATTERY_USAGE_CHARGING_ONLY -

-
- - - - -
-
- - - - -

This value signifies that the operations by the calling application are allowed only when the - device is plugged into a power source. - Note that this restriction is applied in addition to the network type preferences, - see getNetworkTypePreference(). -

- - -
- Constant Value: - - - 257 - (0x00000101) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BATTERY_USAGE_UNRESTRICTED -

-
- - - - -
-
- - - - -

This value signifies that the operations by the calling application are allowed immediately - without being restricted on the current battery status of the device. - Note that this restriction is applied in addition to the network type preferences, - see getNetworkTypePreference(). -

- - -
- Constant Value: - - - 256 - (0x00000100) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NETWORK_TYPE_ANY -

-
- - - - -
-
- - - - -

This value signifies that the operations by the calling application are not restricted to any - specific network type and can be applied over any available network connection (i.e. WIFI, - mobile data etc). - Note that this restriction is applied in addition to the battery usage preferences, - see getBatteryUsagePreference(). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NETWORK_TYPE_WIFI_ONLY -

-
- - - - -
-
- - - - -

This value signifies that the operations by the calling application are allowed only over a - WIFI network connection. - Note that this restriction is applied in addition to the battery usage preferences, - see getBatteryUsagePreference(). -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PREFERENCE_VALUE_UNKNOWN -

-
- - - - -
-
- - - - -

This value signifies that the preference value is unknown to the calling application. This - value is returned only in the case when the preference is set to a value not available in - this version of the API but is added in a newer version of the API. It is advised to update - to the latest version of the API to get an appropriate preference value. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getBatteryUsagePreference - () -

-
-
- - - -
-
- - - - -

Returns the current battery usage preference value. This value can be one of the following: -

- The default value for this preference is BATTERY_USAGE_UNRESTRICTED. -

- Note: The value PREFERENCE_VALUE_UNKNOWN will be returned only in the case when the - preference is set to a value not available in this version of the API but is added in a newer - version of the API. It is advised to update to the latest version of the API to get an - appropriate preference value. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getNetworkTypePreference - () -

-
-
- - - -
-
- - - - -

Returns the current network type preference value. This value can be one of the following: -

- The default value for this preference is NETWORK_TYPE_ANY. -

- Note: The value PREFERENCE_VALUE_UNKNOWN will be returned only in the case when the - preference is set to a value not available in this version of the API but is added in a newer - version of the API. It is advised to update to the latest version of the API to get an - appropriate preference value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isRoamingAllowed - () -

-
-
- - - -
-
- - - - -

Returns the current roaming preference value. If true, operations performed by the - calling application are allowed while the device is on data roaming, otherwise not. The - default value for this preference is true. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - setBatteryUsagePreference - (int batteryUsagePreference) -

-
-
- - - -
-
- - - - -

Sets the battery usage preference to be applied on operations performed by the calling - application. The following battery usage preference values are allowed: -

- The preference value is only saved when setFileUploadPreferences(GoogleApiClient, FileUploadPreferences) - is called.

-
-
Throws
- - - - -
IllegalArgumentException - if the input is an invalid preference value. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setNetworkTypePreference - (int networkTypePreference) -

-
-
- - - -
-
- - - - -

Sets the network type preference to be applied on operations performed by the calling - application. The following network type preference values are allowed: -

- The preference value is only saved when setFileUploadPreferences(GoogleApiClient, FileUploadPreferences) - is called. -

- Note that this value does not override the system level data usage preferences - (https://support.google.com/nexus/answer/2819524) that the user might have set on their - devices, i.e. if mobile data is disabled in the system settings, the file uploads will not - happen on mobile network connection even if the file upload preference is set to - NETWORK_TYPE_ANY. However, if mobile data is enabled the value set in this - preference will be respected.

-
-
Throws
- - - - -
IllegalArgumentException - if the input is an invalid preference value. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - setRoamingAllowed - (boolean allowRoaming) -

-
-
- - - -
-
- - - - -

Sets whether the operations by the calling application are allowed while the device is on - roaming. The preference value is only saved when - setFileUploadPreferences(GoogleApiClient, FileUploadPreferences) is called. -

- Note that this value does not override the system level data usage preferences - (https://support.google.com/nexus/answer/2819524) that the user might have set on their - devices, i.e. if data roaming is disabled in the system setting, the file uploads will not be - allowed in roaming even if this preference is set to true. However if roaming is enabled, - this preference will be respected. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/Metadata.html b/docs/html/reference/com/google/android/gms/drive/Metadata.html deleted file mode 100644 index de3974acffa2..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/Metadata.html +++ /dev/null @@ -1,3293 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Metadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

Metadata

- - - - - extends Object
- - - - - - - implements - - Freezable<Metadata> - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.Metadata
- - - - - - - -
- - -

Class Overview

-

The details of a Drive file or folder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCONTENT_AVAILABLE_LOCALLY - The content is available on the device. - - - -
intCONTENT_NOT_AVAILABLE_LOCALLY - The content is not available on the device. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Metadata() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getAlternateLink() - -
- Returns a link for opening the file using a relevant Google editor or viewer. - - - -
- -
- - - - - - int - - getContentAvailability() - -
- Returns CONTENT_NOT_AVAILABLE_LOCALLY when the content is not available on - the device or CONTENT_AVAILABLE_LOCALLY when the content is available on the - device. - - - -
- -
- - - - - - Date - - getCreatedDate() - -
- Returns the create time for this resource. - - - -
- -
- - - - - - Map<CustomPropertyKey, String> - - getCustomProperties() - -
- Gets all custom properties and their associated values. - - - -
- -
- - - - - - String - - getDescription() - -
- A short description of the resource. - - - -
- -
- - - - - - DriveId - - getDriveId() - -
- Returns the id of the resource - - - -
- -
- - - - - - String - - getEmbedLink() - -
- A link for embedding the file. - - - -
- -
- - - - - - String - - getFileExtension() - -
- The file extension used when downloading this file. - - - -
- -
- - - - - - long - - getFileSize() - -
- The size of the file in bytes. - - - -
- -
- - - - - - Date - - getLastViewedByMeDate() - -
- Returns the last time this resource was viewed by the user or null if the user - never viewed this resource. - - - -
- -
- - - - - - String - - getMimeType() - -
- Returns the MIME type of the resource - - - -
- -
- - - - - - Date - - getModifiedByMeDate() - -
- Returns the last time this resource was modified by the user or null if the user - never modified this resource. - - - -
- -
- - - - - - Date - - getModifiedDate() - -
- Returns the last time this resource was modified by anyone. - - - -
- -
- - - - - - String - - getOriginalFilename() - -
- The original filename if the file was uploaded manually, or the original title if the file - was inserted through the API. - - - -
- -
- - - - - - long - - getQuotaBytesUsed() - -
- The number of quota bytes used by this file. - - - -
- -
- - - - - - Date - - getSharedWithMeDate() - -
- Returns the time at which this resource was shared with the user or null if the - user is the owner of this resource. - - - -
- -
- - - - - - String - - getTitle() - -
- Returns the title of the resource - - - -
- -
- - - - - - String - - getWebContentLink() - -
- A link for downloading the content of the file in a browser using cookie based - authentication. - - - -
- -
- - - - - - String - - getWebViewLink() - -
- A link only available on public folders for viewing their static web assets (HTML, CSS, JS, - etc) via Google Drive's Website Hosting. - - - -
- -
- - - - - - boolean - - isEditable() - -
- Returns true if this resource can be edited by the current user. - - - -
- -
- - - - - - boolean - - isExplicitlyTrashed() - -
- Returns true if this resource has been explicitly trashed, as opposed to recursively trashed. - - - -
- -
- - - - - - boolean - - isFolder() - -
- Returns true if this Metadata is for a folder. - - - -
- -
- - - - - - boolean - - isInAppFolder() - -
- Returns true if this resource is in the Application Folder. - - - -
- -
- - - - - - boolean - - isPinnable() - -
- Returns true if the resource can be pinned. - - - -
- -
- - - - - - boolean - - isPinned() - -
- Returns true if this resource has been pinned (a request has been made to make the content - available offline). - - - -
- -
- - - - - - boolean - - isRestricted() - -
- Whether viewers are prevented from downloading this file. - - - -
- -
- - - - - - boolean - - isShared() - -
- Returns true if this resource is a shared resource. - - - -
- -
- - - - - - boolean - - isStarred() - -
- Returns true if this resource is starred by the user. - - - -
- -
- - - - - - boolean - - isTrashable() - -
- Returns true if this resource can be trashed by this user. - - - -
- -
- - - - - - boolean - - isTrashed() - -
- Returns true if this resource has been trashed. - - - -
- -
- - - - - - boolean - - isViewed() - -
- Whether this file has been viewed by this user. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CONTENT_AVAILABLE_LOCALLY -

-
- - - - -
-
- - - - -

The content is available on the device. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CONTENT_NOT_AVAILABLE_LOCALLY -

-
- - - - -
-
- - - - -

The content is not available on the device. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Metadata - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getAlternateLink - () -

-
-
- - - -
-
- - - - -

Returns a link for opening the file using a relevant Google editor or viewer. -

- -
-
- - - - -
-

- - public - - - - - int - - getContentAvailability - () -

-
-
- - - -
-
- - - - -

Returns CONTENT_NOT_AVAILABLE_LOCALLY when the content is not available on - the device or CONTENT_AVAILABLE_LOCALLY when the content is available on the - device. -

- -
-
- - - - -
-

- - public - - - - - Date - - getCreatedDate - () -

-
-
- - - -
-
- - - - -

Returns the create time for this resource. -

- -
-
- - - - -
-

- - public - - - - - Map<CustomPropertyKey, String> - - getCustomProperties - () -

-
-
- - - -
-
- - - - -

Gets all custom properties and their associated values. -

- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

A short description of the resource. -

- -
-
- - - - -
-

- - public - - - - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Returns the id of the resource

- -
-
- - - - -
-

- - public - - - - - String - - getEmbedLink - () -

-
-
- - - -
-
- - - - -

A link for embedding the file. -

- -
-
- - - - -
-

- - public - - - - - String - - getFileExtension - () -

-
-
- - - -
-
- - - - -

The file extension used when downloading this file. -

- -
-
- - - - -
-

- - public - - - - - long - - getFileSize - () -

-
-
- - - -
-
- - - - -

The size of the file in bytes. Will return 0 for a folder. - -

This is only populated for files with content stored in Drive. -

- -
-
- - - - -
-

- - public - - - - - Date - - getLastViewedByMeDate - () -

-
-
- - - -
-
- - - - -

Returns the last time this resource was viewed by the user or null if the user - never viewed this resource. -

- -
-
- - - - -
-

- - public - - - - - String - - getMimeType - () -

-
-
- - - -
-
- - - - -

Returns the MIME type of the resource

- -
-
- - - - -
-

- - public - - - - - Date - - getModifiedByMeDate - () -

-
-
- - - -
-
- - - - -

Returns the last time this resource was modified by the user or null if the user - never modified this resource. -

- -
-
- - - - -
-

- - public - - - - - Date - - getModifiedDate - () -

-
-
- - - -
-
- - - - -

Returns the last time this resource was modified by anyone. -

- -
-
- - - - -
-

- - public - - - - - String - - getOriginalFilename - () -

-
-
- - - -
-
- - - - -

The original filename if the file was uploaded manually, or the original title if the file - was inserted through the API. -

- -
-
- - - - -
-

- - public - - - - - long - - getQuotaBytesUsed - () -

-
-
- - - -
-
- - - - -

The number of quota bytes used by this file. Will return 0 for a folder. -

- -
-
- - - - -
-

- - public - - - - - Date - - getSharedWithMeDate - () -

-
-
- - - -
-
- - - - -

Returns the time at which this resource was shared with the user or null if the - user is the owner of this resource. -

- -
-
- - - - -
-

- - public - - - - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Returns the title of the resource

- -
-
- - - - -
-

- - public - - - - - String - - getWebContentLink - () -

-
-
- - - -
-
- - - - -

A link for downloading the content of the file in a browser using cookie based - authentication. -

- -
-
- - - - -
-

- - public - - - - - String - - getWebViewLink - () -

-
-
- - - -
-
- - - - -

A link only available on public folders for viewing their static web assets (HTML, CSS, JS, - etc) via Google Drive's Website Hosting. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isEditable - () -

-
-
- - - -
-
- - - - -

Returns true if this resource can be edited by the current user. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isExplicitlyTrashed - () -

-
-
- - - -
-
- - - - -

Returns true if this resource has been explicitly trashed, as opposed to recursively trashed. - This will return false if the file is not trashed. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isFolder - () -

-
-
- - - -
-
- - - - -

Returns true if this Metadata is for a folder. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isInAppFolder - () -

-
-
- - - -
-
- - - - -

Returns true if this resource is in the Application Folder. - -

The App Folder contains hidden files stored in a user's Drive that are only - accessible to the creating app. @see - https://developers.google.com/drive/appdata -

- -
-
- - - - -
-

- - public - - - - - boolean - - isPinnable - () -

-
-
- - - -
-
- - - - -

Returns true if the resource can be pinned. Folders and some shortcut app MIME types are - pinnable. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isPinned - () -

-
-
- - - -
-
- - - - -

Returns true if this resource has been pinned (a request has been made to make the content - available offline). -

- -
-
- - - - -
-

- - public - - - - - boolean - - isRestricted - () -

-
-
- - - -
-
- - - - -

Whether viewers are prevented from downloading this file. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isShared - () -

-
-
- - - -
-
- - - - -

Returns true if this resource is a shared resource. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isStarred - () -

-
-
- - - -
-
- - - - -

Returns true if this resource is starred by the user. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isTrashable - () -

-
-
- - - -
-
- - - - -

Returns true if this resource can be trashed by this user. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isTrashed - () -

-
-
- - - -
-
- - - - -

Returns true if this resource has been trashed. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isViewed - () -

-
-
- - - -
-
- - - - -

Whether this file has been viewed by this user. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/MetadataBuffer.html b/docs/html/reference/com/google/android/gms/drive/MetadataBuffer.html deleted file mode 100644 index 7bb4bf0a627d..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/MetadataBuffer.html +++ /dev/null @@ -1,1938 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MetadataBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MetadataBuffer

- - - - - - - - - extends AbstractDataBuffer<Metadata>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.drive.Metadata>
    ↳com.google.android.gms.drive.MetadataBuffer
- - - - - - - -
- - -

Class Overview

-

A data buffer that points to Metadata entries. Objects of this class are returned in responses to - list requests (such as query(GoogleApiClient, Query)). This object behaves as an Iterable, as - well as allowing indexed access to its entries. Be sure to call release() on any buffers - when you are done with them. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Metadata - - get(int row) - -
- Get the item at the specified position. - - - -
- -
- - - - - - String - - getNextPageToken() - -
- - This method is deprecated. - Paging is not supported, so this always returns null. - - - - -
- -
- - - - - - void - - release() - -
- Releases resources used by the buffer. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Metadata - - get - (int row) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
row - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getNextPageToken - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Paging is not supported, so this always returns null. - -

-

- -
-
- - - - -
-

- - public - - - - - void - - release - () -

-
-
- - - -
-
- - - - -

Releases resources used by the buffer. This method is idempotent. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.Builder.html b/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.Builder.html deleted file mode 100644 index e84fe8087f42..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.Builder.html +++ /dev/null @@ -1,1948 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MetadataChangeSet.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

MetadataChangeSet.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.MetadataChangeSet.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for creating a new MetadataChangeSet. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MetadataChangeSet.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MetadataChangeSet - - build() - -
- - - - - - MetadataChangeSet.Builder - - deleteCustomProperty(CustomPropertyKey key) - -
- Deletes the given custom property of the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setCustomProperty(CustomPropertyKey key, String value) - -
- Sets a Custom File Property for the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setDescription(String description) - -
- Sets the description for the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setIndexableText(String text) - -
- Sets the text to be indexed for the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setLastViewedByMeDate(Date date) - -
- Sets the date when the user most recently viewed the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setMimeType(String mimeType) - -
- Sets a MIME type for the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setPinned(boolean pinned) - -
- If true, the file's contents will be kept up to date locally and thus the contents - will be available when the device is offline. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setStarred(boolean starred) - -
- Sets whether the resource will be starred. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setTitle(String title) - -
- Sets the title for the resource. - - - -
- -
- - - - - - MetadataChangeSet.Builder - - setViewed(boolean viewed) - -
- Sets whether the resource has been viewed. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MetadataChangeSet.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MetadataChangeSet - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - deleteCustomProperty - (CustomPropertyKey key) -

-
-
- - - -
-
- - - - -

Deletes the given custom property of the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setCustomProperty - (CustomPropertyKey key, String value) -

-
-
- - - -
-
- - - - -

Sets a Custom File Property for the resource. -

- Note that the total size of the key string and the value string of a custom property - should not exceed CUSTOM_PROPERTY_SIZE_LIMIT_BYTES bytes in UTF-8 encoding. As - the default charset on Android is UTF-8, the byte length of a string in UTF-8 encoding - can be calculated simply by using stringObject.getBytes().length (See - http://developer.android.com/reference/java/lang/String.html#getBytes()) - Also, note that there are limits on the number of custom properties a resource can have. - See MAX_PUBLIC_PROPERTIES_PER_RESOURCE, - MAX_PRIVATE_PROPERTIES_PER_RESOURCE_PER_APP and - MAX_TOTAL_PROPERTIES_PER_RESOURCE for details. If these limits are exceeded, the - operation to apply this metadata change will fail. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

Sets the description for the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setIndexableText - (String text) -

-
-
- - - -
-
- - - - -

Sets the text to be indexed for the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setLastViewedByMeDate - (Date date) -

-
-
- - - -
-
- - - - -

Sets the date when the user most recently viewed the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setMimeType - (String mimeType) -

-
-
- - - -
-
- - - - -

Sets a MIME type for the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setPinned - (boolean pinned) -

-
-
- - - -
-
- - - - -

If true, the file's contents will be kept up to date locally and thus the contents - will be available when the device is offline. Pinning a file uses bandwidth and storage - space, so it should only be done in response to an explicit user request. - -

Note that only files where - isPinnable() is true can be pinned. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setStarred - (boolean starred) -

-
-
- - - -
-
- - - - -

Sets whether the resource will be starred. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setTitle - (String title) -

-
-
- - - -
-
- - - - -

Sets the title for the resource. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet.Builder - - setViewed - (boolean viewed) -

-
-
- - - -
-
- - - - -

Sets whether the resource has been viewed. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.html b/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.html deleted file mode 100644 index 8c3570c9e765..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/MetadataChangeSet.html +++ /dev/null @@ -1,2086 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MetadataChangeSet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MetadataChangeSet

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.MetadataChangeSet
- - - - - - - -
- - -

Class Overview

-

A collection of metadata changes. Any fields with null values will retain their current value. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMetadataChangeSet.Builder - A builder for creating a new MetadataChangeSet.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCUSTOM_PROPERTY_SIZE_LIMIT_BYTES - The limit on the total number of bytes (in UTF-8 encoding) of the key string and the value - string together. - - - -
intINDEXABLE_TEXT_SIZE_LIMIT_BYTES - The limit on the indexable text size in bytes (for UTF-8 encoding). - - - -
intMAX_PRIVATE_PROPERTIES_PER_RESOURCE_PER_APP - The maximum number of private properties an application can have on a Drive resource. - - - -
intMAX_PUBLIC_PROPERTIES_PER_RESOURCE - The maximum number of public properties allowed on a Drive resource. - - - -
intMAX_TOTAL_PROPERTIES_PER_RESOURCE - The maximum number of properties allowed on a Drive resource. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Map<CustomPropertyKey, String> - - getCustomPropertyChangeMap() - -
- Returns a map that defines the custom property changes for the resource. - - - -
- -
- - - - - - String - - getDescription() - -
- Returns the new description for the resource or null if unchanged. - - - -
- -
- - - - - - String - - getIndexableText() - -
- Returns the new text to be indexed for the resource or null if unchanged. - - - -
- -
- - - - - - Date - - getLastViewedByMeDate() - -
- Returns the date which will be recorded as when the user most recently viewed the resource or - null if unchanged. - - - -
- -
- - - - - - String - - getMimeType() - -
- Returns the new MIME type for the resource or null if unchanged. - - - -
- -
- - - - - - String - - getTitle() - -
- Returns the new title for the resource or null if unchanged. - - - -
- -
- - - - - - Boolean - - isPinned() - -
- Returns the new pinned state for the resource or null if unchanged. - - - -
- -
- - - - - - Boolean - - isStarred() - -
- Returns the new starred state for the resource or null if unchanged. - - - -
- -
- - - - - - Boolean - - isViewed() - -
- Returns the new viewed state for the resource or null if unchanged. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CUSTOM_PROPERTY_SIZE_LIMIT_BYTES -

-
- - - - -
-
- - - - -

The limit on the total number of bytes (in UTF-8 encoding) of the key string and the value - string together. -

- - -
- Constant Value: - - - 124 - (0x0000007c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INDEXABLE_TEXT_SIZE_LIMIT_BYTES -

-
- - - - -
-
- - - - -

The limit on the indexable text size in bytes (for UTF-8 encoding). - See: https://developers.google.com/drive/web/file -

- - -
- Constant Value: - - - 131072 - (0x00020000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_PRIVATE_PROPERTIES_PER_RESOURCE_PER_APP -

-
- - - - -
-
- - - - -

The maximum number of private properties an application can have on a Drive resource. -

- - -
- Constant Value: - - - 30 - (0x0000001e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_PUBLIC_PROPERTIES_PER_RESOURCE -

-
- - - - -
-
- - - - -

The maximum number of public properties allowed on a Drive resource. -

- - -
- Constant Value: - - - 30 - (0x0000001e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_TOTAL_PROPERTIES_PER_RESOURCE -

-
- - - - -
-
- - - - -

The maximum number of properties allowed on a Drive resource. This includes the public - properties on the resource as well as the private properties from all the applications having - access to this Drive resource. -

- - -
- Constant Value: - - - 100 - (0x00000064) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Map<CustomPropertyKey, String> - - getCustomPropertyChangeMap - () -

-
-
- - - -
-
- - - - -

Returns a map that defines the custom property changes for the resource. The map is from the - property keys to the new or updated values. Null values correspond to properties that are - going to be deleted. -

- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Returns the new description for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - String - - getIndexableText - () -

-
-
- - - -
-
- - - - -

Returns the new text to be indexed for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - Date - - getLastViewedByMeDate - () -

-
-
- - - -
-
- - - - -

Returns the date which will be recorded as when the user most recently viewed the resource or - null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - String - - getMimeType - () -

-
-
- - - -
-
- - - - -

Returns the new MIME type for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Returns the new title for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - Boolean - - isPinned - () -

-
-
- - - -
-
- - - - -

Returns the new pinned state for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - Boolean - - isStarred - () -

-
-
- - - -
-
- - - - -

Returns the new starred state for the resource or null if unchanged. -

- -
-
- - - - -
-

- - public - - - - - Boolean - - isViewed - () -

-
-
- - - -
-
- - - - -

Returns the new viewed state for the resource or null if unchanged. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/OpenFileActivityBuilder.html b/docs/html/reference/com/google/android/gms/drive/OpenFileActivityBuilder.html deleted file mode 100644 index 88a78cfd27a9..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/OpenFileActivityBuilder.html +++ /dev/null @@ -1,1603 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OpenFileActivityBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

OpenFileActivityBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.OpenFileActivityBuilder
- - - - - - - -
- - -

Class Overview

-

A builder that is used to configure and display the open file activity. This activity displays - files and folders from the user's Drive. The activity can be used to display all files in the - Drive, not just those your application has access to. Your application will be given access to - the selected file. - -

- To display the activity, pass the result of build(GoogleApiClient) to - #startIntentSenderForResult(). - When the activity completes, a successful response will include an extra - EXTRA_RESPONSE_DRIVE_ID with the selected DriveId. - -

- Note: you cannot use #startActivity to invoke the activity. This will fail. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_RESPONSE_DRIVE_ID - A successful result will return an extra by this name which will contain the DriveId - of the selected file. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - IntentSender - - build(GoogleApiClient apiClient) - -
- Builds an IntentSender from the builder attributes that can be used to start the Open - File activity using - startIntentSenderForResult(IntentSender, int, Intent, int, int, int). - - - -
- -
- - - - - - OpenFileActivityBuilder - - setActivityStartFolder(DriveId folder) - -
- Sets the folder that the Activity will display initially. - - - -
- -
- - - - - - OpenFileActivityBuilder - - setActivityTitle(String title) - -
- Sets the title displayed in the activity. - - - -
- -
- - - - - - OpenFileActivityBuilder - - setMimeType(String[] mimeTypes) - -
- Sets the MIME type filter which controls which kinds of files can be selected from the file - picker. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_RESPONSE_DRIVE_ID -

-
- - - - -
-
- - - - -

A successful result will return an extra by this name which will contain the DriveId - of the selected file. -

- - -
- Constant Value: - - - "response_drive_id" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - IntentSender - - build - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Builds an IntentSender from the builder attributes that can be used to start the Open - File activity using - startIntentSenderForResult(IntentSender, int, Intent, int, int, int).

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. The client must be - connected before invoking this method. -
-
- -
-
- - - - -
-

- - public - - - - - OpenFileActivityBuilder - - setActivityStartFolder - (DriveId folder) -

-
-
- - - -
-
- - - - -

Sets the folder that the Activity will display initially. If not specified, it will default - to the root of "My Drive". -

- -
-
- - - - -
-

- - public - - - - - OpenFileActivityBuilder - - setActivityTitle - (String title) -

-
-
- - - -
-
- - - - -

Sets the title displayed in the activity.

-
-
Parameters
- - - - -
title - the title to set on the activity (may not be null) -
-
- -
-
- - - - -
-

- - public - - - - - OpenFileActivityBuilder - - setMimeType - (String[] mimeTypes) -

-
-
- - - -
-
- - - - -

Sets the MIME type filter which controls which kinds of files can be selected from the file - picker. If this method is not called or if a zero-length array is provided, all non-folder - files will be selectable.

-
-
Parameters
- - - - -
mimeTypes - the mime types to show in the picker. May not be null. If a zero-length - array is provided, all non-folder files will be selectable -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/ChangeEvent.html b/docs/html/reference/com/google/android/gms/drive/events/ChangeEvent.html deleted file mode 100644 index 2551a8eec14e..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/ChangeEvent.html +++ /dev/null @@ -1,1896 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChangeEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ChangeEvent

- - - - - extends Object
- - - - - - - implements - - ResourceEvent - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.events.ChangeEvent
- - - - - - - -
- - -

Class Overview

-

Sent when a DriveResource has had a change to its DriveContents or - Metadata. Refer to DriveEvent for additional information about event listeners. - - Refer to DriveEvent for general information about event listeners and - addChangeListener(GoogleApiClient, ChangeListener) for how to create them. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<ChangeEvent>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - DriveId - - getDriveId() - -
- Returns the id of the Drive resource that triggered the event. - - - -
- -
- - - - - - boolean - - hasBeenDeleted() - -
- Returns true if the resource has been deleted. - - - -
- -
- - - - - - boolean - - hasContentChanged() - -
- Returns true if the content has changed for this resource. - - - -
- -
- - - - - - boolean - - hasMetadataChanged() - -
- Returns true if the metadata has changed for this resource. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.drive.events.ResourceEvent - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<ChangeEvent> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Returns the id of the Drive resource that triggered the event. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasBeenDeleted - () -

-
-
- - - -
-
- - - - -

Returns true if the resource has been deleted. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasContentChanged - () -

-
-
- - - -
-
- - - - -

Returns true if the content has changed for this resource. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasMetadataChanged - () -

-
-
- - - -
-
- - - - -

Returns true if the metadata has changed for this resource. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/ChangeListener.html b/docs/html/reference/com/google/android/gms/drive/events/ChangeListener.html deleted file mode 100644 index 9c2f920decff..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/ChangeListener.html +++ /dev/null @@ -1,1112 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

ChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.events.ChangeListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Event listener interface for ChangeEvent. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onChange(ChangeEvent event) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onChange - (ChangeEvent event) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/CompletionEvent.html b/docs/html/reference/com/google/android/gms/drive/events/CompletionEvent.html deleted file mode 100644 index 41bedf962c9e..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/CompletionEvent.html +++ /dev/null @@ -1,2557 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CompletionEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CompletionEvent

- - - - - extends Object
- - - - - - - implements - - ResourceEvent - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.events.CompletionEvent
- - - - - - - -
- - -

Class Overview

-

An event delivered after the client requests a completion notification using - setNotifyOnCompletion(boolean) and that action has either succeeded or - failed on the server. - - Refer to DriveEvent for additional information about event listeners and subscriptions. - -

- Completion events are only delivered to the application that committed the original request. If - the original change modified the metadata or content of the file and the action failed to - complete on the server, this class provides access to the modified versions of the metadata and - content that could not be committed. - -

- Once the event has been handled by the application, dismiss() should be - called so the Drive API can release any associated resources. Drive will delete this data after - dismiss() has been called or the device reboots, so if an application requires longer - term access to this data (for example, persistence of data across device reboot), the app must - copy and persist any data they want to keep. One way to persist this data is to save it in a file - using the Drive API. - -

- Multiple actions by the same application on the same resource may be collapsed by the Drive API. - In this case the event may refer to multiple collapsed actions. The - InputStream provided by getBaseContentsInputStream() will be the very - first base version of the content and the InputStream provided by - getModifiedContentsInputStream() will be the very last written version of the content. - The tags returned by getTrackingTags() will all be values provided to - commit(GoogleApiClient, MetadataChangeSet, ExecutionOptions) through the - ExecutionOptions parameter, following the same order in which actions were applied. - -

- For every event received the client must call either dismiss() or snooze() - in order to release the event instance. Dismiss indicates that the application has finished - interacting with the event. Snooze indicates that the application could not process the event - at the current time and wants to be notified again of the same event in the future. - -

- If neither dismiss() nor snooze() is invoked within a short period of time after - event notification, it is assumed that the event was not delivered to the client. In such a - situation, the event may be notified again later. In order to observe a reliable notification - behavior, the client must always dismiss or snooze every event received. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATUS_CANCELED - Status code indicating that the action referenced by this event was canceled as a result - of cancelPendingActions(GoogleApiClient, List). - - - -
intSTATUS_CONFLICT - Status code indicating that the action referenced by this event has failed to be applied on - the server because of a conflict. - - - -
intSTATUS_FAILURE - Status code indicating that the action referenced by this event has permanently failed to be - applied on the server. - - - -
intSTATUS_SUCCESS - Status code indicating that the action referenced by this event has successfully been applied - on the server. - - - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<CompletionEvent>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - void - - dismiss() - -
- Indicates to the Drive API that the caller has finished interacting with this event and any - related resources should be cleaned up. - - - -
- -
- - - - - - String - - getAccountName() - -
- Returns the account name that was used by the GoogleApiClient that requested this - notification, or null if the default account was used. - - - -
- -
- - - - - - InputStream - - getBaseContentsInputStream() - -
- Returns an InputStream for the initial contents of a file, in the case of a - notification with status STATUS_CONFLICT. - - - -
- -
- - - - - - DriveId - - getDriveId() - -
- Returns the id of the Drive resource that triggered the event. - - - -
- -
- - - - - - InputStream - - getModifiedContentsInputStream() - -
- Returns an InputStream for the modified contents that generated this - event. - - - -
- -
- - - - - - MetadataChangeSet - - getModifiedMetadataChangeSet() - -
- Returns the MetadataChangeSet that was committed during the update that generated - this event. - - - -
- -
- - - - - - int - - getStatus() - -
- Returns a status indicating the result of the action that generated this event. - - - -
- -
- - - - - - List<String> - - getTrackingTags() - -
- Returns a List of tracking tags provided through - setTrackingTag(String). - - - -
- -
- - - - - - void - - snooze() - -
- Indicates that the client could not process the event at the current time, for example - because of connectivity issues. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.drive.events.ResourceEvent - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATUS_CANCELED -

-
- - - - -
-
- - - - -

Status code indicating that the action referenced by this event was canceled as a result - of cancelPendingActions(GoogleApiClient, List). A canceled action was not applied on the server - and was reverted locally. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_CONFLICT -

-
- - - - -
-
- - - - -

Status code indicating that the action referenced by this event has failed to be applied on - the server because of a conflict. A conflict originates from commit(GoogleApiClient, MetadataChangeSet). - - When this status code is provided, the metadata and contents that were changed in the - original action (if applicable) will be provided through - getModifiedMetadataChangeSet() and getModifiedContentsInputStream(), - respectively, so that the client can retrieve the data that has failed to upload. - -

- This event provides the context in which a conflict originated, so it can be fixed by the - application that caused it. File conflicts are only delivered to the application that - committed a change resulting in a conflict, and that application is responsible for resolving - the conflict (or the conflicting changes will not be committed). - -

- This class provides access to the base content of the file (the content at the time - the file was opened to make the changes in the commit) and the modified metadata and content - (that could not be committed due to the conflict). The current metadata and content (the - newer values that conflicted with the modified metadata and content) can be obtained using - the standard Drive API. - -

- A conflict can be fixed by committing the metadata or content again, possibly with modified - further changes that resulted from analyzing the information provided by this class. - commit(GoogleApiClient, MetadataChangeSet) should be used to commit a conflict resolution. If no such - commit is made, the original changes that produced the conflict will be dropped and the - current metadata and contents will remain unchanged. - -

- Once the conflict has been fixed by the application, dismiss() should be - called so the Drive API can release conflicting resources. If an application requires longer - term access to this conflict data (for example persistence of the conflict data across device - reboot), the app should handle the persistence of any conflict data provided here, since - Drive will delete this conflict data after dismiss() has been called. - -

- Multiple commits by the same application on the same resource may be collapsed by the Drive - API. In this case the conflict may refer to multiple collapsed commits. The - InputStream provided by getBaseContentsInputStream() will be the very first - base version of the content and the InputStream provided by - getModifiedContentsInputStream() will be the very last written version of the - content. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_FAILURE -

-
- - - - -
-
- - - - -

Status code indicating that the action referenced by this event has permanently failed to be - applied on the server. When this status code is provided, the metadata and contents that were - changed in the original action (if applicable) will be provided through - getModifiedMetadataChangeSet() and getModifiedContentsInputStream(), - respectively, so that the client can retrieve the data that has failed to upload. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SUCCESS -

-
- - - - -
-
- - - - -

Status code indicating that the action referenced by this event has successfully been applied - on the server. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<CompletionEvent> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - dismiss - () -

-
-
- - - -
-
- - - - -

Indicates to the Drive API that the caller has finished interacting with this event and any - related resources should be cleaned up. The client may not continue using this event instance - after dismissing. -

- -
-
- - - - -
-

- - public - - - - - String - - getAccountName - () -

-
-
- - - -
-
- - - - -

Returns the account name that was used by the GoogleApiClient that requested this - notification, or null if the default account was used. - -

- This method is provided so that when a completion event is delivered, the correct - GoogleApiClient can be built to work with the file. -

- -
-
- - - - -
-

- - public - - - - - InputStream - - getBaseContentsInputStream - () -

-
-
- - - -
-
- - - - -

Returns an InputStream for the initial contents of a file, in the case of a - notification with status STATUS_CONFLICT. Returns null for any other status - but STATUS_CONFLICT. - -

- This version of the file content is not the current version anymore. In order to get the - current version during conflict resolution, the normal flow to read contents should be used. - This method may only be called once per CompletionEvent instance. - -

- This can be used in conjunction with getModifiedContentsInputStream() in order to - compute the incremental changes that conflicted, so those can be reapplied on top of the - current version. - -

- The returned InputStream can be used until dismiss() or snooze() is - called. -

- -
-
- - - - -
-

- - public - - - - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Returns the id of the Drive resource that triggered the event. -

- -
-
- - - - -
-

- - public - - - - - InputStream - - getModifiedContentsInputStream - () -

-
-
- - - -
-
- - - - -

Returns an InputStream for the modified contents that generated this - event. If the status of this event is not STATUS_SUCCESS, note that the modified - contents provided by this method have not been applied on the server. - This method may only be called once per CompletionEvent instance. - -

- The returned InputStream can be used until dismiss() or snooze() is - called. -

- -
-
- - - - -
-

- - public - - - - - MetadataChangeSet - - getModifiedMetadataChangeSet - () -

-
-
- - - -
-
- - - - -

Returns the MetadataChangeSet that was committed during the update that generated - this event. The value may be null if the action didn't contain metadata changes. The - current metadata can be obtained using getFile and - getMetadata and be compared with this - MetadataChangeSet. If the event has a status other than STATUS_SUCCESS, - note that the changes in this change set have not been applied on the server and have been - reverted locally. - -

- Modifying the returned MetadataChangeSet will not have any effect unless the set is - committed through commit(GoogleApiClient, MetadataChangeSet). -

- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns a status indicating the result of the action that generated this event. May be one - of STATUS_SUCCESS, STATUS_CONFLICT, STATUS_FAILURE, - STATUS_CANCELED. -

- -
-
- - - - -
-

- - public - - - - - List<String> - - getTrackingTags - () -

-
-
- - - -
-
- - - - -

Returns a List of tracking tags provided through - setTrackingTag(String). The application can use these tags to relate - this event with the specific method execution that generated it. - -

- If the list contains multiple elements, the ordering of the elements is guaranteed to be the - one in which the collapsed modifications were applied. Elements in the returned list may not - be null. -

- -
-
- - - - -
-

- - public - - - - - void - - snooze - () -

-
-
- - - -
-
- - - - -

Indicates that the client could not process the event at the current time, for example - because of connectivity issues. The client will be notified again of the same event in the - future. The client may not continue using this event instance after snoozing. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/CompletionListener.html b/docs/html/reference/com/google/android/gms/drive/events/CompletionListener.html deleted file mode 100644 index 866ce540922e..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/CompletionListener.html +++ /dev/null @@ -1,1112 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CompletionListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

CompletionListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.events.CompletionListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Event listener interface for CompletionEvent. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onCompletion(CompletionEvent event) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onCompletion - (CompletionEvent event) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/DriveEvent.html b/docs/html/reference/com/google/android/gms/drive/events/DriveEvent.html deleted file mode 100644 index 2bc26fc0d07c..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/DriveEvent.html +++ /dev/null @@ -1,1246 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DriveEvent

- - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.events.DriveEvent
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface implemented by all Drive event types. An application can express interest in - receiving events by adding an event listener or declaring an event listener service. -

- An event listener implements the listener interface for a particular event type and - receives a direct callback from the Drive service to the client application that is - currently connected. A listener is added by calling the appropriate - addListener method on the DriveResource of interest. Listeners are - active for the duration of the current connection or until the removeListener - method is called on the same entity with the same callback parameter. -

- An event service must be declared in an application's manifest to indicate that an application is - interested in receiving events via bound service AIDL calls on the event service, even if the - application is not currently connected or even running. -

- A subscription is added by calling the appropriate - addSubscription method on the DriveResource of interest. - Subscriptions are active until the removeSubscription method is called on the - same entity or until the next device reboot. An application that is interested in maintaining - any subscriptions across reboots should handle the - ACTION_BOOT_COMPLETED intent to add back these subscriptions after - the reboot has completed. -

- Some event types will also support the ability to request event delivery using the - ExecutionOptions parameter that is passed to a Drive API - call. This will indicate that the requested events be delivered to the event service for as - long as the operation is active, i.e. until it has successfully completed or permanently failed. -

- Events will be delivered to all registered listeners, subscribers, and/or enabled operations - that match the event. The same event may be delivered to more than one listener or service - when appropriate. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/DriveEventService.html b/docs/html/reference/com/google/android/gms/drive/events/DriveEventService.html deleted file mode 100644 index ae0c9d2cd5c2..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/DriveEventService.html +++ /dev/null @@ -1,6737 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriveEventService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - | Protected Ctors - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

DriveEventService

- - - - - - - - - - - - - - - - - extends Service
- - - - - - - implements - - ChangeListener - - CompletionListener - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.drive.events.DriveEventService
- - - - - - - -
- - -

Class Overview

-

Abstract base class for a bound service that handles Drive events. These events will be - delivered using AIDL calls to the service. The base class handles binding and handling of these - calls and will raise listener events on the subclass. -

- Subclasses should override one or more of the following interfaces depending upon the event - types that expected by the application: -

- -

- The default implementation of all listener methods (onListener) methods will log an - unhandled event warning to indicate that an unexpected event type was received. Subclasses - should override these methods for any expected event types to provide appropriate handling. -

- The implementation subclass must be listed as an exported service in the Android manifest - for the application. The following manifest fragment shows a sample declaration with the - required attributes: -

- 
- <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-   <service android:name=".MyAppEventService" android:exported="true" >
-     <intent-filter>
-       <action android:name="com.google.android.gms.drive.events.HANDLE_EVENT" />
-     </intent-filter>
-   </service>
- </manifest>

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_HANDLE_EVENT - The action name used to bind to the DriveEventService for event delivery - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Constructors
- - - - - - - - DriveEventService(String name) - -
- Creates a new event service instance. - - - -
- -
- - - - - - - - DriveEventService() - -
- Creates a new event service instance with a default name. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - synchronized - final - - - IBinder - - onBind(Intent intent) - -
- - - - - - void - - onChange(ChangeEvent event) - -
- - - - - - void - - onCompletion(CompletionEvent event) - -
- - synchronized - - - - void - - onDestroy() - -
- - - - - - boolean - - onUnbind(Intent intent) - -
- - - - - - - - - - - - - - - - -
Protected Methods
- - - - - - int - - getCallingUid() - -
- Retrieves the current calling UID. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - com.google.android.gms.drive.events.ChangeListener - -
- - -
-
- -From interface - - com.google.android.gms.drive.events.CompletionListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_HANDLE_EVENT -

-
- - - - -
-
- - - - -

The action name used to bind to the DriveEventService for event delivery

- - -
- Constant Value: - - - "com.google.android.gms.drive.events.HANDLE_EVENT" - - -
- -
-
- - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - DriveEventService - (String name) -

-
-
- - - -
-
- - - - -

Creates a new event service instance.

-
-
Parameters
- - - - -
name - the name of the event service, used to name the worker thread (for debugging). -
-
- -
-
- - - - -
-

- - protected - - - - - - - DriveEventService - () -

-
-
- - - -
-
- - - - -

Creates a new event service instance with a default name. -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - synchronized - IBinder - - onBind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onChange - (ChangeEvent event) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCompletion - (CompletionEvent event) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - synchronized - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - onUnbind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - - - - - int - - getCallingUid - () -

-
-
- - - -
-
- - - - -

Retrieves the current calling UID. Exposed to support test mocking

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/ResourceEvent.html b/docs/html/reference/com/google/android/gms/drive/events/ResourceEvent.html deleted file mode 100644 index f1649fc71c55..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/ResourceEvent.html +++ /dev/null @@ -1,1286 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ResourceEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

ResourceEvent

- - - - - - implements - - DriveEvent - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.events.ResourceEvent
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for DriveEvent types related to a specific resource. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DriveId - - getDriveId() - -
- Returns the id of the Drive resource that triggered the event. - - - -
- -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DriveId - - getDriveId - () -

-
-
- - - -
-
- - - - -

Returns the id of the Drive resource that triggered the event. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/events/package-summary.html b/docs/html/reference/com/google/android/gms/drive/events/package-summary.html deleted file mode 100644 index efb6459e7a7b..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/events/package-summary.html +++ /dev/null @@ -1,964 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.drive.events | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.drive.events

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ChangeListener - Event listener interface for ChangeEvent.  - - - -
CompletionListener - Event listener interface for CompletionEvent.  - - - -
DriveEvent - Base interface implemented by all Drive event types.  - - - -
ResourceEvent - Base interface for DriveEvent types related to a specific resource.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
ChangeEvent - Sent when a DriveResource has had a change to its DriveContents or - Metadata.  - - - -
CompletionEvent - An event delivered after the client requests a completion notification using - setNotifyOnCompletion(boolean) and that action has either succeeded or - failed on the server.  - - - -
DriveEventService - Abstract base class for a bound service that handles Drive events.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/CustomPropertyKey.html b/docs/html/reference/com/google/android/gms/drive/metadata/CustomPropertyKey.html deleted file mode 100644 index a2d86f935ed3..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/CustomPropertyKey.html +++ /dev/null @@ -1,2122 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CustomPropertyKey | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CustomPropertyKey

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.metadata.CustomPropertyKey
- - - - - - - -
- - -

Class Overview

-

The key to a Custom File Property key-value pair that can be serialized in a Parcel. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intPRIVATE - The custom property is private to this app. - - - -
intPUBLIC - The custom property is shared with all apps. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<CustomPropertyKey>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CustomPropertyKey(String key, int visibility) - -
- Constructs a CustomPropertyKey object. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - static - - CustomPropertyKey - - fromJson(JSONObject jsonObject) - -
- - - - - - String - - getKey() - -
- - - - - - int - - getVisibility() - -
- - - - - - int - - hashCode() - -
- - - - - - JSONObject - - toJson() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - PRIVATE -

-
- - - - -
-
- - - - -

The custom property is private to this app. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PUBLIC -

-
- - - - -
-
- - - - -

The custom property is shared with all apps. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<CustomPropertyKey> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CustomPropertyKey - (String key, int visibility) -

-
-
- - - -
-
- - - - -

Constructs a CustomPropertyKey object.

-
-
Parameters
- - - - - - - -
key - The name of the key. Note that the characters allowed in the name are letters, - numbers, and the characters .!@$%^&*()-_/.
visibility - The visibility of this custom property; either PUBLIC or - PRIVATE. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - CustomPropertyKey - - fromJson - (JSONObject jsonObject) -

-
-
- - - -
-
- - - - -

-
-
Throws
- - - - -
JSONException -
-
- -
-
- - - - -
-

- - public - - - - - String - - getKey - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getVisibility - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - JSONObject - - toJson - () -

-
-
- - - -
-
- - - - -

-
-
Throws
- - - - -
JSONException -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/MetadataField.html b/docs/html/reference/com/google/android/gms/drive/metadata/MetadataField.html deleted file mode 100644 index f4410235af05..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/MetadataField.html +++ /dev/null @@ -1,1055 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MetadataField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

MetadataField

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.metadata.MetadataField<T>
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Base interface for the SearchableMetadataField and SortableMetadataField - interfaces. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableCollectionMetadataField.html b/docs/html/reference/com/google/android/gms/drive/metadata/SearchableCollectionMetadataField.html deleted file mode 100644 index 17f77b39b579..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableCollectionMetadataField.html +++ /dev/null @@ -1,993 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchableCollectionMetadataField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SearchableCollectionMetadataField

- - - - - - implements - - SearchableMetadataField<Collection<T>> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.metadata.SearchableCollectionMetadataField<T>
- - - - - - - -
- - -

Class Overview

-

Interface for metadata fields which hold a collection of values. Implementation of this - interface (such as the static values in - SearchableField) can be used to create "in" filters - for file queries.

- For example, the following code will find all files in the folder with ID "folder" with the MIME - type "text/plain":

- 

- DriveId parent = DriveId.createFromResourceId("folder");
- Filter parentFilter = Filters.in(SearchableField.PARENTS, parent);
- Filter mimeTypeFilter = Filters.eq(SearchableField.MIME_TYPE, "text/plain");
- Query query = new Query.Builder().addFilters(parentFilter, mimeTypeFilter).build();
- for (Metadata metadata : Drive.DriveApi.query(apiClient, query).await().getMetadataBuffer()) {
-     System.out.println(metadata.getTitle());
- }
-
-

- Note that you must pass a SearchableCollectionMetadataField to the - Filters#in - method; a plain SearchableMetadataField cannot be used as part of an "in" query. - However, every SearchableCollectionMetadataField is also a - SearchableMetadataField, so you can use a SearchableCollectionMetadataField with - Filters#eq (for example, if you want to - find a file with an exact set of parents).

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableMetadataField.html b/docs/html/reference/com/google/android/gms/drive/metadata/SearchableMetadataField.html deleted file mode 100644 index d7a5de4901a5..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableMetadataField.html +++ /dev/null @@ -1,1054 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchableMetadataField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - -
- -Summary: - - - - - - - - - - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

SearchableMetadataField

- - - - - - implements - - MetadataField<T> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.metadata.SearchableMetadataField<T>
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Interface for metadata fields that can be used to filter results as part of file queries. - Implementation of this interface (such as the static values in - SearchableField) can be used to create filters for - file or folder queries. -

-

- For example, the following code will find all files that are starred and have the MIME type type - "text/plain": -

- - 

- Filter starredFilter = Filters.eq(SearchableField.STARRED, true);
- Filter mimeTypeFilter = Filters.eq(SearchableField.MIME_TYPE, "text/plain");
- Query query = new Query.Builder().addFilters(starredFilter, mimeTypeFilter).build();
- for (Metadata metadata : Drive.DriveApi.query(apiClient, query).await().getMetadataBuffer()) {
-     System.out.println(metadata.getTitle());
- }
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableOrderedMetadataField.html b/docs/html/reference/com/google/android/gms/drive/metadata/SearchableOrderedMetadataField.html deleted file mode 100644 index ede1dd7008e1..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/SearchableOrderedMetadataField.html +++ /dev/null @@ -1,996 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchableOrderedMetadataField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SearchableOrderedMetadataField

- - - - - - implements - - SearchableMetadataField<T> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.metadata.SearchableOrderedMetadataField<T>
- - - - - - - -
- - -

Class Overview

-

Interface for metadata fields which holds an ordered value (such as a date) and which can be - used for range queries. Implementations of this interface (such as the static values in - SearchableField) can be used to create inequality - filters for file queries.

- For example, the following code will find all files that were modified in the last hour with the - MIME type "text/plain":

- 

- Date oneHourAgo = new Date(System.currentTimeMillis() - (60 * 60 * 1000));
- Filter dateFilter = Filters.greaterThan(SearchableField.MODIFIED_DATE, oneHourAgo);
- Filter mimeTypeFilter = Filters.eq(SearchableField.MIME_TYPE, "text/plain");
- Query query = new Query.Builder().addFilters(dateFilter, mimeTypeFilter).build();
- for (Metadata metadata : Drive.DriveApi.query(apiClient, query).await().getMetadataBuffer()) {
-   System.out.println(metadata.getTitle());
- }
-
-

- Note that you must pass an SearchableOrderedMetadataField to the - Filters#greaterThan, - Filters#lessThan, - Filters#lessThanEquals, or - Filters#greaterThanEquals - methods; a plain SearchableMetadataField cannot be used as part of an inequality query. - However, every SearchableOrderedMetadataField is also a SearchableMetadataField, - so you can use a SearchableOrderedMetadataField with - Filters#eq (for example, if you want to - find a file that was modified at an exact time).

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/SortableMetadataField.html b/docs/html/reference/com/google/android/gms/drive/metadata/SortableMetadataField.html deleted file mode 100644 index 5ec0421aa22f..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/SortableMetadataField.html +++ /dev/null @@ -1,986 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SortableMetadataField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SortableMetadataField

- - - - - - implements - - MetadataField<T> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.metadata.SortableMetadataField<T>
- - - - - - - -
- - -

Class Overview

-

Interface for metadata fields that can be used to sort results of the file queries. - Implementation of this interface (such as the static values in - SortableField) can be add sorting criteria for the - file or folder queries. -

-

- For example, the following code will find all files that are starred, have the MIME type type - "text/plain" and list them in the order they were created: -

- - 

- Filter starredFilter = Filters.eq(SearchableField.STARRED, true);
- Filter mimeTypeFilter = Filters.eq(SearchableField.MIME_TYPE, "text/plain");
- Query query = new Query.Builder()
-                        .addFilters(starredFilter, mimeTypeFilter)
-                        .addSortAscending(SortableField.CREATED_DATE)
-                        .build();
- for (Metadata metadata : Drive.DriveApi.query(apiClient, query).await().getMetadataBuffer()) {
-     System.out.println(metadata.getTitle());
- }
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/metadata/package-summary.html b/docs/html/reference/com/google/android/gms/drive/metadata/package-summary.html deleted file mode 100644 index a917bfdf088e..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/metadata/package-summary.html +++ /dev/null @@ -1,952 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.drive.metadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.drive.metadata

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MetadataField<T> - Base interface for the SearchableMetadataField and SortableMetadataField - interfaces.  - - - -
SearchableCollectionMetadataField<T> - Interface for metadata fields which hold a collection of values.  - - - -
SearchableMetadataField<T> - Interface for metadata fields that can be used to filter results as part of file queries.  - - - -
SearchableOrderedMetadataField<T> - Interface for metadata fields which holds an ordered value (such as a date) and which can be - used for range queries.  - - - -
SortableMetadataField<T> - Interface for metadata fields that can be used to sort results of the file queries.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - -
CustomPropertyKey - The key to a Custom File Property key-value pair that can be serialized in a Parcel.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/package-summary.html b/docs/html/reference/com/google/android/gms/drive/package-summary.html deleted file mode 100644 index 5cee80a35758..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/package-summary.html +++ /dev/null @@ -1,1171 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.drive | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.drive

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DriveApi - The main entry point for interacting with Drive.  - - - -
DriveApi.DriveContentsResult - Result that contains a DriveContents.  - - - -
DriveApi.DriveIdResult - Result that contains a DriveId.  - - - -
DriveApi.MetadataBufferResult - Result that contains a MetadataBuffer.  - - - -
DriveContents - A reference to a Drive file's contents.  - - - -
DriveFile - A file in Drive.  - - - -
DriveFile.DownloadProgressListener - A listener that listens for progress events on an active contents download.  - - - -
DriveFolder - A folder in Drive.  - - - -
DriveFolder.DriveFileResult - A result that contains a DriveFile.  - - - -
DriveFolder.DriveFolderResult - A result that contains a DriveFolder.  - - - -
DrivePreferencesApi - The entry point for retrieving and updating Drive preferences.  - - - -
DrivePreferencesApi.FileUploadPreferencesResult - Result that contains a FileUploadPreferences reference.  - - - -
DriveResource - A Resource represents a file or folder in Drive.  - - - -
DriveResource.MetadataResult - Result that is returned in response to metadata requests.  - - - -
FileUploadPreferences - Represents the file upload preferences associated with the current account.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CreateFileActivityBuilder - A builder that is used to configure and display the create file activity.  - - - -
Drive - The Drive API provides easy access to users' Google Drive contents.  - - - -
DriveId - A canonical identifier for a Drive resource.  - - - -
DriveStatusCodes - Drive specific status codes, for use in getStatusCode().  - - - -
ExecutionOptions - Options that can be included with certain requests to the API to configure notification - and conflict resolution behavior.  - - - -
ExecutionOptions.Builder - A builder for creating a new ExecutionOptions.  - - - -
Metadata - The details of a Drive file or folder.  - - - -
MetadataBuffer - A data buffer that points to Metadata entries.  - - - -
MetadataChangeSet - A collection of metadata changes.  - - - -
MetadataChangeSet.Builder - A builder for creating a new MetadataChangeSet.  - - - -
OpenFileActivityBuilder - A builder that is used to configure and display the open file activity.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/Filter.html b/docs/html/reference/com/google/android/gms/drive/query/Filter.html deleted file mode 100644 index 8071ee18a283..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/Filter.html +++ /dev/null @@ -1,1147 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Filter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Filter

- - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.drive.query.Filter
- - - - - - - -
- - -

Class Overview

-

A query filter that can be used to restrict the results on queries. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/Filters.html b/docs/html/reference/com/google/android/gms/drive/query/Filters.html deleted file mode 100644 index b9a9a7755a85..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/Filters.html +++ /dev/null @@ -1,2231 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Filters | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Filters

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.Filters
- - - - - - - -
- - -

Class Overview

-

A factory for creating filters that are used to construct a Query. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Filters() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Filter - - and(Filter filter, Filter... additionalFilters) - -
- Returns a logical expression which combines filters with the 'AND' operator. - - - -
- -
- - - - static - - Filter - - and(Iterable<Filter> filters) - -
- Returns a filter that matches items which are matched by every element of filters. - - - -
- -
- - - - static - - Filter - - contains(SearchableMetadataField<String> field, String value) - -
- Returns a filter which checks whether value is a substring of field. - - - -
- -
- - - - static - <T> - Filter - - eq(SearchableMetadataField<T> field, T value) - -
- Returns a filter which checks if the value of field equals value. - - - -
- -
- - - - static - - Filter - - eq(CustomPropertyKey key, String value) - -
- Returns a filter which checks whether a custom property with the specified key exists - and its value equals value. - - - -
- -
- - - - static - <T extends Comparable<T>> - Filter - - greaterThan(SearchableOrderedMetadataField<T> field, T value) - -
- Returns a filter which checks if the value of field is greater than value. - - - -
- -
- - - - static - <T extends Comparable<T>> - Filter - - greaterThanEquals(SearchableOrderedMetadataField<T> field, T value) - -
- Returns a filter which checks if the value of field is greater than or equal to - value. - - - -
- -
- - - - static - <T> - Filter - - in(SearchableCollectionMetadataField<T> field, T value) - -
- Returns a filter which checks whether value is an element of field. - - - -
- -
- - - - static - <T extends Comparable<T>> - Filter - - lessThan(SearchableOrderedMetadataField<T> field, T value) - -
- Returns a filter which checks if the value of field is less than value. - - - -
- -
- - - - static - <T extends Comparable<T>> - Filter - - lessThanEquals(SearchableOrderedMetadataField<T> field, T value) - -
- Returns a filter which checks if the value of field is less than or equal to - value. - - - -
- -
- - - - static - - Filter - - not(Filter toNegate) - -
- Returns the negation of an filter. - - - -
- -
- - - - static - - Filter - - openedByMe() - -
- Returns a filter that matches only items that the current user has opened in the past. - - - -
- -
- - - - static - - Filter - - or(Iterable<Filter> filters) - -
- Returns a filter that matches items which are matched by any element of filters. - - - -
- -
- - - - static - - Filter - - or(Filter filter, Filter... additionalFilters) - -
- Returns a filter that matches items which are matched by any of the provided filter - parameters. - - - -
- -
- - - - static - - Filter - - ownedByMe() - -
- Returns a filter that matches only items that the current user owns. - - - -
- -
- - - - static - - Filter - - sharedWithMe() - -
- Returns a filter that matches only items that are shared with the current user. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Filters - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Filter - - and - (Filter filter, Filter... additionalFilters) -

-
-
- - - -
-
- - - - -

Returns a logical expression which combines filters with the 'AND' operator. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - and - (Iterable<Filter> filters) -

-
-
- - - -
-
- - - - -

Returns a filter that matches items which are matched by every element of filters. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - contains - (SearchableMetadataField<String> field, String value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks whether value is a substring of field. - This filter can only be used with fields that contain a string value. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - eq - (SearchableMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks if the value of field equals value. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - eq - (CustomPropertyKey key, String value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks whether a custom property with the specified key exists - and its value equals value. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - greaterThan - (SearchableOrderedMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks if the value of field is greater than value. - This filter can only be used with fields that have a sort order. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - greaterThanEquals - (SearchableOrderedMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks if the value of field is greater than or equal to - value. This filter can only be used with fields that have a sort order. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - in - (SearchableCollectionMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks whether value is an element of field. - This filter can only be used with fields that contain a collection value. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - lessThan - (SearchableOrderedMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks if the value of field is less than value. This - filter can only be used with fields that have a sort order. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - lessThanEquals - (SearchableOrderedMetadataField<T> field, T value) -

-
-
- - - -
-
- - - - -

Returns a filter which checks if the value of field is less than or equal to - value. This filter can only be used with fields that have a sort order. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - not - (Filter toNegate) -

-
-
- - - -
-
- - - - -

Returns the negation of an filter. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - openedByMe - () -

-
-
- - - -
-
- - - - -

Returns a filter that matches only items that the current user has opened in the past. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - or - (Iterable<Filter> filters) -

-
-
- - - -
-
- - - - -

Returns a filter that matches items which are matched by any element of filters. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - or - (Filter filter, Filter... additionalFilters) -

-
-
- - - -
-
- - - - -

Returns a filter that matches items which are matched by any of the provided filter - parameters. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - ownedByMe - () -

-
-
- - - -
-
- - - - -

Returns a filter that matches only items that the current user owns. -

- -
-
- - - - -
-

- - public - static - - - - Filter - - sharedWithMe - () -

-
-
- - - -
-
- - - - -

Returns a filter that matches only items that are shared with the current user. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/Query.Builder.html b/docs/html/reference/com/google/android/gms/drive/query/Query.Builder.html deleted file mode 100644 index 546a980f0105..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/Query.Builder.html +++ /dev/null @@ -1,1618 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Query.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Query.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.Query.Builder
- - - - - - - -
- - -

Class Overview

-

A builder for creating queries. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Query.Builder() - -
- - - - - - - - Query.Builder(Query query) - -
- Creates a new builder with initial values from an existing query. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Query.Builder - - addFilter(Filter filter) - -
- Adds a search filter to the query. - - - -
- -
- - - - - - Query - - build() - -
- - - - - - Query.Builder - - setPageToken(String token) - -
- - This method is deprecated. - Paging is not supported. - - - - -
- -
- - - - - - Query.Builder - - setSortOrder(SortOrder sortOrder) - -
- Sets the SortOrder to be used to sort the query results. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Query.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - Query.Builder - (Query query) -

-
-
- - - -
-
- - - - -

Creates a new builder with initial values from an existing query. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Query.Builder - - addFilter - (Filter filter) -

-
-
- - - -
-
- - - - -

Adds a search filter to the query. If more than one filter is added, they are combined - with a logical AND. Skips MatchAllFilter.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - Query - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Query.Builder - - setPageToken - (String token) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Paging is not supported. - -

-

Set the page token to retrieve the next page of results.

- -
-
- - - - -
-

- - public - - - - - Query.Builder - - setSortOrder - (SortOrder sortOrder) -

-
-
- - - -
-
- - - - -

Sets the SortOrder to be used to sort the query results. Use - SortOrder.Builder to build the sort order as required. Multiple calls to this - method resets the sort order set in previous calls.

-
-
Parameters
- - - - -
sortOrder - the order to be used to sort the query results -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/Query.html b/docs/html/reference/com/google/android/gms/drive/query/Query.html deleted file mode 100644 index d2be77eefb3f..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/Query.html +++ /dev/null @@ -1,1804 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Query | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Query

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.Query
- - - - - - - -
- - -

Class Overview

-

The query object specifies constraints on a query result, including filters, paging information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classQuery.Builder - A builder for creating queries.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<Query>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - Filter - - getFilter() - -
- Get the filters that will restrict the query results. - - - -
- -
- - - - - - String - - getPageToken() - -
- - This method is deprecated. - Paging is not supported. - - - - -
- -
- - - - - - SortOrder - - getSortOrder() - -
- Returns SortOrder containing information about sorting order of the query. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<Query> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Filter - - getFilter - () -

-
-
- - - -
-
- - - - -

Get the filters that will restrict the query results. -

- -
-
- - - - -
-

- - public - - - - - String - - getPageToken - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Paging is not supported. - -

-

A token that indicates the next page of results to retrieve. This should be a token - that was returned in a previous query.

- -
-
- - - - -
-

- - public - - - - - SortOrder - - getSortOrder - () -

-
-
- - - -
-
- - - - -

Returns SortOrder containing information about sorting order of the query. Can be - null when no sorting order is added to the query. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/SearchableField.html b/docs/html/reference/com/google/android/gms/drive/query/SearchableField.html deleted file mode 100644 index bf1ceac8731f..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/SearchableField.html +++ /dev/null @@ -1,1709 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchableField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SearchableField

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.SearchableField
- - - - - - - -
- - -

Class Overview

-

An attribute of the file that is to be searched. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - SearchableMetadataField<Boolean>IS_PINNED - Whether the user has pinned the item. - - - -
- public - static - final - SearchableOrderedMetadataField<Date>LAST_VIEWED_BY_ME - The date this resource was most recently viewed by the user. - - - -
- public - static - final - SearchableMetadataField<String>MIME_TYPE - The MIME type of the item. - - - -
- public - static - final - SearchableOrderedMetadataField<Date>MODIFIED_DATE - The date when the item was most recently modified. - - - -
- public - static - final - SearchableCollectionMetadataField<DriveId>PARENTS - The IDs of the parent folders (if any) of the item. - - - -
- public - static - final - SearchableMetadataField<Boolean>STARRED - Whether the user has starred the item. - - - -
- public - static - final - SearchableMetadataField<String>TITLE - The title of the item. - - - -
- public - static - final - SearchableMetadataField<Boolean>TRASHED - Whether the item is in the trash. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SearchableField() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - SearchableMetadataField<Boolean> - - IS_PINNED -

-
- - - - -
-
- - - - -

Whether the user has pinned the item. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableOrderedMetadataField<Date> - - LAST_VIEWED_BY_ME -

-
- - - - -
-
- - - - -

The date this resource was most recently viewed by the user. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableMetadataField<String> - - MIME_TYPE -

-
- - - - -
-
- - - - -

The MIME type of the item. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableOrderedMetadataField<Date> - - MODIFIED_DATE -

-
- - - - -
-
- - - - -

The date when the item was most recently modified. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableCollectionMetadataField<DriveId> - - PARENTS -

-
- - - - -
-
- - - - -

The IDs of the parent folders (if any) of the item. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableMetadataField<Boolean> - - STARRED -

-
- - - - -
-
- - - - -

Whether the user has starred the item. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableMetadataField<String> - - TITLE -

-
- - - - -
-
- - - - -

The title of the item. -

- - -
-
- - - - - -
-

- - public - static - final - SearchableMetadataField<Boolean> - - TRASHED -

-
- - - - -
-
- - - - -

Whether the item is in the trash. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SearchableField - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/SortOrder.Builder.html b/docs/html/reference/com/google/android/gms/drive/query/SortOrder.Builder.html deleted file mode 100644 index e10c185f7069..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/SortOrder.Builder.html +++ /dev/null @@ -1,1505 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SortOrder.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SortOrder.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.SortOrder.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SortOrder.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SortOrder.Builder - - addSortAscending(SortableMetadataField sortField) - -
- Adds the SortableMetadataField to be used to sort the query results in ascending - order of the values of the sortField. - - - -
- -
- - - - - - SortOrder.Builder - - addSortDescending(SortableMetadataField sortField) - -
- Adds the SortableMetadataField to be used to sort the query results in descending - order of the values of the sortField. - - - -
- -
- - - - - - SortOrder - - build() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SortOrder.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SortOrder.Builder - - addSortAscending - (SortableMetadataField sortField) -

-
-
- - - -
-
- - - - -

Adds the SortableMetadataField to be used to sort the query results in ascending - order of the values of the sortField. Query results are sorted in the same order the - fields are added.

-
-
Parameters
- - - - -
sortField - the field to be used to sort the query results in ascending order, see - SortableField for the list of fields that can be used to sort query results -
-
- -
-
- - - - -
-

- - public - - - - - SortOrder.Builder - - addSortDescending - (SortableMetadataField sortField) -

-
-
- - - -
-
- - - - -

Adds the SortableMetadataField to be used to sort the query results in descending - order of the values of the sortField. Query results are sorted in the same order the - fields are added.

-
-
Parameters
- - - - -
sortField - the field to be used to sort the query results in descending order, see - SortableField for the list of fields that can be used to sort query results -
-
- -
-
- - - - -
-

- - public - - - - - SortOrder - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/SortOrder.html b/docs/html/reference/com/google/android/gms/drive/query/SortOrder.html deleted file mode 100644 index 0f933bcaaa25..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/SortOrder.html +++ /dev/null @@ -1,1628 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SortOrder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SortOrder

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.SortOrder
- - - - - - - -
- - -

Class Overview

-

SortOrder is used to specify the results order in the Query object using the - setSortOrder(SortOrder) method. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSortOrder.Builder -   - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<SortOrder>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<SortOrder> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/SortableField.html b/docs/html/reference/com/google/android/gms/drive/query/SortableField.html deleted file mode 100644 index 1978a777c1d0..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/SortableField.html +++ /dev/null @@ -1,1661 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SortableField | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SortableField

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.drive.query.SortableField
- - - - - - - -
- - -

Class Overview

-

An attribute of the file that a query can be sorted upon. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - SortableMetadataField<Date>CREATED_DATE - The date when the item was created. - - - -
- public - static - final - SortableMetadataField<Date>LAST_VIEWED_BY_ME - The date this resource was most recently viewed by the user. - - - -
- public - static - final - SortableMetadataField<Date>MODIFIED_BY_ME_DATE - The date when the item was most recently modified by the user. - - - -
- public - static - final - SortableMetadataField<Date>MODIFIED_DATE - The date when the item was most recently modified. - - - -
- public - static - final - SortableMetadataField<Long>QUOTA_USED - The Drive quota used by the file. - - - -
- public - static - final - SortableMetadataField<Date>SHARED_WITH_ME_DATE - The date this resource was shared with the user. - - - -
- public - static - final - SortableMetadataField<String>TITLE - The title of the item. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SortableField() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - SortableMetadataField<Date> - - CREATED_DATE -

-
- - - - -
-
- - - - -

The date when the item was created. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<Date> - - LAST_VIEWED_BY_ME -

-
- - - - -
-
- - - - -

The date this resource was most recently viewed by the user. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<Date> - - MODIFIED_BY_ME_DATE -

-
- - - - -
-
- - - - -

The date when the item was most recently modified by the user. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<Date> - - MODIFIED_DATE -

-
- - - - -
-
- - - - -

The date when the item was most recently modified. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<Long> - - QUOTA_USED -

-
- - - - -
-
- - - - -

The Drive quota used by the file. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<Date> - - SHARED_WITH_ME_DATE -

-
- - - - -
-
- - - - -

The date this resource was shared with the user. -

- - -
-
- - - - - -
-

- - public - static - final - SortableMetadataField<String> - - TITLE -

-
- - - - -
-
- - - - -

The title of the item. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SortableField - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/query/package-summary.html b/docs/html/reference/com/google/android/gms/drive/query/package-summary.html deleted file mode 100644 index c6534dac6e34..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/query/package-summary.html +++ /dev/null @@ -1,973 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.drive.query | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.drive.query

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
Filter - A query filter that can be used to restrict the results on queries.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Filters - A factory for creating filters that are used to construct a Query.  - - - -
Query - The query object specifies constraints on a query result, including filters, paging information.  - - - -
Query.Builder - A builder for creating queries.  - - - -
SearchableField - An attribute of the file that is to be searched.  - - - -
SortableField - An attribute of the file that a query can be sorted upon.  - - - -
SortOrder - SortOrder is used to specify the results order in the Query object using the - setSortOrder(SortOrder) method.  - - - -
SortOrder.Builder -   - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/widget/DataBufferAdapter.html b/docs/html/reference/com/google/android/gms/drive/widget/DataBufferAdapter.html deleted file mode 100644 index 56e994b6c685..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/widget/DataBufferAdapter.html +++ /dev/null @@ -1,2828 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataBufferAdapter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataBufferAdapter

- - - - - - - - - extends BaseAdapter
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.widget.BaseAdapter
    ↳com.google.android.gms.drive.widget.DataBufferAdapter<T>
- - - - - - - -
- - -

Class Overview

-

A concrete BaseAdapter that is backed by concatenated DataBuffers. The assumptions and - behaviors of this adapter parallel those of the ArrayAdapter: - -

    -
  • that the provided resource id in the simple constructors references a single TextView -
  • that more complex layouts use constructors taking a field id that references a TextView in - the larger layout resource -
  • that the objects in the DataBuffer have an appropriate toString() method, which will be used - to populate the TextView -
- -

If you need to modify how the objects display in the TextView, override their toString() - method. - -

In addition, any DataBuffers added to this adapter are managed entirely by this adapter, - including their life cycle. Be sure to call clear() anywhere you would otherwise close - the data buffers used here, and if you want to manage their life cycles more granularly, you will - need to override the behavior of clear(), as well as add your own management methods to - ensure resources are properly managed within your application. - -

If you need something other than a single TextView for the data in this adapter, override - getView(int, View, ViewGroup) to populate and return the type of view you want.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.widget.Adapter -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataBufferAdapter(Context context, int resource, int textViewResourceId, List<DataBuffer<T>> objects) - -
- - - - - - - - DataBufferAdapter(Context context, int resource, int textViewResourceId) - -
- - - - - - - - DataBufferAdapter(Context context, int resource, List<DataBuffer<T>> objects) - -
- - - - - - - - DataBufferAdapter(Context context, int resource) - -
- - - - - - - - DataBufferAdapter(Context context, int resource, int textViewResourceId, DataBuffer...<T> buffers) - -
- - - - - - - - DataBufferAdapter(Context context, int resource, DataBuffer...<T> buffers) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - append(DataBuffer<T> buffer) - -
- Appends the specified buffer to the end of the adapter. - - - -
- -
- - - - - - void - - clear() - -
- Closes and removes all buffers, and so all elements, from the adapter. - - - -
- -
- - - - - - Context - - getContext() - -
- - - - - - int - - getCount() - -
- - - - - -
- -
- - - - - - View - - getDropDownView(int position, View convertView, ViewGroup parent) - -
- - - - - -
- -
- - - - - - T - - getItem(int position) - -
- - - - - -
- -
- - - - - - long - - getItemId(int position) - -
- - - - - -
- -
- - - - - - View - - getView(int position, View convertView, ViewGroup parent) - -
- - - - - -
- -
- - - - - - void - - notifyDataSetChanged() - -
- - - This will also re-enable automatic notifications. - - - -
- -
- - - - - - void - - setDropDownViewResource(int resource) - -
- Sets the layout resource to create the drop down views. - - - -
- -
- - - - - - void - - setNotifyOnChange(boolean notifyOnChange) - -
-

Control whether methods that change the list (append(DataBuffer), clear()) - automatically call notifyDataSetChanged(). - - - -

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.BaseAdapter - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.widget.ListAdapter - -
- - -
-
- -From interface - - android.widget.SpinnerAdapter - -
- - -
-
- -From interface - - android.widget.Adapter - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource, int textViewResourceId, List<DataBuffer<T>> objects) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource, int textViewResourceId) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource, List<DataBuffer<T>> objects) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource, int textViewResourceId, DataBuffer...<T> buffers) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - DataBufferAdapter - (Context context, int resource, DataBuffer...<T> buffers) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - append - (DataBuffer<T> buffer) -

-
-
- - - -
-
- - - - -

Appends the specified buffer to the end of the adapter. -

- -
-
- - - - -
-

- - public - - - - - void - - clear - () -

-
-
- - - -
-
- - - - -

Closes and removes all buffers, and so all elements, from the adapter. -

- -
-
- - - - -
-

- - public - - - - - Context - - getContext - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

-

- -
-
- - - - -
-

- - public - - - - - View - - getDropDownView - (int position, View convertView, ViewGroup parent) -

-
-
- - - -
-
- - - - -

-

- -
-
- - - - -
-

- - public - - - - - T - - getItem - (int position) -

-
-
- - - -
-
- - - - -

-

-
-
Throws
- - - - -
CursorIndexOutOfBoundsException -
-
- -
-
- - - - -
-

- - public - - - - - long - - getItemId - (int position) -

-
-
- - - -
-
- - - - -

-

- -
-
- - - - -
-

- - public - - - - - View - - getView - (int position, View convertView, ViewGroup parent) -

-
-
- - - -
-
- - - - -

-

- -
-
- - - - -
-

- - public - - - - - void - - notifyDataSetChanged - () -

-
-
- - - -
-
- - - - -

- - This will also re-enable automatic notifications. Pairing this with setNotifyOnChange(boolean) - gives the ability to make a series of changes to the adapter without triggering multiple - notifications at the same time. Use these two methods together to temporarily disable - notifications for the purpose of batching operations on the adapter. -

- -
-
- - - - -
-

- - public - - - - - void - - setDropDownViewResource - (int resource) -

-
-
- - - -
-
- - - - -

Sets the layout resource to create the drop down views. -

- -
-
- - - - -
-

- - public - - - - - void - - setNotifyOnChange - (boolean notifyOnChange) -

-
-
- - - -
-
- - - - -

Control whether methods that change the list (append(DataBuffer), clear()) - automatically call notifyDataSetChanged(). If set to false, caller must manually call - notifyDataSetChanged() to have the changes reflected in the attached view. - -

The default is true, and calling notifyDataSetChanged() resets the flag to true. Use this - method if you want to make several changes to the adapter in a row, and don't need the view - to update in between changes. This reduces the processing load for each operation - significantly.

-
-
Parameters
- - - - -
notifyOnChange - if true, modifications to the list will automatically call notifyDataSetChanged() -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/drive/widget/package-summary.html b/docs/html/reference/com/google/android/gms/drive/widget/package-summary.html deleted file mode 100644 index 1e74eab7d2d1..000000000000 --- a/docs/html/reference/com/google/android/gms/drive/widget/package-summary.html +++ /dev/null @@ -1,885 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.drive.widget | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.drive.widget

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - -
DataBufferAdapter<T> -

A concrete BaseAdapter that is backed by concatenated DataBuffers.  - - - -

- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/BleApi.html b/docs/html/reference/com/google/android/gms/fitness/BleApi.html deleted file mode 100644 index e72a748e44fa..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/BleApi.html +++ /dev/null @@ -1,1617 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BleApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

BleApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.BleApi
- - - - - - - -
- - -

Class Overview

-

API for scanning, claiming, and using Bluetooth Low Energy devices in Google Fit. -

- Most BLE devices will accept connections from any other device, without the need for pairing. - To prevent Google Fit from using data from a device the user does not own, - we require a device to be claimed before it can be used in the platform. -

- The API supports scanning and claiming devices. Once a device is claimed, - its data sources are exposed via the Sensors and - Recording APIs, similar to local sensors. -

- The BLE API should be accessed from the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.BLE_API)
-         ...
-         .build();
-     client.connect();
-
-     PendingResult<Status> pendingResult = Fitness.BleApi.startBleScan(
-         client,
-         new StartBleScanRequest.Builder()
-             .setDataTypes(DataTypes.STEP_COUNT_DELTA)
-             .setBleScanCallback(bleScanCallback)
-             .build());
-
-

Enabling Bluetooth

- Many methods in this class require Bluetooth to be enabled. In case it isn't, - the method will return a result with status code set to - DISABLED_BLUETOOTH. - In this case, the app should use startResolutionForResult(Activity, int) to show - the dialog allowing the user to enable Bluetooth. -

- Example: - 

-     public class MyActivity extends FragmentActivity {
-
-         private static final int REQUEST_BLUETOOTH = 1001;
-
-         private GoogleApiClient mGoogleApiClient;
-         ...
-
-         private final ResultCallback mResultCallback = new ResultCallback() {
-             @Override
-             public void onResult(Status status) {
-                 ...
-                 if (!status.isSuccess()) {
-                     switch (status.getStatusCode()) {
-                         case FitnessStatusCodes.DISABLED_BLUETOOTH:
-                             try {
-                                 status.startResolutionForResult(
-                                         MyActivity.this, REQUEST_BLUETOOTH);
-                             } catch (SendIntentException e) {
-                                 ...
-                             }
-                             break;
-                         ...
-                     }
-                 }
-             }
-         };
-
-         @Override
-         protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-             super.onActivityResult(requestCode, resultCode, data);
-             switch (requestCode) {
-                 case REQUEST_BLUETOOTH:
-                     startBleScan();
-                     break;
-                 ...
-             }
-         }
-
-         private void startBleScan() {
-             StartBleScanRequest request = ...
-             PendingResult result =
-                     Fitness.BleApi.startBleScan(mGoogleApiClient, request);
-             result.setResultCallback(mResultCallback);
-         }
-     }
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - claimBleDevice(GoogleApiClient client, BleDevice bleDevice) - -
- Associates a BLE device with the current user. - - - -
- -
- abstract - - - - - PendingResult<Status> - - claimBleDevice(GoogleApiClient client, String deviceAddress) - -
- Associates a BLE device with the current user, using only the device address. - - - -
- -
- abstract - - - - - PendingResult<BleDevicesResult> - - listClaimedBleDevices(GoogleApiClient client) - -
- Lists all BLE devices that are associated with the current user. - - - -
- -
- abstract - - - - - PendingResult<Status> - - startBleScan(GoogleApiClient client, StartBleScanRequest request) - -
- Starts a scan for BLE devices compatible with Google Fit. - - - -
- -
- abstract - - - - - PendingResult<Status> - - stopBleScan(GoogleApiClient client, BleScanCallback callback) - -
- Stops a BLE devices scan. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unclaimBleDevice(GoogleApiClient client, String deviceAddress) - -
- Disassociates a BLE device with the current user, using the device's address. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unclaimBleDevice(GoogleApiClient client, BleDevice bleDevice) - -
- Disassociates a BLE device with the current user. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - claimBleDevice - (GoogleApiClient client, BleDevice bleDevice) -

-
-
- - - -
-
- - - - -

Associates a BLE device with the current user. When a device is claimed by a user, - the device will be available through Google Fit. -

- Prior to calling this method, you should stop any active Bluetooth scans you have started. - In order to prevent Bluetooth issues, the application should avoid connecting directly to - the device, but instead using Google Fit to do so.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
bleDevice - the device to claim
-
-
-
Returns
-
  • a pending result containing if the claim was made successfully -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - claimBleDevice - (GoogleApiClient client, String deviceAddress) -

-
-
- - - -
-
- - - - -

Associates a BLE device with the current user, using only the device address. When a device - is claimed by a user, the device will be available through Google Fit. If a full - BleDevice is available, calling claimBleDevice(GoogleApiClient, BleDevice) - is preferred. -

- Prior to calling this method, you should stop any active Bluetooth scans you have started. - In order to prevent Bluetooth issues, the application should avoid connecting directly to - the device, but instead using Google Fit to do so. -

- Since this method requires Bluetooth, please refer to BleApi doc about handling - disabled Bluetooth.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
deviceAddress - the hardware address of the device. A scan will be performed to find - a matching device.
-
-
-
Returns
-
  • a pending result containing if the claim was made successfully -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<BleDevicesResult> - - listClaimedBleDevices - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Lists all BLE devices that are associated with the current user.

-
-
Parameters
- - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the find operation will be delayed until the connection is complete.
-
-
-
Returns
-
  • a pending result containing found claimed BLE devices. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - startBleScan - (GoogleApiClient client, StartBleScanRequest request) -

-
-
- - - -
-
- - - - -

Starts a scan for BLE devices compatible with Google Fit. Results are returned - asynchronously through the BleScanCallback in the request. The callback's - onDeviceFound(BleDevice) method may be called multiple times, for each device - that is found. -

- This method will normally be used to present a list of devices to the user, - and to allow the user to pick a device to claim. Once the user selects a device or - dismisses the picker activity, the scan can be stopped using stopBleScan(GoogleApiClient, BleScanCallback), and - claimBleDevice(GoogleApiClient, String) can be used to associate the selected device - with the user. -

- This scanning is battery-intensive, so try to minimize the amount of time scanning. -

- Since this method requires Bluetooth, please refer to BleApi doc about handling - disabled Bluetooth. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - stopBleScan - (GoogleApiClient client, BleScanCallback callback) -

-
-
- - - -
-
- - - - -

Stops a BLE devices scan. Should be called immediately after scanning is no longer needed. -

- If the scan is already stopped, or if it was never started, - this method will succeed silently. -

- Since this method requires Bluetooth, please refer to BleApi doc about handling - disabled Bluetooth.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the stop scan operation will be delayed until the connection is complete.
callback - the callback originally used to start the scan
-
-
-
Returns
-
  • a pending result containing if the scan was stopped successfully -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unclaimBleDevice - (GoogleApiClient client, String deviceAddress) -

-
-
- - - -
-
- - - - -

Disassociates a BLE device with the current user, using the device's address. The device's - associated DataSources will no longer be available in Google Fit, - and all of the registrations for this device will be removed. - .

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
deviceAddress - the hardware address of the device
-
-
-
Returns
-
  • a pending result containing if the unclaim was made successfully -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unclaimBleDevice - (GoogleApiClient client, BleDevice bleDevice) -

-
-
- - - -
-
- - - - -

Disassociates a BLE device with the current user. The device's associated - DataSources will no longer be available in Google Fit, and - all of the registrations for this device will be removed. - .

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
bleDevice - the device to unclaim
-
-
-
Returns
-
  • a pending result containing if the unclaim was made successfully -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/ConfigApi.html b/docs/html/reference/com/google/android/gms/fitness/ConfigApi.html deleted file mode 100644 index 3daf73b855b7..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/ConfigApi.html +++ /dev/null @@ -1,1262 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ConfigApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

ConfigApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.ConfigApi
- - - - - - - -
- - -

Class Overview

-

API for accessing custom data types and settings in Google Fit. -

- Custom data type definitions can be added and then retrieved using - createCustomDataType(GoogleApiClient, DataTypeCreateRequest) and - readDataType(GoogleApiClient, String). -

- disableFit(GoogleApiClient) can be used to disconnect your app from Google Fit. -

- The Config API should be accessed via the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.CONFIG_API)
-         ...
-         .build();
-     client.connect();
-
-     PendingResult<DataTypeResult> pendingResult = Fitness.ConfigApi.readDataType(
-         client, "com.example.my_custom_data_type");
-
-     DataTypeResult dataTypeResult = pendingResult.await();
-     DataType dataType = dataTypeResult.getDataType();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<DataTypeResult> - - createCustomDataType(GoogleApiClient client, DataTypeCreateRequest request) - -
- Defines a new data type which is added to the Google Fit platform on behalf of the current - application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - disableFit(GoogleApiClient client) - -
- Disables Google Fit for an app. - - - -
- -
- abstract - - - - - PendingResult<DataTypeResult> - - readDataType(GoogleApiClient client, String dataTypeName) - -
- Returns a data type with the specified dataTypeName. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<DataTypeResult> - - createCustomDataType - (GoogleApiClient client, DataTypeCreateRequest request) -

-
-
- - - -
-
- - - - -

Defines a new data type which is added to the Google Fit platform on behalf of the current - application. Useful for adding a private custom data type for recording app-specific data. - Custom data created by one app will not be visible to other apps. -

- Example: - 

-     PendingResult pendingResult = ConfigApi.createCustomDataType(client
-         new DataTypeCreateRequest.Builder()
-             .setName(DATA_TYPE_NAME)
-             .addField(MY_FIELD1)
-             .addField(MY_FIELD2)
-             .build());
-     DataTypeResult result = pendingResult.await();
-

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
request - the new data type name and fields that need to be added
-
-
-
Returns
-
  • a pending result containing the status of the request. If an existing DataType has - the same name but different fields, the operation will fail with - CONFLICTING_DATA_TYPE. - If application package name does not match DataType's name, the operation - will fail with INCONSISTENT_DATA_TYPE status code. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - disableFit - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Disables Google Fit for an app. Can be used to revoke all granted OAuth access permissions - from an app and consequently remove all existing subscriptions and registrations of the app.

-
-
Parameters
- - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
-
-
-
Returns
-
  • result containing the status of the request -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataTypeResult> - - readDataType - (GoogleApiClient client, String dataTypeName) -

-
-
- - - -
-
- - - - -

Returns a data type with the specified dataTypeName. Useful to retrieve - shareable data types added by other apps or custom data types added by your app. - Custom data types created by other apps will not be returned.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the read result will be delayed until the connection is complete.
dataTypeName - name of the data type we want to read
-
-
-
Returns
-
  • result containing the status of the request -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/Fitness.html b/docs/html/reference/com/google/android/gms/fitness/Fitness.html deleted file mode 100644 index 875eaeeedc0d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/Fitness.html +++ /dev/null @@ -1,3000 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Fitness | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Fitness

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.Fitness
- - - - - - - -
- - -

Class Overview

-

The main entry point to Google Fit APIs. -

- The Google Fit APIs help app developers collect and use fitness-related sensor data in their - applications. There are several different APIs, each solving a different problem: -

    -
  • SensorsApi exposes a unified view of sensor streams on the local - device and connected devices, and delivers live events to listeners. -
  • RecordingApi enables low-battery, always-on background collection - of sensor data into the Google Fit store. -
  • SessionsApi lets apps create and manage sessions of user activity. -
  • HistoryApi allows querying and insertion of data in Google Fit. -
  • BleApi can be used to work with Bluetooth Low Energy devices. -
  • ConfigApi can be used to access custom data types and settings. -
- Most API methods require a data type. Each data type operation requires the - user to have granted the app permission to access and store fitness data for the given data type. -

Authorization

- When connecting to the Google Fit API, apps should specify the necessary scopes and the user - account. Apps can use addScope(Scope) to add the - necessary scopes, which should be selected from the SCOPE_XXX constants in this class. - To use a specific user account, apps can use setAccountName(String), - or use useDefaultAccount() to use the default account. The specified account - and scopes will be used to acquire the necessary OAuth tokens on behalf of the app. -

- In case the app does not have the needed OAuth permissions for the requested scopes, - Google Fit will send back a result with status code set - to NEEDS_OAUTH_PERMISSIONS. In this case, the app should use - startResolutionForResult(Activity, int) to get the necessary OAuth - permissions. -

- The first connection to Fit API may require a network connection to verify the account and scopes - associated with it. In case no network connection is available, Google Fit will send back a - result with status code set to NETWORK_ERROR. -

- Sample usage of Google Fit Client: - 

-     public class MyActivity extends FragmentActivity
-             implements ConnectionCallbacks, OnConnectionFailedListener, OnDataPointListener {
-        private static final int REQUEST_OAUTH = 1001;
-        private GoogleApiClient mGoogleApiClient;
-
-        @Override
-        protected void onCreate(Bundle savedInstanceState) {
-            super.onCreate(savedInstanceState);
-
-            // Create a Google Fit Client instance with default user account.
-            mGoogleApiClient = new GoogleApiClient.Builder(this)
-                    .addApi(Fitness.SENSORS_API)  // Required for SensorsApi calls
-                    // Optional: specify more APIs used with additional calls to addApi
-                    .useDefaultAccount()
-                    .addScope(new Scope(Scopes.FITNESS))
-                    .addOnConnectionsCallbacks(this)
-                    .addOnConnectionFailedListener(this)
-                    .build();
-
-            mGoogleApiClient.connect();
-        }
-
-        @Override
-        public void onConnected(Bundle connectionHint) {
-            // Connected to Google Fit Client.
-            Fitness.SensorsApi.add(
-                    mGoogleApiClient,
-                    new SensorRequest.Builder()
-                            .setDataType(DataType.STEP_COUNT_DELTA)
-                            .build(),
-                    this);
-        }
-
-        @Override
-        public void onDataPoint(DataPoint dataPoint) {
-            // Do cool stuff that matters.
-        }
-
-        @Override
-        public void onConnectionSuspended(int cause) {
-            // The connection has been interrupted. Wait until onConnected() is called.
-        }
-
-        @Override
-        public void onConnectionFailed(ConnectionResult result) {
-            // Error while connecting. Try to resolve using the pending intent returned.
-            if (result.getErrorCode() == FitnessStatusCodes.NEEDS_OAUTH_PERMISSIONS) {
-                try {
-                    result.startResolutionForResult(this, REQUEST_OAUTH);
-                } catch (SendIntentException e) {
-                }
-            }
-        }
-
-        @Override
-        public void onActivityResult(int requestCode, int resultCode, Intent data) {
-            if (requestCode == REQUEST_OAUTH && resultCode == RESULT_OK) {
-                mGoogleApiClient.connect();
-            }
-        }
-
-

Intents

- Google Fit supports different intents in order to help fitness apps collaborate. To that - effect, different intent actions are defined in this class: - - Different objects in the Fitness data model can be used in intents, including - sessions, data sources, data types, and - activities. The documentation for each intent action specifies the - different attributes of the intent, including actions, MIME types, and extras. It also - specifies how the intents can be built and parsed using methods in the API. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_TRACK - Broadcast action: the user has requested that an application start or stop tracking - their activity. - - - -
StringACTION_VIEW - Broadcast action: the user has requested that an application show the value of a - particular fitness data type. - - - -
StringACTION_VIEW_GOAL - Broadcast action: the user has requested to view their current fitness goal. - - - -
StringEXTRA_END_TIME - Name for the long intent extra containing the end time. - - - -
StringEXTRA_START_TIME - Name for the long intent extra containing the start time. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - VoidAPI - - This field is deprecated. - in favor of granular API tokens. - - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>BLE_API - Token to pass to addApi(Api) to enable BleApi. - - - -
- public - static - final - BleApiBleApi - Entry point to the Google Fit BLE API. - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>CONFIG_API - Token to pass to addApi(Api) to enable ConfigApi. - - - -
- public - static - final - ConfigApiConfigApi - Entry point to the Google Fit Config API. - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>HISTORY_API - Token to pass to addApi(Api) to enable HistoryApi. - - - -
- public - static - final - HistoryApiHistoryApi - Entry point to the Google Fit History API. - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>RECORDING_API - Token to pass to addApi(Api) to enable RecordingApi. - - - -
- public - static - final - RecordingApiRecordingApi - Entry point to the Google Fit Recording API. - - - -
- public - static - final - ScopeSCOPE_ACTIVITY_READ - Scope for read access to activity-related data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_ACTIVITY_READ_WRITE - Scope for read/write access to activity-related data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_BODY_READ - Scope for read access to the biometric data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_BODY_READ_WRITE - Scope for read/write access to biometric data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_LOCATION_READ - Scope for read access to location-related data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_LOCATION_READ_WRITE - Scope for read/write access to location-related data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_NUTRITION_READ - Scope for read access to the nutrition data types in Google Fit, which include: - - - - - -
- public - static - final - ScopeSCOPE_NUTRITION_READ_WRITE - Scope for read/write access to nutrition data types in Google Fit, which include: - - - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>SENSORS_API - Token to pass to addApi(Api) to enable SensorsApi. - - - -
- public - static - final - Api<Api.ApiOptions.NoOptions>SESSIONS_API - Token to pass to addApi(Api) to enable SessionsApi. - - - -
- public - static - final - SensorsApiSensorsApi - Entry point to the Google Fit Sensors API. - - - -
- public - static - final - SessionsApiSessionsApi - Entry point to the Google Fit Sessions API. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - long - - getEndTime(Intent intent, TimeUnit timeUnit) - -
- Retrieves the end time extra from the given intent. - - - -
- -
- - - - static - - long - - getStartTime(Intent intent, TimeUnit timeUnit) - -
- Retrieves the start time extra from the given intent. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_TRACK -

-
- - - - -
-
- - - - -

Broadcast action: the user has requested that an application start or stop tracking - their activity. The intent will include the following attributes: -

    -
  • mimeType: this will be MIME_TYPE_PREFIX - followed by the name of the activity. Apps can use a MIME type filter to listen - only on activities they can track. - getMimeType(String) can be used to generate a MIME - type from an activity. -
  • Extra EXTRA_STATUS: an extra indicating the current status - of the activity (active or completed). -
-

- - -
- Constant Value: - - - "vnd.google.fitness.TRACK" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_VIEW -

-
- - - - -
-
- - - - -

Broadcast action: the user has requested that an application show the value of a - particular fitness data type. This could be an intent to visualize - the current value of a data type (such as the current heart rate), - or the value of a data type over a period of time. The extras will determine what the - particular intent is. -

- The intent will include the following attributes: -

    -
  • mimeType: this will be MIME_TYPE_PREFIX followed by - the name of the data type the user would like to visualize. Apps can use a MIME type - filter to listen only on data types they can visualize. The MIME type can be generated - by getMimeType(String). -
  • Extra EXTRA_START_TIME: an extra indicating the start time in - milliseconds since epoch, present if the user desires to visualize data over a period - of time. The start time can be extracted by getStartTime(Intent, TimeUnit). -
  • Extra EXTRA_END_TIME: an extra indicating the end time in - milliseconds since epoch, present if the user desires to visualize data over a period - of time. If end time isn't specified, but start time is, then the end time used - should be "now". The end time can be extracted by getEndTime(Intent, TimeUnit). -
  • Extra EXTRA_DATA_SOURCE: an optional extra indicating the - specific data source the user would like to visualize, if any. It can be extracted - using extract(Intent). -
-

- - -
- Constant Value: - - - "vnd.google.fitness.VIEW" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ACTION_VIEW_GOAL -

-
- - - - -
-
- - - - -

Broadcast action: the user has requested to view their current fitness goal. -

- - -
- Constant Value: - - - "vnd.google.fitness.VIEW_GOAL" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_END_TIME -

-
- - - - -
-
- - - - -

Name for the long intent extra containing the end time. It can be extracted using - getEndTime(Intent, TimeUnit) -

- - -
- Constant Value: - - - "vnd.google.fitness.end_time" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_START_TIME -

-
- - - - -
-
- - - - -

Name for the long intent extra containing the start time. It can be extracted using - getStartTime(Intent, TimeUnit). -

- - -
- Constant Value: - - - "vnd.google.fitness.start_time" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Void - - API -

-
- - - - -
-
- - - -

-

- This field is deprecated.
- in favor of granular API tokens. - -

-

Instead of API, you now need to use the specific API for the calls you're making, .e.g. - 

- // Create a Google Fit Client instance with default user account.
- mGoogleApiClient = new GoogleApiClient.Builder(this)
-         .addApi(Fitness.SENSORS_API)    // Required only if you're making SensorsApi calls
-         .addApi(Fitness.RECORDING_API)  // Required only if you're making RecordingApi calls
-         .addApi(Fitness.HISTORY_API)    // Required only if you're making HistoryApi calls
-         .addApi(Fitness.SESSIONS_API)   // Required only if you're making SessionsApi calls
-         // Optional: request more APIs with additional calls to addApi
-         .useDefaultAccount()
-         .addScope(new Scope(Scopes.FITNESS))
-         .addOnConnectionsCallbacks(this)
-         .addOnConnectionFailedListener(this)
-         .build();
-

-
-
See Also
- -
- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - BLE_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable BleApi. -

- - -
-
- - - - - -
-

- - public - static - final - BleApi - - BleApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit BLE API. -

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - CONFIG_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable ConfigApi. -

- - -
-
- - - - - -
-

- - public - static - final - ConfigApi - - ConfigApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit Config API. -

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - HISTORY_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable HistoryApi. -

- - -
-
- - - - - -
-

- - public - static - final - HistoryApi - - HistoryApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit History API. -

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - RECORDING_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable RecordingApi. -

- - -
-
- - - - - -
-

- - public - static - final - RecordingApi - - RecordingApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit Recording API. -

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_ACTIVITY_READ -

-
- - - - -
-
- - - - -

Scope for read access to activity-related data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_ACTIVITY_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to activity-related data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_BODY_READ -

-
- - - - -
-
- - - - -

Scope for read access to the biometric data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_BODY_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to biometric data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_LOCATION_READ -

-
- - - - -
-
- - - - -

Scope for read access to location-related data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_LOCATION_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to location-related data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_NUTRITION_READ -

-
- - - - -
-
- - - - -

Scope for read access to the nutrition data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_NUTRITION_READ_WRITE -

-
- - - - -
-
- - - - -

Scope for read/write access to nutrition data types in Google Fit, which include: -

-

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - SENSORS_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable SensorsApi. -

- - -
-
- - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - SESSIONS_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable SessionsApi. -

- - -
-
- - - - - -
-

- - public - static - final - SensorsApi - - SensorsApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit Sensors API. -

- - -
-
- - - - - -
-

- - public - static - final - SessionsApi - - SessionsApi -

-
- - - - -
-
- - - - -

Entry point to the Google Fit Sessions API. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - long - - getEndTime - (Intent intent, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Retrieves the end time extra from the given intent.

-
-
Parameters
- - - - - - - -
intent - the intent to extract the end time from
timeUnit - the desired time unit for the returned end time
-
-
-
Returns
-
  • the end time, in time unit since epoch, or -1 if not found -
-
- -
-
- - - - -
-

- - public - static - - - - long - - getStartTime - (Intent intent, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Retrieves the start time extra from the given intent.

-
-
Parameters
- - - - - - - -
intent - the intent to extract the start time from
timeUnit - the desired time unit for the returned start time
-
-
-
Returns
-
  • the start time, in time unit since epoch, or -1 if not found -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/FitnessActivities.html b/docs/html/reference/com/google/android/gms/fitness/FitnessActivities.html deleted file mode 100644 index 66cbe7272d55..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/FitnessActivities.html +++ /dev/null @@ -1,7446 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FitnessActivities | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

FitnessActivities

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.FitnessActivities
- - - - - - - -
- - -

Class Overview

-

Constants representing different user activities, such as walking, running, and cycling. - Activities are used in Sessions, - DataTypes and in - read queries. -

- A Session associates an activity with all data that - was recorded during a time interval, such as - heart rate samples - taken while the user was doing aerobics, or - wheel RPM measured - while biking. -

- Activities be stored and read using the - activity sample and - activity segment data - types. When samples are stored, these are automatically converted into segments by the - platform's default data source. -

- When reading data, the - activity segment - and activity type bucketing - strategies can be used to aggregate data by the activities happening at the time data was - collected. This would allow, for instance, aggregating step counts taken during running and - those taken during walking separately, or to query the average heart rate during each activity. -

- Each activity is represented by its name, which is a string constant. These constants are also - used in intents for tracking and visualizing activity data. Internally, activities are stored as - integers inside of DataPoint for efficiency. You can - convert between the String and int representations for storage using - setActivity(String) and - asActivity(). -

- A subset of the activities can be detected by - Activity Recognition and are - listed in DetectedActivity. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringAEROBICS - The user is performing aerobic exercises. - - - -
StringBADMINTON - The user is playing badminton. - - - -
StringBASEBALL - The user is playing baseball. - - - -
StringBASKETBALL - The user is playing basketball. - - - -
StringBIATHLON - The user is practicing biathlon (combination of cross-country skiing and rifle shooting). - - - -
StringBIKING - The user is on a bicycle. - - - -
StringBIKING_HAND - The user is handcycling (or handbiking). - - - -
StringBIKING_MOUNTAIN - The user is mountain biking. - - - -
StringBIKING_ROAD - The user is cycling on a road or other smooth surface. - - - -
StringBIKING_SPINNING - The user is indoor cycling (spinning) on a specialized stationary bike. - - - -
StringBIKING_STATIONARY - The user is cycling on a stationary bike. - - - -
StringBIKING_UTILITY - The user is cycling as a means of transport. - - - -
StringBOXING - The user is boxing. - - - -
StringCALISTHENICS - The user is performing calisthenics exercises. - - - -
StringCIRCUIT_TRAINING - The user is performing circuit training exercises. - - - -
StringCRICKET - The user is playing cricket. - - - -
StringCURLING - The user is practicing curling. - - - -
StringDANCING - The user is dancing. - - - -
StringDIVING - The user is diving into water, from a platform or spring board. - - - -
StringELLIPTICAL - The user is using an elliptical trainer or cross-trainer machine. - - - -
StringERGOMETER - The user is using an ergometer machine. - - - -
StringEXTRA_STATUS - Name for the String extra containing the status of an activity. - - - -
StringFENCING - The user is fencing. - - - -
StringFOOTBALL_AMERICAN - The user is playing American football (known as football in the United States). - - - -
StringFOOTBALL_AUSTRALIAN - The user is playing Australian-rules football. - - - -
StringFOOTBALL_SOCCER - The user is playing association football (known as soccer in the United States). - - - -
StringFRISBEE_DISC - The user is playing with a Frisbee disc. - - - -
StringGARDENING - The user is gardening. - - - -
StringGOLF - The user is playing golf. - - - -
StringGYMNASTICS - The user is practicing gymnastics. - - - -
StringHANDBALL - The user is playing handball. - - - -
StringHIKING - The user is hiking. - - - -
StringHOCKEY - The user is playing hockey. - - - -
StringHORSEBACK_RIDING - The user is horseback riding. - - - -
StringHOUSEWORK - The user is doing house work. - - - -
StringICE_SKATING - The user is ice-skating. - - - -
StringIN_VEHICLE - The user is in a vehicle, such as a car. - - - -
StringJUMP_ROPE - The user is jumping rope. - - - -
StringKAYAKING - The user is kayaking. - - - -
StringKETTLEBELL_TRAINING - The user is training with a kettlebell. - - - -
StringKICKBOXING - The user is kickboxing. - - - -
StringKICK_SCOOTER - The user is riding a kick scooter. - - - -
StringKITESURFING - The user is kite-surfing. - - - -
StringMARTIAL_ARTS - The user is practicing martial arts. - - - -
StringMEDITATION - The user is meditating. - - - -
StringMIME_TYPE_PREFIX - The common prefix for activity MIME types. - - - -
StringMIXED_MARTIAL_ARTS - The user is practicing mixed martial arts (MMA). - - - -
StringON_FOOT - The user is on foot, walking or running. - - - -
StringOTHER - The user is performing a generic fitness activity, which isn't classified. - - - -
StringP90X - The user is performing P90X exercises. - - - -
StringPARAGLIDING - The user is paragliding. - - - -
StringPILATES - The user is performing pilates exercises. - - - -
StringPOLO - The user is playing polo (team sport on horseback). - - - -
StringRACQUETBALL - The user is playing racquetball. - - - -
StringROCK_CLIMBING - The user is rock climbing. - - - -
StringROWING - The user is rowing. - - - -
StringROWING_MACHINE - The user is using a rowing machine. - - - -
StringRUGBY - The user is playing rugby. - - - -
StringRUNNING - The user is running. - - - -
StringRUNNING_JOGGING - The user is jogging. - - - -
StringRUNNING_SAND - The user is running on sand. - - - -
StringRUNNING_TREADMILL - The user is running on a treadmill. - - - -
StringSAILING - The user is sailing. - - - -
StringSCUBA_DIVING - The user is scuba diving. - - - -
StringSKATEBOARDING - The user is skateboarding. - - - -
StringSKATING - The user is skating. - - - -
StringSKATING_CROSS - The user is cross skating. - - - -
StringSKATING_INDOOR - The user is skating in-doors. - - - -
StringSKATING_INLINE - The user is inline skating (roller-blading). - - - -
StringSKIING - The user is skiing. - - - -
StringSKIING_BACK_COUNTRY - The user is back-country skiing. - - - -
StringSKIING_CROSS_COUNTRY - The user is cross-country skiing. - - - -
StringSKIING_DOWNHILL - The user is downhill skiing. - - - -
StringSKIING_KITE - The user is kite skiing. - - - -
StringSKIING_ROLLER - The user is roller skiing (non-snow). - - - -
StringSLEDDING - The user is sledding. - - - -
StringSLEEP - The user is sleeping. - - - -
StringSLEEP_AWAKE - The user is in an awake period in the middle of sleep. - - - -
StringSLEEP_DEEP - The user is in a deep sleep cycle. - - - -
StringSLEEP_LIGHT - The user is in a light sleep cycle. - - - -
StringSLEEP_REM - The user is in a REM sleep cycle. - - - -
StringSNOWBOARDING - The user is snowboarding. - - - -
StringSNOWMOBILE - The user is on a snow mobile. - - - -
StringSNOWSHOEING - The user is snow-shoeing. - - - -
StringSQUASH - The user is playing Squash. - - - -
StringSTAIR_CLIMBING - The user is climbing stairs. - - - -
StringSTAIR_CLIMBING_MACHINE - The user is using a stair-climbing machine. - - - -
StringSTANDUP_PADDLEBOARDING - The user is on a stand-up paddle board. - - - -
StringSTATUS_ACTIVE - Status indicating the activity has started. - - - -
StringSTATUS_COMPLETED - Status indicating the activity has ended. - - - -
StringSTILL - The user is still (not moving). - - - -
StringSTRENGTH_TRAINING - The user is strength training. - - - -
StringSURFING - The user is surfing. - - - -
StringSWIMMING - The user is swimming. - - - -
StringSWIMMING_OPEN_WATER - The user is swimming in open waters. - - - -
StringSWIMMING_POOL - The user is swimming in a swimming pool. - - - -
StringTABLE_TENNIS - The user is playing table tennis (or ping-pong). - - - -
StringTEAM_SPORTS - The user is playing a team sport. - - - -
StringTENNIS - The user is playing tennis. - - - -
StringTILTING - This is a synthetic activity used by the - Activity Recognition API to - indicate that the device angle relative to gravity changed significantly between the sample - immediately before and immediately after the "tilting" sample. - - - -
StringTREADMILL - The user is on a treadmill (either walking or running). - - - -
StringUNKNOWN - The current activity is not known. - - - -
StringVOLLEYBALL - The user is playing volleyball. - - - -
StringVOLLEYBALL_BEACH - The user is playing beach volleyball. - - - -
StringVOLLEYBALL_INDOOR - The user is playing indoor volleyball. - - - -
StringWAKEBOARDING - The user is wake boarding. - - - -
StringWALKING - The user is walking. - - - -
StringWALKING_FITNESS - The user is walking at a moderate to high pace, for fitness. - - - -
StringWALKING_NORDIC - The user is performing Nordic walking (with poles). - - - -
StringWALKING_TREADMILL - The user is walking on a treadmill - - - -
StringWATER_POLO - The user is playing water polo. - - - -
StringWEIGHTLIFTING - The user is weight lifting. - - - -
StringWHEELCHAIR - The user is on a wheel chair. - - - -
StringWINDSURFING - The user is wind surfing. - - - -
StringYOGA - The user is performing Yoga poses. - - - -
StringZUMBA - The users is performing Zumba exercises. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getMimeType(String activity) - -
- Returns the MIME type for a particular activity. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - AEROBICS -

-
- - - - -
-
- - - - -

The user is performing aerobic exercises.

- - -
- Constant Value: - - - "aerobics" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BADMINTON -

-
- - - - -
-
- - - - -

The user is playing badminton.

- - -
- Constant Value: - - - "badminton" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BASEBALL -

-
- - - - -
-
- - - - -

The user is playing baseball.

- - -
- Constant Value: - - - "baseball" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BASKETBALL -

-
- - - - -
-
- - - - -

The user is playing basketball.

- - -
- Constant Value: - - - "basketball" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIATHLON -

-
- - - - -
-
- - - - -

The user is practicing biathlon (combination of cross-country skiing and rifle shooting).

- - -
- Constant Value: - - - "biathlon" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING -

-
- - - - -
-
- - - - -

The user is on a bicycle.

- - -
- Constant Value: - - - "biking" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_HAND -

-
- - - - -
-
- - - - -

The user is handcycling (or handbiking).

- - -
- Constant Value: - - - "biking.hand" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_MOUNTAIN -

-
- - - - -
-
- - - - -

The user is mountain biking.

- - -
- Constant Value: - - - "biking.mountain" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_ROAD -

-
- - - - -
-
- - - - -

The user is cycling on a road or other smooth surface.

- - -
- Constant Value: - - - "biking.road" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_SPINNING -

-
- - - - -
-
- - - - -

The user is indoor cycling (spinning) on a specialized stationary bike.

- - -
- Constant Value: - - - "biking.spinning" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_STATIONARY -

-
- - - - -
-
- - - - -

The user is cycling on a stationary bike.

- - -
- Constant Value: - - - "biking.stationary" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BIKING_UTILITY -

-
- - - - -
-
- - - - -

The user is cycling as a means of transport.

- - -
- Constant Value: - - - "biking.utility" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - BOXING -

-
- - - - -
-
- - - - -

The user is boxing.

- - -
- Constant Value: - - - "boxing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CALISTHENICS -

-
- - - - -
-
- - - - -

The user is performing calisthenics exercises.

- - -
- Constant Value: - - - "calisthenics" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CIRCUIT_TRAINING -

-
- - - - -
-
- - - - -

The user is performing circuit training exercises.

- - -
- Constant Value: - - - "circuit_training" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CRICKET -

-
- - - - -
-
- - - - -

The user is playing cricket.

- - -
- Constant Value: - - - "cricket" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - CURLING -

-
- - - - -
-
- - - - -

The user is practicing curling.

- - -
- Constant Value: - - - "curling" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - DANCING -

-
- - - - -
-
- - - - -

The user is dancing.

- - -
- Constant Value: - - - "dancing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - DIVING -

-
- - - - -
-
- - - - -

The user is diving into water, from a platform or spring board.

- - -
- Constant Value: - - - "diving" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ELLIPTICAL -

-
- - - - -
-
- - - - -

The user is using an elliptical trainer or cross-trainer machine.

- - -
- Constant Value: - - - "elliptical" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERGOMETER -

-
- - - - -
-
- - - - -

The user is using an ergometer machine.

- - -
- Constant Value: - - - "ergometer" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_STATUS -

-
- - - - -
-
- - - - -

Name for the String extra containing the status of an activity. This is a mandatory - extra for ACTION_TRACK intents, and holds one of the following values: -

-

- - -
- Constant Value: - - - "actionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FENCING -

-
- - - - -
-
- - - - -

The user is fencing.

- - -
- Constant Value: - - - "fencing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FOOTBALL_AMERICAN -

-
- - - - -
-
- - - - -

The user is playing American football (known as football in the United States).

- - -
- Constant Value: - - - "football.american" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FOOTBALL_AUSTRALIAN -

-
- - - - -
-
- - - - -

The user is playing Australian-rules football.

- - -
- Constant Value: - - - "football.australian" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FOOTBALL_SOCCER -

-
- - - - -
-
- - - - -

The user is playing association football (known as soccer in the United States).

- - -
- Constant Value: - - - "football.soccer" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - FRISBEE_DISC -

-
- - - - -
-
- - - - -

The user is playing with a Frisbee disc.

- - -
- Constant Value: - - - "frisbee_disc" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GARDENING -

-
- - - - -
-
- - - - -

The user is gardening.

- - -
- Constant Value: - - - "gardening" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GOLF -

-
- - - - -
-
- - - - -

The user is playing golf.

- - -
- Constant Value: - - - "golf" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - GYMNASTICS -

-
- - - - -
-
- - - - -

The user is practicing gymnastics.

- - -
- Constant Value: - - - "gymnastics" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - HANDBALL -

-
- - - - -
-
- - - - -

The user is playing handball.

- - -
- Constant Value: - - - "handball" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - HIKING -

-
- - - - -
-
- - - - -

The user is hiking.

- - -
- Constant Value: - - - "hiking" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - HOCKEY -

-
- - - - -
-
- - - - -

The user is playing hockey.

- - -
- Constant Value: - - - "hockey" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - HORSEBACK_RIDING -

-
- - - - -
-
- - - - -

The user is horseback riding.

- - -
- Constant Value: - - - "horseback_riding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - HOUSEWORK -

-
- - - - -
-
- - - - -

The user is doing house work.

- - -
- Constant Value: - - - "housework" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ICE_SKATING -

-
- - - - -
-
- - - - -

The user is ice-skating.

- - -
- Constant Value: - - - "ice_skating" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - IN_VEHICLE -

-
- - - - -
-
- - - - -

The user is in a vehicle, such as a car.

- - -
- Constant Value: - - - "in_vehicle" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - JUMP_ROPE -

-
- - - - -
-
- - - - -

The user is jumping rope.

- - -
- Constant Value: - - - "jump_rope" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KAYAKING -

-
- - - - -
-
- - - - -

The user is kayaking.

- - -
- Constant Value: - - - "kayaking" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KETTLEBELL_TRAINING -

-
- - - - -
-
- - - - -

The user is training with a kettlebell.

- - -
- Constant Value: - - - "kettlebell_training" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KICKBOXING -

-
- - - - -
-
- - - - -

The user is kickboxing.

- - -
- Constant Value: - - - "kickboxing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KICK_SCOOTER -

-
- - - - -
-
- - - - -

The user is riding a kick scooter.

- - -
- Constant Value: - - - "kick_scooter" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KITESURFING -

-
- - - - -
-
- - - - -

The user is kite-surfing.

- - -
- Constant Value: - - - "kitesurfing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MARTIAL_ARTS -

-
- - - - -
-
- - - - -

The user is practicing martial arts.

- - -
- Constant Value: - - - "martial_arts" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MEDITATION -

-
- - - - -
-
- - - - -

The user is meditating.

- - -
- Constant Value: - - - "meditation" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MIME_TYPE_PREFIX -

-
- - - - -
-
- - - - -

The common prefix for activity MIME types. The MIME type for a particular activity type will - be this prefix followed by the activity name. Examples: - 

- vnd.google.fitness.activity/walking
- vnd.google.fitness.activity/biking.mountain
- vnd.google.fitness.activity/jump_rope
-
- The names for all activities are described by the constants in this - class. The full MIME type can be computed using getMimeType(String) -

- - -
- Constant Value: - - - "vnd.google.fitness.activity/" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MIXED_MARTIAL_ARTS -

-
- - - - -
-
- - - - -

The user is practicing mixed martial arts (MMA).

- - -
- Constant Value: - - - "martial_arts.mixed" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ON_FOOT -

-
- - - - -
-
- - - - -

The user is on foot, walking or running. It's preferred to use the more specific activity - when known. -

- - -
- Constant Value: - - - "on_foot" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - OTHER -

-
- - - - -
-
- - - - -

The user is performing a generic fitness activity, which isn't classified. -

- Unlike unknown, which gives no indication as to what the user is doing, - "other" indicates that the user is performing a fitness-related activity. -

- The "other" activity is most useful to collect user input, for instance when an app wants to - give the user the ability to choose an activity that's not part of the regular activity set - for the app. -

- Note that an activity classified as "other" could represent any of the other activities in - this activity list, as well as an activity not in this list. -

- - -
- Constant Value: - - - "other" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - P90X -

-
- - - - -
-
- - - - -

The user is performing P90X exercises.

- - -
- Constant Value: - - - "p90x" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAGLIDING -

-
- - - - -
-
- - - - -

The user is paragliding.

- - -
- Constant Value: - - - "paragliding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PILATES -

-
- - - - -
-
- - - - -

The user is performing pilates exercises.

- - -
- Constant Value: - - - "pilates" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - POLO -

-
- - - - -
-
- - - - -

The user is playing polo (team sport on horseback).

- - -
- Constant Value: - - - "polo" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RACQUETBALL -

-
- - - - -
-
- - - - -

The user is playing racquetball.

- - -
- Constant Value: - - - "racquetball" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ROCK_CLIMBING -

-
- - - - -
-
- - - - -

The user is rock climbing.

- - -
- Constant Value: - - - "rock_climbing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ROWING -

-
- - - - -
-
- - - - -

The user is rowing.

- - -
- Constant Value: - - - "rowing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ROWING_MACHINE -

-
- - - - -
-
- - - - -

The user is using a rowing machine.

- - -
- Constant Value: - - - "rowing.machine" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RUGBY -

-
- - - - -
-
- - - - -

The user is playing rugby.

- - -
- Constant Value: - - - "rugby" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RUNNING -

-
- - - - -
-
- - - - -

The user is running.

- - -
- Constant Value: - - - "running" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RUNNING_JOGGING -

-
- - - - -
-
- - - - -

The user is jogging.

- - -
- Constant Value: - - - "running.jogging" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RUNNING_SAND -

-
- - - - -
-
- - - - -

The user is running on sand.

- - -
- Constant Value: - - - "running.sand" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - RUNNING_TREADMILL -

-
- - - - -
-
- - - - -

The user is running on a treadmill.

- - -
- Constant Value: - - - "running.treadmill" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SAILING -

-
- - - - -
-
- - - - -

The user is sailing.

- - -
- Constant Value: - - - "sailing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SCUBA_DIVING -

-
- - - - -
-
- - - - -

The user is scuba diving.

- - -
- Constant Value: - - - "scuba_diving" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKATEBOARDING -

-
- - - - -
-
- - - - -

The user is skateboarding.

- - -
- Constant Value: - - - "skateboarding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKATING -

-
- - - - -
-
- - - - -

The user is skating.

- - -
- Constant Value: - - - "skating" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKATING_CROSS -

-
- - - - -
-
- - - - -

The user is cross skating.

- - -
- Constant Value: - - - "skating.cross" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKATING_INDOOR -

-
- - - - -
-
- - - - -

The user is skating in-doors.

- - -
- Constant Value: - - - "skating.indoor" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKATING_INLINE -

-
- - - - -
-
- - - - -

The user is inline skating (roller-blading).

- - -
- Constant Value: - - - "skating.inline" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING -

-
- - - - -
-
- - - - -

The user is skiing.

- - -
- Constant Value: - - - "skiing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING_BACK_COUNTRY -

-
- - - - -
-
- - - - -

The user is back-country skiing.

- - -
- Constant Value: - - - "skiing.back_country" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING_CROSS_COUNTRY -

-
- - - - -
-
- - - - -

The user is cross-country skiing.

- - -
- Constant Value: - - - "skiing.cross_country" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING_DOWNHILL -

-
- - - - -
-
- - - - -

The user is downhill skiing.

- - -
- Constant Value: - - - "skiing.downhill" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING_KITE -

-
- - - - -
-
- - - - -

The user is kite skiing.

- - -
- Constant Value: - - - "skiing.kite" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SKIING_ROLLER -

-
- - - - -
-
- - - - -

The user is roller skiing (non-snow).

- - -
- Constant Value: - - - "skiing.roller" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEDDING -

-
- - - - -
-
- - - - -

The user is sledding.

- - -
- Constant Value: - - - "sledding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEEP -

-
- - - - -
-
- - - - -

The user is sleeping.

- - -
- Constant Value: - - - "sleep" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEEP_AWAKE -

-
- - - - -
-
- - - - -

The user is in an awake period in the middle of sleep.

- - -
- Constant Value: - - - "sleep.awake" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEEP_DEEP -

-
- - - - -
-
- - - - -

The user is in a deep sleep cycle.

- - -
- Constant Value: - - - "sleep.deep" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEEP_LIGHT -

-
- - - - -
-
- - - - -

The user is in a light sleep cycle.

- - -
- Constant Value: - - - "sleep.light" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SLEEP_REM -

-
- - - - -
-
- - - - -

The user is in a REM sleep cycle.

- - -
- Constant Value: - - - "sleep.rem" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SNOWBOARDING -

-
- - - - -
-
- - - - -

The user is snowboarding.

- - -
- Constant Value: - - - "snowboarding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SNOWMOBILE -

-
- - - - -
-
- - - - -

The user is on a snow mobile.

- - -
- Constant Value: - - - "snowmobile" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SNOWSHOEING -

-
- - - - -
-
- - - - -

The user is snow-shoeing.

- - -
- Constant Value: - - - "snowshoeing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SQUASH -

-
- - - - -
-
- - - - -

The user is playing Squash.

- - -
- Constant Value: - - - "squash" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STAIR_CLIMBING -

-
- - - - -
-
- - - - -

The user is climbing stairs.

- - -
- Constant Value: - - - "stair_climbing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STAIR_CLIMBING_MACHINE -

-
- - - - -
-
- - - - -

The user is using a stair-climbing machine.

- - -
- Constant Value: - - - "stair_climbing.machine" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STANDUP_PADDLEBOARDING -

-
- - - - -
-
- - - - -

The user is on a stand-up paddle board.

- - -
- Constant Value: - - - "standup_paddleboarding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STATUS_ACTIVE -

-
- - - - -
-
- - - - -

Status indicating the activity has started.

- - -
- Constant Value: - - - "ActiveActionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STATUS_COMPLETED -

-
- - - - -
-
- - - - -

Status indicating the activity has ended.

- - -
- Constant Value: - - - "CompletedActionStatus" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STILL -

-
- - - - -
-
- - - - -

The user is still (not moving).

- - -
- Constant Value: - - - "still" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - STRENGTH_TRAINING -

-
- - - - -
-
- - - - -

The user is strength training.

- - -
- Constant Value: - - - "strength_training" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SURFING -

-
- - - - -
-
- - - - -

The user is surfing.

- - -
- Constant Value: - - - "surfing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SWIMMING -

-
- - - - -
-
- - - - -

The user is swimming.

- - -
- Constant Value: - - - "swimming" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SWIMMING_OPEN_WATER -

-
- - - - -
-
- - - - -

The user is swimming in open waters.

- - -
- Constant Value: - - - "swimming.open_water" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - SWIMMING_POOL -

-
- - - - -
-
- - - - -

The user is swimming in a swimming pool.

- - -
- Constant Value: - - - "swimming.pool" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TABLE_TENNIS -

-
- - - - -
-
- - - - -

The user is playing table tennis (or ping-pong).

- - -
- Constant Value: - - - "table_tennis" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TEAM_SPORTS -

-
- - - - -
-
- - - - -

The user is playing a team sport.

- - -
- Constant Value: - - - "team_sports" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TENNIS -

-
- - - - -
-
- - - - -

The user is playing tennis.

- - -
- Constant Value: - - - "tennis" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TILTING -

-
- - - - -
-
- - - - -

This is a synthetic activity used by the - Activity Recognition API to - indicate that the device angle relative to gravity changed significantly between the sample - immediately before and immediately after the "tilting" sample. This often occurs when a - device is picked up from a desk or when a user who is sitting stands up. -

- - -
- Constant Value: - - - "tilting" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - TREADMILL -

-
- - - - -
-
- - - - -

The user is on a treadmill (either walking or running).

- - -
- Constant Value: - - - "treadmill" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - UNKNOWN -

-
- - - - -
-
- - - - -

The current activity is not known. In this case, the activity could be any of the - activities described in this class, or a completely different one. -

- - -
- Constant Value: - - - "unknown" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - VOLLEYBALL -

-
- - - - -
-
- - - - -

The user is playing volleyball.

- - -
- Constant Value: - - - "volleyball" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - VOLLEYBALL_BEACH -

-
- - - - -
-
- - - - -

The user is playing beach volleyball.

- - -
- Constant Value: - - - "volleyball.beach" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - VOLLEYBALL_INDOOR -

-
- - - - -
-
- - - - -

The user is playing indoor volleyball.

- - -
- Constant Value: - - - "volleyball.indoor" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WAKEBOARDING -

-
- - - - -
-
- - - - -

The user is wake boarding.

- - -
- Constant Value: - - - "wakeboarding" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WALKING -

-
- - - - -
-
- - - - -

The user is walking.

- - -
- Constant Value: - - - "walking" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WALKING_FITNESS -

-
- - - - -
-
- - - - -

The user is walking at a moderate to high pace, for fitness.

- - -
- Constant Value: - - - "walking.fitness" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WALKING_NORDIC -

-
- - - - -
-
- - - - -

The user is performing Nordic walking (with poles).

- - -
- Constant Value: - - - "walking.nordic" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WALKING_TREADMILL -

-
- - - - -
-
- - - - -

The user is walking on a treadmill

- - -
- Constant Value: - - - "walking.treadmill" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WATER_POLO -

-
- - - - -
-
- - - - -

The user is playing water polo.

- - -
- Constant Value: - - - "water_polo" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WEIGHTLIFTING -

-
- - - - -
-
- - - - -

The user is weight lifting.

- - -
- Constant Value: - - - "weightlifting" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WHEELCHAIR -

-
- - - - -
-
- - - - -

The user is on a wheel chair.

- - -
- Constant Value: - - - "wheelchair" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - WINDSURFING -

-
- - - - -
-
- - - - -

The user is wind surfing.

- - -
- Constant Value: - - - "windsurfing" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - YOGA -

-
- - - - -
-
- - - - -

The user is performing Yoga poses.

- - -
- Constant Value: - - - "yoga" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ZUMBA -

-
- - - - -
-
- - - - -

The users is performing Zumba exercises.

- - -
- Constant Value: - - - "zumba" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getMimeType - (String activity) -

-
-
- - - -
-
- - - - -

Returns the MIME type for a particular activity. The MIME type is used in intents for - viewing a session and - tracking an activity.

-
-
Parameters
- - - - -
activity - the desired activity. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/FitnessStatusCodes.html b/docs/html/reference/com/google/android/gms/fitness/FitnessStatusCodes.html deleted file mode 100644 index b2d6cfb96b44..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/FitnessStatusCodes.html +++ /dev/null @@ -1,2707 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FitnessStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

FitnessStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.fitness.FitnessStatusCodes
- - - - - - - -
- - -

Class Overview

-

Google Fit specific status codes, for use in getStatusCode() -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAGGREGATION_NOT_SUPPORTED - Status code denotes that a read request specified an un-supported data type as input for - aggregation. - - - -
intAPI_EXCEPTION - Status code denotes that an API call to Google backend failed, - due to possible network issues. - - - -
intAPP_MISMATCH - Status code denotes that the app tried to insert data form the wrong app. - - - -
intAPP_NOT_FIT_ENABLED - Status code denotes that an app was not found in the list of connected apps in Google Fit. - - - -
intCONFLICTING_DATA_TYPE - Status code denotes that the app attempted to insert a conflicting DataType, i.e. - - - -
intDATA_TYPE_NOT_FOUND - Status code denotes that the requested data type was not found. - - - -
intDISABLED_BLUETOOTH - Status code denotes that Bluetooth is currently disabled. - - - -
intEQUIVALENT_SESSION_ENDED - Status code denotes that a session could not be started because an equivalent session has - already ended. - - - -
intINCONSISTENT_DATA_TYPE - Status code denotes that the app attempted to insert a DataType whose name does not match - the app's package name. - - - -
intINCONSISTENT_PACKAGE_NAME - Status code denotes that app attempted to insert data for a DataSource that does not match - the app's package name. - - - -
intMISSING_BLE_PERMISSION - Status code denotes that the app is missing the required Bluetooth permissions in its - manifest. - - - -
intNEEDS_OAUTH_PERMISSIONS - Status code denotes that the request is missing desired OAuth permissions. - - - -
intSUCCESS_ALREADY_SUBSCRIBED - The subscribe request succeeded, but the subscription already existed, so it was a no-op. - - - -
intSUCCESS_NO_CLAIMED_DEVICE - The unclaim request succeeded, but no matching claimed device was found. - - - -
intSUCCESS_NO_DATA_SOURCES - The subscribe request succeeded, but no data sources are currently available that match it. - - - -
intTRANSIENT_ERROR - Status code denotes that there was a transient error accessing Google Fit services. - - - -
intUNKNOWN_AUTH_ERROR - Status code denotes that an unknown error occurred while trying to obtain an OAuth token. - - - -
intUNSUPPORTED_ACCOUNT - Status code denotes that the account is not supported. - - - -
intUNSUPPORTED_PLATFORM - Status code denotes that the operation is not supported by Google Fit. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - FitnessStatusCodes() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - AGGREGATION_NOT_SUPPORTED -

-
- - - - -
-
- - - - -

Status code denotes that a read request specified an un-supported data type as input for - aggregation. -

- - -
- Constant Value: - - - 5012 - (0x00001394) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - API_EXCEPTION -

-
- - - - -
-
- - - - -

Status code denotes that an API call to Google backend failed, - due to possible network issues. -

- - -
- Constant Value: - - - 5011 - (0x00001393) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - APP_MISMATCH -

-
- - - - -
-
- - - - -

Status code denotes that the app tried to insert data form the wrong app. -

- - -
- Constant Value: - - - 5004 - (0x0000138c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - APP_NOT_FIT_ENABLED -

-
- - - - -
-
- - - - -

Status code denotes that an app was not found in the list of connected apps in Google Fit. - Signifies that either access to the app was already revoked, or the app is not registered - on the developer's console. -

- - -
- Constant Value: - - - 5010 - (0x00001392) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CONFLICTING_DATA_TYPE -

-
- - - - -
-
- - - - -

Status code denotes that the app attempted to insert a conflicting DataType, i.e. there is an - existing DataType with the same name and different fields. -

- - -
- Constant Value: - - - 5001 - (0x00001389) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DATA_TYPE_NOT_FOUND -

-
- - - - -
-
- - - - -

Status code denotes that the requested data type was not found. -

- - -
- Constant Value: - - - 5003 - (0x0000138b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DISABLED_BLUETOOTH -

-
- - - - -
-
- - - - -

Status code denotes that Bluetooth is currently disabled. -

- - -
- Constant Value: - - - 5014 - (0x00001396) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - EQUIVALENT_SESSION_ENDED -

-
- - - - -
-
- - - - -

Status code denotes that a session could not be started because an equivalent session has - already ended. -

- - -
- Constant Value: - - - 5009 - (0x00001391) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INCONSISTENT_DATA_TYPE -

-
- - - - -
-
- - - - -

Status code denotes that the app attempted to insert a DataType whose name does not match - the app's package name. -

- - -
- Constant Value: - - - 5002 - (0x0000138a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INCONSISTENT_PACKAGE_NAME -

-
- - - - -
-
- - - - -

Status code denotes that app attempted to insert data for a DataSource that does not match - the app's package name. -

- - -
- Constant Value: - - - 5015 - (0x00001397) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MISSING_BLE_PERMISSION -

-
- - - - -
-
- - - - -

Status code denotes that the app is missing the required Bluetooth permissions in its - manifest. -

- - -
- Constant Value: - - - 5006 - (0x0000138e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NEEDS_OAUTH_PERMISSIONS -

-
- - - - -
-
- - - - -

Status code denotes that the request is missing desired OAuth permissions. -

- If an app does not have the required OAuth access for a specific API request, - the request will fail with this status code. When this occurs, - apps can use the pending intent inside the status object to request the necessary access - before retrying the request. -

- Sample usage when access is missing for a request: - 

-     PendingResult pendingResult = FitnessApi.readData(fitnessRequest);
-     Result result = pendingResult.await(3L, TimeUnit.SECONDS);
-     Status = result.getStatus();
-
-     if (!status.isSuccess()) {
-          if (status.getStatusCode() == FitnessStatusCodes.NEEDS_OAUTH_PERMISSIONS) {
-              status.startResolutionForResult(
-                      myActivity,
-                      MY_ACTIVITYS_AUTH_REQUEST_CODE);
-          }
-     }
-
-

- - -
- Constant Value: - - - 5000 - (0x00001388) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS_ALREADY_SUBSCRIBED -

-
- - - - -
-
- - - - -

The subscribe request succeeded, but the subscription already existed, so it was a no-op. -

- - -
- Constant Value: - - - -5001 - (0xffffec77) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS_NO_CLAIMED_DEVICE -

-
- - - - -
-
- - - - -

The unclaim request succeeded, but no matching claimed device was found. - No changes were made. -

- - -
- Constant Value: - - - -5002 - (0xffffec76) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS_NO_DATA_SOURCES -

-
- - - - -
-
- - - - -

The subscribe request succeeded, but no data sources are currently available that match it. - Recording of data will start when data sources become available. -

- - -
- Constant Value: - - - -5000 - (0xffffec78) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TRANSIENT_ERROR -

-
- - - - -
-
- - - - -

Status code denotes that there was a transient error accessing Google Fit services. - Clients may retry. -

- - -
- Constant Value: - - - 5008 - (0x00001390) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN_AUTH_ERROR -

-
- - - - -
-
- - - - -

Status code denotes that an unknown error occurred while trying to obtain an OAuth token. -

- - -
- Constant Value: - - - 5005 - (0x0000138d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNSUPPORTED_ACCOUNT -

-
- - - - -
-
- - - - -

Status code denotes that the account is not supported. -

- - -
- Constant Value: - - - 5013 - (0x00001395) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNSUPPORTED_PLATFORM -

-
- - - - -
-
- - - - -

Status code denotes that the operation is not supported by Google Fit. -

- - -
- Constant Value: - - - 5007 - (0x0000138f) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - FitnessStatusCodes - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/HistoryApi.ViewIntentBuilder.html b/docs/html/reference/com/google/android/gms/fitness/HistoryApi.ViewIntentBuilder.html deleted file mode 100644 index 6724c7bd1fa1..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/HistoryApi.ViewIntentBuilder.html +++ /dev/null @@ -1,1658 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HistoryApi.ViewIntentBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

HistoryApi.ViewIntentBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.HistoryApi.ViewIntentBuilder
- - - - - - - -
- - -

Class Overview

-

Builder of intents to view data stored in Google Fit. This intent can be used when - the application wants to display a more detailed view of a particular - data type. Apps that can handle the data type (such as the app - that inserted the data) can register for the intent. -

- If desired, setPreferredApplication(String) can be called to choose a specific - application to handle the intent, if the application is installed on the device. - This will often be the application defined in - getAppPackageName(). -

- The data view intent has the following attributes: -

    -
  • action is set to ACTION_VIEW -
  • type is MIME_TYPE_PREFIX followed by the data type - name. - For example, vnd.google.fitness.data_type/com.google.heart_rate.bpm could be used - for an intent to view heart rate. -
  • extras contain the data source, start time, and end time. Each of them has a - corresponding constant defined in Fitness. -
-

- An application that would like to handle History view intents should create an activity and - add an intent filter to its manifest file. Here's an example activity that can display heart - rate data: - 

- <activity android:name=".ViewHeartRateActivity" android:exported="true">
-    <intent-filter>
-      <action android:name="vnd.google.fitness.VIEW" />
-      <category android:name="android.intent.category.DEFAULT" />
-      <data android:mimeType="vnd.google.fitness.data_type/com.google.heart_rate.bpm" />
-   </intent-filter>
- </activity>
-
- If the application is only able to shown its own data (and not that from other apps), - it can opt-out of implicit intents by removing CATEGORY_DEFAULT from the - intent filter above. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - HistoryApi.ViewIntentBuilder(Context context, DataType dataType) - -
- Starts building an intent to view History data. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Intent - - build() - -
- Returns the built intent, which can be used with startActivity(Intent) to - launch the desired Fitness activity. - - - -
- -
- - - - - - HistoryApi.ViewIntentBuilder - - setDataSource(DataSource dataSource) - -
- Sets the data source to display data for, if a specific data source is desired. - - - -
- -
- - - - - - HistoryApi.ViewIntentBuilder - - setPreferredApplication(String packageName) - -
- Sets a preferred application to use for this intent. - - - -
- -
- - - - - - HistoryApi.ViewIntentBuilder - - setTimeInterval(long start, long end, TimeUnit timeUnit) - -
- Sets the time interval to display data for. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - HistoryApi.ViewIntentBuilder - (Context context, DataType dataType) -

-
-
- - - -
-
- - - - -

Starts building an intent to view History data.

-
-
Parameters
- - - - - - - -
context - a valid context
dataType - the data type we want to visualize -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Intent - - build - () -

-
-
- - - -
-
- - - - -

Returns the built intent, which can be used with startActivity(Intent) to - launch the desired Fitness activity.

-
-
Throws
- - - - -
IllegalStateException - if not enough data has been passed into the Builder to - build a valid intent. -
-
- -
-
- - - - -
-

- - public - - - - - HistoryApi.ViewIntentBuilder - - setDataSource - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Sets the data source to display data for, if a specific data source is desired. - Otherwise, the viewer can choose any data source or use the default one.

-
-
Parameters
- - - - -
dataSource - the specific data source we want to display data for -
-
- -
-
- - - - -
-

- - public - - - - - HistoryApi.ViewIntentBuilder - - setPreferredApplication - (String packageName) -

-
-
- - - -
-
- - - - -

Sets a preferred application to use for this intent. If the given app is installed and - able to handle this intent, an explicit intent will be returned. This can be used in - combination with getAppPackageName() to link back to the original - application which inserted the data being displayed.

-
-
Parameters
- - - - -
packageName - the package name for the application we want to link to
-
-
-
Returns
-
  • this builder, for chaining -
-
- -
-
- - - - -
-

- - public - - - - - HistoryApi.ViewIntentBuilder - - setTimeInterval - (long start, long end, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the time interval to display data for. Every intent requires a valid time interval.

-
-
Parameters
- - - - - - - - - - -
start - start time, inclusive, in time since epoch
end - end time, exclusive, in time since epoch
timeUnit - the timeUnit for start and end times -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/HistoryApi.html b/docs/html/reference/com/google/android/gms/fitness/HistoryApi.html deleted file mode 100644 index 9566b2bb3e86..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/HistoryApi.html +++ /dev/null @@ -1,1384 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -HistoryApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

HistoryApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.HistoryApi
- - - - - - - -
- - -

Class Overview

-

API for inserting, deleting, and reading data in Google Fit. -

- The readData(GoogleApiClient, DataReadRequest) method should be used whenever historical - data is needed. It can be combined with a subscription in the Recording Api - to collect data in the background and query it later for displaying. -

- The insertData(GoogleApiClient, DataSet) method can be used for batch insertion of - data that was collected outside of Google Fit. It can be useful when data is entered directly - by the user or imported from a device that isn't supported by the platform. -

- The History API should be accessed via the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.HISTORY_API)
-         ...
-         .build();
-     client.connect();
-
-     PendingResult<DataReadResult> pendingResult = Fitness.HistoryApi.readData(
-         client,
-         new DataReadRequest.Builder()
-             .read(DataType.TYPE_STEP_COUNT_DELTA)
-             .setTimeRange(startTime.getMillis(), endTime.getMillis(), TimeUnit.MILLISECONDS)
-             .build());
-
-     DataReadResult readDataResult = pendingResult.await();
-     DataSet dataSet = readDataResult.getDataSet(DataType.TYPE_STEP_COUNT_DELTA);
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classHistoryApi.ViewIntentBuilder - Builder of intents to view data stored in Google Fit.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - deleteData(GoogleApiClient client, DataDeleteRequest request) - -
- Deletes data from the user’s Google Fit history. - - - -
- -
- abstract - - - - - PendingResult<Status> - - insertData(GoogleApiClient client, DataSet dataSet) - -
- Inserts data collected from a data source directly into the user’s Google Fit history, - on behalf of the current application. - - - -
- -
- abstract - - - - - PendingResult<DailyTotalResult> - - readDailyTotal(GoogleApiClient client, DataType dataType) - -
- Reads the current daily total for the given dataType. - - - -
- -
- abstract - - - - - PendingResult<DataReadResult> - - readData(GoogleApiClient client, DataReadRequest request) - -
- Reads data from the user’s Google Fit history. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - deleteData - (GoogleApiClient client, DataDeleteRequest request) -

-
-
- - - -
-
- - - - -

Deletes data from the user’s Google Fit history. This request will fail if the requesting - app tries to delete data that it hasn't inserted. The user can delete data from any - application (or hardware sensors) by visiting the Google Fit dashboard.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the deletion will be delayed until the connection is complete.
request - specifying the data source/type and time range to delete
-
-
-
Returns
-
  • a pending result containing status of the request -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - insertData - (GoogleApiClient client, DataSet dataSet) -

-
-
- - - -
-
- - - - -

Inserts data collected from a data source directly into the user’s Google Fit history, - on behalf of the current application. Useful when the data source isn't compatible with - Google Fit or for importing historical data. -

- If the data source can be exposed via a - BLE GATT profile, - an application-exposed sensor, or some other method compatible - with Google Fit, it's preferable to create a subscription via the Recording API instead of - inserting data directly.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the insertion will be delayed until the connection is complete.
dataSet - the data we’re adding
-
-
-
Returns
-
  • a pending result containing the status of the request -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DailyTotalResult> - - readDailyTotal - (GoogleApiClient client, DataType dataType) -

-
-
- - - -
-
- - - - -

Reads the current daily total for the given dataType. The daily total will be - computed from midnight of the current day on the device's current timezone. The method - can be used as follows: - 

-   PendingResult<DailyTotalResult> result = HistoryApi.readDailyTotal(client, TYPE_STEP_COUNT_DELTA);
-   DailyTotalResult totalResult = result.await(30, SECONDS);
-   if (totalResult.getStatus().isSuccess()) {
-     DataSet totalSet = totalResult.getTotal();
-     long total = totalSet.isEmpty()
-         ? 0
-         : totalSet.getDataPoints().get(0).getValue(FIELD_STEPS).asInt();
-   } else {
-     // handle failure
-   }
-
- -

This is a simplified version of - readData(). When the requested data - type is TYPE_STEP_COUNT_DELTA, authentication is not required to call this - method, making it specially suited for use by Watchface and Widget activities that don't - have the ability to show an authentication panel to the user. - -

This method is equivalent to: - 

-   readData(client, new DataReadRequest.Builder()
-       .setTimeRange(midnight.getMillis(), now.getMillis(), TimeUnit.MILLISECONDS)
-       .bucketByTime(1, TimeUnit.DAYS)
-       .aggregate(DataTypes.STEP_COUNT_DELTA, AggregateDataTypes.STEP_COUNT_DELTA)
-       .build());
-

-
-
Returns
-
  • a pending result containing the requested data. The pending result will contain a - single DataSet. If no data has been collected for the requested data type today, the - DataSet will be empty. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataReadResult> - - readData - (GoogleApiClient client, DataReadRequest request) -

-
-
- - - -
-
- - - - -

Reads data from the user’s Google Fit history. Values can be read in detailed or in - aggregate formats. Aggregate data is presented in buckets, while detailed data is returned - as a single data set.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the read operation will be delayed until the connection is complete.
request - a built request specifying the data sources we’re interested in reading and - the time range of the returned data.
-
-
-
Returns
-
  • a pending result containing the requested data. Includes a data set for each - requested data source. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/RecordingApi.html b/docs/html/reference/com/google/android/gms/fitness/RecordingApi.html deleted file mode 100644 index c9664441a933..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/RecordingApi.html +++ /dev/null @@ -1,1589 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RecordingApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

RecordingApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.RecordingApi
- - - - - - - -
- - -

Class Overview

-

API which enables low-power, always-on background collection of sensor - data into the Google Fit store. Sensor subscriptions are active when the - requesting app is not running, and persisted through system restarts. Collected data can be - queried using the History API. -

- Unlike the Sensors API, the Recording API does not support delivery of - live sensor events. When live data is needed (such as when the app is open in the - foreground), a listener should be added with the Sensors API. An app can have - both an active subscription and an active listener at the same time. Unlike listeners, - subscriptions don't need to be removed and re-added periodically. -

- The Recording API should be accessed from the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.RECORDING_API)
-         ...
-         .build();
-     client.connect();
-
-     // Samples the user's activity once per minute.
-     PendingResult<Status> pendingResult = Fitness.RecordingApi.subscribe(
-         client, DataTypes.ACTIVITY_SAMPLE);
-
- Creating a subscription for a particular data type requires user permission for access to data - of that type, and permissions can be revoked by the user through Google Play Services settings. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<ListSubscriptionsResult> - - listSubscriptions(GoogleApiClient client, DataType dataType) - -
- Reads all existing subscriptions for the current application to a particular data type. - - - -
- -
- abstract - - - - - PendingResult<ListSubscriptionsResult> - - listSubscriptions(GoogleApiClient client) - -
- Reads all existing subscriptions for the current application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - subscribe(GoogleApiClient client, DataSource dataSource) - -
- Subscribe to background collection of data from a specific source on behalf of the current - application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - subscribe(GoogleApiClient client, DataType dataType) - -
- Subscribe to background collection of data of a specific type on behalf of the current - application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unsubscribe(GoogleApiClient client, DataSource dataSource) - -
- Unsubscribes from background data collection for the current application for a particular - data source. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unsubscribe(GoogleApiClient client, DataType dataType) - -
- Unsubscribes from background data collection for the current application for a particular - data type. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unsubscribe(GoogleApiClient client, Subscription subscription) - -
- Unsubscribes from background data collection for the current application. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<ListSubscriptionsResult> - - listSubscriptions - (GoogleApiClient client, DataType dataType) -

-
-
- - - -
-
- - - - -

Reads all existing subscriptions for the current application to a particular data type.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the list operation will be delayed until the connection is complete.
dataType - list only subscriptions to this data type
-
-
-
Returns
-
  • a pending result containing the found subscriptions. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<ListSubscriptionsResult> - - listSubscriptions - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Reads all existing subscriptions for the current application.

-
-
Parameters
- - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the list operation will be delayed until the connection is complete.
-
-
-
Returns
-
  • a pending result containing the found subscriptions. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - subscribe - (GoogleApiClient client, DataSource dataSource) -

-
-
- - - -
-
- - - - -

Subscribe to background collection of data from a specific source on behalf of the current - application. -

- After the subscription is successfully added, new data points in the requested data stream - are persisted to the Google Fit store, and can be queried via the - History Api. -

- If after the subscription is added the data source becomes unavailable (it may be - disconnected or disabled, for instance), the subscription remains active. Once the data - source becomes available again, new data points (and any data points that were batched - while disconnected) are inserted.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the subscribe operation will be delayed until the connection is complete.
dataSource - the data source to subscribe to. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - subscribe - (GoogleApiClient client, DataType dataType) -

-
-
- - - -
-
- - - - -

Subscribe to background collection of data of a specific type on behalf of the current - application. -

- Specifying a data type instead of a data source means - that the default data source will be used to serve this request. The default is based on the - data type and the available data sources. The default data source could be a combined data - source, and its data might be averaged or filtered. As new data sources for the data type - become available, the default data source might change. -

- After the subscription is successfully added, new data points in the requested data stream - are persisted to the Google Fit store, and can be queried via the - History Api. -

- Note that not all data sources are available at all times (external devices may go - offline, for instance). If no data sources matching the subscription are currently - available, the request will succeed silently and - SUCCESS_NO_DATA_SOURCES will be returned. Once data - sources become available, recording of data will start. -

- If after the subscription is added the data source becomes - unavailable, the subscription remains active, and recording resumes once the data source - becomes available again. Data points from the time interval when the data source was - unavailable may or may not be recorded, depending on whether batching is supported. -

- If the requested subscription already exists, the request will be a no-op and - SUCCESS_ALREADY_SUBSCRIBED will be returned.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the subscribe operation will be delayed until the connection is complete.
dataType - the data type to subscribe to. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unsubscribe - (GoogleApiClient client, DataSource dataSource) -

-
-
- - - -
-
- - - - -

Unsubscribes from background data collection for the current application for a particular - data source. Should be called when the application no longer wishes to record data.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
dataSource - the data source to unsubscribe from
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unsubscribe - (GoogleApiClient client, DataType dataType) -

-
-
- - - -
-
- - - - -

Unsubscribes from background data collection for the current application for a particular - data type. Should be called when the application no longer wishes to record data.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
dataType - the data type to remove. All subscriptions to the - particular data type will be removed
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unsubscribe - (GoogleApiClient client, Subscription subscription) -

-
-
- - - -
-
- - - - -

Unsubscribes from background data collection for the current application. Should - be called when the application no longer wishes to record data.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
subscription - the subscription to remove
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/SensorsApi.html b/docs/html/reference/com/google/android/gms/fitness/SensorsApi.html deleted file mode 100644 index 6bbd04c08483..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/SensorsApi.html +++ /dev/null @@ -1,1463 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SensorsApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SensorsApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.SensorsApi
- - - - - - - -
- - -

Class Overview

-

API which exposes different sources of fitness data in local and connected devices, - and delivers live events to listeners. -

- The API exposes data sources from hardware sensors in the local device and in - companion devices. It also exposes data sources from applications. Data sources can be queried - via findDataSources(GoogleApiClient, DataSourcesRequest) -

- The API supports adding and removing listeners to live data streams from any available data - source. It also allows for listening on a DataType, in which case the - best available data source (or a combination of them) is used. -

- The Sensors API should be used whenever live updates from a sensor stream need to be pushed to - the application (for instance, to update a UI). The History API can be used - to query historical data in a pull-based model for scenarios where latency isn't critical. -

- The Sensors API should be accessed from the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.SENSORS_API)
-         ...
-         .build();
-     client.connect();
-
-     PendingResult<Status> pendingResult = Fitness.SensorsApi.add(
-         client,
-         new SensorRequest.Builder()
-             .setDataType(DataType.TYPE_STEP_COUNT_DELTA)
-             .setSamplingDelay(1, TimeUnit.MINUTES)  // sample once per minute
-             .build(),
-         myStepCountListener);
-
- If the application doesn't need live sensor updates, but instead wants persistent - recording of historical sensor data, for batch querying, the Recording - and History APIs and should be used instead. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - add(GoogleApiClient client, SensorRequest request, PendingIntent intent) - -
- Adds a PendingIntent listener to a sensor data source. - - - -
- -
- abstract - - - - - PendingResult<Status> - - add(GoogleApiClient client, SensorRequest request, OnDataPointListener listener) - -
- Adds a data point listener to a sensor data source. - - - -
- -
- abstract - - - - - PendingResult<DataSourcesResult> - - findDataSources(GoogleApiClient client, DataSourcesRequest request) - -
- Finds all available data sources, on the device and remotely. - - - -
- -
- abstract - - - - - PendingResult<Status> - - remove(GoogleApiClient client, PendingIntent pendingIntent) - -
- Removes PendingIntent listener from a sensor data source. - - - -
- -
- abstract - - - - - PendingResult<Status> - - remove(GoogleApiClient client, OnDataPointListener listener) - -
- Removes a listener from a sensor data source. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - add - (GoogleApiClient client, SensorRequest request, PendingIntent intent) -

-
-
- - - -
-
- - - - -

Adds a PendingIntent listener to a sensor data source. This method can be called to - listen on live updates from a particular data source, or a data type (in which case a - default data source is used). -

- Once the add request succeeds, new data points in the data stream are delivered to the - specified intent. Historic data is not delivered, but can be queried via the - History API. -

- Unlike add(GoogleApiClient, SensorRequest, OnDataPointListener), - which takes a listener and is intended for fast sampling rates while the application is - on the foreground, this method is intended for slower sampling rates without the need for - an always-on service. -

- The application specifies a PendingIntent callback (typically an IntentService) which will be - called when new data points are available in the requested stream. When the PendingIntent - is called, the application can use extract(android.content.Intent) to - extract the DataPoint from the intent. See the documentation of - PendingIntent for more details. -

- Any previously registered requests that have the same PendingIntent - (as defined by equals(Object)) will be replaced by this request.

-
-
Parameters
- - - - - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the add operation will be delayed until the connection is complete
request - request specifying the desired data source or data type, as well as the - desired parameters for the add request
intent - a callback intent to be sent for each new data points. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - add - (GoogleApiClient client, SensorRequest request, OnDataPointListener listener) -

-
-
- - - -
-
- - - - -

Adds a data point listener to a sensor data source. This - method can be called to listen on live updates from a particular data source, or data type - (in which case a default data source is used). -

- Once the add request succeeds, new data points in the data stream are delivered to the - specified listener. Historic data is not delivered, but can be queried via the - History API. When the application is closing, or once live data - is no longer needed, the listener should be removed. If necessary, the - Recording API can be used to persist data for later querying when the - application is re-opened in a battery-efficient manner. -

- This method can be called several times with the same listener to change the desired - sampling rate.

-
-
Parameters
- - - - - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the add operation will be delayed until the connection is complete
request - request specifying the desired data source or data type, as well as the - desired parameters for the add request
listener - the listener that will be used to respond to events. The listener object - should be saved, since it can be used to remove the registration when live events - are no longer needed -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataSourcesResult> - - findDataSources - (GoogleApiClient client, DataSourcesRequest request) -

-
-
- - - -
-
- - - - -

Finds all available data sources, on the device and remotely. Results are returned - asynchronously as a PendingResult. -

- It's not necessary to call this method if an application is interested only in getting the - best available data for a data type, regardless of source. In this case, - add(GoogleApiClient, SensorRequest, OnDataPointListener) can be used with a - generic data type.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the find operation will be delayed until the connection is complete.
request - a built request specifying the data sources we’re interested in finding
-
-
-
Returns
-
  • a pending result containing the found data sources. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - remove - (GoogleApiClient client, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - - -

Removes PendingIntent listener from a sensor data source. Should be called - whenever live updates are no longer needed.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
pendingIntent - the PendingIntent that was used in the - add request or is - equal as defined by equals(Object).
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - remove - (GoogleApiClient client, OnDataPointListener listener) -

-
-
- - - -
-
- - - - -

Removes a listener from a sensor data source. Should be called whenever live updates are - no longer needed, such as when the activity that displays live data is paused, stopped, - or destroyed.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
listener - the listener that was used in the - add request.
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/SessionsApi.ViewIntentBuilder.html b/docs/html/reference/com/google/android/gms/fitness/SessionsApi.ViewIntentBuilder.html deleted file mode 100644 index f6a6a2bcb180..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/SessionsApi.ViewIntentBuilder.html +++ /dev/null @@ -1,1568 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionsApi.ViewIntentBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SessionsApi.ViewIntentBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.SessionsApi.ViewIntentBuilder
- - - - - - - -
- - -

Class Overview

-

Builder of intents to view sessions stored in Google Fit. - This intent can be used when the application wants to display a more detailed view of a - particular session. Apps that can display sessions (such as the app that inserted the - session) can register for the given intent. -

- If the application which inserted the session is installed on the device, - it'll be preferred to handle the intent. This behavior can be overridden by - setPreferredApplication(String). -

- The session view intent has the following attributes: -

    -
  • action is set to ACTION_VIEW -
  • type is MIME_TYPE_PREFIX followed by the activity - for the session. For example, vnd.google.fitness.session/running would represent a - running session. -
  • extras containing the session -
-

- An application that would like to handle Session view intents should create an activity and - add an intent filter to its manifest file. Here's an example of an activity that can display - biking and running sessions: - 

- <activity android:name=".ViewSessionActivity" android:exported="true">
-    <intent-filter>
-      <action android:name="vnd.google.fitness.VIEW" />
-      <data android:mimeType="vnd.google.fitness.session/biking" />
-      <data android:mimeType="vnd.google.fitness.session/running" />
-   </intent-filter>
- </activity>
-
- In addition, if the application is able to show sessions from other apps, - it can add the CATEGORY_DEFAULT to the intent filter, as follows: - 
-      <category android:name="android.intent.category.DEFAULT" />
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SessionsApi.ViewIntentBuilder(Context context) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Intent - - build() - -
- Returns the built intent, which can be used with startActivity(Intent) to - launch the desired Fitness activity. - - - -
- -
- - - - - - SessionsApi.ViewIntentBuilder - - setPreferredApplication(String packageName) - -
- Sets a preferred application to use for this intent. - - - -
- -
- - - - - - SessionsApi.ViewIntentBuilder - - setSession(Session session) - -
- Sets the session to display data for. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SessionsApi.ViewIntentBuilder - (Context context) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Intent - - build - () -

-
-
- - - -
-
- - - - -

Returns the built intent, which can be used with startActivity(Intent) to - launch the desired Fitness activity.

-
-
Throws
- - - - -
IllegalStateException - if not enough data has been passed into the Builder to - build a valid intent. -
-
- -
-
- - - - -
-

- - public - - - - - SessionsApi.ViewIntentBuilder - - setPreferredApplication - (String packageName) -

-
-
- - - -
-
- - - - -

Sets a preferred application to use for this intent. If the given app is installed and - able to handle this intent, an explicit intent will be returned. -

- By default, the intent will attempt to use the application which inserted the session. - Use this method only to override that behavior.

-
-
Parameters
- - - - -
packageName - the package name for the application to prefer for the intent, or - null to not prefer any application
-
-
-
Returns
-
  • this builder, for chaining -
-
- -
-
- - - - -
-

- - public - - - - - SessionsApi.ViewIntentBuilder - - setSession - (Session session) -

-
-
- - - -
-
- - - - -

Sets the session to display data for. A specific session must be set.

-
-
Parameters
- - - - -
session - the specific session to show data for
-
-
-
Returns
-
  • this builder, for chaining -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/SessionsApi.html b/docs/html/reference/com/google/android/gms/fitness/SessionsApi.html deleted file mode 100644 index c8f25097e126..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/SessionsApi.html +++ /dev/null @@ -1,1562 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionsApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SessionsApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.SessionsApi
- - - - - - - -
- - -

Class Overview

-

API for creating and managing sessions of user activity in Google Fit. - Sessions are a way of storing user-visible groups of related stream data in a useful and - shareable manner, and allow for easy querying of the data in a detailed or aggregated fashion. -

- The startSession(GoogleApiClient, Session) and - stopSession(GoogleApiClient, String) methods mark the time range of the session. - Data inserted using the HistoryApi during the period where the session is in progress - will be associated with that Session once it is stopped. -

- Another way of adding sessions is with - insertSession(GoogleApiClient, SessionInsertRequest). This is designed for bulk - insertion when importing a user's historic data into Google Fit; for live sessions use the - previous API. All data in Google Fit that falls within the time range of an inserted session - will be implicitly associated with that session. -

- Once a session has been saved, it can be retrieved using - readSession(GoogleApiClient, SessionReadRequest). -

- Clients can register to be notified of sessions, and remove existing registrations, using - registerForSessions(GoogleApiClient, PendingIntent) and - unregisterForSessions(GoogleApiClient, PendingIntent). Notifications will be sent for - sessions when they are started and stopped. -

- Deleting sessions is handled like any other data deletion, via - deleteData(GoogleApiClient, DataDeleteRequest). -

- The Sessions API should be accessed via the Fitness entry point. Example: - 

-     GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(Fitness.SESSIONS_API)
-         ...
-         .build();
-     client.connect();
-
-     Session session = new Session.Builder()
-         .setName(sessionName)
-         .setIdentifier(identifier)
-         .setDescription(description)
-         .setStartTimeMillis(startTime.getMillis(), TimeUnit.MILLISECONDS)
-         .build();
-
-     PendingResult<Status> pendingResult
-         = Fitness.SessionsApi.startSession(client, session);
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSessionsApi.ViewIntentBuilder - Builder of intents to view sessions stored in Google Fit.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - insertSession(GoogleApiClient client, SessionInsertRequest request) - -
- Inserts specified Session and corresponding data into the user's Google Fit store - on behalf of the current application. - - - -
- -
- abstract - - - - - PendingResult<SessionReadResult> - - readSession(GoogleApiClient client, SessionReadRequest request) - -
- Reads data from the user's Google Fit store of the specific type(s) and for the specific - session(s) selected from the request parameters. - - - -
- -
- abstract - - - - - PendingResult<Status> - - registerForSessions(GoogleApiClient client, PendingIntent intent) - -
- Registers for notifications of session start and end events using a PendingIntent. - - - -
- -
- abstract - - - - - PendingResult<Status> - - startSession(GoogleApiClient client, Session session) - -
- Starts a new active session for the current application. - - - -
- -
- abstract - - - - - PendingResult<SessionStopResult> - - stopSession(GoogleApiClient client, String identifier) - -
- Stops active sessions for the current application. - - - -
- -
- abstract - - - - - PendingResult<Status> - - unregisterForSessions(GoogleApiClient client, PendingIntent intent) - -
- Unregisters from session start and end notifications using a PendingIntent. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - insertSession - (GoogleApiClient client, SessionInsertRequest request) -

-
-
- - - -
-
- - - - -

Inserts specified Session and corresponding data into the user's Google Fit store - on behalf of the current application. Useful for bulk upload of a previously recorded - session.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the insertion will be delayed until the connection is complete.
request - the Session and its associated data, which includes - details of the session and data set for data source(s). -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<SessionReadResult> - - readSession - (GoogleApiClient client, SessionReadRequest request) -

-
-
- - - -
-
- - - - -

Reads data from the user's Google Fit store of the specific type(s) and for the specific - session(s) selected from the request parameters.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the insertion will be delayed until the connection is complete.
request - a built request specifying the specific session, time interval and/or - data type for the query
-
-
-
Returns
-
  • a pending result containing the requested session and data. Includes a data set for - each session and data type that was returned. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - registerForSessions - (GoogleApiClient client, PendingIntent intent) -

-
-
- - - -
-
- - - - -

Registers for notifications of session start and end events using a PendingIntent. -

- The application specifies a PendingIntent callback (typically an IntentService) which will be - called when sessions are started or stopped. When the PendingIntent is called, the - application can use extract(android.content.Intent) to extract the Session - from the intent. In addition, the following Intent extras can be used: -

-

- Finally, the Intent's type will be set to - MIME_TYPE_PREFIX followed by the name of the activity - associated with this session, and can be computed by - getMimeType(String). -

- Any previously registered sessions that have the same PendingIntent - (as defined by equals(Object)) will be replaced by this session.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
intent - a callback intent to be sent every time a session is started or stopped. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - startSession - (GoogleApiClient client, Session session) -

-
-
- - - -
-
- - - - -

Starts a new active session for the current application.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
session - the session to be started
-
-
-
Returns
-
  • a pending result containing the status of request
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<SessionStopResult> - - stopSession - (GoogleApiClient client, String identifier) -

-
-
- - - -
-
- - - - -

Stops active sessions for the current application. The active sessions to be stopped are - chosen as per the specifications in the input request.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
identifier - the identifier of the session to stop. If null is passed all - active sessions will be stopped.
-
-
-
Returns
-
  • a pending result containing the list of sessions that were stopped
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - unregisterForSessions - (GoogleApiClient client, PendingIntent intent) -

-
-
- - - -
-
- - - - -

Unregisters from session start and end notifications using a PendingIntent.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. Must be connected at the time of this call.
intent - the PendingIntent that was used in the - registerForSessions - call or is equal as defined by equals(Object).
-
-
-
Throws
- - - - -
IllegalStateException - if client is not connected -
-
-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/BleDevice.html b/docs/html/reference/com/google/android/gms/fitness/data/BleDevice.html deleted file mode 100644 index 7b72d9a97f2d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/BleDevice.html +++ /dev/null @@ -1,1867 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BleDevice | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

BleDevice

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.BleDevice
- - - - - - - -
- - -

Class Overview

-

Representation of a BLE Device (such as a heart rate monitor) that broadcasts information - about its on board sensors. The BLE device supports one or more - GATT Profiles, which can be translated to one or more - data type. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - String - - getAddress() - -
- Returns the address of the BLE device, from getAddress(). - - - -
- -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns all of the Fitness Platform data types supported by the device's - supported profiles. - - - -
- -
- - - - - - String - - getName() - -
- Returns the name of the BLE device, from getName(). - - - -
- -
- - - - - - List<String> - - getSupportedProfiles() - -
- Returns a list of supported GATT Profile - - Specification Types for the device which are also supported by the Fitness Platform. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAddress - () -

-
-
- - - -
-
- - - - -

Returns the address of the BLE device, from getAddress(). -

- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns all of the Fitness Platform data types supported by the device's - supported profiles. -

- Note that in some GATT profiles certain characteristics are optional. This method will - return an optional data type even if the device doesn't support it. Registering to - updates from a non-supported optional data type from a supported profile will succeed, - but no data will be returned. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name of the BLE device, from getName(). -

- -
-
- - - - -
-

- - public - - - - - List<String> - - getSupportedProfiles - () -

-
-
- - - -
-
- - - - -

Returns a list of supported GATT Profile - - Specification Types for the device which are also supported by the Fitness Platform. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Bucket.html b/docs/html/reference/com/google/android/gms/fitness/data/Bucket.html deleted file mode 100644 index c42946139274..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Bucket.html +++ /dev/null @@ -1,2282 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bucket | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Bucket

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Bucket
- - - - - - - -
- - -

Class Overview

-

A bucket represents a time interval over which aggregated data is computed. For example, - a bucket can represent user's average speed and average heart rate over a 1 hour interval. - Currently we allow buckets to be computed by only one of the following strategies: -

    -
  1. time: a time bucket can represent a full day, hour, or any other desired interval -
  2. session: a session bucket represents data for one session -
  3. activity type: an activity type represents one of the FitnessActivities -
  4. activity segments: an activity segment represents data for one - activity segment -
-

- A Bucket consists of the following fields: -

    -
  • startTime denotes the start time of the bucket. This field is always present. -
  • endTime denotes the end time of the bucket. This field is always present. -
  • session denotes the associated session with the bucket. This is an optional field - that is set only if the read query had requested bucketing by sessions. -
  • activity denotes the associated activity with the bucket as defined in - FitnessActivities. This is an optional field and - is set only if the read query had requested bucketing of data by activity segments. -
  • dataSets DataSets for the aggregated data types - requested in the read query over the time interval of this bucket. -
  • bucketType denotes if the bucketing is by time, session or activity. This field is - always present and set to one of TYPE_TIME, TYPE_SESSION, - TYPE_ACTIVITY_SEGMENT or TYPE_ACTIVITY_TYPE. -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTYPE_ACTIVITY_SEGMENT - Type constant denoting that bucketing by individual activity segment is requested. - - - -
intTYPE_ACTIVITY_TYPE - Type constant denoting that bucketing by activity type is requested. - - - -
intTYPE_SESSION - Type constant denoting that bucketing by session is requested. - - - -
intTYPE_TIME - Type constant denoting that bucketing by time is requested. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - String - - getActivity() - -
- Returns the activity of the bucket if bucketing by activity - was requested, or UNKNOWN otherwise. - - - -
- -
- - - - - - int - - getBucketType() - -
- Returns the type of the bucket. - - - -
- -
- - - - - - DataSet - - getDataSet(DataType dataType) - -
- Returns the data set of requested data type over the time interval of the bucket. - - - -
- -
- - - - - - List<DataSet> - - getDataSets() - -
- Returns the requested data sets over the time interval of the bucket. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time of the bucket, in the given time unit since epoch. - - - -
- -
- - - - - - Session - - getSession() - -
- Returns the session of the bucket if bucketing by session was requested, null - otherwise. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time of the bucket, in the given time unit since epoch. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - TYPE_ACTIVITY_SEGMENT -

-
- - - - -
-
- - - - -

Type constant denoting that bucketing by individual activity segment is requested.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ACTIVITY_TYPE -

-
- - - - -
-
- - - - -

Type constant denoting that bucketing by activity type is requested.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SESSION -

-
- - - - -
-
- - - - -

Type constant denoting that bucketing by session is requested.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TIME -

-
- - - - -
-
- - - - -

Type constant denoting that bucketing by time is requested.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getActivity - () -

-
-
- - - -
-
- - - - -

Returns the activity of the bucket if bucketing by activity - was requested, or UNKNOWN otherwise. -

- -
-
- - - - -
-

- - public - - - - - int - - getBucketType - () -

-
-
- - - -
-
- - - - -

Returns the type of the bucket. -

- -
-
- - - - -
-

- - public - - - - - DataSet - - getDataSet - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns the data set of requested data type over the time interval of the bucket. Returns - null, if data set for the requested type is not found. -

- -
-
- - - - -
-

- - public - - - - - List<DataSet> - - getDataSets - () -

-
-
- - - -
-
- - - - -

Returns the requested data sets over the time interval of the bucket. -

- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time of the bucket, in the given time unit since epoch. -

- -
-
- - - - -
-

- - public - - - - - Session - - getSession - () -

-
-
- - - -
-
- - - - -

Returns the session of the bucket if bucketing by session was requested, null - otherwise. -

- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time of the bucket, in the given time unit since epoch. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/DataPoint.html b/docs/html/reference/com/google/android/gms/fitness/data/DataPoint.html deleted file mode 100644 index 5e306940628e..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/DataPoint.html +++ /dev/null @@ -1,2491 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataPoint | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DataPoint

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.DataPoint
- - - - - - - -
- - -

Class Overview

-

Represents a single data point in a data type's stream from a particular - data source. A data point holds a value for each field, a timestamp and an - optional start time. The exact semantics of each of these attributes is specified in the - documentation for the particular data type, which can be found in the appropriate constant in - DataType. -

- A data point can represent an instantaneous measurement, reading or inputted observation, as well - as averages or aggregates over a time interval. Check the data type documentation to determine - which is the case for a particular data type. -

- DataPoints always contain one value for each the data type - field. - Initially, all of the values are unset. After creating the data point, the appropriate values - and timestamps should be set. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - DataPoint - - create(DataSource dataSource) - -
- Creates a new data point for the given dataSource. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - static - - DataPoint - - extract(Intent intent) - -
- Extracts a data point from a callback intent received after registering to a data source - with a PendingIntent. - - - -
- -
- - - - - - DataSource - - getDataSource() - -
- Returns the data source for the data point. - - - -
- -
- - - - - - DataType - - getDataType() - -
- Returns the data type defining the format of the values in this data point. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time of the interval represented by this data point, in the given unit since - epoch. - - - -
- -
- - - - - - DataSource - - getOriginalDataSource() - -
- Returns the original data source for this data point. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time of the interval represented by this data point, - in the given unit since epoch. - - - -
- -
- - - - - - long - - getTimestamp(TimeUnit timeUnit) - -
- Returns the timestamp of the data point, in the given unit since epoch. - - - -
- -
- - - - - - Value - - getValue(Field field) - -
- Returns the value holder for the field with the given name. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - DataPoint - - setFloatValues(float... values) - -
- Sets the values of this data point, where the format for all of its values is float. - - - -
- -
- - - - - - DataPoint - - setIntValues(int... values) - -
- Sets the values of this data point, where the format for all of its values is int. - - - -
- -
- - - - - - DataPoint - - setTimeInterval(long startTime, long endTime, TimeUnit timeUnit) - -
- Sets the time interval of a data point that represents an interval of time. - - - -
- -
- - - - - - DataPoint - - setTimestamp(long timestamp, TimeUnit timeUnit) - -
- Sets the timestamp of a data point that represent an instantaneous reading, - measurement, or input. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - DataPoint - - create - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Creates a new data point for the given dataSource. An unset Value is - created for each field of the data source's data type.

-
-
Returns
-
  • an empty data point instance -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - DataPoint - - extract - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts a data point from a callback intent received after registering to a data source - with a PendingIntent.

-
-
Returns
-
  • the extracted DataPoint, or null if the given intent does not contain a - DataPoint -
-
- -
-
- - - - -
-

- - public - - - - - DataSource - - getDataSource - () -

-
-
- - - -
-
- - - - -

Returns the data source for the data point. If the data point is part of a DataSet, - this will correspond to the data set's data source. -

- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the data type defining the format of the values in this data point. -

- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time of the interval represented by this data point, in the given unit since - epoch. This method is equivalent to getTimestamp(TimeUnit) -

- -
-
- - - - -
-

- - public - - - - - DataSource - - getOriginalDataSource - () -

-
-
- - - -
-
- - - - -

Returns the original data source for this data point. The original data source helps - identify the source of the data point as it gets merged and transformed into different - streams. -

- Note that, if this data point is part of a DataSet, the data source returned here - may be different from the data set's data source. In case of transformed or merged data - sets, each data point's original data source will retain the original attribution as much - as possible, while the data set's data source will represent the merged or transformed - stream. -

- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time of the interval represented by this data point, - in the given unit since epoch. -

- -
-
- - - - -
-

- - public - - - - - long - - getTimestamp - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the timestamp of the data point, in the given unit since epoch. For data points that - represent intervals, this method will return the end time. -

- -
-
- - - - -
-

- - public - - - - - Value - - getValue - (Field field) -

-
-
- - - -
-
- - - - -

Returns the value holder for the field with the given name. This method can be used - both to query the value and to set it.

-
-
Parameters
- - - - -
field - one of the fields of this data type
-
-
-
Returns
-
  • the Value associated with the given field
-
-
-
Throws
- - - - -
IllegalArgumentException - if the given field doesn't match any of the fields - for this DataPoint's data type. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DataPoint - - setFloatValues - (float... values) -

-
-
- - - -
-
- - - - -

Sets the values of this data point, where the format for all of its values is float.

-
-
Parameters
- - - - -
values - the value for each field of the data point, in order -
-
- -
-
- - - - -
-

- - public - - - - - DataPoint - - setIntValues - (int... values) -

-
-
- - - -
-
- - - - -

Sets the values of this data point, where the format for all of its values is int.

-
-
Parameters
- - - - -
values - the value for each field of the data point, in order -
-
- -
-
- - - - -
-

- - public - - - - - DataPoint - - setTimeInterval - (long startTime, long endTime, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the time interval of a data point that represents an interval of time. For data points - that represent instantaneous readings, setTimestamp(long, TimeUnit) should be used. -

- Examples of data types that represent intervals include: -

- Google Fit accepts timestamps with up to nanosecond granularity.

-
-
Parameters
- - - - - - - - - - -
startTime - the start time in the given unit, representing elapsed time since epoch
endTime - the end time in the given unit, representing elapsed time since epoch
timeUnit - the time unit of both start and end timestamps -
-
- -
-
- - - - -
-

- - public - - - - - DataPoint - - setTimestamp - (long timestamp, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the timestamp of a data point that represent an instantaneous reading, - measurement, or input. For data points that represent intervals, - setTimeInterval(long, long, TimeUnit) should be used. -

- Examples of data types with instantaneous timestamp include: -

- Google Fit accepts timestamps with up to nanosecond granularity for all - DataTypes with the exception of location, which supports only timestamps with millisecond precision. If the timestamp has - more than millisecond granularity for a location, the extra precision will be lost.

-
-
Parameters
- - - - - - - -
timestamp - the timestamp in the given unit, representing elapsed time since epoch
timeUnit - the unit of the given timestamp -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/DataSet.html b/docs/html/reference/com/google/android/gms/fitness/data/DataSet.html deleted file mode 100644 index 436bcc3dc7f8..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/DataSet.html +++ /dev/null @@ -1,2116 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DataSet

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.DataSet
- - - - - - - -
- - -

Class Overview

-

Represents a fixed set of data points in a data type's stream - from a particular data source. A data set usually represents data at fixed - time boundaries, and can be used both for batch data insertion and as a result of read requests. -

- Here's a sample usage for populating a data source with activity data: - 

-     DataType dataType = DataTypes.ACTIVITY_SEGMENT;
-     DataSet dataSet = DataSet.create(dataSource);
-     for (ActivitySegment segment : getActivitySegments()) {
-       dataSet.add(dataSet.createDataPoint()
-           .setTimeInterval(segment.getStartMillis(), segment.getEndTimeMillis(), MILLISECONDS))
-           .setValues(segment.getActivity()));
-     }
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - add(DataPoint dataPoint) - -
- Adds a data point to this data set. - - - -
- -
- - - - - - void - - addAll(Iterable<DataPoint> dataPoints) - -
- Adds a list of data points to this data set in bulk. - - - -
- -
- - - - static - - DataSet - - create(DataSource dataSource) - -
- Creates a new data set to hold data points for the given dataSource. - - - -
- -
- - - - - - DataPoint - - createDataPoint() - -
- Creates an empty data point for this data set's data source. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<DataPoint> - - getDataPoints() - -
- Returns the list of data points represented by this data set. - - - -
- -
- - - - - - DataSource - - getDataSource() - -
- Returns the data source which this data set represents. - - - -
- -
- - - - - - DataType - - getDataType() - -
- Returns the data type this data set represents. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isEmpty() - -
- Returns whether this data set contains no data points. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - add - (DataPoint dataPoint) -

-
-
- - - -
-
- - - - -

Adds a data point to this data set. The data points should be for the correct data type - and data source, and should have its timestamp already set. -

- -
-
- - - - -
-

- - public - - - - - void - - addAll - (Iterable<DataPoint> dataPoints) -

-
-
- - - -
-
- - - - -

Adds a list of data points to this data set in bulk. All data points should be for the - correct data type and data source, and should have their timestamp already set. -

- -
-
- - - - -
-

- - public - static - - - - DataSet - - create - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Creates a new data set to hold data points for the given dataSource. -

- Data points with the matching data source can be created using createDataPoint(), - and after having the values set added to the data set via add(DataPoint).

-
-
Throws
- - - - -
NullPointerException - if specified data source is null -
-
- -
-
- - - - -
-

- - public - - - - - DataPoint - - createDataPoint - () -

-
-
- - - -
-
- - - - -

Creates an empty data point for this data set's data source. The new data - point is not added to the data set by this method. After the data point is - initialized, add(DataPoint) should be called. -

- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataPoint> - - getDataPoints - () -

-
-
- - - -
-
- - - - -

Returns the list of data points represented by this data set. The data points will preserve - the same order in which they were inserted. -

- Certain APIs that return a DataSet might insert data points in chronological order, but this - isn't enforced. -

- -
-
- - - - -
-

- - public - - - - - DataSource - - getDataSource - () -

-
-
- - - -
-
- - - - -

Returns the data source which this data set represents. All of the data points in the data - set are from this data source. -

- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the data type this data set represents. All of the data points in the data set are - of this data type. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isEmpty - () -

-
-
- - - -
-
- - - - -

Returns whether this data set contains no data points.

-
-
Returns
-
  • true if this data set has no data points, false otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/DataSource.Builder.html b/docs/html/reference/com/google/android/gms/fitness/data/DataSource.Builder.html deleted file mode 100644 index 6e42931150d5..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/DataSource.Builder.html +++ /dev/null @@ -1,1828 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSource.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

DataSource.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.DataSource.Builder
- - - - - - - -
- - -

Class Overview

-

A builder that can be used to construct new data source objects. In general, a built data - source should be saved in memory to avoid the cost of re-constructing it for every request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataSource.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - DataSource - - build() - -
- Finishes building the data source and returns a DataSource object. - - - -
- -
- - - - - - DataSource.Builder - - setAppPackageName(String packageName) - -
- Sets the package name for the application that is recording or computing the data. - - - -
- -
- - - - - - DataSource.Builder - - setAppPackageName(Context appContext) - -
- Sets the package name for the application that is recording or computing the data - based on the app's context. - - - -
- -
- - - - - - DataSource.Builder - - setDataType(DataType dataType) - -
- Sets the data type for the data source. - - - -
- -
- - - - - - DataSource.Builder - - setDevice(Device device) - -
- Sets the integrated device where data is being recorded (for instance, a phone that has - sensors, or a wearable). - - - -
- -
- - - - - - DataSource.Builder - - setName(String name) - -
- Sets an end-user-visible name for this data source. - - - -
- -
- - - - - - DataSource.Builder - - setStreamName(String streamName) - -
- The stream name uniquely identifies this particular data source among other data sources - of the same type from the same underlying producer. - - - -
- -
- - - - - - DataSource.Builder - - setType(int type) - -
- Sets the type of the data source. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataSource.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - DataSource - - build - () -

-
-
- - - -
-
- - - - -

Finishes building the data source and returns a DataSource object.

-
-
Throws
- - - - -
IllegalStateException - if the builder didn't have enough data to build - a valid data source. -
-
- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setAppPackageName - (String packageName) -

-
-
- - - -
-
- - - - -

Sets the package name for the application that is recording or computing the data. - Used for data sources that aren't built into the platform (local sensors and BLE sensors - are built-in). It can be used to identify the data source, to disambiguate between data - from different applications, and also to link back to the original application for a - detailed view. -

- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setAppPackageName - (Context appContext) -

-
-
- - - -
-
- - - - -

Sets the package name for the application that is recording or computing the data - based on the app's context. This method should be preferred when an application is - creating a data source that represents its own data. When creating a data source to - query data from other apps, setAppPackageName(String) should be used. -

- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setDataType - (DataType dataType) -

-
-
- - - -
-
- - - - -

Sets the data type for the data source. Every data source is required to have a data - type.

-
-
Parameters
- - - - -
dataType - one of the data types defined in DataType, or a custom data type -
-
- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setDevice - (Device device) -

-
-
- - - -
-
- - - - -

Sets the integrated device where data is being recorded (for instance, a phone that has - sensors, or a wearable). Can be useful to identify the data source, and to disambiguate - between data from different devices. If the data is coming from the local device, use - Device.getLocalDevice(Context). -

- Note that it may be useful to set the device even if the data is not coming from a - hardware sensor on the device. For instance, if the user installs an application which - generates sensor data in two separate devices, the only way to differentiate the two data - sources is using the device. This can be specially important if both devices are used at - the same time. -

- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

Sets an end-user-visible name for this data source. This is optional. -

- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setStreamName - (String streamName) -

-
-
- - - -
-
- - - - -

The stream name uniquely identifies this particular data source among other data sources - of the same type from the same underlying producer. Setting the stream name is optional, - but should be done whenever an application exposes two streams for the same data type, or - when a device has two equivalent sensors. -

- The stream name is used by getStreamIdentifier() to make sure the different - streams are properly separated when querying or persisting data.

-
-
Throws
- - - - -
IllegalArgumentException - if the specified stream name is null -
-
- -
-
- - - - -
-

- - public - - - - - DataSource.Builder - - setType - (int type) -

-
-
- - - -
-
- - - - -

Sets the type of the data source. TYPE_DERIVED should be used if any other - data source is used in generating the data. TYPE_RAW should be used if the - data comes completely from outside of Google Fit. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/DataSource.html b/docs/html/reference/com/google/android/gms/fitness/data/DataSource.html deleted file mode 100644 index a51ee6e346b8..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/DataSource.html +++ /dev/null @@ -1,2335 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSource | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataSource

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.DataSource
- - - - - - - -
- - -

Class Overview

-

Definition of a unique source of sensor data. Data sources can expose raw data coming from - hardware sensors on local or companion devices. They can also expose derived data, created by - transforming or merging other data sources. Multiple data sources can exist for the same - data type. Every data point inserted into or read from Google Fit has an - associated data source. -

- The data source contains enough information to uniquely identify its data, including the hardware - device and the application that collected and/or - transformed the data. It also holds useful metadata, such as a stream name and the device type. -

- The data source's data stream can be accessed in a live fashion by registering a data source - listener, or via queries over fixed time intervals. -

- An end-user-visible name for the data stream can be set by calling - setName(String) or otherwise computed from the device model and application name. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classDataSource.Builder - A builder that can be used to construct new data source objects.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_DATA_SOURCE - Name for the parcelable intent extra containing a data source. - - - -
intTYPE_DERIVED - Type constant for a data source which exposes data which is derived from one or more - existing data sources by performing transformations on the original data. - - - -
intTYPE_RAW - Type constant for a data source which exposes original, raw data from an external source - such as a hardware sensor, a wearable device, or user input. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - static - - DataSource - - extract(Intent intent) - -
- Extracts the data source extra from the given intent, such as an intent to - view user's data. - - - -
- -
- - - - - - String - - getAppPackageName() - -
- Returns the package name for the application responsible for setting the data, - or null if unset/unknown. - - - -
- -
- - - - - - DataType - - getDataType() - -
- Returns the data type for data coming from this data source. - - - -
- -
- - - - - - Device - - getDevice() - -
- Returns the device where data is being collected, or null if unset. - - - -
- -
- - - - - - String - - getName() - -
- Returns the specified user-visible name for the data source, or null if unset. - - - -
- -
- - - - - - String - - getStreamIdentifier() - -
- Returns a unique identifier for the data stream produced by this data source. - - - -
- -
- - - - - - String - - getStreamName() - -
- Returns the specific name for the stream coming form - this data source, or null if unset. - - - -
- -
- - - - - - int - - getType() - -
- Returns the constant describing the type of this data source. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_DATA_SOURCE -

-
- - - - -
-
- - - - -

Name for the parcelable intent extra containing a data source. It can be - extracted using extract(Intent). -

- - -
- Constant Value: - - - "vnd.google.fitness.data_source" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_DERIVED -

-
- - - - -
-
- - - - -

Type constant for a data source which exposes data which is derived from one or more - existing data sources by performing transformations on the original data. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_RAW -

-
- - - - -
-
- - - - -

Type constant for a data source which exposes original, raw data from an external source - such as a hardware sensor, a wearable device, or user input. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - DataSource - - extract - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts the data source extra from the given intent, such as an intent to - view user's data.

-
-
Returns
-
  • the data source, or null if not found -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAppPackageName - () -

-
-
- - - -
-
- - - - -

Returns the package name for the application responsible for setting the data, - or null if unset/unknown. The PackageManager can be used to query - relevant data on the application, such as the name, icon, logo, etc. -

- Data coming from local sensors or BLE devices will not have a corresponding application. -

- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the data type for data coming from this data source. Knowing the type of data source - can be useful to perform transformations on top of raw data without using sources that are - themselves computed by transforming raw data. -

- -
-
- - - - -
-

- - public - - - - - Device - - getDevice - () -

-
-
- - - -
-
- - - - -

Returns the device where data is being collected, or null if unset. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the specified user-visible name for the data source, or null if unset. -

- If the name is unset, the device model and - app can be used as user-visible identifiers for the source. -

- -
-
- - - - -
-

- - public - - - - - String - - getStreamIdentifier - () -

-
-
- - - -
-
- - - - -

Returns a unique identifier for the data stream produced by this data source. The identifier - includes: -

    -
  • the physical device's manufacturer, model, and serial number (UID) -
  • the application's package name (unique for a given application) -
  • The data source's data type -
  • the data source's type (raw or derived) -
  • the data source's stream name. -
-

- -
-
- - - - -
-

- - public - - - - - String - - getStreamName - () -

-
-
- - - -
-
- - - - -

Returns the specific name for the stream coming form - this data source, or null if unset. -

- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Returns the constant describing the type of this data source.

-
-
Returns
-
  • one of the constant values (TYPE_DERIVED or TYPE_RAW), - zero if unset. Values outside of this range should be treated as unset/unknown. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/DataType.html b/docs/html/reference/com/google/android/gms/fitness/data/DataType.html deleted file mode 100644 index 08dee865c350..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/DataType.html +++ /dev/null @@ -1,4031 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataType | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

DataType

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.DataType
- - - - - - - -
- - -

Class Overview

-

The data type defines the schema for a stream of data being collected by, inserted into, or - queried from Google Fit. The data type defines only the representation and - format of the data, and not how it's being collected, the sensor being used, or the parameters - of the collection. -

- The same underlying concept may be represented by different data types, depending on how data is - represented. For example, the com.google.step_count.delta data type represents step - count data as delta (new steps) between different readings, while the - com.google.step_count.cumulative data type represents step count data as a sum since the - start of the count. The platform has built-in support for converting between compatible data - types. -

- A data type contains one or more fields. In case of multi-dimensional data (such as location - with latitude, longitude, and accuracy) each field represents one dimension. Each data - type field has a unique name which identifies it. The field also defines the format of the - data (int, float, etc.). -

- The data types in the com.google namespace are shared with any app with the user - consent. These are fixed and can only be updated in new releases of the platform. - This class contains constants representing each of the com.google data types, - each prefixed with TYPE_. Custom data types can be accessed via the ConfigApi. -

- Certain data types can represent aggregates, and can be computed as part of read requests by - calling aggregate(DataType, DataType). This class contains - constants for all the valid aggregates, each prefixed with AGGREGATE_. In addition, - AGGREGATE_INPUT_TYPES contains all valid input types to aggregation, - and the aggregates for each input type can be queried via - getAggregatesForInput(DataType). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringMIME_TYPE_PREFIX - The common prefix for data type MIME types, for use in intents. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - DataTypeAGGREGATE_ACTIVITY_SUMMARY - In the com.google.activity.summary data type, each data point represents a summary - of all activity segments of a particular activity type over a time interval. - - - -
- public - static - final - DataTypeAGGREGATE_BASAL_METABOLIC_RATE_SUMMARY - In the com.google.bmr.summary data type, each data point represents the - average, maximum and minimum basal metabolic rate, in kcal per day, over the time interval of - the data point. - - - -
- public - static - final - DataTypeAGGREGATE_BODY_FAT_PERCENTAGE_SUMMARY - In the com.google.body.fat_percentage.summary data type, each data point represents - the average, maximum and minimum percentage over the time interval of the data point. - - - -
- public - static - final - DataTypeAGGREGATE_CALORIES_CONSUMED - - This field is deprecated. - Use AGGREGATE_NUTRITION_SUMMARY instead, which contains calories as - well as other nutrients. This data type will be removed in a future release. - - - - -
- public - static - final - DataTypeAGGREGATE_CALORIES_EXPENDED - Aggregate calories expended,in kcal, during a time interval. - - - -
- public - static - final - DataTypeAGGREGATE_DISTANCE_DELTA - Aggregate distance, in meters, during a time interval. - - - -
- public - static - final - DataTypeAGGREGATE_HEART_RATE_SUMMARY - In the com.google.heart_rate.summary data type, each data point represents - average, maximum and minimum beats per minute over the time interval of the data point. - - - -
- public - static - final - Set<DataType>AGGREGATE_INPUT_TYPES - List of data types that are supported as input data types for aggregation. - - - -
- public - static - final - DataTypeAGGREGATE_LOCATION_BOUNDING_BOX - In the com.google.location.bounding_box data type, a data point represents the - bounding box computed over user's location data points over a time interval. - - - -
- public - static - final - DataTypeAGGREGATE_NUTRITION_SUMMARY - In the com.google.nutrition.summary data type, each data point represents the sum of - all nutrition entries over the time interval of the data point. - - - -
- public - static - final - DataTypeAGGREGATE_POWER_SUMMARY - In the com.google.power.summary data type, each data point represents - average, maximum and minimum watts over the time interval of the data point. - - - -
- public - static - final - DataTypeAGGREGATE_SPEED_SUMMARY - In the com.google.speed.summary data type, each data point represents the - average, maximum and minimum speed over ground, in meters/second, over the time interval of - the data point. - - - -
- public - static - final - DataTypeAGGREGATE_STEP_COUNT_DELTA - Aggregate number of steps during a time interval. - - - -
- public - static - final - DataTypeAGGREGATE_WEIGHT_SUMMARY - In the com.google.weight.summary data type, each data point represents the - average, maximum and minimum weight, in kilograms, over the time interval of - the data point. - - - -
- public - static - final - DataTypeTYPE_ACTIVITY_SAMPLE - In the com.google.activity.sample data type, each data point represents an - instantaneous sample of the current activity. - - - -
- public - static - final - DataTypeTYPE_ACTIVITY_SEGMENT - In the com.google.activity.segment data type, each data point represents a continuous - time interval with a single activity value. - - - -
- public - static - final - DataTypeTYPE_BASAL_METABOLIC_RATE - In the com.google.calories.bmr data type, each data point represents the basal - metabolic rate of energy expenditure at rest of the user at the time of the reading, in kcal - per day. - - - -
- public - static - final - DataTypeTYPE_BODY_FAT_PERCENTAGE - In the com.google.body.fat.percentage data type, each data point represents a - measurement of the total fat mass in a person's body as a percentage of the total body mass. - - - -
- public - static - final - DataTypeTYPE_CALORIES_CONSUMED - - This field is deprecated. - Use TYPE_NUTRITION instead which holds calories as well as other - nutrients. This data type will be removed in a future release. - - - - -
- public - static - final - DataTypeTYPE_CALORIES_EXPENDED - In the com.google.calories.expended data type, each data point represents the number - of calories expended, in kcal, over the time interval of the data point. - - - -
- public - static - final - DataTypeTYPE_CYCLING_PEDALING_CADENCE - In the com.google.cycling,cadence data type, each data point represents an - instantaneous measurement of the pedaling rate in crank revolutions per minute. - - - -
- public - static - final - DataTypeTYPE_CYCLING_PEDALING_CUMULATIVE - In the com.google.cycling.pedaling.cumulative data type, each data point represents - the number of rotations taken from the start of the count. - - - -
- public - static - final - DataTypeTYPE_CYCLING_WHEEL_REVOLUTION - In the com.google.cycling.wheel_revolution.cumulative data type, each data point - represents the number of revolutions taken from the start of the count. - - - -
- public - static - final - DataTypeTYPE_CYCLING_WHEEL_RPM - In the com.google.cycling.wheel.revolutions data type, each data point represents an - instantaneous measurement of the wheel in revolutions per minute. - - - -
- public - static - final - DataTypeTYPE_DISTANCE_DELTA - In the com.google.distance.delta data type, each data point represents the distance - covered, in meters, since the last reading. - - - -
- public - static - final - DataTypeTYPE_HEART_RATE_BPM - In the com.google.heart_rate.bpm data type, each data point represents an - instantaneous measurement of the heart rate in beats per minute. - - - -
- public - static - final - DataTypeTYPE_HEIGHT - In the com.google.height data type, each data point represents the height of the - user at the time of the reading, in meters. - - - -
- public - static - final - DataTypeTYPE_LOCATION_SAMPLE - In the com.google.location.sample data type, each data point represents the user's - location at a given instant. - - - -
- public - static - final - DataTypeTYPE_LOCATION_TRACK - The com.google.location.track data type represents a location point that is part of a - track and which may have inexact timestamps. - - - -
- public - static - final - DataTypeTYPE_NUTRITION - In the com.google.nutrition data type, each data point represents the value of - all nutrients consumed as part of a meal or a food item. - - - -
- public - static - final - DataTypeTYPE_POWER_SAMPLE - In the com.google.power.sample data type, each data point represents an - instantaneous measurement of power in watts. - - - -
- public - static - final - DataTypeTYPE_SPEED - In the com.google.speed data type, each data point represents the instantaneous - speed over ground, in meters/second. - - - -
- public - static - final - DataTypeTYPE_STEP_COUNT_CADENCE - In the com.google.step_count.cadence data type, each data point represents an - instantaneous measurement of the cadence in steps per minute. - - - -
- public - static - final - DataTypeTYPE_STEP_COUNT_DELTA - In the com.google.step_count.delta data type, each data point represents the number - of steps taken since the last reading. - - - -
- public - static - final - DataTypeTYPE_WEIGHT - In the com.google.weight data type, each data point represents the weight of the - user at the time of the reading, in kilograms. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - static - - List<DataType> - - getAggregatesForInput(DataType inputDataType) - -
- Returns a list of output aggregate data types for the specified inputDataType. - - - -
- -
- - - - - - List<Field> - - getFields() - -
- Returns the ordered list of fields for the data type. - - - -
- -
- - - - static - - String - - getMimeType(DataType dataType) - -
- Returns the MIME type for a particular DataType. - - - -
- -
- - - - - - String - - getName() - -
- Returns the namespaced name which uniquely identifies this data type. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - int - - indexOf(Field field) - -
- Return the index of a field - - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - MIME_TYPE_PREFIX -

-
- - - - -
-
- - - - -

The common prefix for data type MIME types, for use in intents. The - MIME type for a particular data type will be this prefix followed by the data type name. - Examples: - 

-     vnd.google.fitness.data_type/com.google.heart_rate.bpm
-     vnd.google.fitness.data_type/com.google.activity.segment
-     vnd.google.fitness.data_type/com.example.my_type
-
- The data type's name is returned by getName(). The full MIME type can be - computed by getMimeType(DataType). -

- - -
- Constant Value: - - - "vnd.google.fitness.data_type/" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - DataType - - AGGREGATE_ACTIVITY_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.activity.summary data type, each data point represents a summary - of all activity segments of a particular activity type over a time interval. The data type - has three fields: -

    -
  1. activity an activity from FitnessActivities, as described in - FIELD_ACTIVITY. -
  2. duration an integer denoting the total time spent, in milliseconds, in this - activity across all segments over the time interval of this data point -
  3. num_segments number of distinct activity segments over the time interval of this - data point -
-

- Because this is an aggregate data type, start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_BASAL_METABOLIC_RATE_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.bmr.summary data type, each data point represents the - average, maximum and minimum basal metabolic rate, in kcal per day, over the time interval of - the data point. -

- Because this is an aggregate data type, the start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_BODY_FAT_PERCENTAGE_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.body.fat_percentage.summary data type, each data point represents - the average, maximum and minimum percentage over the time interval of the data point. -

- Because this is an aggregate data type, the start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_CALORIES_CONSUMED -

-
- - - - -
-
- - - -

-

- This field is deprecated.
- Use AGGREGATE_NUTRITION_SUMMARY instead, which contains calories as - well as other nutrients. This data type will be removed in a future release. - -

-

Aggregate calories consumed,in kcal, during a time interval. This data type is equivalent - to the one used for non-aggregated data. The full definition can be found at - TYPE_CALORIES_CONSUMED.

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_CALORIES_EXPENDED -

-
- - - - -
-
- - - - -

Aggregate calories expended,in kcal, during a time interval. This data type is equivalent - to the one used for non-aggregated data. The full definition can be found at - TYPE_CALORIES_EXPENDED. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_DISTANCE_DELTA -

-
- - - - -
-
- - - - -

Aggregate distance, in meters, during a time interval. This data type is equivalent to the - one used for non-aggregated data. The full definition can be found at - TYPE_DISTANCE_DELTA. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_HEART_RATE_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.heart_rate.summary data type, each data point represents - average, maximum and minimum beats per minute over the time interval of the data point. -

- Because this is an aggregate data type, start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - Set<DataType> - - AGGREGATE_INPUT_TYPES -

-
- - - - -
-
- - - - -

List of data types that are supported as input data types for aggregation. These - include: -

- Currently, data types outside of the com.google namespace cannot be aggregated by - the platform. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_LOCATION_BOUNDING_BOX -

-
- - - - -
-
- - - - -

In the com.google.location.bounding_box data type, a data point represents the - bounding box computed over user's location data points over a time interval. Each bounding - box has four fields: -

    -
  1. low_latitude latitude of the lower left corner of the box, - represented as a float, in degrees -
  2. low_longitude longitude of the lower left corner of the box, - represented as a float, in degrees -
  3. high_latitude latitude of the upper right corner of the box, - represented as a float, in degrees -
  4. high_longitude longitude of the upper right corner of the box, - represented as a float, in degrees -
- Because this is an aggregate data type, start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_NUTRITION_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.nutrition.summary data type, each data point represents the sum of - all nutrition entries over the time interval of the data point. -

- In the nutrients field map, each value will represent the sum of the nutrient over all of - the entries in the interval. If the nutrient was not present in any of the entries, it won't - be present on the aggregate map either. -

- If all of the original entries are for the same meal, the meal_type field will also - be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_POWER_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.power.summary data type, each data point represents - average, maximum and minimum watts over the time interval of the data point. -

- Because this is an aggregate data type, start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_SPEED_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.speed.summary data type, each data point represents the - average, maximum and minimum speed over ground, in meters/second, over the time interval of - the data point. -

- Because this is an aggregate data type, the start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_STEP_COUNT_DELTA -

-
- - - - -
-
- - - - -

Aggregate number of steps during a time interval. This data type is equivalent to the - one used for non-aggregated data. The full definition can be found at - TYPE_STEP_COUNT_DELTA. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - AGGREGATE_WEIGHT_SUMMARY -

-
- - - - -
-
- - - - -

In the com.google.weight.summary data type, each data point represents the - average, maximum and minimum weight, in kilograms, over the time interval of - the data point. -

- Because this is an aggregate data type, the start and end times should be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_ACTIVITY_SAMPLE -

-
- - - - -
-
- - - - -

In the com.google.activity.sample data type, each data point represents an - instantaneous sample of the current activity. The data point has two fields, the first one - representing the activity (as described in - FIELD_ACTIVITY), - and the second representing the confidence in the sample, specified as a float between - 0.0 and 100.0. If the confidence is unknown or not calculated, a negative value can be used. -

- Because the samples are instantaneous, start time has no meaning and should be left unset. -

- It's possible that more than one activity is detected at the same time with different - confidence values. This can be represented as multiple data points with the same timestamp - but different field values. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_ACTIVITY_SEGMENT -

-
- - - - -
-
- - - - -

In the com.google.activity.segment data type, each data point represents a continuous - time interval with a single activity value. Activity values are described in - FIELD_ACTIVITY. -

- The start time of the data point must always be present as it represents the start of the - activity, with the timestamp representing the activity's end time. Data point time intervals - should be non-overlapping, although they do not need to be contiguous. In case when two - activities happen at the same time, the most significant one should be used. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_BASAL_METABOLIC_RATE -

-
- - - - -
-
- - - - -

In the com.google.calories.bmr data type, each data point represents the basal - metabolic rate of energy expenditure at rest of the user at the time of the reading, in kcal - per day. -

- Because the recorded BMR is instantaneous, the start time should not be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_BODY_FAT_PERCENTAGE -

-
- - - - -
-
- - - - -

In the com.google.body.fat.percentage data type, each data point represents a - measurement of the total fat mass in a person's body as a percentage of the total body mass. -

- Since this is an instantaneous measurement, start time should not be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CALORIES_CONSUMED -

-
- - - - -
-
- - - -

-

- This field is deprecated.
- Use TYPE_NUTRITION instead which holds calories as well as other - nutrients. This data type will be removed in a future release. - -

-

In the com.google.calories.consumed data type, each data point represents the number - of calories consumed, in kcal, over the time interval of the data point. The field value - is stored as a float. -

- Start and end times should be set to denote the duration over which the calories were - consumed.

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CALORIES_EXPENDED -

-
- - - - -
-
- - - - -

In the com.google.calories.expended data type, each data point represents the number - of calories expended, in kcal, over the time interval of the data point. The field value - is stored as a float. -

- Start and end times should be set to denote the duration over which the calories were - expended. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CYCLING_PEDALING_CADENCE -

-
- - - - -
-
- - - - -

In the com.google.cycling,cadence data type, each data point represents an - instantaneous measurement of the pedaling rate in crank revolutions per minute. -

- Start time should be left unset. Different data sources will need to monitor the rotations - of the crank for different amounts of time before calculating the instantaneous RPM. - This should be indicated as part of the data source and not the data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CYCLING_PEDALING_CUMULATIVE -

-
- - - - -
-
- - - - -

In the com.google.cycling.pedaling.cumulative data type, each data point represents - the number of rotations taken from the start of the count. When using this - data type, each revolution can be reported multiple times, as the values of each data point - are monotonically increasing. To calculate the number of revolutions during an interval, the - value at the end of the interval should be subtracted from the value at the beginning. -

- Note that the count may reset to zero at different times depending on the data source. When - available, the data source should indicate the beginning of the count by setting the start - time of the data point to the time of the start of the count. Alternatively, a data point - with a value of zero can be used to indicate the resetting of the count. If neither of these - is available, the count resetting can be inferred in a best-effort basis by detecting - decreases in the total value. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CYCLING_WHEEL_REVOLUTION -

-
- - - - -
-
- - - - -

In the com.google.cycling.wheel_revolution.cumulative data type, each data point - represents the number of revolutions taken from the start of the count. - When using this data type, each revolution can be reported multiple times, as the values of - each data point are monotonically increasing. To calculate the number of revolutions during - an interval, the value at the end of the interval should be subtracted from the value at the - beginning. -

- Note that the count may reset to zero at different times depending on the data source. When - available, the data source should indicate the beginning of the count by setting the start - time of the data point to the time of the start of the count. Alternatively, a data point - with a value of zero can be used to indicate the resetting of the count. If neither of these - is available, the count resetting can be inferred in a best-effort basis by detecting - decreases in the total value. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_CYCLING_WHEEL_RPM -

-
- - - - -
-
- - - - -

In the com.google.cycling.wheel.revolutions data type, each data point represents an - instantaneous measurement of the wheel in revolutions per minute. -

- Start time should be left unset. Different data sources will need to monitor the RPMs for - different amounts of time before calculating the instantaneous RPM. - This should be indicated as part of the data source and not the data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_DISTANCE_DELTA -

-
- - - - -
-
- - - - -

In the com.google.distance.delta data type, each data point represents the distance - covered, in meters, since the last reading. The total distance over an - interval can be calculated by adding together all the values during the interval. -

- The start time of each data point should represent the start of the interval in which the - distance was covered. The start time must be equal to or greater than the end time of the - previous data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_HEART_RATE_BPM -

-
- - - - -
-
- - - - -

In the com.google.heart_rate.bpm data type, each data point represents an - instantaneous measurement of the heart rate in beats per minute. -

- Start time should be left unset. Different data sources will need to monitor the heart's - beat rate for different amounts of time before calculating the instantaneous heart rate. - This should be indicated as part of the data source and not the data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_HEIGHT -

-
- - - - -
-
- - - - -

In the com.google.height data type, each data point represents the height of the - user at the time of the reading, in meters. -

- Because the recorded height is instantaneous, the start time should not be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_LOCATION_SAMPLE -

-
- - - - -
-
- - - - -

In the com.google.location.sample data type, each data point represents the user's - location at a given instant. The location data point has four fields: -

    -
  1. latitude is represented as a float, in degrees -
  2. longitude is represented as a float, in degrees -
  3. accuracy is represented as a float, in meters, and defines the radius of - 68% confidence (so that it'd represent one standard deviation under a normal distribution) - for latitude and longitude. - See getAccuracy() for more details. -
  4. altitude is represented as a float, in meters above sea level. Accuracy - is unknown (not represented by accuracy). Most mobile devices produce measurements - that are up to 25 meters away from the correct altitude, so care must be taken to average - several results for increased accuracy or use another source for elevation information. - If altitude could not be determined for this location sample, this field is not set. -
-

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_LOCATION_TRACK -

-
- - - - -
-
- - - - -

The com.google.location.track data type represents a location point that is part of a - track and which may have inexact timestamps. -

- Its fields are the same as location.sample. The - difference between the two data types is that, while location.sample data points - have an exact timestamp, location.track data points have an inexact time interval. - The start time will represent the earliest time where the user may been at the - location, and the end time will represent the latest time. Start time should always be - set, even if it's the same as end time. -

- One use case of location.track is capturing the path of a user during an activity - when the track for the path is known, but the exact time at each coordinate isn't. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_NUTRITION -

-
- - - - -
-
- - - - -

In the com.google.nutrition data type, each data point represents the value of - all nutrients consumed as part of a meal or a food item. -

- The data point contains several fields. The nutrients field and either the meal type and/or - the food item field are required. -

    -
  • nutrients contains all of the nutrient data for the entry -
  • meal_type lists the type of meal, if known -
  • food_item lists the particular food item for the entry, if known -
-

- In case the meal time is known, it should be reflected in the timestamps. Otherwise, start - and end times should be set to the range in which the meal occurred. -

- The meal_type field accepts the following values, which are defined as constants in - Field: -

- When the meal type isn't known, the field may be absent or set to "unknown". Apps should - handle both cases accordingly. -

- The nutrients field is a map where the key holds the type of nutrient and the - value holds the amount of the nutrient for the entry. Key values are represented by the - NUTRIENT_XXX constants in Field. In - case the amount of the nutrient for the entry is not known, no value for that nutrient should - be added to the map. You may optionally use a value of zero when it is known that the - nutrient is not present in the entry. Multiple nutrients can be added by calling - setKeyValue(String, float) repeatedly. -

- Here's an example of creating a DataPoint to represent the user eating a banana: - 

-     DataSource nutritionSource = new DataSource.Builder()
-         .setDataType(TYPE_NUTRITION)
-         ...
-         .build();
-
-     DataPoint banana = DataPoint.create(nutritionSource);
-     banana.setTimestamp(now.getMillis(), MILLISECONDS);
-     banana.getValue(FIELD_FOOD_ITEM).setString("banana");
-     banana.getValue(FIELD_MEAL_TYPE).setInt(MEAL_TYPE_SNACK);
-     banana.getValue(FIELD_NUTRIENTS).setKeyValue(NUTRIENT_TOTAL_FAT, 0.4f);
-     banana.getValue(FIELD_NUTRIENTS).setKeyValue(NUTRIENT_SODIUM, 1f);
-     banana.getValue(FIELD_NUTRIENTS).setKeyValue(NUTRIENT_POTASSIUM, 422f);
-
-

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_POWER_SAMPLE -

-
- - - - -
-
- - - - -

In the com.google.power.sample data type, each data point represents an - instantaneous measurement of power in watts. The field value - is stored as a float. -

- Because the recorded power is instantaneous, the start time should not be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_SPEED -

-
- - - - -
-
- - - - -

In the com.google.speed data type, each data point represents the instantaneous - speed over ground, in meters/second. The value represents the scalar magnitude of the speed, - so negative values should not occur. -

- Because the recorded speed is instantaneous, the start time should not be set. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_STEP_COUNT_CADENCE -

-
- - - - -
-
- - - - -

In the com.google.step_count.cadence data type, each data point represents an - instantaneous measurement of the cadence in steps per minute. -

- Both feet are used for calculating cadence, so if a sensor only measures one foot the value - measurement is doubled. -

- Start time should be left unset. Different data sources will need to monitor the rotations - of the crank for different amounts of time before calculating the instantaneous RPM. - This should be indicated as part of the data source and not the data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_STEP_COUNT_DELTA -

-
- - - - -
-
- - - - -

In the com.google.step_count.delta data type, each data point represents the number - of steps taken since the last reading. When using this data type, each - step is only ever reported once, in the reading immediately succeeding the step. By adding - all of the values together for a period of time, the total number of steps during that period - can be computed. -

- As an example, if a user walked a total of 5 steps, with 3 different readings, the values for - each reading might be [1, 2, 2]. -

- The start time of each data point should represent the start of the interval in which steps - were taken. The start time must be equal to or greater than the end time of the previous - data point. -

- - -
-
- - - - - -
-

- - public - static - final - DataType - - TYPE_WEIGHT -

-
- - - - -
-
- - - - -

In the com.google.weight data type, each data point represents the weight of the - user at the time of the reading, in kilograms. -

- Because the recorded weight is instantaneous, the start time should not be set. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - List<DataType> - - getAggregatesForInput - (DataType inputDataType) -

-
-
- - - -
-
- - - - -

Returns a list of output aggregate data types for the specified inputDataType. -

- -
-
- - - - -
-

- - public - - - - - List<Field> - - getFields - () -

-
-
- - - -
-
- - - - -

Returns the ordered list of fields for the data type. -

- -
-
- - - - -
-

- - public - static - - - - String - - getMimeType - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns the MIME type for a particular DataType. The MIME type is used in intents - such as the data view intent. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the namespaced name which uniquely identifies this data type. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - indexOf - (Field field) -

-
-
- - - -
-
- - - - -

Return the index of a field -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Device.html b/docs/html/reference/com/google/android/gms/fitness/data/Device.html deleted file mode 100644 index da0eb5ab11ba..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Device.html +++ /dev/null @@ -1,2359 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Device | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Device

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Device
- - - - - - - -
- - -

Class Overview

-

Representation of an integrated device (such as a phone or a wearable) that can hold sensors. - Each sensor is exposed as a DataSource. -

- The main purpose of the Device information contained in this class is to identify the hardware - of a particular data source. This can be useful in different ways, including: -

    -
  • distinguishing two similar sensors on different devices (the step counter on two nexus 5 - phones, for instance) -
  • display the source of data to the user (by using the device make / model) -
  • treat data differently depending on sensor type (accelerometers on a watch may give different - patterns than those on a phone) -
  • build different analysis models for each device/version. -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTYPE_CHEST_STRAP - Constant indicating the device is a chest strap. - - - -
intTYPE_PHONE - Constant indicating the device is an Android phone. - - - -
intTYPE_SCALE - Constant indicating the device is a scale or similar device the user steps on. - - - -
intTYPE_TABLET - Constant indicating the device is an Android tablet. - - - -
intTYPE_UNKNOWN - Constant indicating the device type is not known. - - - -
intTYPE_WATCH - Constant indicating the device is a watch or other wrist-mounted band. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Device(String manufacturer, String model, String uid, int type) - -
- Creates a new device. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - static - - Device - - getLocalDevice(Context context) - -
- Returns the Device representation of the local device, which can be used when defining local - data sources. - - - -
- -
- - - - - - String - - getManufacturer() - -
- Returns the manufacturer of the product/hardware. - - - -
- -
- - - - - - String - - getModel() - -
- Returns the end-user-visible model name for the device. - - - -
- -
- - - - - - int - - getType() - -
- Returns the constant representing the type of the device. - - - -
- -
- - - - - - String - - getUid() - -
- Returns the serial number or other unique ID for the hardware - - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - TYPE_CHEST_STRAP -

-
- - - - -
-
- - - - -

Constant indicating the device is a chest strap.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PHONE -

-
- - - - -
-
- - - - -

Constant indicating the device is an Android phone.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SCALE -

-
- - - - -
-
- - - - -

Constant indicating the device is a scale or similar device the user steps on.

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TABLET -

-
- - - - -
-
- - - - -

Constant indicating the device is an Android tablet.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating the device type is not known.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_WATCH -

-
- - - - -
-
- - - - -

Constant indicating the device is a watch or other wrist-mounted band.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Device - (String manufacturer, String model, String uid, int type) -

-
-
- - - -
-
- - - - -

Creates a new device.

-
-
Parameters
- - - - - - - - - - - - - -
manufacturer - the manufacturer of the product/hardware
model - the end-user-visible name for the end product
uid - a serial number or other unique identifier for the particular device hardware
type - the type of device. One of the type constants. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - Device - - getLocalDevice - (Context context) -

-
-
- - - -
-
- - - - -

Returns the Device representation of the local device, which can be used when defining local - data sources. -

- -
-
- - - - -
-

- - public - - - - - String - - getManufacturer - () -

-
-
- - - -
-
- - - - -

Returns the manufacturer of the product/hardware. -

- -
-
- - - - -
-

- - public - - - - - String - - getModel - () -

-
-
- - - -
-
- - - - -

Returns the end-user-visible model name for the device. -

- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Returns the constant representing the type of the device. This will usually be one of the - values from the type constants in this class, but it's not required to be. Any other value - should be treated as TYPE_UNKNOWN. -

- -
-
- - - - -
-

- - public - - - - - String - - getUid - () -

-
-
- - - -
-
- - - - -

Returns the serial number or other unique ID for the hardware -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Field.html b/docs/html/reference/com/google/android/gms/fitness/data/Field.html deleted file mode 100644 index 91bf86113517..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Field.html +++ /dev/null @@ -1,4631 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Field | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Field

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Field
- - - - - - - -
- - -

Class Overview

-

A field represents one dimension of a data type. It defines the name and format of data. - Unlike data type names, field names are not namespaced, and only need to be unique within - the data type. -

- This class contains constants representing the field names of common data types, - each prefixed with FIELD_. These can be used to access and set the fields via - DataPoint.getValue(Field). -

- Fields for custom data types can be created using - addField(String, int). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intFORMAT_FLOAT - Format constant indicating the field holds float values. - - - -
intFORMAT_INT32 - Format constant indicating the field holds integer values. - - - -
intFORMAT_MAP - Format constant indicating the field holds a map of string keys to values. - - - -
intFORMAT_STRING - Format constant indicating the field holds string values. - - - -
intMEAL_TYPE_BREAKFAST - Meal type constant representing a breakfast meal. - - - -
intMEAL_TYPE_DINNER - Meal type constant representing a dinner meal. - - - -
intMEAL_TYPE_LUNCH - Meal type constant representing a lunch meal. - - - -
intMEAL_TYPE_SNACK - Meal type constant representing a snack meal. - - - -
intMEAL_TYPE_UNKNOWN - Meal type constant representing the meal type is unknown - - - - -
StringNUTRIENT_CALCIUM - Calcium amount in milligrams. - - - -
StringNUTRIENT_CALORIES - Calories in kcal. - - - -
StringNUTRIENT_CHOLESTEROL - Cholesterol in milligrams. - - - -
StringNUTRIENT_DIETARY_FIBER - Dietary fiber in grams. - - - -
StringNUTRIENT_IRON - Iron amount in milligrams. - - - -
StringNUTRIENT_MONOUNSATURATED_FAT - Monounsaturated fat in grams. - - - -
StringNUTRIENT_POLYUNSATURATED_FAT - Polyunsaturated fat in grams. - - - -
StringNUTRIENT_POTASSIUM - Potassium in milligrams. - - - -
StringNUTRIENT_PROTEIN - Protein amount in grams. - - - -
StringNUTRIENT_SATURATED_FAT - Saturated fat in grams. - - - -
StringNUTRIENT_SODIUM - Sodium in milligrams. - - - -
StringNUTRIENT_SUGAR - Sugar amount in grams. - - - -
StringNUTRIENT_TOTAL_CARBS - Total carbohydrates in grams. - - - -
StringNUTRIENT_TOTAL_FAT - Total fat in grams. - - - -
StringNUTRIENT_TRANS_FAT - Trans fat in grams. - - - -
StringNUTRIENT_VITAMIN_A - Vitamin A amount in International Units (IU). - - - -
StringNUTRIENT_VITAMIN_C - Vitamin C amount in milligrams. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - FieldFIELD_ACCURACY - The accuracy of an accompanied value (such as location). - - - -
- public - static - final - FieldFIELD_ACTIVITY - An activity type of FitnessActivities, encoded as an integer for efficiency. - - - -
- public - static - final - FieldFIELD_ALTITUDE - An altitude of a location represented as a float, in meters above sea level. - - - -
- public - static - final - FieldFIELD_AVERAGE - An average value. - - - -
- public - static - final - FieldFIELD_BPM - A heart rate in beats per minute. - - - -
- public - static - final - FieldFIELD_CALORIES - Calories in kcal. - - - -
- public - static - final - FieldFIELD_CIRCUMFERENCE - Circumference of a body part, in centimeters. - - - -
- public - static - final - FieldFIELD_CONFIDENCE - The confidence of an accompanied value, specified as a value between 0.0 and 100.0. - - - -
- public - static - final - FieldFIELD_DISTANCE - A distance in meters. - - - -
- public - static - final - FieldFIELD_DURATION - A duration in milliseconds. - - - -
- public - static - final - FieldFIELD_FOOD_ITEM - The corresponding food item for a nutrition entry. - - - -
- public - static - final - FieldFIELD_HEIGHT - A height in meters. - - - -
- public - static - final - FieldFIELD_HIGH_LATITUDE - A high latitude of a location bounding box represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_HIGH_LONGITUDE - A high longitude of a location bounding box represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_LATITUDE - A latitude of a location represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_LONGITUDE - A longitude of a location represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_LOW_LATITUDE - A low latitude of a location bounding box represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_LOW_LONGITUDE - A low longitude of a location bounding box represented as a float, in degrees. - - - -
- public - static - final - FieldFIELD_MAX - A maximum value. - - - -
- public - static - final - FieldFIELD_MEAL_TYPE - Type of meal, represented as the appropriate int constant. - - - -
- public - static - final - FieldFIELD_MIN - A minimum value. - - - -
- public - static - final - FieldFIELD_NUM_SEGMENTS - A number of segments. - - - -
- public - static - final - FieldFIELD_NUTRIENTS - Nutrients ingested by the user, represented as a float map of nutrient key to quantity. - - - -
- public - static - final - FieldFIELD_PERCENTAGE - A percentage value, between 0 and 100. - - - -
- public - static - final - FieldFIELD_REVOLUTIONS - A count of revolutions. - - - -
- public - static - final - FieldFIELD_RPM - Revolutions per minute or rate per minute. - - - -
- public - static - final - FieldFIELD_SPEED - A speed in meter/sec. - - - -
- public - static - final - FieldFIELD_STEPS - A count of steps. - - - -
- public - static - final - FieldFIELD_WATTS - Power in watts. - - - -
- public - static - final - FieldFIELD_WEIGHT - A weight in kilograms. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - int - - getFormat() - -
- Returns the format of the field, as one of the format constant values. - - - -
- -
- - - - - - String - - getName() - -
- Returns the name of the field. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - FORMAT_FLOAT -

-
- - - - -
-
- - - - -

Format constant indicating the field holds float values.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FORMAT_INT32 -

-
- - - - -
-
- - - - -

Format constant indicating the field holds integer values.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FORMAT_MAP -

-
- - - - -
-
- - - - -

Format constant indicating the field holds a map of string keys to values. - The valid key space and units for the corresponding value should be documented as - part of the data type definition. - -

Map values can be set using setKeyValue(String, float) and read using - getKeyValue(String). - -

Keys should be kept small whenever possible. Data streams with large keys and - high data frequency may be down sampled. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FORMAT_STRING -

-
- - - - -
-
- - - - -

Format constant indicating the field holds string values. - Strings should be kept small whenever possible. Data streams with large string - values and high data frequency may be down sampled. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEAL_TYPE_BREAKFAST -

-
- - - - -
-
- - - - -

Meal type constant representing a breakfast meal. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEAL_TYPE_DINNER -

-
- - - - -
-
- - - - -

Meal type constant representing a dinner meal. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEAL_TYPE_LUNCH -

-
- - - - -
-
- - - - -

Meal type constant representing a lunch meal. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEAL_TYPE_SNACK -

-
- - - - -
-
- - - - -

Meal type constant representing a snack meal. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MEAL_TYPE_UNKNOWN -

-
- - - - -
-
- - - - -

Meal type constant representing the meal type is unknown -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_CALCIUM -

-
- - - - -
-
- - - - -

Calcium amount in milligrams. -

- - -
- Constant Value: - - - "calcium" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_CALORIES -

-
- - - - -
-
- - - - -

Calories in kcal. -

- - -
- Constant Value: - - - "calories" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_CHOLESTEROL -

-
- - - - -
-
- - - - -

Cholesterol in milligrams. -

- - -
- Constant Value: - - - "cholesterol" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_DIETARY_FIBER -

-
- - - - -
-
- - - - -

Dietary fiber in grams. -

- - -
- Constant Value: - - - "dietary_fiber" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_IRON -

-
- - - - -
-
- - - - -

Iron amount in milligrams. -

- - -
- Constant Value: - - - "iron" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_MONOUNSATURATED_FAT -

-
- - - - -
-
- - - - -

Monounsaturated fat in grams. -

- - -
- Constant Value: - - - "fat.monounsaturated" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_POLYUNSATURATED_FAT -

-
- - - - -
-
- - - - -

Polyunsaturated fat in grams. -

- - -
- Constant Value: - - - "fat.polyunsaturated" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_POTASSIUM -

-
- - - - -
-
- - - - -

Potassium in milligrams. -

- - -
- Constant Value: - - - "potassium" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_PROTEIN -

-
- - - - -
-
- - - - -

Protein amount in grams. -

- - -
- Constant Value: - - - "protein" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_SATURATED_FAT -

-
- - - - -
-
- - - - -

Saturated fat in grams. -

- - -
- Constant Value: - - - "fat.saturated" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_SODIUM -

-
- - - - -
-
- - - - -

Sodium in milligrams. -

- - -
- Constant Value: - - - "sodium" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_SUGAR -

-
- - - - -
-
- - - - -

Sugar amount in grams. -

- - -
- Constant Value: - - - "sugar" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_TOTAL_CARBS -

-
- - - - -
-
- - - - -

Total carbohydrates in grams. -

- - -
- Constant Value: - - - "carbs.total" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_TOTAL_FAT -

-
- - - - -
-
- - - - -

Total fat in grams. -

- - -
- Constant Value: - - - "fat.total" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_TRANS_FAT -

-
- - - - -
-
- - - - -

Trans fat in grams. -

- - -
- Constant Value: - - - "fat.trans" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_VITAMIN_A -

-
- - - - -
-
- - - - -

Vitamin A amount in International Units (IU). For converting from daily percentages, the - - FDA recommended 5000 IUs Daily Value can be used. -

- - -
- Constant Value: - - - "vitamin_a" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - NUTRIENT_VITAMIN_C -

-
- - - - -
-
- - - - -

Vitamin C amount in milligrams. -

- - -
- Constant Value: - - - "vitamin_c" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Field - - FIELD_ACCURACY -

-
- - - - -
-
- - - - -

The accuracy of an accompanied value (such as location). -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_ACTIVITY -

-
- - - - -
-
- - - - -

An activity type of FitnessActivities, encoded as an integer for efficiency. The - activity value should be stored using setActivity(String), - and read using asActivity() -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_ALTITUDE -

-
- - - - -
-
- - - - -

An altitude of a location represented as a float, in meters above sea level. - Some location samples don't have an altitude value so this field might not be set. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_AVERAGE -

-
- - - - -
-
- - - - -

An average value. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_BPM -

-
- - - - -
-
- - - - -

A heart rate in beats per minute. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_CALORIES -

-
- - - - -
-
- - - - -

Calories in kcal. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_CIRCUMFERENCE -

-
- - - - -
-
- - - - -

Circumference of a body part, in centimeters. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_CONFIDENCE -

-
- - - - -
-
- - - - -

The confidence of an accompanied value, specified as a value between 0.0 and 100.0. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_DISTANCE -

-
- - - - -
-
- - - - -

A distance in meters. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_DURATION -

-
- - - - -
-
- - - - -

A duration in milliseconds. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_FOOD_ITEM -

-
- - - - -
-
- - - - -

The corresponding food item for a nutrition entry. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_HEIGHT -

-
- - - - -
-
- - - - -

A height in meters. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_HIGH_LATITUDE -

-
- - - - -
-
- - - - -

A high latitude of a location bounding box represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_HIGH_LONGITUDE -

-
- - - - -
-
- - - - -

A high longitude of a location bounding box represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_LATITUDE -

-
- - - - -
-
- - - - -

A latitude of a location represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_LONGITUDE -

-
- - - - -
-
- - - - -

A longitude of a location represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_LOW_LATITUDE -

-
- - - - -
-
- - - - -

A low latitude of a location bounding box represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_LOW_LONGITUDE -

-
- - - - -
-
- - - - -

A low longitude of a location bounding box represented as a float, in degrees. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_MAX -

-
- - - - -
-
- - - - -

A maximum value. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_MEAL_TYPE -

-
- - - - -
-
- - - - -

Type of meal, represented as the appropriate int constant. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_MIN -

-
- - - - -
-
- - - - -

A minimum value. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_NUM_SEGMENTS -

-
- - - - -
-
- - - - -

A number of segments. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_NUTRIENTS -

-
- - - - -
-
- - - - -

Nutrients ingested by the user, represented as a float map of nutrient key to quantity. - The valid keys of the map are listed in this class using the NUTRIENT_ prefix. - The documentation for each key describes the unit of its value. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_PERCENTAGE -

-
- - - - -
-
- - - - -

A percentage value, between 0 and 100. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_REVOLUTIONS -

-
- - - - -
-
- - - - -

A count of revolutions. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_RPM -

-
- - - - -
-
- - - - -

Revolutions per minute or rate per minute. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_SPEED -

-
- - - - -
-
- - - - -

A speed in meter/sec. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_STEPS -

-
- - - - -
-
- - - - -

A count of steps. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_WATTS -

-
- - - - -
-
- - - - -

Power in watts. -

- - -
-
- - - - - -
-

- - public - static - final - Field - - FIELD_WEIGHT -

-
- - - - -
-
- - - - -

A weight in kilograms. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getFormat - () -

-
-
- - - -
-
- - - - -

Returns the format of the field, as one of the format constant values. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name of the field. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Session.Builder.html b/docs/html/reference/com/google/android/gms/fitness/data/Session.Builder.html deleted file mode 100644 index d90933c50a8d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Session.Builder.html +++ /dev/null @@ -1,1819 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Session.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Session.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Session.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new Sessions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Session.Builder() - -
- Constructs an instance of the Session.Builder. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Session - - build() - -
- Finishes building and returns the session. - - - -
- -
- - - - - - Session.Builder - - setActiveTime(long time, TimeUnit timeUnit) - -
- Sets the active session period duration. - - - -
- -
- - - - - - Session.Builder - - setActivity(String activity) - -
- Sets the activity associated with this session. - - - -
- -
- - - - - - Session.Builder - - setDescription(String description) - -
- Sets a description for this session. - - - -
- -
- - - - - - Session.Builder - - setEndTime(long time, TimeUnit timeUnit) - -
- Sets the end time of the session. - - - -
- -
- - - - - - Session.Builder - - setIdentifier(String identifier) - -
- Sets the identifier for this session. - - - -
- -
- - - - - - Session.Builder - - setName(String name) - -
- Sets the a human readable name of the session. - - - -
- -
- - - - - - Session.Builder - - setStartTime(long time, TimeUnit timeUnit) - -
- Sets the start time of the session. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Session.Builder - () -

-
-
- - - -
-
- - - - -

Constructs an instance of the Session.Builder.

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Session - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the session. Returned session will always have non-empty - non-null identifier.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough state to - create a valid request -
-
- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setActiveTime - (long time, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the active session period duration. -

- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setActivity - (String activity) -

-
-
- - - -
-
- - - - -

Sets the activity associated with this session. The specified activity value should be - one of the values in FitnessActivities. If an unrecognized value is specified, - or if not specified, the activity for the session is set to - UNKNOWN. -

- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

Sets a description for this session. -

- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setEndTime - (long time, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the end time of the session. If end time is not specified, session is considered to - be still ongoing.

-
-
Parameters
- - - - - - - -
time - an end time, in the given unit since epoch, inclusive
timeUnit - the unit of the timestamp -
-
- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setIdentifier - (String identifier) -

-
-
- - - -
-
- - - - -

Sets the identifier for this session. Must be unique for the client application. -

- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

Sets the a human readable name of the session. -

- -
-
- - - - -
-

- - public - - - - - Session.Builder - - setStartTime - (long time, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the start time of the session.

-
-
Parameters
- - - - - - - -
time - a start time, in the given unit since epoch, inclusive
timeUnit - the unit of the timestamp -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Session.html b/docs/html/reference/com/google/android/gms/fitness/data/Session.html deleted file mode 100644 index abe9fa2fac7d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Session.html +++ /dev/null @@ -1,2541 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Session | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Session

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Session
- - - - - - - -
- - -

Class Overview

-

A Session represents a time interval with associated metadata. Sessions provide a mechanism to - store user-visible groups of related stream data in a useful and shareable manner, and allows for - easy querying of the data in a detailed or aggregated fashion. The start and end times for - sessions will be controlled by applications, and can be used to represent user-friendly groupings - of activities, such as "bike ride", "marathon training run", etc. Any data in Google Fit which - falls within this time range is implicitly associated with the session. -

- A session consists of the following fields: -

    -
  • startTime: the timestamp when the session started. This is a mandatory field. -
  • endTimeMillis: the timestamp when the session ended. If not specified, the session is - considered to be still ongoing. If specified, the end time should be strictly later than - the start time. This is an optional field. -
  • name: a human readable name, possibly specified by the user. For instance, "Sunday bike ride" -
  • identifier: a unique identifier for the session. Should be unique for the given application - and user. The application can use this identifier to later fetch a particular session. - If the identifier is not specified, one will be created from the start time and name. -
  • description: description of the session. Can be filled in by the user with specific notes - for the session. This is an optional field. -
  • activity: the activity associated with this session; for instance, biking. Can be used to - identify sessions that encompass a single user activity. This is an optional field. -
  • packageName: the package name of the application that added this session. This is inferred - automatically by the Fitness Platform. -
-

- Example usage: - 

-     new Session.Builder()
-          .setName(sessionName)
-          .setIdentifier(identifier)
-          .setDescription(description)
-          .setStartTime(startTime, TimeUnit.MILLISECONDS)
-          .setEndTime(endTime, TimeUnit.MILLISECONDS)
-          .setActivity(FitnessActivities.BIKING)
-          .build();
-

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSession.Builder - Builder used to create new Sessions.  - - - -
- - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_SESSION - Name for the parcelable intent extra containing a session. - - - -
StringMIME_TYPE_PREFIX - The common prefix for session MIME types. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - static - - Session - - extract(Intent intent) - -
- Extracts the session extra from the given intent, such as a callback intent received - after - registering - to session start/end notifications, or an intent to - view a session. - - - -
- -
- - - - - - long - - getActiveTime(TimeUnit timeUnit) - -
- Returns the active time period of the session. - - - -
- -
- - - - - - String - - getActivity() - -
- Returns the activity associated with this session, if set. - - - -
- -
- - - - - - String - - getAppPackageName() - -
- Returns the package name for the application responsible for adding the session. - - - -
- -
- - - - - - String - - getDescription() - -
- Returns the description for this session, if set. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time for the session, in the given unit since epoch. - - - -
- -
- - - - - - String - - getIdentifier() - -
- Returns the identifier for this session, if set. - - - -
- -
- - - - static - - String - - getMimeType(String activity) - -
- Returns the MIME type which describes a Session for a particular activity. - - - -
- -
- - - - - - String - - getName() - -
- Returns the name for this session. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time for the session, in the given time unit since epoch. - - - -
- -
- - - - - - boolean - - hasActiveTime() - -
- Returns whether the session active time is set. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isOngoing() - -
- Returns whether the session is ongoing. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_SESSION -

-
- - - - -
-
- - - - -

Name for the parcelable intent extra containing a session. It can be - extracted using extract(Intent). -

- - -
- Constant Value: - - - "vnd.google.fitness.session" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MIME_TYPE_PREFIX -

-
- - - - -
-
- - - - -

The common prefix for session MIME types. The MIME type for a particular - session will be this prefix followed by the session's activity name. Examples: - 

- vnd.google.fitness.session/running
- vnd.google.fitness.session/volleyball.beach
-
- The session's activity type is returned by getActivity(). The MIME - type can be computed from the activity using getMimeType(String) -

- - -
- Constant Value: - - - "vnd.google.fitness.session/" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - Session - - extract - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts the session extra from the given intent, such as a callback intent received - after - registering - to session start/end notifications, or an intent to - view a session.

-
-
Returns
-
  • the extracted Session, or null if the given intent does not contain a - Session -
-
- -
-
- - - - -
-

- - public - - - - - long - - getActiveTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the active time period of the session. - -

Make sure to use hasActiveTime() before using this method.

-
-
Throws
- - - - -
IllegalStateException - hasActiveTime() returns false. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getActivity - () -

-
-
- - - -
-
- - - - -

Returns the activity associated with this session, if set. Else returns - UNKNOWN. -

- -
-
- - - - -
-

- - public - - - - - String - - getAppPackageName - () -

-
-
- - - -
-
- - - - -

Returns the package name for the application responsible for adding the session. - or null if unset/unknown. The PackageManager can be used to query - relevant data on the application, such as the name, icon, logo, etc. -

- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Returns the description for this session, if set. -

- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time for the session, in the given unit since epoch. If the session is - ongoing (it hasn't ended yet), this will return 0. -

- -
-
- - - - -
-

- - public - - - - - String - - getIdentifier - () -

-
-
- - - -
-
- - - - -

Returns the identifier for this session, if set. -

- -
-
- - - - -
-

- - public - static - - - - String - - getMimeType - (String activity) -

-
-
- - - -
-
- - - - -

Returns the MIME type which describes a Session for a particular activity. The MIME type - is used in intents such as the session view - intent.

-
-
Parameters
- - - - -
activity - one of the activities in FitnessActivities. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name for this session. A non-empty name is always set. -

- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time for the session, in the given time unit since epoch. A valid start - time is always set. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasActiveTime - () -

-
-
- - - -
-
- - - - -

Returns whether the session active time is set. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isOngoing - () -

-
-
- - - -
-
- - - - -

Returns whether the session is ongoing. If the session has ended, this will return false. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Subscription.html b/docs/html/reference/com/google/android/gms/fitness/data/Subscription.html deleted file mode 100644 index 4b7581ef521f..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Subscription.html +++ /dev/null @@ -1,1798 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Subscription | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Subscription

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Subscription
- - - - - - - -
- - -

Class Overview

-

Subscription for persistent storage of data from a given data source or for a - given data type. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - DataSource - - getDataSource() - -
- Returns the data source for this subscription, if specified. - - - -
- -
- - - - - - DataType - - getDataType() - -
- Returns the data type for this subscription, if specified. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toDebugString() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DataSource - - getDataSource - () -

-
-
- - - -
-
- - - - -

Returns the data source for this subscription, if specified.

-
-
Returns
-
  • the specified data source, or null if none specified -
-
- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the data type for this subscription, if specified.

-
-
Returns
-
  • the specified data type, or null if none specified -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toDebugString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/Value.html b/docs/html/reference/com/google/android/gms/fitness/data/Value.html deleted file mode 100644 index 600e4d296bd0..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/Value.html +++ /dev/null @@ -1,2496 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Value | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Value

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.data.Value
- - - - - - - -
- - -

Class Overview

-

Holder object for the value of a single field in a data point. - Values are not constructed directly; a value for each field of the data type - is created for each data point. -

- A field value has a particular format, and should be set and read using the - format-specific methods. For instance, a float value should be set via setFloat(float) - and read via asFloat(). - Formats are defined as constants in Field -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - asActivity() - -
- Returns the value of this object as an activity. - - - -
- -
- - - - - - float - - asFloat() - -
- Returns the value of this object as a float. - - - -
- -
- - - - - - int - - asInt() - -
- Returns the value of this object as an int. - - - -
- -
- - - - - - String - - asString() - -
- Returns the value of this object as a string. - - - -
- -
- - - - - - void - - clearKey(String key) - -
- Clears any value currently associated with the given key in the map. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - getFormat() - -
- Returns the format of this value, which matches the appropriate field in the - data type definition. - - - -
- -
- - - - - - Float - - getKeyValue(String key) - -
- Returns the value of the given key in the map as a float. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isSet() - -
- Returns true if this object's value has been set by calling one of the setters. - - - -
- -
- - - - - - void - - setActivity(String activity) - -
- Updates this value object to represent an activity value. - - - -
- -
- - - - - - void - - setFloat(float value) - -
- Updates this value object to represent a float value. - - - -
- -
- - - - - - void - - setInt(int value) - -
- Updates this value object to represent an int value. - - - -
- -
- - - - - - void - - setKeyValue(String key, float value) - -
- Updates the value for a given key in the map to the given float value. - - - -
- -
- - - - - - void - - setString(String value) - -
- Updates this value object to represent a string value. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - asActivity - () -

-
-
- - - -
-
- - - - -

Returns the value of this object as an activity. The integer representation of the - activity is converted to a String prior to returning.

-
-
Returns
- -
-
-
Throws
- - - - -
IllegalStateException - if the object does not hold an int value -
-
- -
-
- - - - -
-

- - public - - - - - float - - asFloat - () -

-
-
- - - -
-
- - - - -

Returns the value of this object as a float.

-
-
Throws
- - - - -
IllegalStateException - if the object does not hold an float value -
-
- -
-
- - - - -
-

- - public - - - - - int - - asInt - () -

-
-
- - - -
-
- - - - -

Returns the value of this object as an int.

-
-
Throws
- - - - -
IllegalStateException - if the object does not hold an int value -
-
- -
-
- - - - -
-

- - public - - - - - String - - asString - () -

-
-
- - - -
-
- - - - -

Returns the value of this object as a string.

-
-
Throws
- - - - -
IllegalStateException - if the object does not hold a string value -
-
- -
-
- - - - -
-

- - public - - - - - void - - clearKey - (String key) -

-
-
- - - -
-
- - - - -

Clears any value currently associated with the given key in the map. This method can - be used only on map values.

-
-
Parameters
- - - - -
key - the key we're modifying -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getFormat - () -

-
-
- - - -
-
- - - - -

Returns the format of this value, which matches the appropriate field in the - data type definition.

-
-
Returns
-
  • one of the format constants from Field -
-
- -
-
- - - - -
-

- - public - - - - - Float - - getKeyValue - (String key) -

-
-
- - - -
-
- - - - -

Returns the value of the given key in the map as a float.

-
-
Returns
-
  • null if the key doesn't have a set value in the map -
-
-
-
Throws
- - - - -
IllegalStateException - if the object does not hold a map value
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isSet - () -

-
-
- - - -
-
- - - - -

Returns true if this object's value has been set by calling one of the setters. -

- -
-
- - - - -
-

- - public - - - - - void - - setActivity - (String activity) -

-
-
- - - -
-
- - - - -

Updates this value object to represent an activity value. - Activities are internally represented as integers for storage.

-
-
Parameters
- - - - -
activity - one of the activities from FitnessActivities -
-
- -
-
- - - - -
-

- - public - - - - - void - - setFloat - (float value) -

-
-
- - - -
-
- - - - -

Updates this value object to represent a float value. Any previous values associated - with this object are erased.

-
-
Parameters
- - - - -
value - the new value that this objects holds -
-
- -
-
- - - - -
-

- - public - - - - - void - - setInt - (int value) -

-
-
- - - -
-
- - - - -

Updates this value object to represent an int value. Any previous values are - erased.

-
-
Parameters
- - - - -
value - the new value that this object holds -
-
- -
-
- - - - -
-

- - public - - - - - void - - setKeyValue - (String key, float value) -

-
-
- - - -
-
- - - - -

Updates the value for a given key in the map to the given float value. Any previous - values associated with the key are erased. This method can be used only on - map values. - -

Key values should be kept small whenever possible. This is specially important for high - frequency streams, since large keys may result in down sampling.

-
-
Parameters
- - - - - - - -
key - the key we're modifying
value - the new value for the given key -
-
- -
-
- - - - -
-

- - public - - - - - void - - setString - (String value) -

-
-
- - - -
-
- - - - -

Updates this value object to represent a string value. Any previous values associated - with this object are erased. - -

String values should be kept small whenever possible. This is specially important for - high frequency streams, since large values may result in down sampling.

-
-
Parameters
- - - - -
value - the new value that this objects holds -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/data/package-summary.html b/docs/html/reference/com/google/android/gms/fitness/data/package-summary.html deleted file mode 100644 index b1ecc4ac4776..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/data/package-summary.html +++ /dev/null @@ -1,1027 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.fitness.data | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.fitness.data

-
- -
- -
- - -
- Contains the Google Fit data model. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BleDevice - Representation of a BLE Device (such as a heart rate monitor) that broadcasts information - about its on board sensors.  - - - -
Bucket - A bucket represents a time interval over which aggregated data is computed.  - - - -
DataPoint - Represents a single data point in a data type's stream from a particular - data source.  - - - -
DataSet - Represents a fixed set of data points in a data type's stream - from a particular data source.  - - - -
DataSource - Definition of a unique source of sensor data.  - - - -
DataSource.Builder - A builder that can be used to construct new data source objects.  - - - -
DataType - The data type defines the schema for a stream of data being collected by, inserted into, or - queried from Google Fit.  - - - -
Device - Representation of an integrated device (such as a phone or a wearable) that can hold sensors.  - - - -
Field - A field represents one dimension of a data type.  - - - -
Session - A Session represents a time interval with associated metadata.  - - - -
Session.Builder - Builder used to create new Sessions.  - - - -
Subscription - Subscription for persistent storage of data from a given data source or for a - given data type.  - - - -
Value - Holder object for the value of a single field in a data point.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/package-summary.html b/docs/html/reference/com/google/android/gms/fitness/package-summary.html deleted file mode 100644 index 82368a9c5779..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/package-summary.html +++ /dev/null @@ -1,1013 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.fitness | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.fitness

-
- -
- -
- - -
- Contains the Google Fit APIs. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BleApi - API for scanning, claiming, and using Bluetooth Low Energy devices in Google Fit.  - - - -
ConfigApi - API for accessing custom data types and settings in Google Fit.  - - - -
HistoryApi - API for inserting, deleting, and reading data in Google Fit.  - - - -
RecordingApi - API which enables low-power, always-on background collection of sensor - data into the Google Fit store.  - - - -
SensorsApi - API which exposes different sources of fitness data in local and connected devices, - and delivers live events to listeners.  - - - -
SessionsApi - API for creating and managing sessions of user activity in Google Fit.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fitness - The main entry point to Google Fit APIs.  - - - -
FitnessActivities - Constants representing different user activities, such as walking, running, and cycling.  - - - -
FitnessStatusCodes - Google Fit specific status codes, for use in getStatusCode() -  - - - -
HistoryApi.ViewIntentBuilder - Builder of intents to view data stored in Google Fit.  - - - -
SessionsApi.ViewIntentBuilder - Builder of intents to view sessions stored in Google Fit.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/BleScanCallback.html b/docs/html/reference/com/google/android/gms/fitness/request/BleScanCallback.html deleted file mode 100644 index 73f59de67f9d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/BleScanCallback.html +++ /dev/null @@ -1,1435 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BleScanCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

BleScanCallback

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.BleScanCallback
- - - - - - - -
- - -

Class Overview

-

Callback for BLE Scans. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - BleScanCallback() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDeviceFound(BleDevice device) - -
- Called once for each device found. - - - -
- -
- abstract - - - - - void - - onScanStopped() - -
- Called when the scan is stopped (normally because the timeout expired). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - BleScanCallback - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDeviceFound - (BleDevice device) -

-
-
- - - -
-
- - - - -

Called once for each device found. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onScanStopped - () -

-
-
- - - -
-
- - - - -

Called when the scan is stopped (normally because the timeout expired). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.Builder.html deleted file mode 100644 index 54790db7245d..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.Builder.html +++ /dev/null @@ -1,1775 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataDeleteRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

DataDeleteRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataDeleteRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new DataDeleteRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataDeleteRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - DataDeleteRequest.Builder - - addDataSource(DataSource dataSource) - -
- Adds a specific data source to delete data from the Google Fit store. - - - -
- -
- - - - - - DataDeleteRequest.Builder - - addDataType(DataType dataType) - -
- Adds a specific data type to delete data from the Google Fit store. - - - -
- -
- - - - - - DataDeleteRequest.Builder - - addSession(Session session) - -
- Adds a specific session to delete from the Google Fit store. - - - -
- -
- - - - - - DataDeleteRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - DataDeleteRequest.Builder - - deleteAllData() - -
- Adds option to delete data for all data types. - - - -
- -
- - - - - - DataDeleteRequest.Builder - - deleteAllSessions() - -
- - - - - - DataDeleteRequest.Builder - - setTimeInterval(long startTime, long endTime, TimeUnit timeUnit) - -
- Sets the time interval for the data delete query. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataDeleteRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - addDataSource - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Adds a specific data source to delete data from the Google Fit store. Apps can either - use this function or use addDataType(DataType) to add a specific data type, - or use deleteAllData() to mark data for all data types to be deleted.

-
-
Throws
- - - - -
IllegalArgumentException - if the input data source is invalid or if all data is - already marked for deletion -
-
- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - addDataType - (DataType dataType) -

-
-
- - - -
-
- - - - -

Adds a specific data type to delete data from the Google Fit store. Apps can either - use this function or use addDataSource(DataSource) to add a specific data - source, or use deleteAllData() to mark data for all data types to be deleted.

-
-
Throws
- - - - -
IllegalArgumentException - if invalid data type is specified or if all data is - already marked for deletion -
-
- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - addSession - (Session session) -

-
-
- - - -
-
- - - - -

Adds a specific session to delete from the Google Fit store. Apps can either use this - function or use deleteAllSessions() to mark all sessions for deletion. Only - sessions that have already ended can be marked for deletion.

-
-
Throws
- - - - -
IllegalArgumentException - if the input session is invalid or is still ongoing, - or if all sessions are already marked for deletion -
-
- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if time interval is not set or if input sessions are - outside the query time interval, or if no data or session is marked for deletion -
-
- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - deleteAllData - () -

-
-
- - - -
-
- - - - -

Adds option to delete data for all data types. Apps can either use this function to - delete all data or specify a specific data source using - addDataSource(DataSource) or a specific data type using - addDataType(DataType) for data deletion.

-
-
Throws
- - - - -
IllegalArgumentException - if a specific data source/type is already added for - deletion -
-
- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - deleteAllSessions - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DataDeleteRequest.Builder - - setTimeInterval - (long startTime, long endTime, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the time interval for the data delete query.

-
-
Throws
- - - - -
IllegalArgumentException - if the input time interval is invalid. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.html deleted file mode 100644 index c179aab54b9e..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataDeleteRequest.html +++ /dev/null @@ -1,2172 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataDeleteRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataDeleteRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataDeleteRequest
- - - - - - - -
- - -

Class Overview

-

A request to delete data and sessions added by the app from the Google Fit store in the time - interval specified. -

- An app can either specify a specific DataType or a specific DataSource or mark - data for all data types to be deleted. If neither a specific data type/source is specified nor - all data is marked for deletion, then no data will be deleted. -

- An app can also request to delete specific Sessions or all sessions added - by this app. If neither a specific session is specified nor all sessions are marked for - deletion, then no session will be deleted. -

- Only sessions that have already ended can be specified. Ongoing sessions will not be deleted. -

- An app can only delete data and sessions that it has added and cannot delete data and sessions - added by other apps. -

- Sample usage to delete data for a specific data type and session: - 

-     DataDeleteRequest request = new DataDeleteRequest.Builder()
-          .setTimeInterval(startTime, endTime, timeUnit)
-          .addDataType(dataType)
-          .addSession(session)
-          .build();
-
- Sample usage to delete data for all data types and a specific session: - 
-     DataDeleteRequest request = new DataDeleteRequest.Builder()
-          .setTimeInterval(startTime, endTime, timeUnit)
-          .deleteAllData()
-          .addSession(session)
-          .build();
-
- Sample usage to delete data for all data types and all sessions: - 
-     DataDeleteRequest request = new DataDeleteRequest.Builder()
-          .setTimeInterval(startTime, endTime, timeUnit)
-          .deleteAllData()
-          .deleteAllSessions()
-          .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classDataDeleteRequest.Builder - Builder used to create new DataDeleteRequests.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataDeleteRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - deleteAllData() - -
- Returns true if all data types are marked for deletion. - - - -
- -
- - - - - - boolean - - deleteAllSessions() - -
- Returns true if all sessions are marked for deletion. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<DataSource> - - getDataSources() - -
- Returns the list of data sources specified for data deletion. - - - -
- -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns the list of data types specified for data deletion. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time of the query, in the given unit since epoch. - - - -
- -
- - - - - - List<Session> - - getSessions() - -
- Returns the list of sessions specified for deletion. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time of the query, in the given unit since epoch. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataDeleteRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - deleteAllData - () -

-
-
- - - -
-
- - - - -

Returns true if all data types are marked for deletion. Otherwise, - only the specified data types and - data sources will have their data deleted. -

- -
-
- - - - -
-

- - public - - - - - boolean - - deleteAllSessions - () -

-
-
- - - -
-
- - - - -

Returns true if all sessions are marked for deletion. Otherwise, only the specified - sessions will be deleted. -

- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getDataSources - () -

-
-
- - - -
-
- - - - -

Returns the list of data sources specified for data deletion.

-
-
Returns
-
  • the data sources to have their data deleted, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns the list of data types specified for data deletion. All data sources for the - given data type will be deleted.

-
-
Returns
-
  • the data types to have their data deleted, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time of the query, in the given unit since epoch. A valid end time is - always set. -

- -
-
- - - - -
-

- - public - - - - - List<Session> - - getSessions - () -

-
-
- - - -
-
- - - - -

Returns the list of sessions specified for deletion.

-
-
Returns
-
  • the sessions that will be deleted, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time of the query, in the given unit since epoch. A valid start time is - always set. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.Builder.html deleted file mode 100644 index 53ef2cb2ebfe..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.Builder.html +++ /dev/null @@ -1,2490 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataReadRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

DataReadRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataReadRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new DataReadRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataReadRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - DataReadRequest.Builder - - aggregate(DataType inputDataType, DataType outputDataType) - -
- Adds the default data source for the given aggregate dataType to this request - and sets the output aggregate data type to be returned. - - - -
- -
- - - - - - DataReadRequest.Builder - - aggregate(DataSource dataSource, DataType outputDataType) - -
- Adds a specific data source we want aggregate data from for this request and also sets - the output aggregate data type that will be returned. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketByActivitySegment(int minDuration, TimeUnit timeUnit) - -
- Specifies bucket type as TYPE_ACTIVITY_SEGMENT, sets the minimum duration - of each TYPE_ACTIVITY_SEGMENT for the bucket. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketByActivitySegment(int minDuration, TimeUnit timeUnit, DataSource activityDataSource) - -
- Specifies bucket type as TYPE_ACTIVITY_SEGMENT, sets the minimum duration - of each TYPE_ACTIVITY_SEGMENT for the bucket. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketByActivityType(int minDuration, TimeUnit timeUnit) - -
- Specifies bucket type as TYPE_ACTIVITY_TYPE, sets the minimum duration of - each TYPE_ACTIVITY_SEGMENT for computing the buckets. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketByActivityType(int minDuration, TimeUnit timeUnit, DataSource activityDataSource) - -
- Specifies bucket type as TYPE_ACTIVITY_TYPE, sets the minimum duration of - each TYPE_ACTIVITY_SEGMENT for computing the buckets and sets the - activity data source to be used to read activity segments from. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketBySession(int minDuration, TimeUnit timeUnit) - -
- Specifies bucket type as TYPE_SESSION and sets the minimum duration of - each Session for the bucket. - - - -
- -
- - - - - - DataReadRequest.Builder - - bucketByTime(int duration, TimeUnit timeUnit) - -
- Specifies bucket type as TYPE_TIME and sets the duration of each bucket. - - - -
- -
- - - - - - DataReadRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - DataReadRequest.Builder - - enableServerQueries() - -
- Enable querying the Google Fit server to fetch query results, - in case the local store doesn't have data for the full requested time range. - - - -
- -
- - - - - - DataReadRequest.Builder - - read(DataType dataType) - -
- Adds the default data source to read for the given dataType to this request. - - - -
- -
- - - - - - DataReadRequest.Builder - - read(DataSource dataSource) - -
- Adds a specific data source we want to read data from to this request. - - - -
- -
- - - - - - DataReadRequest.Builder - - setLimit(int limit) - -
- Limits results to the latest limit data points. - - - -
- -
- - - - - - DataReadRequest.Builder - - setTimeRange(long start, long end, TimeUnit timeUnit) - -
- Sets the time range for our query. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataReadRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - DataReadRequest.Builder - - aggregate - (DataType inputDataType, DataType outputDataType) -

-
-
- - - -
-
- - - - -

Adds the default data source for the given aggregate dataType to this request - and sets the output aggregate data type to be returned. For a list of valid output - aggregate data types for a given input data type - see getAggregatesForInput(DataType). -

- The default data source is selected based on all available sources for the given data - type, and may be averaged or filtered. Aggregation should be requested in conjunction - with one of the bucketing strategy: by time, session or activity. At least one valid - detailed data source or aggregate data source should be specified in the request -

- This method can be used instead of aggregate(DataSource, DataType) - when the application is not interested in a specific data source. -

- The resulting aggregated data can be queried via - getBuckets() and getDataSet(DataType).

-
-
Parameters
- - - - - - - -
inputDataType - the input data type we're aggregating
outputDataType - the output data type that will be returned
-
-
-
Throws
- - - - - - - - - - -
IllegalStateException - if the data type is already requested as detailed
IllegalArgumentException - if the input data type is not supported for aggregation - or if the output data type is invalid
NullPointerException - if the data type is null -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - aggregate - (DataSource dataSource, DataType outputDataType) -

-
-
- - - -
-
- - - - -

Adds a specific data source we want aggregate data from for this request and also sets - the output aggregate data type that will be returned. For a list of valid output - aggregate data types for a given input data type - see getAggregatesForInput(DataType). -

- Aggregation should be requested in conjunction with one of the bucketing strategies: by - time, session or activity. At least one valid detailed data source or aggregate data - source should be specified in the request. -

- The resulting aggregated data can be queried via - getBuckets() and getDataSet(DataType).

-
-
Parameters
- - - - - - - -
dataSource - the data source we're reading for aggregate data
outputDataType - the output data type that will be returned in the result
-
-
-
Throws
- - - - - - - - - - -
IllegalStateException - if the data source is already requested as detailed
IllegalArgumentException - if the input data type is not supported for aggregation - or if the output aggregate data type is invalid
NullPointerException - if the data source is null -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketByActivitySegment - (int minDuration, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_ACTIVITY_SEGMENT, sets the minimum duration - of each TYPE_ACTIVITY_SEGMENT for the bucket. -

- An TYPE_ACTIVITY_SEGMENT represents a continuous time interval with a - single activity value. In this case, each Bucket will represent an individual - activity segment which lies inside the time interval of the request. For instance, - if the user had two separate activity segments for walking, one for 1km and another for - 2km, the result will be two buckets one with distance value of 1km and another with - distance value of 2km. -

- If no activity segments exist recorded for specific time intervals of the read query, - a Bucket corresponding to activity type - UNKNOWN will be used instead. - For instance, if there is an activity segment for biking from time [20, 30] seconds - and for running from time [40, 50] seconds, the result for a read query over [0, 60] - will have the following buckets: -

    -
  • Bucket 1 Time Interval: [0, 20] Activity: UNKNOWN -
  • Bucket 2 Time Interval: [20, 30] Activity: BIKING -
  • Bucket 3 Time Interval: [30, 40] Activity: UNKNOWN -
  • Bucket 4 Time Interval: [40, 50] Activity: RUNNING -
  • Bucket 5 Time Interval: [50, 60] Activity: UNKNOWN -
-

- Only activity segments of duration longer than minDuration are chosen for - bucketing. -

- By default, activity segments are chosen from the default data source. To use a - specific data source, use bucketByActivitySegment(int, TimeUnit, DataSource). -

- Detailed data of the aggregate type(s) specified in the request over time interval of - each bucket will be aggregated and returned. Each bucket will have one DataSet - of aggregated data for each requested aggregate DataType.

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid minDuration is specified -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketByActivitySegment - (int minDuration, TimeUnit timeUnit, DataSource activityDataSource) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_ACTIVITY_SEGMENT, sets the minimum duration - of each TYPE_ACTIVITY_SEGMENT for the bucket. -

- An TYPE_ACTIVITY_SEGMENT represents a continuous time interval with a - single activity value. In this case, each Bucket will represent an individual - activity segment which lies inside the time interval of the request. For instance, - if the user had two separate activity segments for walking, one for 1km and another for - 2km, the result will be two buckets one with distance value of 1km and another with - distance value of 2km. -

- If no activity segments exist recorded for specific time intervals of the read query, - a Bucket corresponding to activity type - UNKNOWN will be - added for each missing interval. For instance, if there is an activity segment - for biking from time [20, 30] seconds and for running from time [40, 50] seconds, - the result for a read query over [0, 60] will have the following buckets: -

    -
  • Bucket 1 Time Interval: [0, 20] Activity: UNKNOWN -
  • Bucket 2 Time Interval: [20, 30] Activity: BIKING -
  • Bucket 3 Time Interval: [30, 40] Activity: UNKNOWN -
  • Bucket 4 Time Interval: [40, 50] Activity: RUNNING -
  • Bucket 5 Time Interval: [50, 60] Activity: UNKNOWN -
-

- Only activity segments of duration longer than minDuration are chosen for - bucketing. -

- The activity segments are chosen from the specified activityDataSource. To use - the default activity data source, use bucketByActivitySegment(int, TimeUnit). -

- Detailed data of the aggregate type(s) specified in the request over time interval of - each bucket will be aggregated and returned. Each bucket will have one DataSet - of aggregated data for each requested aggregate DataType.

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid minDuration is specified -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketByActivityType - (int minDuration, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_ACTIVITY_TYPE, sets the minimum duration of - each TYPE_ACTIVITY_SEGMENT for computing the buckets. -

- In this case, each Bucket will represent an activity type, - and be comprised of aggregated data over all individual activity segments of this - activity which lie inside the time interval of the request. For instance, - if the user had two separate activity segments of walking during the time interval, - one for a distance of 1km and another for a distance of 2km, - the result will be one activity bucket with a single aggregate data point for distance - with a value of 3km. -

- If no activity segments are recorded for specific time intervals of the read query, - segments of type UNKNOWN - will be added for these intervals and used to compute an aggregate bucket of activity - type Unknown. -

- Only activity segments of duration longer than minDuration are chosen for - bucketing. -

- By default, activity segments are chosen from the default data source. To use a - specific data source, use bucketByActivitySegment(int, TimeUnit, DataSource). -

- Detailed data of the aggregate type(s) specified in the request over time interval of - each bucket will be aggregated and returned. Each bucket will have one DataSet - of aggregated data for each requested aggregate DataType.

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid minDuration is specified. -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketByActivityType - (int minDuration, TimeUnit timeUnit, DataSource activityDataSource) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_ACTIVITY_TYPE, sets the minimum duration of - each TYPE_ACTIVITY_SEGMENT for computing the buckets and sets the - activity data source to be used to read activity segments from. -

- In this case, each Bucket will represent an activity type, - and be comprised of aggregated data over all individual activity segments of this - activity which lie inside the time interval of the request. For instance, - if the user had two separate activity segments of walking during the time interval, - one for a distance of 1km and another for a distance of 2km, - the result will be one activity bucket with a single aggregate data point for distance - with a value of 3km. -

- If no activity segments are recorded for specific time intervals of the read query, - segments of type UNKNOWN - will be added for these intervals and used to compute an aggregate bucket of activity - type Unknown. -

- Only activity segments of duration longer than minDuration are chosen for - bucketing. -

- The activity segments are chosen from the specified activityDataSource. To use - the default activity segment data source - use bucketByActivityType(int, TimeUnit). -

- Detailed data of the aggregate type(s) specified in the request over time interval of - each bucket will be aggregated and returned. Each bucket will have one DataSet - of aggregated data for each requested aggregate DataType.

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid minDuration is specified or if an invalid - activity data source is specified. -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketBySession - (int minDuration, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_SESSION and sets the minimum duration of - each Session for the bucket. -

- A Session represents a time interval with associate meta data to store - user-visible groups of related data. In this case, each bucket will signify a session - which lies inside the time interval of the request. -

- Detailed data of the aggregate type(s) specified in the request over time interval of - each bucket will be aggregated and returned. Each bucket will have one DataSet - of aggregated data for each requested aggregate DataType..

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid minDuration is specified -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - bucketByTime - (int duration, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Specifies bucket type as TYPE_TIME and sets the duration of each bucket. -

- The detailed data from the Google Fit store across the time interval of the request is - divided into sub-intervals of length duration, and aggregation is then performed - over each sub-interval to return one Bucket of aggregated data per sub-interval. -

- Aggregation is performed for data type(s) specified in the request. Each bucket - will have one DataSet of aggregated data per requested aggregate DataType.

-
-
Throws
- - - - -
IllegalArgumentException - if another bucket type is already specified - in the request or if an invalid duration is specified. -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough state to - create a valid request -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - enableServerQueries - () -

-
-
- - - -
-
- - - - -

Enable querying the Google Fit server to fetch query results, - in case the local store doesn't have data for the full requested time range. - Server results will be combined with local results into one DataSet. -

- Note that querying the server adds latency, specially under poor network conditions. - Also note that attempting to query the server when there is no network connection may - result in a - transient error. - Server queries are off by default. -

- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - read - (DataType dataType) -

-
-
- - - -
-
- - - - -

Adds the default data source to read for the given dataType to this request. The - default data source is selected based on all available sources for the given data - type, and may be averaged or filtered. At least one valid detailed data source or - aggregate data source should be specified in the request. -

- This method can be used instead of read(DataSource) when the - application is not interested in a specific data source. -

- The resulting unaggregated data can be queried via - getDataSet(DataType).

-
-
Parameters
- - - - -
dataType - the data type we're reading
-
-
-
Throws
- - - - - - - -
IllegalStateException - if the data type is already requested as aggregate
NullPointerException - if the data type is null -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - read - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Adds a specific data source we want to read data from to this request. At least one - valid detailed data source or aggregate data source should be specified in the request. -

- The resulting unaggregated data can be queried via - getDataSet(DataSource).

-
-
Parameters
- - - - -
dataSource - the data source we're reading
-
-
-
Throws
- - - - - - - -
IllegalArgumentException - if the data source is already requested as aggregate
NullPointerException - if the data source is null -
-
- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - setLimit - (int limit) -

-
-
- - - -
-
- - - - -

Limits results to the latest limit data points. This parameter is ignored for - aggregated queries. By default there is no limit. -

- This method is useful to reduce the amount of sent data as well as to support scenarios - like requesting the current (limit == 1 to get the latest value) weight or height. -

- -
-
- - - - -
-

- - public - - - - - DataReadRequest.Builder - - setTimeRange - (long start, long end, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the time range for our query. Defined start and end times are required for every - read query.

-
-
Parameters
- - - - - - - - - - -
start - a start time, in the given unit since epoch, inclusive
end - an end time, in the given unit since epoch, inclusive
timeUnit - the unit of the start and end timestamps -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.html deleted file mode 100644 index a2fb2cf82ac5..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataReadRequest.html +++ /dev/null @@ -1,2434 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataReadRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataReadRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataReadRequest
- - - - - - - -
- - -

Class Overview

-

Request for reading data from Google Fit. Use this request to specify the data types to read, - as well as aggregation parameters. Read requests require a time range and allow reading - data in detailed or aggregated fashion. A single request can be used to read multiple data - types and data sources together. -

Detailed Data

- For requesting detailed data, the request should specify: -
    -
  • the time interval for the data -
  • at least one data source or data type -
- Example usage for reading location samples during an interval: - 
-     new DataReadRequest.Builder()
-         .setTimeRange(startTime.getMillis(), endTime.getMillis(). TimeUnit.MILLISECONDS)
-         .read(DataTypes.LOCATION_SAMPLE)
-         .build();
-
-

Aggregated Data

- For requesting aggregate data, the request should specify a valid - bucketing strategy. - Apps can request to bucket by time, - activity type, - activity segment, or session. - Apps should also specify at least one input data source or data type to aggregate. See - AGGREGATE_INPUT_TYPES - for a list of valid input data types supported for aggregation. -

- The aggregation request should specify: -

    -
  • time interval for the data -
  • at least one input data source or data type to aggregate and its corresponding output - aggregate data type -
  • bucketing strategy for aggregation -
-

- Example usage for selecting location bounding boxes for each hour: - 

-     new DataReadRequest.Builder()
-          .setTimeRange(startTime.getMillis(), endTime.getMillis(), TimeUnit.MILLISECONDS)
-          .bucketByTime(1, TimeUnit.HOURS)
-          .aggregate(DataTypes.LOCATION_SAMPLE, AggregateDataTypes.LOCATION_BOUNDING_BOX)
-          .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classDataReadRequest.Builder - Builder used to create new DataReadRequests.  - - - -
- - - - - - - - - - - -
Constants
intNO_LIMIT - Constant specifying no limit has been set. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataReadRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - DataSource - - getActivityDataSource() - -
- Returns the data source used to get activity segments for creating buckets for - data aggregation in this request. - - - -
- -
- - - - - - List<DataSource> - - getAggregatedDataSources() - -
- Returns all of the data sources that will be read then aggregated as part of this request. - - - -
- -
- - - - - - List<DataType> - - getAggregatedDataTypes() - -
- Returns all of the data types that will be read then aggregated as part of this request. - - - -
- -
- - - - - - long - - getBucketDuration(TimeUnit timeUnit) - -
- Returns the bucket duration for this request in the given time unit. - - - -
- -
- - - - - - int - - getBucketType() - -
- Returns the bucket type for data aggregation for this request. - - - -
- -
- - - - - - List<DataSource> - - getDataSources() - -
- Returns the data sources that should be read in this request. - - - -
- -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns the data types for which default data sources should be read in this request. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time for our query, in the specified time unit - - - - -
- -
- - - - - - int - - getLimit() - -
- Returns the max number of data points to return in the result. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time for our query, in the specified time unit - - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - NO_LIMIT -

-
- - - - -
-
- - - - -

Constant specifying no limit has been set.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataReadRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DataSource - - getActivityDataSource - () -

-
-
- - - -
-
- - - - -

Returns the data source used to get activity segments for creating buckets for - data aggregation in this request. -

- This data source is used when bucketing by - activity segment or - activity type.

-
-
Returns
-
  • the data source, or null if unset -
-
- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getAggregatedDataSources - () -

-
-
- - - -
-
- - - - -

Returns all of the data sources that will be read then aggregated as part of this request. - Each data source will be read then aggregated as specified in - aggregate(DataSource, DataType).

-
-
Returns
-
  • the input data sources for aggregation, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getAggregatedDataTypes - () -

-
-
- - - -
-
- - - - -

Returns all of the data types that will be read then aggregated as part of this request. - The default data source for each data type will be read, then aggregated as specified in - aggregate(DataType, DataType).

-
-
Returns
-
  • the input data types for aggregation, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - long - - getBucketDuration - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the bucket duration for this request in the given time unit. -

- -
-
- - - - -
-

- - public - - - - - int - - getBucketType - () -

-
-
- - - -
-
- - - - -

Returns the bucket type for data aggregation for this request. -

- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getDataSources - () -

-
-
- - - -
-
- - - - -

Returns the data sources that should be read in this request.

-
-
Returns
-
  • all specified data sources, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns the data types for which default data sources should be read in this request.

-
-
Returns
-
  • all specified data types, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time for our query, in the specified time unit -

- -
-
- - - - -
-

- - public - - - - - int - - getLimit - () -

-
-
- - - -
-
- - - - -

Returns the max number of data points to return in the result. If specified, - only the latest data points up to the given limit will be read.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time for our query, in the specified time unit -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.Builder.html deleted file mode 100644 index d9715f26720e..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.Builder.html +++ /dev/null @@ -1,1526 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSourcesRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

DataSourcesRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataSourcesRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new DataSourceRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataSourcesRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - DataSourcesRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - DataSourcesRequest.Builder - - setDataSourceTypes(int... dataSourceTypes) - -
- Sets the data source types that should be searched for in the data sources request. - - - -
- -
- - - - - - DataSourcesRequest.Builder - - setDataTypes(DataType... dataTypes) - -
- Sets the desired data types to search for on the data sources request. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataSourcesRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - DataSourcesRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough data to build - a valid request -
-
- -
-
- - - - -
-

- - public - - - - - DataSourcesRequest.Builder - - setDataSourceTypes - (int... dataSourceTypes) -

-
-
- - - -
-
- - - - -

Sets the data source types that should be searched for in the data sources request. By - default the data sources request will search for all source types. Use this method if - you'd like to restrict the search to only raw or only derived data sources. Calling this - method multiple times will override the previous calls.

-
-
Parameters
- - - - -
dataSourceTypes - a varargs array representing the types of data sources we're - searching for. Each can be specified as one of the type constants from - DataSource. -
-
- -
-
- - - - -
-

- - public - - - - - DataSourcesRequest.Builder - - setDataTypes - (DataType... dataTypes) -

-
-
- - - -
-
- - - - -

Sets the desired data types to search for on the data sources request. - At least one data type should be set, or build() will throw an exception.

-
-
Parameters
- - - - -
dataTypes - the data types to search for. These can be one of the data types - listed in DataType, or a custom data type. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.html deleted file mode 100644 index eeb9a52b65c4..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataSourcesRequest.html +++ /dev/null @@ -1,1695 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSourcesRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataSourcesRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataSourcesRequest
- - - - - - - -
- - -

Class Overview

-

Request for finding data sources in Google Fit. A request can be built using - the DataSourcesRequest.Builder. Use the parameters of the request to specify which data - sources should be returned. Example usage: - 

-     new DataSourcesRequest.Builder()
-         .setDataTypes(DataTypes.STEP_COUNT_CUMULATIVE, DataTypes.STEP_COUNT_DELTA)
-         .setDataSourceTypes(DataSource.Type.RAW)
-         .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classDataSourcesRequest.Builder - Builder used to create new DataSourceRequests.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataSourcesRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns all of the data types requested. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataSourcesRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns all of the data types requested.

-
-
Returns
-
  • the requested data types, non-empty -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.Builder.html deleted file mode 100644 index 24f210979ade..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.Builder.html +++ /dev/null @@ -1,1559 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataTypeCreateRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

DataTypeCreateRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataTypeCreateRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new DataTypeInsertRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataTypeCreateRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - DataTypeCreateRequest.Builder - - addField(Field field) - -
- Adds the specified field to the new data type. - - - -
- -
- - - - - - DataTypeCreateRequest.Builder - - addField(String name, int format) - -
- Adds a new field with the specified name and format to the new data type. - - - -
- -
- - - - - - DataTypeCreateRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - DataTypeCreateRequest.Builder - - setName(String name) - -
- Set the name for the new data type. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataTypeCreateRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - DataTypeCreateRequest.Builder - - addField - (Field field) -

-
-
- - - -
-
- - - - -

Adds the specified field to the new data type. -

- -
-
- - - - -
-

- - public - - - - - DataTypeCreateRequest.Builder - - addField - (String name, int format) -

-
-
- - - -
-
- - - - -

Adds a new field with the specified name and format to the new data type. -

- -
-
- - - - -
-

- - public - - - - - DataTypeCreateRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if name or data fields are not specified. -
-
- -
-
- - - - -
-

- - public - - - - - DataTypeCreateRequest.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

Set the name for the new data type. For private data types the name must have a format - packageName + "." + typeName, where packageName is the application - package name and typeName is a unique identifier of the DataType withing - package. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html deleted file mode 100644 index 6719eb80f3ae..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html +++ /dev/null @@ -1,1854 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataTypeCreateRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataTypeCreateRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.DataTypeCreateRequest
- - - - - - - -
- - -

Class Overview

-

A request for inserting an application-specific data type into the Google Fit store. Apps can - use this request to define their own custom data types for reading and writing custom data. -

- The new data type should not duplicate any existing public data type. Apps can obtain the new - data type from the result of this request, and use it to insert/read data. Data written in - this data type will only be visible to the app that created this data type. -

- The new data type name should have the app's package name as the prefix. For instance, - if the app's package name is "com.exampleapp", then a new data type named "com.exampleapp - .custom_data" is permitted. However, a new data type named "com.anotherapp.custom_data" is not - permitted. -

- Sample usage: - 

-     DataTypeCreateRequest request = new DataTypeCreateRequest.Builder()
-          .setName("com.app.custom_data")
-          .addField("field1", Field.FORMAT_INT32)
-          .addField(DataTypes.Fields.ACTIVITY)
-          .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classDataTypeCreateRequest.Builder - Builder used to create new DataTypeInsertRequests.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataTypeCreateRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<Field> - - getFields() - -
- Returns the specified fields for the created data type. - - - -
- -
- - - - - - String - - getName() - -
- Returns the specified name for the crated data type. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataTypeCreateRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<Field> - - getFields - () -

-
-
- - - -
-
- - - - -

Returns the specified fields for the created data type. -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the specified name for the crated data type. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/OnDataPointListener.html b/docs/html/reference/com/google/android/gms/fitness/request/OnDataPointListener.html deleted file mode 100644 index d73e5cd6dbac..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/OnDataPointListener.html +++ /dev/null @@ -1,1082 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnDataPointListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnDataPointListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.request.OnDataPointListener
- - - - - - - -
- - -

Class Overview

-

Listener used to register to live data updates from a DataSource. - Used by clients wanting to subscribe to live data stream updates via SensorsApi. - Each event is delivered as a DataPoint. -

- The listener is used both when - adding - a registration and when - removing it. The same - listener can be used for multiple registrations. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDataPoint(DataPoint dataPoint) - -
- Handle a new data point from the data source. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDataPoint - (DataPoint dataPoint) -

-
-
- - - -
-
- - - - -

Handle a new data point from the data source. The data point's - data type describes the format and meaning of its values. -

- Note: The application doesn't own the data point object passed as a parameter - after this method returns and therefore should not hold on to it, since the DataPoint - can be reused by the platform.

-
-
Parameters
- - - - -
dataPoint - the data point for this event -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.Builder.html deleted file mode 100644 index f83d383d9d82..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.Builder.html +++ /dev/null @@ -1,1914 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SensorRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SensorRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SensorRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new SensorRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SensorRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SensorRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - SensorRequest.Builder - - setAccuracyMode(int accuracyMode) - -
- Sets the accuracy policy (mode) expected by the application. - - - -
- -
- - - - - - SensorRequest.Builder - - setDataSource(DataSource dataSource) - -
- Sets the specific data source for this registration. - - - -
- -
- - - - - - SensorRequest.Builder - - setDataType(DataType dataType) - -
- Sets the data type for the request. - - - -
- -
- - - - - - SensorRequest.Builder - - setFastestRate(int fastestInterval, TimeUnit unit) - -
- Sets the fastest interval between two consecutive data points, in the given unit. - - - -
- -
- - - - - - SensorRequest.Builder - - setMaxDeliveryLatency(int interval, TimeUnit unit) - -
- Sets the maximum latency between a data point being detected and reported to the - application. - - - -
- -
- - - - - - SensorRequest.Builder - - setSamplingRate(long interval, TimeUnit unit) - -
- Sets the desired interval between two consecutive data points, in the given unit. - - - -
- -
- - - - - - SensorRequest.Builder - - setTimeout(long timeout, TimeUnit timeUnit) - -
- Sets the timeout for the registration for the sensor request to expire. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SensorRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SensorRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough data to build - a valid request -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setAccuracyMode - (int accuracyMode) -

-
-
- - - -
-
- - - - -

Sets the accuracy policy (mode) expected by the application. The Accuracy mode is passed - along to the underlying data source. Setting this value has a direct impact in battery - usage: i.e. a high accuracy can improve the quality of the data collected at the - expense of higher battery consumption. -

- The accuracy mode is a hint to the system. If no accuracy is specified, or if the - underlying data source does not support it, a balanced policy is used. -

- Example usage: - 

-     builder.setAccuracyMode(SensorRequest.ACCURACY_MODE_LOW) // lowest impact in battery
-

-
-
Parameters
- - - - -
accuracyMode - the accuracy mode to be passed to the data sources -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setDataSource - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Sets the specific data source for this registration. Either this method or - setDataType(DataType) must be called to specify the data source for each - request.

-
-
Parameters
- - - - -
dataSource - the data source from which we want to receive live events -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setDataType - (DataType dataType) -

-
-
- - - -
-
- - - - -

Sets the data type for the request. This can be used instead of - setDataSource(DataSource) to use a default data source for the request, based - on the data type and the available data sources. -

- It's not necessary to set the data type if the data source is also set.

-
-
Parameters
- - - - -
dataType - the data type for which we want to receive live events -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setFastestRate - (int fastestInterval, TimeUnit unit) -

-
-
- - - -
-
- - - - -

Sets the fastest interval between two consecutive data points, in the given unit. - The system will not deliver data points faster than this rate, even if they're - passively available from other applications. Example: - 

-     builder.setFastestRate(5, TimeUnit.SECONDS)
-
- If the fastest rate is unspecified, a default rate will be used. The default rate is - data type specific.

-
-
Parameters
- - - - - - - -
fastestInterval - the fastest interval between data points, in the given unit
unit - unit for the interval. Intervals can be specified in up to microsecond - granularity. -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setMaxDeliveryLatency - (int interval, TimeUnit unit) -

-
-
- - - -
-
- - - - -

Sets the maximum latency between a data point being detected and reported to the - application. The max delivery latency is passed along to the underlying data source and - used to enable batching. Batching can save battery by reducing the number of times the - Application Processor is awaken, and the number of network transfers for external data - sources. -

- The max latency is a hint to the system, and events can be received faster or slower - than the specified interval. If no interval is specified, or if the underlying data - source does not support batching, events are reported as soon as they are detected. -

- Example usage: - 

-     builder.setMaxDeliveryLatency(1, TimeUnit.MINUTES) // delivery at least once a minute
-

-
-
Parameters
- - - - - - - -
interval - the maximum interval between detection and reporting of events
unit - unit for the given interval. Intervals can be specified in up to microsecond - granularity. -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setSamplingRate - (long interval, TimeUnit unit) -

-
-
- - - -
-
- - - - -

Sets the desired interval between two consecutive data points, in the given unit. This - is only a hint to the system. Events may be received faster or slower than the specified - rate (usually faster). Example: - 

-     builder.setSamplingRate(10, TimeUnit.SECONDS) // sample every 10 seconds
-
- If the sampling rate is unspecified, a default rate will be used. The default rate is - data type specific.

-
-
Parameters
- - - - - - - -
interval - the desired interval between data points, in the given unit
unit - unit for the interval. Intervals can be specified in up to microsecond - granularity. -
-
- -
-
- - - - -
-

- - public - - - - - SensorRequest.Builder - - setTimeout - (long timeout, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the timeout for the registration for the sensor request to expire. Registration - for this sensor request will automatically expire after this time and app - will stop getting live sensor updates. -

- This timeout is intended to avoid situations where an app fails to unregister from a - sensor request. If apps do not set a timeout value, a default timeout will be chosen - for the sensor registration request to expire.

-
-
Parameters
- - - - - - - -
timeout - the timeout duration after which the registration expires
timeUnit - unit for the timeout -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.html deleted file mode 100644 index 9aed66d0a8e5..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SensorRequest.html +++ /dev/null @@ -1,2045 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SensorRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SensorRequest

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SensorRequest
- - - - - - - -
- - -

Class Overview

-

Request for registering for live updates from a data source. Use this - request to specify the data source or data type to register to, the sampling rate, - the fastest reporting interval, and the maximum desired delivery latency. Example usage: - 

-     new SensorRequest.Builder()
-         .setDataType(DataType.TYPE_HEART_RATE_BPM)
-         .setSamplingRate(10, TimeUnit.SECONDS)  // sample every 10s
-         .build();
-
- An app can register to either public data sources/types or custom data sources/types created by - itself. Registration to custom data source/type created by another app is not permitted. -

- Registration will automatically expire after a timeout. Apps can change the default - timeout by using setTimeout(long, TimeUnit) -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSensorRequest.Builder - Builder used to create new SensorRequests.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intACCURACY_MODE_DEFAULT - The default Accuracy Mode that offers a balance between accuracy of data collection and - battery usage. - - - -
intACCURACY_MODE_HIGH - An Accuracy Mode representation that indicates that the application requires high accuracy - data and expects the extra battery usage. - - - -
intACCURACY_MODE_LOW - An Accuracy Mode representation that indicates that the application requires low accuracy - data, improving battery life. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object that) - -
- - - - static - - SensorRequest - - fromLocationRequest(DataSource dataSource, LocationRequest locationRequest) - -
- Returns a SensorRequest for location updates corresponding to the given LocationRequest. - - - -
- -
- - - - - - int - - getAccuracyMode() - -
- Returns the accuracy mode for this request. - - - -
- -
- - - - - - DataSource - - getDataSource() - -
- Returns the specified data source for this request. - - - -
- -
- - - - - - DataType - - getDataType() - -
- Returns the specified data type for this request. - - - -
- -
- - - - - - long - - getFastestRate(TimeUnit timeUnit) - -
- Returns the fastest rate for this request, in the given time unit. - - - -
- -
- - - - - - long - - getMaxDeliveryLatency(TimeUnit timeUnit) - -
- Returns the max delivery latency for this request, in the given time unit. - - - -
- -
- - - - - - long - - getSamplingRate(TimeUnit timeUnit) - -
- Returns the sampling rate for this request, in the given time unit. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ACCURACY_MODE_DEFAULT -

-
- - - - -
-
- - - - -

The default Accuracy Mode that offers a balance between accuracy of data collection and - battery usage. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ACCURACY_MODE_HIGH -

-
- - - - -
-
- - - - -

An Accuracy Mode representation that indicates that the application requires high accuracy - data and expects the extra battery usage. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ACCURACY_MODE_LOW -

-
- - - - -
-
- - - - -

An Accuracy Mode representation that indicates that the application requires low accuracy - data, improving battery life. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - SensorRequest - - fromLocationRequest - (DataSource dataSource, LocationRequest locationRequest) -

-
-
- - - -
-
- - - - -

Returns a SensorRequest for location updates corresponding to the given LocationRequest.

-
-
Parameters
- - - - - - - -
dataSource - The DataSource that will provide location.
locationRequest - Request defining parameters for location updates. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getAccuracyMode - () -

-
-
- - - -
-
- - - - -

Returns the accuracy mode for this request. -

- -
-
- - - - -
-

- - public - - - - - DataSource - - getDataSource - () -

-
-
- - - -
-
- - - - -

Returns the specified data source for this request.

-
-
Returns
-
  • the specified data source, or null if only a data type was specified -
-
- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the specified data type for this request.

-
-
Returns
-
  • the specified data type, or null if only a data source was specified -
-
- -
-
- - - - -
-

- - public - - - - - long - - getFastestRate - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the fastest rate for this request, in the given time unit. -

- -
-
- - - - -
-

- - public - - - - - long - - getMaxDeliveryLatency - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the max delivery latency for this request, in the given time unit. -

- -
-
- - - - -
-

- - public - - - - - long - - getSamplingRate - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the sampling rate for this request, in the given time unit.

-
-
Returns
-
  • the sampling rate, negative if unspecified -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.Builder.html deleted file mode 100644 index 61306845ed63..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.Builder.html +++ /dev/null @@ -1,1587 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionInsertRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SessionInsertRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SessionInsertRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new SessionInsertRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SessionInsertRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SessionInsertRequest.Builder - - addAggregateDataPoint(DataPoint aggregateDataPoint) - -
- Adds the specified aggregate data point for this request. - - - -
- -
- - - - - - SessionInsertRequest.Builder - - addDataSet(DataSet dataSet) - -
- Adds the specified data set for this request. - - - -
- -
- - - - - - SessionInsertRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - SessionInsertRequest.Builder - - setSession(Session session) - -
- Sets the session for this request. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SessionInsertRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SessionInsertRequest.Builder - - addAggregateDataPoint - (DataPoint aggregateDataPoint) -

-
-
- - - -
-
- - - - -

Adds the specified aggregate data point for this request. Only one aggregate data point - per data source is allowed for a session.

-
-
Throws
- - - - - - - -
IllegalArgumentException - if the data point is null
IllegalStateException - if an aggregate data point for this data source - is already added -
-
- -
-
- - - - -
-

- - public - - - - - SessionInsertRequest.Builder - - addDataSet - (DataSet dataSet) -

-
-
- - - -
-
- - - - -

Adds the specified data set for this request. Only one data set per data source is - allowed for a session.

-
-
Throws
- - - - - - - -
IllegalArgumentException - if the data set is null or empty
IllegalStateException - if data set for this data source is already - added -
-
- -
-
- - - - -
-

- - public - - - - - SessionInsertRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough state to - create a valid request -
-
- -
-
- - - - -
-

- - public - - - - - SessionInsertRequest.Builder - - setSession - (Session session) -

-
-
- - - -
-
- - - - -

Sets the session for this request. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html deleted file mode 100644 index a9899f3c270f..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SessionInsertRequest.html +++ /dev/null @@ -1,1928 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionInsertRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SessionInsertRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SessionInsertRequest
- - - - - - - -
- - -

Class Overview

-

A request for inserting a Session and associated DataSet and/or aggregated - DataPoint into the Google Fit store. Useful when data is read from a data source outside - of Google Fit, or when inserting batch historical data. -

- The request cannot have a continuing session, i.e. session should have valid start and end times. - Request may contain multiple data sets and multiple aggregated data points. -

- The Builder will enforce that each data set or aggregated data point represents a unique - DataSource. The Builder will also enforce that timestamps of the data specified are - consistent with session start and end times. For all data points specified in the data set(s), - the timestamps should fall between the session start and end times. And for all aggregate data - points, the start and end time timestamps should fall between the session start and end times. -

- Example usage: - 

-     Session session = new Session.Builder()
-          .setName(sessionName)
-          .setIdentifier(identifier)
-          .setDescription(description)
-          .setStartTime(startTime.getMillis(), TimeUnit.MILLISECONDS)
-          .setEndTime(endTime.getMillis(), TimeUnit.MILLISECONDS)
-          .build();
-     SessionInsertRequest request = new SessionInsertRequest.Builder()
-          .setSession(session)
-          .addDataSet(dataSet)
-          .addAggregatedDataPoint(dataPoint)
-          .build();
-
- Apps can only add data for public data types or custom data types created by itself. Data - of custom data type created by another app cannot be added. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSessionInsertRequest.Builder - Builder used to create new SessionInsertRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<SessionInsertRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<DataPoint> - - getAggregateDataPoints() - -
- Returns the aggregate data points we are inserting. - - - -
- -
- - - - - - List<DataSet> - - getDataSets() - -
- Returns the data sets we are inserting. - - - -
- -
- - - - - - Session - - getSession() - -
- Returns the session we are inserting. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<SessionInsertRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataPoint> - - getAggregateDataPoints - () -

-
-
- - - -
-
- - - - -

Returns the aggregate data points we are inserting.

-
-
Returns
-
  • the list of specified data points, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - List<DataSet> - - getDataSets - () -

-
-
- - - -
-
- - - - -

Returns the data sets we are inserting.

-
-
Returns
-
  • the list of specified data sets, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - Session - - getSession - () -

-
-
- - - -
-
- - - - -

Returns the session we are inserting. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.Builder.html deleted file mode 100644 index a8fe9660d613..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.Builder.html +++ /dev/null @@ -1,1948 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionReadRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SessionReadRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SessionReadRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create a new SessionReadRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SessionReadRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SessionReadRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - SessionReadRequest.Builder - - enableServerQueries() - -
- Enable querying the Google Fit server to fetch query results, - in case the local store doesn't have data for the full requested time range. - - - -
- -
- - - - - - SessionReadRequest.Builder - - excludePackage(String appPackageName) - -
- Exclude sessions from a particular package name from the read result. - - - -
- -
- - - - - - SessionReadRequest.Builder - - read(DataType dataType) - -
- Reads data from the default data source of the given dataType for each - session selected by this request. - - - -
- -
- - - - - - SessionReadRequest.Builder - - read(DataSource dataSource) - -
- Reads data from a given dataSource for each session selected by this request. - - - -
- -
- - - - - - SessionReadRequest.Builder - - readSessionsFromAllApps() - -
- Enables reading sessions inserted by any app. - - - -
- -
- - - - - - SessionReadRequest.Builder - - setSessionId(String sessionId) - -
- Adds an optional session identifier to this request. - - - -
- -
- - - - - - SessionReadRequest.Builder - - setSessionName(String sessionName) - -
- Adds an optional session name to this request. - - - -
- -
- - - - - - SessionReadRequest.Builder - - setTimeInterval(long startTime, long endTime, TimeUnit timeUnit) - -
- Sets the time range for the sessions we want to select in our query, - in a specific TimeUnit. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SessionReadRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SessionReadRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - - - - -
IllegalArgumentException - if the builder doesn't have valid time - interval data to create a read request
IllegalStateException - if the builder doesn't have valid data type or - data source to create a read request -
-
- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - enableServerQueries - () -

-
-
- - - -
-
- - - - -

Enable querying the Google Fit server to fetch query results, - in case the local store doesn't have data for the full requested time range. - Server results will be combined with local results. -

- Note that querying the server adds latency, specially under poor network conditions. - Also note that attempting to query the server when there is no network connection may - result in a - transient error. - Server queries are off by default. -

- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - excludePackage - (String appPackageName) -

-
-
- - - -
-
- - - - -

Exclude sessions from a particular package name from the read result. This method - can be used in combination with readSessionsFromAllApps() to exclude sessions - from apps that are not of interest (for instance, sessions you have written yourself). -

- The method can be called multiple times to exclude more than one package from the - request. -

- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - read - (DataType dataType) -

-
-
- - - -
-
- - - - -

Reads data from the default data source of the given dataType for each - session selected by this request. The default data source may be aggregated or merged. - The read data will be returned as a separate - DataSet for each returned session. -

- The data returned from the data type does not need to be inserted together with - the session. The only requirement is that its timestamp fall within the session - interval. -

- This method can be called multiple times to read multiple data types in the request.

-
-
Parameters
- - - - -
dataType - the data type we are reading -
-
- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - read - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Reads data from a given dataSource for each session selected by this request. - The read data will be returned as a separate - DataSet for each returned session. -

- The data returned from this data source does not need to be inserted together with - the session. The only requirement is that its timestamp fall within the session - interval. -

- This method can be called multiple times to read multiple data sources in the request.

-
-
Parameters
- - - - -
dataSource - the data source we're reading -
-
- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - readSessionsFromAllApps - () -

-
-
- - - -
-
- - - - -

Enables reading sessions inserted by any app. If not set, only sessions added by the - calling app will be returned. -

- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - setSessionId - (String sessionId) -

-
-
- - - -
-
- - - - -

Adds an optional session identifier to this request. If specified, - only the session with the exact identifier is selected. -

- Only one session identifier can be specified per request. Calling this method - multiple times will override the previous call.

-
-
Parameters
- - - - -
sessionId - the ID of the session we want data for -
-
- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - setSessionName - (String sessionName) -

-
-
- - - -
-
- - - - -

Adds an optional session name to this request. If specified, - only sessions with the exact name are selected. -

- Only one session name can be specified per request. Calling this method multiple times - will override the previous call.

-
-
Parameters
- - - - -
sessionName - the name of the session we want data for -
-
- -
-
- - - - -
-

- - public - - - - - SessionReadRequest.Builder - - setTimeInterval - (long startTime, long endTime, TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the time range for the sessions we want to select in our query, - in a specific TimeUnit. -

- Defined start and end times are required for every read query. All sessions that fall - in the specified time interval are returned. Session - name and - identifier can be used to further restrict the - returned sessions. -

For a session to be returned, it has to fall completely within the interval - specified in the query. Overlapping sessions with start and/or end times outside the - interval will not be returned. Ongoing sessions (with no end time specified yet) - whose start time falls within the interval are returned.

-
-
Parameters
- - - - - - - - - - -
startTime - a start time since epoch, inclusive
endTime - an end time since epoch, inclusive
timeUnit - time unit for the start and end times -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.html deleted file mode 100644 index 13d55306a58e..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/SessionReadRequest.html +++ /dev/null @@ -1,2214 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionReadRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SessionReadRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.SessionReadRequest
- - - - - - - -
- - -

Class Overview

-

Request for reading Session data from Google Fit. - Use this request to specify the sessions to read, as well as - data sets - that should be read for each session. -

- Example usage for reading all sessions during a time interval, as well as location data points - for each session: - 

-     new SessionReadRequest.Builder()
-         .setTimeInterval(startTime.getMillis(), endTime.getMillis(), TimeUnit.MILLISECONDS)
-         .read(DataTypes.LOCATION_SAMPLE)
-         .build();
-
-

- A valid time interval is mandatory for the request. Session name and identifier are optional - fields that can be used to further filter out the returned result. -

- By default, only sessions created by the calling app will be returned. To get sessions created - by other apps, use readSessionsFromAllApps()} -

- An app can only read public data types or custom data created by itself. Custom data types - created by another app cannot be read. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSessionReadRequest.Builder - Builder used to create a new SessionReadRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<SessionReadRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<DataSource> - - getDataSources() - -
- Returns the data sources to be read in this request. - - - -
- -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns the data types for which default data sources should be read in this request. - - - -
- -
- - - - - - long - - getEndTime(TimeUnit timeUnit) - -
- Returns the end time for our query, in the given time unit - - - - -
- -
- - - - - - List<String> - - getExcludedPackages() - -
- Returns any app package names that were excluded from the request. - - - -
- -
- - - - - - String - - getSessionId() - -
- Returns the session id we are requesting data for. - - - -
- -
- - - - - - String - - getSessionName() - -
- Returns the session name we are requesting data for. - - - -
- -
- - - - - - long - - getStartTime(TimeUnit timeUnit) - -
- Returns the start time for our query, in the given time unit - - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - includeSessionsFromAllApps() - -
- Returns true if the read data should include sessions from other apps. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<SessionReadRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getDataSources - () -

-
-
- - - -
-
- - - - -

Returns the data sources to be read in this request.

-
-
Returns
-
  • the specified data sources, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns the data types for which default data sources should be read in this request.

-
-
Returns
-
  • the specified data types, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - long - - getEndTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the end time for our query, in the given time unit -

- -
-
- - - - -
-

- - public - - - - - List<String> - - getExcludedPackages - () -

-
-
- - - -
-
- - - - -

Returns any app package names that were excluded from the request.

-
-
Returns
-
  • the list of excluded packages, empty if none -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSessionId - () -

-
-
- - - -
-
- - - - -

Returns the session id we are requesting data for.

-
-
Returns
-
  • the specified session identifier, or null if unspecified -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSessionName - () -

-
-
- - - -
-
- - - - -

Returns the session name we are requesting data for.

-
-
Returns
-
  • the specified session name, or null if unspecified -
-
- -
-
- - - - -
-

- - public - - - - - long - - getStartTime - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the start time for our query, in the given time unit -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - includeSessionsFromAllApps - () -

-
-
- - - -
-
- - - - -

Returns true if the read data should include sessions from other apps. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder.html b/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder.html deleted file mode 100644 index aa0571c05536..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder.html +++ /dev/null @@ -1,1591 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StartBleScanRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

StartBleScanRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.StartBleScanRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder used to create new DataSourceRequests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StartBleScanRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - StartBleScanRequest - - build() - -
- Finishes building and returns the request. - - - -
- -
- - - - - - StartBleScanRequest.Builder - - setBleScanCallback(BleScanCallback bleScanCallback) - -
- Sets the callback to be used when devices are found. - - - -
- -
- - - - - - StartBleScanRequest.Builder - - setDataTypes(DataType... dataTypes) - -
- Sets the desired data types to search for on the BLE scan. - - - -
- -
- - - - - - StartBleScanRequest.Builder - - setTimeoutSecs(int stopTimeSecs) - -
- Sets how long to wait before automatically stopping the scan, - in seconds. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StartBleScanRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - StartBleScanRequest - - build - () -

-
-
- - - -
-
- - - - -

Finishes building and returns the request.

-
-
Throws
- - - - -
IllegalStateException - if the builder doesn't have enough data to build - a valid request -
-
- -
-
- - - - -
-

- - public - - - - - StartBleScanRequest.Builder - - setBleScanCallback - (BleScanCallback bleScanCallback) -

-
-
- - - -
-
- - - - -

Sets the callback to be used when devices are found. - The callback must be set or build() will throw an exception.

-
-
Parameters
- - - - -
bleScanCallback - the callback to be called. -
-
- -
-
- - - - -
-

- - public - - - - - StartBleScanRequest.Builder - - setDataTypes - (DataType... dataTypes) -

-
-
- - - -
-
- - - - -

Sets the desired data types to search for on the BLE scan. We'll only return devices - which match this data type. If no data types are set, the request will return all - compatible devices.

-
-
Parameters
- - - - -
dataTypes - the data types to search for. These can be one of the data types - listed in DataType, or a custom data type. -
-
- -
-
- - - - -
-

- - public - - - - - StartBleScanRequest.Builder - - setTimeoutSecs - (int stopTimeSecs) -

-
-
- - - -
-
- - - - -

Sets how long to wait before automatically stopping the scan, - in seconds. If this method isn't called scans will stop after 10 seconds by default.

-
-
Parameters
- - - - -
stopTimeSecs - duration of the scan before stopping. Must be a value between 1 - and 60 seconds. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.html b/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.html deleted file mode 100644 index 7cf8c319b693..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/StartBleScanRequest.html +++ /dev/null @@ -1,1751 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StartBleScanRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StartBleScanRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.request.StartBleScanRequest
- - - - - - - -
- - -

Class Overview

-

Request for finding BLE devices around the user. A request can be built - using the StartBleScanRequest.Builder. Use the parameters of the request to specify - which data sources should be returned. Example usage: - 

-     new StartBleScanRequest.Builder()
-         .setDataTypes(DataTypes.HEART_RATE_BPM)
-         .setBleScanCallback(callback)
-         .build();
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classStartBleScanRequest.Builder - Builder used to create new DataSourceRequests.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<StartBleScanRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - List<DataType> - - getDataTypes() - -
- Returns the list of data types that constrain the list of scanned devices. - - - -
- -
- - - - - - int - - getTimeoutSecs() - -
- Returns the timeout for the scan, in seconds. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<StartBleScanRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataType> - - getDataTypes - () -

-
-
- - - -
-
- - - - -

Returns the list of data types that constrain the list of scanned devices.

-
-
Returns
-
  • the list of data types, empty if we're scanning all devices -
-
- -
-
- - - - -
-

- - public - - - - - int - - getTimeoutSecs - () -

-
-
- - - -
-
- - - - -

Returns the timeout for the scan, in seconds. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/request/package-summary.html b/docs/html/reference/com/google/android/gms/fitness/request/package-summary.html deleted file mode 100644 index 3274e2121dfb..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/request/package-summary.html +++ /dev/null @@ -1,1089 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.fitness.request | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.fitness.request

-
- -
- -
- - -
- Contains request objects used in Google Fit API methods. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
OnDataPointListener - Listener used to register to live data updates from a DataSource.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BleScanCallback - Callback for BLE Scans.  - - - -
DataDeleteRequest - A request to delete data and sessions added by the app from the Google Fit store in the time - interval specified.  - - - -
DataDeleteRequest.Builder - Builder used to create new DataDeleteRequests.  - - - -
DataReadRequest - Request for reading data from Google Fit.  - - - -
DataReadRequest.Builder - Builder used to create new DataReadRequests.  - - - -
DataSourcesRequest - Request for finding data sources in Google Fit.  - - - -
DataSourcesRequest.Builder - Builder used to create new DataSourceRequests.  - - - -
DataTypeCreateRequest - A request for inserting an application-specific data type into the Google Fit store.  - - - -
DataTypeCreateRequest.Builder - Builder used to create new DataTypeInsertRequests.  - - - -
SensorRequest - Request for registering for live updates from a data source.  - - - -
SensorRequest.Builder - Builder used to create new SensorRequests.  - - - -
SessionInsertRequest - A request for inserting a Session and associated DataSet and/or aggregated - DataPoint into the Google Fit store.  - - - -
SessionInsertRequest.Builder - Builder used to create new SessionInsertRequest.  - - - -
SessionReadRequest - Request for reading Session data from Google Fit.  - - - -
SessionReadRequest.Builder - Builder used to create a new SessionReadRequest.  - - - -
StartBleScanRequest - Request for finding BLE devices around the user.  - - - -
StartBleScanRequest.Builder - Builder used to create new DataSourceRequests.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/BleDevicesResult.html b/docs/html/reference/com/google/android/gms/fitness/result/BleDevicesResult.html deleted file mode 100644 index d45a942f9b33..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/BleDevicesResult.html +++ /dev/null @@ -1,1945 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BleDevicesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

BleDevicesResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.BleDevicesResult
- - - - - - - -
- - -

Class Overview

-

Result of listClaimedBleDevices(GoogleApiClient). Contains all user associated - claimed BLE devices which matched the request. The method getClaimedBleDevices() can be - used to fetch the resulting claimed BLE devices returned from the Google Fit store. -

- The calling app should check getStatus() to confirm that the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<BleDevicesResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - List<BleDevice> - - getClaimedBleDevices(DataType dataType) - -
- Returns all found claimed BLE devices for the given dataType - - - -
- -
- - - - - - List<BleDevice> - - getClaimedBleDevices() - -
- Returns all of the found claimed BLE devices. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<BleDevicesResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<BleDevice> - - getClaimedBleDevices - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns all found claimed BLE devices for the given dataType

-
-
Returns
-
  • the list of retrieved claimed BLE devices, empty if none were found. -
-
- -
-
- - - - -
-

- - public - - - - - List<BleDevice> - - getClaimedBleDevices - () -

-
-
- - - -
-
- - - - -

Returns all of the found claimed BLE devices.

-
-
Returns
-
  • the list of retrieved BLE devices, empty if none were found. -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/DailyTotalResult.html b/docs/html/reference/com/google/android/gms/fitness/result/DailyTotalResult.html deleted file mode 100644 index fc400f35c1ec..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/DailyTotalResult.html +++ /dev/null @@ -1,1716 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DailyTotalResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DailyTotalResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.DailyTotalResult
- - - - - - - -
- - -

Class Overview

-

Result of readDailyTotal(GoogleApiClient, DataType). Use getTotal() - to access the data point containing the daily total for the requested data type. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object that) - -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - DataSet - - getTotal() - -
- Returns the resulting data set containing the daily total for the requested data type. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - DataSet - - getTotal - () -

-
-
- - - -
-
- - - - -

Returns the resulting data set containing the daily total for the requested data type.

-
-
Returns
-
  • the resulting data set, empty if there was no data for the data type, - and null if the request failed. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/DataReadResult.html b/docs/html/reference/com/google/android/gms/fitness/result/DataReadResult.html deleted file mode 100644 index 7f05e0f06586..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/DataReadResult.html +++ /dev/null @@ -1,2115 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataReadResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataReadResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.DataReadResult
- - - - - - - -
- - -

Class Overview

-

Result of readData(GoogleApiClient, DataReadRequest). -

- Contains exactly one data set for each detailed data source requested in the - DataReadRequest. -

- The methods getDataSet(DataType) and getDataSet(DataSource) can be used to - fetch the resulting detailed data for a specific data source. -

- If aggregate data was requested, then the result will return buckets created as per the - bucketing strategy specified in the request. Each bucket will have one data set per aggregate - data requested. -

- The method getBuckets() can be used to retrieve the buckets. -

- The method getStatus() can be be used to confirm if the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- In case the app attempts to read custom data created by another app, - the returned status has status code set to INCONSISTENT_DATA_TYPE. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataReadResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - List<Bucket> - - getBuckets() - -
- Returns all of the Buckets with aggregated data. - - - -
- -
- - - - - - DataSet - - getDataSet(DataSource dataSource) - -
- Returns the resulting data set for the given dataSource. - - - -
- -
- - - - - - DataSet - - getDataSet(DataType dataType) - -
- Returns the resulting data set for the given dataType. - - - -
- -
- - - - - - List<DataSet> - - getDataSets() - -
- Returns all of the data sets in the result. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataReadResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<Bucket> - - getBuckets - () -

-
-
- - - -
-
- - - - -

Returns all of the Buckets with aggregated data. In each bucket, - there will be exactly one data set for each aggregated data source requested in the - DataReadRequest. -

- Buckets only contain aggregated data requested via - aggregate(DataSource, DataType). Non-aggregated data can - be accessed via getDataSet(DataType).

-
-
Returns
-
  • an empty list if the read request failed. -
-
- -
-
- - - - -
-

- - public - - - - - DataSet - - getDataSet - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Returns the resulting data set for the given dataSource. -

- This method returns only non-aggregated data sets that were queried via - read(DataSource). Aggregated data can be queried via - getBuckets().

-
-
Returns
-
  • a data set for the given data source, empty if no data was found.
-
-
-
Throws
- - - - -
IllegalArgumentException - if the given data source was not part of the read request -
-
- -
-
- - - - -
-

- - public - - - - - DataSet - - getDataSet - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns the resulting data set for the given dataType. If more than one data source - for the given data type was requested, this method will return the data for an arbitrary - one. Use getDataSet(DataSource) to read each specific data source. -

- This method returns only non-aggregated data sets that were queried via - read(DataType) or - read(DataSource). - Aggregated data can be queried via getBuckets().

-
-
Returns
-
  • a data set for the given data type, empty if no data was found.
-
-
-
Throws
- - - - -
IllegalArgumentException - if the given data type was not part of the read request -
-
- -
-
- - - - -
-

- - public - - - - - List<DataSet> - - getDataSets - () -

-
-
- - - -
-
- - - - -

Returns all of the data sets in the result. There will be exactly one data set for each - data source requested in the DataReadRequest. -

- This method returns only non-aggregated data sets that were queried via - read(DataType) or - read(DataSource). - Aggregated data can be queried via getBuckets(). -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/DataSourcesResult.html b/docs/html/reference/com/google/android/gms/fitness/result/DataSourcesResult.html deleted file mode 100644 index 85069bae44e5..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/DataSourcesResult.html +++ /dev/null @@ -1,1945 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataSourcesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataSourcesResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.DataSourcesResult
- - - - - - - -
- - -

Class Overview

-

Result of findDataSources(GoogleApiClient, DataSourcesRequest). Contains - all of the retrieved data sources which matched the request. The method - getDataSources() can be used to fetch the resulting data sources. -

- The calling app should check getStatus() to confirm that the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataSourcesResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - List<DataSource> - - getDataSources(DataType dataType) - -
- Returns all of the found data sources for the given dataType - - - -
- -
- - - - - - List<DataSource> - - getDataSources() - -
- Returns all of the found data sources. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataSourcesResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getDataSources - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns all of the found data sources for the given dataType

-
-
Returns
-
  • the list of retrieved data sources, empty if none were found -
-
- -
-
- - - - -
-

- - public - - - - - List<DataSource> - - getDataSources - () -

-
-
- - - -
-
- - - - -

Returns all of the found data sources.

-
-
Returns
-
  • the list of retrieved data sources, empty if none were found -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/DataTypeResult.html b/docs/html/reference/com/google/android/gms/fitness/result/DataTypeResult.html deleted file mode 100644 index c6df1ec79999..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/DataTypeResult.html +++ /dev/null @@ -1,1884 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataTypeResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataTypeResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.DataTypeResult
- - - - - - - -
- - -

Class Overview

-

Result of - readDataType(GoogleApiClient, String). -

- The method getStatus() can be be used to confirm if the request was successful. On - success, the returned data type can be accessed via getDataType(). -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- In case the app attempts to read a custom data type created by other app, - the returned status has status code set to INCONSISTENT_DATA_TYPE. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<DataTypeResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - DataType - - getDataType() - -
- Returns the new custom data type inserted. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<DataTypeResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - DataType - - getDataType - () -

-
-
- - - -
-
- - - - -

Returns the new custom data type inserted. -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/ListSubscriptionsResult.html b/docs/html/reference/com/google/android/gms/fitness/result/ListSubscriptionsResult.html deleted file mode 100644 index f1254f225737..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/ListSubscriptionsResult.html +++ /dev/null @@ -1,1944 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ListSubscriptionsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ListSubscriptionsResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.ListSubscriptionsResult
- - - - - - - -
- - -

Class Overview

-

Result of listSubscriptions(GoogleApiClient, DataType). Contains all of - the returned subscriptions which can be retrieved by getSubscriptions(). -

- The method getStatus() can be be used to confirm if the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<ListSubscriptionsResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - List<Subscription> - - getSubscriptions(DataType dataType) - -
- Returns all of the found subscriptions for the given dataType - - - -
- -
- - - - - - List<Subscription> - - getSubscriptions() - -
- Returns all of the found subscriptions. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<ListSubscriptionsResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - List<Subscription> - - getSubscriptions - (DataType dataType) -

-
-
- - - -
-
- - - - -

Returns all of the found subscriptions for the given dataType

-
-
Returns
-
  • the list of retrieved data sources, empty if none were found -
-
- -
-
- - - - -
-

- - public - - - - - List<Subscription> - - getSubscriptions - () -

-
-
- - - -
-
- - - - -

Returns all of the found subscriptions.

-
-
Returns
-
  • the list of retrieved subscriptions, empty if none were found -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/SessionReadResult.html b/docs/html/reference/com/google/android/gms/fitness/result/SessionReadResult.html deleted file mode 100644 index ba0dcce63c3b..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/SessionReadResult.html +++ /dev/null @@ -1,2035 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionReadResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SessionReadResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.SessionReadResult
- - - - - - - -
- - -

Class Overview

-

Result of readSession(GoogleApiClient, SessionReadRequest). Contains all - Sessions and their corresponding data sets that matched the filters specified in the - SessionReadRequest. -

- The method getStatus() can be be used to confirm if the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- The method getSessions() returns all sessions that are returned for the request. - The method getDataSet(Session, DataType) returns DataSet for a particular - Session and DataType from the result. -

- In case the app tried to read data for a custom data type created by another app, - the returned status has status code set to INCONSISTENT_DATA_TYPE. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<SessionReadResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - List<DataSet> - - getDataSet(Session session, DataType dataType) - -
- Returns the data sets for a given session and dataType. - - - -
- -
- - - - - - List<DataSet> - - getDataSet(Session session) - -
- Returns the data sets for all data sources for a given session. - - - -
- -
- - - - - - List<Session> - - getSessions() - -
- Returns all sessions that matched the requested filters. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<SessionReadResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<DataSet> - - getDataSet - (Session session, DataType dataType) -

-
-
- - - -
-
- - - - -

Returns the data sets for a given session and dataType. If a specific data - source was requested for this data type in the read request, the returned data set is from - that source. Else, the default data source for this data type is used. Returns empty if no - data for the requested data type is found.

-
-
Returns
-
  • data sets for the given session and data type, empty if no data was found. Multiple - data sets may be returned for a given type, based on the read request
-
-
-
Throws
- - - - -
IllegalArgumentException - if the given session was not part of - getSessions() output. -
-
- -
-
- - - - -
-

- - public - - - - - List<DataSet> - - getDataSet - (Session session) -

-
-
- - - -
-
- - - - -

Returns the data sets for all data sources for a given session. If a specific data - source was requested for a data type in the read request, the returned data set is from - that source. Else, the default data source for the requested data type is used.

-
-
Returns
-
  • data sets for the given session for all data sources, empty if no data was found. - Multiple data sets may be returned for a given type, based on the read request
-
-
-
Throws
- - - - -
IllegalArgumentException - if the given session was not part of - getSessions() output -
-
- -
-
- - - - -
-

- - public - - - - - List<Session> - - getSessions - () -

-
-
- - - -
-
- - - - -

Returns all sessions that matched the requested filters. -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/SessionStopResult.html b/docs/html/reference/com/google/android/gms/fitness/result/SessionStopResult.html deleted file mode 100644 index 9a0eacf78940..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/SessionStopResult.html +++ /dev/null @@ -1,1877 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SessionStopResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SessionStopResult

- - - - - extends Object
- - - - - - - implements - - Result - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.result.SessionStopResult
- - - - - - - -
- - -

Class Overview

-

Result of stopSession(GoogleApiClient, String). -

- The method getStatus() can be be used to confirm if the request was successful. -

- In case the calling app is missing the required permissions, the returned status has status - code set to NEEDS_OAUTH_PERMISSIONS. In this case the - caller should use startResolutionForResult(Activity, int) to start an intent - to get the necessary consent from the user before retrying the request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<SessionStopResult>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - List<Session> - - getSessions() - -
- Returns the list of sessions that were stopped by the request. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of the call to Google Fit. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<SessionStopResult> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<Session> - - getSessions - () -

-
-
- - - -
-
- - - - -

Returns the list of sessions that were stopped by the request. Returns an empty list if no - active session was stopped. -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of the call to Google Fit. isSuccess() can be used to - determine whether the call succeeded. In the case of failure, you can inspect the status to - determine the reason. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/result/package-summary.html b/docs/html/reference/com/google/android/gms/fitness/result/package-summary.html deleted file mode 100644 index 9cdcbb24e1af..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/result/package-summary.html +++ /dev/null @@ -1,968 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.fitness.result | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.fitness.result

-
- -
- -
- - -
- Contains response objects used in Google Fit API methods. - -
- - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BleDevicesResult - Result of listClaimedBleDevices(GoogleApiClient).  - - - -
DailyTotalResult - Result of readDailyTotal(GoogleApiClient, DataType).  - - - -
DataReadResult - Result of readData(GoogleApiClient, DataReadRequest).  - - - -
DataSourcesResult - Result of findDataSources(GoogleApiClient, DataSourcesRequest).  - - - -
DataTypeResult - Result of - readDataType(GoogleApiClient, String).  - - - -
ListSubscriptionsResult - Result of listSubscriptions(GoogleApiClient, DataType).  - - - -
SessionReadResult - Result of readSession(GoogleApiClient, SessionReadRequest).  - - - -
SessionStopResult - Result of stopSession(GoogleApiClient, String).  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorService.html b/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorService.html deleted file mode 100644 index 9302b9dc597b..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorService.html +++ /dev/null @@ -1,6563 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FitnessSensorService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

FitnessSensorService

- - - - - - - - - - - - - - - - - extends Service
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.fitness.service.FitnessSensorService
- - - - - - - -
- - -

Class Overview

-

A service which allows an installed application to expose sensors to Google Fit, so that they - can be used by other applications through the standard SensorsApi. - The service supports finding, registering, and unregistering to application-exposed sensors. -

- Applications should implement the FitnessSensorService when they have access to - live sensor data from external devices that are not otherwise compatible with the platform. - An example would be a hardware pedometer that connects to the phone via standard Bluetooth. - A companion application could expose the pedometer's readings to the platform. -

- The FitnessSensorService can also be used to expose software sensors. For instance, - an application may compute step count data in software based on other hardware sensors (such - as the accelerometer). The computed data can be made available using this service. -

- To add an application-exposed sensor to the platform, a subclass of FitnessSensorService - must be declared in the manifest as such: - 

-      <service
-         android:name="com.example.android.fitness.MySensorService"
-         android:exported="true">
-         <intent-filter>
-             <action android:name="com.google.android.gms.fitness.service.FitnessSensorService" />
-             <data android:mimeType="vnd.google.fitness.data_type/com.google.heart_rate.bpm" />
-         </intent-filter>
-      </service>
-
-

- The declared service must include one or more mimeType filters, indicating which data types it - supports. If no data type is listed, the service will be ignored. -

- The service will be used to find, register, and unregister to the application-exposed sensors. - When an active registration exists, Google Fit will bind to the service, - and will remain bound until all registrations are removed. In this way, - the platform is able to control the lifetime of the sensor service. -

- The Fitness Platform has built-in support for local hardware sensors, BLE devices with standard - GATT profiles, and Android Wear devices. Accessing these sensors does not require a custom - FitnessSensorService. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringSERVICE_INTERFACE - Intent action that must be declared in the manifest for the subclass. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - FitnessSensorService() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - IBinder - - onBind(Intent intent) - -
- - - - - - void - - onCreate() - -
- abstract - - - - - List<DataSource> - - onFindDataSources(List<DataType> dataTypes) - -
- Find application data sources which match the given data types. - - - -
- -
- abstract - - - - - boolean - - onRegister(FitnessSensorServiceRequest request) - -
- Registers for events from a particular data source at a given rate. - - - -
- -
- abstract - - - - - boolean - - onUnregister(DataSource dataSource) - -
- Unregisters for events from a particular data source. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - SERVICE_INTERFACE -

-
- - - - -
-
- - - - -

Intent action that must be declared in the manifest for the subclass. Used to start the - service to find and register to application-exposed sensors. -

- - -
- Constant Value: - - - "com.google.android.gms.fitness.service.FitnessSensorService" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - FitnessSensorService - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - IBinder - - onBind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - abstract - - List<DataSource> - - onFindDataSources - (List<DataType> dataTypes) -

-
-
- - - -
-
- - - - -

Find application data sources which match the given data types.

-
-
Parameters
- - - - -
dataTypes - the data types that the client is interested in
-
-
-
Returns
-
  • the list of data sources which this application can expose that match the given - data types, empty if there is no match -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - onRegister - (FitnessSensorServiceRequest request) -

-
-
- - - -
-
- - - - -

Registers for events from a particular data source at a given rate. Events should be - delivered to the fitness platform using the dispatcher specified in the request, - accessible via getDispatcher(). -

- In case an active registration to the given data source already exists, - the request should be treated as an update. In case the given data source is no longer - exposed by this application, the request can be ignored and false returned.

-
-
Parameters
- - - - -
request - request specifying the data source to register to, the desired sampling rate, - and the desired batching interval
-
-
-
Returns
-
  • true if we were able to register to a matching data source -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - onUnregister - (DataSource dataSource) -

-
-
- - - -
-
- - - - -

Unregisters for events from a particular data source.

-
-
Parameters
- - - - -
dataSource - the data source we wish to stop receiving events from
-
-
-
Returns
-
  • true if we were able to unregister from a matching data source -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorServiceRequest.html b/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorServiceRequest.html deleted file mode 100644 index f40a50fc9a4a..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/service/FitnessSensorServiceRequest.html +++ /dev/null @@ -1,2020 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FitnessSensorServiceRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

FitnessSensorServiceRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.fitness.service.FitnessSensorServiceRequest
- - - - - - - -
- - -

Class Overview

-

Request for registering for sensor events from an application-exposed sensor - data source. The request specifies the data source, - the desired sampling rate and batching interval for the registration, - and a listener to deliver events to. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intUNSPECIFIED - Constant representing an unspecified value. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<FitnessSensorServiceRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - long - - getBatchInterval(TimeUnit timeUnit) - -
- Sets the maximum delay between a data point being detected and reported. - - - -
- -
- - - - - - DataSource - - getDataSource() - -
- Returns the data source the client is registering to. - - - -
- -
- - - - - - SensorEventDispatcher - - getDispatcher() - -
- Returns a dispatcher that can be used to send events back to the Fitness Platform for this - particular registration. - - - -
- -
- - - - - - long - - getSamplingRate(TimeUnit timeUnit) - -
- Returns the desired delay between two consecutive collected data points, - in the given time unit. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - UNSPECIFIED -

-
- - - - -
-
- - - - -

Constant representing an unspecified value.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<FitnessSensorServiceRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - long - - getBatchInterval - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Sets the maximum delay between a data point being detected and reported. - The batch interval can be used to enable batching, which can save battery by reducing the - number of times the AP is awaken, and the number of network transfers. This is specially - important if the sensor exposed is from a companion device. -

- The batch interval is a hint to the system, and events can be reported sooner. If no - interval is specified, or if the underlying data source does not support batching, - events may be reported as soon as they are detected.

-
-
Returns
-
  • the maximum latency, in micros, or UNSPECIFIED if unspecified. -
-
- -
-
- - - - -
-

- - public - - - - - DataSource - - getDataSource - () -

-
-
- - - -
-
- - - - -

Returns the data source the client is registering to. The Fitness Platform will guarantee - that applications only receive requests for data sources they own. -

- Duplicate requests for the same data source should be treated as update requests. -

- -
-
- - - - -
-

- - public - - - - - SensorEventDispatcher - - getDispatcher - () -

-
-
- - - -
-
- - - - -

Returns a dispatcher that can be used to send events back to the Fitness Platform for this - particular registration. -

- -
-
- - - - -
-

- - public - - - - - long - - getSamplingRate - (TimeUnit timeUnit) -

-
-
- - - -
-
- - - - -

Returns the desired delay between two consecutive collected data points, - in the given time unit. This is only a hint, and events may be sampled faster or slower - than the specified rate. -

- If the sampling rate is unspecified, the application should select a default rate with - conservative battery usage for an always-on registration.

-
-
Returns
-
  • the sampling rate, in the specified unit, or UNSPECIFIED if unspecified. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/service/SensorEventDispatcher.html b/docs/html/reference/com/google/android/gms/fitness/service/SensorEventDispatcher.html deleted file mode 100644 index f467c1697efb..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/service/SensorEventDispatcher.html +++ /dev/null @@ -1,1135 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SensorEventDispatcher | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SensorEventDispatcher

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.fitness.service.SensorEventDispatcher
- - - - - - - -
- - -

Class Overview

-

Dispatcher that can be used by FitnessSensorService implementations to push events - to the Fitness Platform. Each event is delivered as a DataPoint. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - publish(DataPoint dataPoint) - -
- Publishes a new data point to the Fitness Platform. - - - -
- -
- abstract - - - - - void - - publish(List<DataPoint> dataPoints) - -
- Publishes a batch of data points to the Fitness Platform. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - publish - (DataPoint dataPoint) -

-
-
- - - -
-
- - - - -

Publishes a new data point to the Fitness Platform. -

-
-
Throws
- - - - -
RemoteException -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - publish - (List<DataPoint> dataPoints) -

-
-
- - - -
-
- - - - -

Publishes a batch of data points to the Fitness Platform. -

-
-
Throws
- - - - -
RemoteException -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/fitness/service/package-summary.html b/docs/html/reference/com/google/android/gms/fitness/service/package-summary.html deleted file mode 100644 index 7fb0c0a69423..000000000000 --- a/docs/html/reference/com/google/android/gms/fitness/service/package-summary.html +++ /dev/null @@ -1,925 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.fitness.service | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.fitness.service

-
- -
- -
- - -
- Contains APIs for exposing third-party sensors to Google Fit using a service. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
SensorEventDispatcher - Dispatcher that can be used by FitnessSensorService implementations to push events - to the Fitness Platform.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - -
FitnessSensorService - A service which allows an installed application to expose sensors to Google Fit, so that they - can be used by other applications through the standard SensorsApi.  - - - -
FitnessSensorServiceRequest - Request for registering for sensor events from an application-exposed sensor - data source.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Game.html b/docs/html/reference/com/google/android/gms/games/Game.html deleted file mode 100644 index fe755690981c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Game.html +++ /dev/null @@ -1,2456 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Game | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Game

- - - - - - implements - - Freezable<Game> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Game
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving game information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - areSnapshotsEnabled() - -
- Indicates whether or not this game supports snapshots. - - - -
- -
- abstract - - - - - int - - getAchievementTotalCount() - -
- Retrieves the number of achievements registered for this game. - - - -
- -
- abstract - - - - - String - - getApplicationId() - -
- Retrieves the application ID for this game. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- Retrieves the description of this game. - - - -
- -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the description string into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getDeveloperName() - -
- Retrieves the name of the developer of this game. - - - -
- -
- abstract - - - - - void - - getDeveloperName(CharArrayBuffer dataOut) - -
- Loads the developer name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getDisplayName() - -
- Retrieves the display name for this game. - - - -
- -
- abstract - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the display name string into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Uri - - getFeaturedImageUri() - -
- Retrieves an image URI that can be used to load the game's featured (banner) image from - Google Play. - - - -
- -
- abstract - - - - - Uri - - getHiResImageUri() - -
- Retrieves an image URI that can be used to load the game's hi-res image. - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Retrieves an image URI that can be used to load the game's icon. - - - -
- -
- abstract - - - - - int - - getLeaderboardCount() - -
- Gets the number of leaderboards registered for this game. - - - -
- -
- abstract - - - - - String - - getPrimaryCategory() - -
- Retrieves the primary category of the game - this is may be null. - - - -
- -
- abstract - - - - - String - - getSecondaryCategory() - -
- Retrieves the secondary category of the game - this may be null. - - - -
- -
- abstract - - - - - String - - getThemeColor() - -
- Retrieves the theme color for this game. - - - -
- -
- abstract - - - - - boolean - - hasGamepadSupport() - -
- Indicates whether or not this game is marked as supporting gamepads. - - - -
- -
- abstract - - - - - boolean - - isRealTimeMultiplayerEnabled() - -
- Indicates whether or not this game supports real-time multiplayer. - - - -
- -
- abstract - - - - - boolean - - isTurnBasedMultiplayerEnabled() - -
- Indicates whether or not this game supports turn-based multiplayer. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - areSnapshotsEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports snapshots.

-
-
Returns
-
  • Whether or not this game supports snapshots. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getAchievementTotalCount - () -

-
-
- - - -
-
- - - - -

Retrieves the number of achievements registered for this game.

-
-
Returns
-
  • The number of achievements registered for this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getApplicationId - () -

-
-
- - - -
-
- - - - -

Retrieves the application ID for this game.

-
-
Returns
-
  • The application ID for this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description of this game.

-
-
Returns
-
  • The description of this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the description string into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDeveloperName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of the developer of this game.

-
-
Returns
-
  • The name of the developer of this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDeveloperName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the developer name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the display name for this game.

-
-
Returns
-
  • The display name for this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the display name string into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getFeaturedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's featured (banner) image from - Google Play. Returns null if game has no featured image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's featured image, or null if the game has no - featured image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's hi-res image. Returns null if - game has no hi-res image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's hi-res image, or null if the game has no - hi-res image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's icon. Returns null if game has no - icon. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's icon, or null if the game has no icon. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getLeaderboardCount - () -

-
-
- - - -
-
- - - - -

Gets the number of leaderboards registered for this game.

-
-
Returns
-
  • The number of leaderboards registered for this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPrimaryCategory - () -

-
-
- - - -
-
- - - - -

Retrieves the primary category of the game - this is may be null.

-
-
Returns
-
  • The primary category of the game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getSecondaryCategory - () -

-
-
- - - -
-
- - - - -

Retrieves the secondary category of the game - this may be null.

-
-
Returns
-
  • The secondary category of the game, or null if not provided. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getThemeColor - () -

-
-
- - - -
-
- - - - -

Retrieves the theme color for this game. The theme color is used to configure the appearance - of Play Games UIs.

-
-
Returns
-
  • The color to use as an RGB hex triplet, e.g. "E0E0E0" -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGamepadSupport - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game is marked as supporting gamepads.

-
-
Returns
-
  • Whether or not this game declares gamepad support. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isRealTimeMultiplayerEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports real-time multiplayer.

-
-
Returns
-
  • Whether or not this game supports real-time mulitplayer. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isTurnBasedMultiplayerEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports turn-based multiplayer.

-
-
Returns
-
  • Whether or not this game supports turn-based mulitplayer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GameBuffer.html b/docs/html/reference/com/google/android/gms/games/GameBuffer.html deleted file mode 100644 index 3c4d5bae25e8..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GameBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GameBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GameBuffer

- - - - - - - - - extends AbstractDataBuffer<Game>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.Game>
    ↳com.google.android.gms.games.GameBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of games. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Game - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Game - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GameEntity.html b/docs/html/reference/com/google/android/gms/games/GameEntity.html deleted file mode 100644 index 7440188c9766..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GameEntity.html +++ /dev/null @@ -1,3557 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GameEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GameEntity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Game - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.GameEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing a set of Game data. This is immutable, and therefore safe to cache or - store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<GameEntity>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - areSnapshotsEnabled() - -
- Indicates whether or not this game supports snapshots. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Game - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - int - - getAchievementTotalCount() - -
- Retrieves the number of achievements registered for this game. - - - -
- -
- - - - - - String - - getApplicationId() - -
- Retrieves the application ID for this game. - - - -
- -
- - - - - - String - - getDescription() - -
- Retrieves the description of this game. - - - -
- -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the description string into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getDeveloperName() - -
- Retrieves the name of the developer of this game. - - - -
- -
- - - - - - void - - getDeveloperName(CharArrayBuffer dataOut) - -
- Loads the developer name into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getDisplayName() - -
- Retrieves the display name for this game. - - - -
- -
- - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the display name string into the given CharArrayBuffer. - - - -
- -
- - - - - - Uri - - getFeaturedImageUri() - -
- Retrieves an image URI that can be used to load the game's featured (banner) image from - Google Play. - - - -
- -
- - - - - - Uri - - getHiResImageUri() - -
- Retrieves an image URI that can be used to load the game's hi-res image. - - - -
- -
- - - - - - Uri - - getIconImageUri() - -
- Retrieves an image URI that can be used to load the game's icon. - - - -
- -
- - - - - - int - - getLeaderboardCount() - -
- Gets the number of leaderboards registered for this game. - - - -
- -
- - - - - - String - - getPrimaryCategory() - -
- Retrieves the primary category of the game - this is may be null. - - - -
- -
- - - - - - String - - getSecondaryCategory() - -
- Retrieves the secondary category of the game - this may be null. - - - -
- -
- - - - - - String - - getThemeColor() - -
- Retrieves the theme color for this game. - - - -
- -
- - - - - - boolean - - hasGamepadSupport() - -
- Indicates whether or not this game is marked as supporting gamepads. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - boolean - - isRealTimeMultiplayerEnabled() - -
- Indicates whether or not this game supports real-time multiplayer. - - - -
- -
- - - - - - boolean - - isTurnBasedMultiplayerEnabled() - -
- Indicates whether or not this game supports turn-based multiplayer. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.games.Game - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<GameEntity> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - areSnapshotsEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports snapshots.

-
-
Returns
-
  • Whether or not this game supports snapshots. -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Game - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getAchievementTotalCount - () -

-
-
- - - -
-
- - - - -

Retrieves the number of achievements registered for this game.

-
-
Returns
-
  • The number of achievements registered for this game. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getApplicationId - () -

-
-
- - - -
-
- - - - -

Retrieves the application ID for this game.

-
-
Returns
-
  • The application ID for this game. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description of this game.

-
-
Returns
-
  • The description of this game. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the description string into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDeveloperName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of the developer of this game.

-
-
Returns
-
  • The name of the developer of this game. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDeveloperName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the developer name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the display name for this game.

-
-
Returns
-
  • The display name for this game. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the display name string into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getFeaturedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's featured (banner) image from - Google Play. Returns null if game has no featured image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's featured image, or null if the game has no - featured image. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's hi-res image. Returns null if - game has no hi-res image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's hi-res image, or null if the game has no - hi-res image. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the game's icon. Returns null if game has no - icon. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load the game's icon, or null if the game has no icon. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getLeaderboardCount - () -

-
-
- - - -
-
- - - - -

Gets the number of leaderboards registered for this game.

-
-
Returns
-
  • The number of leaderboards registered for this game. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPrimaryCategory - () -

-
-
- - - -
-
- - - - -

Retrieves the primary category of the game - this is may be null.

-
-
Returns
-
  • The primary category of the game. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSecondaryCategory - () -

-
-
- - - -
-
- - - - -

Retrieves the secondary category of the game - this may be null.

-
-
Returns
-
  • The secondary category of the game, or null if not provided. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getThemeColor - () -

-
-
- - - -
-
- - - - -

Retrieves the theme color for this game. The theme color is used to configure the appearance - of Play Games UIs.

-
-
Returns
-
  • The color to use as an RGB hex triplet, e.g. "E0E0E0" -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasGamepadSupport - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game is marked as supporting gamepads.

-
-
Returns
-
  • Whether or not this game declares gamepad support. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isRealTimeMultiplayerEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports real-time multiplayer.

-
-
Returns
-
  • Whether or not this game supports real-time mulitplayer. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isTurnBasedMultiplayerEnabled - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this game supports turn-based multiplayer.

-
-
Returns
-
  • Whether or not this game supports turn-based mulitplayer. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.Builder.html b/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.Builder.html deleted file mode 100644 index 39e61842a0c3..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.Builder.html +++ /dev/null @@ -1,1502 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Games.GamesOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Games.GamesOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.Games.GamesOptions.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Games.GamesOptions - - build() - -
- - - - - - Games.GamesOptions.Builder - - setSdkVariant(int variant) - -
- - - - - - Games.GamesOptions.Builder - - setShowConnectingPopup(boolean showConnectingPopup) - -
- Sets whether a "connecting" popup should be displayed automatically at the start of - the sign-in flow. - - - -
- -
- - - - - - Games.GamesOptions.Builder - - setShowConnectingPopup(boolean showConnectingPopup, int gravity) - -
- Sets whether a "connecting" popup should be displayed automatically at the start of - the sign-in flow. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Games.GamesOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Games.GamesOptions.Builder - - setSdkVariant - (int variant) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Games.GamesOptions.Builder - - setShowConnectingPopup - (boolean showConnectingPopup) -

-
-
- - - -
-
- - - - -

Sets whether a "connecting" popup should be displayed automatically at the start of - the sign-in flow. By default this is enabled. -

- Note that this call will use the default gravity for the "connecting" popup, which - will display the popup at the center of the screen. If you prefer that the popup - appear in a different section of the screen, you can use - setShowConnectingPopup(boolean, int), and provide a Gravity value.

-
-
Parameters
- - - - -
showConnectingPopup - Whether or not to show a "connecting" popup at the - beginning of the sign-in flow. Default behavior is for this to be true.
-
-
-
Returns
-
  • This Builder. -
-
- -
-
- - - - -
-

- - public - - - - - Games.GamesOptions.Builder - - setShowConnectingPopup - (boolean showConnectingPopup, int gravity) -

-
-
- - - -
-
- - - - -

Sets whether a "connecting" popup should be displayed automatically at the start of - the sign-in flow. By default this is enabled.

-
-
Parameters
- - - - - - - -
showConnectingPopup - Whether or not to show a "connecting" popup at the - beginning of the sign-in flow. Default behavior is for this to be true.
gravity - The Gravity which controls where the "connecting" popup should - be displayed during sign-in.
-
-
-
Returns
-
  • This Builder. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.html b/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.html deleted file mode 100644 index 14c7b90e549c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Games.GamesOptions.html +++ /dev/null @@ -1,1365 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Games.GamesOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Games.GamesOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.Optional - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.Games.GamesOptions
- - - - - - - -
- - -

Class Overview

-

API configuration parameters for Games. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGames.GamesOptions.Builder -   - - - -
- - - - - - - - - - -
Public Methods
- - - - static - - Games.GamesOptions.Builder - - builder() - -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Games.GamesOptions.Builder - - builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Games.html b/docs/html/reference/com/google/android/gms/games/Games.html deleted file mode 100644 index 8a9316801102..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Games.html +++ /dev/null @@ -1,2655 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Games | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Games

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.Games
- - - - - - - -
- - -

Class Overview

-

Main entry point for the Games APIs. This class provides APIs and interfaces to access the Google - Play game services functionality. -

- To use the service, construct a GoogleApiClient and pass API to - addApi(Api). Once you have your GoogleApiClient, call - connect() and wait for the - onConnected(Bundle) method to be called. The Bundle provided - to onConnected may be null. If not null, it can contain the following keys: -

-

- For more information, see the "Getting Started" guide available at https://developers.google.com/games/services/android/quickstart. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGames.GamesOptions - API configuration parameters for Games.  - - - -
- - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_PLAYER_IDS - Used to return a list of player IDs. - - - -
StringEXTRA_STATUS - Used to return a Status object from activities. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Games.GamesOptions>API - Token to pass to addApi(Api) to enable the Games features. - - - -
- public - static - final - AchievementsAchievements - Methods for interacting with achievements. - - - -
- public - static - final - EventsEvents - Methods for interacting with events. - - - -
- public - static - final - GamesMetadataGamesMetadata - Methods for interacting with game metadata. - - - -
- public - static - final - InvitationsInvitations - Methods for interacting with invitations. - - - -
- public - static - final - LeaderboardsLeaderboards - Methods for interacting with leaderboard data. - - - -
- public - static - final - NotificationsNotifications - Methods for interacting with notifications. - - - -
- public - static - final - PlayersPlayers - Methods for interacting with players. - - - -
- public - static - final - QuestsQuests - Methods for interacting with quests. - - - -
- public - static - final - RealTimeMultiplayerRealTimeMultiplayer - Methods for interacting with real-time multiplayer games. - - - -
- public - static - final - RequestsRequests - Methods for interacting with requests. - - - -
- public - static - final - ScopeSCOPE_GAMES - Scope for accessing data from Google Play Games. - - - -
- public - static - final - SnapshotsSnapshots - Methods for interacting with snapshots. - - - -
- public - static - final - TurnBasedMultiplayerTurnBasedMultiplayer - Methods for interacting with turn-based multiplayer games. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getAppId(GoogleApiClient apiClient) - -
- Get the application ID linked to this client instance. - - - -
- -
- - - - static - - String - - getCurrentAccountName(GoogleApiClient apiClient) - -
- Get the name of the currently selected account. - - - -
- -
- - - - static - - int - - getSdkVariant(GoogleApiClient apiClient) - -
- - - - static - - Intent - - getSettingsIntent(GoogleApiClient apiClient) - -
- Gets an intent to show the Settings screen that allows the user to configure Games-related - features for the current game. - - - -
- -
- - - - static - - void - - setGravityForPopups(GoogleApiClient apiClient, int gravity) - -
- Specifies the part of the screen at which games service popups (for example, "welcome back" - or "achievement unlocked" popups) will be displayed using gravity. - - - -
- -
- - - - static - - void - - setViewForPopups(GoogleApiClient apiClient, View gamesContentView) - -
- Sets the View to use as a content view for popups. - - - -
- -
- - - - static - - PendingResult<Status> - - signOut(GoogleApiClient apiClient) - -
- Asynchronously signs the current user out. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_PLAYER_IDS -

-
- - - - -
-
- - - - -

Used to return a list of player IDs. Retrieve with - getStringArrayListExtra(String). - - Also used to pass in a list of player IDs for preselecting players. Set with - putStringArrayListExtra(String, java.util.ArrayList).

-
-
See Also
- -
- - -
- Constant Value: - - - "players" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_STATUS -

-
- - - - -
-
- - - - -

Used to return a Status object from activities. Retrieve with - getParcelableExtra(String). -

- - -
- Constant Value: - - - "status" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Games.GamesOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the Games features. -

- To configure additional Games options, provide a Games.GamesOptions object to - addApi(Api). -

- - -
-
- - - - - -
-

- - public - static - final - Achievements - - Achievements -

-
- - - - -
-
- - - - -

Methods for interacting with achievements. -

- - -
-
- - - - - -
-

- - public - static - final - Events - - Events -

-
- - - - -
-
- - - - -

Methods for interacting with events. -

- - -
-
- - - - - -
-

- - public - static - final - GamesMetadata - - GamesMetadata -

-
- - - - -
-
- - - - -

Methods for interacting with game metadata. -

- - -
-
- - - - - -
-

- - public - static - final - Invitations - - Invitations -

-
- - - - -
-
- - - - -

Methods for interacting with invitations. -

- - -
-
- - - - - -
-

- - public - static - final - Leaderboards - - Leaderboards -

-
- - - - -
-
- - - - -

Methods for interacting with leaderboard data. -

- - -
-
- - - - - -
-

- - public - static - final - Notifications - - Notifications -

-
- - - - -
-
- - - - -

Methods for interacting with notifications. -

- - -
-
- - - - - -
-

- - public - static - final - Players - - Players -

-
- - - - -
-
- - - - -

Methods for interacting with players. -

- - -
-
- - - - - -
-

- - public - static - final - Quests - - Quests -

-
- - - - -
-
- - - - -

Methods for interacting with quests. -

- - -
-
- - - - - -
-

- - public - static - final - RealTimeMultiplayer - - RealTimeMultiplayer -

-
- - - - -
-
- - - - -

Methods for interacting with real-time multiplayer games. -

- - -
-
- - - - - -
-

- - public - static - final - Requests - - Requests -

-
- - - - -
-
- - - - -

Methods for interacting with requests. -

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_GAMES -

-
- - - - -
-
- - - - -

Scope for accessing data from Google Play Games. -

- - -
-
- - - - - -
-

- - public - static - final - Snapshots - - Snapshots -

-
- - - - -
-
- - - - -

Methods for interacting with snapshots. -

- - -
-
- - - - - -
-

- - public - static - final - TurnBasedMultiplayer - - TurnBasedMultiplayer -

-
- - - - -
-
- - - - -

Methods for interacting with turn-based multiplayer games. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getAppId - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Get the application ID linked to this client instance. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The application ID linked to this client instance. -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getCurrentAccountName - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Get the name of the currently selected account. This is the account the user has chosen to - use for Google Play Games. -

- Note that the GoogleApiClient must be connected to call this API, and your app must - have <uses-permission android:name="android.permission.GET_ACCOUNTS" /> - declared in your manifest in order to use this method. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • Account name for the currently selected account. May be null if an error occurred - while communicating with the games service.
-
-
-
Throws
- - - - -
SecurityException - If your app doesn't have the - GET_ACCOUNTS permission. -
-
- -
-
- - - - -
-

- - public - static - - - - int - - getSdkVariant - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - Intent - - getSettingsIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets an intent to show the Settings screen that allows the user to configure Games-related - features for the current game. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- A RESULT_RECONNECT_REQUIRED may be returned as the - resultCode in onActivityResult(int, int, Intent) if the GoogleApiClient ends up in an - inconsistent state. -

- Most applications will not need to call this directly, since the Settings UI is already - reachable from most other Games UI screens (achievements, leaderboards, etc.) via a menu - item. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the GoogleApiClient Settings UI. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setGravityForPopups - (GoogleApiClient apiClient, int gravity) -

-
-
- - - -
-
- - - - -

Specifies the part of the screen at which games service popups (for example, "welcome back" - or "achievement unlocked" popups) will be displayed using gravity. -

- Default value is TOP|CENTER_HORIZONTAL. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
gravity - The gravity which controls the placement of games service popups. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setViewForPopups - (GoogleApiClient apiClient, View gamesContentView) -

-
-
- - - -
-
- - - - -

Sets the View to use as a content view for popups. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
gamesContentView - The view to use as a content view for popups. View cannot be null. -
-
- -
-
- - - - -
-

- - public - static - - - - PendingResult<Status> - - signOut - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Asynchronously signs the current user out. -

- This call doesn't disconnect the Google API Client. As no user is signed in after this call - is completed, subsequent calls to this client will very likely fail. You should either call - disconnect() or finish your Activity after this call. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GamesActivityResultCodes.html b/docs/html/reference/com/google/android/gms/games/GamesActivityResultCodes.html deleted file mode 100644 index f5f14b305e10..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GamesActivityResultCodes.html +++ /dev/null @@ -1,1725 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GamesActivityResultCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GamesActivityResultCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.GamesActivityResultCodes
- - - - - - - -
- - -

Class Overview

-

Result codes that can be set as result in Activities from the Client UI started with - startActivityForResult(Intent, int). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRESULT_APP_MISCONFIGURED - Result code sent back to the calling Activity when the game is not properly configured to - access the Games service. - - - -
intRESULT_INVALID_ROOM - Result code send back to the calling Activity when a RealTimeWaitingRoom cannot be displayed - because the room does not exist, - - - -
intRESULT_LEFT_ROOM - Result code sent back to the calling Activity when the user explicitly chose - to "leave the room" from the real-time multiplayer "waiting room" screen. - - - -
intRESULT_LICENSE_FAILED - Result code sent back to the calling Activity when the game is not licensed to the user. - - - -
intRESULT_NETWORK_FAILURE - Result code sent back to the calling Activity when the server request resulted in a network - error. - - - -
intRESULT_RECONNECT_REQUIRED - Result code sent back to the calling Activity when a reconnect is required. - - - -
intRESULT_SEND_REQUEST_FAILED - Result code sent back to the calling Activity when sending a request from the "send request" - screen failed. - - - -
intRESULT_SIGN_IN_FAILED - Result code sent back to the calling Activity when signing in fails. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESULT_APP_MISCONFIGURED -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when the game is not properly configured to - access the Games service. Developers should check the logs for more details. -

- - -
- Constant Value: - - - 10004 - (0x00002714) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_INVALID_ROOM -

-
- - - - -
-
- - - - -

Result code send back to the calling Activity when a RealTimeWaitingRoom cannot be displayed - because the room does not exist,

-
-
See Also
- -
- - -
- Constant Value: - - - 10008 - (0x00002718) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_LEFT_ROOM -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when the user explicitly chose - to "leave the room" from the real-time multiplayer "waiting room" screen. - - (Note that if the user simply exits the "waiting room" screen by pressing - Back, that does not indicate that the user wants to leave the current room. - The waiting room screen will return RESULT_CANCELED in that - case.)

-
-
See Also
- -
- - -
- Constant Value: - - - 10005 - (0x00002715) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_LICENSE_FAILED -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when the game is not licensed to the user. -

- - -
- Constant Value: - - - 10003 - (0x00002713) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_NETWORK_FAILURE -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when the server request resulted in a network - error. -

- - -
- Constant Value: - - - 10006 - (0x00002716) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_RECONNECT_REQUIRED -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when a reconnect is required. -

- The GoogleApiClient is in an inconsistent state and must reconnect to the service to - resolve the issue. Further calls to the service using the current connection are unlikely to - succeed. -

- - -
- Constant Value: - - - 10001 - (0x00002711) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_SEND_REQUEST_FAILED -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when sending a request from the "send request" - screen failed. The logs will contain more detailed information.

-
-
See Also
- -
- - -
- Constant Value: - - - 10007 - (0x00002717) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_SIGN_IN_FAILED -

-
- - - - -
-
- - - - -

Result code sent back to the calling Activity when signing in fails. -

- The attempt to sign in to the Games service failed. For example, this might happen if the - network is flaky, or the user's account has been disabled, or consent could not be obtained. -

- - -
- Constant Value: - - - 10002 - (0x00002712) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GamesMetadata.LoadGamesResult.html b/docs/html/reference/com/google/android/gms/games/GamesMetadata.LoadGamesResult.html deleted file mode 100644 index 4b1541d32981..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GamesMetadata.LoadGamesResult.html +++ /dev/null @@ -1,1216 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GamesMetadata.LoadGamesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GamesMetadata.LoadGamesResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.GamesMetadata.LoadGamesResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when game metadata has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - GameBuffer - - getGames() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - GameBuffer - - getGames - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The game metadata that was requested. This is guaranteed to be non-null, though - it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GamesMetadata.html b/docs/html/reference/com/google/android/gms/games/GamesMetadata.html deleted file mode 100644 index 85980324fab4..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GamesMetadata.html +++ /dev/null @@ -1,1174 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GamesMetadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

GamesMetadata

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.GamesMetadata
- - - - - - - -
- - -

Class Overview

-

Entry point for game metadata functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceGamesMetadata.LoadGamesResult - Result delivered when game metadata has been loaded.  - - - -
- - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Game - - getCurrentGame(GoogleApiClient apiClient) - -
- Gets the metadata for the current game, if available. - - - -
- -
- abstract - - - - - PendingResult<GamesMetadata.LoadGamesResult> - - loadGame(GoogleApiClient apiClient) - -
- Loads the details for the current game. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Game - - getCurrentGame - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the metadata for the current game, if available. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • Game metadata for the current game. May be null if the metadata is not - available locally. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<GamesMetadata.LoadGamesResult> - - loadGame - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Loads the details for the current game. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/GamesStatusCodes.html b/docs/html/reference/com/google/android/gms/games/GamesStatusCodes.html deleted file mode 100644 index 46d791894362..000000000000 --- a/docs/html/reference/com/google/android/gms/games/GamesStatusCodes.html +++ /dev/null @@ -1,4090 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GamesStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GamesStatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.GamesStatusCodes
- - - - - - - -
- - -

Class Overview

-

Status codes for Games results. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATUS_ACHIEVEMENT_NOT_INCREMENTAL - Indicates that the call to increment achievement failed since the achievement is not an - incremental achievement. - - - -
intSTATUS_ACHIEVEMENT_UNKNOWN - Could not find the achievement, so the operation to update the achievement failed. - - - -
intSTATUS_ACHIEVEMENT_UNLOCKED - Indicates that the incremental achievement was also unlocked when the call was made to - increment the achievement. - - - -
intSTATUS_ACHIEVEMENT_UNLOCK_FAILURE - An incremental achievement cannot be unlocked directly, so the call to unlock achievement - failed. - - - -
intSTATUS_APP_MISCONFIGURED - The developer has misconfigured their application in some way. - - - -
intSTATUS_CLIENT_RECONNECT_REQUIRED - The GoogleApiClient is in an inconsistent state and must reconnect to the service to resolve - the issue. - - - -
intSTATUS_GAME_NOT_FOUND - The specified game ID was not recognized by the server. - - - -
intSTATUS_INTERNAL_ERROR - An unspecified error occurred; no more specific information is available. - - - -
intSTATUS_INTERRUPTED - Was interrupted while waiting for the result. - - - -
intSTATUS_INVALID_REAL_TIME_ROOM_ID - Constant indicating that the real-time room ID provided to the operation was not valid, or - does not correspond to the currently active real-time room. - - - -
intSTATUS_LICENSE_CHECK_FAILED - The game is not licensed to the user. - - - -
intSTATUS_MATCH_ERROR_ALREADY_REMATCHED - The specified match has already had a rematch created. - - - -
intSTATUS_MATCH_ERROR_INACTIVE_MATCH - The match is not currently active. - - - -
intSTATUS_MATCH_ERROR_INVALID_MATCH_RESULTS - The match results provided in this API call are invalid. - - - -
intSTATUS_MATCH_ERROR_INVALID_MATCH_STATE - The match is not in the correct state to perform the specified action. - - - -
intSTATUS_MATCH_ERROR_INVALID_PARTICIPANT_STATE - One or more participants in this match are not in valid states. - - - -
intSTATUS_MATCH_ERROR_LOCALLY_MODIFIED - The specified match has already been modified locally. - - - -
intSTATUS_MATCH_ERROR_OUT_OF_DATE_VERSION - The match data is out of date. - - - -
intSTATUS_MATCH_NOT_FOUND - The specified match cannot be found. - - - -
intSTATUS_MILESTONE_CLAIMED_PREVIOUSLY - This quest milestone was previously claimed (on this device or another). - - - -
intSTATUS_MILESTONE_CLAIM_FAILED - This quest milestone is not available for claiming. - - - -
intSTATUS_MULTIPLAYER_DISABLED - This game does not support multiplayer. - - - -
intSTATUS_MULTIPLAYER_ERROR_CREATION_NOT_ALLOWED - The user is not allowed to create a new multiplayer game at this time. - - - -
intSTATUS_MULTIPLAYER_ERROR_INVALID_MULTIPLAYER_TYPE - The match is not the right type to perform this action on. - - - -
intSTATUS_MULTIPLAYER_ERROR_INVALID_OPERATION - This multiplayer operation is not valid, and the server rejected it. - - - -
intSTATUS_MULTIPLAYER_ERROR_NOT_TRUSTED_TESTER - The user attempted to invite another user who was not authorized to see the game. - - - -
intSTATUS_NETWORK_ERROR_NO_DATA - A network error occurred while attempting to retrieve fresh data, and no data was available - locally. - - - -
intSTATUS_NETWORK_ERROR_OPERATION_DEFERRED - A network error occurred while attempting to modify data, but the data was successfully - modified locally and will be updated on the network the next time the device is able to sync. - - - -
intSTATUS_NETWORK_ERROR_OPERATION_FAILED - A network error occurred while attempting to perform an operation that requires network - access. - - - -
intSTATUS_NETWORK_ERROR_STALE_DATA - A network error occurred while attempting to retrieve fresh data, but some locally cached - data was available. - - - -
intSTATUS_OK - The operation was successful. - - - -
intSTATUS_OPERATION_IN_FLIGHT - Trying to start a join/create operation while another is already in flight. - - - -
intSTATUS_PARTICIPANT_NOT_CONNECTED - Constant indicating that the ID of the participant provided by the user is not currently - connected to the client in the real-time room. - - - -
intSTATUS_QUEST_NOT_STARTED - This quest is not available yet and cannot be accepted. - - - -
intSTATUS_QUEST_NO_LONGER_AVAILABLE - This quest has expired or the developer has removed, and cannot be accepted. - - - -
intSTATUS_REAL_TIME_CONNECTION_FAILED - Failed to initialize the network connection for a real-time room. - - - -
intSTATUS_REAL_TIME_INACTIVE_ROOM - The room is not currently active. - - - -
intSTATUS_REAL_TIME_MESSAGE_SEND_FAILED - Failed to send message to the peer participant for a real-time room. - - - -
intSTATUS_REAL_TIME_ROOM_NOT_JOINED - Failed to send message to the peer participant for a real-time room, since the user has not - joined the room. - - - -
intSTATUS_REQUEST_TOO_MANY_RECIPIENTS - Sending request failed due to too many recipients. - - - -
intSTATUS_REQUEST_UPDATE_PARTIAL_SUCCESS - Some of the batched network operations succeeded. - - - -
intSTATUS_REQUEST_UPDATE_TOTAL_FAILURE - All of the request update operations attempted failed. - - - -
intSTATUS_SNAPSHOT_COMMIT_FAILED - The attempt to commit the snapshot change failed. - - - -
intSTATUS_SNAPSHOT_CONFLICT - A conflict was detected for the snapshot. - - - -
intSTATUS_SNAPSHOT_CONFLICT_MISSING - The conflict that was being resolved doesn't exist. - - - -
intSTATUS_SNAPSHOT_CONTENTS_UNAVAILABLE - An error occurred while attempting to open the contents of the snapshot. - - - -
intSTATUS_SNAPSHOT_CREATION_FAILED - The attempt to create a snapshot failed. - - - -
intSTATUS_SNAPSHOT_FOLDER_UNAVAILABLE - The root folder for snapshots could not be found or created. - - - -
intSTATUS_SNAPSHOT_NOT_FOUND - The specified snapshot does not exist on the server. - - - -
intSTATUS_TIMEOUT - The operation timed out while awaiting the result. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusString(int statusCode) - -
- Get the string associated with the status code. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATUS_ACHIEVEMENT_NOT_INCREMENTAL -

-
- - - - -
-
- - - - -

Indicates that the call to increment achievement failed since the achievement is not an - incremental achievement. -

- - -
- Constant Value: - - - 3002 - (0x00000bba) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ACHIEVEMENT_UNKNOWN -

-
- - - - -
-
- - - - -

Could not find the achievement, so the operation to update the achievement failed. -

- - -
- Constant Value: - - - 3001 - (0x00000bb9) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ACHIEVEMENT_UNLOCKED -

-
- - - - -
-
- - - - -

Indicates that the incremental achievement was also unlocked when the call was made to - increment the achievement. -

- - -
- Constant Value: - - - 3003 - (0x00000bbb) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ACHIEVEMENT_UNLOCK_FAILURE -

-
- - - - -
-
- - - - -

An incremental achievement cannot be unlocked directly, so the call to unlock achievement - failed. -

- - -
- Constant Value: - - - 3000 - (0x00000bb8) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_APP_MISCONFIGURED -

-
- - - - -
-
- - - - -

The developer has misconfigured their application in some way. The logs will contain more - data about the error and the appropriate resolution. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_CLIENT_RECONNECT_REQUIRED -

-
- - - - -
-
- - - - -

The GoogleApiClient is in an inconsistent state and must reconnect to the service to resolve - the issue. Further calls to the service using the current connection are unlikely to succeed. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_GAME_NOT_FOUND -

-
- - - - -
-
- - - - -

The specified game ID was not recognized by the server. -

- - -
- Constant Value: - - - 9 - (0x00000009) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INTERNAL_ERROR -

-
- - - - -
-
- - - - -

An unspecified error occurred; no more specific information is available. The device logs may - provide additional data. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INTERRUPTED -

-
- - - - -
-
- - - - -

Was interrupted while waiting for the result. Only returned if using a - PendingResult directly. -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INVALID_REAL_TIME_ROOM_ID -

-
- - - - -
-
- - - - -

Constant indicating that the real-time room ID provided to the operation was not valid, or - does not correspond to the currently active real-time room. -

- - -
- Constant Value: - - - 7002 - (0x00001b5a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_LICENSE_CHECK_FAILED -

-
- - - - -
-
- - - - -

The game is not licensed to the user. Further calls will return the same code. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_ALREADY_REMATCHED -

-
- - - - -
-
- - - - -

The specified match has already had a rematch created. Only one rematch may be created for - any initial match. -

- - -
- Constant Value: - - - 6505 - (0x00001969) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_INACTIVE_MATCH -

-
- - - - -
-
- - - - -

The match is not currently active. This action cannot be performed on an inactive match. -

- - -
- Constant Value: - - - 6501 - (0x00001965) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_INVALID_MATCH_RESULTS -

-
- - - - -
-
- - - - -

The match results provided in this API call are invalid. This covers cases of duplicate - results, results for players who are not in the match, etc. -

- - -
- Constant Value: - - - 6504 - (0x00001968) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_INVALID_MATCH_STATE -

-
- - - - -
-
- - - - -

The match is not in the correct state to perform the specified action. -

- - -
- Constant Value: - - - 6502 - (0x00001966) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_INVALID_PARTICIPANT_STATE -

-
- - - - -
-
- - - - -

One or more participants in this match are not in valid states. This could occur if a - specified participant is not actually a participant of the match, or is invalid, or is in an - incorrect state to make the API call. Check the logs for more detailed information. -

- - -
- Constant Value: - - - 6500 - (0x00001964) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_LOCALLY_MODIFIED -

-
- - - - -
-
- - - - -

The specified match has already been modified locally. This operation cannot be performed - until the match has been sent to the server. -

- - -
- Constant Value: - - - 6507 - (0x0000196b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_ERROR_OUT_OF_DATE_VERSION -

-
- - - - -
-
- - - - -

The match data is out of date. Someone else has modified the data on the server, so the - request could not be completed safely. -

- - -
- Constant Value: - - - 6503 - (0x00001967) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MATCH_NOT_FOUND -

-
- - - - -
-
- - - - -

The specified match cannot be found. The provided match ID does not correspond to any known - match. -

- - -
- Constant Value: - - - 6506 - (0x0000196a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MILESTONE_CLAIMED_PREVIOUSLY -

-
- - - - -
-
- - - - -

This quest milestone was previously claimed (on this device or another). -

- - -
- Constant Value: - - - 8000 - (0x00001f40) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MILESTONE_CLAIM_FAILED -

-
- - - - -
-
- - - - -

This quest milestone is not available for claiming. You may want to refresh quests - from the server when this happens, as the local cache is out of sync with the server. -

- - -
- Constant Value: - - - 8001 - (0x00001f41) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MULTIPLAYER_DISABLED -

-
- - - - -
-
- - - - -

This game does not support multiplayer. This could occur if the linked app is not configured - appropriately in the developer console. -

- - -
- Constant Value: - - - 6003 - (0x00001773) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MULTIPLAYER_ERROR_CREATION_NOT_ALLOWED -

-
- - - - -
-
- - - - -

The user is not allowed to create a new multiplayer game at this time. This could occur if - the user has too many outstanding invitations already. -

- - -
- Constant Value: - - - 6000 - (0x00001770) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MULTIPLAYER_ERROR_INVALID_MULTIPLAYER_TYPE -

-
- - - - -
-
- - - - -

The match is not the right type to perform this action on. For example, this error will be - returned when trying to take a turn in a real-time match. -

- - -
- Constant Value: - - - 6002 - (0x00001772) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MULTIPLAYER_ERROR_INVALID_OPERATION -

-
- - - - -
-
- - - - -

This multiplayer operation is not valid, and the server rejected it. Check the logs for more - information. -

- - -
- Constant Value: - - - 6004 - (0x00001774) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_MULTIPLAYER_ERROR_NOT_TRUSTED_TESTER -

-
- - - - -
-
- - - - -

The user attempted to invite another user who was not authorized to see the game. This can - occur if a trusted tester invites a user who is not a trusted tester while the game is - unpublished. In this case, the invitations will not be sent. -

- - -
- Constant Value: - - - 6001 - (0x00001771) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_NO_DATA -

-
- - - - -
-
- - - - -

A network error occurred while attempting to retrieve fresh data, and no data was available - locally. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_OPERATION_DEFERRED -

-
- - - - -
-
- - - - -

A network error occurred while attempting to modify data, but the data was successfully - modified locally and will be updated on the network the next time the device is able to sync. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_OPERATION_FAILED -

-
- - - - -
-
- - - - -

A network error occurred while attempting to perform an operation that requires network - access. The operation may be retried later. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_ERROR_STALE_DATA -

-
- - - - -
-
- - - - -

A network error occurred while attempting to retrieve fresh data, but some locally cached - data was available. The data returned may be stale and/or incomplete. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_OK -

-
- - - - -
-
- - - - -

The operation was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_OPERATION_IN_FLIGHT -

-
- - - - -
-
- - - - -

Trying to start a join/create operation while another is already in flight. -

- - -
- Constant Value: - - - 7007 - (0x00001b5f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_PARTICIPANT_NOT_CONNECTED -

-
- - - - -
-
- - - - -

Constant indicating that the ID of the participant provided by the user is not currently - connected to the client in the real-time room. -

- - -
- Constant Value: - - - 7003 - (0x00001b5b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_QUEST_NOT_STARTED -

-
- - - - -
-
- - - - -

This quest is not available yet and cannot be accepted. -

- - -
- Constant Value: - - - 8003 - (0x00001f43) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_QUEST_NO_LONGER_AVAILABLE -

-
- - - - -
-
- - - - -

This quest has expired or the developer has removed, and cannot be accepted. -

- - -
- Constant Value: - - - 8002 - (0x00001f42) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REAL_TIME_CONNECTION_FAILED -

-
- - - - -
-
- - - - -

Failed to initialize the network connection for a real-time room. -

- - -
- Constant Value: - - - 7000 - (0x00001b58) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REAL_TIME_INACTIVE_ROOM -

-
- - - - -
-
- - - - -

The room is not currently active. This action cannot be performed on an inactive room. -

- - -
- Constant Value: - - - 7005 - (0x00001b5d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REAL_TIME_MESSAGE_SEND_FAILED -

-
- - - - -
-
- - - - -

Failed to send message to the peer participant for a real-time room. -

- - -
- Constant Value: - - - 7001 - (0x00001b59) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REAL_TIME_ROOM_NOT_JOINED -

-
- - - - -
-
- - - - -

Failed to send message to the peer participant for a real-time room, since the user has not - joined the room. -

- - -
- Constant Value: - - - 7004 - (0x00001b5c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REQUEST_TOO_MANY_RECIPIENTS -

-
- - - - -
-
- - - - -

Sending request failed due to too many recipients. -

- - -
- Constant Value: - - - 2002 - (0x000007d2) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REQUEST_UPDATE_PARTIAL_SUCCESS -

-
- - - - -
-
- - - - -

Some of the batched network operations succeeded. -

- - -
- Constant Value: - - - 2000 - (0x000007d0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_REQUEST_UPDATE_TOTAL_FAILURE -

-
- - - - -
-
- - - - -

All of the request update operations attempted failed. Retrying will not fix these errors. -

- - -
- Constant Value: - - - 2001 - (0x000007d1) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_COMMIT_FAILED -

-
- - - - -
-
- - - - -

The attempt to commit the snapshot change failed. See the device logs for more details. -

- - -
- Constant Value: - - - 4003 - (0x00000fa3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_CONFLICT -

-
- - - - -
-
- - - - -

A conflict was detected for the snapshot. Use resolveConflict(GoogleApiClient, String, Snapshot) to resolve - this conflict. -

- - -
- Constant Value: - - - 4004 - (0x00000fa4) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_CONFLICT_MISSING -

-
- - - - -
-
- - - - -

The conflict that was being resolved doesn't exist. This could occur if another device - resolved this conflict first, or if an inappropriate conflict ID was provided to - resolveConflict(GoogleApiClient, String, Snapshot). -

- - -
- Constant Value: - - - 4006 - (0x00000fa6) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_CONTENTS_UNAVAILABLE -

-
- - - - -
-
- - - - -

An error occurred while attempting to open the contents of the snapshot. See the device logs - for more details. -

- - -
- Constant Value: - - - 4002 - (0x00000fa2) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_CREATION_FAILED -

-
- - - - -
-
- - - - -

The attempt to create a snapshot failed. See the device logs for more details. -

- - -
- Constant Value: - - - 4001 - (0x00000fa1) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_FOLDER_UNAVAILABLE -

-
- - - - -
-
- - - - -

The root folder for snapshots could not be found or created. See the device logs for more - details on the failure. -

- - -
- Constant Value: - - - 4005 - (0x00000fa5) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_SNAPSHOT_NOT_FOUND -

-
- - - - -
-
- - - - -

The specified snapshot does not exist on the server. -

- - -
- Constant Value: - - - 4000 - (0x00000fa0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_TIMEOUT -

-
- - - - -
-
- - - - -

The operation timed out while awaiting the result. Only returned if using a - PendingResult directly. -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusString - (int statusCode) -

-
-
- - - -
-
- - - - -

Get the string associated with the status code. This can be used for clearer logging messages - to avoid having to look up error codes.

-
-
Parameters
- - - - -
statusCode - The status code to get the message string for.
-
-
-
Returns
-
  • The string associated with the error code. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Notifications.html b/docs/html/reference/com/google/android/gms/games/Notifications.html deleted file mode 100644 index b2919baa5a90..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Notifications.html +++ /dev/null @@ -1,1534 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Notifications | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Notifications

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Notifications
- - - - - - - -
- - -

Class Overview

-

Entry point for notifications functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intNOTIFICATION_TYPES_ALL - Notification types for any notification. - - - -
intNOTIFICATION_TYPES_MULTIPLAYER - Notification types for multiplayer notifications. - - - -
intNOTIFICATION_TYPE_INVITATION - Notification type for invites to multiplayer games. - - - -
intNOTIFICATION_TYPE_LEVEL_UP - Notification type for level-ups. - - - -
intNOTIFICATION_TYPE_MATCH_UPDATE - Notification type for updates to match information. - - - -
intNOTIFICATION_TYPE_QUEST - Notification type for quests. - - - -
intNOTIFICATION_TYPE_REQUEST - Notification type for requests. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - clear(GoogleApiClient apiClient, int notificationTypes) - -
- Clear the notifications of the specified type for the current game and signed-in player. - - - -
- -
- abstract - - - - - void - - clearAll(GoogleApiClient apiClient) - -
- Clear all notifications for the current game and signed-in player. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPES_ALL -

-
- - - - -
-
- - - - -

Notification types for any notification.

- - -
- Constant Value: - - - 31 - (0x0000001f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPES_MULTIPLAYER -

-
- - - - -
-
- - - - -

Notification types for multiplayer notifications.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPE_INVITATION -

-
- - - - -
-
- - - - -

Notification type for invites to multiplayer games.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPE_LEVEL_UP -

-
- - - - -
-
- - - - -

Notification type for level-ups.

- - -
- Constant Value: - - - 16 - (0x00000010) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPE_MATCH_UPDATE -

-
- - - - -
-
- - - - -

Notification type for updates to match information.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPE_QUEST -

-
- - - - -
-
- - - - -

Notification type for quests.

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NOTIFICATION_TYPE_REQUEST -

-
- - - - -
-
- - - - -

Notification type for requests.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - clear - (GoogleApiClient apiClient, int notificationTypes) -

-
-
- - - -
-
- - - - -

Clear the notifications of the specified type for the current game and signed-in player. This - should be a mask comprised of values from the constants - NOTIFICATION_TYPE_INVITATION, NOTIFICATION_TYPE_MATCH_UPDATE, - NOTIFICATION_TYPES_MULTIPLAYER, and NOTIFICATION_TYPES_ALL. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
notificationTypes - Mask of notification types to clear. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - clearAll - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Clear all notifications for the current game and signed-in player. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/PageDirection.html b/docs/html/reference/com/google/android/gms/games/PageDirection.html deleted file mode 100644 index a1fe3217856c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/PageDirection.html +++ /dev/null @@ -1,1417 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PageDirection | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PageDirection

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.PageDirection
- - - - - - - -
- - -

Class Overview

-

Direction constants for pagination over data sets. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intNEXT - Direction advancing toward the end of the data set. - - - -
intNONE - Constant indicating that no pagination is occurring. - - - -
intPREV - Direction advancing toward the beginning of the data set. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - NEXT -

-
- - - - -
-
- - - - -

Direction advancing toward the end of the data set.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NONE -

-
- - - - -
-
- - - - -

Constant indicating that no pagination is occurring.

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PREV -

-
- - - - -
-
- - - - -

Direction advancing toward the beginning of the data set.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Player.html b/docs/html/reference/com/google/android/gms/games/Player.html deleted file mode 100644 index 1956e2fe5f6e..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Player.html +++ /dev/null @@ -1,2159 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Player | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Player

- - - - - - implements - - Freezable<Player> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Player
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving player information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
longCURRENT_XP_UNKNOWN - Constant indicating that the current XP total for a player is not known. - - - -
longTIMESTAMP_UNKNOWN - Constant indicating that a timestamp for a player is not known. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDisplayName() - -
- Retrieves the display name for this player. - - - -
- -
- abstract - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the player's display name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Uri - - getHiResImageUri() - -
- Retrieves the URI for loading this player's hi-res profile image. - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Retrieves the URI for loading this player's icon-size profile image. - - - -
- -
- abstract - - - - - long - - getLastPlayedWithTimestamp() - -
- Retrieves the timestamp at which this player last played a multiplayer game with the - currently signed in user. - - - -
- -
- abstract - - - - - PlayerLevelInfo - - getLevelInfo() - -
- Retrieves the player level associated information if any exists. - - - -
- -
- abstract - - - - - String - - getPlayerId() - -
- Retrieves the ID of this player. - - - -
- -
- abstract - - - - - long - - getRetrievedTimestamp() - -
- Retrieves the timestamp at which this player record was last updated locally. - - - -
- -
- abstract - - - - - void - - getTitle(CharArrayBuffer dataOut) - -
- Loads the player's title into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getTitle() - -
- Retrieves the title of the player. - - - -
- -
- abstract - - - - - boolean - - hasHiResImage() - -
- Indicates whether this player has a hi-res profile image to display. - - - -
- -
- abstract - - - - - boolean - - hasIconImage() - -
- Indicates whether this player has an icon-size profile image to display. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - long - - CURRENT_XP_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating that the current XP total for a player is not known. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - TIMESTAMP_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating that a timestamp for a player is not known. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the display name for this player.

-
-
Returns
-
  • The player's display name. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the player's display name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI for loading this player's hi-res profile image. Returns null if the player - has no profile image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the player's hi-res profile image, or null if the player has none. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI for loading this player's icon-size profile image. Returns null if the - player has no profile image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the player's icon-size profile image, or null if the player has - none. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getLastPlayedWithTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp at which this player last played a multiplayer game with the - currently signed in user. If the timestamp is not found, this method returns - TIMESTAMP_UNKNOWN.

-
-
Returns
-
  • The timestamp (in ms since epoch) at which the player last played a multiplayer - game with the currently signed in user. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PlayerLevelInfo - - getLevelInfo - () -

-
-
- - - -
-
- - - - -

Retrieves the player level associated information if any exists. If no level information - exists for this player, this method will return null.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPlayerId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this player.

-
-
Returns
-
  • The player ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getRetrievedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp at which this player record was last updated locally.

-
-
Returns
-
  • The timestamp (in ms since epoch) at which the player data was last updated locally. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getTitle - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the player's title into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Retrieves the title of the player. This is based on the player's gameplay activity in apps - using Google Play Games services. Note that not all players have titles, and that a player's - title may change over time.

-
-
Returns
-
  • The player's title, or null if this player has no title. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasHiResImage - () -

-
-
- - - -
-
- - - - -

Indicates whether this player has a hi-res profile image to display.

-
-
Returns
-
  • Whether the player has a hi-res profile image to display. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasIconImage - () -

-
-
- - - -
-
- - - - -

Indicates whether this player has an icon-size profile image to display.

-
-
Returns
-
  • Whether the player has an icon-size profile image to display. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/PlayerBuffer.html b/docs/html/reference/com/google/android/gms/games/PlayerBuffer.html deleted file mode 100644 index b3e01b7c3329..000000000000 --- a/docs/html/reference/com/google/android/gms/games/PlayerBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlayerBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlayerBuffer

- - - - - - - - - extends AbstractDataBuffer<Player>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.Player>
    ↳com.google.android.gms.games.PlayerBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of players. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Player - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Player - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/PlayerEntity.html b/docs/html/reference/com/google/android/gms/games/PlayerEntity.html deleted file mode 100644 index 9a87442db6a1..000000000000 --- a/docs/html/reference/com/google/android/gms/games/PlayerEntity.html +++ /dev/null @@ -1,3020 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlayerEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlayerEntity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Player - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.PlayerEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing a set of Player data. This is immutable, and therefore safe to cache or - store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - From interface -com.google.android.gms.games.Player -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<PlayerEntity>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Player - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - String - - getDisplayName() - -
- Retrieves the display name for this player. - - - -
- -
- - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the player's display name into the given CharArrayBuffer. - - - -
- -
- - - - - - Uri - - getHiResImageUri() - -
- Retrieves the URI for loading this player's hi-res profile image. - - - -
- -
- - - - - - Uri - - getIconImageUri() - -
- Retrieves the URI for loading this player's icon-size profile image. - - - -
- -
- - - - - - long - - getLastPlayedWithTimestamp() - -
- Retrieves the timestamp at which this player last played a multiplayer game with the - currently signed in user. - - - -
- -
- - - - - - PlayerLevelInfo - - getLevelInfo() - -
- Retrieves the player level associated information if any exists. - - - -
- -
- - - - - - String - - getPlayerId() - -
- Retrieves the ID of this player. - - - -
- -
- - - - - - long - - getRetrievedTimestamp() - -
- Retrieves the timestamp at which this player record was last updated locally. - - - -
- -
- - - - - - void - - getTitle(CharArrayBuffer dataOut) - -
- Loads the player's title into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getTitle() - -
- Retrieves the title of the player. - - - -
- -
- - - - - - boolean - - hasHiResImage() - -
- Indicates whether this player has a hi-res profile image to display. - - - -
- -
- - - - - - boolean - - hasIconImage() - -
- Indicates whether this player has an icon-size profile image to display. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.games.Player - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<PlayerEntity> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Player - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the display name for this player.

-
-
Returns
-
  • The player's display name. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the player's display name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI for loading this player's hi-res profile image. Returns null if the player - has no profile image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the player's hi-res profile image, or null if the player has none. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI for loading this player's icon-size profile image. Returns null if the - player has no profile image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the player's icon-size profile image, or null if the player has - none. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLastPlayedWithTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp at which this player last played a multiplayer game with the - currently signed in user. If the timestamp is not found, this method returns - TIMESTAMP_UNKNOWN.

-
-
Returns
-
  • The timestamp (in ms since epoch) at which the player last played a multiplayer - game with the currently signed in user. -
-
- -
-
- - - - -
-

- - public - - - - - PlayerLevelInfo - - getLevelInfo - () -

-
-
- - - -
-
- - - - -

Retrieves the player level associated information if any exists. If no level information - exists for this player, this method will return null.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getPlayerId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this player.

-
-
Returns
-
  • The player ID. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getRetrievedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp at which this player record was last updated locally.

-
-
Returns
-
  • The timestamp (in ms since epoch) at which the player data was last updated locally. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getTitle - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the player's title into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Retrieves the title of the player. This is based on the player's gameplay activity in apps - using Google Play Games services. Note that not all players have titles, and that a player's - title may change over time.

-
-
Returns
-
  • The player's title, or null if this player has no title. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasHiResImage - () -

-
-
- - - -
-
- - - - -

Indicates whether this player has a hi-res profile image to display.

-
-
Returns
-
  • Whether the player has a hi-res profile image to display. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasIconImage - () -

-
-
- - - -
-
- - - - -

Indicates whether this player has an icon-size profile image to display.

-
-
Returns
-
  • Whether the player has an icon-size profile image to display. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/PlayerLevel.html b/docs/html/reference/com/google/android/gms/games/PlayerLevel.html deleted file mode 100644 index f366ac7c645b..000000000000 --- a/docs/html/reference/com/google/android/gms/games/PlayerLevel.html +++ /dev/null @@ -1,1869 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlayerLevel | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlayerLevel

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.PlayerLevel
- - - - - - - -
- - -

Class Overview

-

Data object representing a level a player can obtain in the metagame. -

- A PlayerLevel has three components: a numeric value, and a range of XP totals it - represents. A player is considered a given level if they have at least getMinXp() - and less than getMaxXp(). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - PlayerLevelCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - int - - getLevelNumber() - -
- Returns the number for this level, e.g. - - - -
- -
- - - - - - long - - getMaxXp() - -
- - - - - - long - - getMinXp() - -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - PlayerLevelCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getLevelNumber - () -

-
-
- - - -
-
- - - - -

Returns the number for this level, e.g. "level 10". -

- This is the level that this object represents. For a player to be considered as being of this - level, the value given by getCurrentXpTotal() must fall in the range - [getMinXp(), getMaxXp()).

-
-
Returns
-
  • The level number for this level. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getMaxXp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The maximum XP value represented by this level, exclusive. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getMinXp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The minimum XP value needed to attain this level, inclusive. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/PlayerLevelInfo.html b/docs/html/reference/com/google/android/gms/games/PlayerLevelInfo.html deleted file mode 100644 index 0fba87823185..000000000000 --- a/docs/html/reference/com/google/android/gms/games/PlayerLevelInfo.html +++ /dev/null @@ -1,1942 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlayerLevelInfo | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlayerLevelInfo

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.PlayerLevelInfo
- - - - - - - -
- - -

Class Overview

-

Data object representing the current level information of a player in the metagame. -

- A PlayerLevelInfo has four components: the player's current XP, the timestamp of the - player's last level-up, the player's current level, and the player's next level. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - PlayerLevelInfoCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - PlayerLevel - - getCurrentLevel() - -
- Getter for the player's current level object. - - - -
- -
- - - - - - long - - getCurrentXpTotal() - -
- - - - - - long - - getLastLevelUpTimestamp() - -
- - - - - - PlayerLevel - - getNextLevel() - -
- Getter for the player's next level object. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isMaxLevel() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - PlayerLevelInfoCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - PlayerLevel - - getCurrentLevel - () -

-
-
- - - -
-
- - - - -

Getter for the player's current level object. This object will be the same as the one - returned from getNextLevel() if the player reached the maximum level.

-
-
Returns
-
  • The player's current level object. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - long - - getCurrentXpTotal - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The player's current XP value. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLastLevelUpTimestamp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The timestamp of the player's last level-up. -
-
- -
-
- - - - -
-

- - public - - - - - PlayerLevel - - getNextLevel - () -

-
-
- - - -
-
- - - - -

Getter for the player's next level object. This object will be the same as the one returned - from getCurrentLevel() if the player reached the maximum level.

-
-
Returns
-
  • The player's next level object. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isMaxLevel - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Players.LoadPlayersResult.html b/docs/html/reference/com/google/android/gms/games/Players.LoadPlayersResult.html deleted file mode 100644 index 943b4cb23127..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Players.LoadPlayersResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Players.LoadPlayersResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Players.LoadPlayersResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Players.LoadPlayersResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when player data has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PlayerBuffer - - getPlayers() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PlayerBuffer - - getPlayers - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The player metadata that was requested. This is guaranteed to be non-null, though - it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Players.LoadProfileSettingsResult.html b/docs/html/reference/com/google/android/gms/games/Players.LoadProfileSettingsResult.html deleted file mode 100644 index e2ba1f02b9a8..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Players.LoadProfileSettingsResult.html +++ /dev/null @@ -1,1212 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Players.LoadProfileSettingsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Players.LoadProfileSettingsResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Players.LoadProfileSettingsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when the profile settings of the signed-in player have been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - isProfileVisible() - -
- abstract - - - - - boolean - - isVisibilityExplicitlySet() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - isProfileVisible - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether or not the player's profile information is visible. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isVisibilityExplicitlySet - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether or not this player has explicitly chosen their profile visibility. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/Players.html b/docs/html/reference/com/google/android/gms/games/Players.html deleted file mode 100644 index 97a8c4fa7c25..000000000000 --- a/docs/html/reference/com/google/android/gms/games/Players.html +++ /dev/null @@ -1,1995 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Players | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Players

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.Players
- - - - - - - -
- - -

Class Overview

-

Entry point for player functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfacePlayers.LoadPlayersResult - Result delivered when player data has been loaded.  - - - -
- - - - - interfacePlayers.LoadProfileSettingsResult - Result delivered when the profile settings of the signed-in player have been loaded.  - - - -
- - - - - - - - - - - -
Constants
StringEXTRA_PLAYER_SEARCH_RESULTS - Used by the Player Search UI to return a list of parceled Player objects. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Intent - - getCompareProfileIntent(GoogleApiClient apiClient, Player player) - -
- Returns an intent that will display a screen where the user can compare themselves against - another player's profile. - - - -
- -
- abstract - - - - - Player - - getCurrentPlayer(GoogleApiClient apiClient) - -
- Get the current signed in player, if available. - - - -
- -
- abstract - - - - - String - - getCurrentPlayerId(GoogleApiClient apiClient) - -
- Get the current signed in player ID, if available. - - - -
- -
- abstract - - - - - Intent - - getPlayerSearchIntent(GoogleApiClient apiClient) - -
- Returns an intent that will display a screen where the user can search for people on Google+. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadConnectedPlayers(GoogleApiClient apiClient, boolean forceReload) - -
- Asynchronously loads a list of players that have connected to this game (and that - the user has permission to know about). - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadInvitablePlayers(GoogleApiClient apiClient, int pageSize, boolean forceReload) - -
- Load the initial page of players the currently signed-in player can invite to a multiplayer - game, sorted alphabetically by name. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadMoreInvitablePlayers(GoogleApiClient apiClient, int pageSize) - -
- Asynchronously loads an additional page of invitable players. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadMoreRecentlyPlayedWithPlayers(GoogleApiClient apiClient, int pageSize) - -
- Asynchronously loads an additional page of players that the signed-in player has played - multiplayer games with recently. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadPlayer(GoogleApiClient apiClient, String playerId, boolean forceReload) - -
- Loads the profile for the requested player ID. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadPlayer(GoogleApiClient apiClient, String playerId) - -
- Loads the profile for the requested player ID. - - - -
- -
- abstract - - - - - PendingResult<Players.LoadPlayersResult> - - loadRecentlyPlayedWithPlayers(GoogleApiClient apiClient, int pageSize, boolean forceReload) - -
- Load the initial page of players the currently signed-in player has played multiplayer games - with recently, starting with the most recent. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_PLAYER_SEARCH_RESULTS -

-
- - - - -
-
- - - - -

Used by the Player Search UI to return a list of parceled Player objects. Retrieve with - getParcelableArrayListExtra(String).

-
-
See Also
- -
- - -
- Constant Value: - - - "player_search_results" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Intent - - getCompareProfileIntent - (GoogleApiClient apiClient, Player player) -

-
-
- - - -
-
- - - - -

Returns an intent that will display a screen where the user can compare themselves against - another player's profile. - Note that this must be invoked with startActivityForResult(Intent, int), so - that the identity of the calling package can be established. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to display the player profile. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getCurrentPlayer - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Get the current signed in player, if available. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • Player representing the currently signed in player. May be null if an error - occurred while communicating with the games service. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getCurrentPlayerId - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Get the current signed in player ID, if available. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The player ID for the currently signed in player. May be null if an error occurred - while communicating with the games service. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getPlayerSearchIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns an intent that will display a screen where the user can search for people on Google+. - Note that this must be invoked with startActivityForResult(Intent, int), so - that the identity of the calling package can be established. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected any players from the search results list, the result will be - RESULT_OK, and the data intent will contain a list of parceled Player - objects in EXTRA_PLAYER_SEARCH_RESULTS. -

- Note that the current Player Search UI only allows a single selection, so the returned list - of parceled Player objects will currently contain at most one Player. The Player Search UI - may allow multiple selections in a future release, though. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to display the player selector. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadConnectedPlayers - (GoogleApiClient apiClient, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously loads a list of players that have connected to this game (and that - the user has permission to know about). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadInvitablePlayers - (GoogleApiClient apiClient, int pageSize, boolean forceReload) -

-
-
- - - -
-
- - - - -

Load the initial page of players the currently signed-in player can invite to a multiplayer - game, sorted alphabetically by name. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
pageSize - The number of entries to request for this initial page. Note that if cached - data already exists, the returned buffer may contain more than this size, but it - is guaranteed to contain at least this many if the collection contains enough - records. This must be a value between 1 and 25.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadMoreInvitablePlayers - (GoogleApiClient apiClient, int pageSize) -

-
-
- - - -
-
- - - - -

Asynchronously loads an additional page of invitable players. A new player buffer will be - delivered that includes an extra page of results. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
pageSize - The number of additional entries to request. This must be a value between 1 - and 25.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadMoreRecentlyPlayedWithPlayers - (GoogleApiClient apiClient, int pageSize) -

-
-
- - - -
-
- - - - -

Asynchronously loads an additional page of players that the signed-in player has played - multiplayer games with recently. A new player buffer will be delivered that includes an extra - page of results. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
pageSize - The number of additional entries to request. This must be a value between 1 - and 25.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadPlayer - (GoogleApiClient apiClient, String playerId, boolean forceReload) -

-
-
- - - -
-
- - - - -

Loads the profile for the requested player ID. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
playerId - The player ID to get full profile data for.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadPlayer - (GoogleApiClient apiClient, String playerId) -

-
-
- - - -
-
- - - - -

Loads the profile for the requested player ID. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
playerId - The player ID to get full profile data for.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Players.LoadPlayersResult> - - loadRecentlyPlayedWithPlayers - (GoogleApiClient apiClient, int pageSize, boolean forceReload) -

-
-
- - - -
-
- - - - -

Load the initial page of players the currently signed-in player has played multiplayer games - with recently, starting with the most recent. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
pageSize - The number of entries to request for this initial page. Note that if cached - data already exists, the returned buffer may contain more than this size, but it - is guaranteed to contain at least this many if the collection contains enough - records. This must be a value between 1 and 25.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/Achievement.html b/docs/html/reference/com/google/android/gms/games/achievement/Achievement.html deleted file mode 100644 index c1fe7281014e..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/Achievement.html +++ /dev/null @@ -1,2710 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Achievement | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Achievement

- - - - - - implements - - Freezable<Achievement> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.achievement.Achievement
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving achievement information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATE_HIDDEN - Constant returned by getState() indicating a hidden achievement. - - - -
intSTATE_REVEALED - Constant returned by getState() indicating a revealed achievement. - - - -
intSTATE_UNLOCKED - Constant returned by getState() indicating an unlocked achievement. - - - -
intTYPE_INCREMENTAL - Constant returned by getType() indicating an incremental achievement. - - - -
intTYPE_STANDARD - Constant returned by getType() indicating a standard achievement. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getAchievementId() - -
- Retrieves the ID of this achievement. - - - -
- -
- abstract - - - - - int - - getCurrentSteps() - -
- Retrieves the number of steps this user has gone toward unlocking this achievement; only - applicable for TYPE_INCREMENTAL achievement types. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- Retrieves the description for this achievement. - - - -
- -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the achievement description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - void - - getFormattedCurrentSteps(CharArrayBuffer dataOut) - -
- Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale) into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getFormattedCurrentSteps() - -
- Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale); only applicable for TYPE_INCREMENTAL - achievement types. - - - -
- -
- abstract - - - - - void - - getFormattedTotalSteps(CharArrayBuffer dataOut) - -
- Loads the total number of steps necessary to unlock this achievement (formatted for the - user's locale) into the given CharArrayBuffer; only applicable for - TYPE_INCREMENTAL achievement types. - - - -
- -
- abstract - - - - - String - - getFormattedTotalSteps() - -
- Retrieves the total number of steps necessary to unlock this achievement, formatted for the - user's locale; only applicable for TYPE_INCREMENTAL achievement types. - - - -
- -
- abstract - - - - - long - - getLastUpdatedTimestamp() - -
- Retrieves the timestamp (in millseconds since epoch) at which this achievement was last - updated. - - - -
- -
- abstract - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the achievement name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getName() - -
- Retrieves the name of this achievement. - - - -
- -
- abstract - - - - - Player - - getPlayer() - -
- Retrieves the player information associated with this achievement. - - - -
- -
- abstract - - - - - Uri - - getRevealedImageUri() - -
- Retrieves a URI that can be used to load the achievement's revealed image icon. - - - -
- -
- abstract - - - - - int - - getState() - -
- Retrieves the state of the achievement - one of STATE_UNLOCKED, - STATE_REVEALED, or STATE_HIDDEN. - - - -
- -
- abstract - - - - - int - - getTotalSteps() - -
- Retrieves the total number of steps necessary to unlock this achievement; only applicable for - TYPE_INCREMENTAL achievement types. - - - -
- -
- abstract - - - - - int - - getType() - -
- Retrieves the type of this achievement - one of TYPE_STANDARD or - TYPE_INCREMENTAL. - - - -
- -
- abstract - - - - - Uri - - getUnlockedImageUri() - -
- Retrieves a URI that can be used to load the achievement's unlocked image icon. - - - -
- -
- abstract - - - - - long - - getXpValue() - -
- Retrieves the XP value of this achievement. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATE_HIDDEN -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating a hidden achievement. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_REVEALED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating a revealed achievement. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_UNLOCKED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating an unlocked achievement. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_INCREMENTAL -

-
- - - - -
-
- - - - -

Constant returned by getType() indicating an incremental achievement. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_STANDARD -

-
- - - - -
-
- - - - -

Constant returned by getType() indicating a standard achievement. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getAchievementId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this achievement.

-
-
Returns
-
  • The achievement ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getCurrentSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement; only - applicable for TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The number of steps this user has gone toward unlocking this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this achievement.

-
-
Returns
-
  • The achievement description. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the achievement description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getFormattedCurrentSteps - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale) into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getFormattedCurrentSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale); only applicable for TYPE_INCREMENTAL - achievement types.

-
-
Returns
-
  • The formatted number of steps this user has gone toward unlocking this achievement, -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getFormattedTotalSteps - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the total number of steps necessary to unlock this achievement (formatted for the - user's locale) into the given CharArrayBuffer; only applicable for - TYPE_INCREMENTAL achievement types.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getFormattedTotalSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the total number of steps necessary to unlock this achievement, formatted for the - user's locale; only applicable for TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The total number of steps necessary to unlock this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in millseconds since epoch) at which this achievement was last - updated. If the achievement has never been updated, this will return -1.

-
-
Returns
-
  • Timestamp at which this achievement was last updated. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the achievement name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this achievement.

-
-
Returns
-
  • The achievement name. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Retrieves the player information associated with this achievement. -

- Note that this object is a volatile representation, so it is not safe to cache the output of - this directly. Instead, cache the result of freeze().

-
-
Returns
-
  • The player associated with this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getRevealedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the achievement's revealed image icon. Returns null - if the achievement has no revealed image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's revealed image icon, or null if the achievement - has no revealed image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the achievement - one of STATE_UNLOCKED, - STATE_REVEALED, or STATE_HIDDEN.

-
-
Returns
-
  • The state of this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getTotalSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the total number of steps necessary to unlock this achievement; only applicable for - TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The total number of steps necessary to unlock this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getType - () -

-
-
- - - -
-
- - - - -

Retrieves the type of this achievement - one of TYPE_STANDARD or - TYPE_INCREMENTAL.

-
-
Returns
-
  • The type of this achievement. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getUnlockedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the achievement's unlocked image icon. Returns null - if the achievement has no unlocked image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's unlocked image icon, or null if the achievement - has no unlocked image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getXpValue - () -

-
-
- - - -
-
- - - - -

Retrieves the XP value of this achievement.

-
-
Returns
-
  • XP value given to players for unlocking this achievement. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/AchievementBuffer.html b/docs/html/reference/com/google/android/gms/games/achievement/AchievementBuffer.html deleted file mode 100644 index 4118d7a85702..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/AchievementBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AchievementBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AchievementBuffer

- - - - - - - - - extends AbstractDataBuffer<Achievement>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.achievement.Achievement>
    ↳com.google.android.gms.games.achievement.AchievementBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of achievements. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Achievement - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Achievement - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/AchievementEntity.html b/docs/html/reference/com/google/android/gms/games/achievement/AchievementEntity.html deleted file mode 100644 index 7cd8e9955be5..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/AchievementEntity.html +++ /dev/null @@ -1,3689 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AchievementEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AchievementEntity

- - - - - extends Object
- - - - - - - implements - - Achievement - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.achievement.AchievementEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing a set of Achievement data. This is immutable, and therefore safe to - cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.achievement.Achievement -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AchievementEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Achievement - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - String - - getAchievementId() - -
- Retrieves the ID of this achievement. - - - -
- -
- - - - - - int - - getCurrentSteps() - -
- Retrieves the number of steps this user has gone toward unlocking this achievement; only - applicable for TYPE_INCREMENTAL achievement types. - - - -
- -
- - - - - - String - - getDescription() - -
- Retrieves the description for this achievement. - - - -
- -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the achievement description into the given CharArrayBuffer. - - - -
- -
- - - - - - void - - getFormattedCurrentSteps(CharArrayBuffer dataOut) - -
- Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale) into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getFormattedCurrentSteps() - -
- Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale); only applicable for TYPE_INCREMENTAL - achievement types. - - - -
- -
- - - - - - void - - getFormattedTotalSteps(CharArrayBuffer dataOut) - -
- Loads the total number of steps necessary to unlock this achievement (formatted for the - user's locale) into the given CharArrayBuffer; only applicable for - TYPE_INCREMENTAL achievement types. - - - -
- -
- - - - - - String - - getFormattedTotalSteps() - -
- Retrieves the total number of steps necessary to unlock this achievement, formatted for the - user's locale; only applicable for TYPE_INCREMENTAL achievement types. - - - -
- -
- - - - - - long - - getLastUpdatedTimestamp() - -
- Retrieves the timestamp (in millseconds since epoch) at which this achievement was last - updated. - - - -
- -
- - - - - - String - - getName() - -
- Retrieves the name of this achievement. - - - -
- -
- - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the achievement name into the given CharArrayBuffer. - - - -
- -
- - - - - - Player - - getPlayer() - -
- Retrieves the player information associated with this achievement. - - - -
- -
- - - - - - Uri - - getRevealedImageUri() - -
- Retrieves a URI that can be used to load the achievement's revealed image icon. - - - -
- -
- - - - - - String - - getRevealedImageUrl() - -
- - - - - - int - - getState() - -
- Retrieves the state of the achievement - one of STATE_UNLOCKED, - STATE_REVEALED, or STATE_HIDDEN. - - - -
- -
- - - - - - int - - getTotalSteps() - -
- Retrieves the total number of steps necessary to unlock this achievement; only applicable for - TYPE_INCREMENTAL achievement types. - - - -
- -
- - - - - - int - - getType() - -
- Retrieves the type of this achievement - one of TYPE_STANDARD or - TYPE_INCREMENTAL. - - - -
- -
- - - - - - Uri - - getUnlockedImageUri() - -
- Retrieves a URI that can be used to load the achievement's unlocked image icon. - - - -
- -
- - - - - - String - - getUnlockedImageUrl() - -
- - - - - - long - - getXpValue() - -
- Retrieves the XP value of this achievement. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.achievement.Achievement - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AchievementEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Achievement - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAchievementId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this achievement.

-
-
Returns
-
  • The achievement ID. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCurrentSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement; only - applicable for TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The number of steps this user has gone toward unlocking this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this achievement.

-
-
Returns
-
  • The achievement description. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the achievement description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getFormattedCurrentSteps - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale) into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getFormattedCurrentSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the number of steps this user has gone toward unlocking this achievement (formatted - for the user's locale); only applicable for TYPE_INCREMENTAL - achievement types.

-
-
Returns
-
  • The formatted number of steps this user has gone toward unlocking this achievement, -
-
- -
-
- - - - -
-

- - public - - - - - void - - getFormattedTotalSteps - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the total number of steps necessary to unlock this achievement (formatted for the - user's locale) into the given CharArrayBuffer; only applicable for - TYPE_INCREMENTAL achievement types.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getFormattedTotalSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the total number of steps necessary to unlock this achievement, formatted for the - user's locale; only applicable for TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The total number of steps necessary to unlock this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in millseconds since epoch) at which this achievement was last - updated. If the achievement has never been updated, this will return -1.

-
-
Returns
-
  • Timestamp at which this achievement was last updated. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this achievement.

-
-
Returns
-
  • The achievement name. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the achievement name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Retrieves the player information associated with this achievement. -

- Note that this object is a volatile representation, so it is not safe to cache the output of - this directly. Instead, cache the result of freeze().

-
-
Returns
-
  • The player associated with this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getRevealedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the achievement's revealed image icon. Returns null - if the achievement has no revealed image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's revealed image icon, or null if the achievement - has no revealed image. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getRevealedImageUrl - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the achievement - one of STATE_UNLOCKED, - STATE_REVEALED, or STATE_HIDDEN.

-
-
Returns
-
  • The state of this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getTotalSteps - () -

-
-
- - - -
-
- - - - -

Retrieves the total number of steps necessary to unlock this achievement; only applicable for - TYPE_INCREMENTAL achievement types.

-
-
Returns
-
  • The total number of steps necessary to unlock this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Retrieves the type of this achievement - one of TYPE_STANDARD or - TYPE_INCREMENTAL.

-
-
Returns
-
  • The type of this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getUnlockedImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the achievement's unlocked image icon. Returns null - if the achievement has no unlocked image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's unlocked image icon, or null if the achievement - has no unlocked image. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getUnlockedImageUrl - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - long - - getXpValue - () -

-
-
- - - -
-
- - - - -

Retrieves the XP value of this achievement.

-
-
Returns
-
  • XP value given to players for unlocking this achievement. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.LoadAchievementsResult.html b/docs/html/reference/com/google/android/gms/games/achievement/Achievements.LoadAchievementsResult.html deleted file mode 100644 index d5dd9e8aa57d..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.LoadAchievementsResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Achievements.LoadAchievementsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Achievements.LoadAchievementsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.achievement.Achievements.LoadAchievementsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when achievement data has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - AchievementBuffer - - getAchievements() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - AchievementBuffer - - getAchievements - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The achievement data that was requested. This is guaranteed to be non-null, - though it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.UpdateAchievementResult.html b/docs/html/reference/com/google/android/gms/games/achievement/Achievements.UpdateAchievementResult.html deleted file mode 100644 index db535ab9beda..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.UpdateAchievementResult.html +++ /dev/null @@ -1,1177 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Achievements.UpdateAchievementResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Achievements.UpdateAchievementResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.achievement.Achievements.UpdateAchievementResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when achievement data has been updated (revealed, unlocked - or incremented). -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getAchievementId() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getAchievementId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the achievement that was updated. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.html b/docs/html/reference/com/google/android/gms/games/achievement/Achievements.html deleted file mode 100644 index 6484f3b38351..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/Achievements.html +++ /dev/null @@ -1,1881 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Achievements | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Achievements

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.achievement.Achievements
- - - - - - - -
- - -

Class Overview

-

Entry point for achievements functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceAchievements.LoadAchievementsResult - Result delivered when achievement data has been loaded.  - - - -
- - - - - interfaceAchievements.UpdateAchievementResult - Result delivered when achievement data has been updated (revealed, unlocked - or incremented).  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Intent - - getAchievementsIntent(GoogleApiClient apiClient) - -
- Gets an intent to show the list of achievements for a game. - - - -
- -
- abstract - - - - - void - - increment(GoogleApiClient apiClient, String id, int numSteps) - -
- Increments an achievement by the given number of steps. - - - -
- -
- abstract - - - - - PendingResult<Achievements.UpdateAchievementResult> - - incrementImmediate(GoogleApiClient apiClient, String id, int numSteps) - -
- Increments an achievement by the given number of steps. - - - -
- -
- abstract - - - - - PendingResult<Achievements.LoadAchievementsResult> - - load(GoogleApiClient apiClient, boolean forceReload) - -
- Asynchronously load achievement data for the currently signed in player. - - - -
- -
- abstract - - - - - void - - reveal(GoogleApiClient apiClient, String id) - -
- Reveal a hidden achievement to the currently signed in player. - - - -
- -
- abstract - - - - - PendingResult<Achievements.UpdateAchievementResult> - - revealImmediate(GoogleApiClient apiClient, String id) - -
- Reveal a hidden achievement to the currently signed in player. - - - -
- -
- abstract - - - - - void - - setSteps(GoogleApiClient apiClient, String id, int numSteps) - -
- Set an achievement to have at least the given number of steps completed. - - - -
- -
- abstract - - - - - PendingResult<Achievements.UpdateAchievementResult> - - setStepsImmediate(GoogleApiClient apiClient, String id, int numSteps) - -
- Set an achievement to have at least the given number of steps completed. - - - -
- -
- abstract - - - - - void - - unlock(GoogleApiClient apiClient, String id) - -
- Unlock an achievement for the currently signed in player. - - - -
- -
- abstract - - - - - PendingResult<Achievements.UpdateAchievementResult> - - unlockImmediate(GoogleApiClient apiClient, String id) - -
- Unlock an achievement for the currently signed in player. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Intent - - getAchievementsIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets an intent to show the list of achievements for a game. Note that this must be invoked - with startActivityForResult(Intent, int), so that the identity of the - calling package can be established. -

- A RESULT_RECONNECT_REQUIRED may be returned as the - resultCode in onActivityResult(int, int, Intent) if the GoogleApiClient ends up in an - inconsistent state. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the currently signed in player's - achievements. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - increment - (GoogleApiClient apiClient, String id, int numSteps) -

-
-
- - - -
-
- - - - -

Increments an achievement by the given number of steps. The achievement must be an - incremental achievement. Once an achievement reaches at least the maximum number of steps, it - will be unlocked automatically. Any further increments will be ignored. -

- This is the fire-and-forget form of the API. Use this form if you don't need to know the - status of the operation immediately. For most applications, this will be the preferred API to - use, though note that the update may not be sent to the server until the next sync. See - incrementImmediate(GoogleApiClient, String, int) if you need the operation to attempt to communicate to the server - immediately or need to have the status code delivered to your application. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The achievement ID to increment.
numSteps - The number of steps to increment by. Must be greater than 0. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Achievements.UpdateAchievementResult> - - incrementImmediate - (GoogleApiClient apiClient, String id, int numSteps) -

-
-
- - - -
-
- - - - -

Increments an achievement by the given number of steps. The achievement must be an - incremental achievement. Once an achievement reaches at least the maximum number of steps, it - will be unlocked automatically. Any further increments will be ignored. -

- This form of the API will attempt to update the user's achievement on the server immediately, - and will return a GamesPendingResult that can be used to retrieve the result. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The ID of the achievement to increment.
numSteps - The number of steps to increment by. Must be greater than 0.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Achievements.LoadAchievementsResult> - - load - (GoogleApiClient apiClient, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load achievement data for the currently signed in player. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - reveal - (GoogleApiClient apiClient, String id) -

-
-
- - - -
-
- - - - -

Reveal a hidden achievement to the currently signed in player. If the achievement has already - been unlocked, this will have no effect. -

- This is the fire-and-forget form of the API. Use this form if you don't need to know the - status of the operation immediately. For most applications, this will be the preferred API to - use, though note that the update may not be sent to the server until the next sync. See - revealImmediate(GoogleApiClient, String) if you need the operation to attempt to communicate to the server - immediately or need to have the status code delivered to your application. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The achievement ID to reveal
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Achievements.UpdateAchievementResult> - - revealImmediate - (GoogleApiClient apiClient, String id) -

-
-
- - - -
-
- - - - -

Reveal a hidden achievement to the currently signed in player. If the achievement is already - visible, this will have no effect. -

- This form of the API will attempt to update the user's achievement on the server immediately, - and will return a GamesPendingResult that can be used to retrieve the result. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The ID of the achievement to reveal
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - setSteps - (GoogleApiClient apiClient, String id, int numSteps) -

-
-
- - - -
-
- - - - -

Set an achievement to have at least the given number of steps completed. Calling this method - while the achievement already has more steps than the provided value is a no-op. Once the - achievement reaches the maximum number of steps, the achievement will automatically be - unlocked, and any further mutation operations will be ignored. -

- This is the fire-and-forget form of the API. Use this form if you don't need to know the - status of the operation immediately. For most applications, this will be the preferred API to - use, though note that the update may not be sent to the server until the next sync. See - setStepsImmediate(GoogleApiClient, String, int) if you need the operation to attempt to communicate to the server - immediately or need to have the status code delivered to your application. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The ID of the achievement to modify.
numSteps - The number of steps to set the achievement to. Must be greater than 0. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Achievements.UpdateAchievementResult> - - setStepsImmediate - (GoogleApiClient apiClient, String id, int numSteps) -

-
-
- - - -
-
- - - - -

Set an achievement to have at least the given number of steps completed. Calling this method - while the achievement already has more steps than the provided value is a no-op. Once the - achievement reaches the maximum number of steps, the achievement will automatically be - unlocked, and any further mutation operations will be ignored. -

- This form of the API will attempt to update the user's achievement on the server immediately, - and will return a GamesPendingResult that can be used to retrieve the result. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The ID of the achievement to modify.
numSteps - The number of steps to set the achievement to. Must be greater than 0.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - unlock - (GoogleApiClient apiClient, String id) -

-
-
- - - -
-
- - - - -

Unlock an achievement for the currently signed in player. If the achievement is hidden this - will reveal it to the player. -

- This is the fire-and-forget form of the API. Use this form if you don't need to know the - status of the operation immediately. For most applications, this will be the preferred API to - use, though note that the update may not be sent to the server until the next sync. See - unlockImmediate(GoogleApiClient, String) if you need the operation to attempt to communicate to the server - immediately or need to have the status code delivered to your application. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The achievement ID to unlock
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Achievements.UpdateAchievementResult> - - unlockImmediate - (GoogleApiClient apiClient, String id) -

-
-
- - - -
-
- - - - -

Unlock an achievement for the currently signed in player. If the achievement is hidden this - will reveal it to the player. -

- This form of the API will attempt to update the user's achievement on the server immediately, - and will return a GamesPendingResult that can be used to retrieve the result. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
id - The ID of the achievement to unlock.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/achievement/package-summary.html b/docs/html/reference/com/google/android/gms/games/achievement/package-summary.html deleted file mode 100644 index 5523e927e1a3..000000000000 --- a/docs/html/reference/com/google/android/gms/games/achievement/package-summary.html +++ /dev/null @@ -1,956 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.achievement | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.achievement

-
- -
- -
- - -
- Contains classes for loading and updating achievements. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Achievement - Data interface for retrieving achievement information.  - - - -
Achievements - Entry point for achievements functionality.  - - - -
Achievements.LoadAchievementsResult - Result delivered when achievement data has been loaded.  - - - -
Achievements.UpdateAchievementResult - Result delivered when achievement data has been updated (revealed, unlocked - or incremented).  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - -
AchievementBuffer - Data structure providing access to a list of achievements.  - - - -
AchievementEntity - Data object representing a set of Achievement data.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/Event.html b/docs/html/reference/com/google/android/gms/games/event/Event.html deleted file mode 100644 index 41367ba6c2a6..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/Event.html +++ /dev/null @@ -1,1974 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Event | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Event

- - - - - - implements - - Freezable<Event> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.event.Event
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving event information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDescription() - -
- Retrieves the description for this event. - - - -
- -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the event description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getEventId() - -
- Retrieves the ID of this event. - - - -
- -
- abstract - - - - - String - - getFormattedValue() - -
- Retrieves the sum of increments have been made to this event (formatted for the user's - locale). - - - -
- -
- abstract - - - - - void - - getFormattedValue(CharArrayBuffer dataOut) - -
- Retrieves the sum of increments have been made to this event (formatted - for the user's locale). - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Retrieves a URI that can be used to load the event's image icon. - - - -
- -
- abstract - - - - - String - - getName() - -
- Retrieves the name of this event. - - - -
- -
- abstract - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the event name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Player - - getPlayer() - -
- Retrieves the player information associated with this event. - - - -
- -
- abstract - - - - - long - - getValue() - -
- Retrieves the number of increments this user has made to this event. - - - -
- -
- abstract - - - - - boolean - - isVisible() - -
- Retrieves whether the event should be displayed to the user in any event related UIs. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this event.

-
-
Returns
-
  • The event description. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the event description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getEventId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this event.

-
-
Returns
-
  • The event ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getFormattedValue - () -

-
-
- - - -
-
- - - - -

Retrieves the sum of increments have been made to this event (formatted for the user's - locale).

-
-
Returns
-
  • The formatted number of increments this user has made to this event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getFormattedValue - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Retrieves the sum of increments have been made to this event (formatted - for the user's locale).

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the event's image icon. Returns null if the event - has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's unlocked image icon, or null if the achievement - has no unlocked image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this event.

-
-
Returns
-
  • The event name. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the event name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Retrieves the player information associated with this event. -

- Note that this object is a volatile representation, so it is not safe to cache the output of - this directly. Instead, cache the result of freeze().

-
-
Returns
-
  • The player associated with this event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getValue - () -

-
-
- - - -
-
- - - - -

Retrieves the number of increments this user has made to this event.

-
-
Returns
-
  • The number of increments this user has made to this event. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Retrieves whether the event should be displayed to the user in any event related UIs.

-
-
Returns
-
  • Whether to display the event to the user. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/EventBuffer.html b/docs/html/reference/com/google/android/gms/games/event/EventBuffer.html deleted file mode 100644 index a48456609114..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/EventBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -EventBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

EventBuffer

- - - - - - - - - extends AbstractDataBuffer<Event>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.event.Event>
    ↳com.google.android.gms.games.event.EventBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of events. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Event - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Event - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/EventEntity.html b/docs/html/reference/com/google/android/gms/games/event/EventEntity.html deleted file mode 100644 index 707964a6fc45..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/EventEntity.html +++ /dev/null @@ -1,3005 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -EventEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

EventEntity

- - - - - extends Object
- - - - - - - implements - - Event - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.event.EventEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a event. This is immutable, and therefore safe - to cache or store. Note, however, that the data it represents may grow stale. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - EventEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - EventEntity(Event event) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Event - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - String - - getDescription() - -
- Retrieves the description for this event. - - - -
- -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the event description into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getEventId() - -
- Retrieves the ID of this event. - - - -
- -
- - - - - - String - - getFormattedValue() - -
- Retrieves the sum of increments have been made to this event (formatted for the user's - locale). - - - -
- -
- - - - - - void - - getFormattedValue(CharArrayBuffer dataOut) - -
- Retrieves the sum of increments have been made to this event (formatted - for the user's locale). - - - -
- -
- - - - - - Uri - - getIconImageUri() - -
- Retrieves a URI that can be used to load the event's image icon. - - - -
- -
- - - - - - String - - getIconImageUrl() - -
- - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the event name into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getName() - -
- Retrieves the name of this event. - - - -
- -
- - - - - - Player - - getPlayer() - -
- Retrieves the player information associated with this event. - - - -
- -
- - - - - - long - - getValue() - -
- Retrieves the number of increments this user has made to this event. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Retrieves whether the event should be displayed to the user in any event related UIs. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.event.Event - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - EventEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - EventEntity - (Event event) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Event - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this event.

-
-
Returns
-
  • The event description. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the event description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEventId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this event.

-
-
Returns
-
  • The event ID. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getFormattedValue - () -

-
-
- - - -
-
- - - - -

Retrieves the sum of increments have been made to this event (formatted for the user's - locale).

-
-
Returns
-
  • The formatted number of increments this user has made to this event. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getFormattedValue - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Retrieves the sum of increments have been made to this event (formatted - for the user's locale).

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the event's image icon. Returns null if the event - has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The image URI for the achievement's unlocked image icon, or null if the achievement - has no unlocked image. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getIconImageUrl - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the event name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this event.

-
-
Returns
-
  • The event name. -
-
- -
-
- - - - -
-

- - public - - - - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Retrieves the player information associated with this event. -

- Note that this object is a volatile representation, so it is not safe to cache the output of - this directly. Instead, cache the result of freeze().

-
-
Returns
-
  • The player associated with this event. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getValue - () -

-
-
- - - -
-
- - - - -

Retrieves the number of increments this user has made to this event.

-
-
Returns
-
  • The number of increments this user has made to this event. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Retrieves whether the event should be displayed to the user in any event related UIs.

-
-
Returns
-
  • Whether to display the event to the user. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/Events.LoadEventsResult.html b/docs/html/reference/com/google/android/gms/games/event/Events.LoadEventsResult.html deleted file mode 100644 index 0b5947922166..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/Events.LoadEventsResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Events.LoadEventsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Events.LoadEventsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.event.Events.LoadEventsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when event data has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - EventBuffer - - getEvents() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - EventBuffer - - getEvents - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The event data that was requested. This is guaranteed to be non-null, - though it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/Events.html b/docs/html/reference/com/google/android/gms/games/event/Events.html deleted file mode 100644 index 73d0be70ac29..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/Events.html +++ /dev/null @@ -1,1270 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Events | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Events

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.event.Events
- - - - - - - -
- - -

Class Overview

-

Entry point for events functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceEvents.LoadEventsResult - Result delivered when event data has been loaded.  - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - increment(GoogleApiClient apiClient, String eventId, int incrementAmount) - -
- Increments an event by the given number of steps. - - - -
- -
- abstract - - - - - PendingResult<Events.LoadEventsResult> - - load(GoogleApiClient apiClient, boolean forceReload) - -
- Asynchronously load event data for the currently signed in player. - - - -
- -
- abstract - - - - - PendingResult<Events.LoadEventsResult> - - loadByIds(GoogleApiClient apiClient, boolean forceReload, String... eventIds) - -
- Asynchronously load event data for specified event IDs. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - increment - (GoogleApiClient apiClient, String eventId, int incrementAmount) -

-
-
- - - -
-
- - - - -

Increments an event by the given number of steps. -

- This is the fire-and-forget API. Event increments are cached locally and flushed to the - server in batches. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
eventId - The event ID to increment.
incrementAmount - The amount increment by. Must be greater than or equal to 0. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Events.LoadEventsResult> - - load - (GoogleApiClient apiClient, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load event data for the currently signed in player. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Events.LoadEventsResult> - - loadByIds - (GoogleApiClient apiClient, boolean forceReload, String... eventIds) -

-
-
- - - -
-
- - - - -

Asynchronously load event data for specified event IDs. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
eventIds - The IDs of the events to load.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/event/package-summary.html b/docs/html/reference/com/google/android/gms/games/event/package-summary.html deleted file mode 100644 index 07bb9fd252e4..000000000000 --- a/docs/html/reference/com/google/android/gms/games/event/package-summary.html +++ /dev/null @@ -1,939 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.event | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.event

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - -
Event - Data interface for retrieving event information.  - - - -
Events - Entry point for events functionality.  - - - -
Events.LoadEventsResult - Result delivered when event data has been loaded.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - -
EventBuffer - Data structure providing access to a list of events.  - - - -
EventEntity - Data object representing the data for a event.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboard.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboard.html deleted file mode 100644 index 668d2cd0ed03..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboard.html +++ /dev/null @@ -1,1618 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboard | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Leaderboard

- - - - - - implements - - Freezable<Leaderboard> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboard
- - - - - - - -
- - -

Class Overview

-

Data interface for leaderboard metadata. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSCORE_ORDER_LARGER_IS_BETTER - Score order constant for leaderboards where scores are sorted in descending order. - - - -
intSCORE_ORDER_SMALLER_IS_BETTER - Score order constant for leaderboards where scores are sorted in ascending order. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDisplayName() - -
- Retrieves the display name of this leaderboard. - - - -
- -
- abstract - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads this leaderboard's display name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Retrieves an image URI that can be used to load this leaderboard's icon, or null if there was - a problem retrieving the icon. - - - -
- -
- abstract - - - - - String - - getLeaderboardId() - -
- Retrieves the ID of this leaderboard. - - - -
- -
- abstract - - - - - int - - getScoreOrder() - -
- Retrieves the sort order of scores for this leaderboard. - - - -
- -
- abstract - - - - - ArrayList<LeaderboardVariant> - - getVariants() - -
- Retrieves the LeaderboardVariants for this leaderboard. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - SCORE_ORDER_LARGER_IS_BETTER -

-
- - - - -
-
- - - - -

Score order constant for leaderboards where scores are sorted in descending order. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SCORE_ORDER_SMALLER_IS_BETTER -

-
- - - - -
-
- - - - -

Score order constant for leaderboards where scores are sorted in ascending order. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the display name of this leaderboard.

-
-
Returns
-
  • Display name of this leaderboard. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads this leaderboard's display name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load this leaderboard's icon, or null if there was - a problem retrieving the icon. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load this leaderboard's icon, or null if there was a - problem retrieving the icon. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getLeaderboardId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this leaderboard.

-
-
Returns
-
  • The ID of this leaderboard. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getScoreOrder - () -

-
-
- - - -
-
- - - - -

Retrieves the sort order of scores for this leaderboard. Possible values are - SCORE_ORDER_LARGER_IS_BETTER or SCORE_ORDER_SMALLER_IS_BETTER.

-
-
Returns
-
  • The score order used by this leaderboard. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ArrayList<LeaderboardVariant> - - getVariants - () -

-
-
- - - -
-
- - - - -

Retrieves the LeaderboardVariants for this leaderboard. These will be returned - sorted by time span first, then by variant type. -

- Note that these variants are volatile, and are tied to the lifetime of the original buffer.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer.html b/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer.html deleted file mode 100644 index 3ac9ae611e89..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer.html +++ /dev/null @@ -1,1864 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LeaderboardBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LeaderboardBuffer

- - - - - - - - - extends AbstractDataBuffer<Leaderboard>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.leaderboard.Leaderboard>
    ↳com.google.android.gms.games.leaderboard.LeaderboardBuffer
- - - - - - - -
- - -

Class Overview

-

EntityBuffer containing Leaderboard data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - Leaderboard - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - Leaderboard - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScore.html b/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScore.html deleted file mode 100644 index eb76e22136e6..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScore.html +++ /dev/null @@ -1,2007 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LeaderboardScore | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

LeaderboardScore

- - - - - - implements - - Freezable<LeaderboardScore> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.LeaderboardScore
- - - - - - - -
- - -

Class Overview

-

Data interface representing a single score on a leaderboard. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intLEADERBOARD_RANK_UNKNOWN - Constant indicating that the score holder's rank was not known. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - getDisplayRank(CharArrayBuffer dataOut) - -
- Load the formatted display rank into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getDisplayRank() - -
- Retrieves a formatted string to display for this rank. - - - -
- -
- abstract - - - - - String - - getDisplayScore() - -
- Retrieves a formatted string to display for this score. - - - -
- -
- abstract - - - - - void - - getDisplayScore(CharArrayBuffer dataOut) - -
- Loads the formatted display score into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - long - - getRank() - -
- Retrieves the rank returned from the server for this score. - - - -
- -
- abstract - - - - - long - - getRawScore() - -
- Retrieves the raw score value. - - - -
- -
- abstract - - - - - Player - - getScoreHolder() - -
- Retrieves the player that scored this particular score. - - - -
- -
- abstract - - - - - void - - getScoreHolderDisplayName(CharArrayBuffer dataOut) - -
- Load the display name of the player who scored this score into the provided - CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getScoreHolderDisplayName() - -
- Retrieves the name to display for the player who scored this score. - - - -
- -
- abstract - - - - - Uri - - getScoreHolderHiResImageUri() - -
- Retrieves the URI of the hi-res image to display for the player who scored this score. - - - -
- -
- abstract - - - - - Uri - - getScoreHolderIconImageUri() - -
- Retrieves the URI of the icon image to display for the player who scored this score. - - - -
- -
- abstract - - - - - String - - getScoreTag() - -
- Retrieve the optional score tag associated with this score, if any. - - - -
- -
- abstract - - - - - long - - getTimestampMillis() - -
- Retrieves the timestamp (in milliseconds from epoch) at which this score was achieved. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - LEADERBOARD_RANK_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating that the score holder's rank was not known. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - getDisplayRank - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Load the formatted display rank into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayRank - () -

-
-
- - - -
-
- - - - -

Retrieves a formatted string to display for this rank. This handles appropriate localization - and formatting.

-
-
Returns
-
  • Formatted string to display. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayScore - () -

-
-
- - - -
-
- - - - -

Retrieves a formatted string to display for this score. The details of the formatting are - specified by the developer in their dev console.

-
-
Returns
-
  • Formatted string to display. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDisplayScore - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the formatted display score into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getRank - () -

-
-
- - - -
-
- - - - -

Retrieves the rank returned from the server for this score. Note that this may not be exact - and that multiple scores can have identical ranks. Lower ranks indicate a better score, with - rank 1 being the best score on the board. -

- If the score holder's rank cannot be determined, this will return - LEADERBOARD_RANK_UNKNOWN.

-
-
Returns
-
  • Rank of score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getRawScore - () -

-
-
- - - -
-
- - - - -

Retrieves the raw score value.

-
-
Returns
-
  • The raw score value. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getScoreHolder - () -

-
-
- - - -
-
- - - - -

Retrieves the player that scored this particular score. The return value here may be null if - the current player is not authorized to see information about the holder of this score. -

- Note that this object is a volatile representation, so it is not safe to cache the output of - this directly. Instead, cache the result of freeze().

-
-
Returns
-
  • The player associated with this leaderboard score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getScoreHolderDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Load the display name of the player who scored this score into the provided - CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getScoreHolderDisplayName - () -

-
-
- - - -
-
- - - - -

Retrieves the name to display for the player who scored this score. If the identity of the - player is unknown, this will return an anonymous name to display.

-
-
Returns
-
  • The display name of the holder of this score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getScoreHolderHiResImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI of the hi-res image to display for the player who scored this score. If the - identity of the player is unknown, this will return null. It may also be null if the player - simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the hi-res image to display for this score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getScoreHolderIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves the URI of the icon image to display for the player who scored this score. If the - identity of the player is unknown, this will return an anonymous image for the player. It may - also be null if the player simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the icon image to display for this score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getScoreTag - () -

-
-
- - - -
-
- - - - -

Retrieve the optional score tag associated with this score, if any.

-
-
Returns
-
  • The score tag associated with this score. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getTimestampMillis - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds from epoch) at which this score was achieved.

-
-
Returns
-
  • Timestamp when this score was achieved. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScoreBuffer.html b/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScoreBuffer.html deleted file mode 100644 index c48ed88065ad..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardScoreBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LeaderboardScoreBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LeaderboardScoreBuffer

- - - - - - - - - extends AbstractDataBuffer<LeaderboardScore>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.leaderboard.LeaderboardScore>
    ↳com.google.android.gms.games.leaderboard.LeaderboardScoreBuffer
- - - - - - - -
- - -

Class Overview

-

AbstractDataBuffer containing LeaderboardScore data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LeaderboardScore - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LeaderboardScore - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardVariant.html b/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardVariant.html deleted file mode 100644 index e61e9a0d1c94..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/LeaderboardVariant.html +++ /dev/null @@ -1,2186 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LeaderboardVariant | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

LeaderboardVariant

- - - - - - implements - - Freezable<LeaderboardVariant> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.LeaderboardVariant
- - - - - - - -
- - -

Class Overview

-

Data interface for a specific variant of a leaderboard; a variant is defined by the combination - of the leaderboard's collection (public or social) and time span (daily, weekly, or all-time). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCOLLECTION_PUBLIC - Collection constant for public leaderboards. - - - -
intCOLLECTION_SOCIAL - Collection constant for social leaderboards. - - - -
intNUM_SCORES_UNKNOWN - Constant returned when the total number of scores for this variant is unknown. - - - -
intNUM_TIME_SPANS - Number of time spans that exist. - - - -
intPLAYER_RANK_UNKNOWN - Constant returned when a player's rank for this variant is unknown. - - - -
intPLAYER_SCORE_UNKNOWN - Constant returned when a player's score for this variant is unknown. - - - -
intTIME_SPAN_ALL_TIME - Scores are never reset. - - - -
intTIME_SPAN_DAILY - Scores are reset every day. - - - -
intTIME_SPAN_WEEKLY - Scores are reset once per week. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getCollection() - -
- Retrieves the collection of scores contained by this variant. - - - -
- -
- abstract - - - - - String - - getDisplayPlayerRank() - -
- Retrieves the viewing player's formatted rank for this variant, if any. - - - -
- -
- abstract - - - - - String - - getDisplayPlayerScore() - -
- Retrieves the viewing player's score for this variant, if any. - - - -
- -
- abstract - - - - - long - - getNumScores() - -
- Retrieves the total number of scores for this variant. - - - -
- -
- abstract - - - - - long - - getPlayerRank() - -
- Retrieves the viewing player's rank for this variant, if any. - - - -
- -
- abstract - - - - - String - - getPlayerScoreTag() - -
- Retrieves the viewing player's score tag for this variant, if any. - - - -
- -
- abstract - - - - - long - - getRawPlayerScore() - -
- Retrieves the viewing player's score for this variant, if any. - - - -
- -
- abstract - - - - - int - - getTimeSpan() - -
- Retrieves the time span that the scores for this variant are drawn from. - - - -
- -
- abstract - - - - - boolean - - hasPlayerInfo() - -
- Get whether or not this variant contains score information for the viewing player or not. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - COLLECTION_PUBLIC -

-
- - - - -
-
- - - - -

Collection constant for public leaderboards. Public leaderboards contain the scores of - players who are sharing their gameplay activity publicly. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - COLLECTION_SOCIAL -

-
- - - - -
-
- - - - -

Collection constant for social leaderboards. Social leaderboards contain the scores of - players in the viewing player's circles. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NUM_SCORES_UNKNOWN -

-
- - - - -
-
- - - - -

Constant returned when the total number of scores for this variant is unknown. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - NUM_TIME_SPANS -

-
- - - - -
-
- - - - -

Number of time spans that exist. Needs to be updated if we ever have more. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_RANK_UNKNOWN -

-
- - - - -
-
- - - - -

Constant returned when a player's rank for this variant is unknown. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLAYER_SCORE_UNKNOWN -

-
- - - - -
-
- - - - -

Constant returned when a player's score for this variant is unknown. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIME_SPAN_ALL_TIME -

-
- - - - -
-
- - - - -

Scores are never reset. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIME_SPAN_DAILY -

-
- - - - -
-
- - - - -

Scores are reset every day. The reset occurs at 11:59PM PST. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TIME_SPAN_WEEKLY -

-
- - - - -
-
- - - - -

Scores are reset once per week. The reset occurs at 11:59PM PST on Sunday. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getCollection - () -

-
-
- - - -
-
- - - - -

Retrieves the collection of scores contained by this variant. Possible values are - COLLECTION_PUBLIC or COLLECTION_SOCIAL.

-
-
Returns
-
  • The collection of scores contained by this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayPlayerRank - () -

-
-
- - - -
-
- - - - -

Retrieves the viewing player's formatted rank for this variant, if any. Note that this value - is only accurate if hasPlayerInfo() returns true.

-
-
Returns
-
  • The String representation of the viewing player's rank, or {@code null) - if the player has no rank for this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayPlayerScore - () -

-
-
- - - -
-
- - - - -

Retrieves the viewing player's score for this variant, if any. Note that this value is only - accurate if hasPlayerInfo() returns true.

-
-
Returns
-
  • The String representation of the viewing player's score, or null if the - player has no score for this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getNumScores - () -

-
-
- - - -
-
- - - - -

Retrieves the total number of scores for this variant. Not all of these scores will always - be present on the local device. Note that if scores for this variant have not been loaded, - this method will return NUM_SCORES_UNKNOWN.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - long - - getPlayerRank - () -

-
-
- - - -
-
- - - - -

Retrieves the viewing player's rank for this variant, if any. Note that this value is only - accurate if hasPlayerInfo() returns true.

-
-
Returns
-
  • The long representation of the viewing player's rank, or PLAYER_RANK_UNKNOWN - if the player has no rank for this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPlayerScoreTag - () -

-
-
- - - -
-
- - - - -

Retrieves the viewing player's score tag for this variant, if any. Note that this value is - only accurate if hasPlayerInfo() returns true.

-
-
Returns
-
  • The score tag associated with the viewing player's score, or null if the - player has no score for this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getRawPlayerScore - () -

-
-
- - - -
-
- - - - -

Retrieves the viewing player's score for this variant, if any. Note that this value is only - accurate if hasPlayerInfo() returns true.

-
-
Returns
-
  • The long representation of the viewing player's score, or - PLAYER_SCORE_UNKNOWN if the player has no score for this variant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getTimeSpan - () -

-
-
- - - -
-
- - - - -

Retrieves the time span that the scores for this variant are drawn from. Possible values are - TIME_SPAN_ALL_TIME, TIME_SPAN_WEEKLY, or TIME_SPAN_DAILY.

-
-
Returns
-
  • The time span that the scores for this variant are drawn from. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPlayerInfo - () -

-
-
- - - -
-
- - - - -

Get whether or not this variant contains score information for the viewing player or not. - There are several possible reasons why this might be false. If the scores for this variant - have never been loaded, we won't know if the player has a score or not. Similarly, if the - player has not submitted a score for this variant, this will return false. -

- It is possible to have a score but no rank. For instance, on leaderboard variants of - COLLECTION_PUBLIC, players who are not sharing their scores publicly will never have - a rank.

-
-
Returns
-
  • Whether or not this variant contains score information for the viewing player. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult.html deleted file mode 100644 index b35021ce1573..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboards.LeaderboardMetadataResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Leaderboards.LeaderboardMetadataResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboards.LeaderboardMetadataResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when leaderboard metadata has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - LeaderboardBuffer - - getLeaderboards() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - LeaderboardBuffer - - getLeaderboards - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The leaderboard metadata that was requested. This is guaranteed to be non-null, - though it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadPlayerScoreResult.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadPlayerScoreResult.html deleted file mode 100644 index 641043b53908..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadPlayerScoreResult.html +++ /dev/null @@ -1,1164 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboards.LoadPlayerScoreResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Leaderboards.LoadPlayerScoreResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboards.LoadPlayerScoreResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a player's leaderboard score has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - LeaderboardScore - - getScore() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - LeaderboardScore - - getScore - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The leaderboard score that was requested. This item may be null if no score was - found. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadScoresResult.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadScoresResult.html deleted file mode 100644 index d90d9a38cfdb..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadScoresResult.html +++ /dev/null @@ -1,1269 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboards.LoadScoresResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Leaderboards.LoadScoresResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboards.LoadScoresResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when leaderboard scores have been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Leaderboard - - getLeaderboard() - -
- abstract - - - - - LeaderboardScoreBuffer - - getScores() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Leaderboard - - getLeaderboard - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The leaderboard that the requested scores belong to. This may be null if the - leaderboard metadata could not be found. -
-
- -
-
- - - - -
-

- - public - - - abstract - - LeaderboardScoreBuffer - - getScores - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The leaderboard scores that were requested. This is guaranteed to be non-null, - though it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.SubmitScoreResult.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.SubmitScoreResult.html deleted file mode 100644 index aaba72e5ac31..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.SubmitScoreResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboards.SubmitScoreResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Leaderboards.SubmitScoreResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboards.SubmitScoreResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a leaderboard score has been submitted. The statusCode indicates - whether or not the score was successfully submitted to the servers. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ScoreSubmissionData - - getScoreData() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ScoreSubmissionData - - getScoreData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Data about the score that was submitted and the response from the server. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.html b/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.html deleted file mode 100644 index cca190904a2f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/Leaderboards.html +++ /dev/null @@ -1,2465 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Leaderboards | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Leaderboards

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.leaderboard.Leaderboards
- - - - - - - -
- - -

Class Overview

-

Entry point for leaderboard functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceLeaderboards.LeaderboardMetadataResult - Result delivered when leaderboard metadata has been loaded.  - - - -
- - - - - interfaceLeaderboards.LoadPlayerScoreResult - Result delivered when a player's leaderboard score has been loaded.  - - - -
- - - - - interfaceLeaderboards.LoadScoresResult - Result delivered when leaderboard scores have been loaded.  - - - -
- - - - - interfaceLeaderboards.SubmitScoreResult - Result delivered when a leaderboard score has been submitted.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Intent - - getAllLeaderboardsIntent(GoogleApiClient apiClient) - -
- Gets an intent to show the list of leaderboards for a game. - - - -
- -
- abstract - - - - - Intent - - getLeaderboardIntent(GoogleApiClient apiClient, String leaderboardId) - -
- Gets an intent to show a leaderboard for a game. - - - -
- -
- abstract - - - - - Intent - - getLeaderboardIntent(GoogleApiClient apiClient, String leaderboardId, int timeSpan) - -
- Gets an intent to show a leaderboard for a game. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadPlayerScoreResult> - - loadCurrentPlayerLeaderboardScore(GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection) - -
- Asynchronously load the currently signed in player's score for a given leaderboard. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LeaderboardMetadataResult> - - loadLeaderboardMetadata(GoogleApiClient apiClient, String leaderboardId, boolean forceReload) - -
- Asynchronously load a specific leaderboard's metadata for this game. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LeaderboardMetadataResult> - - loadLeaderboardMetadata(GoogleApiClient apiClient, boolean forceReload) - -
- Asynchronously load the list of leaderboard metadata for this game. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadScoresResult> - - loadMoreScores(GoogleApiClient apiClient, LeaderboardScoreBuffer buffer, int maxResults, int pageDirection) - -
- Asynchronously loads an additional page of score data for the given score buffer. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadScoresResult> - - loadPlayerCenteredScores(GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults) - -
- Asynchronously load the player-centered page of scores for a given leaderboard. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadScoresResult> - - loadPlayerCenteredScores(GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults, boolean forceReload) - -
- Asynchronously load the player-centered page of scores for a given leaderboard. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadScoresResult> - - loadTopScores(GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults, boolean forceReload) - -
- Asynchronously load the top page of scores for a given leaderboard. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.LoadScoresResult> - - loadTopScores(GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults) - -
- Asynchronously load the top page of scores for a given leaderboard. - - - -
- -
- abstract - - - - - void - - submitScore(GoogleApiClient apiClient, String leaderboardId, long score, String scoreTag) - -
- Submit a score to a leaderboard for the currently signed in player. - - - -
- -
- abstract - - - - - void - - submitScore(GoogleApiClient apiClient, String leaderboardId, long score) - -
- Submit a score to a leaderboard for the currently signed in player. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.SubmitScoreResult> - - submitScoreImmediate(GoogleApiClient apiClient, String leaderboardId, long score) - -
- Submit a score to a leaderboard for the currently signed in player. - - - -
- -
- abstract - - - - - PendingResult<Leaderboards.SubmitScoreResult> - - submitScoreImmediate(GoogleApiClient apiClient, String leaderboardId, long score, String scoreTag) - -
- Submit a score to a leaderboard for the currently signed in player. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Intent - - getAllLeaderboardsIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets an intent to show the list of leaderboards for a game. Note that this must be invoked - with startActivityForResult(Intent, int), so that the identity of the - calling package can be established. -

- A RESULT_RECONNECT_REQUIRED may be returned as the - resultCode in onActivityResult(int, int, Intent) if the GoogleApiClient ends up in an - inconsistent state. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the list of leaderboards for a game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getLeaderboardIntent - (GoogleApiClient apiClient, String leaderboardId) -

-
-
- - - -
-
- - - - -

Gets an intent to show a leaderboard for a game. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- A RESULT_RECONNECT_REQUIRED may be returned as the - resultCode in onActivityResult(int, int, Intent) if the GoogleApiClient ends up in an - inconsistent state. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The ID of the leaderboard to view.
-
-
-
Returns
-
  • An Intent that can be started to view the specified leaderboard. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getLeaderboardIntent - (GoogleApiClient apiClient, String leaderboardId, int timeSpan) -

-
-
- - - -
-
- - - - -

Gets an intent to show a leaderboard for a game. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- A RESULT_RECONNECT_REQUIRED may be returned as the - resultCode in onActivityResult(int, int, Intent) if the GoogleApiClient ends up in an - inconsistent state. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The ID of the leaderboard to view.
timeSpan - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
-
-
-
Returns
-
  • An Intent that can be started to view the specified leaderboard. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadPlayerScoreResult> - - loadCurrentPlayerLeaderboardScore - (GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection) -

-
-
- - - -
-
- - - - -

Asynchronously load the currently signed in player's score for a given leaderboard. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard to load the score from.
span - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
leaderboardCollection - The leaderboard collection to retrieve scores for. Valid values - are either COLLECTION_PUBLIC or - COLLECTION_SOCIAL.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LeaderboardMetadataResult> - - loadLeaderboardMetadata - (GoogleApiClient apiClient, String leaderboardId, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load a specific leaderboard's metadata for this game. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard to load metadata for.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LeaderboardMetadataResult> - - loadLeaderboardMetadata - (GoogleApiClient apiClient, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load the list of leaderboard metadata for this game. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadScoresResult> - - loadMoreScores - (GoogleApiClient apiClient, LeaderboardScoreBuffer buffer, int maxResults, int pageDirection) -

-
-
- - - -
-
- - - - -

Asynchronously loads an additional page of score data for the given score buffer. A new score - buffer will be delivered that replaces the given buffer. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
buffer - The existing buffer that will be expanded. The buffer is allowed to be closed - prior to being passed in to this method.
maxResults - The maximum number of scores to fetch per page. Must be between 1 and 25. - Note that the number of scores returned here may be greater than this value, - depending on how much data is cached on the device.
pageDirection - The direction to expand the buffer. Values are defined in - PageDirection.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadScoresResult> - - loadPlayerCenteredScores - (GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults) -

-
-
- - - -
-
- - - - -

Asynchronously load the player-centered page of scores for a given leaderboard. If the player - does not have a score on this leaderboard, this call will return the top page instead. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard.
span - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
leaderboardCollection - The leaderboard collection to retrieve scores for. Valid values - are either COLLECTION_PUBLIC or - COLLECTION_SOCIAL.
maxResults - The maximum number of scores to fetch per page. Must be between 1 and 25.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadScoresResult> - - loadPlayerCenteredScores - (GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load the player-centered page of scores for a given leaderboard. If the player - does not have a score on this leaderboard, this call will return the top page instead. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard.
span - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
leaderboardCollection - The leaderboard collection to retrieve scores for. Valid values - are either COLLECTION_PUBLIC or - COLLECTION_SOCIAL.
maxResults - The maximum number of scores to fetch per page. Must be between 1 and 25.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadScoresResult> - - loadTopScores - (GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load the top page of scores for a given leaderboard. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard.
span - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
leaderboardCollection - The leaderboard collection to retrieve scores for. Valid values - are either COLLECTION_PUBLIC or - COLLECTION_SOCIAL.
maxResults - The maximum number of scores to fetch per page. Must be between 1 and 25.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.LoadScoresResult> - - loadTopScores - (GoogleApiClient apiClient, String leaderboardId, int span, int leaderboardCollection, int maxResults) -

-
-
- - - -
-
- - - - -

Asynchronously load the top page of scores for a given leaderboard. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - ID of the leaderboard.
span - Time span to retrieve data for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
leaderboardCollection - The leaderboard collection to retrieve scores for. Valid values - are either COLLECTION_PUBLIC or - COLLECTION_SOCIAL.
maxResults - The maximum number of scores to fetch per page. Must be between 1 and 25.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - submitScore - (GoogleApiClient apiClient, String leaderboardId, long score, String scoreTag) -

-
-
- - - -
-
- - - - -

Submit a score to a leaderboard for the currently signed in player. The score is ignored if - it is worse (as defined by the leaderboard configuration) than a previously submitted score - for the same player. -

- This form of the API is a fire-and-forget form. Use this if you do not need to be notified of - the results of submitting the score, though note that the update may not be sent to the - server until the next sync. -

- The meaning of the score value depends on the formatting of the leaderboard established in - the developer console. Leaderboards support the following score formats: -

    -
  • Fixed-point: score represents a raw value, and will be formatted based on the - number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0, or - 10.00 for 0, 1, or 2 decimal places.
    • -
  • Time: score represents an elapsed time in milliseconds. The value will be - formatted as an appropriate time value.
    • -
  • Currency: score represents a value in micro units. For example, in USD, a score - of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
    • -
-

- For more details, please see Leaderboard - Concepts. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The leaderboard to submit the score to.
score - The raw score value.
scoreTag - Optional metadata about this score. The value may contain no more than 64 - URI-safe characters as defined by section 2.3 of RFC 3986. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - submitScore - (GoogleApiClient apiClient, String leaderboardId, long score) -

-
-
- - - -
-
- - - - -

Submit a score to a leaderboard for the currently signed in player. The score is ignored if - it is worse (as defined by the leaderboard configuration) than a previously submitted score - for the same player. -

- This form of the API is a fire-and-forget form. Use this if you do not need to be notified of - the results of submitting the score, though note that the update may not be sent to the - server until the next sync. -

- The meaning of the score value depends on the formatting of the leaderboard established in - the developer console. Leaderboards support the following score formats: -

    -
  • Fixed-point: score represents a raw value, and will be formatted based on the - number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0, or - 10.00 for 0, 1, or 2 decimal places.
    • -
  • Time: score represents an elapsed time in milliseconds. The value will be - formatted as an appropriate time value.
    • -
  • Currency: score represents a value in micro units. For example, in USD, a score - of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
    • -
-

- For more details, please see Leaderboard - Concepts. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The leaderboard to submit the score to.
score - The raw score value. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.SubmitScoreResult> - - submitScoreImmediate - (GoogleApiClient apiClient, String leaderboardId, long score) -

-
-
- - - -
-
- - - - -

Submit a score to a leaderboard for the currently signed in player. The score is ignored if - it is worse (as defined by the leaderboard configuration) than a previously submitted score - for the same player. -

- This form of the API will attempt to submit the score to the server immediately, and will - return a GamesPendingResult with information about the submission. -

- The meaning of the score value depends on the formatting of the leaderboard established in - the developer console. Leaderboards support the following score formats: -

    -
  • Fixed-point: score represents a raw value, and will be formatted based on the - number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0, or - 10.00 for 0, 1, or 2 decimal places.
    • -
  • Time: score represents an elapsed time in milliseconds. The value will be - formatted as an appropriate time value.
    • -
  • Currency: score represents a value in micro units. For example, in USD, a score - of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
    • -
-

- For more details, please see this - page. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The leaderboard to submit the score to.
score - The raw score value.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Leaderboards.SubmitScoreResult> - - submitScoreImmediate - (GoogleApiClient apiClient, String leaderboardId, long score, String scoreTag) -

-
-
- - - -
-
- - - - -

Submit a score to a leaderboard for the currently signed in player. The score is ignored if - it is worse (as defined by the leaderboard configuration) than a previously submitted score - for the same player. -

- This form of the API will attempt to submit the score to the server immediately, and will - return a GamesPendingResult with information about the submission. -

- The meaning of the score value depends on the formatting of the leaderboard established in - the developer console. Leaderboards support the following score formats: -

    -
  • Fixed-point: score represents a raw value, and will be formatted based on the - number of decimal places configured. A score of 1000 would be formatted as 1000, 100.0, or - 10.00 for 0, 1, or 2 decimal places.
    • -
  • Time: score represents an elapsed time in milliseconds. The value will be - formatted as an appropriate time value.
    • -
  • Currency: score represents a value in micro units. For example, in USD, a score - of 100 would display as $0.0001, while a score of 1000000 would display as $1.00
    • -
-

- For more details, please see this - page. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
leaderboardId - The leaderboard to submit the score to.
score - The raw score value.
scoreTag - Optional metadata about this score. The value may contain no more than 64 - URI-safe characters as defined by section 2.3 of RFC 3986.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.Result.html b/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.Result.html deleted file mode 100644 index 2c0f8f9ecfcc..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.Result.html +++ /dev/null @@ -1,1584 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ScoreSubmissionData.Result | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

ScoreSubmissionData.Result

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.leaderboard.ScoreSubmissionData.Result
- - - - - - - -
- - -

Class Overview

-

Simple data class containing the result data for a particular time span. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - StringformattedScore - String containing the score data in a display-appropriate format. - - - -
- public - - final - booleannewBest - Boolean indicating whether or not this score was the player's new best score for this - time span. - - - -
- public - - final - longrawScore - The raw score value of this score result. - - - -
- public - - final - StringscoreTag - The score tag associated with this result, if any. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ScoreSubmissionData.Result(long rawScore, String formattedScore, String scoreTag, boolean newBest) - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - String - - formattedScore -

-
- - - - -
-
- - - - -

String containing the score data in a display-appropriate format. -

- - -
-
- - - - - -
-

- - public - - final - boolean - - newBest -

-
- - - - -
-
- - - - -

Boolean indicating whether or not this score was the player's new best score for this - time span. -

- - -
-
- - - - - -
-

- - public - - final - long - - rawScore -

-
- - - - -
-
- - - - -

The raw score value of this score result. -

- - -
-
- - - - - -
-

- - public - - final - String - - scoreTag -

-
- - - - -
-
- - - - -

The score tag associated with this result, if any. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ScoreSubmissionData.Result - (long rawScore, String formattedScore, String scoreTag, boolean newBest) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.html b/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.html deleted file mode 100644 index 989482f6f767..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.html +++ /dev/null @@ -1,1525 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ScoreSubmissionData | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ScoreSubmissionData

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.leaderboard.ScoreSubmissionData
- - - - - - - -
- - -

Class Overview

-

Data object representing the result of submitting a score to a leaderboard. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classScoreSubmissionData.Result - Simple data class containing the result data for a particular time span.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getLeaderboardId() - -
- Retrieves the ID of the leaderboard the score was submitted to. - - - -
- -
- - - - - - String - - getPlayerId() - -
- Retrieves the ID of the player the score was submitted for. - - - -
- -
- - - - - - ScoreSubmissionData.Result - - getScoreResult(int timeSpan) - -
- Retrieves the ScoreSubmissionData.Result object for the given time span, if any. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getLeaderboardId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of the leaderboard the score was submitted to.

-
-
Returns
-
  • The ID of the leaderboard. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPlayerId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of the player the score was submitted for.

-
-
Returns
-
  • The ID of submitting player. -
-
- -
-
- - - - -
-

- - public - - - - - ScoreSubmissionData.Result - - getScoreResult - (int timeSpan) -

-
-
- - - -
-
- - - - -

Retrieves the ScoreSubmissionData.Result object for the given time span, if any.

-
-
Parameters
- - - - -
timeSpan - Time span to retrieve result for. Valid values are - TIME_SPAN_DAILY, - TIME_SPAN_WEEKLY, or - TIME_SPAN_ALL_TIME.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/leaderboard/package-summary.html b/docs/html/reference/com/google/android/gms/games/leaderboard/package-summary.html deleted file mode 100644 index ca5ab6537651..000000000000 --- a/docs/html/reference/com/google/android/gms/games/leaderboard/package-summary.html +++ /dev/null @@ -1,1022 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.leaderboard | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.leaderboard

-
- -
- -
- - -
- Contains data classes for leaderboards. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Leaderboard - Data interface for leaderboard metadata.  - - - -
Leaderboards - Entry point for leaderboard functionality.  - - - -
Leaderboards.LeaderboardMetadataResult - Result delivered when leaderboard metadata has been loaded.  - - - -
Leaderboards.LoadPlayerScoreResult - Result delivered when a player's leaderboard score has been loaded.  - - - -
Leaderboards.LoadScoresResult - Result delivered when leaderboard scores have been loaded.  - - - -
Leaderboards.SubmitScoreResult - Result delivered when a leaderboard score has been submitted.  - - - -
LeaderboardScore - Data interface representing a single score on a leaderboard.  - - - -
LeaderboardVariant - Data interface for a specific variant of a leaderboard; a variant is defined by the combination - of the leaderboard's collection (public or social) and time span (daily, weekly, or all-time).  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LeaderboardBuffer - EntityBuffer containing Leaderboard data.  - - - -
LeaderboardScoreBuffer - AbstractDataBuffer containing LeaderboardScore data.  - - - -
ScoreSubmissionData - Data object representing the result of submitting a score to a leaderboard.  - - - -
ScoreSubmissionData.Result - Simple data class containing the result data for a particular time span.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitation.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Invitation.html deleted file mode 100644 index 6fb4b005451d..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitation.html +++ /dev/null @@ -1,1901 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Invitation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Invitation

- - - - - - implements - - Freezable<Invitation> - - Participatable - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Invitation
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for an invitation object. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intINVITATION_TYPE_REAL_TIME - Constant indicating that this invitation is for a real-time room. - - - -
intINVITATION_TYPE_TURN_BASED - Constant indicating that this invitation is for a turn-based match. - - - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getAvailableAutoMatchSlots() - -
- Return the maximum number of available automatch slots for this invitation. - - - -
- -
- abstract - - - - - long - - getCreationTimestamp() - -
- Retrieve the server timestamp at which this Invitation was created. - - - -
- -
- abstract - - - - - Game - - getGame() - -
- Retrieve the Game object that this Invitation is associated with. - - - -
- -
- abstract - - - - - String - - getInvitationId() - -
- Retrieve the ID of this Invitation. - - - -
- -
- abstract - - - - - int - - getInvitationType() - -
- Retrieve the type of this Invitation. - - - -
- -
- abstract - - - - - Participant - - getInviter() - -
- Retrieve the Participant who created this Invitation. - - - -
- -
- abstract - - - - - int - - getVariant() - -
- Retrieve the variant specified for this Invitation, if any. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - INVITATION_TYPE_REAL_TIME -

-
- - - - -
-
- - - - -

Constant indicating that this invitation is for a real-time room. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVITATION_TYPE_TURN_BASED -

-
- - - - -
-
- - - - -

Constant indicating that this invitation is for a turn-based match. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getAvailableAutoMatchSlots - () -

-
-
- - - -
-
- - - - -

Return the maximum number of available automatch slots for this invitation. If automatch - criteria were not specified during creation, or if all slots have been filled, this will - return 0.

-
-
Returns
-
  • The maximum number of additional players that can be added to this game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieve the server timestamp at which this Invitation was created.

-
-
Returns
-
  • The server timestamp at which this Invitation was created. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieve the Game object that this Invitation is associated with.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - String - - getInvitationId - () -

-
-
- - - -
-
- - - - -

Retrieve the ID of this Invitation.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getInvitationType - () -

-
-
- - - -
-
- - - - -

Retrieve the type of this Invitation. May be either - INVITATION_TYPE_REAL_TIME or INVITATION_TYPE_TURN_BASED.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - Participant - - getInviter - () -

-
-
- - - -
-
- - - - -

Retrieve the Participant who created this Invitation.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

Retrieve the variant specified for this Invitation, if any. A variant is an optional - developer-controlled parameter describing the type of game to play. If specified, this value - will be a positive integer. If this invitation had no variant specified, returns - ROOM_VARIANT_DEFAULT or MATCH_VARIANT_DEFAULT.

-
-
Returns
-
  • Variant specified for this invitation, if any. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationBuffer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationBuffer.html deleted file mode 100644 index 31492cf05be9..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationBuffer.html +++ /dev/null @@ -1,1864 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InvitationBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InvitationBuffer

- - - - - - - - - extends AbstractDataBuffer<Invitation>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.multiplayer.Invitation>
    ↳com.google.android.gms.games.multiplayer.InvitationBuffer
- - - - - - - -
- - -

Class Overview

-

EntityBuffer implementation containing Invitation data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - Invitation - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - Invitation - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationEntity.html b/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationEntity.html deleted file mode 100644 index 367e48f318df..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/InvitationEntity.html +++ /dev/null @@ -1,2644 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InvitationEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InvitationEntity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Invitation - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.InvitationEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a multiplayer invitation. This is immutable, and therefore - safe to cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - From interface -com.google.android.gms.games.multiplayer.Invitation -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<InvitationEntity>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Invitation - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - int - - getAvailableAutoMatchSlots() - -
- Return the maximum number of available automatch slots for this invitation. - - - -
- -
- - - - - - long - - getCreationTimestamp() - -
- Retrieve the server timestamp at which this Invitation was created. - - - -
- -
- - - - - - Game - - getGame() - -
- Retrieve the Game object that this Invitation is associated with. - - - -
- -
- - - - - - String - - getInvitationId() - -
- Retrieve the ID of this Invitation. - - - -
- -
- - - - - - Participant - - getInviter() - -
- Retrieve the Participant who created this Invitation. - - - -
- -
- - - - - - ArrayList<Participant> - - getParticipants() - -
- Retrieve the Participants for this object. - - - -
- -
- - - - - - int - - getVariant() - -
- Retrieve the variant specified for this Invitation, if any. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Invitation - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<InvitationEntity> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Invitation - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getAvailableAutoMatchSlots - () -

-
-
- - - -
-
- - - - -

Return the maximum number of available automatch slots for this invitation. If automatch - criteria were not specified during creation, or if all slots have been filled, this will - return 0.

-
-
Returns
-
  • The maximum number of additional players that can be added to this game. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieve the server timestamp at which this Invitation was created.

-
-
Returns
-
  • The server timestamp at which this Invitation was created. -
-
- -
-
- - - - -
-

- - public - - - - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieve the Game object that this Invitation is associated with.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getInvitationId - () -

-
-
- - - -
-
- - - - -

Retrieve the ID of this Invitation.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - Participant - - getInviter - () -

-
-
- - - -
-
- - - - -

Retrieve the Participant who created this Invitation.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - ArrayList<Participant> - - getParticipants - () -

-
-
- - - -
-
- - - - -

Retrieve the Participants for this object. This is a list of all Participants - applicable to the given object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

Retrieve the variant specified for this Invitation, if any. A variant is an optional - developer-controlled parameter describing the type of game to play. If specified, this value - will be a positive integer. If this invitation had no variant specified, returns - ROOM_VARIANT_DEFAULT or MATCH_VARIANT_DEFAULT.

-
-
Returns
-
  • Variant specified for this invitation, if any. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.LoadInvitationsResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.LoadInvitationsResult.html deleted file mode 100644 index 0852064b0e1e..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.LoadInvitationsResult.html +++ /dev/null @@ -1,1211 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Invitations.LoadInvitationsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Invitations.LoadInvitationsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Invitations.LoadInvitationsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when invitations have been loaded. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - InvitationBuffer - - getInvitations() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - InvitationBuffer - - getInvitations - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The invitations that were requested. This is guaranteed to be non-null, though it - may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.html deleted file mode 100644 index 0df8cc779d11..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Invitations.html +++ /dev/null @@ -1,1408 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Invitations | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Invitations

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Invitations
- - - - - - - -
- - -

Class Overview

-

Entry point for invitations functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceInvitations.LoadInvitationsResult - Result delivered when invitations have been loaded.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Intent - - getInvitationInboxIntent(GoogleApiClient apiClient) - -
- Returns an intent that will let the user see and manage any outstanding invitations. - - - -
- -
- abstract - - - - - PendingResult<Invitations.LoadInvitationsResult> - - loadInvitations(GoogleApiClient apiClient, int sortOrder) - -
- Asynchronously load the list of invitations for the current game. - - - -
- -
- abstract - - - - - PendingResult<Invitations.LoadInvitationsResult> - - loadInvitations(GoogleApiClient apiClient) - -
- Asynchronously load the list of invitations for the current game. - - - -
- -
- abstract - - - - - void - - registerInvitationListener(GoogleApiClient apiClient, OnInvitationReceivedListener listener) - -
- Register a listener to intercept incoming invitations for the currently signed-in user. - - - -
- -
- abstract - - - - - void - - unregisterInvitationListener(GoogleApiClient apiClient) - -
- Unregisters this client's invitation listener, if any. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Intent - - getInvitationInboxIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user see and manage any outstanding invitations. Note - that this must be invoked using startActivityForResult(Intent, int) so that - the identity of the calling package can be established. -

- If the user canceled the result will be RESULT_CANCELED. If the user - selected an invitation to accept, the result will be RESULT_OK - and the data intent will contain the selected invitation as a parcelable extra in the - extras. Based on the type of the match (TTMP/RBMP), the result will include either - EXTRA_TURN_BASED_MATCH or EXTRA_INVITATION. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the invitation inbox UI. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Invitations.LoadInvitationsResult> - - loadInvitations - (GoogleApiClient apiClient, int sortOrder) -

-
-
- - - -
-
- - - - -

Asynchronously load the list of invitations for the current game. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
sortOrder - How to sort the returned invitations. Must be either - SORT_ORDER_MOST_RECENT_FIRST or - SORT_ORDER_SOCIAL_AGGREGATION.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Invitations.LoadInvitationsResult> - - loadInvitations - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Asynchronously load the list of invitations for the current game. Invitations are returned - sorted by most recent first. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerInvitationListener - (GoogleApiClient apiClient, OnInvitationReceivedListener listener) -

-
-
- - - -
-
- - - - -

Register a listener to intercept incoming invitations for the currently signed-in user. If a - listener is registered by this method, the incoming invitation will not generate a status bar - notification as long as this client remains connected. -

- Note that only one invitation listener may be active at a time. Calling this method while - another invitation listener was previously registered will replace the original listener with - the new one. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is called when a new invitation is received. The listener - is called on the main thread. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterInvitationListener - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Unregisters this client's invitation listener, if any. Any new invitations will generate - status bar notifications as normal. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Multiplayer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Multiplayer.html deleted file mode 100644 index 6043d981a6b5..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Multiplayer.html +++ /dev/null @@ -1,1558 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Multiplayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Multiplayer

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Multiplayer
- - - - - - - -
- - -

Class Overview

-

Common constants/methods for multiplayer functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_EXCLUSIVE_BIT_MASK - Used to bundle the exclusive bit mask of the player for auto-match criteria. - - - -
StringEXTRA_INVITATION - Used to return an Invitation. - - - -
StringEXTRA_MAX_AUTOMATCH_PLAYERS - Used to return the maximum number of players that should be added to a room by auto-matching. - - - -
StringEXTRA_MIN_AUTOMATCH_PLAYERS - Used to return the minimum number of players that should be added to a room by auto-matching. - - - -
StringEXTRA_ROOM - Used to return a Room. - - - -
StringEXTRA_TURN_BASED_MATCH - Used to return a TurnBasedMatch. - - - -
intMAX_RELIABLE_MESSAGE_LEN - This gives the maximum message size supported via the - sendReliableMessage(GoogleApiClient, RealTimeMultiplayer.ReliableMessageSentCallback, byte[], String, String) methods (excluding protocol headers). - - - -
intMAX_UNRELIABLE_MESSAGE_LEN - This gives the maximum (unfragmented) message size supported via the - sendUnreliableMessage(GoogleApiClient, byte[], String, String) methods (excluding protocol headers). - - - -
intSORT_ORDER_MOST_RECENT_FIRST - Sort multiplayer activities by their last-modified timestamp with most recent first. - - - -
intSORT_ORDER_SOCIAL_AGGREGATION - Sort multiplayer activities such that activities from players in the user's circles are - returned first. - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_EXCLUSIVE_BIT_MASK -

-
- - - - -
-
- - - - -

Used to bundle the exclusive bit mask of the player for auto-match criteria. -

- - -
- Constant Value: - - - "exclusive_bit_mask" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_INVITATION -

-
- - - - -
-
- - - - -

Used to return an Invitation. Retrieve with getParcelableExtra(String) - or getParcelable(String). -

- - -
- Constant Value: - - - "invitation" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_MAX_AUTOMATCH_PLAYERS -

-
- - - - -
-
- - - - -

Used to return the maximum number of players that should be added to a room by auto-matching. - Retrieve with getIntExtra(String, int).

-
-
See Also
- -
- - -
- Constant Value: - - - "max_automatch_players" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_MIN_AUTOMATCH_PLAYERS -

-
- - - - -
-
- - - - -

Used to return the minimum number of players that should be added to a room by auto-matching. - Retrieve with getIntExtra(String, int).

-
-
See Also
- -
- - -
- Constant Value: - - - "min_automatch_players" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ROOM -

-
- - - - -
-
- - - - -

Used to return a Room. Retrieve with getParcelableExtra(String). -

- - -
- Constant Value: - - - "room" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_TURN_BASED_MATCH -

-
- - - - -
-
- - - - -

Used to return a TurnBasedMatch. Retrieve with - getParcelableExtra(String) or getParcelable(String). -

- - -
- Constant Value: - - - "turn_based_match" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_RELIABLE_MESSAGE_LEN -

-
- - - - -
-
- - - - -

This gives the maximum message size supported via the - sendReliableMessage(GoogleApiClient, RealTimeMultiplayer.ReliableMessageSentCallback, byte[], String, String) methods (excluding protocol headers). -

- - -
- Constant Value: - - - 1400 - (0x00000578) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_UNRELIABLE_MESSAGE_LEN -

-
- - - - -
-
- - - - -

This gives the maximum (unfragmented) message size supported via the - sendUnreliableMessage(GoogleApiClient, byte[], String, String) methods (excluding protocol headers). -

- - -
- Constant Value: - - - 1168 - (0x00000490) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_MOST_RECENT_FIRST -

-
- - - - -
-
- - - - -

Sort multiplayer activities by their last-modified timestamp with most recent first. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_SOCIAL_AGGREGATION -

-
- - - - -
-
- - - - -

Sort multiplayer activities such that activities from players in the user's circles are - returned first. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/OnInvitationReceivedListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/OnInvitationReceivedListener.html deleted file mode 100644 index 5827c119141f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/OnInvitationReceivedListener.html +++ /dev/null @@ -1,1138 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnInvitationReceivedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnInvitationReceivedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.OnInvitationReceivedListener
- - - - - - - -
- - -

Class Overview

-

Listener to invoke when a new invitation is received. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onInvitationReceived(Invitation invitation) - -
- Callback invoked when a new invitation is received. - - - -
- -
- abstract - - - - - void - - onInvitationRemoved(String invitationId) - -
- Callback invoked when a previously received invitation has been removed from the local - device. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onInvitationReceived - (Invitation invitation) -

-
-
- - - -
-
- - - - -

Callback invoked when a new invitation is received. This allows an app to respond to the - invitation as appropriate. If the app receives this callback, the system will not display a - notification for this invitation.

-
-
Parameters
- - - - -
invitation - The invitation that was received. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onInvitationRemoved - (String invitationId) -

-
-
- - - -
-
- - - - -

Callback invoked when a previously received invitation has been removed from the local - device. For example, this might occur if the inviting player leaves the match.

-
-
Parameters
- - - - -
invitationId - The ID of the invitation that was removed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Participant.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Participant.html deleted file mode 100644 index e121883781d5..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Participant.html +++ /dev/null @@ -1,2255 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Participant | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Participant

- - - - - - implements - - Freezable<Participant> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Participant
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for multiplayer participants. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATUS_DECLINED - Constant indicating that this participant has declined the invitation. - - - -
intSTATUS_FINISHED - Constant indicating that this participant is finished with this match. - - - -
intSTATUS_INVITED - Constant indicating that this participant has been sent an invitation. - - - -
intSTATUS_JOINED - Constant indicating that this participant has accepted the invitation and is joined. - - - -
intSTATUS_LEFT - Constant indicating that this participant joined a multiplayer game and subsequently left. - - - -
intSTATUS_NOT_INVITED_YET - Constant indicating that this participant has not yet been sent an invitation. - - - -
intSTATUS_UNRESPONSIVE - Constant indicating that this participant did not respond to the match in the alloted time. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDisplayName() - -
- Return the name to display for this participant. - - - -
- -
- abstract - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the display name for this participant into the provided CharArrayBuffer. - - - -
- -
- abstract - - - - - Uri - - getHiResImageUri() - -
- Returns the URI of the hi-res image to display for this participant. - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Returns the URI of the icon-sized image to display for this participant. - - - -
- -
- abstract - - - - - String - - getParticipantId() - -
- Returns the ID of this participant. - - - -
- -
- abstract - - - - - Player - - getPlayer() - -
- Returns the Player that this participant represents. - - - -
- -
- abstract - - - - - ParticipantResult - - getResult() - -
- Returns the ParticipantResult associated with this participant, if any. - - - -
- -
- abstract - - - - - int - - getStatus() - -
- Retrieve the status of this participant. - - - -
- -
- abstract - - - - - boolean - - isConnectedToRoom() - -
- Retrieves the connected status of the participant. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATUS_DECLINED -

-
- - - - -
-
- - - - -

Constant indicating that this participant has declined the invitation. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_FINISHED -

-
- - - - -
-
- - - - -

Constant indicating that this participant is finished with this match. - Only applies to turn-based match participants. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_INVITED -

-
- - - - -
-
- - - - -

Constant indicating that this participant has been sent an invitation. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_JOINED -

-
- - - - -
-
- - - - -

Constant indicating that this participant has accepted the invitation and is joined. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_LEFT -

-
- - - - -
-
- - - - -

Constant indicating that this participant joined a multiplayer game and subsequently left. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NOT_INVITED_YET -

-
- - - - -
-
- - - - -

Constant indicating that this participant has not yet been sent an invitation. - Only applies to turn-based match participants. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_UNRESPONSIVE -

-
- - - - -
-
- - - - -

Constant indicating that this participant did not respond to the match in the alloted time. - Only applies to turn-based match participants. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Return the name to display for this participant. If the identity of the player is unknown, - this will be a generic handle to describe the player.

-
-
Returns
-
  • Display name of the participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the display name for this participant into the provided CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Returns the URI of the hi-res image to display for this participant. If the identity of the - player is unknown, this will be null. It may also be null if the player simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the hi-res image to display for this participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Returns the URI of the icon-sized image to display for this participant. If the identity of - the player is unknown, this will be the automatch avatar icon image for the player. It may - also be null if the player simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the icon image to display for this participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getParticipantId - () -

-
-
- - - -
-
- - - - -

Returns the ID of this participant. Note that this is only valid for use in the current - multiplayer room or match: a participant will not have the same ID across multiple rooms or - matches.

-
-
Returns
-
  • The ID of this participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Returns the Player that this participant represents. Note that this may be null if - the identity of the player is unknown. This occurs in automatching scenarios where some - players are not permitted to see the real identity of others.

-
-
Returns
-
  • The Player corresponding to this participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ParticipantResult - - getResult - () -

-
-
- - - -
-
- - - - -

Returns the ParticipantResult associated with this participant, if any. - Only applies to turn-based match participants.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

Retrieve the status of this participant. -

- Possible status values for room participants are - STATUS_INVITED, STATUS_JOINED, STATUS_DECLINED, and - STATUS_LEFT. -

- Possible status values for turn-based match participants are all of - the above, STATUS_NOT_INVITED_YET, STATUS_FINISHED, and - STATUS_UNRESPONSIVE.

-
-
Returns
-
  • Status of this participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConnectedToRoom - () -

-
-
- - - -
-
- - - - -

Retrieves the connected status of the participant. If true indicates that participant is in - the connected set of the room. Only applies to room participants.

-
-
Returns
-
  • Connected status of the participant. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantBuffer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantBuffer.html deleted file mode 100644 index 42ebfd4ba387..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ParticipantBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ParticipantBuffer

- - - - - - - - - extends AbstractDataBuffer<Participant>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.multiplayer.Participant>
    ↳com.google.android.gms.games.multiplayer.ParticipantBuffer
- - - - - - - -
- - -

Class Overview

-

AbstractDataBuffer implementation containing match participant data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Participant - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Participant - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantEntity.html b/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantEntity.html deleted file mode 100644 index aee439523a3c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantEntity.html +++ /dev/null @@ -1,2833 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ParticipantEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ParticipantEntity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Participant - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.ParticipantEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing a Participant in a match. This is immutable, and therefore safe to cache - or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - From interface -com.google.android.gms.games.multiplayer.Participant -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<ParticipantEntity>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Participant - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - String - - getDisplayName() - -
- Return the name to display for this participant. - - - -
- -
- - - - - - void - - getDisplayName(CharArrayBuffer dataOut) - -
- Loads the display name for this participant into the provided CharArrayBuffer. - - - -
- -
- - - - - - Uri - - getHiResImageUri() - -
- Returns the URI of the hi-res image to display for this participant. - - - -
- -
- - - - - - Uri - - getIconImageUri() - -
- Returns the URI of the icon-sized image to display for this participant. - - - -
- -
- - - - - - String - - getParticipantId() - -
- Returns the ID of this participant. - - - -
- -
- - - - - - Player - - getPlayer() - -
- Returns the Player that this participant represents. - - - -
- -
- - - - - - ParticipantResult - - getResult() - -
- Returns the ParticipantResult associated with this participant, if any. - - - -
- -
- - - - - - int - - getStatus() - -
- Retrieve the status of this participant. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isConnectedToRoom() - -
- Retrieves the connected status of the participant. - - - -
- -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participant - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<ParticipantEntity> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Participant - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Return the name to display for this participant. If the identity of the player is unknown, - this will be a generic handle to describe the player.

-
-
Returns
-
  • Display name of the participant. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDisplayName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the display name for this participant into the provided CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getHiResImageUri - () -

-
-
- - - -
-
- - - - -

Returns the URI of the hi-res image to display for this participant. If the identity of the - player is unknown, this will be null. It may also be null if the player simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the hi-res image to display for this participant. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Returns the URI of the icon-sized image to display for this participant. If the identity of - the player is unknown, this will be the automatch avatar icon image for the player. It may - also be null if the player simply has no image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • The URI of the icon image to display for this participant. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getParticipantId - () -

-
-
- - - -
-
- - - - -

Returns the ID of this participant. Note that this is only valid for use in the current - multiplayer room or match: a participant will not have the same ID across multiple rooms or - matches.

-
-
Returns
-
  • The ID of this participant. -
-
- -
-
- - - - -
-

- - public - - - - - Player - - getPlayer - () -

-
-
- - - -
-
- - - - -

Returns the Player that this participant represents. Note that this may be null if - the identity of the player is unknown. This occurs in automatching scenarios where some - players are not permitted to see the real identity of others.

-
-
Returns
-
  • The Player corresponding to this participant. -
-
- -
-
- - - - -
-

- - public - - - - - ParticipantResult - - getResult - () -

-
-
- - - -
-
- - - - -

Returns the ParticipantResult associated with this participant, if any. - Only applies to turn-based match participants.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

Retrieve the status of this participant. -

- Possible status values for room participants are - STATUS_INVITED, STATUS_JOINED, STATUS_DECLINED, and - STATUS_LEFT. -

- Possible status values for turn-based match participants are all of - the above, STATUS_NOT_INVITED_YET, STATUS_FINISHED, and - STATUS_UNRESPONSIVE.

-
-
Returns
-
  • Status of this participant. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isConnectedToRoom - () -

-
-
- - - -
-
- - - - -

Retrieves the connected status of the participant. If true indicates that participant is in - the connected set of the room. Only applies to room participants.

-
-
Returns
-
  • Connected status of the participant. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantResult.html deleted file mode 100644 index 82fb775f1b37..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantResult.html +++ /dev/null @@ -1,2259 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ParticipantResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ParticipantResult

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.ParticipantResult
- - - - - - - -
- - -

Class Overview

-

Data class used to report a participant's result in a match. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intMATCH_RESULT_DISAGREED - Constant indicating that this participant had different results reported by different - clients. - - - -
intMATCH_RESULT_DISCONNECT - Constant indicating that this participant disconnected or left during the match. - - - -
intMATCH_RESULT_LOSS - Constant indicating that this participant lost the match. - - - -
intMATCH_RESULT_NONE - Constant indicating that this participant had no result for the match. - - - -
intMATCH_RESULT_TIE - Constant indicating that this participant tied the match. - - - -
intMATCH_RESULT_UNINITIALIZED - Constant indicating that this participant has not reported a result at all yet. - - - -
intMATCH_RESULT_WIN - Constant indicating that this participant won the match. - - - -
intPLACING_UNINITIALIZED - Constant returned by getPlacing() if the participant has not reported a placing in - the match yet. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - ParticipantResultCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ParticipantResult(String participantId, int result, int placing) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getParticipantId() - -
- - - - - - int - - getPlacing() - -
- - - - - - int - - getResult() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - MATCH_RESULT_DISAGREED -

-
- - - - -
-
- - - - -

Constant indicating that this participant had different results reported by different - clients. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_DISCONNECT -

-
- - - - -
-
- - - - -

Constant indicating that this participant disconnected or left during the match. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_LOSS -

-
- - - - -
-
- - - - -

Constant indicating that this participant lost the match. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_NONE -

-
- - - - -
-
- - - - -

Constant indicating that this participant had no result for the match. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_TIE -

-
- - - - -
-
- - - - -

Constant indicating that this participant tied the match. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_UNINITIALIZED -

-
- - - - -
-
- - - - -

Constant indicating that this participant has not reported a result at all yet. This will - commonly be seen when the match is currently in progress. Note that this is distinct from - MATCH_RESULT_NONE, -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_RESULT_WIN -

-
- - - - -
-
- - - - -

Constant indicating that this participant won the match. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PLACING_UNINITIALIZED -

-
- - - - -
-
- - - - -

Constant returned by getPlacing() if the participant has not reported a placing in - the match yet. Usually seen when a match is still in progress. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - ParticipantResultCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ParticipantResult - (String participantId, int result, int placing) -

-
-
- - - -
-
- - - - -

-
-
Parameters
- - - - - - - - - - -
participantId - The ID of the participant this result is for.
result - The result type for this participant in the match. One of - MATCH_RESULT_WIN, MATCH_RESULT_LOSS, MATCH_RESULT_TIE, - MATCH_RESULT_NONE, MATCH_RESULT_DISCONNECT, or - MATCH_RESULT_DISAGREED.
placing - The placing of this participant in the match. Use - PLACING_UNINITIALIZED to indicate that no placing should be reported. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getParticipantId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the participant this result is for. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getPlacing - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The placing of this participant in the match. PLACING_UNINITIALIZED means - that this result has no placing value to report. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getResult - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantUtils.html b/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantUtils.html deleted file mode 100644 index d352265c22c3..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/ParticipantUtils.html +++ /dev/null @@ -1,1330 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ParticipantUtils | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ParticipantUtils

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.ParticipantUtils
- - - - - - - -
- - -

Class Overview

-

Utilities for working with multiplayer participants. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getParticipantId(ArrayList<Participant> participants, String playerId) - -
- Get the participant ID corresponding to a given player ID. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getParticipantId - (ArrayList<Participant> participants, String playerId) -

-
-
- - - -
-
- - - - -

Get the participant ID corresponding to a given player ID. If none of the provided - participants represent the provided player, the return value will be null.

-
-
Parameters
- - - - - - - -
participants - List of Participants to check.
playerId - The player ID to find participant ID for.
-
-
-
Returns
-
  • The participant ID of the given player, or null if not found. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/Participatable.html b/docs/html/reference/com/google/android/gms/games/multiplayer/Participatable.html deleted file mode 100644 index 351e4f787527..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/Participatable.html +++ /dev/null @@ -1,1190 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Participatable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Participatable

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.Participatable
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Interface defining methods for an object which can have participants. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ArrayList<Participant> - - getParticipants() - -
- Retrieve the Participants for this object. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ArrayList<Participant> - - getParticipants - () -

-
-
- - - -
-
- - - - -

Retrieve the Participants for this object. This is a list of all Participants - applicable to the given object.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/package-summary.html b/docs/html/reference/com/google/android/gms/games/multiplayer/package-summary.html deleted file mode 100644 index 50fc97761ec1..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/package-summary.html +++ /dev/null @@ -1,1032 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.multiplayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.multiplayer

-
- -
- -
- - -
- Contains data classes for multiplayer functionality. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Invitation - Data interface for an invitation object.  - - - -
Invitations - Entry point for invitations functionality.  - - - -
Invitations.LoadInvitationsResult - Result delivered when invitations have been loaded.  - - - -
Multiplayer - Common constants/methods for multiplayer functionality.  - - - -
OnInvitationReceivedListener - Listener to invoke when a new invitation is received.  - - - -
Participant - Data interface for multiplayer participants.  - - - -
Participatable - Interface defining methods for an object which can have participants.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
InvitationBuffer - EntityBuffer implementation containing Invitation data.  - - - -
InvitationEntity - Data object representing the data for a multiplayer invitation.  - - - -
ParticipantBuffer - AbstractDataBuffer implementation containing match participant data.  - - - -
ParticipantEntity - Data object representing a Participant in a match.  - - - -
ParticipantResult - Data class used to report a participant's result in a match.  - - - -
ParticipantUtils - Utilities for working with multiplayer participants.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html deleted file mode 100644 index 8ca16010f220..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html +++ /dev/null @@ -1,1835 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RealTimeMessage | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

RealTimeMessage

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.realtime.RealTimeMessage
- - - - - - - -
- - -

Class Overview

-

Message received from participants in a real-time room, which is passed to the client. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRELIABLE - - - - -
intUNRELIABLE - - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<RealTimeMessage>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - byte[] - - getMessageData() - -
- - - - - - String - - getSenderParticipantId() - -
- - - - - - boolean - - isReliable() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flag) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RELIABLE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNRELIABLE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<RealTimeMessage> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - byte[] - - getMessageData - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The message data. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSenderParticipantId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The participant ID of the message sender. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isReliable - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether this message was sent over a reliable channel. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flag) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html deleted file mode 100644 index 2b6406dbe35d..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html +++ /dev/null @@ -1,1072 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RealTimeMessageReceivedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

RealTimeMessageReceivedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.RealTimeMessageReceivedListener
- - - - - - - -
- - -

Class Overview

-

Listener for message received callback, which is called when the client receives a message - from a peer. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onRealTimeMessageReceived(RealTimeMessage message) - -
- Called to notify the client that a reliable or unreliable message was received for a - room. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onRealTimeMessageReceived - (RealTimeMessage message) -

-
-
- - - -
-
- - - - -

Called to notify the client that a reliable or unreliable message was received for a - room.

-
-
Parameters
- - - - -
message - The message that was received. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.ReliableMessageSentCallback.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.ReliableMessageSentCallback.html deleted file mode 100644 index 864979af0228..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.ReliableMessageSentCallback.html +++ /dev/null @@ -1,1086 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RealTimeMultiplayer.ReliableMessageSentCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

RealTimeMultiplayer.ReliableMessageSentCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.RealTimeMultiplayer.ReliableMessageSentCallback
- - - - - - - -
- - -

Class Overview

-

The listener for callback that is called when a reliable message is sent successfully. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onRealTimeMessageSent(int statusCode, int tokenId, String recipientParticipantId) - -
- Called to notify the client that a reliable message was sent for a room. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onRealTimeMessageSent - (int statusCode, int tokenId, String recipientParticipantId) -

-
-
- - - -
-
- - - - -

Called to notify the client that a reliable message was sent for a room. Possible status - codes include: -

-
-
Parameters
- - - - - - - - - - -
statusCode - A status code indicating the result of the operation.
tokenId - The ID of the message which was sent.
recipientParticipantId - The participant ID of the peer to whom the message was - sent. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.html deleted file mode 100644 index fc71b649a412..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.html +++ /dev/null @@ -1,2190 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RealTimeMultiplayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

RealTimeMultiplayer

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.RealTimeMultiplayer
- - - - - - - -
- - -

Class Overview

-

Entry point for real-time multiplayer functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceRealTimeMultiplayer.ReliableMessageSentCallback - The listener for callback that is called when a reliable message is sent successfully.  - - - -
- - - - - - - - - - - -
Constants
intREAL_TIME_MESSAGE_FAILED - Return value indicating immediate failure. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - create(GoogleApiClient apiClient, RoomConfig config) - -
- Create a real-time room for the current game. - - - -
- -
- abstract - - - - - void - - declineInvitation(GoogleApiClient apiClient, String invitationId) - -
- Decline an invitation for a real-time room. - - - -
- -
- abstract - - - - - void - - dismissInvitation(GoogleApiClient apiClient, String invitationId) - -
- Dismiss an invitation to a real-time room. - - - -
- -
- abstract - - - - - Intent - - getSelectOpponentsIntent(GoogleApiClient apiClient, int minPlayers, int maxPlayers, boolean allowAutomatch) - -
- Returns an intent that will let the user select opponents to send an invitation to for a - real-time multiplayer match. - - - -
- -
- abstract - - - - - Intent - - getSelectOpponentsIntent(GoogleApiClient apiClient, int minPlayers, int maxPlayers) - -
- Returns an intent that will let the user select opponents to send an invitation to for a - real-time multiplayer match. - - - -
- -
- abstract - - - - - Intent - - getWaitingRoomIntent(GoogleApiClient apiClient, Room room, int minParticipantsToStart) - -
- Returns an intent that will display a "waiting room" screen that shows the progress of - participants joining a real-time multiplayer room. - - - -
- -
- abstract - - - - - void - - join(GoogleApiClient apiClient, RoomConfig config) - -
- Join a real-time room by accepting an invitation. - - - -
- -
- abstract - - - - - void - - leave(GoogleApiClient apiClient, RoomUpdateListener listener, String roomId) - -
- Leave the specified room. - - - -
- -
- abstract - - - - - int - - sendReliableMessage(GoogleApiClient apiClient, RealTimeMultiplayer.ReliableMessageSentCallback listener, byte[] messageData, String roomId, String recipientParticipantId) - -
- Send a message to a participant in a real-time room reliably. - - - -
- -
- abstract - - - - - int - - sendUnreliableMessage(GoogleApiClient apiClient, byte[] messageData, String roomId, String recipientParticipantId) - -
- Send a message to a participant in a real-time room. - - - -
- -
- abstract - - - - - int - - sendUnreliableMessage(GoogleApiClient apiClient, byte[] messageData, String roomId, List<String> recipientParticipantIds) - -
- Send a message to one or more participants in a real-time room. - - - -
- -
- abstract - - - - - int - - sendUnreliableMessageToOthers(GoogleApiClient apiClient, byte[] messageData, String roomId) - -
- Send a message to all participants in a real-time room, excluding the current player. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - REAL_TIME_MESSAGE_FAILED -

-
- - - - -
-
- - - - -

Return value indicating immediate failure. Returned by - sendUnreliableMessage(GoogleApiClient, byte[], String, String) and - sendReliableMessage(GoogleApiClient, ReliableMessageSentCallback, byte[], String, String) - methods when the message send operation failed due to an error. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - create - (GoogleApiClient apiClient, RoomConfig config) -

-
-
- - - -
-
- - - - -

Create a real-time room for the current game. The lifetime of the current game's connection - to the room is bound to this GoogleApiClient's lifecycle. When the client - disconnects, the player will leave the room and any peer-to-peer connections for this player - will be torn down. The result is delivered by the callback - onRoomCreated(int, Room) to the given RoomUpdateListener in the - RoomConfig. The listener is called on the main thread. - 

- The room created by this API is a resource that needs to be released by
- leave(GoogleApiClient, RoomUpdateListener, String) when the caller is done
- with it.
- 

- Required API: API

- Required Scopes: SCOPE_GAMES
-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
config - The real-time room configuration. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - declineInvitation - (GoogleApiClient apiClient, String invitationId) -

-
-
- - - -
-
- - - - -

Decline an invitation for a real-time room. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationId - The ID of the invitation to decline. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - dismissInvitation - (GoogleApiClient apiClient, String invitationId) -

-
-
- - - -
-
- - - - -

Dismiss an invitation to a real-time room. Dismissing an invitation will not change the state - of the room for the other participants. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationId - The ID of the invitation to dismiss. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSelectOpponentsIntent - (GoogleApiClient apiClient, int minPlayers, int maxPlayers, boolean allowAutomatch) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user select opponents to send an invitation to for a - real-time multiplayer match. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- The number of players passed in should be the desired number of additional players to select, - not including the current player. So, for a game that can handle between 2 and 4 players, - minPlayers would be 1 and maxPlayers would be 3. -

- Players may be preselected by specifying a list of player IDs in the - EXTRA_PLAYER_IDS extra on the returned intent. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected players, the result will be RESULT_OK, and the data intent will - contain the selected player IDs in EXTRA_PLAYER_IDS and the minimum and maximum - numbers of additional auto-match players in EXTRA_MIN_AUTOMATCH_PLAYERS - and EXTRA_MAX_AUTOMATCH_PLAYERS respectively. The player IDs in - EXTRA_PLAYER_IDS will include only the other players selected, not the current - player. -

- If the allowAutomatch parameter is set to false, the UI will not display an option - for selecting automatch players. Set this to false if your game does not support - automatching. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
minPlayers - The minimum number of players to select (not including the current player).
maxPlayers - The maximum number of players to select (not including the current player).
allowAutomatch - Whether or not to display an option for selecting automatch players.
-
-
-
Returns
-
  • An Intent that can be started to display the player selector.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSelectOpponentsIntent - (GoogleApiClient apiClient, int minPlayers, int maxPlayers) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user select opponents to send an invitation to for a - real-time multiplayer match. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- The number of players passed in should be the desired number of additional players to select, - not including the current player. So, for a game that can handle between 2 and 4 players, - minPlayers would be 1 and maxPlayers would be 3. -

- Players may be preselected by specifying a list of player IDs in the - EXTRA_PLAYER_IDS extra on the returned intent. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected players, the result will be RESULT_OK, and the data intent will - contain the selected player IDs in EXTRA_PLAYER_IDS and the minimum and maximum - numbers of additional auto-match players in EXTRA_MIN_AUTOMATCH_PLAYERS - and EXTRA_MAX_AUTOMATCH_PLAYERS respectively. The player IDs in - EXTRA_PLAYER_IDS will include only the other players selected, not the current - player. -

- This method is the equivalent of calling - getSelectOpponentsIntent(GoogleApiClient, int, int, boolean) with the - allowAutomatch parameter set to true. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
minPlayers - The minimum number of players to select (not including the current player).
maxPlayers - The maximum number of players to select (not including the current player).
-
-
-
Returns
-
  • An Intent that can be started to display the player selector.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getWaitingRoomIntent - (GoogleApiClient apiClient, Room room, int minParticipantsToStart) -

-
-
- - - -
-
- - - - -

Returns an intent that will display a "waiting room" screen that shows the progress of - participants joining a real-time multiplayer room. Note that this must be invoked with - startActivityForResult(Intent, int), so that the identity of the calling - package can be established. -

- If the necessary number of peers have connected and it's now OK to start the game, or if the - user explicitly asked to start the game now, the activity result will be - RESULT_OK. If the user bailed out of the waiting room screen without taking - any action, the result will be RESULT_CANCELED. If the user explicitly chose - to leave the room, the result will be RESULT_LEFT_ROOM. If - the room no longer exists or is otherwise invalid the result will be - RESULT_INVALID_ROOM. -

- Regardless of what the result code was, the waiting room activity will return a data intent - containing a Room object in EXTRA_ROOM that represents the - current state of the Room that you originally passed as a parameter here. Note that the - returned room may be null if the room no longer exists. -

- If desired, the waiting room can allow the user to start playing the game even before the - room is fully connected. This is controlled by the minParticipantsToStart parameter: - if at least that many participants (including the current player) are connected to the room, - a "Start playing" menu item will become enabled in the waiting room UI. Setting - minParticipantsToStart to 0 means that "Start playing" will always be available, and - a value of MAX_VALUE will disable the item completely. Note: if you do allow - the user to start early, you'll need to handle that situation by explicitly telling the other - connected peers that the game is now starting; see the developer documentation for more - details. -

- Finally, note that the waiting room itself will never explicitly take any action to change - the state of the room or its participants. So if the activity result is - RESULT_LEFT_ROOM, it's the caller's responsibility to - actually leave the room. Or if the result is RESULT_CANCELED, it's the - responsibility of the caller to double-check the current state of the Room and decide whether - to start the game, keep waiting, or do something else. But note that while the waiting room - is active, the state of the Room will change as participants accept or - decline invitations, and the number of participants may even change as auto-match players get - added. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
room - The Room object to be displayed.
minParticipantsToStart - the minimum number of participants that must be connected to - the room (including the current player) for the "Start playing" menu item to - become enabled.
-
-
-
Returns
-
  • An Intent that can be started to display the waiting room screen.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - join - (GoogleApiClient apiClient, RoomConfig config) -

-
-
- - - -
-
- - - - -

Join a real-time room by accepting an invitation. The lifetime of the current game's - connection to the room is bound to this GoogleApiClient's lifecycle. When the client - disconnects, the player will leave the room and any peer-to-peer connections for this player - will be torn down. The result is delivered by the callback - onJoinedRoom(int, Room) to the given RoomUpdateListener in the - RoomConfig. The listener is called on the main thread. - 

- The room created by this API is a resource that needs to be released by
- leave(GoogleApiClient, RoomUpdateListener, String) when the caller is done
- with it.
- 

- Required API: API

- Required Scopes: SCOPE_GAMES
-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
config - The real-time room configuration. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - leave - (GoogleApiClient apiClient, RoomUpdateListener listener, String roomId) -

-
-
- - - -
-
- - - - -

Leave the specified room. This will disconnect the player from the room, but allow other - players to continue playing the game. The result is delivered by the callback - onLeftRoom(int, String) to the given listener on the main thread. -

- After this method is called, you cannot perform any further actions on the room. You can - create or join another room only after onLeftRoom(int, String) is received. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is notified after the room has been left. The listener is - called on the main thread.
roomId - ID of the room to leave. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - sendReliableMessage - (GoogleApiClient apiClient, RealTimeMultiplayer.ReliableMessageSentCallback listener, byte[] messageData, String roomId, String recipientParticipantId) -

-
-
- - - -
-
- - - - -

Send a message to a participant in a real-time room reliably. The caller will receive a - callback to report the status of the send message operation. Throws an - IllegalArgumentException if recipientParticipantId is not a valid participant or - belongs to the current player. The maximum message size supported is - MAX_RELIABLE_MESSAGE_LEN bytes. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is notified when the message has been sent.
messageData - The message to be sent. Should be at most - MAX_RELIABLE_MESSAGE_LEN bytes.
roomId - ID of the room for which the message is being sent.
recipientParticipantId - The participant ID to send the message to.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - sendUnreliableMessage - (GoogleApiClient apiClient, byte[] messageData, String roomId, String recipientParticipantId) -

-
-
- - - -
-
- - - - -

Send a message to a participant in a real-time room. The message delivery is not reliable and - will not report status after completion. Throws an IllegalArgumentException if - recipientParticipantId is not a valid participant or belongs to the current player. The - maximum message size supported is MAX_UNRELIABLE_MESSAGE_LEN bytes. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
messageData - The message to be sent. Should be at most - MAX_UNRELIABLE_MESSAGE_LEN bytes.
roomId - ID of the room for which the message is being sent.
recipientParticipantId - The participant ID to send the message to.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - sendUnreliableMessage - (GoogleApiClient apiClient, byte[] messageData, String roomId, List<String> recipientParticipantIds) -

-
-
- - - -
-
- - - - -

Send a message to one or more participants in a real-time room. The message delivery is not - reliable and will not report status after completion. Throws an - IllegalArgumentException if any participants in recipientParticipantIds are not valid - or belong to the current player. The maximum message size supported is - MAX_UNRELIABLE_MESSAGE_LEN bytes. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
messageData - The message to be sent. Should be at most - MAX_UNRELIABLE_MESSAGE_LEN bytes.
roomId - ID of the room for which the message is being sent.
recipientParticipantIds - One or more participant IDs to send the message to.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - sendUnreliableMessageToOthers - (GoogleApiClient apiClient, byte[] messageData, String roomId) -

-
-
- - - -
-
- - - - -

Send a message to all participants in a real-time room, excluding the current player. The - message delivery is not reliable and will not report status after completion. The maximum - message size supported is MAX_UNRELIABLE_MESSAGE_LEN bytes. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
messageData - The message to be sent. Should be at most - MAX_UNRELIABLE_MESSAGE_LEN bytes.
roomId - ID of the room for which the message is being sent.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html deleted file mode 100644 index 8ea005ea7cab..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/Room.html +++ /dev/null @@ -1,2453 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Room | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Room

- - - - - - implements - - Freezable<Room> - - Participatable - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.Room
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for room functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intROOM_STATUS_ACTIVE - Constant returned by getStatus() indicating that the room is active and connections - are established. - - - -
intROOM_STATUS_AUTO_MATCHING - Constant returned by getStatus() indicating that one or more slots are waiting to be - filled by auto-matching. - - - -
intROOM_STATUS_CONNECTING - Constant returned by getStatus() indicating that this room is waiting for clients to - connect to each other. - - - -
intROOM_STATUS_INVITING - Constant returned by getStatus() indicating that the room has one or more players - that have been invited and have not responded yet. - - - -
intROOM_VARIANT_DEFAULT - Constant used to indicate that the variant for a room is unspecified. - - - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the automatch criteria used to create or join this room, if any. - - - -
- -
- abstract - - - - - int - - getAutoMatchWaitEstimateSeconds() - -
- Retrieves the estimated wait time for automatching to finish for players who are not - automatched immediately, as measured from the time that the room entered the - automatching pool. - - - -
- -
- abstract - - - - - long - - getCreationTimestamp() - -
- abstract - - - - - String - - getCreatorId() - -
- abstract - - - - - String - - getDescription() - -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the room description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Participant - - getParticipant(String participantId) - -
- Get a participant in a room by its ID. - - - -
- -
- abstract - - - - - String - - getParticipantId(String playerId) - -
- Get the participant ID for a given player. - - - -
- -
- abstract - - - - - ArrayList<String> - - getParticipantIds() - -
- Get the IDs of the participants of the given room. - - - -
- -
- abstract - - - - - int - - getParticipantStatus(String participantId) - -
- Get the status of a participant in a room. - - - -
- -
- abstract - - - - - String - - getRoomId() - -
- abstract - - - - - int - - getStatus() - -
- abstract - - - - - int - - getVariant() - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ROOM_STATUS_ACTIVE -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the room is active and connections - are established. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ROOM_STATUS_AUTO_MATCHING -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that one or more slots are waiting to be - filled by auto-matching. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ROOM_STATUS_CONNECTING -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that this room is waiting for clients to - connect to each other. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ROOM_STATUS_INVITING -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the room has one or more players - that have been invited and have not responded yet. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ROOM_VARIANT_DEFAULT -

-
- - - - -
-
- - - - -

Constant used to indicate that the variant for a room is unspecified. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the automatch criteria used to create or join this room, if any. May be null if the - room has no automatch properties.

-
-
Returns
-
  • A bundle containing the automatch criteria for this room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getAutoMatchWaitEstimateSeconds - () -

-
-
- - - -
-
- - - - -

Retrieves the estimated wait time for automatching to finish for players who are not - automatched immediately, as measured from the time that the room entered the - automatching pool.

-
-
Returns
-
  • The estimated wait time in seconds, or -1 if the room is not - automatching or no estimate could be provided. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The server timestamp at which the room was created. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getCreatorId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the participant who created this Room. Note that not all participants will - see the same value for the creator. In the case of an automatch, this value may - differ for each participant. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Description of this room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the room description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Participant - - getParticipant - (String participantId) -

-
-
- - - -
-
- - - - -

Get a participant in a room by its ID. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
-
  • The participant corresponding to the given ID.
-
-
-
Throws
- - - - -
- IllegalStateException} if the participant is not a participant in this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getParticipantId - (String playerId) -

-
-
- - - -
-
- - - - -

Get the participant ID for a given player. This will only return a non-null ID if the player - is actually a participant in the room and that player's identity is visible to the current - player. Note that this will always return non-null for the current player.

-
-
Parameters
- - - - -
playerId - Player ID to find participant ID for.
-
-
-
Returns
-
  • The participant ID corresponding to given player, or null if none found. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ArrayList<String> - - getParticipantIds - () -

-
-
- - - -
-
- - - - -

Get the IDs of the participants of the given room.

-
-
Returns
-
  • The IDs of the participants in this room. These are returned in the participant - order of the room. Note that these are not stable across rooms. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getParticipantStatus - (String participantId) -

-
-
- - - -
-
- - - - -

Get the status of a participant in a room. Note that the participant ID must correspond to a - participant in this room, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Room-local ID of the participant to retrieve status for.
-
-
-
Returns
- -
-
-
Throws
- - - - -
- IllegalStateException} if the participant is not a participant in this room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getRoomId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of this Room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Variant specified for this room, if any. A variant is an optional - developer-controlled parameter describing the type of game to play. If specified, - this value will be a positive integer. If this room had no variant specified, returns - ROOM_VARIANT_DEFAULT. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html deleted file mode 100644 index 94f77fbf1edb..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html +++ /dev/null @@ -1,1806 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RoomConfig.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

RoomConfig.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.realtime.RoomConfig.Builder
- - - - - - - -
- - -

Class Overview

-

Builder class for RoomConfig. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - RoomConfig.Builder - - addPlayersToInvite(String... playerIds) - -
- Add one or more player IDs to invite to the room. - - - -
- -
- - - - - - RoomConfig.Builder - - addPlayersToInvite(ArrayList<String> playerIds) - -
- Add a list of player IDs to invite to the room. - - - -
- -
- - - - - - RoomConfig - - build() - -
- Builds a new RoomConfig object. - - - -
- -
- - - - - - RoomConfig.Builder - - setAutoMatchCriteria(Bundle autoMatchCriteria) - -
- Sets the auto-match criteria for the room. - - - -
- -
- - - - - - RoomConfig.Builder - - setInvitationIdToAccept(String invitationId) - -
- Set the ID of the invitation to accept. - - - -
- -
- - - - - - RoomConfig.Builder - - setMessageReceivedListener(RealTimeMessageReceivedListener listener) - -
- Set the listener for message received from a connected peer in a room. - - - -
- -
- - - - - - RoomConfig.Builder - - setRoomStatusUpdateListener(RoomStatusUpdateListener listener) - -
- Set the listener for room status changes. - - - -
- -
- - - - - - RoomConfig.Builder - - setVariant(int variant) - -
- Sets the variant for the room when calling - create(GoogleApiClient, RoomConfig). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - RoomConfig.Builder - - addPlayersToInvite - (String... playerIds) -

-
-
- - - -
-
- - - - -

Add one or more player IDs to invite to the room. This should be set only when calling - create(GoogleApiClient, RoomConfig)

-
-
Parameters
- - - - -
playerIds - One or more player IDs to invite to the room.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - addPlayersToInvite - (ArrayList<String> playerIds) -

-
-
- - - -
-
- - - - -

Add a list of player IDs to invite to the room. This should be set only when calling - create(GoogleApiClient, RoomConfig)

-
-
Parameters
- - - - -
playerIds - One or more player IDs to invite to the room.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig - - build - () -

-
-
- - - -
-
- - - - -

Builds a new RoomConfig object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - setAutoMatchCriteria - (Bundle autoMatchCriteria) -

-
-
- - - -
-
- - - - -

Sets the auto-match criteria for the room. See - createAutoMatchCriteria(int, int, long).

-
-
Parameters
- - - - -
autoMatchCriteria - The criteria for auto-matching one or more players for the - match. If null, the match is created with the invited players only.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - setInvitationIdToAccept - (String invitationId) -

-
-
- - - -
-
- - - - -

Set the ID of the invitation to accept. This is required and should be set only when - calling join(GoogleApiClient, RoomConfig).

-
-
Parameters
- - - - -
invitationId - The ID of the invitation to accept. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - setMessageReceivedListener - (RealTimeMessageReceivedListener listener) -

-
-
- - - -
-
- - - - -

Set the listener for message received from a connected peer in a room. -

- If not using socket-based communication, a non-null listener must be provided here before - constructing the RoomConfig object.

-
-
Parameters
- - - - -
listener - The message received listener that is called to notify the client when it - receives a message in a room. The listener is called on the main thread. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - setRoomStatusUpdateListener - (RoomStatusUpdateListener listener) -

-
-
- - - -
-
- - - - -

Set the listener for room status changes.

-
-
Parameters
- - - - -
listener - The listener that is called to notify the client when the status of the - room has changed. The listener is called on the main thread. -
-
- -
-
- - - - -
-

- - public - - - - - RoomConfig.Builder - - setVariant - (int variant) -

-
-
- - - -
-
- - - - -

Sets the variant for the room when calling - create(GoogleApiClient, RoomConfig). This is an optional, - developer-controlled parameter describing the type of game to play, and is used for - auto-matching criteria. Must be either a positive integer or - ROOM_VARIANT_DEFAULT (the default) if not desired. -

- Note that variants must match exactly. Thus, if you do not specify a variant, only other - rooms created with ROOM_VARIANT_DEFAULT will be considered potential - auto-matches.

-
-
Parameters
- - - - -
variant - The variant for the match.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html deleted file mode 100644 index d51b52c2b3a6..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html +++ /dev/null @@ -1,1922 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RoomConfig | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - | Protected Ctors - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

RoomConfig

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.realtime.RoomConfig
- - - - - - - -
- - -

Class Overview

-

Configuration for a new room. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classRoomConfig.Builder - Builder class for RoomConfig.  - - - -
- - - - - - - - - - -
Protected Constructors
- - - - - - - - RoomConfig() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - RoomConfig.Builder - - builder(RoomUpdateListener listener) - -
- Creates a builder for assembling a RoomConfig. - - - -
- -
- - - - static - - Bundle - - createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask) - -
- Creates an auto-match criteria Bundle for a new invitation. - - - -
- -
- abstract - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the criteria for auto-matching one or more players for the room. - - - -
- -
- abstract - - - - - String - - getInvitationId() - -
- Retrieves the ID of the invitation to accept, if any. - - - -
- -
- abstract - - - - - String[] - - getInvitedPlayerIds() - -
- Retrieves the player IDs to invite to the room. - - - -
- -
- abstract - - - - - RealTimeMessageReceivedListener - - getMessageReceivedListener() - -
- Retrieves the listener for message received from a peer. - - - -
- -
- abstract - - - - - RoomStatusUpdateListener - - getRoomStatusUpdateListener() - -
- Retrieves the listener for the room status changes. - - - -
- -
- abstract - - - - - RoomUpdateListener - - getRoomUpdateListener() - -
- Retrieves the listener that is called when operations complete. - - - -
- -
- abstract - - - - - int - - getVariant() - -
- Retrieves the (optional) developer-controlled parameter describing the type of game to play. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - RoomConfig - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - RoomConfig.Builder - - builder - (RoomUpdateListener listener) -

-
-
- - - -
-
- - - - -

Creates a builder for assembling a RoomConfig. The provided listener is required, and - must not be null. It will be invoked on the main thread when appropriate.

-
-
Parameters
- - - - -
listener - The listener to be invoked when the primary state of the room changes.
-
-
-
Returns
-
  • An instance of a builder. -
-
- -
-
- - - - -
-

- - public - static - - - - Bundle - - createAutoMatchCriteria - (int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask) -

-
-
- - - -
-
- - - - -

Creates an auto-match criteria Bundle for a new invitation. Can be passed to - setAutoMatchCriteria(Bundle).

-
-
Parameters
- - - - - - - - - - -
minAutoMatchPlayers - Minimum number of auto-matched players.
maxAutoMatchPlayers - Maximum number of auto-matched players.
exclusiveBitMask - Exclusive bitmasks for the automatching request. The logical AND of - each pairing of automatching requests must equal zero for auto-match. If there - are no exclusivity requirements for the game, this value should just be set to 0.
-
-
-
Returns
-
  • A bundle of auto-match criteria data. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the criteria for auto-matching one or more players for the room.

-
-
Returns
-
  • The criteria for auto-matching one or more players for the room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getInvitationId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of the invitation to accept, if any. This is necessary when calling - join(GoogleApiClient, RoomConfig).

-
-
Returns
-
  • The ID of the invitation to accept. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String[] - - getInvitedPlayerIds - () -

-
-
- - - -
-
- - - - -

Retrieves the player IDs to invite to the room.

-
-
Returns
-
  • The player IDs to invite to the room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - RealTimeMessageReceivedListener - - getMessageReceivedListener - () -

-
-
- - - -
-
- - - - -

Retrieves the listener for message received from a peer.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - RoomStatusUpdateListener - - getRoomStatusUpdateListener - () -

-
-
- - - -
-
- - - - -

Retrieves the listener for the room status changes.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - RoomUpdateListener - - getRoomUpdateListener - () -

-
-
- - - -
-
- - - - -

Retrieves the listener that is called when operations complete.

-
-
Returns
-
  • The listener that is called when operations complete. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

Retrieves the (optional) developer-controlled parameter describing the type of game to play. - Must be either a positive integer or ROOM_VARIANT_DEFAULT if not desired.

-
-
Returns
-
  • The developer-specified game variant. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html deleted file mode 100644 index 9e816bf22f64..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html +++ /dev/null @@ -1,3168 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RoomEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

RoomEntity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Room - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.realtime.RoomEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a room. This is immutable, andtherefore safe to cache or - store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - From interface -com.google.android.gms.games.multiplayer.realtime.Room -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<RoomEntity>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Room - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the automatch criteria used to create or join this room, if any. - - - -
- -
- - - - - - int - - getAutoMatchWaitEstimateSeconds() - -
- Retrieves the estimated wait time for automatching to finish for players who are not - automatched immediately, as measured from the time that the room entered the - automatching pool. - - - -
- -
- - - - - - long - - getCreationTimestamp() - -
- - - - - - String - - getCreatorId() - -
- - - - - - String - - getDescription() - -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the room description into the given CharArrayBuffer. - - - -
- -
- - - - - - Participant - - getParticipant(String participantId) - -
- Get a participant in a room by its ID. - - - -
- -
- - - - - - String - - getParticipantId(String playerId) - -
- Get the participant ID for a given player. - - - -
- -
- - - - - - ArrayList<String> - - getParticipantIds() - -
- Get the IDs of the participants of the given room. - - - -
- -
- - - - - - int - - getParticipantStatus(String participantId) - -
- Get the status of a participant in a room. - - - -
- -
- - - - - - ArrayList<Participant> - - getParticipants() - -
- Retrieve the Participants for this object. - - - -
- -
- - - - - - String - - getRoomId() - -
- - - - - - int - - getStatus() - -
- - - - - - int - - getVariant() - -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.realtime.Room - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<RoomEntity> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Room - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the automatch criteria used to create or join this room, if any. May be null if the - room has no automatch properties.

-
-
Returns
-
  • A bundle containing the automatch criteria for this room. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getAutoMatchWaitEstimateSeconds - () -

-
-
- - - -
-
- - - - -

Retrieves the estimated wait time for automatching to finish for players who are not - automatched immediately, as measured from the time that the room entered the - automatching pool.

-
-
Returns
-
  • The estimated wait time in seconds, or -1 if the room is not - automatching or no estimate could be provided. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCreatorId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the room description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Participant - - getParticipant - (String participantId) -

-
-
- - - -
-
- - - - -

Get a participant in a room by its ID. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
-
  • The participant corresponding to the given ID.
-
- -
-
- - - - -
-

- - public - - - - - String - - getParticipantId - (String playerId) -

-
-
- - - -
-
- - - - -

Get the participant ID for a given player. This will only return a non-null ID if the player - is actually a participant in the room and that player's identity is visible to the current - player. Note that this will always return non-null for the current player.

-
-
Parameters
- - - - -
playerId - Player ID to find participant ID for.
-
-
-
Returns
-
  • The participant ID corresponding to given player, or null if none found. -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<String> - - getParticipantIds - () -

-
-
- - - -
-
- - - - -

Get the IDs of the participants of the given room.

-
-
Returns
-
  • The IDs of the participants in this room. These are returned in the participant - order of the room. Note that these are not stable across rooms. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getParticipantStatus - (String participantId) -

-
-
- - - -
-
- - - - -

Get the status of a participant in a room. Note that the participant ID must correspond to a - participant in this room, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Room-local ID of the participant to retrieve status for.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - ArrayList<Participant> - - getParticipants - () -

-
-
- - - -
-
- - - - -

Retrieve the Participants for this object. This is a list of all Participants - applicable to the given object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getRoomId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html deleted file mode 100644 index 7ba673515178..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html +++ /dev/null @@ -1,1823 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RoomStatusUpdateListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

RoomStatusUpdateListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.RoomStatusUpdateListener
- - - - - - - -
- - -

Class Overview

-

Listener invoked when the status of a room, status of its participants or connection status of - the participants has changed. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onConnectedToRoom(Room room) - -
- Called when the client is connected to the connected set in a room. - - - -
- -
- abstract - - - - - void - - onDisconnectedFromRoom(Room room) - -
- Called when the client is disconnected from the connected set in a room. - - - -
- -
- abstract - - - - - void - - onP2PConnected(String participantId) - -
- Called when the client is successfully connected to a peer participant. - - - -
- -
- abstract - - - - - void - - onP2PDisconnected(String participantId) - -
- Called when client gets disconnected from a peer participant. - - - -
- -
- abstract - - - - - void - - onPeerDeclined(Room room, List<String> participantIds) - -
- Called when one or more peers decline the invitation to a room. - - - -
- -
- abstract - - - - - void - - onPeerInvitedToRoom(Room room, List<String> participantIds) - -
- Called when one or more peers are invited to a room. - - - -
- -
- abstract - - - - - void - - onPeerJoined(Room room, List<String> participantIds) - -
- Called when one or more peer participants join a room. - - - -
- -
- abstract - - - - - void - - onPeerLeft(Room room, List<String> participantIds) - -
- Called when one or more peer participant leave a room. - - - -
- -
- abstract - - - - - void - - onPeersConnected(Room room, List<String> participantIds) - -
- Called when one or more peer participants are connected to a room. - - - -
- -
- abstract - - - - - void - - onPeersDisconnected(Room room, List<String> participantIds) - -
- Called when one or more peer participants are disconnected from a room. - - - -
- -
- abstract - - - - - void - - onRoomAutoMatching(Room room) - -
- Called when the server has started the process of auto-matching. - - - -
- -
- abstract - - - - - void - - onRoomConnecting(Room room) - -
- Called when one or more participants have joined the room and have started - the process of establishing peer connections. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onConnectedToRoom - (Room room) -

-
-
- - - -
-
- - - - -

Called when the client is connected to the connected set in a room.

-
-
Parameters
- - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onDisconnectedFromRoom - (Room room) -

-
-
- - - -
-
- - - - -

Called when the client is disconnected from the connected set in a room.

-
-
Parameters
- - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onP2PConnected - (String participantId) -

-
-
- - - -
-
- - - - -

Called when the client is successfully connected to a peer participant.

-
-
Parameters
- - - - -
participantId - ID of the peer participant who was successfully connected. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onP2PDisconnected - (String participantId) -

-
-
- - - -
-
- - - - -

Called when client gets disconnected from a peer participant.

-
-
Parameters
- - - - -
participantId - ID of the peer participant who was disconnected. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeerDeclined - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peers decline the invitation to a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of the peers invited to a room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeerInvitedToRoom - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peers are invited to a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of the peers invited to a room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeerJoined - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peer participants join a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of peer participants who joined a room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeerLeft - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peer participant leave a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of peer participants who left the room. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeersConnected - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peer participants are connected to a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of peer participants who were connected. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeersDisconnected - (Room room, List<String> participantIds) -

-
-
- - - -
-
- - - - -

Called when one or more peer participants are disconnected from a room.

-
-
Parameters
- - - - - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully.
participantIds - IDs of peer participants who were disconnected. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onRoomAutoMatching - (Room room) -

-
-
- - - -
-
- - - - -

Called when the server has started the process of auto-matching. Any invited participants - must have joined and fully connected to each other before this will occur.

-
-
Parameters
- - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onRoomConnecting - (Room room) -

-
-
- - - -
-
- - - - -

Called when one or more participants have joined the room and have started - the process of establishing peer connections.

-
-
Parameters
- - - - -
room - The room data with the status of a room and its participants. The room can be - null if it could not be loaded successfully. - -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html deleted file mode 100644 index 5157adbd6a8f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html +++ /dev/null @@ -1,1317 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RoomUpdateListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

RoomUpdateListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.realtime.RoomUpdateListener
- - - - - - - -
- - -

Class Overview

-

The listener invoked when the state of the room has changed. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onJoinedRoom(int statusCode, Room room) - -
- Called when the client attempts to join a real-time room. - - - -
- -
- abstract - - - - - void - - onLeftRoom(int statusCode, String roomId) - -
- Called when the client attempts to leaves the real-time room. - - - -
- -
- abstract - - - - - void - - onRoomConnected(int statusCode, Room room) - -
- Called when all the participants in a real-time room are fully connected. - - - -
- -
- abstract - - - - - void - - onRoomCreated(int statusCode, Room room) - -
- Called when the client attempts to create a real-time room. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onJoinedRoom - (int statusCode, Room room) -

-
-
- - - -
-
- - - - -

Called when the client attempts to join a real-time room. The real-time room can be joined by - calling the join(GoogleApiClient, RoomConfig) operation. Possible status codes include: -

-
-
Parameters
- - - - - - - -
statusCode - A status code indicating the result of the operation.
room - The data of the room that was joined. The room can be null if the - join(GoogleApiClient, RoomConfig) operation failed. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onLeftRoom - (int statusCode, String roomId) -

-
-
- - - -
-
- - - - -

Called when the client attempts to leaves the real-time room. Possible status codes include: -

-
-
Parameters
- - - - - - - -
statusCode - A status code indicating the result of the operation.
roomId - ID of the real-time room which was left. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onRoomConnected - (int statusCode, Room room) -

-
-
- - - -
-
- - - - -

Called when all the participants in a real-time room are fully connected. This gets called - once all invitations are accepted and any necessary automatching has been completed. Possible - status codes include: -

-
-
Parameters
- - - - -
room - The fully connected room object. The room can be null if it could not be - loaded successfully. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onRoomCreated - (int statusCode, Room room) -

-
-
- - - -
-
- - - - -

Called when the client attempts to create a real-time room. The real-time room can be created - by calling the create(GoogleApiClient, RoomConfig) operation. Possible status codes include: -

-
-
Parameters
- - - - - - - -
statusCode - A status code indicating the result of the operation.
room - The room data that was created if successful. The room can be null if the - create(GoogleApiClient, RoomConfig) operation failed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html b/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html deleted file mode 100644 index c9cd07a81f2c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html +++ /dev/null @@ -1,1001 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.multiplayer.realtime | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.multiplayer.realtime

-
- -
- -
- - -
- Contains data classes for real-time multiplayer functionality. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RealTimeMessageReceivedListener - Listener for message received callback, which is called when the client receives a message - from a peer.  - - - -
RealTimeMultiplayer - Entry point for real-time multiplayer functionality.  - - - -
RealTimeMultiplayer.ReliableMessageSentCallback - The listener for callback that is called when a reliable message is sent successfully.  - - - -
Room - Data interface for room functionality.  - - - -
RoomStatusUpdateListener - Listener invoked when the status of a room, status of its participants or connection status of - the participants has changed.  - - - -
RoomUpdateListener - The listener invoked when the state of the room has changed.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RealTimeMessage - Message received from participants in a real-time room, which is passed to the client.  - - - -
RoomConfig - Configuration for a new room.  - - - -
RoomConfig.Builder - Builder class for RoomConfig.  - - - -
RoomEntity - Data object representing the data for a room.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/LoadMatchesResponse.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/LoadMatchesResponse.html deleted file mode 100644 index 044ad30d5570..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/LoadMatchesResponse.html +++ /dev/null @@ -1,1687 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LoadMatchesResponse | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LoadMatchesResponse

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.turnbased.LoadMatchesResponse
- - - - - - - -
- - -

Class Overview

-

Response object containing the data requested in a - loadMatchesByStatus(GoogleApiClient, int, int[]) call. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - close() - -
- - This method is deprecated. - See release() for the correct method. - - - - -
- -
- - - - - - TurnBasedMatchBuffer - - getCompletedMatches() - -
- Get the completed matches returned from this request. - - - -
- -
- - - - - - InvitationBuffer - - getInvitations() - -
- Get the invitations returned from this request. - - - -
- -
- - - - - - TurnBasedMatchBuffer - - getMyTurnMatches() - -
- Get the "my turn" matches returned from this request. - - - -
- -
- - - - - - TurnBasedMatchBuffer - - getTheirTurnMatches() - -
- Get the "their turn" matches returned from this request. - - - -
- -
- - - - - - boolean - - hasData() - -
- Helper method to return whether or not this response contains any data. - - - -
- -
- - - - - - void - - release() - -
- Release all the buffers stored in this response. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - close - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- See release() for the correct method. - -

-

Close all the buffers stored in this response. Note that using one of these buffers after - calling this method will result in an error.

- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchBuffer - - getCompletedMatches - () -

-
-
- - - -
-
- - - - -

Get the completed matches returned from this request. Note that if the original request did - not include MATCH_TURN_STATUS_COMPLETE, this method will return null.

-
-
Returns
-
  • The matches returned from this request, or null if completed matches were not - originally requested. -
-
- -
-
- - - - -
-

- - public - - - - - InvitationBuffer - - getInvitations - () -

-
-
- - - -
-
- - - - -

Get the invitations returned from this request. Note that if the original request did not - include MATCH_TURN_STATUS_INVITED, this method will return null.

-
-
Returns
-
  • The invitations returned from this request, or null if invitations were not - originally requested. -
-
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchBuffer - - getMyTurnMatches - () -

-
-
- - - -
-
- - - - -

Get the "my turn" matches returned from this request. Note that if the original request did - not include MATCH_TURN_STATUS_MY_TURN, this method will return null.

-
-
Returns
-
  • The matches returned from this request, or null if "my turn" matches were not - originally requested. -
-
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchBuffer - - getTheirTurnMatches - () -

-
-
- - - -
-
- - - - -

Get the "their turn" matches returned from this request. Note that if the original request - did not include MATCH_TURN_STATUS_THEIR_TURN, this method will return - null.

-
-
Returns
-
  • The matches returned from this request, or null if "their turn" matches were not - originally requested. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasData - () -

-
-
- - - -
-
- - - - -

Helper method to return whether or not this response contains any data.

-
-
Returns
-
  • whether or not this response contains any non-empty buffers. -
-
- -
-
- - - - -
-

- - public - - - - - void - - release - () -

-
-
- - - -
-
- - - - -

Release all the buffers stored in this response. Note that using one of these buffers after - calling this method will result in an error. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/OnTurnBasedMatchUpdateReceivedListener.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/OnTurnBasedMatchUpdateReceivedListener.html deleted file mode 100644 index ef1e136c1ec2..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/OnTurnBasedMatchUpdateReceivedListener.html +++ /dev/null @@ -1,1136 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnTurnBasedMatchUpdateReceivedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnTurnBasedMatchUpdateReceivedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.OnTurnBasedMatchUpdateReceivedListener
- - - - - - - -
- - -

Class Overview

-

Listener invoked when an update to a turn-based match is received. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onTurnBasedMatchReceived(TurnBasedMatch match) - -
- Callback invoked when a new update to a match arrives. - - - -
- -
- abstract - - - - - void - - onTurnBasedMatchRemoved(String matchId) - -
- Callback invoked when a match has been removed from the local device. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onTurnBasedMatchReceived - (TurnBasedMatch match) -

-
-
- - - -
-
- - - - -

Callback invoked when a new update to a match arrives. Note that if a listener receives this - callback, the system will not display a notification for this event.

-
-
Parameters
- - - - -
match - The match that was received. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onTurnBasedMatchRemoved - (String matchId) -

-
-
- - - -
-
- - - - -

Callback invoked when a match has been removed from the local device. For example, this might - occur if the player leaves the match on another device.

-
-
Parameters
- - - - -
matchId - The ID of the match that has been removed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatch.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatch.html deleted file mode 100644 index 4bc134862923..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatch.html +++ /dev/null @@ -1,3631 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMatch | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

TurnBasedMatch

- - - - - - implements - - Freezable<TurnBasedMatch> - - Participatable - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for turn-based specific match functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intMATCH_STATUS_ACTIVE - Constant returned by getStatus() indicating that the match has started. - - - -
intMATCH_STATUS_AUTO_MATCHING - Constant returned by getStatus() indicating that one or more slots are waiting to be - filled by auto-matching. - - - -
intMATCH_STATUS_CANCELED - Constant returned by getStatus() indicating that the match was canceled by one of - the participants. - - - -
intMATCH_STATUS_COMPLETE - Constant returned by getStatus() indicating that the match has finished. - - - -
intMATCH_STATUS_EXPIRED - Constant returned by getStatus() indicating that the match expired. - - - -
intMATCH_TURN_STATUS_COMPLETE - Turn status constant for matches which have been completed. - - - -
intMATCH_TURN_STATUS_INVITED - Turn status constant for matches which the current player has been invited to. - - - -
intMATCH_TURN_STATUS_MY_TURN - Turn status constant for matches where it is the current player's turn. - - - -
intMATCH_TURN_STATUS_THEIR_TURN - Turn status constant for matches where it is not the current player's turn. - - - -
intMATCH_VARIANT_DEFAULT - Constant used to indicate that the variant for a match is unspecified. - - - -
- - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - int[]MATCH_TURN_STATUS_ALL - Array of all the turn status constants. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - canRematch() - -
- Return whether or not this match can be rematched. - - - -
- -
- abstract - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the automatch criteria used to create or join this match, if any. - - - -
- -
- abstract - - - - - int - - getAvailableAutoMatchSlots() - -
- Return the maximum number of available automatch slots for this match. - - - -
- -
- abstract - - - - - long - - getCreationTimestamp() - -
- abstract - - - - - String - - getCreatorId() - -
- abstract - - - - - byte[] - - getData() - -
- Return the current (game-specific) data for this match. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the match description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Participant - - getDescriptionParticipant() - -
- Get the participant representing the primary opponent in the match. - - - -
- -
- abstract - - - - - String - - getDescriptionParticipantId() - -
- Get the ID of another participant in the match that can be used when describing the - participants the user is playing with. - - - -
- -
- abstract - - - - - Game - - getGame() - -
- abstract - - - - - long - - getLastUpdatedTimestamp() - -
- Return the timestamp at which the match was last modified. - - - -
- -
- abstract - - - - - String - - getLastUpdaterId() - -
- Return the ID of the participant who updated the match most recently. - - - -
- -
- abstract - - - - - String - - getMatchId() - -
- abstract - - - - - int - - getMatchNumber() - -
- Return the match sequence number for this match. - - - -
- -
- abstract - - - - - Participant - - getParticipant(String participantId) - -
- Get a participant in a match by its ID. - - - -
- -
- abstract - - - - - String - - getParticipantId(String playerId) - -
- Get the participant ID for a given player. - - - -
- -
- abstract - - - - - ArrayList<String> - - getParticipantIds() - -
- Get the IDs of the participants of the given match. - - - -
- -
- abstract - - - - - int - - getParticipantStatus(String participantId) - -
- Get the status of a participant in a match. - - - -
- -
- abstract - - - - - String - - getPendingParticipantId() - -
- Return the ID of the participant that is considered pending. - - - -
- -
- abstract - - - - - byte[] - - getPreviousMatchData() - -
- Return the match data from the previous match, if available. - - - -
- -
- abstract - - - - - String - - getRematchId() - -
- Return the match ID of the rematch that was created from this match, if any. - - - -
- -
- abstract - - - - - int - - getStatus() - -
- abstract - - - - - int - - getTurnStatus() - -
- abstract - - - - - int - - getVariant() - -
- abstract - - - - - int - - getVersion() - -
- Return the current version of the match. - - - -
- -
- abstract - - - - - boolean - - isLocallyModified() - -
- Return whether or not this match has been locally modified. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - MATCH_STATUS_ACTIVE -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the match has started. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_STATUS_AUTO_MATCHING -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that one or more slots are waiting to be - filled by auto-matching. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_STATUS_CANCELED -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the match was canceled by one of - the participants. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_STATUS_COMPLETE -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the match has finished. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_STATUS_EXPIRED -

-
- - - - -
-
- - - - -

Constant returned by getStatus() indicating that the match expired. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_TURN_STATUS_COMPLETE -

-
- - - - -
-
- - - - -

Turn status constant for matches which have been completed. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_TURN_STATUS_INVITED -

-
- - - - -
-
- - - - -

Turn status constant for matches which the current player has been invited to. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_TURN_STATUS_MY_TURN -

-
- - - - -
-
- - - - -

Turn status constant for matches where it is the current player's turn. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_TURN_STATUS_THEIR_TURN -

-
- - - - -
-
- - - - -

Turn status constant for matches where it is not the current player's turn. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MATCH_VARIANT_DEFAULT -

-
- - - - -
-
- - - - -

Constant used to indicate that the variant for a match is unspecified. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - int[] - - MATCH_TURN_STATUS_ALL -

-
- - - - -
-
- - - - -

Array of all the turn status constants. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - canRematch - () -

-
-
- - - -
-
- - - - -

Return whether or not this match can be rematched. This will return true when the match has - complete and has not already been rematched.

-
-
Returns
-
  • Whether or not this match can be rematched. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the automatch criteria used to create or join this match, if any. May be null if - the match has no automatch properties.

-
-
Returns
-
  • A bundle containing the automatch criteria for this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getAvailableAutoMatchSlots - () -

-
-
- - - -
-
- - - - -

Return the maximum number of available automatch slots for this match. If automatch criteria - were not specified during match creation, or if all slots have been filled, this will return - 0.

-
-
Returns
-
  • The maximum number of additional players that can be added to this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The server timestamp at which the match was created. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getCreatorId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the participant who created this Match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

Return the current (game-specific) data for this match.

-
-
Returns
-
  • Byte array representing the current (game-specific) match state data. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Description of this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the match description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Participant - - getDescriptionParticipant - () -

-
-
- - - -
-
- - - - -

Get the participant representing the primary opponent in the match. -

- Note that this will return null if there is no primary opponent. This could happen if - an automatch slot has not been filled.

-
-
Returns
-
  • The participant representing the primary opponent in the match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescriptionParticipantId - () -

-
-
- - - -
-
- - - - -

Get the ID of another participant in the match that can be used when describing the - participants the user is playing with. For example, in a four player match this might be used - to state "Martha (and 2 others)". -

- Note that this will return null if there is no primary opponent. This could happen if - an automatch slot has not been filled.

-
-
Returns
-
  • The participant ID of the primary opponent in the match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The Game object that owns this Match. Note that this should not be cached - separately from the Match itself, since the data underlying this object may change. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Return the timestamp at which the match was last modified.

-
-
Returns
-
  • The server timestamp at which the match was last modified. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getLastUpdaterId - () -

-
-
- - - -
-
- - - - -

Return the ID of the participant who updated the match most recently.

-
-
Returns
-
  • The ID of the last participant who updated this Match object. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getMatchId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of this Match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMatchNumber - () -

-
-
- - - -
-
- - - - -

Return the match sequence number for this match. This number starts at 1, and increases every - time a rematch is created.

-
-
Returns
-
  • The match sequence number for this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Participant - - getParticipant - (String participantId) -

-
-
- - - -
-
- - - - -

Get a participant in a match by its ID. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
-
  • The participant corresponding to the given ID.
-
-
-
Throws
- - - - -
- IllegalStateException} if the participant is not a participant in this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getParticipantId - (String playerId) -

-
-
- - - -
-
- - - - -

Get the participant ID for a given player. This will only return a non-null ID if the player - is actually a participant in the match and that player's identity is visible to the current - player. Note that this will always return non-null for the current player. -

- To find the player ID for the current player, use getCurrentPlayerId(GoogleApiClient).

-
-
Parameters
- - - - -
playerId - Player ID to find participant ID for.
-
-
-
Returns
-
  • The participant ID corresponding to given player, or null if none found. -
-
- -
-
- - - - -
-

- - public - - - abstract - - ArrayList<String> - - getParticipantIds - () -

-
-
- - - -
-
- - - - -

Get the IDs of the participants of the given match.

-
-
Returns
-
  • The IDs of the participants in this match. These are returned in the participant - order of the match. Note that these are not stable across matches. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getParticipantStatus - (String participantId) -

-
-
- - - -
-
- - - - -

Get the status of a participant in a match. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
- -
-
-
Throws
- - - - -
- IllegalStateException} if the participant is not a participant in this match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPendingParticipantId - () -

-
-
- - - -
-
- - - - -

Return the ID of the participant that is considered pending. If no participant is considered - pending (ie, the match is over, etc), this function will return null.

-
-
Returns
-
  • The ID of the participant that is considered pending, if any. Returns null if no - participant is pending. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getPreviousMatchData - () -

-
-
- - - -
-
- - - - -

Return the match data from the previous match, if available. Note that this is only provided - on the first turn of a rematched match.

-
-
Returns
-
  • Byte array of data from the previous match of a rematch, or null if not available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getRematchId - () -

-
-
- - - -
-
- - - - -

Return the match ID of the rematch that was created from this match, if any. This will only - be non-null if a rematch has been created.

-
-
Returns
-
  • The match ID of the rematch, or null if no rematch exists. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getTurnStatus - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Variant specified for this match, if any. A variant is an optional - developer-controlled parameter describing the type of game to play, ranging from - 1-1023 (inclusive). If this match had no variant specified, returns - MATCH_VARIANT_DEFAULT. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVersion - () -

-
-
- - - -
-
- - - - -

Return the current version of the match.

-
-
Returns
-
  • The current version of the match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isLocallyModified - () -

-
-
- - - -
-
- - - - -

Return whether or not this match has been locally modified. If this is true, the local device - has match state which has not successfully synced to the server yet. In this state, further - mutations to the match will fail with a status of - STATUS_MATCH_ERROR_LOCALLY_MODIFIED.

-
-
Returns
-
  • Whether this match has local modifications or not. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchBuffer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchBuffer.html deleted file mode 100644 index 9209e5dcfbbf..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchBuffer.html +++ /dev/null @@ -1,1864 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMatchBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

TurnBasedMatchBuffer

- - - - - - - - - extends AbstractDataBuffer<TurnBasedMatch>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch>
    ↳com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchBuffer
- - - - - - - -
- - -

Class Overview

-

EntityBuffer implementation containing TurnBasedMatch details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - TurnBasedMatch - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - TurnBasedMatch - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.Builder.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.Builder.html deleted file mode 100644 index cf65d3ae7a7f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.Builder.html +++ /dev/null @@ -1,1601 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMatchConfig.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

TurnBasedMatchConfig.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig.Builder
- - - - - - - -
- - -

Class Overview

-

Builder class for TurnBasedMatchConfig. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - TurnBasedMatchConfig.Builder - - addInvitedPlayer(String playerId) - -
- Add a player ID to invite to the match. - - - -
- -
- - - - - - TurnBasedMatchConfig.Builder - - addInvitedPlayers(ArrayList<String> playerIds) - -
- Add a list of player IDs to invite to the match. - - - -
- -
- - - - - - TurnBasedMatchConfig - - build() - -
- Builds a new TurnBasedMatchConfig object. - - - -
- -
- - - - - - TurnBasedMatchConfig.Builder - - setAutoMatchCriteria(Bundle autoMatchCriteria) - -
- Sets the auto-match criteria for the match. - - - -
- -
- - - - - - TurnBasedMatchConfig.Builder - - setVariant(int variant) - -
- Sets the variant for the match. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - TurnBasedMatchConfig.Builder - - addInvitedPlayer - (String playerId) -

-
-
- - - -
-
- - - - -

Add a player ID to invite to the match.

-
-
Parameters
- - - - -
playerId - Player ID to invite to the match.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchConfig.Builder - - addInvitedPlayers - (ArrayList<String> playerIds) -

-
-
- - - -
-
- - - - -

Add a list of player IDs to invite to the match.

-
-
Parameters
- - - - -
playerIds - One or more player IDs to invite to the match.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchConfig - - build - () -

-
-
- - - -
-
- - - - -

Builds a new TurnBasedMatchConfig object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchConfig.Builder - - setAutoMatchCriteria - (Bundle autoMatchCriteria) -

-
-
- - - -
-
- - - - -

Sets the auto-match criteria for the match. See - createAutoMatchCriteria(int, int, long).

-
-
Parameters
- - - - -
autoMatchCriteria - The criteria for auto-matching one or more players for the - match. If null, the match is created with the invited players only.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - -
-

- - public - - - - - TurnBasedMatchConfig.Builder - - setVariant - (int variant) -

-
-
- - - -
-
- - - - -

Sets the variant for the match. This is an optional, developer-controlled parameter - describing the type of game to play, and is used for auto-matching criteria. Must be - either a positive integer, or MATCH_VARIANT_DEFAULT (the default) - if not desired. -

- Note that variants must match exactly. Thus, if you do not specify a variant, only other - matches created with MATCH_VARIANT_DEFAULT will be considered - potential auto-matches.

-
-
Parameters
- - - - -
variant - The variant for the match.
-
-
-
Returns
-
  • The builder instance. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.html deleted file mode 100644 index 51fa3614ca80..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.html +++ /dev/null @@ -1,1668 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMatchConfig | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - | Protected Ctors - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

TurnBasedMatchConfig

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig
- - - - - - - -
- - -

Class Overview

-

Configuration for creating a new turn-based match. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classTurnBasedMatchConfig.Builder - Builder class for TurnBasedMatchConfig.  - - - -
- - - - - - - - - - -
Protected Constructors
- - - - - - - - TurnBasedMatchConfig() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - TurnBasedMatchConfig.Builder - - builder() - -
- Creates a builder for assembling a TurnBasedMatchConfig. - - - -
- -
- - - - static - - Bundle - - createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask) - -
- Creates an auto-match criteria Bundle. - - - -
- -
- abstract - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the criteria for auto-matching one or more players for the match. - - - -
- -
- abstract - - - - - String[] - - getInvitedPlayerIds() - -
- Retrieves the player IDs to invite to the match. - - - -
- -
- abstract - - - - - int - - getVariant() - -
- Retrieves the developer-specified match variant. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - TurnBasedMatchConfig - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - TurnBasedMatchConfig.Builder - - builder - () -

-
-
- - - -
-
- - - - -

Creates a builder for assembling a TurnBasedMatchConfig.

-
-
Returns
-
  • An instance of a builder. -
-
- -
-
- - - - -
-

- - public - static - - - - Bundle - - createAutoMatchCriteria - (int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask) -

-
-
- - - -
-
- - - - -

Creates an auto-match criteria Bundle. Can be passed to - createMatch(GoogleApiClient, TurnBasedMatchConfig) to create a match for a turn-based game.

-
-
Parameters
- - - - - - - - - - -
minAutoMatchPlayers - min number of auto-matched players.
maxAutoMatchPlayers - max number of auto-matched players.
exclusiveBitMask - exclusive bitmask for exclusive roles for the player. The exclusive - bitmask of each pairing of players must equal zero for auto-match.
-
-
-
Returns
-
  • bundle of auto-match criteria data. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the criteria for auto-matching one or more players for the match.

-
-
Returns
-
  • The criteria for auto-matching one or more players for the match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String[] - - getInvitedPlayerIds - () -

-
-
- - - -
-
- - - - -

Retrieves the player IDs to invite to the match.

-
-
Returns
-
  • The player IDs to invite to the match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

Retrieves the developer-specified match variant.

-
-
Returns
-
  • The developer-specified match variant. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchEntity.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchEntity.html deleted file mode 100644 index 10403f767940..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchEntity.html +++ /dev/null @@ -1,4428 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMatchEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - | Inherited Fields - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

TurnBasedMatchEntity

- - - - - extends Object
- - - - - - - implements - - TurnBasedMatch - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a turn-based match. This is immutable, and therefore safe - to cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - TurnBasedMatchEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From interface -com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - canRematch() - -
- Return whether or not this match can be rematched. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - TurnBasedMatch - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - Bundle - - getAutoMatchCriteria() - -
- Retrieves the automatch criteria used to create or join this match, if any. - - - -
- -
- - - - - - int - - getAvailableAutoMatchSlots() - -
- Return the maximum number of available automatch slots for this match. - - - -
- -
- - - - - - long - - getCreationTimestamp() - -
- - - - - - String - - getCreatorId() - -
- - - - - - byte[] - - getData() - -
- Return the current (game-specific) data for this match. - - - -
- -
- - - - - - String - - getDescription() - -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the match description into the given CharArrayBuffer. - - - -
- -
- - - - - - Participant - - getDescriptionParticipant() - -
- Get the participant representing the primary opponent in the match. - - - -
- -
- - - - - - String - - getDescriptionParticipantId() - -
- Get the ID of another participant in the match that can be used when describing the - participants the user is playing with. - - - -
- -
- - - - - - Game - - getGame() - -
- - - - - - long - - getLastUpdatedTimestamp() - -
- Return the timestamp at which the match was last modified. - - - -
- -
- - - - - - String - - getLastUpdaterId() - -
- Return the ID of the participant who updated the match most recently. - - - -
- -
- - - - - - String - - getMatchId() - -
- - - - - - int - - getMatchNumber() - -
- Return the match sequence number for this match. - - - -
- -
- - - - - - Participant - - getParticipant(String participantId) - -
- Get a participant in a match by its ID. - - - -
- -
- - - - - - String - - getParticipantId(String playerId) - -
- Get the participant ID for a given player. - - - -
- -
- - - - - - ArrayList<String> - - getParticipantIds() - -
- Get the IDs of the participants of the given match. - - - -
- -
- - - - - - int - - getParticipantStatus(String participantId) - -
- Get the status of a participant in a match. - - - -
- -
- - - - - - ArrayList<Participant> - - getParticipants() - -
- Retrieve the Participants for this object. - - - -
- -
- - - - - - String - - getPendingParticipantId() - -
- Return the ID of the participant that is considered pending. - - - -
- -
- - - - - - byte[] - - getPreviousMatchData() - -
- Return the match data from the previous match, if available. - - - -
- -
- - - - - - String - - getRematchId() - -
- Return the match ID of the rematch that was created from this match, if any. - - - -
- -
- - - - - - int - - getStatus() - -
- - - - - - int - - getTurnStatus() - -
- - - - - - int - - getVariant() - -
- - - - - - int - - getVersion() - -
- Return the current version of the match. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - boolean - - isLocallyModified() - -
- Return whether or not this match has been locally modified. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - com.google.android.gms.games.multiplayer.Participatable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - TurnBasedMatchEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - canRematch - () -

-
-
- - - -
-
- - - - -

Return whether or not this match can be rematched. This will return true when the match has - complete and has not already been rematched.

-
-
Returns
-
  • Whether or not this match can be rematched. -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - TurnBasedMatch - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - Bundle - - getAutoMatchCriteria - () -

-
-
- - - -
-
- - - - -

Retrieves the automatch criteria used to create or join this match, if any. May be null if - the match has no automatch properties.

-
-
Returns
-
  • A bundle containing the automatch criteria for this match. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getAvailableAutoMatchSlots - () -

-
-
- - - -
-
- - - - -

Return the maximum number of available automatch slots for this match. If automatch criteria - were not specified during match creation, or if all slots have been filled, this will return - 0.

-
-
Returns
-
  • The maximum number of additional players that can be added to this match. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCreatorId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

Return the current (game-specific) data for this match.

-
-
Returns
-
  • Byte array representing the current (game-specific) match state data. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the match description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Participant - - getDescriptionParticipant - () -

-
-
- - - -
-
- - - - -

Get the participant representing the primary opponent in the match. -

- Note that this will return null if there is no primary opponent. This could happen if - an automatch slot has not been filled.

-
-
Returns
-
  • The participant representing the primary opponent in the match. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescriptionParticipantId - () -

-
-
- - - -
-
- - - - -

Get the ID of another participant in the match that can be used when describing the - participants the user is playing with. For example, in a four player match this might be used - to state "Martha (and 2 others)". -

- Note that this will return null if there is no primary opponent. This could happen if - an automatch slot has not been filled.

-
-
Returns
-
  • The participant ID of the primary opponent in the match. -
-
- -
-
- - - - -
-

- - public - - - - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Return the timestamp at which the match was last modified.

-
-
Returns
-
  • The server timestamp at which the match was last modified. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getLastUpdaterId - () -

-
-
- - - -
-
- - - - -

Return the ID of the participant who updated the match most recently.

-
-
Returns
-
  • The ID of the last participant who updated this Match object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMatchId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getMatchNumber - () -

-
-
- - - -
-
- - - - -

Return the match sequence number for this match. This number starts at 1, and increases every - time a rematch is created.

-
-
Returns
-
  • The match sequence number for this match. -
-
- -
-
- - - - -
-

- - public - - - - - Participant - - getParticipant - (String participantId) -

-
-
- - - -
-
- - - - -

Get a participant in a match by its ID. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
-
  • The participant corresponding to the given ID.
-
- -
-
- - - - -
-

- - public - - - - - String - - getParticipantId - (String playerId) -

-
-
- - - -
-
- - - - -

Get the participant ID for a given player. This will only return a non-null ID if the player - is actually a participant in the match and that player's identity is visible to the current - player. Note that this will always return non-null for the current player. -

- To find the player ID for the current player, use getCurrentPlayerId(GoogleApiClient).

-
-
Parameters
- - - - -
playerId - Player ID to find participant ID for.
-
-
-
Returns
-
  • The participant ID corresponding to given player, or null if none found. -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<String> - - getParticipantIds - () -

-
-
- - - -
-
- - - - -

Get the IDs of the participants of the given match.

-
-
Returns
-
  • The IDs of the participants in this match. These are returned in the participant - order of the match. Note that these are not stable across matches. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getParticipantStatus - (String participantId) -

-
-
- - - -
-
- - - - -

Get the status of a participant in a match. Note that the participant ID must correspond to a - participant in this match, or this method will throw an exception.

-
-
Parameters
- - - - -
participantId - Match-local ID of the participant to retrieve status for.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - ArrayList<Participant> - - getParticipants - () -

-
-
- - - -
-
- - - - -

Retrieve the Participants for this object. This is a list of all Participants - applicable to the given object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getPendingParticipantId - () -

-
-
- - - -
-
- - - - -

Return the ID of the participant that is considered pending. If no participant is considered - pending (ie, the match is over, etc), this function will return null.

-
-
Returns
-
  • The ID of the participant that is considered pending, if any. Returns null if no - participant is pending. -
-
- -
-
- - - - -
-

- - public - - - - - byte[] - - getPreviousMatchData - () -

-
-
- - - -
-
- - - - -

Return the match data from the previous match, if available. Note that this is only provided - on the first turn of a rematched match.

-
-
Returns
-
  • Byte array of data from the previous match of a rematch, or null if not available. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getRematchId - () -

-
-
- - - -
-
- - - - -

Return the match ID of the rematch that was created from this match, if any. This will only - be non-null if a rematch has been created.

-
-
Returns
-
  • The match ID of the rematch, or null if no rematch exists. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getTurnStatus - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getVariant - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getVersion - () -

-
-
- - - -
-
- - - - -

Return the current version of the match.

-
-
Returns
-
  • The current version of the match. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isLocallyModified - () -

-
-
- - - -
-
- - - - -

Return whether or not this match has been locally modified. If this is true, the local device - has match state which has not successfully synced to the server yet. In this state, further - mutations to the match will fail with a status of - STATUS_MATCH_ERROR_LOCALLY_MODIFIED.

-
-
Returns
-
  • Whether this match has local modifications or not. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.CancelMatchResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.CancelMatchResult.html deleted file mode 100644 index 0d9cb25ec135..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.CancelMatchResult.html +++ /dev/null @@ -1,1164 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.CancelMatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.CancelMatchResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.CancelMatchResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when the match has been canceled. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getMatchId() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getMatchId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the canceled match. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.InitiateMatchResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.InitiateMatchResult.html deleted file mode 100644 index 8acad1773ec5..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.InitiateMatchResult.html +++ /dev/null @@ -1,1167 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.InitiateMatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.InitiateMatchResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.InitiateMatchResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when match has been initiated. This happens when the player creates a new - match, or when the player joins an existing match. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - TurnBasedMatch - - getMatch() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - TurnBasedMatch - - getMatch - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The newly initiated TurnBasedMatch object. Note that this may be null, - depending on the status code returned. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LeaveMatchResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LeaveMatchResult.html deleted file mode 100644 index b0d67e37654b..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LeaveMatchResult.html +++ /dev/null @@ -1,1169 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.LeaveMatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.LeaveMatchResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LeaveMatchResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when the player has left the match. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - TurnBasedMatch - - getMatch() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - TurnBasedMatch - - getMatch - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The updated TurnBasedMatch object. Note that this may be null, depending - on the status code returned. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchResult.html deleted file mode 100644 index 4edffe605f09..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchResult.html +++ /dev/null @@ -1,1162 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.LoadMatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.LoadMatchResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LoadMatchResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a turn-based match has been loaded. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - TurnBasedMatch - - getMatch() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - TurnBasedMatch - - getMatch - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The requested TurnBasedMatch object. Note that this may be null, - depending on the status code returned. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchesResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchesResult.html deleted file mode 100644 index 1d64db86544b..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchesResult.html +++ /dev/null @@ -1,1210 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.LoadMatchesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.LoadMatchesResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LoadMatchesResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when matches have been loaded. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - LoadMatchesResponse - - getMatches() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - LoadMatchesResponse - - getMatches - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.UpdateMatchResult.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.UpdateMatchResult.html deleted file mode 100644 index 046150c6795b..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.UpdateMatchResult.html +++ /dev/null @@ -1,1172 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer.UpdateMatchResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

TurnBasedMultiplayer.UpdateMatchResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.UpdateMatchResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when match has been updated. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - TurnBasedMatch - - getMatch() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - TurnBasedMatch - - getMatch - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The updated TurnBasedMatch object. Note that this may be null, depending - on the status code returned. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.html deleted file mode 100644 index 429eacac7712..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.html +++ /dev/null @@ -1,3206 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TurnBasedMultiplayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

TurnBasedMultiplayer

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer
- - - - - - - -
- - -

Class Overview

-

Entry point for turn-based multiplayer functionality. -

- For more details, see the turn-based - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceTurnBasedMultiplayer.CancelMatchResult - Result delivered when the match has been canceled.  - - - -
- - - - - interfaceTurnBasedMultiplayer.InitiateMatchResult - Result delivered when match has been initiated.  - - - -
- - - - - interfaceTurnBasedMultiplayer.LeaveMatchResult - Result delivered when the player has left the match.  - - - -
- - - - - interfaceTurnBasedMultiplayer.LoadMatchResult - Result delivered when a turn-based match has been loaded.  - - - -
- - - - - interfaceTurnBasedMultiplayer.LoadMatchesResult - Result delivered when matches have been loaded.  - - - -
- - - - - interfaceTurnBasedMultiplayer.UpdateMatchResult - Result delivered when match has been updated.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - acceptInvitation(GoogleApiClient apiClient, String invitationId) - -
- Accept an invitation for a turn-based match. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.CancelMatchResult> - - cancelMatch(GoogleApiClient apiClient, String matchId) - -
- Cancels a turn-based match. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - createMatch(GoogleApiClient apiClient, TurnBasedMatchConfig config) - -
- Create a new turn-based match for the current game. - - - -
- -
- abstract - - - - - void - - declineInvitation(GoogleApiClient apiClient, String invitationId) - -
- Decline an invitation for a turn-based match. - - - -
- -
- abstract - - - - - void - - dismissInvitation(GoogleApiClient apiClient, String invitationId) - -
- Dismiss an invitation to a turn-based match. - - - -
- -
- abstract - - - - - void - - dismissMatch(GoogleApiClient apiClient, String matchId) - -
- Delete a match from the server and local storage. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch(GoogleApiClient apiClient, String matchId, byte[] matchData, ParticipantResult... results) - -
- Mark a match as finished. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch(GoogleApiClient apiClient, String matchId, byte[] matchData, List<ParticipantResult> results) - -
- Mark a match as finished. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch(GoogleApiClient apiClient, String matchId) - -
- Indicate that a participant is finished with a match. - - - -
- -
- abstract - - - - - Intent - - getInboxIntent(GoogleApiClient apiClient) - -
- Returns an intent that will let the user see and manage any outstanding invitations and - matches. - - - -
- -
- abstract - - - - - int - - getMaxMatchDataSize(GoogleApiClient apiClient) - -
- Gets the maximum data size per match in bytes. - - - -
- -
- abstract - - - - - Intent - - getSelectOpponentsIntent(GoogleApiClient apiClient, int minPlayers, int maxPlayers, boolean allowAutomatch) - -
- Returns an intent that will let the user select opponents to send an invitation to for a - turn based multiplayer match. - - - -
- -
- abstract - - - - - Intent - - getSelectOpponentsIntent(GoogleApiClient apiClient, int minPlayers, int maxPlayers) - -
- Returns an intent that will let the user select opponents to send an invitation to for a - turn based multiplayer match. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.LeaveMatchResult> - - leaveMatch(GoogleApiClient apiClient, String matchId) - -
- Leave the specified match when it is not the current player's turn. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.LeaveMatchResult> - - leaveMatchDuringTurn(GoogleApiClient apiClient, String matchId, String pendingParticipantId) - -
- Leave the specified match during the current player's turn. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.LoadMatchResult> - - loadMatch(GoogleApiClient apiClient, String matchId) - -
- Load a specified turn-based match. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.LoadMatchesResult> - - loadMatchesByStatus(GoogleApiClient apiClient, int invitationSortOrder, int[] matchTurnStatuses) - -
- Asynchronously load turn-based matches for the current game. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.LoadMatchesResult> - - loadMatchesByStatus(GoogleApiClient apiClient, int[] matchTurnStatuses) - -
- Asynchronously load turn-based matches for the current game. - - - -
- -
- abstract - - - - - void - - registerMatchUpdateListener(GoogleApiClient apiClient, OnTurnBasedMatchUpdateReceivedListener listener) - -
- Register a listener to intercept incoming match updates for the currently signed-in user. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - rematch(GoogleApiClient apiClient, String matchId) - -
- Create a rematch of a previously completed turn-based match. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn(GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId) - -
- Update a match with new turn data. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn(GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId, List<ParticipantResult> results) - -
- Update a match with new turn data. - - - -
- -
- abstract - - - - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn(GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId, ParticipantResult... results) - -
- Update a match with new turn data. - - - -
- -
- abstract - - - - - void - - unregisterMatchUpdateListener(GoogleApiClient apiClient) - -
- Unregisters this client's match update listener, if any. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - acceptInvitation - (GoogleApiClient apiClient, String invitationId) -

-
-
- - - -
-
- - - - -

Accept an invitation for a turn-based match. This changes the current player's participant - status to STATUS_JOINED. -

- After this call returns successfully, it will be the calling player's turn in the match. At - this point, the player may take their first turn by calling takeTurn(GoogleApiClient, String, byte[], String). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationId - The ID of the invitation to be accepted.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.CancelMatchResult> - - cancelMatch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Cancels a turn-based match. Once this call succeeds, the match will be removed from local - storage. Note that this will cancel the match completely, forcing it to end for all players - involved. See leaveMatch(GoogleApiClient, String) for a different alternative. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - The ID of the match to cancel.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - createMatch - (GoogleApiClient apiClient, TurnBasedMatchConfig config) -

-
-
- - - -
-
- - - - -

Create a new turn-based match for the current game. If the provided - TurnBasedMatchConfig includes automatch parameters, the server will attempt to find - any previously created matches that satisfy these parameters and join the current player into - the previous match. If no suitable match can be found, a new match will be created. -

- After this call returns successfully, it will be the calling player's turn in the new match. - At this point, the player may take their first turn by calling takeTurn(GoogleApiClient, String, byte[], String). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
config - The configuration parameters for the match to create.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - declineInvitation - (GoogleApiClient apiClient, String invitationId) -

-
-
- - - -
-
- - - - -

Decline an invitation for a turn-based match. -

- Note that this will cancel the match for the other participants and remove the match from the - caller's local device. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationId - The ID of the invitation to decline. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - dismissInvitation - (GoogleApiClient apiClient, String invitationId) -

-
-
- - - -
-
- - - - -

Dismiss an invitation to a turn-based match. Dismissing an invitation will not change the - state of the match for the other participants. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationId - The ID of the invitation to dismiss. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - dismissMatch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Delete a match from the server and local storage. Dismissing a match will not change the - state of the match for the other participants, but dismissed matches will never be shown to - the dismissing player again. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - The ID of the match to dismiss. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch - (GoogleApiClient apiClient, String matchId, byte[] matchData, ParticipantResult... results) -

-
-
- - - -
-
- - - - -

Mark a match as finished. This should be called when the match is over and all participants - have results to be reported (if appropriate). Note that the last client to update a match is - responsible for calling finish on that match. -

- On the last turn of the match, the client should call this method instead of - takeTurn(GoogleApiClient, String, byte[], String). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to finish.
matchData - Data representing the new state of the match after this update. Limited to a - maximum of getMaxMatchDataSize(GoogleApiClient) bytes.
results - List of ParticipantResult objects for this match. The client which - calls finishMatch is responsible for reporting the results for all - appropriate participants in the match. Not every participant is required to have a - result, but providing results for participants who are not in the match is an - error.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch - (GoogleApiClient apiClient, String matchId, byte[] matchData, List<ParticipantResult> results) -

-
-
- - - -
-
- - - - -

Mark a match as finished. This should be called when the match is over and all participants - have results to be reported (if appropriate). Note that the last client to update a match is - responsible for calling finish on that match. -

- On the last turn of the match, the client should call this method instead of - takeTurn(GoogleApiClient, String, byte[], String). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to finish.
matchData - Data representing the new state of the match after this update. Limited to a - maximum of getMaxMatchDataSize(GoogleApiClient) bytes.
results - List of ParticipantResult objects for this match. The client which - calls finishMatch is responsible for reporting the results for all - appropriate participants in the match. Not every participant is required to have a - result, but providing results for participants who are not in the match is an - error.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - finishMatch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Indicate that a participant is finished with a match. This will not change the data of the - match, but it will transition the match into state - MATCH_STATUS_COMPLETE if the match is not already in that state. This - method is most commonly used to report that a participant has finished any post-processing - steps the game might have and has seen their results in the match. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to finish.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getInboxIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user see and manage any outstanding invitations and - matches. Note that this must be invoked using - startActivityForResult(Intent, int) so that the identity of the calling - package can be established. -

- If the user canceled the result will be RESULT_CANCELED. If the user - selected an invitation or a match to accept, the result will be RESULT_OK - and the data intent will contain the selected invitation/match as a parcelable extra in the - extras. Based on the type of the match, the result will include either - EXTRA_TURN_BASED_MATCH or EXTRA_INVITATION. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the match inbox. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMaxMatchDataSize - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum data size per match in bytes. Guaranteed to be at least 128 KB. May increase - in the future. -

- If the service cannot be reached for some reason, this will return -1. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum data size per match in bytes. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSelectOpponentsIntent - (GoogleApiClient apiClient, int minPlayers, int maxPlayers, boolean allowAutomatch) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user select opponents to send an invitation to for a - turn based multiplayer match. Note that this must be invoked with startActivityForResult(Intent, int), so that the identity of the calling package - can be established. -

- The number of players passed in should be the desired number of additional players to select, - not including the current player. So, for a game that can handle between 2 and 4 players, - minPlayers would be 1 and maxPlayers would be 3. -

- Players may be preselected by specifying a list of player IDs in the - EXTRA_PLAYER_IDS extra on the returned intent. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected players, the result will be RESULT_OK, and the data intent will - contain the selected player IDs in EXTRA_PLAYER_IDS and the minimum and - maximum numbers of additional auto-match players in - EXTRA_MIN_AUTOMATCH_PLAYERS and - EXTRA_MAX_AUTOMATCH_PLAYERS respectively. The player IDs in - EXTRA_PLAYER_IDS will include only the other players selected, - not the current player. -

- If the allowAutomatch parameter is set to false, the UI will not display an option - for selecting automatch players. Set this to false if your game does not support - automatching. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
minPlayers - The minimum number of players to select (not including the current player).
maxPlayers - The maximum number of players to select (not including the current player).
allowAutomatch - Whether or not to display an option for selecting automatch players.
-
-
-
Returns
-
  • An Intent that can be started to display the player selector.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSelectOpponentsIntent - (GoogleApiClient apiClient, int minPlayers, int maxPlayers) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user select opponents to send an invitation to for a - turn based multiplayer match. Note that this must be invoked with startActivityForResult(Intent, int), so that the identity of the calling package - can be established. -

- The number of players passed in should be the desired number of additional players to select, - not including the current player. So, for a game that can handle between 2 and 4 players, - minPlayers would be 1 and maxPlayers would be 3. -

- Players may be preselected by specifying a list of player IDs in the - EXTRA_PLAYER_IDS extra on the returned intent. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected players, the result will be RESULT_OK, and the data intent will - contain the selected player IDs in EXTRA_PLAYER_IDS and the minimum and - maximum numbers of additional auto-match players in - EXTRA_MIN_AUTOMATCH_PLAYERS and - EXTRA_MAX_AUTOMATCH_PLAYERS respectively. The player IDs in - EXTRA_PLAYER_IDS will include only the other players selected, - not the current player. -

- This method is the equivalent of calling - getSelectOpponentsIntent(GoogleApiClient, int, int, boolean) with the - allowAutomatch parameter set to true. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
minPlayers - The minimum number of players to select (not including the current player).
maxPlayers - The maximum number of players to select (not including the current player).
-
-
-
Returns
-
  • An Intent that can be started to display the player selector.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.LeaveMatchResult> - - leaveMatch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Leave the specified match when it is not the current player's turn. If this takes the match - to fewer than two participants, the match will be canceled. -

- See leaveMatchDuringTurn(GoogleApiClient, String, String) for the form of the API to call during the current player's - turn. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to leave.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.LeaveMatchResult> - - leaveMatchDuringTurn - (GoogleApiClient apiClient, String matchId, String pendingParticipantId) -

-
-
- - - -
-
- - - - -

Leave the specified match during the current player's turn. If this takes the match to fewer - than two participants, the match will be canceled. The provided pendingParticipantId - will be used to determine which participant should act next. If no pending participant is - provided and the match has available auto-match slots, the match will wait for additional - players to be found. If there are no auto-match slots available for this match, a pending - participant ID is required. -

- See leaveMatch(GoogleApiClient, String) for the form of the API to call when it is not the current player's - turn. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to leave.
pendingParticipantId - ID of the participant who will be set to pending after this - update succeeds, or null to wait for additional automatched players (if - possible).
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.LoadMatchResult> - - loadMatch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Load a specified turn-based match. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - The ID of the match to retreive.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.LoadMatchesResult> - - loadMatchesByStatus - (GoogleApiClient apiClient, int invitationSortOrder, int[] matchTurnStatuses) -

-
-
- - - -
-
- - - - -

Asynchronously load turn-based matches for the current game. Matches with any specified turn - status codes will be returned. -

- Valid turn status values are MATCH_TURN_STATUS_INVITED, - MATCH_TURN_STATUS_MY_TURN, - MATCH_TURN_STATUS_THEIR_TURN, or - MATCH_TURN_STATUS_COMPLETE. Note that if your game implements both - turn-based and real-time multiplayer, requesting - MATCH_TURN_STATUS_INVITED will return invitations for both turn-based - matches and real-time matches. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
invitationSortOrder - How to sort the returned invitations. Must be either - SORT_ORDER_MOST_RECENT_FIRST or - SORT_ORDER_SOCIAL_AGGREGATION.
matchTurnStatuses - List of turn statuses to request.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.LoadMatchesResult> - - loadMatchesByStatus - (GoogleApiClient apiClient, int[] matchTurnStatuses) -

-
-
- - - -
-
- - - - -

Asynchronously load turn-based matches for the current game. Matches with any specified turn - status codes will be returned. -

- Valid turn status values are MATCH_TURN_STATUS_INVITED, - MATCH_TURN_STATUS_MY_TURN, - MATCH_TURN_STATUS_THEIR_TURN, or - MATCH_TURN_STATUS_COMPLETE. Note that if your game implements both - turn-based and real-time multiplayer, requesting - MATCH_TURN_STATUS_INVITED will return invitations for both turn-based - matches and real-time matches. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchTurnStatuses - List of turn statuses to request.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerMatchUpdateListener - (GoogleApiClient apiClient, OnTurnBasedMatchUpdateReceivedListener listener) -

-
-
- - - -
-
- - - - -

Register a listener to intercept incoming match updates for the currently signed-in user. If - a listener is registered by this method, the incoming match update will not generate a status - bar notification as long as this client remains connected. -

- Note that only one match update listener may be active at a time. Calling this method while - another match update listener was previously registered will replace the original listener - with the new one. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is called when a match update is received. The listener is - called on the main thread. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.InitiateMatchResult> - - rematch - (GoogleApiClient apiClient, String matchId) -

-
-
- - - -
-
- - - - -

Create a rematch of a previously completed turn-based match. The new match will have the same - participants as the previous match. Note that only one rematch may be created from any single - completed match, and only by a player that has already called Finish on the match. It is only - valid to call this if canRematch() return true - calling this method any - other time will result in an error. -

- After this call returns successfully, it will be the calling player's turn in the new match. - At this point, the player may take their first turn by calling takeTurn(GoogleApiClient, String, byte[], String). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - The ID of the previous match to re-create.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn - (GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId) -

-
-
- - - -
-
- - - - -

Update a match with new turn data. The participant that is passed in as the pending - participant will be notified that it is their turn to take action. If no pending participant - is provided and the match has available auto-match slots, the match will wait for additional - players to be found. If there are no auto-match slots available for this match, a pending - participant ID is required. -

- For the final turn of the match, there is no need to call this method. Instead, call - finishMatch(GoogleApiClient, String) directly. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to update.
matchData - Data representing the new state of the match after this update. Limited to a - maximum of getMaxMatchDataSize(GoogleApiClient) bytes.
pendingParticipantId - ID of the participant who will be set to pending after this - update succeeds, or null to wait for additional automatched players (if - possible).
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn - (GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId, List<ParticipantResult> results) -

-
-
- - - -
-
- - - - -

Update a match with new turn data. The participant that is passed in as the pending - participant will be notified that it is their turn to take action. If no pending participant - is provided and the match has available auto-match slots, the match will wait for additional - players to be found. If there are no auto-match slots available for this match, a pending - participant ID is required. -

- Note that players will not receive invitations for matches until this method is called. An - invitation will be sent to a player the first time they are set as the pending participant of - a match. -

- For the final turn of the match, there is no need to call this method. Instead, call - finishMatch(GoogleApiClient, String) directly. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to update.
matchData - Data representing the new state of the match after this update. Limited to a - maximum of getMaxMatchDataSize(GoogleApiClient) bytes.
pendingParticipantId - ID of the participant who will be set to pending after this - update succeeds, or null to wait for additional automatched players (if - possible).
results - Optional list of ParticipantResult objects for this match. Note that - the results reported here should be final - if results reported later conflict - with these values, the returned value will indicate a conflicted result by - returning MATCH_RESULT_DISAGREED. This is most useful - for cases where a participant knows their results early. For example, a single - elimination game where participants are eliminated as the game continues might - wish to specify results for the eliminated participants here.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<TurnBasedMultiplayer.UpdateMatchResult> - - takeTurn - (GoogleApiClient apiClient, String matchId, byte[] matchData, String pendingParticipantId, ParticipantResult... results) -

-
-
- - - -
-
- - - - -

Update a match with new turn data. The participant that is passed in as the pending - participant will be notified that it is their turn to take action. If no pending participant - is provided and the match has available auto-match slots, the match will wait for additional - players to be found. If there are no auto-match slots available for this match, a pending - participant ID is required. -

- Note that players will not receive invitations for matches until this method is called. An - invitation will be sent to a player the first time they are set as the pending participant of - a match. -

- For the final turn of the match, there is no need to call this method. Instead, call - finishMatch(GoogleApiClient, String) directly. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
matchId - ID of the match to update.
matchData - Data representing the new state of the match after this update. Limited to a - maximum of getMaxMatchDataSize(GoogleApiClient) bytes.
pendingParticipantId - ID of the participant who will be set to pending after this - update succeeds, or null to wait for additional automatched players (if - possible).
results - Optional list of ParticipantResult objects for this match. Note that - the results reported here should be final - if results reported later conflict - with these values, the returned value will indicate a conflicted result by - returning MATCH_RESULT_DISAGREED. This is most useful - for cases where a participant knows their results early. For example, a single - elimination game where participants are eliminated as the game continues might - wish to specify results for the eliminated participants here.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterMatchUpdateListener - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Unregisters this client's match update listener, if any. Any new match updates will generate - status bar notifications as normal. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/package-summary.html b/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/package-summary.html deleted file mode 100644 index 4ca71d63caa1..000000000000 --- a/docs/html/reference/com/google/android/gms/games/multiplayer/turnbased/package-summary.html +++ /dev/null @@ -1,1044 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.multiplayer.turnbased | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.multiplayer.turnbased

-
- -
- -
- - -
- Contains data classes for turn-based multiplayer functionality. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OnTurnBasedMatchUpdateReceivedListener - Listener invoked when an update to a turn-based match is received.  - - - -
TurnBasedMatch - Data interface for turn-based specific match functionality.  - - - -
TurnBasedMultiplayer - Entry point for turn-based multiplayer functionality.  - - - -
TurnBasedMultiplayer.CancelMatchResult - Result delivered when the match has been canceled.  - - - -
TurnBasedMultiplayer.InitiateMatchResult - Result delivered when match has been initiated.  - - - -
TurnBasedMultiplayer.LeaveMatchResult - Result delivered when the player has left the match.  - - - -
TurnBasedMultiplayer.LoadMatchesResult - Result delivered when matches have been loaded.  - - - -
TurnBasedMultiplayer.LoadMatchResult - Result delivered when a turn-based match has been loaded.  - - - -
TurnBasedMultiplayer.UpdateMatchResult - Result delivered when match has been updated.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LoadMatchesResponse - Response object containing the data requested in a - loadMatchesByStatus(GoogleApiClient, int, int[]) call.  - - - -
TurnBasedMatchBuffer - EntityBuffer implementation containing TurnBasedMatch details.  - - - -
TurnBasedMatchConfig - Configuration for creating a new turn-based match.  - - - -
TurnBasedMatchConfig.Builder - Builder class for TurnBasedMatchConfig.  - - - -
TurnBasedMatchEntity - Data object representing the data for a turn-based match.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/package-summary.html b/docs/html/reference/com/google/android/gms/games/package-summary.html deleted file mode 100644 index 9e2fd4074a2d..000000000000 --- a/docs/html/reference/com/google/android/gms/games/package-summary.html +++ /dev/null @@ -1,1110 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games

-
- -
- -
- - -
- Contains the games client class. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Game - Data interface for retrieving game information.  - - - -
GamesMetadata - Entry point for game metadata functionality.  - - - -
GamesMetadata.LoadGamesResult - Result delivered when game metadata has been loaded.  - - - -
Notifications - Entry point for notifications functionality.  - - - -
Player - Data interface for retrieving player information.  - - - -
Players - Entry point for player functionality.  - - - -
Players.LoadPlayersResult - Result delivered when player data has been loaded.  - - - -
Players.LoadProfileSettingsResult - Result delivered when the profile settings of the signed-in player have been loaded.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GameBuffer - Data structure providing access to a list of games.  - - - -
GameEntity - Data object representing a set of Game data.  - - - -
Games - Main entry point for the Games APIs.  - - - -
Games.GamesOptions - API configuration parameters for Games.  - - - -
Games.GamesOptions.Builder -   - - - -
GamesActivityResultCodes - Result codes that can be set as result in Activities from the Client UI started with - startActivityForResult(Intent, int).  - - - -
GamesStatusCodes - Status codes for Games results.  - - - -
PageDirection - Direction constants for pagination over data sets.  - - - -
PlayerBuffer - Data structure providing access to a list of players.  - - - -
PlayerEntity - Data object representing a set of Player data.  - - - -
PlayerLevel - Data object representing a level a player can obtain in the metagame.  - - - -
PlayerLevelInfo - Data object representing the current level information of a player in the metagame.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Milestone.html b/docs/html/reference/com/google/android/gms/games/quest/Milestone.html deleted file mode 100644 index f1c19d21c482..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Milestone.html +++ /dev/null @@ -1,1900 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Milestone | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Milestone

- - - - - - implements - - Freezable<Milestone> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Milestone
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving milestone information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATE_CLAIMED - Constant returned by server indicating the milestone was successfully claimed. - - - -
intSTATE_COMPLETED_NOT_CLAIMED - Constant returned by server indicating the milestone has not been claimed yet. - - - -
intSTATE_NOT_COMPLETED - Constant returned by server indicating the player has not completed the milestone. - - - -
intSTATE_NOT_STARTED - Constant returned by server when the milestone has not been started. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - byte[] - - getCompletionRewardData() - -
- Retrieves the completion reward data for this milestone. - - - -
- -
- abstract - - - - - long - - getCurrentProgress() - -
- Retrieves the current progress of getTargetProgress() required to complete the - milestone. - - - -
- -
- abstract - - - - - String - - getEventId() - -
- Retrieve the ID of the associated event. - - - -
- -
- abstract - - - - - String - - getMilestoneId() - -
- Retrieves the ID of this milestone. - - - -
- -
- abstract - - - - - int - - getState() - -
- Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, - STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED. - - - -
- -
- abstract - - - - - long - - getTargetProgress() - -
- Retrieves the number of increments of the event associated with the milestone - getEventId() required to complete the milestone. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATE_CLAIMED -

-
- - - - -
-
- - - - -

Constant returned by server indicating the milestone was successfully claimed. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_COMPLETED_NOT_CLAIMED -

-
- - - - -
-
- - - - -

Constant returned by server indicating the milestone has not been claimed yet. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_NOT_COMPLETED -

-
- - - - -
-
- - - - -

Constant returned by server indicating the player has not completed the milestone. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_NOT_STARTED -

-
- - - - -
-
- - - - -

Constant returned by server when the milestone has not been started. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - byte[] - - getCompletionRewardData - () -

-
-
- - - -
-
- - - - -

Retrieves the completion reward data for this milestone.

-
-
Returns
-
  • The completion reward data. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getCurrentProgress - () -

-
-
- - - -
-
- - - - -

Retrieves the current progress of getTargetProgress() required to complete the - milestone. - 

- When the milestone state is STATE_CLAIMED or STATE_COMPLETED_NOT_CLAIMED
- the value of getTargetProgress() is returned.
- 
- When the milestone state is STATE_NOT_COMPLETED the return value is the number of
- increments to the event getEventId() associated with the milestone that have
- occurred since the quest was accepted.
- 
- When the milestone state is STATE_NOT_STARTED the return value is 0.
-
-
Returns
-
  • An indicator of progress through the milestone. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getEventId - () -

-
-
- - - -
-
- - - - -

Retrieve the ID of the associated event. Increments to this event will increase the user's - progress toward this milestone when the milestone is in the STATE_NOT_COMPLETED - state.

-
-
Returns
-
  • The ID of the Event associated with this milestone. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getMilestoneId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this milestone.

-
-
Returns
-
  • The milestone ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, - STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED.

-
-
Returns
-
  • The state of this milestone. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getTargetProgress - () -

-
-
- - - -
-
- - - - -

Retrieves the number of increments of the event associated with the milestone - getEventId() required to complete the milestone.

-
-
Returns
-
  • The number of increments required to complete the milestone. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/MilestoneBuffer.html b/docs/html/reference/com/google/android/gms/games/quest/MilestoneBuffer.html deleted file mode 100644 index e68b105b10e9..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/MilestoneBuffer.html +++ /dev/null @@ -1,1817 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MilestoneBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MilestoneBuffer

- - - - - - - - - extends AbstractDataBuffer<Milestone>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.quest.Milestone>
    ↳com.google.android.gms.games.quest.MilestoneBuffer
- - - - - - - -
- - -

Class Overview

-

AbstractDataBuffer implementation containing quest - milestone data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Milestone - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Milestone - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/MilestoneEntity.html b/docs/html/reference/com/google/android/gms/games/quest/MilestoneEntity.html deleted file mode 100644 index ff11d796846f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/MilestoneEntity.html +++ /dev/null @@ -1,2541 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MilestoneEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MilestoneEntity

- - - - - extends Object
- - - - - - - implements - - Milestone - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.quest.MilestoneEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a milestone. This is immutable, and therefore safe - to cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.quest.Milestone -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - MilestoneEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Milestone - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - byte[] - - getCompletionRewardData() - -
- Retrieves the completion reward data for this milestone. - - - -
- -
- - - - - - long - - getCurrentProgress() - -
- Retrieves the current progress of getTargetProgress() required to complete the - milestone. - - - -
- -
- - - - - - String - - getEventId() - -
- Retrieve the ID of the associated event. - - - -
- -
- - - - - - String - - getMilestoneId() - -
- Retrieves the ID of this milestone. - - - -
- -
- - - - - - int - - getState() - -
- Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, - STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED. - - - -
- -
- - - - - - long - - getTargetProgress() - -
- Retrieves the number of increments of the event associated with the milestone - getEventId() required to complete the milestone. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.quest.Milestone - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - MilestoneEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Milestone - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - byte[] - - getCompletionRewardData - () -

-
-
- - - -
-
- - - - -

Retrieves the completion reward data for this milestone.

-
-
Returns
-
  • The completion reward data. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getCurrentProgress - () -

-
-
- - - -
-
- - - - -

Retrieves the current progress of getTargetProgress() required to complete the - milestone. - 

- When the milestone state is STATE_CLAIMED or STATE_COMPLETED_NOT_CLAIMED
- the value of getTargetProgress() is returned.
- 
- When the milestone state is STATE_NOT_COMPLETED the return value is the number of
- increments to the event getEventId() associated with the milestone that have
- occurred since the quest was accepted.
- 
- When the milestone state is STATE_NOT_STARTED the return value is 0.
-
-
Returns
-
  • An indicator of progress through the milestone. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEventId - () -

-
-
- - - -
-
- - - - -

Retrieve the ID of the associated event. Increments to this event will increase the user's - progress toward this milestone when the milestone is in the STATE_NOT_COMPLETED - state.

-
-
Returns
-
  • The ID of the Event associated with this milestone. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMilestoneId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this milestone.

-
-
Returns
-
  • The milestone ID. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the milestone - one of STATE_COMPLETED_NOT_CLAIMED, - STATE_CLAIMED, STATE_NOT_COMPLETED, or STATE_NOT_STARTED.

-
-
Returns
-
  • The state of this milestone. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getTargetProgress - () -

-
-
- - - -
-
- - - - -

Retrieves the number of increments of the event associated with the milestone - getEventId() required to complete the milestone.

-
-
Returns
-
  • The number of increments required to complete the milestone. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Quest.html b/docs/html/reference/com/google/android/gms/games/quest/Quest.html deleted file mode 100644 index caf659b790ee..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Quest.html +++ /dev/null @@ -1,2742 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Quest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Quest

- - - - - - implements - - Freezable<Quest> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Quest
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for retrieving quest information. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATE_ACCEPTED - Constant returned by getState() indicating the player has accepted the quest. - - - -
intSTATE_COMPLETED - Constant returned by getState() indicating the player has completed the quest. - - - -
intSTATE_EXPIRED - Constant returned by getState() indicating the quest is over and this player - never accepted the quest. - - - -
intSTATE_FAILED - Constant returned by getState() indicating the quest is over and this player - did not complete the quest. - - - -
intSTATE_OPEN - Constant returned by getState() indicating players can now accept this quest. - - - -
intSTATE_UPCOMING - Constant returned by getState() indicating the quest happens in the future, - so it is visible to the UI, but players can't accept it yet. - - - -
longUNSET_QUEST_TIMESTAMP - The default value for Quest related timestamps when they aren't set by the server. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - int[]QUEST_STATE_ALL - Array of all the valid state constants. - - - -
- public - static - final - String[]QUEST_STATE_NON_TERMINAL - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - long - - getAcceptedTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted - by the player. - - - -
- -
- abstract - - - - - Uri - - getBannerImageUri() - -
- Retrieves a URI that can be used to load the quest's banner image. - - - -
- -
- abstract - - - - - Milestone - - getCurrentMilestone() - -
- Retrieves the latest milestone information associated with this quest. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- Retrieves the description for this quest. - - - -
- -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the quest description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - long - - getEndTimestamp() - -
- Timestamp at which this quest will change to STATE_EXPIRED if not accepted, - or change to STATE_FAILED if accepted but not completed. - - - -
- -
- abstract - - - - - Game - - getGame() - -
- Retrieves the game metadata associated with this quest. - - - -
- -
- abstract - - - - - Uri - - getIconImageUri() - -
- Retrieves a URI that can be used to load the quest's icon image. - - - -
- -
- abstract - - - - - long - - getLastUpdatedTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest was last - updated. - - - -
- -
- abstract - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the quest name into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - String - - getName() - -
- Retrieves the name of this quest. - - - -
- -
- abstract - - - - - String - - getQuestId() - -
- Retrieves the ID of this quest. - - - -
- -
- abstract - - - - - long - - getStartTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available - for players to accept. - - - -
- -
- abstract - - - - - int - - getState() - -
- Retrieves the state of the quest - one of STATE_UPCOMING, - STATE_OPEN, STATE_COMPLETED, STATE_EXPIRED, - STATE_FAILED, STATE_ACCEPTED. - - - -
- -
- abstract - - - - - boolean - - isEndingSoon() - -
- Indicates whether the quest will be expiring soon - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATE_ACCEPTED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating the player has accepted the quest. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_COMPLETED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating the player has completed the quest. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_EXPIRED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating the quest is over and this player - never accepted the quest. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_FAILED -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating the quest is over and this player - did not complete the quest. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_OPEN -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating players can now accept this quest. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATE_UPCOMING -

-
- - - - -
-
- - - - -

Constant returned by getState() indicating the quest happens in the future, - so it is visible to the UI, but players can't accept it yet. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - UNSET_QUEST_TIMESTAMP -

-
- - - - -
-
- - - - -

The default value for Quest related timestamps when they aren't set by the server. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - int[] - - QUEST_STATE_ALL -

-
- - - - -
-
- - - - -

Array of all the valid state constants. -

- - -
-
- - - - - -
-

- - public - static - final - String[] - - QUEST_STATE_NON_TERMINAL -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - long - - getAcceptedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted - by the player. If the quest has never been accepted, this will return - UNSET_QUEST_TIMESTAMP. If you are looking for the time that a quest is available - to be accepted, see getStartTimestamp(). This value should always be greater - than getStartTimestamp() and less than getEndTimestamp()

-
-
Returns
-
  • Timestamp at which this quest was accepted. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getBannerImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the quest's banner image. Returns null - if the quest has no banner image. -

- To retrieve the Image from the Uri, use - ImageManager.

-
-
Returns
-
  • The image URI for the quest's banner image, or null if the quest - has no banner image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Milestone - - getCurrentMilestone - () -

-
-
- - - -
-
- - - - -

Retrieves the latest milestone information associated with this quest.

-
-
Returns
-
  • The latest milestone associated with this quest. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this quest.

-
-
Returns
-
  • The quest description. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the quest description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getEndTimestamp - () -

-
-
- - - -
-
- - - - -

Timestamp at which this quest will change to STATE_EXPIRED if not accepted, - or change to STATE_FAILED if accepted but not completed.

-
-
Returns
-
  • Timestamp at which this quest will end. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game metadata associated with this quest.

-
-
Returns
-
  • The game associated with the quest. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the quest's icon image. Returns null - if the quest has no icon image. -

- To retrieve the Image from the Uri, use - ImageManager.

-
-
Returns
-
  • The image URI for the quest's icon image, or null if the quest - has no icon image. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest was last - updated. If the quest has never been updated, this will return - UNSET_QUEST_TIMESTAMP.

-
-
Returns
-
  • Timestamp at which this quest was last updated. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the quest name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this quest.

-
-
Returns
-
  • The quest name. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getQuestId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this quest.

-
-
Returns
-
  • The quest ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getStartTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available - for players to accept. If you are looking for the time that a quest was accepted by the - player, see getAcceptedTimestamp()

-
-
Returns
-
  • Timestamp at which this quest will begin. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the quest - one of STATE_UPCOMING, - STATE_OPEN, STATE_COMPLETED, STATE_EXPIRED, - STATE_FAILED, STATE_ACCEPTED.

-
-
Returns
-
  • The state of this quest. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isEndingSoon - () -

-
-
- - - -
-
- - - - -

Indicates whether the quest will be expiring soon

-
-
Returns
-
  • Is the quest expiring soon. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/QuestBuffer.html b/docs/html/reference/com/google/android/gms/games/quest/QuestBuffer.html deleted file mode 100644 index 09dc322eaaf6..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/QuestBuffer.html +++ /dev/null @@ -1,1864 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -QuestBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

QuestBuffer

- - - - - - - - - extends AbstractDataBuffer<Quest>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.quest.Quest>
    ↳com.google.android.gms.games.quest.QuestBuffer
- - - - - - - -
- - -

Class Overview

-

EntityBuffer implementation containing Quest details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - Quest - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - Quest - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/QuestEntity.html b/docs/html/reference/com/google/android/gms/games/quest/QuestEntity.html deleted file mode 100644 index f7195c2fa851..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/QuestEntity.html +++ /dev/null @@ -1,3425 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -QuestEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - | Inherited Fields - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

QuestEntity

- - - - - extends Object
- - - - - - - implements - - Quest - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.quest.QuestEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a quest. This is immutable, and therefore safe - to cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.quest.Quest -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - QuestEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From interface -com.google.android.gms.games.quest.Quest -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Quest - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - long - - getAcceptedTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted - by the player. - - - -
- -
- - - - - - Uri - - getBannerImageUri() - -
- Retrieves a URI that can be used to load the quest's banner image. - - - -
- -
- - - - - - Milestone - - getCurrentMilestone() - -
- Retrieves the latest milestone information associated with this quest. - - - -
- -
- - - - - - String - - getDescription() - -
- Retrieves the description for this quest. - - - -
- -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the quest description into the given CharArrayBuffer. - - - -
- -
- - - - - - long - - getEndTimestamp() - -
- Timestamp at which this quest will change to STATE_EXPIRED if not accepted, - or change to STATE_FAILED if accepted but not completed. - - - -
- -
- - - - - - Game - - getGame() - -
- Retrieves the game metadata associated with this quest. - - - -
- -
- - - - - - Uri - - getIconImageUri() - -
- Retrieves a URI that can be used to load the quest's icon image. - - - -
- -
- - - - - - long - - getLastUpdatedTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest was last - updated. - - - -
- -
- - - - - - void - - getName(CharArrayBuffer dataOut) - -
- Loads the quest name into the given CharArrayBuffer. - - - -
- -
- - - - - - String - - getName() - -
- Retrieves the name of this quest. - - - -
- -
- - - - - - String - - getQuestId() - -
- Retrieves the ID of this quest. - - - -
- -
- - - - - - long - - getStartTimestamp() - -
- Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available - for players to accept. - - - -
- -
- - - - - - int - - getState() - -
- Retrieves the state of the quest - one of STATE_UPCOMING, - STATE_OPEN, STATE_COMPLETED, STATE_EXPIRED, - STATE_FAILED, STATE_ACCEPTED. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - boolean - - isEndingSoon() - -
- Indicates whether the quest will be expiring soon - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.quest.Quest - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - QuestEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Quest - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getAcceptedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted - by the player. If the quest has never been accepted, this will return - UNSET_QUEST_TIMESTAMP. If you are looking for the time that a quest is available - to be accepted, see getStartTimestamp(). This value should always be greater - than getStartTimestamp() and less than getEndTimestamp()

-
-
Returns
-
  • Timestamp at which this quest was accepted. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getBannerImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the quest's banner image. Returns null - if the quest has no banner image. -

- To retrieve the Image from the Uri, use - ImageManager.

-
-
Returns
-
  • The image URI for the quest's banner image, or null if the quest - has no banner image. -
-
- -
-
- - - - -
-

- - public - - - - - Milestone - - getCurrentMilestone - () -

-
-
- - - -
-
- - - - -

Retrieves the latest milestone information associated with this quest.

-
-
Returns
-
  • The latest milestone associated with this quest. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description for this quest.

-
-
Returns
-
  • The quest description. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the quest description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getEndTimestamp - () -

-
-
- - - -
-
- - - - -

Timestamp at which this quest will change to STATE_EXPIRED if not accepted, - or change to STATE_FAILED if accepted but not completed.

-
-
Returns
-
  • Timestamp at which this quest will end. -
-
- -
-
- - - - -
-

- - public - - - - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game metadata associated with this quest.

-
-
Returns
-
  • The game associated with the quest. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getIconImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves a URI that can be used to load the quest's icon image. Returns null - if the quest has no icon image. -

- To retrieve the Image from the Uri, use - ImageManager.

-
-
Returns
-
  • The image URI for the quest's icon image, or null if the quest - has no icon image. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLastUpdatedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest was last - updated. If the quest has never been updated, this will return - UNSET_QUEST_TIMESTAMP.

-
-
Returns
-
  • Timestamp at which this quest was last updated. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getName - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the quest name into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Retrieves the name of this quest.

-
-
Returns
-
  • The quest name. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getQuestId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this quest.

-
-
Returns
-
  • The quest ID. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getStartTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available - for players to accept. If you are looking for the time that a quest was accepted by the - player, see getAcceptedTimestamp()

-
-
Returns
-
  • Timestamp at which this quest will begin. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getState - () -

-
-
- - - -
-
- - - - -

Retrieves the state of the quest - one of STATE_UPCOMING, - STATE_OPEN, STATE_COMPLETED, STATE_EXPIRED, - STATE_FAILED, STATE_ACCEPTED.

-
-
Returns
-
  • The state of this quest. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isEndingSoon - () -

-
-
- - - -
-
- - - - -

Indicates whether the quest will be expiring soon

-
-
Returns
-
  • Is the quest expiring soon. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/QuestUpdateListener.html b/docs/html/reference/com/google/android/gms/games/quest/QuestUpdateListener.html deleted file mode 100644 index 2389df4190ba..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/QuestUpdateListener.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -QuestUpdateListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

QuestUpdateListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.QuestUpdateListener
- - - - - - - -
- - -

Class Overview

-

Listener to invoke when a quest is updated. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onQuestCompleted(Quest quest) - -
- Called when the quest moves from another state to STATE_COMPLETED. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onQuestCompleted - (Quest quest) -

-
-
- - - -
-
- - - - -

Called when the quest moves from another state to STATE_COMPLETED.

-
-
Parameters
- - - - -
quest - The newly updated quest data. The quest can be null if it could - not be loaded successfully. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Quests.AcceptQuestResult.html b/docs/html/reference/com/google/android/gms/games/quest/Quests.AcceptQuestResult.html deleted file mode 100644 index df00ad2b5d15..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Quests.AcceptQuestResult.html +++ /dev/null @@ -1,1158 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Quests.AcceptQuestResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Quests.AcceptQuestResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Quests.AcceptQuestResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when accepting a quest. -

- Possible status codes include: -

    -
  • STATUS_OK if the request was successful and the quest is - updated after accepting.
    • -
  • STATUS_NETWORK_ERROR_NO_DATA if the device was unable to - retrieve any data from the network and has no data cached locally.
    • -
  • STATUS_INTERNAL_ERROR if an unexpected error occurred in the - service.
    • -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Quest - - getQuest() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Quest - - getQuest - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The quest that was accepted. This will be null if the accept operation did - not succeed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Quests.ClaimMilestoneResult.html b/docs/html/reference/com/google/android/gms/games/quest/Quests.ClaimMilestoneResult.html deleted file mode 100644 index be7e8ad6295c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Quests.ClaimMilestoneResult.html +++ /dev/null @@ -1,1216 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Quests.ClaimMilestoneResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Quests.ClaimMilestoneResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Quests.ClaimMilestoneResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when claiming a milestone. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Milestone - - getMilestone() - -
- abstract - - - - - Quest - - getQuest() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Milestone - - getMilestone - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The claimed milestone. This will be null if the claim operation did not succeed. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Quest - - getQuest - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The quest owning the claimed milestone. This will be null if the claim - operation did not succeed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Quests.LoadQuestsResult.html b/docs/html/reference/com/google/android/gms/games/quest/Quests.LoadQuestsResult.html deleted file mode 100644 index 0538beaec499..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Quests.LoadQuestsResult.html +++ /dev/null @@ -1,1217 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Quests.LoadQuestsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Quests.LoadQuestsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Quests.LoadQuestsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when quest data has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - QuestBuffer - - getQuests() - -
- Retrieves all loaded quests who's state is one of the states in the provided state list. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - QuestBuffer - - getQuests - () -

-
-
- - - -
-
- - - - -

Retrieves all loaded quests who's state is one of the states in the provided state list.

-
-
Returns
-
  • A collection of quests order by last updated timestamp. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/Quests.html b/docs/html/reference/com/google/android/gms/games/quest/Quests.html deleted file mode 100644 index 5d033c9f8c7f..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/Quests.html +++ /dev/null @@ -1,2576 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Quests | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Quests

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.quest.Quests
- - - - - - - -
- - -

Class Overview

-

Entry point for Quest functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceQuests.AcceptQuestResult - Result delivered when accepting a quest.  - - - -
- - - - - interfaceQuests.ClaimMilestoneResult - Result delivered when claiming a milestone.  - - - -
- - - - - interfaceQuests.LoadQuestsResult - Result delivered when quest data has been loaded.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_QUEST - Intent extra used to pass a Quest. - - - -
intSELECT_ACCEPTED - Constant used to add quests in the STATE_ACCEPTED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_COMPLETED - Constant used to add quests in the STATE_COMPLETED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_COMPLETED_UNCLAIMED - Constant used to add quests in the STATE_COMPLETED state that have at least - one milestone in the STATE_COMPLETED_NOT_CLAIMED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_ENDING_SOON - Constant used to add quests in the STATE_ACCEPTED state that have been marked - as ending soon isEndingSoon() returned by load(GoogleApiClient, int[], int, boolean) and - getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_EXPIRED - Constant used to add quests in the STATE_EXPIRED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_FAILED - Constant used to add quests in the STATE_FAILED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_OPEN - Constant used to add quests in the STATE_OPEN state to the QuestBuffer returned - by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSELECT_RECENTLY_FAILED - Constant used to add quests in the STATE_FAILED state with a - getLastUpdatedTimestamp() no older than 7 days ago. - - - -
intSELECT_UPCOMING - Constant used to add quests in the STATE_UPCOMING state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). - - - -
intSORT_ORDER_ENDING_SOON_FIRST - Sort requests with the quests ending soon first. - - - -
intSORT_ORDER_RECENTLY_UPDATED_FIRST - Sort requests with the recently updated quests first. - - - -
- - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - int[]SELECT_ALL_QUESTS - Array of all the valid state selector constants. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Quests.AcceptQuestResult> - - accept(GoogleApiClient apiClient, String questId) - -
- Asynchronously accept the quest. - - - -
- -
- abstract - - - - - PendingResult<Quests.ClaimMilestoneResult> - - claim(GoogleApiClient apiClient, String questId, String milestoneId) - -
- Asynchronously claim the milestone. - - - -
- -
- abstract - - - - - Intent - - getQuestIntent(GoogleApiClient apiClient, String questId) - -
- Get an intent to view a single quest. - - - -
- -
- abstract - - - - - Intent - - getQuestsIntent(GoogleApiClient apiClient, int[] questSelectors) - -
- Get an intent to view a list of quests. - - - -
- -
- abstract - - - - - PendingResult<Quests.LoadQuestsResult> - - load(GoogleApiClient apiClient, int[] questSelectors, int sortOrder, boolean forceReload) - -
- Asynchronously load the quest data for the currently signed-in player and game into - a single result, including only quests in the provided state array. - - - -
- -
- abstract - - - - - PendingResult<Quests.LoadQuestsResult> - - loadByIds(GoogleApiClient apiClient, boolean forceReload, String... questIds) - -
- Asynchronously load single quest data for the currently signed-in player and game. - - - -
- -
- abstract - - - - - void - - registerQuestUpdateListener(GoogleApiClient apiClient, QuestUpdateListener listener) - -
- Register a listener to listen for updates on Quest instances. - - - -
- -
- abstract - - - - - void - - showStateChangedPopup(GoogleApiClient apiClient, String questId) - -
- Display a popup based on the current state of the quest. - - - -
- -
- abstract - - - - - void - - unregisterQuestUpdateListener(GoogleApiClient apiClient) - -
- Unregisters this client's quest update listener, if any. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_QUEST -

-
- - - - -
-
- - - - -

Intent extra used to pass a Quest.

-
-
See Also
- -
- - -
- Constant Value: - - - "quest" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_ACCEPTED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_ACCEPTED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_COMPLETED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_COMPLETED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_COMPLETED_UNCLAIMED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_COMPLETED state that have at least - one milestone in the STATE_COMPLETED_NOT_CLAIMED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). This is a subset of - SELECT_COMPLETED, so the two criteria do not both need to be included to get - all quests. -

- - -
- Constant Value: - - - 101 - (0x00000065) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_ENDING_SOON -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_ACCEPTED state that have been marked - as ending soon isEndingSoon() returned by load(GoogleApiClient, int[], int, boolean) and - getQuestsIntent(GoogleApiClient, int[]). This is a subset of STATE_ACCEPTED, so the two - criteria do not both need to be included to get all quests. -

- - -
- Constant Value: - - - 102 - (0x00000066) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_EXPIRED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_EXPIRED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_FAILED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_FAILED state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_OPEN -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_OPEN state to the QuestBuffer returned - by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_RECENTLY_FAILED -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_FAILED state with a - getLastUpdatedTimestamp() no older than 7 days ago. In simple terms, it will - include quests that the player attempted, but failed in the last 7 days. Use with the - load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]) API endpoints. This is a subset of - STATE_FAILED. -

- - -
- Constant Value: - - - 103 - (0x00000067) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECT_UPCOMING -

-
- - - - -
-
- - - - -

Constant used to add quests in the STATE_UPCOMING state to the QuestBuffer - returned by load(GoogleApiClient, int[], int, boolean) and getQuestsIntent(GoogleApiClient, int[]). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_ENDING_SOON_FIRST -

-
- - - - -
-
- - - - -

Sort requests with the quests ending soon first. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_RECENTLY_UPDATED_FIRST -

-
- - - - -
-
- - - - -

Sort requests with the recently updated quests first. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - int[] - - SELECT_ALL_QUESTS -

-
- - - - -
-
- - - - -

Array of all the valid state selector constants. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Quests.AcceptQuestResult> - - accept - (GoogleApiClient apiClient, String questId) -

-
-
- - - -
-
- - - - -

Asynchronously accept the quest. This enters the player into an STATE_OPEN - quest and will start tracking their progress towards the milestone goal. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to - service the call.
questId - The quest ID of the quest to accept.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Quests.ClaimMilestoneResult> - - claim - (GoogleApiClient apiClient, String questId, String milestoneId) -

-
-
- - - -
-
- - - - -

Asynchronously claim the milestone. This method informs Google Play Games services that the - player has completed the milestone on this device, and prevents the milestone from being - claimed on another device by the same user. If the method call returns - STATUS_OK, your app should reward the player based on the - CompletionRewardData of the milestone. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the - call.
questId - The parent quest ID.
milestoneId - The ID of the milestone to claim.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getQuestIntent - (GoogleApiClient apiClient, String questId) -

-
-
- - - -
-
- - - - -

Get an intent to view a single quest. Note that this must be invoked using - startActivityForResult(Intent, int) so that the identity of the - calling package can be established. -

- The functionality of this activity is identical to (GoogleApiClient, int[]), the only difference being this activity displays a single quest - rather than a list of quests. See - getQuestsIntent(GoogleApiClient, int[]) for usage details and behavior. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
questId - The ID of the quest to display.
-
-
-
Returns
-
  • An Intent that can be started to view the quest. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getQuestsIntent - (GoogleApiClient apiClient, int[] questSelectors) -

-
-
- - - -
-
- - - - -

Get an intent to view a list of quests. Note that this must be invoked using - startActivityForResult(Intent, int) so that the identity of the - calling package can be established. -

- Quests that are open will contain an "Accept" button, while quests that are completed with - unclaimed milestone rewards will have a "Claim Reward" button. Buttons will not be shown for - quests in other states. -

- If the user clicks the "Accept" button on a quest, - accept(GoogleApiClient, String) will be called. If the quest is successfully - accepted, the activity will close with RESULT_OK, and the data - intent will contain a parcelable object in EXTRA_QUEST indicating the accepted - quest. -

- If the user clicks the "Claim Reward" button on a quest, the activity will close with - RESULT_OK, and the data intent will contain a parcelable object in - EXTRA_QUEST indicating the quest the user would like to claim a reward for. - The caller is responsible for examining the state of this returned quest. If the quest state - is STATE_COMPLETED, the caller should invoke - claim(GoogleApiClient, String, String). If the claim succeeds, the caller - should then give the reward to the player. -

- If the user canceled, the result will be RESULT_CANCELED. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
questSelectors - Array of quest selectors to include in the list of quests. Valid values - include: SELECT_UPCOMING, SELECT_OPEN, SELECT_ACCEPTED, - SELECT_ENDING_SOON, SELECT_COMPLETED, - SELECT_COMPLETED_UNCLAIMED, SELECT_EXPIRED, - SELECT_FAILED, or SELECT_RECENTLY_FAILED. - Use SELECT_ALL_QUESTS to view all quests.
-
-
-
Returns
-
  • An Intent that can be started to view the list of quests. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Quests.LoadQuestsResult> - - load - (GoogleApiClient apiClient, int[] questSelectors, int sortOrder, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load the quest data for the currently signed-in player and game into - a single result, including only quests in the provided state array. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
questSelectors - An array of quest selectors to indicate which quest states to include. - Valid values include: - SELECT_UPCOMING, SELECT_OPEN, - SELECT_ACCEPTED, SELECT_ENDING_SOON, - SELECT_COMPLETED, SELECT_COMPLETED_UNCLAIMED, - SELECT_EXPIRED, SELECT_FAILED, or SELECT_RECENTLY_FAILED. - Use SELECT_ALL_QUESTS to view all quests.
sortOrder - The sort order to use for sorting the quests. Must be either - SORT_ORDER_ENDING_SOON_FIRST or SORT_ORDER_RECENTLY_UPDATED_FIRST.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Quests.LoadQuestsResult> - - loadByIds - (GoogleApiClient apiClient, boolean forceReload, String... questIds) -

-
-
- - - -
-
- - - - -

Asynchronously load single quest data for the currently signed-in player and game. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
questIds - The IDs of quests to retrieve.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerQuestUpdateListener - (GoogleApiClient apiClient, QuestUpdateListener listener) -

-
-
- - - -
-
- - - - -

Register a listener to listen for updates on Quest instances. -

- Note that only one quest listener may be active at a time. Calling this method while - another quest listener was previously registered will replace the original listener with - the new one. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is called when the quest state changes. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - showStateChangedPopup - (GoogleApiClient apiClient, String questId) -

-
-
- - - -
-
- - - - -

Display a popup based on the current state of the quest. Popups are only displayed for quests - in STATE_ACCEPTED. If the quest is in any other state, no popup will be - displayed. Call this from the onAccepted callbacks to show a popup for accepting a quest. -

- This method should generally be invoked at the point of quest acceptance (after the callback - from accept(GoogleApiClient, String) returns). -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
questId - The ID of the quest to fetch assets from for the popup (name and images). -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterQuestUpdateListener - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Unregisters this client's quest update listener, if any. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/quest/package-summary.html b/docs/html/reference/com/google/android/gms/games/quest/package-summary.html deleted file mode 100644 index b127f339520b..000000000000 --- a/docs/html/reference/com/google/android/gms/games/quest/package-summary.html +++ /dev/null @@ -1,1006 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.quest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.quest

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Milestone - Data interface for retrieving milestone information.  - - - -
Quest - Data interface for retrieving quest information.  - - - -
Quests - Entry point for Quest functionality.  - - - -
Quests.AcceptQuestResult - Result delivered when accepting a quest.  - - - -
Quests.ClaimMilestoneResult - Result delivered when claiming a milestone.  - - - -
Quests.LoadQuestsResult - Result delivered when quest data has been loaded.  - - - -
QuestUpdateListener - Listener to invoke when a quest is updated.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MilestoneBuffer - AbstractDataBuffer implementation containing quest - milestone data.  - - - -
MilestoneEntity - Data object representing the data for a milestone.  - - - -
QuestBuffer - EntityBuffer implementation containing Quest details.  - - - -
QuestEntity - Data object representing the data for a quest.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/GameRequest.html b/docs/html/reference/com/google/android/gms/games/request/GameRequest.html deleted file mode 100644 index 07a7664930e3..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/GameRequest.html +++ /dev/null @@ -1,2352 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GameRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

GameRequest

- - - - - - implements - - Freezable<GameRequest> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.request.GameRequest
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for game requests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRECIPIENT_STATUS_ACCEPTED - Constant indicating that the request has been accepted. - - - -
intRECIPIENT_STATUS_PENDING - Constant indicating that the request is still pending. - - - -
intSTATUS_ACCEPTED - Constant indicating that this request has been accepted. - - - -
intSTATUS_PENDING - Constant indicating that this request has not been acted on yet. - - - -
intTYPE_ALL - Array of all the request type constants. - - - -
intTYPE_GIFT - Request type indicating that the sender is giving something to the recipient. - - - -
intTYPE_WISH - Request type indicating that the sender is asking for something from the recipient. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - long - - getCreationTimestamp() - -
- abstract - - - - - byte[] - - getData() - -
- Retrieves the data associated with the request. - - - -
- -
- abstract - - - - - long - - getExpirationTimestamp() - -
- abstract - - - - - Game - - getGame() - -
- Retrieves the game associated with this request. - - - -
- -
- abstract - - - - - int - - getRecipientStatus(String playerId) - -
- Retrieves the status of the request for a given recipient. - - - -
- -
- abstract - - - - - List<Player> - - getRecipients() - -
- Retrieves the information about all the players that the request was sent to. - - - -
- -
- abstract - - - - - String - - getRequestId() - -
- Retrieves the ID of this request. - - - -
- -
- abstract - - - - - Player - - getSender() - -
- Retrieves the information about the player that sent the request. - - - -
- -
- abstract - - - - - int - - getStatus() - -
- Retrieves the status of the request as an overall status depending on all recipients. - - - -
- -
- abstract - - - - - int - - getType() - -
- Retrieves the type of this request. - - - -
- -
- abstract - - - - - boolean - - isConsumed(String playerId) - -
- Retrieves whether the request was consumed by a specific recipient. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RECIPIENT_STATUS_ACCEPTED -

-
- - - - -
-
- - - - -

Constant indicating that the request has been accepted. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RECIPIENT_STATUS_PENDING -

-
- - - - -
-
- - - - -

Constant indicating that the request is still pending. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ACCEPTED -

-
- - - - -
-
- - - - -

Constant indicating that this request has been accepted. Note - not being returned from - server at the moment. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_PENDING -

-
- - - - -
-
- - - - -

Constant indicating that this request has not been acted on yet. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ALL -

-
- - - - -
-
- - - - -

Array of all the request type constants. -

- - -
- Constant Value: - - - 65535 - (0x0000ffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GIFT -

-
- - - - -
-
- - - - -

Request type indicating that the sender is giving something to the recipient. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_WISH -

-
- - - - -
-
- - - - -

Request type indicating that the sender is asking for something from the recipient. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The server timestamp (in milliseconds from epoch) at which this request was created. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

Retrieves the data associated with the request.

-
-
Returns
-
  • The data associated with the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getExpirationTimestamp - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The server timestamp (in milliseconds from epoch) at which this request will expire. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game associated with this request.

-
-
Returns
-
  • The associated game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getRecipientStatus - (String playerId) -

-
-
- - - -
-
- - - - -

Retrieves the status of the request for a given recipient.

-
-
Parameters
- - - - -
playerId - The player ID for which the consumed state should be queried.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - List<Player> - - getRecipients - () -

-
-
- - - -
-
- - - - -

Retrieves the information about all the players that the request was sent to.

-
-
Returns
-
  • The players that are receiving the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getRequestId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this request.

-
-
Returns
-
  • The request ID. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getSender - () -

-
-
- - - -
-
- - - - -

Retrieves the information about the player that sent the request.

-
-
Returns
-
  • The player that sent the request. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

Retrieves the status of the request as an overall status depending on all recipients.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - int - - getType - () -

-
-
- - - -
-
- - - - -

Retrieves the type of this request.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isConsumed - (String playerId) -

-
-
- - - -
-
- - - - -

Retrieves whether the request was consumed by a specific recipient.

-
-
Parameters
- - - - -
playerId - The player ID for which the consumed state should be queried.
-
-
-
Returns
-
  • True if the request was consumed by the given recipient. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/GameRequestBuffer.html b/docs/html/reference/com/google/android/gms/games/request/GameRequestBuffer.html deleted file mode 100644 index 582551b99ccc..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/GameRequestBuffer.html +++ /dev/null @@ -1,1865 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GameRequestBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GameRequestBuffer

- - - - - - - - - extends AbstractDataBuffer<GameRequest>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.request.GameRequest>
    ↳com.google.android.gms.games.request.GameRequestBuffer
- - - - - - - -
- - -

Class Overview

-

EntityBuffer implementation containing - Request details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - GameRequest - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - GameRequest - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/GameRequestEntity.html b/docs/html/reference/com/google/android/gms/games/request/GameRequestEntity.html deleted file mode 100644 index eee1a1e46e74..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/GameRequestEntity.html +++ /dev/null @@ -1,2954 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GameRequestEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GameRequestEntity

- - - - - extends Object
- - - - - - - implements - - GameRequest - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.request.GameRequestEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a request. This is immutable, and therefore safe to cache - or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.request.GameRequest -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - GameRequestEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - GameRequest - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - long - - getCreationTimestamp() - -
- - - - - - byte[] - - getData() - -
- Retrieves the data associated with the request. - - - -
- -
- - - - - - long - - getExpirationTimestamp() - -
- - - - - - Game - - getGame() - -
- Retrieves the game associated with this request. - - - -
- -
- - - - - - int - - getRecipientStatus(String playerId) - -
- Retrieves the status of the request for a given recipient. - - - -
- -
- - - - - - List<Player> - - getRecipients() - -
- Retrieves the information about all the players that the request was sent to. - - - -
- -
- - - - - - String - - getRequestId() - -
- Retrieves the ID of this request. - - - -
- -
- - - - - - Player - - getSender() - -
- Retrieves the information about the player that sent the request. - - - -
- -
- - - - - - int - - getStatus() - -
- Retrieves the status of the request as an overall status depending on all recipients. - - - -
- -
- - - - - - int - - getType() - -
- Retrieves the type of this request. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isConsumed(String playerId) - -
- Retrieves whether the request was consumed by a specific recipient. - - - -
- -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.request.GameRequest - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - GameRequestEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - GameRequest - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getCreationTimestamp - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

Retrieves the data associated with the request.

-
-
Returns
-
  • The data associated with the request. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getExpirationTimestamp - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game associated with this request.

-
-
Returns
-
  • The associated game. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getRecipientStatus - (String playerId) -

-
-
- - - -
-
- - - - -

Retrieves the status of the request for a given recipient.

-
-
Parameters
- - - - -
playerId - The player ID for which the consumed state should be queried.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - List<Player> - - getRecipients - () -

-
-
- - - -
-
- - - - -

Retrieves the information about all the players that the request was sent to.

-
-
Returns
-
  • The players that are receiving the request. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getRequestId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of this request.

-
-
Returns
-
  • The request ID. -
-
- -
-
- - - - -
-

- - public - - - - - Player - - getSender - () -

-
-
- - - -
-
- - - - -

Retrieves the information about the player that sent the request.

-
-
Returns
-
  • The player that sent the request. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

Retrieves the status of the request as an overall status depending on all recipients.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Retrieves the type of this request.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isConsumed - (String playerId) -

-
-
- - - -
-
- - - - -

Retrieves whether the request was consumed by a specific recipient.

-
-
Parameters
- - - - -
playerId - The player ID for which the consumed state should be queried.
-
-
-
Returns
-
  • True if the request was consumed by the given recipient. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/OnRequestReceivedListener.html b/docs/html/reference/com/google/android/gms/games/request/OnRequestReceivedListener.html deleted file mode 100644 index fb933cd547b0..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/OnRequestReceivedListener.html +++ /dev/null @@ -1,1137 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnRequestReceivedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnRequestReceivedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.request.OnRequestReceivedListener
- - - - - - - -
- - -

Class Overview

-

Listener to invoke when a new request is received. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onRequestReceived(GameRequest request) - -
- Callback invoked when a new request is received. - - - -
- -
- abstract - - - - - void - - onRequestRemoved(String requestId) - -
- Callback invoked when a previously received request has been removed from the local device. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onRequestReceived - (GameRequest request) -

-
-
- - - -
-
- - - - -

Callback invoked when a new request is received. This allows an app to respond to the request - as appropriate. If the app receives this callback, the system will not display a notification - for this request.

-
-
Parameters
- - - - -
request - The request that was received. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onRequestRemoved - (String requestId) -

-
-
- - - -
-
- - - - -

Callback invoked when a previously received request has been removed from the local device. - For example, this might occur if the sender cancels the request.

-
-
Parameters
- - - - -
requestId - The ID of the request that was removed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/Requests.LoadRequestsResult.html b/docs/html/reference/com/google/android/gms/games/request/Requests.LoadRequestsResult.html deleted file mode 100644 index ddcf84c628d2..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/Requests.LoadRequestsResult.html +++ /dev/null @@ -1,1230 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Requests.LoadRequestsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Requests.LoadRequestsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.request.Requests.LoadRequestsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when requests have loaded. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - GameRequestBuffer - - getRequests(int requestType) - -
- Retrieves any loaded requests of the specified type. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - GameRequestBuffer - - getRequests - (int requestType) -

-
-
- - - -
-
- - - - -

Retrieves any loaded requests of the specified type. Note that if requestType was - not specified in the corresponding call to - loadRequests(GoogleApiClient, int, int, int)}, this method will - return null.

-
-
Parameters
- - - - -
requestType - The type of GameRequest objects to retrieve.
-
-
-
Returns
-
  • Any requests which have the specified request type, or null if the type was not - requested when loading. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/Requests.UpdateRequestsResult.html b/docs/html/reference/com/google/android/gms/games/request/Requests.UpdateRequestsResult.html deleted file mode 100644 index 8b1a50fa9c46..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/Requests.UpdateRequestsResult.html +++ /dev/null @@ -1,1290 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Requests.UpdateRequestsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Requests.UpdateRequestsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.request.Requests.UpdateRequestsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when requests are updated. Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Set<String> - - getRequestIds() - -
- Provides the set of all the request IDs that were used for the update. - - - -
- -
- abstract - - - - - int - - getRequestOutcome(String requestId) - -
- Retrieve the outcome of updating the specified request. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Set<String> - - getRequestIds - () -

-
-
- - - -
-
- - - - -

Provides the set of all the request IDs that were used for the update. This set does not - preserve the original order in which updates were performed or added to the - RequestUpdateOutcomes object.

-
-
Returns
-
  • The set of all the external request IDs that were a part of the update operation. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getRequestOutcome - (String requestId) -

-
-
- - - -
-
- - - - -

Retrieve the outcome of updating the specified request. If the request ID was not part of - the original update operation, this will throw an exception.

-
-
Parameters
- - - - -
requestId - The external request ID to lookup.
-
-
-
Returns
-
  • The outcome of the update for the given request. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/Requests.html b/docs/html/reference/com/google/android/gms/games/request/Requests.html deleted file mode 100644 index d133df0829d5..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/Requests.html +++ /dev/null @@ -1,2742 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Requests | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Requests

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.request.Requests
- - - - - - - -
- - -

Class Overview

-

Entry point for request functionality. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceRequests.LoadRequestsResult - Result delivered when requests have loaded.  - - - -
- - - - - interfaceRequests.UpdateRequestsResult - Result delivered when requests are updated.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_REQUESTS - Used to return a list of GameRequest objects. - - - -
intMAX_REQUEST_RECIPIENTS - The maximum number of recipients for a gift/request. - - - -
intREQUEST_DEFAULT_LIFETIME_DAYS - Value used to signal the server to use the default request lifetime. - - - -
intREQUEST_DIRECTION_INBOUND - Load only inbound requests (where the loading player is the recipient). - - - -
intREQUEST_DIRECTION_OUTBOUND - Load only outbound requests (where the loading player is the sender). - - - -
intREQUEST_UPDATE_OUTCOME_FAIL - Constant indicating that the request update failed. - - - -
intREQUEST_UPDATE_OUTCOME_RETRY - Constant indicating that the request update failed but should be retried. - - - -
intREQUEST_UPDATE_OUTCOME_SUCCESS - Constant indicating that the request update was a success. - - - -
intREQUEST_UPDATE_TYPE_ACCEPT - Constant indicating that the request should be accepted. - - - -
intREQUEST_UPDATE_TYPE_DISMISS - Constant indicating that the request should be dismissed. - - - -
intSORT_ORDER_EXPIRING_SOON_FIRST - Sort requests with the requests expiring soonest first. - - - -
intSORT_ORDER_SOCIAL_AGGREGATION - Sort requests such that requests from players in the user's circles are returned first. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Requests.UpdateRequestsResult> - - acceptRequest(GoogleApiClient apiClient, String requestId) - -
- Accepts the specified request. - - - -
- -
- abstract - - - - - PendingResult<Requests.UpdateRequestsResult> - - acceptRequests(GoogleApiClient apiClient, List<String> requestIds) - -
- Accepts the specified requests as a batch operation. - - - -
- -
- abstract - - - - - PendingResult<Requests.UpdateRequestsResult> - - dismissRequest(GoogleApiClient apiClient, String requestId) - -
- Dismisses the specified request. - - - -
- -
- abstract - - - - - PendingResult<Requests.UpdateRequestsResult> - - dismissRequests(GoogleApiClient apiClient, List<String> requestIds) - -
- Dismisses the specified requests as a batch operation. - - - -
- -
- abstract - - - - - ArrayList<GameRequest> - - getGameRequestsFromBundle(Bundle extras) - -
- This method takes a Bundle object and extracts the GameRequest list provided. - - - -
- -
- abstract - - - - - ArrayList<GameRequest> - - getGameRequestsFromInboxResponse(Intent response) - -
- This method takes an Intent object and extracts the GameRequest list provided - as an extra. - - - -
- -
- abstract - - - - - Intent - - getInboxIntent(GoogleApiClient apiClient) - -
- Returns an intent that will let the user see and manage any outstanding requests. - - - -
- -
- abstract - - - - - int - - getMaxLifetimeDays(GoogleApiClient apiClient) - -
- Gets the maximum lifetime of a request in days. - - - -
- -
- abstract - - - - - int - - getMaxPayloadSize(GoogleApiClient apiClient) - -
- Gets the maximum data size of a request payload in bytes. - - - -
- -
- abstract - - - - - Intent - - getSendIntent(GoogleApiClient apiClient, int type, byte[] payload, int requestLifetimeDays, Bitmap icon, String description) - -
- Returns an intent that will let the user send a request to another player. - - - -
- -
- abstract - - - - - PendingResult<Requests.LoadRequestsResult> - - loadRequests(GoogleApiClient apiClient, int requestDirection, int types, int sortOrder) - -
- Loads requests for the current game. - - - -
- -
- abstract - - - - - void - - registerRequestListener(GoogleApiClient apiClient, OnRequestReceivedListener listener) - -
- Register a listener to intercept incoming requests for the currently signed-in user. - - - -
- -
- abstract - - - - - void - - unregisterRequestListener(GoogleApiClient apiClient) - -
- Unregisters this client's request listener, if any. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_REQUESTS -

-
- - - - -
-
- - - - -

Used to return a list of GameRequest objects. Retrieve with - getParcelableArrayListExtra(String) or - getParcelableArrayList(String). -

- - -
- Constant Value: - - - "requests" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_REQUEST_RECIPIENTS -

-
- - - - -
-
- - - - -

The maximum number of recipients for a gift/request. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_DEFAULT_LIFETIME_DAYS -

-
- - - - -
-
- - - - -

Value used to signal the server to use the default request lifetime. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_DIRECTION_INBOUND -

-
- - - - -
-
- - - - -

Load only inbound requests (where the loading player is the recipient). -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_DIRECTION_OUTBOUND -

-
- - - - -
-
- - - - -

Load only outbound requests (where the loading player is the sender). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_UPDATE_OUTCOME_FAIL -

-
- - - - -
-
- - - - -

Constant indicating that the request update failed.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_UPDATE_OUTCOME_RETRY -

-
- - - - -
-
- - - - -

Constant indicating that the request update failed but should be retried.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_UPDATE_OUTCOME_SUCCESS -

-
- - - - -
-
- - - - -

Constant indicating that the request update was a success.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_UPDATE_TYPE_ACCEPT -

-
- - - - -
-
- - - - -

Constant indicating that the request should be accepted.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - REQUEST_UPDATE_TYPE_DISMISS -

-
- - - - -
-
- - - - -

Constant indicating that the request should be dismissed.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_EXPIRING_SOON_FIRST -

-
- - - - -
-
- - - - -

Sort requests with the requests expiring soonest first. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SORT_ORDER_SOCIAL_AGGREGATION -

-
- - - - -
-
- - - - -

Sort requests such that requests from players in the user's circles are returned first. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Requests.UpdateRequestsResult> - - acceptRequest - (GoogleApiClient apiClient, String requestId) -

-
-
- - - -
-
- - - - -

Accepts the specified request. If the result of this operation is - REQUEST_UPDATE_OUTCOME_SUCCESS, the player successfully accepted the - request. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
requestId - The ID of the request to accept.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Requests.UpdateRequestsResult> - - acceptRequests - (GoogleApiClient apiClient, List<String> requestIds) -

-
-
- - - -
-
- - - - -

Accepts the specified requests as a batch operation. If the result of this operation is - REQUEST_UPDATE_OUTCOME_SUCCESS, the player successfully accepted the - requests. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
requestIds - The IDs of the requests to accept.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Requests.UpdateRequestsResult> - - dismissRequest - (GoogleApiClient apiClient, String requestId) -

-
-
- - - -
-
- - - - -

Dismisses the specified request. If the result of this operation is - REQUEST_UPDATE_OUTCOME_SUCCESS, the request will be deleted from local - storage. Note that dismissing a request does not inform the sender of the action. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
requestId - The ID of the request to dismiss.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Requests.UpdateRequestsResult> - - dismissRequests - (GoogleApiClient apiClient, List<String> requestIds) -

-
-
- - - -
-
- - - - -

Dismisses the specified requests as a batch operation. If the result of this operation is - REQUEST_UPDATE_OUTCOME_SUCCESS, the requests will be deleted from local - storage. Note that dismissing a request does not inform the sender of the action. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
requestIds - The ID of the requests to dismiss.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - ArrayList<GameRequest> - - getGameRequestsFromBundle - (Bundle extras) -

-
-
- - - -
-
- - - - -

This method takes a Bundle object and extracts the GameRequest list provided. - If the Bundle is invalid or does not contain the correct data, this method returns an - empty list.

-
-
Parameters
- - - - -
extras - The Bundle to parse for GameRequest objects.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - ArrayList<GameRequest> - - getGameRequestsFromInboxResponse - (Intent response) -

-
-
- - - -
-
- - - - -

This method takes an Intent object and extracts the GameRequest list provided - as an extra. Specifically, this method is useful in parsing the returned Intent that - was returned as the response from the request inbox Intent. If the Intent is - invalid or does not contain the correct extra data, this method returns an empty list.

-
-
Parameters
- - - - -
response - The Intent response from the requests inbox.
-
-
-
Returns
- -
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getInboxIntent - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user see and manage any outstanding requests. Note that - this must be invoked using startActivityForResult(Intent, int) so that the - identity of the calling package can be established. -

- If the user canceled, the result will be RESULT_CANCELED. If the user - selected any requests to accept, the result will be RESULT_OK and the data - intent will contain the selected requests as a parcelable extra in EXTRA_REQUESTS. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • An Intent that can be started to view the request inbox UI. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMaxLifetimeDays - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum lifetime of a request in days. This is guaranteed to be at least 14 days. -

- If the service cannot be reached for some reason, this will return -1. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum request lifetime in days. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMaxPayloadSize - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum data size of a request payload in bytes. Guaranteed to be at least 2 KB. May - increase in the future. -

- If the service cannot be reached for some reason, this will return -1. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum data size per request in bytes. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSendIntent - (GoogleApiClient apiClient, int type, byte[] payload, int requestLifetimeDays, Bitmap icon, String description) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user send a request to another player. Note that this - must be invoked using startActivityForResult(Intent, int) so that the - identity of the calling package can be established. -

- Players may be preselected by specifying a list of player IDs in the - EXTRA_PLAYER_IDS extra on the returned intent. -

- If the user canceled, the result will be RESULT_CANCELED. If the request was - sent successfully, the result will be RESULT_OK. If the request could not be - sent, the result will be RESULT_SEND_REQUEST_FAILED. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
type - The type of the request to send. May be either TYPE_GIFT or - TYPE_WISH.
payload - A byte array of data to send with the request. May be a maximum of - getMaxPayloadSize(GoogleApiClient) bytes.
requestLifetimeDays - How long (in days) this request should last if the recipient takes - no action. Must be at least 1 day and no more than - getMaxLifetimeDays(GoogleApiClient). To use the server default, use - REQUEST_DEFAULT_LIFETIME_DAYS.
icon - A Bitmap to display as the request icon.
description - String describing the item. Displayed to the user to add context.
-
-
-
Returns
-
  • An Intent that can be started to launch the "Send Request" UI. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Requests.LoadRequestsResult> - - loadRequests - (GoogleApiClient apiClient, int requestDirection, int types, int sortOrder) -

-
-
- - - -
-
- - - - -

Loads requests for the current game. Requests with any of the specified types will be - returned. -

- Possible types include TYPE_GIFT or - TYPE_WISH. Types may be joined together as a bitmask to request - multiple types. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
requestDirection - The direction of requests to load. Must be either - REQUEST_DIRECTION_INBOUND or - REQUEST_DIRECTION_OUTBOUND.
types - Mask indicating the types of requests to load.
sortOrder - The sort order to use for sorting the requests. Must be either - SORT_ORDER_EXPIRING_SOON_FIRST or - SORT_ORDER_SOCIAL_AGGREGATION.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - registerRequestListener - (GoogleApiClient apiClient, OnRequestReceivedListener listener) -

-
-
- - - -
-
- - - - -

Register a listener to intercept incoming requests for the currently signed-in user. If a - listener is registered by this method, the incoming request will not generate a status bar - notification as long as this client remains connected. -

- Note that only one request listener may be active at a time. Calling this method while - another request listener was previously registered will replace the original listener with - the new one. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
listener - The listener that is called when a new request is received. The listener is - called on the main thread. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - unregisterRequestListener - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Unregisters this client's request listener, if any. Any new requests will generate status bar - notifications as normal. -

- Required API: API
- Required Scopes: SCOPE_GAMES

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/request/package-summary.html b/docs/html/reference/com/google/android/gms/games/request/package-summary.html deleted file mode 100644 index 10eed55dca7d..000000000000 --- a/docs/html/reference/com/google/android/gms/games/request/package-summary.html +++ /dev/null @@ -1,962 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.request | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.request

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GameRequest - Data interface for game requests.  - - - -
OnRequestReceivedListener - Listener to invoke when a new request is received.  - - - -
Requests - Entry point for request functionality.  - - - -
Requests.LoadRequestsResult - Result delivered when requests have loaded.  - - - -
Requests.UpdateRequestsResult - Result delivered when requests are updated.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - -
GameRequestBuffer - EntityBuffer implementation containing - Request details.  - - - -
GameRequestEntity - Data object representing the data for a request.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshot.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshot.html deleted file mode 100644 index 3d1d849c61c7..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshot.html +++ /dev/null @@ -1,1412 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshot | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Snapshot

- - - - - - implements - - Freezable<Snapshot> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshot
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for a representation of a saved game. This includes both the metadata and the - actual game content. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - SnapshotMetadata - - getMetadata() - -
- Retrieves the metadata for this snapshot. - - - -
- -
- abstract - - - - - SnapshotContents - - getSnapshotContents() - -
- Retrieve the SnapshotContents associated with this snapshot. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - SnapshotMetadata - - getMetadata - () -

-
-
- - - -
-
- - - - -

Retrieves the metadata for this snapshot.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - SnapshotContents - - getSnapshotContents - () -

-
-
- - - -
-
- - - - -

Retrieve the SnapshotContents associated with this snapshot. This object can be used - to update the data of a snapshot. Note that this will return null if this snapshot was not - obtained via open(GoogleApiClient, SnapshotMetadata).

-
-
Returns
-
  • The SnapshotContents for this snapshot, or null if the snapshot is not - opened. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotContents.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotContents.html deleted file mode 100644 index 07078b8f26fc..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotContents.html +++ /dev/null @@ -1,1529 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotContents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

SnapshotContents

- - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.SnapshotContents
- - - - - - - -
- - -

Class Overview

-

Data interface for a representation of Snapshot contents. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ParcelFileDescriptor - - getParcelFileDescriptor() - -
- Retrieve the ParcelFileDescriptor associated with the underlying file for this - snapshot contents. - - - -
- -
- abstract - - - - - boolean - - isClosed() - -
- abstract - - - - - boolean - - modifyBytes(int dstOffset, byte[] content, int srcOffset, int count) - -
- Write the specified data into the snapshot. - - - -
- -
- abstract - - - - - byte[] - - readFully() - -
- Read the contents of a snapshot. - - - -
- -
- abstract - - - - - boolean - - writeBytes(byte[] content) - -
- Write the specified data into the snapshot. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ParcelFileDescriptor - - getParcelFileDescriptor - () -

-
-
- - - -
-
- - - - -

Retrieve the ParcelFileDescriptor associated with the underlying file for this - snapshot contents. This object can be used to update the data of a snapshot, but the snapshot - should still be committed using commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange) or - resolveConflict(GoogleApiClient, String, Snapshot) (in case of conflict resolution). -

- If this SnapshotContentsEntity was not obtained via - getSnapshotContents() or - getResolutionSnapshotContents(), or if the contents have - already been committed and closed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange) or - resolveConflict(GoogleApiClient, String, Snapshot), this method will throw an exception.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isClosed - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether this snapshot contents has been closed. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - modifyBytes - (int dstOffset, byte[] content, int srcOffset, int count) -

-
-
- - - -
-
- - - - -

Write the specified data into the snapshot. The contents of the snapshot will be replaced - with the data provided in content. The data will be persisted on disk, but is not - uploaded to the server until the snapshot is committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange). -

- Note that this form of the API does not necessarily overwrite the entire contents of the - file. If you are writing less data than was previously stored in the snapshot, the excess - data will remain. Use writeBytes(byte[]) to fully overwrite the file. -

- If the snapshot was not opened via open(GoogleApiClient, SnapshotMetadata), or if the contents have already - been committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange), this method will throw an exception.

-
-
Parameters
- - - - - - - - - - - - - -
dstOffset - Position in the snapshot file to start writing data to. 0 indicates the head - of the file.
content - The data to write.
srcOffset - Position in content to start writing from.
count - Number of bytes from content to write to this snapshot.
-
-
-
Returns
-
  • Whether or not the data was successfully written to disk. -
-
- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - readFully - () -

-
-
- - - -
-
- - - - -

Read the contents of a snapshot. -

- If this snapshot was not opened via open(GoogleApiClient, SnapshotMetadata), or if the contents have already - been committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange) this method will throw an exception.

-
-
Returns
-
  • The bytes of the snapshot contents.
-
-
-
Throws
- - - - -
IOException - if reading the snapshot failed. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - writeBytes - (byte[] content) -

-
-
- - - -
-
- - - - -

Write the specified data into the snapshot. The contents of the snapshot will be replaced - with the data provided in content. The data will be persisted on disk, but is not - uploaded to the server until the snapshot is committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange). -

- Note that this form of the API will fully overwrite the contents of the file. No previous - data will be retained. Use modifyBytes(int, byte[], int, int) to overwrite parts of - the file. -

- If the snapshot was not opened via open(GoogleApiClient, SnapshotMetadata), or if the contents have already - been committed via commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange), this method will throw an exception.

-
-
Parameters
- - - - -
content - The data to write.
-
-
-
Returns
-
  • Whether or not the data was successfully written to disk. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotEntity.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotEntity.html deleted file mode 100644 index 5459ee9edc23..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotEntity.html +++ /dev/null @@ -1,2120 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SnapshotEntity

- - - - - extends Object
- - - - - - - implements - - Snapshot - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.snapshot.SnapshotEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the data for a saved game. This is immutable, and therefore safe to - cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - SnapshotEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - Snapshot - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - SnapshotMetadata - - getMetadata() - -
- Retrieves the metadata for this snapshot. - - - -
- -
- - - - - - SnapshotContents - - getSnapshotContents() - -
- Retrieve the SnapshotContents associated with this snapshot. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.snapshot.Snapshot - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - SnapshotEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Snapshot - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - SnapshotMetadata - - getMetadata - () -

-
-
- - - -
-
- - - - -

Retrieves the metadata for this snapshot.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - SnapshotContents - - getSnapshotContents - () -

-
-
- - - -
-
- - - - -

Retrieve the SnapshotContents associated with this snapshot. This object can be used - to update the data of a snapshot. Note that this will return null if this snapshot was not - obtained via open(GoogleApiClient, SnapshotMetadata).

-
-
Returns
-
  • The SnapshotContents for this snapshot, or null if the snapshot is not - opened. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadata.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadata.html deleted file mode 100644 index 9dd4dada9282..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadata.html +++ /dev/null @@ -1,2094 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotMetadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

SnapshotMetadata

- - - - - - implements - - Freezable<SnapshotMetadata> - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.SnapshotMetadata
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Data interface for the metadata of a saved game. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
longPLAYED_TIME_UNKNOWN - Constant indicating that the played time of a snapshot is unknown. - - - -
longPROGRESS_VALUE_UNKNOWN - Constant indicating that the progress value of a snapshot is unknown. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - float - - getCoverImageAspectRatio() - -
- Retrieves the aspect ratio of the cover image for this snapshot, if any. - - - -
- -
- abstract - - - - - Uri - - getCoverImageUri() - -
- Retrieves an image URI that can be used to load the snapshot's cover image. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- Retrieves the description of this snapshot. - - - -
- -
- abstract - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the snapshot description into the given CharArrayBuffer. - - - -
- -
- abstract - - - - - Game - - getGame() - -
- Retrieves the game associated with this snapshot. - - - -
- -
- abstract - - - - - long - - getLastModifiedTimestamp() - -
- Retrieves the last time this snapshot was modified, in millis since epoch. - - - -
- -
- abstract - - - - - Player - - getOwner() - -
- Retrieves the player that owns this snapshot. - - - -
- -
- abstract - - - - - long - - getPlayedTime() - -
- Retrieves the played time of this snapshot in milliseconds. - - - -
- -
- abstract - - - - - long - - getProgressValue() - -
- Retrieves the progress value for this snapshot. - - - -
- -
- abstract - - - - - String - - getUniqueName() - -
- Retrieves the unique identifier of this snapshot. - - - -
- -
- abstract - - - - - boolean - - hasChangePending() - -
- Indicates whether or not this snapshot has any changes pending that have not been uploaded to - the server. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - long - - PLAYED_TIME_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating that the played time of a snapshot is unknown. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - PROGRESS_VALUE_UNKNOWN -

-
- - - - -
-
- - - - -

Constant indicating that the progress value of a snapshot is unknown. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - float - - getCoverImageAspectRatio - () -

-
-
- - - -
-
- - - - -

Retrieves the aspect ratio of the cover image for this snapshot, if any. This is the ratio of - width to height, so a value > 1.0f indicates a landscape image while a value < 1.0f indicates - a portrait image. If the snapshot has no cover image, this will return 0.0f.

-
-
Returns
-
  • The aspect ratio of the cover image, or 0.0f if no image is present. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getCoverImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the snapshot's cover image. Returns null if - the snapshot has no cover image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load this snapshot's cover image, if one is present. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description of this snapshot.

-
-
Returns
-
  • The description of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the snapshot description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game associated with this snapshot.

-
-
Returns
-
  • The associated game. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getLastModifiedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the last time this snapshot was modified, in millis since epoch.

-
-
Returns
-
  • The last modification time of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Player - - getOwner - () -

-
-
- - - -
-
- - - - -

Retrieves the player that owns this snapshot.

-
-
Returns
-
  • The owning player. -
-
- -
-
- - - - -
-

- - public - - - abstract - - long - - getPlayedTime - () -

-
-
- - - -
-
- - - - -

Retrieves the played time of this snapshot in milliseconds. This value is specified during - the update operation. If not known, returns PLAYED_TIME_UNKNOWN.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - long - - getProgressValue - () -

-
-
- - - -
-
- - - - -

Retrieves the progress value for this snapshot. Can be used to provide automatic conflict - resolution (see RESOLUTION_POLICY_HIGHEST_PROGRESS). If not known, returns - PROGRESS_VALUE_UNKNOWN.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - String - - getUniqueName - () -

-
-
- - - -
-
- - - - -

Retrieves the unique identifier of this snapshot. This value can be passed to - open(GoogleApiClient, SnapshotMetadata) to open the snapshot for modification. -

- This name should be unique within the scope of the application.

-
-
Returns
-
  • Unique identifier of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasChangePending - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this snapshot has any changes pending that have not been uploaded to - the server. Once all changes have been flushed to the server, this will return false.

-
-
Returns
-
  • Whether or not this snapshot has any outstanding changes. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataBuffer.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataBuffer.html deleted file mode 100644 index 310bab9c6a28..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotMetadataBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SnapshotMetadataBuffer

- - - - - - - - - extends AbstractDataBuffer<SnapshotMetadata>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.games.snapshot.SnapshotMetadata>
    ↳com.google.android.gms.games.snapshot.SnapshotMetadataBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of snapshots. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SnapshotMetadata - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SnapshotMetadata - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.Builder.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.Builder.html deleted file mode 100644 index 662bdc593bcf..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.Builder.html +++ /dev/null @@ -1,1611 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotMetadataChange.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

SnapshotMetadataChange.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.snapshot.SnapshotMetadataChange.Builder
- - - - - - - -
- - -

Class Overview

-

Builder for SnapshotMetadataChange objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SnapshotMetadataChange.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - SnapshotMetadataChange - - build() - -
- - - - - - SnapshotMetadataChange.Builder - - fromMetadata(SnapshotMetadata metadata) - -
- - - - - - SnapshotMetadataChange.Builder - - setCoverImage(Bitmap coverImage) - -
- - - - - - SnapshotMetadataChange.Builder - - setDescription(String description) - -
- - - - - - SnapshotMetadataChange.Builder - - setPlayedTimeMillis(long playedTimeMillis) - -
- - - - - - SnapshotMetadataChange.Builder - - setProgressValue(long progressValue) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SnapshotMetadataChange.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - SnapshotMetadataChange - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadataChange.Builder - - fromMetadata - (SnapshotMetadata metadata) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadataChange.Builder - - setCoverImage - (Bitmap coverImage) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadataChange.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadataChange.Builder - - setPlayedTimeMillis - (long playedTimeMillis) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadataChange.Builder - - setProgressValue - (long progressValue) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.html deleted file mode 100644 index 42578eb4562c..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.html +++ /dev/null @@ -1,1629 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotMetadataChange | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - | Protected Ctors - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

SnapshotMetadataChange

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.snapshot.SnapshotMetadataChange
- - - - - - - -
- - -

Class Overview

-

A collection of changes to apply to the metadata of a snapshot. Fields that are not set will - retain their current values. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSnapshotMetadataChange.Builder - Builder for SnapshotMetadataChange objects.  - - - -
- - - - - - - - - - - -
Fields
- public - static - final - SnapshotMetadataChangeEMPTY_CHANGE - Sentinel object to use to commit a change without modifying the metadata. - - - -
- - - - - - - - - - - - - - - - - - - - - -
Protected Constructors
- - - - - - - - SnapshotMetadataChange() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Bitmap - - getCoverImage() - -
- abstract - - - - - String - - getDescription() - -
- abstract - - - - - Long - - getPlayedTimeMillis() - -
- abstract - - - - - Long - - getProgressValue() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - SnapshotMetadataChange - - EMPTY_CHANGE -

-
- - - - -
-
- - - - -

Sentinel object to use to commit a change without modifying the metadata. -

- - -
-
- - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - SnapshotMetadataChange - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Bitmap - - getCoverImage - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The new cover image to set for the snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The new description to set for the snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Long - - getPlayedTimeMillis - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The new played time to set for the snapshot. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Long - - getProgressValue - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The new progress value to set for the snapshot. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataEntity.html b/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataEntity.html deleted file mode 100644 index c7618e9e7279..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/SnapshotMetadataEntity.html +++ /dev/null @@ -1,2980 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SnapshotMetadataEntity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SnapshotMetadataEntity

- - - - - extends Object
- - - - - - - implements - - SnapshotMetadata - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.games.snapshot.SnapshotMetadataEntity
- - - - - - - -
- - -

Class Overview

-

Data object representing the metadata for a saved game. This is immutable, and therefore safe to - cache or store. Note, however, that the data it represents may grow stale. -

- This class exists solely to support parceling these objects and should not be used directly. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -com.google.android.gms.games.snapshot.SnapshotMetadata -
- - -
-
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - SnapshotMetadataEntityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object obj) - -
- - - - - - SnapshotMetadata - - freeze() - -
- Freeze a volatile representation into an immutable representation. - - - -
- -
- - - - - - float - - getCoverImageAspectRatio() - -
- Retrieves the aspect ratio of the cover image for this snapshot, if any. - - - -
- -
- - - - - - Uri - - getCoverImageUri() - -
- Retrieves an image URI that can be used to load the snapshot's cover image. - - - -
- -
- - - - - - String - - getDescription() - -
- Retrieves the description of this snapshot. - - - -
- -
- - - - - - void - - getDescription(CharArrayBuffer dataOut) - -
- Loads the snapshot description into the given CharArrayBuffer. - - - -
- -
- - - - - - Game - - getGame() - -
- Retrieves the game associated with this snapshot. - - - -
- -
- - - - - - long - - getLastModifiedTimestamp() - -
- Retrieves the last time this snapshot was modified, in millis since epoch. - - - -
- -
- - - - - - Player - - getOwner() - -
- Retrieves the player that owns this snapshot. - - - -
- -
- - - - - - long - - getPlayedTime() - -
- Retrieves the played time of this snapshot in milliseconds. - - - -
- -
- - - - - - long - - getProgressValue() - -
- Retrieves the progress value for this snapshot. - - - -
- -
- - - - - - String - - getSnapshotId() - -
- - - - - - String - - getUniqueName() - -
- Retrieves the unique identifier of this snapshot. - - - -
- -
- - - - - - boolean - - hasChangePending() - -
- Indicates whether or not this snapshot has any changes pending that have not been uploaded to - the server. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isDataValid() - -
- Check to see if this object is valid for use. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.games.snapshot.SnapshotMetadata - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - SnapshotMetadataEntityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object obj) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - SnapshotMetadata - - freeze - () -

-
-
- - - -
-
- - - - -

Freeze a volatile representation into an immutable representation. Objects returned from this - call are safe to cache. -

- Note that the output of freeze may not be identical to the parent object, but should - be equal. In other words: - - 

- 
- Freezable f1 = new Freezable();
- Freezable f2 = f1.freeze();
- f1 == f2 may not be true.
- f1.equals(f2) will be true.
- 
-

-
-
Returns
-
  • A concrete implementation of the data object. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getCoverImageAspectRatio - () -

-
-
- - - -
-
- - - - -

Retrieves the aspect ratio of the cover image for this snapshot, if any. This is the ratio of - width to height, so a value > 1.0f indicates a landscape image while a value < 1.0f indicates - a portrait image. If the snapshot has no cover image, this will return 0.0f.

-
-
Returns
-
  • The aspect ratio of the cover image, or 0.0f if no image is present. -
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getCoverImageUri - () -

-
-
- - - -
-
- - - - -

Retrieves an image URI that can be used to load the snapshot's cover image. Returns null if - the snapshot has no cover image. -

- To retrieve the Image from the Uri, use ImageManager.

-
-
Returns
-
  • A URI that can be used to load this snapshot's cover image, if one is present. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

Retrieves the description of this snapshot.

-
-
Returns
-
  • The description of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getDescription - (CharArrayBuffer dataOut) -

-
-
- - - -
-
- - - - -

Loads the snapshot description into the given CharArrayBuffer.

-
-
Parameters
- - - - -
dataOut - The buffer to load the data into. -
-
- -
-
- - - - -
-

- - public - - - - - Game - - getGame - () -

-
-
- - - -
-
- - - - -

Retrieves the game associated with this snapshot.

-
-
Returns
-
  • The associated game. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLastModifiedTimestamp - () -

-
-
- - - -
-
- - - - -

Retrieves the last time this snapshot was modified, in millis since epoch.

-
-
Returns
-
  • The last modification time of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - - - Player - - getOwner - () -

-
-
- - - -
-
- - - - -

Retrieves the player that owns this snapshot.

-
-
Returns
-
  • The owning player. -
-
- -
-
- - - - -
-

- - public - - - - - long - - getPlayedTime - () -

-
-
- - - -
-
- - - - -

Retrieves the played time of this snapshot in milliseconds. This value is specified during - the update operation. If not known, returns PLAYED_TIME_UNKNOWN.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - long - - getProgressValue - () -

-
-
- - - -
-
- - - - -

Retrieves the progress value for this snapshot. Can be used to provide automatic conflict - resolution (see RESOLUTION_POLICY_HIGHEST_PROGRESS). If not known, returns - PROGRESS_VALUE_UNKNOWN.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - String - - getSnapshotId - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getUniqueName - () -

-
-
- - - -
-
- - - - -

Retrieves the unique identifier of this snapshot. This value can be passed to - open(GoogleApiClient, SnapshotMetadata) to open the snapshot for modification. -

- This name should be unique within the scope of the application.

-
-
Returns
-
  • Unique identifier of this snapshot. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasChangePending - () -

-
-
- - - -
-
- - - - -

Indicates whether or not this snapshot has any changes pending that have not been uploaded to - the server. Once all changes have been flushed to the server, this will return false.

-
-
Returns
-
  • Whether or not this snapshot has any outstanding changes. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDataValid - () -

-
-
- - - -
-
- - - - -

Check to see if this object is valid for use. If the object is still volatile, this method - will indicate whether or not the object can be safely used. The output of a call to - freeze() will always be valid.

-
-
Returns
-
  • whether or not the object is valid for use. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.CommitSnapshotResult.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.CommitSnapshotResult.html deleted file mode 100644 index cd668cdfe69e..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.CommitSnapshotResult.html +++ /dev/null @@ -1,1166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshots.CommitSnapshotResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Snapshots.CommitSnapshotResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshots.CommitSnapshotResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a snapshot has been committed. At this point, the snapshot's data may - no longer be modified without being re-opened first. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - SnapshotMetadata - - getSnapshotMetadata() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - SnapshotMetadata - - getSnapshotMetadata - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The metadata for the snapshot that was committed. Note that the original - Snapshot may no longer be used to write data. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.DeleteSnapshotResult.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.DeleteSnapshotResult.html deleted file mode 100644 index b09f10b77f50..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.DeleteSnapshotResult.html +++ /dev/null @@ -1,1159 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshots.DeleteSnapshotResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Snapshots.DeleteSnapshotResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshots.DeleteSnapshotResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a snapshot has been deleted. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getSnapshotId() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getSnapshotId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ID of the snapshot that was deleted. This may be null if the operation did - not complete. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.LoadSnapshotsResult.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.LoadSnapshotsResult.html deleted file mode 100644 index db3052c980bb..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.LoadSnapshotsResult.html +++ /dev/null @@ -1,1215 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshots.LoadSnapshotsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Snapshots.LoadSnapshotsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshots.LoadSnapshotsResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when snapshot data has been loaded. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - SnapshotMetadataBuffer - - getSnapshots() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - SnapshotMetadataBuffer - - getSnapshots - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The snapshot data that was requested. This is guaranteed to be non-null, though - it may be empty. The listener must close this object when finished. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.OpenSnapshotResult.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.OpenSnapshotResult.html deleted file mode 100644 index eb8bd6930d48..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.OpenSnapshotResult.html +++ /dev/null @@ -1,1377 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshots.OpenSnapshotResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Snapshots.OpenSnapshotResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshots.OpenSnapshotResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a snapshot has been opened. -

- Possible status codes include: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getConflictId() - -
- Retrieves the ID of the conflict to resolve, if any. - - - -
- -
- abstract - - - - - Snapshot - - getConflictingSnapshot() - -
- Retrieves the modified version of this snapshot in the case of a conflict. - - - -
- -
- abstract - - - - - SnapshotContents - - getResolutionSnapshotContents() - -
- Retrieve the SnapshotContents object used to update the data in case of a - conflict. - - - -
- -
- abstract - - - - - Snapshot - - getSnapshot() - -
- Retrieves the snapshot that was opened. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getConflictId - () -

-
-
- - - -
-
- - - - -

Retrieves the ID of the conflict to resolve, if any. Pass this to - resolveConflict(GoogleApiClient, String, Snapshot) when resolving the conflict. Will return null if the - status of this operation is not STATUS_SNAPSHOT_CONFLICT.

-
-
Returns
-
  • The ID of the conflict to resolve, or null if there was no conflict. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Snapshot - - getConflictingSnapshot - () -

-
-
- - - -
-
- - - - -

Retrieves the modified version of this snapshot in the case of a conflict. This version - may differ from the values returned in getSnapshot(), and may need to be merged. - Will return null if the status of this operation is not - STATUS_SNAPSHOT_CONFLICT.

-
-
Returns
-
  • The modified snapshot data, or null if there was no conflict. -
-
- -
-
- - - - -
-

- - public - - - abstract - - SnapshotContents - - getResolutionSnapshotContents - () -

-
-
- - - -
-
- - - - -

Retrieve the SnapshotContents object used to update the data in case of a - conflict. Pass this to - resolveConflict(GoogleApiClient, String, String, SnapshotMetadataChange, SnapshotContents) - to resolve this conflict. -

- Will return null if the status of this operation is not - STATUS_SNAPSHOT_CONFLICT.

-
-
Returns
-
  • A SnapshotContents object to use to write resolved snapshot data, or null - if there was no conflict. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Snapshot - - getSnapshot - () -

-
-
- - - -
-
- - - - -

Retrieves the snapshot that was opened. This is always the device's most up-to-date view - of the snapshot data. If getStatus() is - STATUS_SNAPSHOT_CONFLICT, the return value here represents the - state of the snapshot on the server.

-
-
Returns
-
  • The snapshot that was opened, if any. This will be null if the open operation did - not succeed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.html b/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.html deleted file mode 100644 index bfce28c69f90..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/Snapshots.html +++ /dev/null @@ -1,2736 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Snapshots | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Snapshots

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.games.snapshot.Snapshots
- - - - - - - -
- - -

Class Overview

-

The Snapshots API allows you to store data representing the player's game progress on Google's - servers. Your app can use this data to restore saved state from a previous gaming session and - provide a visual indicator of progression to the player. -

- For more details, see the saved games - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceSnapshots.CommitSnapshotResult - Result delivered when a snapshot has been committed.  - - - -
- - - - - interfaceSnapshots.DeleteSnapshotResult - Result delivered when a snapshot has been deleted.  - - - -
- - - - - interfaceSnapshots.LoadSnapshotsResult - Result delivered when snapshot data has been loaded.  - - - -
- - - - - interfaceSnapshots.OpenSnapshotResult - Result delivered when a snapshot has been opened.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intDISPLAY_LIMIT_NONE - Constant passed to getSelectSnapshotIntent(GoogleApiClient, String, boolean, boolean, int) indicating that the UI should not cap the - number of displayed snapshots. - - - -
StringEXTRA_SNAPSHOT_METADATA - Intent extra used to pass a SnapshotMetadata. - - - -
StringEXTRA_SNAPSHOT_NEW - Intent extra used to indicate the user wants to create a new snapshot. - - - -
intRESOLUTION_POLICY_HIGHEST_PROGRESS - In the case of a conflict, the snapshot with the highest progress value will be used. - - - -
intRESOLUTION_POLICY_LAST_KNOWN_GOOD - In the case of a conflict, the last known good version of this snapshot will be used. - - - -
intRESOLUTION_POLICY_LONGEST_PLAYTIME - In the case of a conflict, the snapshot with the longest played time will be used. - - - -
intRESOLUTION_POLICY_MANUAL - In the case of a conflict, the result will be returned to the app for resolution. - - - -
intRESOLUTION_POLICY_MOST_RECENTLY_MODIFIED - In the case of a conflict, the most recently modified version of this snapshot will be used. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Snapshots.CommitSnapshotResult> - - commitAndClose(GoogleApiClient apiClient, Snapshot snapshot, SnapshotMetadataChange metadataChange) - -
- Commit any modifications made to the snapshot. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.DeleteSnapshotResult> - - delete(GoogleApiClient apiClient, SnapshotMetadata metadata) - -
- Delete the specified snapshot. - - - -
- -
- abstract - - - - - void - - discardAndClose(GoogleApiClient apiClient, Snapshot snapshot) - -
- Discard the contents of the snapshot and close the contents. - - - -
- -
- abstract - - - - - int - - getMaxCoverImageSize(GoogleApiClient apiClient) - -
- Gets the maximum data size per snapshot cover image in bytes. - - - -
- -
- abstract - - - - - int - - getMaxDataSize(GoogleApiClient apiClient) - -
- Gets the maximum data size per snapshot in bytes. - - - -
- -
- abstract - - - - - Intent - - getSelectSnapshotIntent(GoogleApiClient apiClient, String title, boolean allowAddButton, boolean allowDelete, int maxSnapshots) - -
- Returns an intent that will let the user select a snapshot. - - - -
- -
- abstract - - - - - SnapshotMetadata - - getSnapshotFromBundle(Bundle extras) - -
- This method takes a Bundle object and extracts the Snapshot provided. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.LoadSnapshotsResult> - - load(GoogleApiClient apiClient, boolean forceReload) - -
- Asynchronously load the snapshot data for the currently signed-in player. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - open(GoogleApiClient apiClient, String fileName, boolean createIfNotFound) - -
- Open a snapshot with the given name. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - open(GoogleApiClient apiClient, String fileName, boolean createIfNotFound, int conflictPolicy) - -
- Open a snapshot with the given name. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - open(GoogleApiClient apiClient, SnapshotMetadata metadata) - -
- Open a snapshot with the given metadata (usually returned from - load(GoogleApiClient, boolean). - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - open(GoogleApiClient apiClient, SnapshotMetadata metadata, int conflictPolicy) - -
- Open a snapshot with the given metadata (usually returned from - load(GoogleApiClient, boolean). - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - resolveConflict(GoogleApiClient apiClient, String conflictId, String snapshotId, SnapshotMetadataChange metadataChange, SnapshotContents snapshotContents) - -
- Resolve a conflict using the provided data. - - - -
- -
- abstract - - - - - PendingResult<Snapshots.OpenSnapshotResult> - - resolveConflict(GoogleApiClient apiClient, String conflictId, Snapshot snapshot) - -
- Resolve a conflict using the data from the provided snapshot. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - DISPLAY_LIMIT_NONE -

-
- - - - -
-
- - - - -

Constant passed to getSelectSnapshotIntent(GoogleApiClient, String, boolean, boolean, int) indicating that the UI should not cap the - number of displayed snapshots. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_SNAPSHOT_METADATA -

-
- - - - -
-
- - - - -

Intent extra used to pass a SnapshotMetadata.

-
-
See Also
- -
- - -
- Constant Value: - - - "com.google.android.gms.games.SNAPSHOT_METADATA" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_SNAPSHOT_NEW -

-
- - - - -
-
- - - - -

Intent extra used to indicate the user wants to create a new snapshot.

-
-
See Also
- -
- - -
- Constant Value: - - - "com.google.android.gms.games.SNAPSHOT_NEW" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_POLICY_HIGHEST_PROGRESS -

-
- - - - -
-
- - - - -

In the case of a conflict, the snapshot with the highest progress value will be used. In the - case of a tie, the last known good snapshot will be chosen instead. -

- This policy is a good choice if your game uses the progress value of the snapshot to - determine the best saved game. Note that you must use - setProgressValue(long) when saving games for this - policy to be meaningful. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_POLICY_LAST_KNOWN_GOOD -

-
- - - - -
-
- - - - -

In the case of a conflict, the last known good version of this snapshot will be used. This - corresponds to the data that would be returned from getSnapshot() - in a custom merge. -

- This policy is a reasonable choice if your game requires stability from the snapshot data. - This policy ensures that only writes which are not contested are seen by the player, which - guarantees that all clients converge. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_POLICY_LONGEST_PLAYTIME -

-
- - - - -
-
- - - - -

In the case of a conflict, the snapshot with the longest played time will be used. In the - case of a tie, the last known good snapshot will be chosen instead. -

- This policy is a good choice if the length of play time is a reasonable proxy for the "best" - save game. Note that you must use - setPlayedTimeMillis(long) when saving games for this - policy to be meaningful. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_POLICY_MANUAL -

-
- - - - -
-
- - - - -

In the case of a conflict, the result will be returned to the app for resolution. No - automatic resolution will be performed. -

- This policy ensures that no user changes to the state of the save game will ever be lost. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED -

-
- - - - -
-
- - - - -

In the case of a conflict, the most recently modified version of this snapshot will be used. - This corresponds to the data that would be returned from - getConflictingSnapshot() in a custom merge. -

- This policy is a reasonable choice if your game can tolerate players on multiple devices - clobbering their own changes. Because this policy blindly chooses the most recent data, it is - possible that a player's changes may get lost. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.CommitSnapshotResult> - - commitAndClose - (GoogleApiClient apiClient, Snapshot snapshot, SnapshotMetadataChange metadataChange) -

-
-
- - - -
-
- - - - -

Commit any modifications made to the snapshot. This will cause the changes to be synced to - the server in the background. -

- Calling this method with a snapshot that has already been committed or that was not opened - via open(GoogleApiClient, SnapshotMetadata) will throw an exception. -

- Note that the total size of the contents of snapshot may not exceed the size provided - by getMaxDataSize(GoogleApiClient). -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
snapshot - The snapshot to commit the data for.
metadataChange - The set of changes to apply to the metadata for the snapshot. Use - EMPTY_CHANGE to preserve the existing metadata.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.DeleteSnapshotResult> - - delete - (GoogleApiClient apiClient, SnapshotMetadata metadata) -

-
-
- - - -
-
- - - - -

Delete the specified snapshot. This will delete the data of the snapshot locally and on the - server. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
metadata - The metadata of the snapshot to delete.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - void - - discardAndClose - (GoogleApiClient apiClient, Snapshot snapshot) -

-
-
- - - -
-
- - - - -

Discard the contents of the snapshot and close the contents. This will discard all changes - made to the file, and close the snapshot to future changes until it is re-opened. The file - will not be modified on the server. -

- Calling this method with a snapshot that has already been committed or that was not opened - via open(GoogleApiClient, SnapshotMetadata) will throw an exception. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
snapshot - The snapshot to discard the data for. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMaxCoverImageSize - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum data size per snapshot cover image in bytes. Guaranteed to be at least 800 - KB. May increase in the future. -

- If the service cannot be reached for some reason, this will return -1. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum data size per snapshot cover image in bytes. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getMaxDataSize - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Gets the maximum data size per snapshot in bytes. Guaranteed to be at least 3 MB. May - increase in the future. -

- If the service cannot be reached for some reason, this will return -1. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • The maximum data size per snapshot in bytes. -
-
- -
-
- - - - -
-

- - public - - - abstract - - Intent - - getSelectSnapshotIntent - (GoogleApiClient apiClient, String title, boolean allowAddButton, boolean allowDelete, int maxSnapshots) -

-
-
- - - -
-
- - - - -

Returns an intent that will let the user select a snapshot. Note that this must be invoked - using startActivityForResult(Intent, int) so that the identity of the - calling package can be established. -

- If the user canceled without selecting a snapshot, the result will be - RESULT_CANCELED. If the user selected a snapshot from the list, the result - will be RESULT_OK and the data intent will contain the selected Snapshot as - a parcelable object in EXTRA_SNAPSHOT_METADATA. If the user pressed the add button, - the result will be RESULT_OK and the data intent will contain a true boolean - value in EXTRA_SNAPSHOT_NEW. -

- Note that if you have modified an open snapshot, the changes will not appear in this UI until - you call commitAndClose(GoogleApiClient, Snapshot, SnapshotMetadataChange) on the snapshot. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
title - The title to display in the action bar of the returned Activity.
allowAddButton - Whether or not to display a "create new snapshot" option in the - selection UI.
allowDelete - Whether or not to provide a delete overflow menu option for each snapshot - in the selection UI.
maxSnapshots - The maximum number of snapshots to display in the UI. Use - DISPLAY_LIMIT_NONE to display all snapshots.
-
-
-
Returns
-
  • An Intent that can be started to view the select snapshot UI. -
-
- -
-
- - - - -
-

- - public - - - abstract - - SnapshotMetadata - - getSnapshotFromBundle - (Bundle extras) -

-
-
- - - -
-
- - - - -

This method takes a Bundle object and extracts the Snapshot provided. If the - Bundle is invalid or does not contain the correct data, this method returns null.

-
-
Parameters
- - - - -
extras - The Bundle to parse for a Snapshot object.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.LoadSnapshotsResult> - - load - (GoogleApiClient apiClient, boolean forceReload) -

-
-
- - - -
-
- - - - -

Asynchronously load the snapshot data for the currently signed-in player. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
forceReload - If true, this call will clear any locally cached data and attempt to fetch - the latest data from the server. This would commonly be used for something like a - user-initiated refresh. Normally, this should be set to false to gain advantages - of data caching.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - open - (GoogleApiClient apiClient, String fileName, boolean createIfNotFound) -

-
-
- - - -
-
- - - - -

Open a snapshot with the given name. If createIfNotFound is set to true, the - specified snapshot will be created if it does not already exist. -

- This will open the snapshot using RESOLUTION_POLICY_MANUAL as a conflict policy. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
fileName - The name of the snapshot file to open. Must be between 1 and 100 - non-URL-reserved characters (a-z, A-Z, 0-9, or the symbols "-", ".", "_", or "~").
createIfNotFound - If true, the snapshot will be created if one cannot be found.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - open - (GoogleApiClient apiClient, String fileName, boolean createIfNotFound, int conflictPolicy) -

-
-
- - - -
-
- - - - -

Open a snapshot with the given name. If createIfNotFound is set to true, the - specified snapshot will be created if it does not already exist. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
fileName - The name of the snapshot file to open. Must be between 1 and 100 - non-URL-reserved characters (a-z, A-Z, 0-9, or the symbols "-", ".", "_", or "~").
createIfNotFound - If true, the snapshot will be created if one cannot be found.
conflictPolicy - The conflict resolution policy to use for this snapshot.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - open - (GoogleApiClient apiClient, SnapshotMetadata metadata) -

-
-
- - - -
-
- - - - -

Open a snapshot with the given metadata (usually returned from - load(GoogleApiClient, boolean). To succeed, the snapshot must exist; i.e. this call - will fail if the snapshot was deleted between the load and open calls. -

- This will open the snapshot using RESOLUTION_POLICY_MANUAL as a conflict policy. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to service the call.
metadata - The metadata of the existing snapshot to load.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - open - (GoogleApiClient apiClient, SnapshotMetadata metadata, int conflictPolicy) -

-
-
- - - -
-
- - - - -

Open a snapshot with the given metadata (usually returned from - load(GoogleApiClient, boolean). To succeed, the snapshot must exist; i.e. this call - will fail if the snapshot was deleted between the load and open calls. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
metadata - The metadata of the existing snapshot to load.
conflictPolicy - The conflict resolution policy to use for this snapshot.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - resolveConflict - (GoogleApiClient apiClient, String conflictId, String snapshotId, SnapshotMetadataChange metadataChange, SnapshotContents snapshotContents) -

-
-
- - - -
-
- - - - -

Resolve a conflict using the provided data. This will replace the data on the server with the - specified metadata changes and contents. Note that it is possible for this operation to - result in a conflict itself, in which case resolution should be repeated. -

- Values which are not included in the metadata change will be resolved to the version - currently on the server. -

- Note that the total size of contents may not exceed the size provided by - getMaxDataSize(GoogleApiClient). -

- Calling this method with a snapshot that has already been committed or that was not opened - via open(GoogleApiClient, SnapshotMetadata) will throw an exception. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
conflictId - The ID of the conflict to resolve. Must come from - getConflictId().
snapshotId - The ID of the snapshot to resolve the conflict for.
metadataChange - The set of changes to apply to the metadata for the snapshot.
snapshotContents - The SnapshotContents to replace the snapshot data with.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Snapshots.OpenSnapshotResult> - - resolveConflict - (GoogleApiClient apiClient, String conflictId, Snapshot snapshot) -

-
-
- - - -
-
- - - - -

Resolve a conflict using the data from the provided snapshot. This will replace the data on - the server with the specified snapshot. Note that it is possible for this operation to result - in a conflict itself, in which case resolution should be repeated. -

- Note that the total size of the contents of snapshot may not exceed the size provided - by getMaxDataSize(GoogleApiClient). -

- Calling this method with a snapshot that has already been committed or that was not opened - via open(GoogleApiClient, SnapshotMetadata) will throw an exception. -

- Required API: API
- Required Scopes: SCOPE_GAMES and SCOPE_APPFOLDER.

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to service the call.
conflictId - The ID of the conflict to resolve. Must come from - getConflictId().
snapshot - The snapshot to use to resolve the conflict.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/games/snapshot/package-summary.html b/docs/html/reference/com/google/android/gms/games/snapshot/package-summary.html deleted file mode 100644 index 96cfdceaf839..000000000000 --- a/docs/html/reference/com/google/android/gms/games/snapshot/package-summary.html +++ /dev/null @@ -1,1033 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.games.snapshot | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.games.snapshot

-
- -
- -
- - -
- Contains data classes for snapshot functionality. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Snapshot - Data interface for a representation of a saved game.  - - - -
SnapshotContents - Data interface for a representation of Snapshot contents.  - - - -
SnapshotMetadata - Data interface for the metadata of a saved game.  - - - -
Snapshots - The Snapshots API allows you to store data representing the player's game progress on Google's - servers.  - - - -
Snapshots.CommitSnapshotResult - Result delivered when a snapshot has been committed.  - - - -
Snapshots.DeleteSnapshotResult - Result delivered when a snapshot has been deleted.  - - - -
Snapshots.LoadSnapshotsResult - Result delivered when snapshot data has been loaded.  - - - -
Snapshots.OpenSnapshotResult - Result delivered when a snapshot has been opened.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SnapshotEntity - Data object representing the data for a saved game.  - - - -
SnapshotMetadataBuffer - Data structure providing access to a list of snapshots.  - - - -
SnapshotMetadataChange - A collection of changes to apply to the metadata of a snapshot.  - - - -
SnapshotMetadataChange.Builder - Builder for SnapshotMetadataChange objects.  - - - -
SnapshotMetadataEntity - Data object representing the metadata for a saved game.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html b/docs/html/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html deleted file mode 100644 index 1375b91b4807..000000000000 --- a/docs/html/reference/com/google/android/gms/gcm/GoogleCloudMessaging.html +++ /dev/null @@ -1,2302 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleCloudMessaging | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GoogleCloudMessaging

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.gcm.GoogleCloudMessaging
- - - - - - - -
- - -

Class Overview

-

The class you use to write a GCM-enabled client application that runs on an Android device. - Client applications can receive and send messages to the server. - -

This class requires Google Play services version 3.1 or higher. For a - detailed discussion of how to write a GCM client app, see - - Implementing GCM Client. - -

To send or receive messages, your application first needs to get a registration ID. The - registration ID identifies the device and application, and also determines which 3rd-party - application servers are allowed to send messages to this application instance. - -

To get a registration ID, you must supply one or more sender IDs. A sender ID is a project - number you acquire from the API console, as described in - Getting Started. The sender ID is - used in the registration process to identify a 3rd-party application server that is permitted to - send messages to the device. The following snippet shows you how to call the - register() method. For a more comprehensive example, see - Implementing GCM Client. - - 

- String SENDER_ID = "My-Sender-ID";
- GoogleCloudMessaging gcm = GoogleCloudMessaging.getInstance(context);
- String registrationId = gcm.register(SENDER_ID);
- // Upload the registration ID to your own server
-
- -

In order to receive GCM messages, you need to declare a permission and a - BroadcastReceiver in your manifest. This is a backward-compatible subset of what was - required in previous versions of GCM. - -

To allow the application to use GCM, add this permission to the manifest: - - 

<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
- -

GCM delivers messages as a broadcast. The receivers must be registered in the manifest in - order to wake up the application. - -

The com.google.android.c2dm.permission.SEND permission is held by Google Play - services. This prevents other code from invoking the broadcast receiver. Here is an excerpt - from a sample manifest: - - 

- <receiver android:name=".MyReceiver" android:exported="true"
-     android:permission="com.google.android.c2dm.permission.SEND" >
-     <intent-filter>
-        <action android:name="com.google.android.c2dm.intent.RECEIVE" />
-        <category android:name="YOUR_PACKAGE_NAME" />
-     </intent-filter>
- </receiver>
- -

When a GCM connection server delivers the message to your client app, the - BroadcastReceiver receives the message as an intent. You can either process the - intent in the BroadcastReceiver, or you can pass off the work of processing the - intent to a service (typically, an IntentService). If you use a service, your - broadcast receiver should be an instance of WakefulBroadcastReceiver, to hold a - wake lock while the service is doing its work. - -

When processing the intent GCM passes into your app's broadcast receiver, you can determine - the message type by calling getMessageType(intent). For example: - - 

- GoogleCloudMessaging gcm = GoogleCloudMessaging.getInstance(this);
- String messageType = gcm.getMessageType(intent);
- ...
- // Filter messages based on message type. It is likely that GCM will be extended in the future
- // with new message types, so just ignore message types you're not interested in, or that you
- // don't recognize.
- if (GoogleCloudMessaging.MESSAGE_TYPE_SEND_ERROR.equals(messageType)) {
-    // It's an error.
- } else if (GoogleCloudMessaging.MESSAGE_TYPE_DELETED.equals(messageType)) {
-    // Deleted messages on the server.
- } else if (GoogleCloudMessaging.MESSAGE_TYPE_MESSAGE.equals(messageType)) {
-    // It's a regular GCM message, do some work.
- }
-
- -

If you are using the XMPP-based - Cloud Connection Server, your - client app can send upstream messages back to the server. For example: - - 

- gcm.send(SENDER_ID + "@gcm.googleapis.com", id, data);
-
- - For a more details, see - Implementing GCM Client. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringERROR_MAIN_THREAD - The GCM register() and unregister() methods are - blocking. - - - -
StringERROR_SERVICE_NOT_AVAILABLE - The device can't read the response, or there was a 500/503 from the - server that can be retried later. - - - -
StringMESSAGE_TYPE_DELETED - Returned by getMessageType(Intent) to indicate that the server deleted - some pending messages because they exceeded the storage limits. - - - -
StringMESSAGE_TYPE_MESSAGE - Returned by getMessageType(Intent) to indicate a regular message. - - - -
StringMESSAGE_TYPE_SEND_ERROR - Returned by getMessageType(Intent) to indicate a send error. - - - -
StringMESSAGE_TYPE_SEND_EVENT - Returned by getMessageType(Intent) to indicate a sent message has been received by the GCM - server. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GoogleCloudMessaging() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - close() - -
- Must be called when your application is done using GCM, to release - internal resources. - - - -
- -
- - synchronized - - static - - GoogleCloudMessaging - - getInstance(Context context) - -
- Return the singleton instance of GCM. - - - -
- -
- - - - - - String - - getMessageType(Intent intent) - -
- Return the message type from an intent passed into a client app's broadcast receiver. - - - -
- -
- - synchronized - - - - String - - register(String... senderIds) - -
- Register the application for GCM and return the registration ID. - - - -
- -
- - - - - - void - - send(String to, String msgId, long timeToLive, Bundle data) - -
- Send an upstream ("device to cloud") message. - - - -
- -
- - - - - - void - - send(String to, String msgId, Bundle data) - -
- Send an upstream ("device to cloud") message. - - - -
- -
- - synchronized - - - - void - - unregister() - -
- Unregister the application. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ERROR_MAIN_THREAD -

-
- - - - -
-
- - - - -

The GCM register() and unregister() methods are - blocking. You should not run them in the main thread or in broadcast receivers. -

- - -
- Constant Value: - - - "MAIN_THREAD" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - ERROR_SERVICE_NOT_AVAILABLE -

-
- - - - -
-
- - - - -

The device can't read the response, or there was a 500/503 from the - server that can be retried later. The application should use exponential - back off and retry. -

- - -
- Constant Value: - - - "SERVICE_NOT_AVAILABLE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MESSAGE_TYPE_DELETED -

-
- - - - -
-
- - - - -

Returned by getMessageType(Intent) to indicate that the server deleted - some pending messages because they exceeded the storage limits. The - application should contact the server to retrieve the discarded messages. -

- - -
- Constant Value: - - - "deleted_messages" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MESSAGE_TYPE_MESSAGE -

-
- - - - -
-
- - - - -

Returned by getMessageType(Intent) to indicate a regular message. -

- - -
- Constant Value: - - - "gcm" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MESSAGE_TYPE_SEND_ERROR -

-
- - - - -
-
- - - - -

Returned by getMessageType(Intent) to indicate a send error. - The intent includes the message ID of the message and an error code. -

- - -
- Constant Value: - - - "send_error" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - MESSAGE_TYPE_SEND_EVENT -

-
- - - - -
-
- - - - -

Returned by getMessageType(Intent) to indicate a sent message has been received by the GCM - server. The intent includes the message ID of the message. -

- - -
- Constant Value: - - - "send_event" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GoogleCloudMessaging - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - close - () -

-
-
- - - -
-
- - - - -

Must be called when your application is done using GCM, to release - internal resources. -

- -
-
- - - - -
-

- - public - static - - - synchronized - GoogleCloudMessaging - - getInstance - (Context context) -

-
-
- - - -
-
- - - - -

Return the singleton instance of GCM.

- -
-
- - - - -
-

- - public - - - - - String - - getMessageType - (Intent intent) -

-
-
- - - -
-
- - - - -

Return the message type from an intent passed into a client app's broadcast receiver. There - are two general categories of messages passed from the server: regular GCM messages, - and special GCM status messages. - - The possible types are: -

    -
  • MESSAGE_TYPE_MESSAGE—regular message from your server. -
  • MESSAGE_TYPE_DELETED—special status message indicating that some - messages have been discarded because they exceeded the storage limits. -
  • MESSAGE_TYPE_SEND_ERROR—special status message indicating that - there were errors sending one of the messages. -
- - You can use this method to filter based on message type. Since it is likely that GCM will - be extended in the future with new message types, just ignore any message types you're not - interested in, or that you don't recognize.

-
-
Returns
-
  • The message type or null if the intent is not a GCM intent -
-
- -
-
- - - - -
-

- - public - - - - synchronized - String - - register - (String... senderIds) -

-
-
- - - -
-
- - - - -

Register the application for GCM and return the registration ID. You must call this once, - when your application is installed, and send the returned registration ID to the server. -

- Repeated calls to this method will return the original registration ID. -

- If you want to modify the list of senders, you must call unregister() first. -

- Most applications use a single sender ID. You may use multiple senders if different - servers may send messages to the app or for testing.

-
-
Parameters
- - - - -
senderIds - list of project numbers or Google accounts identifying who is allowed to - send messages to this application.
-
-
-
Returns
-
  • registration id -
-
-
-
Throws
- - - - -
IOException -
-
- -
-
- - - - -
-

- - public - - - - - void - - send - (String to, String msgId, long timeToLive, Bundle data) -

-
-
- - - -
-
- - - - -

Send an upstream ("device to cloud") message. You can only use the upstream feature - if your GCM implementation uses the XMPP-based - Cloud Connection Server. - - The current limits for max storage time and number of outstanding messages per - application are documented in the - GCM Developers Guide.

-
-
Parameters
- - - - - - - - - - - - - -
to - string identifying the receiver of the message in the format of - SENDER_ID@gcm.googleapis.com. The SENDER_ID should be one of the sender - IDs used in register().
msgId - ID of the message. This is generated by the application. It must be - unique for each message. This allows error callbacks and debugging.
timeToLive - If 0, we'll attempt to send immediately and return an - error if we're not connected. Otherwise, the message will be queued. - As for server-side messages, we don't return an error if the message has been - dropped because of TTL—this can happen on the server side, and it would require - extra communication.
data - key/value pairs to be sent. Values must be String, any other type will - be ignored.
-
-
-
Throws
- - - - - - - -
IllegalArgumentException -
IOException -
-
- -
-
- - - - -
-

- - public - - - - - void - - send - (String to, String msgId, Bundle data) -

-
-
- - - -
-
- - - - -

Send an upstream ("device to cloud") message. You can only use the upstream feature - if your GCM implementation uses the XMPP-based - Cloud Connection Server. - - When there is an active connection the message will be sent immediately, otherwise the - message will be queued for the maximum interval.

-
-
Parameters
- - - - - - - - - - -
to - string identifying the receiver of the message in the format of - SENDER_ID@gcm.googleapis.com. The SENDER_ID should be one of the sender - IDs used in register().
msgId - ID of the message. This is generated by the application. It must be - unique for each message. This allows error callbacks and debugging.
data - key/value pairs to be sent. Values must be String—any other type will - be ignored.
-
-
-
Throws
- - - - - - - -
- IllegalArgumentException
IOException -
-
- -
-
- - - - -
-

- - public - - - - synchronized - void - - unregister - () -

-
-
- - - -
-
- - - - -

Unregister the application. Calling unregister() stops any - messages from the server. This is a blocking call—you shouldn't call - it from the UI thread. - - You should rarely (if ever) need to call this method. Not only is it - expensive in terms of resources, but it invalidates all your registration IDs - returned from register() or subscribe(). This should not be done - unnecessarily. A better approach is to simply have your server stop - sending messages. Only use unregister if you want to change your sender ID.

-
-
Throws
- - - - -
IOException - if we can't connect to server to unregister. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/gcm/package-summary.html b/docs/html/reference/com/google/android/gms/gcm/package-summary.html deleted file mode 100644 index ff21c452f793..000000000000 --- a/docs/html/reference/com/google/android/gms/gcm/package-summary.html +++ /dev/null @@ -1,885 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.gcm | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.gcm

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - -
GoogleCloudMessaging -

The class you use to write a GCM-enabled client application that runs on an Android device.  - - - -

- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/Address.AddressOptions.html b/docs/html/reference/com/google/android/gms/identity/intents/Address.AddressOptions.html deleted file mode 100644 index 166d6897ab31..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/Address.AddressOptions.html +++ /dev/null @@ -1,1459 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Address.AddressOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Address.AddressOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.HasOptions - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.Address.AddressOptions
- - - - - - - -
- - -

Class Overview

-

A class that encapsulates options for the Address APIs. Currently this is just the theme of - any UI elements the user interacts with. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - inttheme - Theme to use for system UI elements that the user will interact with. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Address.AddressOptions() - -
- Uses the default theme THEME_DARK. - - - -
- -
- - - - - - - - Address.AddressOptions(int theme) - -
- Constructor that accepts a theme to use. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - int - - theme -

-
- - - - -
-
- - - - -

Theme to use for system UI elements that the user will interact with. See - AddressConstants.Themes for allowed values. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Address.AddressOptions - () -

-
-
- - - -
-
- - - - -

Uses the default theme THEME_DARK. -

- -
-
- - - - -
-

- - public - - - - - - - Address.AddressOptions - (int theme) -

-
-
- - - -
-
- - - - -

Constructor that accepts a theme to use. See AddressConstants.Themes for - allowed values. -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/Address.html b/docs/html/reference/com/google/android/gms/identity/intents/Address.html deleted file mode 100644 index b97095a91f3d..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/Address.html +++ /dev/null @@ -1,1513 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Address | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Address

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.Address
- - - - - - - -
- - -

Class Overview

-

APIs for accessing a user's address. Calling requestUserAddress(GoogleApiClient, UserAddressRequest, int) will prompt the - user to select an address to share with your application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classAddress.AddressOptions - A class that encapsulates options for the Address APIs.  - - - -
- - - - - - - - - - - -
Fields
- public - static - final - Api<Address.AddressOptions>API - Add this to your GoogleApiClient via addApi(Api). - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Address() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - void - - requestUserAddress(GoogleApiClient googleApiClient, UserAddressRequest request, int requestCode) - -
- API to request an address from a user. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Address.AddressOptions> - - API -

-
- - - - -
-
- - - - -

Add this to your GoogleApiClient via addApi(Api). -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Address - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - requestUserAddress - (GoogleApiClient googleApiClient, UserAddressRequest request, int requestCode) -

-
-
- - - -
-
- - - - -

API to request an address from a user. This will invoke a dialog that allows the user to - decide if they want to select a single address to share your app, or alternatively decline - to share an address at all. The response to this request is supplied via your Activity's - onActivityResult(int, int, Intent) callback method. -

-
-
Parameters
- - - - - - - - - - -
googleApiClient - used to communicate with Google Play Services. This should be - configured to use API. Must not be null.
request - used to specify what kind of addresses your app can handle. You - must pass in a valid UserAddressRequest created via - build().
requestCode - used onActivityResult(int, int, Intent) to identify which request - triggered that callback. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ErrorCodes.html b/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ErrorCodes.html deleted file mode 100644 index 9052c6aee64c..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ErrorCodes.html +++ /dev/null @@ -1,1061 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddressConstants.ErrorCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AddressConstants.ErrorCodes

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.identity.intents.AddressConstants.ErrorCodes
- - - - - - - -
- - -

Class Overview

-

Error codes that could be returned in the data Intent returned to your Activity via its - onActivityResult method. These are retrieved using EXTRA_ERROR_CODE. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intERROR_CODE_NO_APPLICABLE_ADDRESSES - Error code returned if the user has no addresses that can be used. - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ERROR_CODE_NO_APPLICABLE_ADDRESSES -

-
- - - - -
-
- - - - -

Error code returned if the user has no addresses that can be used. -

- - -
- Constant Value: - - - 555 - (0x0000022b) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Extras.html b/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Extras.html deleted file mode 100644 index 2444b71932b1..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Extras.html +++ /dev/null @@ -1,1119 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddressConstants.Extras | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AddressConstants.Extras

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.identity.intents.AddressConstants.Extras
- - - - - - - -
- - -

Class Overview

-

Keys for Intent extras. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_ADDRESS - The key for retrieving a - UserAddress returned to your - Activity's onActivityResult method after calling requestUserAddress(GoogleApiClient, UserAddressRequest, int). - - - -
StringEXTRA_ERROR_CODE - The key for retrieving an error code returned to your Activity's onActivityResult method - after calling requestUserAddress(GoogleApiClient, UserAddressRequest, int). - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_ADDRESS -

-
- - - - -
-
- - - - -

The key for retrieving a - UserAddress returned to your - Activity's onActivityResult method after calling requestUserAddress(GoogleApiClient, UserAddressRequest, int). -

- - -
- Constant Value: - - - "com.google.android.gms.identity.intents.EXTRA_ADDRESS" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ERROR_CODE -

-
- - - - -
-
- - - - -

The key for retrieving an error code returned to your Activity's onActivityResult method - after calling requestUserAddress(GoogleApiClient, UserAddressRequest, int). See AddressConstants.ErrorCodes for possible - values. -

- - -
- Constant Value: - - - "com.google.android.gms.identity.intents.EXTRA_ERROR_CODE" - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ResultCodes.html b/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ResultCodes.html deleted file mode 100644 index f5905c352974..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.ResultCodes.html +++ /dev/null @@ -1,1063 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddressConstants.ResultCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AddressConstants.ResultCodes

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.identity.intents.AddressConstants.ResultCodes
- - - - - - - -
- - -

Class Overview

-

Custom result codes that can be returned to your Activity's onActivityResult method after - you call requestUserAddress(GoogleApiClient, UserAddressRequest, int). Note that the standard result codes of - Activity.RESULT_OK and Activity.RESULT_CANCELLED can also be returned in addition to these - custom ones. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intRESULT_ERROR - Result code returned if an error occurs while processing your request. - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESULT_ERROR -

-
- - - - -
-
- - - - -

Result code returned if an error occurs while processing your request. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Themes.html b/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Themes.html deleted file mode 100644 index 27cc89c50a6b..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.Themes.html +++ /dev/null @@ -1,1239 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddressConstants.Themes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AddressConstants.Themes

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.identity.intents.AddressConstants.Themes
- - - - - - - -
- - -

Class Overview

-

System themes that can be used to customize the UI elements shown when you call - requestUserAddress(GoogleApiClient, UserAddressRequest, int). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTHEME_DARK - Use the dark system theme - - - - -
intTHEME_HOLO_DARK - - This constant is deprecated. - use THEME_DARK - - - - -
intTHEME_HOLO_LIGHT - - This constant is deprecated. - use THEME_LIGHT - - - - -
intTHEME_LIGHT - Use the light system theme - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - THEME_DARK -

-
- - - - -
-
- - - - -

Use the dark system theme -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_HOLO_DARK -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- use THEME_DARK - -

-

Use the dark system theme

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_HOLO_LIGHT -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- use THEME_LIGHT - -

-

Use the light system theme

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_LIGHT -

-
- - - - -
-
- - - - -

Use the light system theme -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.html b/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.html deleted file mode 100644 index d3afe6f6c715..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/AddressConstants.html +++ /dev/null @@ -1,1069 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddressConstants | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

AddressConstants

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.identity.intents.AddressConstants
- - - - - - - -
- - -

Class Overview

-

Constants used for Address APIs. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.Builder.html b/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.Builder.html deleted file mode 100644 index 4a0accf8da41..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.Builder.html +++ /dev/null @@ -1,1431 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserAddressRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

UserAddressRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
-
Nested Classes
- - - - - interfaceAddressConstants.ErrorCodes - Error codes that could be returned in the data Intent returned to your Activity via its - onActivityResult method.  - - - -
- - - - - interfaceAddressConstants.Extras - Keys for Intent extras.  - - - -
- - - - - interfaceAddressConstants.ResultCodes - Custom result codes that can be returned to your Activity's onActivityResult method after - you call requestUserAddress(GoogleApiClient, UserAddressRequest, int).  - - - -
- - - - - interfaceAddressConstants.Themes - System themes that can be used to customize the UI elements shown when you call - requestUserAddress(GoogleApiClient, UserAddressRequest, int).  - - - -
- - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.UserAddressRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder for creating a UserAddressRequest. This class lets your create an instance - of UserAddressRequest that specifies a set of countries for restricting the choice of - addresses by the user, i.e. the user can only select an address if it's in one of the - specified countries. If no countries are specified, then there are no restrictions and the - user can select any of their addresses to share with your app. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - UserAddressRequest.Builder - - addAllowedCountrySpecification(CountrySpecification countrySpecification) - -
- Specifies a country whose addresses can be handled by your app. - - - -
- -
- - - - - - UserAddressRequest.Builder - - addAllowedCountrySpecifications(Collection<CountrySpecification> countrySpecifications) - -
- Specifies multiple countries whose addresses can be handled by your app. - - - -
- -
- - - - - - UserAddressRequest - - build() - -
- Builds an instance of UserAddressRequest and returns it. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - UserAddressRequest.Builder - - addAllowedCountrySpecification - (CountrySpecification countrySpecification) -

-
-
- - - -
-
- - - - -

Specifies a country whose addresses can be handled by your app. Note that calling this - after you have called build() will cause a runtime exception to be thrown. -

- -
-
- - - - -
-

- - public - - - - - UserAddressRequest.Builder - - addAllowedCountrySpecifications - (Collection<CountrySpecification> countrySpecifications) -

-
-
- - - -
-
- - - - -

Specifies multiple countries whose addresses can be handled by your app. Note that - calling this after you have called build() will cause a runtime - exception to be thrown. -

- -
-
- - - - -
-

- - public - - - - - UserAddressRequest - - build - () -

-
-
- - - -
-
- - - - -

Builds an instance of UserAddressRequest and returns it. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.html b/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.html deleted file mode 100644 index d876c77d3e79..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/UserAddressRequest.html +++ /dev/null @@ -1,1678 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserAddressRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

UserAddressRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.UserAddressRequest
- - - - - - - -
- - -

Class Overview

-

Object that encapsulates a request to requestUserAddress(GoogleApiClient, UserAddressRequest, int). If your app only - allows addresses in certain countries, then you can use this object to specify these countries - and the API will only return an address if it is an applicable country. If you do not specify - any countries, then it will be assumed that there are no restrictions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classUserAddressRequest.Builder - Builder for creating a UserAddressRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<UserAddressRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - int - - getVersionCode() - -
- - - - static - - UserAddressRequest.Builder - - newBuilder() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<UserAddressRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - UserAddressRequest.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/model/CountrySpecification.html b/docs/html/reference/com/google/android/gms/identity/intents/model/CountrySpecification.html deleted file mode 100644 index 2001e28a0b61..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/model/CountrySpecification.html +++ /dev/null @@ -1,1739 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CountrySpecification | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CountrySpecification

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.model.CountrySpecification
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a country. Used for restricting which addresses a user can choose to - share. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<CountrySpecification>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CountrySpecification(String countryCode) - -
- Constructs a country specification based on a country code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getCountryCode() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<CountrySpecification> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CountrySpecification - (String countryCode) -

-
-
- - - -
-
- - - - -

Constructs a country specification based on a country code. - - Country code should follow the ISO 3166-2 format (ex: "US", "CA", "JP").

-
-
Parameters
- - - - -
countryCode - an ISO 3166-2 formatted country code -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCountryCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the 2-letter ISO 3166-2 country code (ex: "US" or "CA"). -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/model/UserAddress.html b/docs/html/reference/com/google/android/gms/identity/intents/model/UserAddress.html deleted file mode 100644 index 4e8a9113578c..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/model/UserAddress.html +++ /dev/null @@ -1,2442 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UserAddress | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

UserAddress

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.identity.intents.model.UserAddress
- - - - - - - -
- - -

Class Overview

-

Parcelable representing an address. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<UserAddress>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - static - - UserAddress - - fromIntent(Intent data) - -
- - - - - - String - - getAddress1() - -
- - - - - - String - - getAddress2() - -
- - - - - - String - - getAddress3() - -
- - - - - - String - - getAddress4() - -
- - - - - - String - - getAddress5() - -
- - - - - - String - - getAdministrativeArea() - -
- - - - - - String - - getCompanyName() - -
- - - - - - String - - getCountryCode() - -
- - - - - - String - - getEmailAddress() - -
- - - - - - String - - getLocality() - -
- - - - - - String - - getName() - -
- - - - - - String - - getPhoneNumber() - -
- - - - - - String - - getPostalCode() - -
- - - - - - String - - getSortingCode() - -
- - - - - - int - - getVersionCode() - -
- - - - - - boolean - - isPostBox() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<UserAddress> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - UserAddress - - fromIntent - (Intent data) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAddress1 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The first line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress2 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The second line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress3 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The third line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress4 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The fourth line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress5 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The fifth line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAdministrativeArea - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The state, province, etc. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCompanyName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The company name of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCountryCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The 2-letter ISO-3166 country code. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEmailAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The email address used with this address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getLocality - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The city, town, etc. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Name of the person at this address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPhoneNumber - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The phone number associated to the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPostalCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The postal, zip code, etc. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSortingCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The sorting code. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isPostBox - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether the address is a post box or not. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/model/package-summary.html b/docs/html/reference/com/google/android/gms/identity/intents/model/package-summary.html deleted file mode 100644 index 849c64f4c529..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/model/package-summary.html +++ /dev/null @@ -1,896 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.identity.intents.model | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.identity.intents.model

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - -
CountrySpecification - Parcelable representing a country.  - - - -
UserAddress - Parcelable representing an address.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/identity/intents/package-summary.html b/docs/html/reference/com/google/android/gms/identity/intents/package-summary.html deleted file mode 100644 index 6baa893868ca..000000000000 --- a/docs/html/reference/com/google/android/gms/identity/intents/package-summary.html +++ /dev/null @@ -1,986 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.identity.intents | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.identity.intents

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AddressConstants - Constants used for Address APIs.  - - - -
AddressConstants.ErrorCodes - Error codes that could be returned in the data Intent returned to your Activity via its - onActivityResult method.  - - - -
AddressConstants.Extras - Keys for Intent extras.  - - - -
AddressConstants.ResultCodes - Custom result codes that can be returned to your Activity's onActivityResult method after - you call requestUserAddress(GoogleApiClient, UserAddressRequest, int).  - - - -
AddressConstants.Themes - System themes that can be used to customize the UI elements shown when you call - requestUserAddress(GoogleApiClient, UserAddressRequest, int).  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Address - APIs for accessing a user's address.  - - - -
Address.AddressOptions - A class that encapsulates options for the Address APIs.  - - - -
UserAddressRequest - Object that encapsulates a request to requestUserAddress(GoogleApiClient, UserAddressRequest, int).  - - - -
UserAddressRequest.Builder - Builder for creating a UserAddressRequest.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/ActivityRecognition.html b/docs/html/reference/com/google/android/gms/location/ActivityRecognition.html deleted file mode 100644 index 4943dd00536d..000000000000 --- a/docs/html/reference/com/google/android/gms/location/ActivityRecognition.html +++ /dev/null @@ -1,1425 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ActivityRecognition | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ActivityRecognition

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.ActivityRecognition
- - - - - - - -
- - -

Class Overview

-

The main entry point for activity recognition integration. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringCLIENT_NAME - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Token to pass to addApi(Api) to enable ContextServices. - - - -
- public - static - - ActivityRecognitionApiActivityRecognitionApi - Entry point to the activity recognition APIs. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - CLIENT_NAME -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - "activity_recognition" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable ContextServices. -

- - -
-
- - - - - -
-

- - public - static - - ActivityRecognitionApi - - ActivityRecognitionApi -

-
- - - - -
-
- - - - -

Entry point to the activity recognition APIs. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/ActivityRecognitionApi.html b/docs/html/reference/com/google/android/gms/location/ActivityRecognitionApi.html deleted file mode 100644 index 22061db8d460..000000000000 --- a/docs/html/reference/com/google/android/gms/location/ActivityRecognitionApi.html +++ /dev/null @@ -1,1232 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ActivityRecognitionApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

ActivityRecognitionApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.ActivityRecognitionApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with activity recognition. - -

The methods must be used in conjunction with a GoogleApiClient. E.g. - 


-     new GoogleApiClient.Builder(context)
-             .addApi(ActivityRecognition.API)
-             .addConnectionCallbacks(this)
-             .addOnConnectionFailedListener(this)
-             .build()
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - removeActivityUpdates(GoogleApiClient client, PendingIntent callbackIntent) - -
- Removes all activity updates for the specified PendingIntent. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestActivityUpdates(GoogleApiClient client, long detectionIntervalMillis, PendingIntent callbackIntent) - -
- Register for activity recognition updates. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeActivityUpdates - (GoogleApiClient client, PendingIntent callbackIntent) -

-
-
- - - -
-
- - - - -

Removes all activity updates for the specified PendingIntent. -

- Calling this function requires the - com.google.android.gms.permission.ACTIVITY_RECOGNITION permission.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the - time of this call, which is normally achieved by calling - connect() and waiting for - onConnected(Bundle) to - be called.
callbackIntent - the PendingIntent that was used in - requestActivityUpdates(GoogleApiClient, long, PendingIntent) - or is equal as defined by equals(Object).
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to - determine if it was successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestActivityUpdates - (GoogleApiClient client, long detectionIntervalMillis, PendingIntent callbackIntent) -

-
-
- - - -
-
- - - - -

Register for activity recognition updates. -

- The activities are detected by periodically waking up the device and - reading short bursts of sensor data. It only makes use of low power - sensors in order to keep the power usage to a minimum. For example, it - can detect if the user is currently on foot, in a car, on a bicycle or - still. See DetectedActivity for more details. -

- The activity detection update interval can be controlled with the - detectionIntervalMillis parameter. Larger values will result in fewer - activity detections while improving battery life. Smaller values will - result in more frequent activity detections but will consume more power - since the device must be woken up more frequently. -

- Activities may be received more frequently than the - detectionIntervalMillis parameter if another application has also - requested activity updates at a faster rate. It may also receive updates - faster when the activity detection service receives a signal that the - current activity may change, such as if the device has been still for a - long period of time and is then unplugged from a phone charger. -

- Activities may arrive several seconds after the requested - detectionIntervalMillis if the activity detection service requires more - samples to make a more accurate prediction. -

- To conserve battery, activity reporting may stop when the device is - 'STILL' for an extended period of time. It will resume once the device - moves again. This only happens on devices that support the - Sensor.TYPE_SIGNIFICANT_MOTION hardware. -

- Beginning in API 21, activities may be received less frequently than the - detectionIntervalMillis parameter if the device is in power save mode - and the screen is off. -

- A common use case is that an application wants to monitor activities in - the background and perform an action when a specific activity is - detected. To do this without needing a service that is always on in the - background consuming resources, detected activities are delivered via an - intent. The application specifies a PendingIntent callback (typically an - IntentService) which will be called with an intent when activities are - detected. The intent recipient can extract the - ActivityRecognitionResult using - extractResult(android.content.Intent). - See the documentation of PendingIntent for more - details. -

- Any requests previously registered with requestActivityUpdates(GoogleApiClient, long, PendingIntent) that have the same - PendingIntent (as defined by equals(Object)) will be replaced by this request. -

- Calling this function requires the - com.google.android.gms.permission.ACTIVITY_RECOGNITION permission.

-
-
Parameters
- - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the - time of this call, which is normally achieved by calling - connect() and waiting for - onConnected(Bundle) to - be called.
detectionIntervalMillis - the desired time between activity - detections. Larger values will result in fewer activity - detections while improving battery life. A value of 0 will - result in activity detections at the fastest possible rate.
callbackIntent - a PendingIntent to be sent for each activity - detection.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to - determine if it was successful. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/ActivityRecognitionResult.html b/docs/html/reference/com/google/android/gms/location/ActivityRecognitionResult.html deleted file mode 100644 index 5cb8c88a5249..000000000000 --- a/docs/html/reference/com/google/android/gms/location/ActivityRecognitionResult.html +++ /dev/null @@ -1,2279 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ActivityRecognitionResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ActivityRecognitionResult

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.ActivityRecognitionResult
- - - - - - - -
- - -

Class Overview

-

Result of an activity recognition. -

- It contains a list of activities that a user may have been doing at a - particular time. The activities are sorted by the most probable activity - first. A confidence is associated with each activity which indicates how - likely that activity is. -

- getMostProbableActivity() will return the most probable activity of - the user at the time that activity recognition was run. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_ACTIVITY_RESULT - - This constant is deprecated. - If you use it to extract extras from an intent, use - extractResult(Intent) instead. - - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - ActivityRecognitionResultCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ActivityRecognitionResult(List<DetectedActivity> probableActivities, long time, long elapsedRealtimeMillis) - -
- Constructs an ActivityRecognitionResult. - - - -
- -
- - - - - - - - ActivityRecognitionResult(DetectedActivity mostProbableActivity, long time, long elapsedRealtimeMillis) - -
- Constructs an ActivityRecognitionResult from a single activity. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - static - - ActivityRecognitionResult - - extractResult(Intent intent) - -
- Extracts the ActivityRecognitionResult from an Intent. - - - -
- -
- - - - - - int - - getActivityConfidence(int activityType) - -
- Returns the confidence of the given activity type. - - - -
- -
- - - - - - long - - getElapsedRealtimeMillis() - -
- Returns the elapsed real time of this detection in milliseconds since - boot, including time spent in sleep as obtained by - SystemClock.elapsedRealtime(). - - - -
- -
- - - - - - DetectedActivity - - getMostProbableActivity() - -
- Returns the most probable activity of the user. - - - -
- -
- - - - - - List<DetectedActivity> - - getProbableActivities() - -
- Returns the list of activities that where detected with the confidence - value associated with each activity. - - - -
- -
- - - - - - long - - getTime() - -
- Returns the UTC time of this detection, in milliseconds since January 1, - 1970. - - - -
- -
- - - - static - - boolean - - hasResult(Intent intent) - -
- Returns true if an Intent contains an ActivityRecognitionResult. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_ACTIVITY_RESULT -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- If you use it to extract extras from an intent, use - extractResult(Intent) instead. - -

-

- - -
- Constant Value: - - - "com.google.android.location.internal.EXTRA_ACTIVITY_RESULT" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - ActivityRecognitionResultCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ActivityRecognitionResult - (List<DetectedActivity> probableActivities, long time, long elapsedRealtimeMillis) -

-
-
- - - -
-
- - - - -

Constructs an ActivityRecognitionResult.

-
-
Parameters
- - - - - - - - - - -
probableActivities - the activities that where detected, sorted by - confidence (most probable first).
time - the UTC time of this detection, in milliseconds since January - 1, 1970.
elapsedRealtimeMillis - milliseconds since boot -
-
- -
-
- - - - -
-

- - public - - - - - - - ActivityRecognitionResult - (DetectedActivity mostProbableActivity, long time, long elapsedRealtimeMillis) -

-
-
- - - -
-
- - - - -

Constructs an ActivityRecognitionResult from a single activity.

-
-
Parameters
- - - - - - - - - - -
mostProbableActivity - the most probable activity of the device.
time - the UTC time of this detection, in milliseconds since January - 1, 1970.
elapsedRealtimeMillis - milliseconds since boot. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - ActivityRecognitionResult - - extractResult - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts the ActivityRecognitionResult from an Intent. -

- This is a utility function which extracts the ActivityRecognitionResult - from the extras of an Intent that was sent from the activity detection - service.

-
-
Returns
-
  • an ActivityRecognitionResult, or null if the intent doesn't - contain an ActivityRecognitionResult. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getActivityConfidence - (int activityType) -

-
-
- - - -
-
- - - - -

Returns the confidence of the given activity type. -

- -
-
- - - - -
-

- - public - - - - - long - - getElapsedRealtimeMillis - () -

-
-
- - - -
-
- - - - -

Returns the elapsed real time of this detection in milliseconds since - boot, including time spent in sleep as obtained by - SystemClock.elapsedRealtime(). -

- -
-
- - - - -
-

- - public - - - - - DetectedActivity - - getMostProbableActivity - () -

-
-
- - - -
-
- - - - -

Returns the most probable activity of the user. -

- -
-
- - - - -
-

- - public - - - - - List<DetectedActivity> - - getProbableActivities - () -

-
-
- - - -
-
- - - - -

Returns the list of activities that where detected with the confidence - value associated with each activity. The activities are sorted by most - probable activity first. -

- The sum of the confidences of all detected activities this method returns - does not have to be <= 100 since some activities are not mutually exclusive - (for example, you can be walking while in a bus) and some activities are - hierarchical (ON_FOOT is a generalization of WALKING and RUNNING). -

- -
-
- - - - -
-

- - public - - - - - long - - getTime - () -

-
-
- - - -
-
- - - - -

Returns the UTC time of this detection, in milliseconds since January 1, - 1970. -

- -
-
- - - - -
-

- - public - static - - - - boolean - - hasResult - (Intent intent) -

-
-
- - - -
-
- - - - -

Returns true if an Intent contains an ActivityRecognitionResult. -

- This is a utility function that can be called from inside an intent - receiver to make sure the received intent is from activity recognition.

-
-
Returns
-
  • true if the intent contains an ActivityRecognitionResult, false - otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/DetectedActivity.html b/docs/html/reference/com/google/android/gms/location/DetectedActivity.html deleted file mode 100644 index 74860f75afcb..000000000000 --- a/docs/html/reference/com/google/android/gms/location/DetectedActivity.html +++ /dev/null @@ -1,2268 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DetectedActivity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DetectedActivity

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.DetectedActivity
- - - - - - - -
- - -

Class Overview

-

The detected activity of the device with an an associated confidence. See - ActivityRecognitionApi for details on how to obtain a DetectedActivity. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intIN_VEHICLE - The device is in a vehicle, such as a car. - - - -
intON_BICYCLE - The device is on a bicycle. - - - -
intON_FOOT - The device is on a user who is walking or running. - - - -
intRUNNING - The device is on a user who is running. - - - -
intSTILL - The device is still (not moving). - - - -
intTILTING - The device angle relative to gravity changed significantly. - - - -
intUNKNOWN - Unable to detect the current activity. - - - -
intWALKING - The device is on a user who is walking. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - DetectedActivityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DetectedActivity(int activityType, int confidence) - -
- Constructs a DetectedActivity. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - int - - getConfidence() - -
- Returns a value from 0 to 100 indicating the likelihood that the user is performing this - activity. - - - -
- -
- - - - - - int - - getType() - -
- Returns the type of activity that was detected. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - IN_VEHICLE -

-
- - - - -
-
- - - - -

The device is in a vehicle, such as a car. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ON_BICYCLE -

-
- - - - -
-
- - - - -

The device is on a bicycle. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ON_FOOT -

-
- - - - -
-
- - - - -

The device is on a user who is walking or running. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RUNNING -

-
- - - - -
-
- - - - -

The device is on a user who is running. This is a sub-activity of ON_FOOT. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STILL -

-
- - - - -
-
- - - - -

The device is still (not moving). -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TILTING -

-
- - - - -
-
- - - - -

The device angle relative to gravity changed significantly. This often occurs when a device - is picked up from a desk or a user who is sitting stands up. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN -

-
- - - - -
-
- - - - -

Unable to detect the current activity. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WALKING -

-
- - - - -
-
- - - - -

The device is on a user who is walking. This is a sub-activity of ON_FOOT. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - DetectedActivityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DetectedActivity - (int activityType, int confidence) -

-
-
- - - -
-
- - - - -

Constructs a DetectedActivity.

-
-
Parameters
- - - - - - - -
activityType - the activity that was detected.
confidence - value from 0 to 100 indicating how likely it is that - the user is performing this activity. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getConfidence - () -

-
-
- - - -
-
- - - - -

Returns a value from 0 to 100 indicating the likelihood that the user is performing this - activity. -

- The larger the value, the more consistent the data used to perform the classification is with - the detected activity. -

- This value will be <= 100. It means that larger values such as a confidence of >= 75 indicate - that it's very likely that the detected activity is correct, while a value of <= 50 indicates - that there may be another activity that is just as or more likely. -

- Multiple activities may have high confidence values. For example, the ON_FOOT may have a - confidence of 100 while the RUNNING activity may have a confidence of 95. The sum of the - confidences of all detected activities for a classification does not have to be <= 100 since - some activities are not mutually exclusive (for example, you can be walking while in a bus) - and some activities are hierarchical (ON_FOOT is a generalization of WALKING and RUNNING). -

- -
-
- - - - -
-

- - public - - - - - int - - getType - () -

-
-
- - - -
-
- - - - -

Returns the type of activity that was detected. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/FusedLocationProviderApi.html b/docs/html/reference/com/google/android/gms/location/FusedLocationProviderApi.html deleted file mode 100644 index 9eabd1cfbab4..000000000000 --- a/docs/html/reference/com/google/android/gms/location/FusedLocationProviderApi.html +++ /dev/null @@ -1,2124 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FusedLocationProviderApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

FusedLocationProviderApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.FusedLocationProviderApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with the fused location provider. - -

The methods must be used in conjunction with a GoogleApiClient. E.g. - 


-     new GoogleApiClient.Builder(context)
-             .addApi(LocationServices.API)
-             .addConnectionCallbacks(this)
-             .addOnConnectionFailedListener(this)
-             .build()
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringKEY_LOCATION_CHANGED - Key used for a Bundle extra holding a Location value when a location change is broadcast - using a PendingIntent. - - - -
StringKEY_MOCK_LOCATION - Key used for the Bundle extra in Location object holding a boolean indicating whether - the location was set using setMockLocation(GoogleApiClient, Location). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Location - - getLastLocation(GoogleApiClient client) - -
- Returns the best most recent location currently available. - - - -
- -
- abstract - - - - - LocationAvailability - - getLocationAvailability(GoogleApiClient client) - -
- Returns the availability of location data. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeLocationUpdates(GoogleApiClient client, LocationCallback callback) - -
- Removes all location updates for the given location result listener. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeLocationUpdates(GoogleApiClient client, LocationListener listener) - -
- Removes all location updates for the given location listener. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeLocationUpdates(GoogleApiClient client, PendingIntent callbackIntent) - -
- Removes all location updates for the given pending intent. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestLocationUpdates(GoogleApiClient client, LocationRequest request, LocationCallback callback, Looper looper) - -
- Requests location updates with a callback on the specified Looper thread. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestLocationUpdates(GoogleApiClient client, LocationRequest request, LocationListener listener, Looper looper) - -
- Requests location updates with a callback on the specified Looper thread. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestLocationUpdates(GoogleApiClient client, LocationRequest request, LocationListener listener) - -
- Requests location updates. - - - -
- -
- abstract - - - - - PendingResult<Status> - - requestLocationUpdates(GoogleApiClient client, LocationRequest request, PendingIntent callbackIntent) - -
- Requests location updates with a callback on the specified PendingIntent. - - - -
- -
- abstract - - - - - PendingResult<Status> - - setMockLocation(GoogleApiClient client, Location mockLocation) - -
- Sets the mock location to be used for the location provider. - - - -
- -
- abstract - - - - - PendingResult<Status> - - setMockMode(GoogleApiClient client, boolean isMockMode) - -
- Sets whether or not the location provider is in mock mode. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - KEY_LOCATION_CHANGED -

-
- - - - -
-
- - - - -

Key used for a Bundle extra holding a Location value when a location change is broadcast - using a PendingIntent. -

- - -
- Constant Value: - - - "com.google.android.location.LOCATION" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_MOCK_LOCATION -

-
- - - - -
-
- - - - -

Key used for the Bundle extra in Location object holding a boolean indicating whether - the location was set using setMockLocation(GoogleApiClient, Location). If the value is false this - extra is not set. -

- - -
- Constant Value: - - - "mockLocation" - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Location - - getLastLocation - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the best most recent location currently available. -

- If a location is not available, which should happen very rarely, null will be returned. The - best accuracy available while respecting the location permissions will be returned. -

- This method provides a simplified way to get location. It is particularly well suited for - applications that do not require an accurate location and that do not want to maintain extra - logic for location updates.

-
-
Parameters
- - - - -
client - An existing GoogleApiClient. If not connected null will be returned. -
-
- -
-
- - - - -
-

- - public - - - abstract - - LocationAvailability - - getLocationAvailability - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Returns the availability of location data. - When isLocationAvailable() - returns true, then the location returned by getLastLocation(GoogleApiClient) will be reasonably - up to date within the hints specified by the active LocationRequests. -

- If the client isn't connected to Google Play services and the request times out, - null is returned.

-
-
Parameters
- - - - -
client - An existing GoogleApiClient. If not connected null will be returned. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeLocationUpdates - (GoogleApiClient client, LocationCallback callback) -

-
-
- - - -
-
- - - - -

Removes all location updates for the given location result listener.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
callback - The callback to remove.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeLocationUpdates - (GoogleApiClient client, LocationListener listener) -

-
-
- - - -
-
- - - - -

Removes all location updates for the given location listener.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
listener - The listener to remove.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeLocationUpdates - (GoogleApiClient client, PendingIntent callbackIntent) -

-
-
- - - -
-
- - - - -

Removes all location updates for the given pending intent. - -

It is possible for this call to cancel the PendingIntent under some circumstances.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
callbackIntent - The PendingIntent that was used in - requestLocationUpdates(GoogleApiClient, LocationRequest, PendingIntent) - or is equal as defined by equals(Object).
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestLocationUpdates - (GoogleApiClient client, LocationRequest request, LocationCallback callback, Looper looper) -

-
-
- - - -
-
- - - - -

Requests location updates with a callback on the specified Looper thread. -

- This method is suited for the foreground use cases,more specifically - for requesting locations while being connected to GoogleApiClient. For - background use cases, the PendingIntent version of the method is recommended, see - requestLocationUpdates(GoogleApiClient, LocationRequest, PendingIntent). -

- Any previous LocationRequests registered on this LocationListener will be replaced. -

- Callbacks for LocationCallback will be made on the specified thread, which must - already be a prepared looper thread.

-
-
Parameters
- - - - - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
request - The location request for the updates.
callback - The callback for the location updates.
looper - The Looper object whose message queue will be used to implement the callback - mechanism, or null to make callbacks on the calling thread.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful.
-
-
-
Throws
- - - - -
IllegalStateException - If looper is null and this method is executed in a - thread that has not called Looper.prepare(). -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestLocationUpdates - (GoogleApiClient client, LocationRequest request, LocationListener listener, Looper looper) -

-
-
- - - -
-
- - - - -

Requests location updates with a callback on the specified Looper thread. -

- This method is suited for the foreground use cases,more specifically - for requesting locations while being connected to GoogleApiClient. For - background use cases, the PendingIntent version of the method is recommended, see - requestLocationUpdates(GoogleApiClient, LocationRequest, PendingIntent). -

- Any previous LocationRequests registered on this LocationListener will be replaced. -

- Callbacks for LocationListener will be made on the specified thread, which must already be a - prepared looper thread. For cases where the callback can happen on the calling thread, the - variant of this method without a Looper can be used. See requestLocationUpdates(GoogleApiClient, LocationRequest, LocationListener, Looper).

-
-
Parameters
- - - - - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
request - The location request for the updates.
listener - The listener for the location updates.
looper - The Looper object whose message queue will be used to implement the callback - mechanism, or null to make callbacks on the calling thread.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful.
-
-
-
Throws
- - - - -
IllegalStateException - If looper is null and this method is executed in a - thread that has not called Looper.prepare(). -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestLocationUpdates - (GoogleApiClient client, LocationRequest request, LocationListener listener) -

-
-
- - - -
-
- - - - -

Requests location updates. -

- This method is suited for the foreground use cases, more specifically - for requesting locations while being connected to GoogleApiClient. For - background use cases, the PendingIntent version of the method is recommended, see - requestLocationUpdates(GoogleApiClient, LocationRequest, PendingIntent). -

- Any previous LocationRequests registered on this LocationListener will be replaced. -

- Callbacks for LocationListener will be made on the calling thread, which must already be a - prepared looper thread, such as the main thread of the calling Activity. The variant of this - method with a Looper is recommended for cases where the callback needs to happen on - a specific thread. - See - requestLocationUpdates(GoogleApiClient, LocationRequest, LocationListener, Looper).

-
-
Parameters
- - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
request - The location request for the updates.
listener - The listener for the location updates.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful.
-
-
-
Throws
- - - - -
IllegalStateException - If this method is executed in a thread that has not called - Looper.prepare(). -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - requestLocationUpdates - (GoogleApiClient client, LocationRequest request, PendingIntent callbackIntent) -

-
-
- - - -
-
- - - - -

Requests location updates with a callback on the specified PendingIntent. -

- This method is suited for the background use cases, more specifically - for receiving location updates, even when the app has been killed by the system. In order to - do so, use a PendingIntent for a started service. For foreground use cases, the - LocationListener version of the method is recommended, see - requestLocationUpdates(GoogleApiClient, LocationRequest, LocationListener). -

- Any previously registered requests that have the same PendingIntent - (as defined by equals(Object)) will be replaced by this request. -

- Location updates are sent with a key of KEY_LOCATION_CHANGED - and a Location value on the intent.

-
-
Parameters
- - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
request - The location request for the updates.
callbackIntent - A pending intent to be sent for each location update.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - setMockLocation - (GoogleApiClient client, Location mockLocation) -

-
-
- - - -
-
- - - - -

Sets the mock location to be used for the location provider. This location will be used - in place of any actual locations from the underlying providers (network or gps). - -

setMockMode(GoogleApiClient, boolean) must be called and set to true prior to calling this method. -

Care should be taken in specifying the timestamps as many applications require them - to be monotonically increasing.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
mockLocation - The mock location. Must have a minimum number of fields set to be - considered a valild location, as per documentation in the - Location class.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
-
-
Throws
- - - - -
SecurityException - if the ACCESS_MOCK_LOCATION permission is not present or the - Settings.Secure.ALLOW_MOCK_LOCATION system setting is - not enabled.
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - setMockMode - (GoogleApiClient client, boolean isMockMode) -

-
-
- - - -
-
- - - - -

Sets whether or not the location provider is in mock mode. - -

The underlying providers (network and gps) will be stopped (except by direct - LocationManager access), and only locations specified in - setMockLocation(GoogleApiClient, Location) will be reported. This will effect all location clients - connected using the FusedLocationProviderApi, including geofencer clients (i.e. - geofences can be triggered based on mock locations). - -

The client must remain connected in order for mock mode to remain active. If the client - dies the system will return to its normal state. - -

Calls are not nested, and mock mode will be set directly regardless of previous calls.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and - waiting for onConnected(Bundle) - to be called.
isMockMode - If true the location provider will be set to mock mode. If false it - will be returned to its normal state.
-
-
-
Returns
-
  • a PendingResult for the call, check isSuccess() to determine if it was - successful. -
-
-
-
Throws
- - - - -
SecurityException - if the ACCESS_MOCK_LOCATION permission is not present or the - Settings.Secure.ALLOW_MOCK_LOCATION system setting is - not enabled.
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/Geofence.Builder.html b/docs/html/reference/com/google/android/gms/location/Geofence.Builder.html deleted file mode 100644 index 9273aedd76d8..000000000000 --- a/docs/html/reference/com/google/android/gms/location/Geofence.Builder.html +++ /dev/null @@ -1,1823 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Geofence.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Geofence.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.Geofence.Builder
- - - - - - - -
- - -

Class Overview

-

A builder that builds Geofence. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Geofence.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Geofence - - build() - -
- Creates a geofence object. - - - -
- -
- - - - - - Geofence.Builder - - setCircularRegion(double latitude, double longitude, float radius) - -
- Sets the region of this geofence. - - - -
- -
- - - - - - Geofence.Builder - - setExpirationDuration(long durationMillis) - -
- Sets the expiration duration of geofence. - - - -
- -
- - - - - - Geofence.Builder - - setLoiteringDelay(int loiteringDelayMs) - -
- Sets the delay between GEOFENCE_TRANSITION_ENTER and - GEOFENCE_TRANSITION_DWELLING in milliseconds. - - - -
- -
- - - - - - Geofence.Builder - - setNotificationResponsiveness(int notificationResponsivenessMs) - -
- Sets the best-effort notification responsiveness of the geofence. - - - -
- -
- - - - - - Geofence.Builder - - setRequestId(String requestId) - -
- Sets the request ID of the geofence. - - - -
- -
- - - - - - Geofence.Builder - - setTransitionTypes(int transitionTypes) - -
- Sets the transition types of interest. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Geofence.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Geofence - - build - () -

-
-
- - - -
-
- - - - -

Creates a geofence object.

-
-
Throws
- - - - -
IllegalArgumentException - if any parameters are not set or out - of range -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setCircularRegion - (double latitude, double longitude, float radius) -

-
-
- - - -
-
- - - - -

Sets the region of this geofence. The geofence represents a circular - area on a flat, horizontal plane.

-
-
Parameters
- - - - - - - - - - -
latitude - latitude in degrees, between -90 and +90 inclusive
longitude - longitude in degrees, between -180 and +180 - inclusive
radius - radius in meters -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setExpirationDuration - (long durationMillis) -

-
-
- - - -
-
- - - - -

Sets the expiration duration of geofence. This geofence will be - removed automatically after this period of time.

-
-
Parameters
- - - - -
durationMillis - time for this proximity alert, in milliseconds, - or NEVER_EXPIRE to indicate no expiration. When - positive, this geofence will be removed automatically - after this amount of time. -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setLoiteringDelay - (int loiteringDelayMs) -

-
-
- - - -
-
- - - - -

Sets the delay between GEOFENCE_TRANSITION_ENTER and - GEOFENCE_TRANSITION_DWELLING in milliseconds. For example, if - loitering delay is set to 300000 ms (i.e. 5 minutes) the geofence - service will send a GEOFENCE_TRANSITION_DWELL alert roughly - 5 minutes after user enters a geofence if the user stays inside the - geofence during this period of time. If the user exits from the - geofence in this amount of time, GEOFENCE_TRANSITION_DWELL - alert won't be sent. -

- This value is ignored if the transition types don't include a - GEOFENCE_TRANSITION_DWELL filter.

-
-
Parameters
- - - - -
loiteringDelayMs - the delay for confirming dwelling, in - milliseconds -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setNotificationResponsiveness - (int notificationResponsivenessMs) -

-
-
- - - -
-
- - - - -

Sets the best-effort notification responsiveness of the geofence. - Defaults to 0. Setting a big responsiveness value, for example 5 - minutes, can save power significantly. However, setting a very small - responsiveness value, for example 5 seconds, doesn't necessarily mean - you will get notified right after the user enters or exits a - geofence: internally, the geofence might adjust the responsiveness - value to save power when needed.

-
-
Parameters
- - - - -
notificationResponsivenessMs - (milliseconds) defines the - best-effort description of how soon should the callback be - called when the transition associated with the Geofence is - triggered. For instance, if set to 300000 milliseconds the - callback will be called 5 minutes within entering or - exiting the geofence. -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setRequestId - (String requestId) -

-
-
- - - -
-
- - - - -

Sets the request ID of the geofence. Request ID is a string to - identify this geofence inside your application. When two geofences - with the same requestId are monitored, the new one will replace the - old one regardless the geographical region these two geofences - represent.

-
-
Parameters
- - - - -
requestId - the request ID. The length of the string can be up - to 100 characters. -
-
- -
-
- - - - -
-

- - public - - - - - Geofence.Builder - - setTransitionTypes - (int transitionTypes) -

-
-
- - - -
-
- - - - -

Sets the transition types of interest. Alerts are only generated for - the given transition types.

-
-
Parameters
- - - - -
transitionTypes - geofence transition types of interest, as a - bitwise-OR of GEOFENCE_TRANSITION_ flags. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/Geofence.html b/docs/html/reference/com/google/android/gms/location/Geofence.html deleted file mode 100644 index 0cf488b20e8d..000000000000 --- a/docs/html/reference/com/google/android/gms/location/Geofence.html +++ /dev/null @@ -1,1329 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Geofence | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Geofence

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.Geofence
- - - - - - - -
- - -

Class Overview

-

Represents a geographical region, also known as a geofence. Geofences can be - monitored by geofencer service. And when the user crosses the boundary of a - geofence, an alert will be generated. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGeofence.Builder - A builder that builds Geofence.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intGEOFENCE_TRANSITION_DWELL - The transition type indicating that the user enters and dwells in - geofences for a given period of time. - - - -
intGEOFENCE_TRANSITION_ENTER - The transition type indicating that the user enters the geofence(s). - - - -
intGEOFENCE_TRANSITION_EXIT - The transition type indicating that the user exits the geofence(s). - - - -
longNEVER_EXPIRE - Expiration value that indicates the geofence should never expire. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getRequestId() - -
- Returns the request ID of this geofence. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - GEOFENCE_TRANSITION_DWELL -

-
- - - - -
-
- - - - -

The transition type indicating that the user enters and dwells in - geofences for a given period of time. If - GEOFENCE_TRANSITION_ENTER is also specified, this alert will - always be sent after the GEOFENCE_TRANSITION_ENTER alert. -

- You must set the duration of loitering before this alert is sent using - setLoiteringDelay(int). -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TRANSITION_ENTER -

-
- - - - -
-
- - - - -

The transition type indicating that the user enters the geofence(s). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TRANSITION_EXIT -

-
- - - - -
-
- - - - -

The transition type indicating that the user exits the geofence(s). -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - long - - NEVER_EXPIRE -

-
- - - - -
-
- - - - -

Expiration value that indicates the geofence should never expire. -

- - -
- Constant Value: - - - -1 - (0xffffffffffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getRequestId - () -

-
-
- - - -
-
- - - - -

Returns the request ID of this geofence. The request ID is a string to - identify this geofence inside your application. When two geofences with - the same requestId are monitored, the new one will replace the old one - regardless the geographical region these two geofences represent. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/GeofenceStatusCodes.html b/docs/html/reference/com/google/android/gms/location/GeofenceStatusCodes.html deleted file mode 100644 index 06dee33bc07b..000000000000 --- a/docs/html/reference/com/google/android/gms/location/GeofenceStatusCodes.html +++ /dev/null @@ -1,1815 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeofenceStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GeofenceStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.location.GeofenceStatusCodes
- - - - - - - -
- - -

Class Overview

-

Geofence specific status codes, for use in getStatusCode() -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intGEOFENCE_NOT_AVAILABLE - Geofence service is not available now. - - - -
intGEOFENCE_TOO_MANY_GEOFENCES - Your app has registered more than 100 geofences. - - - -
intGEOFENCE_TOO_MANY_PENDING_INTENTS - You have provided more than 5 different PendingIntents to the - addGeofences(GoogleApiClient, GeofencingRequest, PendingIntent) call. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- Returns an untranslated debug (not user-friendly!) string based on the current status code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - GEOFENCE_NOT_AVAILABLE -

-
- - - - -
-
- - - - -

Geofence service is not available now. Typically this is because the user turned off location - access in settings > location access. -

- - -
- Constant Value: - - - 1000 - (0x000003e8) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TOO_MANY_GEOFENCES -

-
- - - - -
-
- - - - -

Your app has registered more than 100 geofences. Remove unused ones before adding new - geofences. -

- - -
- Constant Value: - - - 1001 - (0x000003e9) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TOO_MANY_PENDING_INTENTS -

-
- - - - -
-
- - - - -

You have provided more than 5 different PendingIntents to the - addGeofences(GoogleApiClient, GeofencingRequest, PendingIntent) call. -

- - -
- Constant Value: - - - 1002 - (0x000003ea) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

Returns an untranslated debug (not user-friendly!) string based on the current status code. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/GeofencingApi.html b/docs/html/reference/com/google/android/gms/location/GeofencingApi.html deleted file mode 100644 index 105073fb5ea7..000000000000 --- a/docs/html/reference/com/google/android/gms/location/GeofencingApi.html +++ /dev/null @@ -1,1469 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeofencingApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

GeofencingApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.GeofencingApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with the geofencing APIs. - -

The methods must be used in conjunction with a GoogleApiClient. E.g. - 


- new GoogleApiClient.Builder(context)
-     .addApi(LocationServices.API)
-     .addConnectionCallbacks(this)
-     .addOnConnectionFailedListener(this)
-     .build()
-
- -

All methods are thread safe. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addGeofences(GoogleApiClient client, GeofencingRequest geofencingRequest, PendingIntent pendingIntent) - -
- Sets alerts to be notified when the device enters or exits one of the specified geofences. - - - -
- -
- abstract - - - - - PendingResult<Status> - - addGeofences(GoogleApiClient client, List<Geofence> geofences, PendingIntent pendingIntent) - -
- - This method is deprecated. - use addGeofences(GoogleApiClient, GeofencingRequest, PendingIntent) - instead. - - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeGeofences(GoogleApiClient client, List<String> geofenceRequestIds) - -
- Removes geofences by their request IDs. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeGeofences(GoogleApiClient client, PendingIntent pendingIntent) - -
- Removes all geofences associated with the given pendingIntent. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addGeofences - (GoogleApiClient client, GeofencingRequest geofencingRequest, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - - -

Sets alerts to be notified when the device enters or exits one of the specified geofences. If - an existing geofence with the same request ID is already registered, the old geofence is - replaced by the new one, and the new PendingIntent is used to generate intents for - alerts. -

- Status is returned when geofences are successfully added or failed to be added. Refer - to GeofenceStatusCodes for possible errors when adding geofences. -

- When a geofence transition (for example, entering or exiting) matches one of the transition - filter (see setTransitionTypes(int)) in the given geofence list, an - intent is generated using the given pending intent. You can call - fromIntent(Intent) to get the transition type, geofences that - triggered this intent and the location that triggered the geofence transition. -

- In case network location provider is disabled by the user, the geofence service will stop - updating, all registered geofences will be removed and an intent is generated by the provided - pending intent. In this case, the GeofencingEvent created from this intent represents - an error event, where hasError() returns true and - getErrorCode() returns - GEOFENCE_NOT_AVAILABLE. -

- This method requires ACCESS_FINE_LOCATION.

-
-
Parameters
- - - - - - - - - - -
client - an existing GoogleApiClient. It must be connected at the time of this call, - which is normally achieved by calling connect() and waiting - for onConnected(Bundle) to be called.
geofencingRequest - geofencing request that include a list of geofences to be added and - related triggering behavior. The request must be created using - GeofencingRequest.Builder.
pendingIntent - a pending intent that will be used to generate an intent when matched - geofence transition is observed
-
-
-
Throws
- - - - - - - -
SecurityException - if the app does not have - ACCESS_FINE_LOCATION permission
NullPointerException - if geofencingRequest or pendingIntent is - null -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addGeofences - (GoogleApiClient client, List<Geofence> geofences, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use addGeofences(GoogleApiClient, GeofencingRequest, PendingIntent) - instead. - -

-

Sets alerts to be notified when the device enters or exits one of the - specified geofences. If an existing geofence with the same request ID is - already registered, the old geofence is replaced by the new one, and the - new pendingIntent is used to generate intents for alerts. -

- Status is returned when geofences are successfully added or failed to be added. - Refer to GeofenceStatusCodes for possible errors when adding geofences. -

- When a geofence transition (for example, entering or exiting) matches one - of the transition filter (see - setTransitionTypes(int)) in the given geofence - list, an intent is generated using the given pending intent. You can call - fromIntent(Intent) to get the transition type, - geofences that triggered this intent and the location that triggered the geofence - transition. -

- In case network location provider is disabled by the user, the geofence - service will stop updating, all registered geofences will be removed and - an intent is generated by the provided pending intent. In this case, - the GeofencingEvent created from this intent represents an error event, - where hasError() returns true and - getErrorCode() returns - GEOFENCE_NOT_AVAILABLE. -

- This method requires - ACCESS_FINE_LOCATION.

-
-
Parameters
- - - - - - - - - - -
client - An existing GoogleApiClient. It must be connected at the - time of this call, which is normally achieved by calling - connect() and waiting for - onConnected(Bundle) to - be called.
geofences - a list of geofences to be added. The geofences must be - created using Geofence.Builder.
pendingIntent - a pending intent that will be used to generate an - intent when matched geofence transition is observed
-
-
-
Throws
- - - - - - - - - - -
SecurityException - if the app does not have - ACCESS_FINE_LOCATION - permission
IllegalArgumentException - if geofences is null or - empty
NullPointerException - if intent or listener is - null
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeGeofences - (GoogleApiClient client, List<String> geofenceRequestIds) -

-
-
- - - -
-
- - - - -

Removes geofences by their request IDs. Request ID is specified when you - create a Geofence by calling - setRequestId(String). -

- Status is returned when geofences are successfully removed or fail to be removed. - Refer to GeofenceStatusCodes for possible errors when removing geofences. -

- This method requires - ACCESS_FINE_LOCATION.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the - time of this call, which is normally achieved by calling - connect() and waiting for - onConnected(Bundle) to - be called.
geofenceRequestIds - a list of request IDs of geofences that need to - be removed
-
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if geofenceRequestIds is - null or empty
SecurityException - if the app does not have - ACCESS_FINE_LOCATION - permission
NullPointerException - if listener is null -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeGeofences - (GoogleApiClient client, PendingIntent pendingIntent) -

-
-
- - - -
-
- - - - -

Removes all geofences associated with the given pendingIntent. -

- Warning: equals(Object) is used for comparison. Please use - FLAG_UPDATE_CURRENT - rather than FLAG_CANCEL_CURRENT when - creating the pending intent, otherwise you will not get the same pending - intent you provided to - addGeofences(GoogleApiClient, List, PendingIntent) - and thus the removal operation will remove nothing. -

- Status is returned when geofences are successfully removed or fail to be removed. - Refer to GeofenceStatusCodes for possible errors when removing geofences. -

- This method requires - ACCESS_FINE_LOCATION.

-
-
Parameters
- - - - - - - -
client - An existing GoogleApiClient. It must be connected at the - time of this call, which is normally achieved by calling - connect() and waiting for - onConnected(Bundle) to - be called.
pendingIntent - the pending intent associated with the geofences - that need to be removed.
-
-
-
Throws
- - - - - - - -
SecurityException - if the app does not have - ACCESS_FINE_LOCATION - permission
NullPointerException - if intent or listener is - null -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/GeofencingEvent.html b/docs/html/reference/com/google/android/gms/location/GeofencingEvent.html deleted file mode 100644 index b3c496bbfef1..000000000000 --- a/docs/html/reference/com/google/android/gms/location/GeofencingEvent.html +++ /dev/null @@ -1,1646 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeofencingEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GeofencingEvent

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.GeofencingEvent
- - - - - - - -
- - -

Class Overview

-

Represents an event from the GeofencingApi API. The event can be -

    -
  • A geofence triggering event generated when a geofence transition happens. -
    • -
  • An error happens after geofences are registered and being monitored.
    • -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - GeofencingEvent - - fromIntent(Intent intent) - -
- Creates a GeofencingEvent object from the given intent. - - - -
- -
- - - - - - int - - getErrorCode() - -
- Returns the error code that explains the error that triggered the intent - specified in fromIntent(Intent). - - - -
- -
- - - - - - int - - getGeofenceTransition() - -
- Returns the transition type of the geofence transition alert. - - - -
- -
- - - - - - List<Geofence> - - getTriggeringGeofences() - -
- Returns a list of geofences that triggered this geofence transition - alert. - - - -
- -
- - - - - - Location - - getTriggeringLocation() - -
- Gets the location that triggered the geofence transition. - - - -
- -
- - - - - - boolean - - hasError() - -
- Whether an error triggered this intent. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - GeofencingEvent - - fromIntent - (Intent intent) -

-
-
- - - -
-
- - - - -

Creates a GeofencingEvent object from the given intent.

-
-
Parameters
- - - - -
intent - the intent to extract the geofencing event data from
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getErrorCode - () -

-
-
- - - -
-
- - - - -

Returns the error code that explains the error that triggered the intent - specified in fromIntent(Intent).

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getGeofenceTransition - () -

-
-
- - - -
-
- - - - -

Returns the transition type of the geofence transition alert.

-
-
Returns
-
  • -1 if the intent specified in fromIntent(Intent) is not - generated for a transition alert; Otherwise returns the - GEOFENCE_TRANSITION_ flags value defined in Geofence. -
-
- -
-
- - - - -
-

- - public - - - - - List<Geofence> - - getTriggeringGeofences - () -

-
-
- - - -
-
- - - - -

Returns a list of geofences that triggered this geofence transition - alert.

-
-
Returns
-
  • a list of geofences that triggered this geofence transition - alert or null if the intent specified in - fromIntent(Intent) is not generated for a geofence - transition alert -
-
- -
-
- - - - -
-

- - public - - - - - Location - - getTriggeringLocation - () -

-
-
- - - -
-
- - - - -

Gets the location that triggered the geofence transition. Triggering location - is only available if the calling app links against Google Play services - 5.0 SDK.

-
-
Returns
-
  • the location that triggered this geofence alert or null - if it's not included in the intent specified in - fromIntent(Intent) -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - hasError - () -

-
-
- - - -
-
- - - - -

Whether an error triggered this intent.

-
-
Returns
-
  • true if an error triggered the intent specified in - fromIntent(Intent), otherwise false -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/GeofencingRequest.Builder.html b/docs/html/reference/com/google/android/gms/location/GeofencingRequest.Builder.html deleted file mode 100644 index 5888d8df7256..000000000000 --- a/docs/html/reference/com/google/android/gms/location/GeofencingRequest.Builder.html +++ /dev/null @@ -1,1630 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeofencingRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

GeofencingRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.GeofencingRequest.Builder
- - - - - - - -
- - -

Class Overview

-

A builder that builds GeofencingRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GeofencingRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - GeofencingRequest.Builder - - addGeofence(Geofence geofence) - -
- Adds a geofence to be monitored by geofencing service. - - - -
- -
- - - - - - GeofencingRequest.Builder - - addGeofences(List<Geofence> geofences) - -
- Adds all the geofences in the given list to be monitored by geofencing service. - - - -
- -
- - - - - - GeofencingRequest - - build() - -
- Builds the GeofencingRequest object. - - - -
- -
- - - - - - GeofencingRequest.Builder - - setInitialTrigger(int initialTrigger) - -
- Sets the geofence notification behavior at the moment when the geofences are added. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GeofencingRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - GeofencingRequest.Builder - - addGeofence - (Geofence geofence) -

-
-
- - - -
-
- - - - -

Adds a geofence to be monitored by geofencing service.

-
-
Parameters
- - - - -
geofence - the geofence to be monitored. The geofence must be built with - Geofence.Builder.
-
-
-
Returns
-
  • the builder object itself for method chaining
-
-
-
Throws
- - - - - - - -
IllegalArgumentException - if the geofence is not built with - Geofence.Builder.
NullPointerException - if the given geofence is null -
-
- -
-
- - - - -
-

- - public - - - - - GeofencingRequest.Builder - - addGeofences - (List<Geofence> geofences) -

-
-
- - - -
-
- - - - -

Adds all the geofences in the given list to be monitored by geofencing service.

-
-
Parameters
- - - - -
geofences - the geofences to be monitored. The geofences in the list must be built - with Geofence.Builder.
-
-
-
Returns
-
  • the builder object itself for method chaining
-
-
-
Throws
- - - - -
IllegalArgumentException - if the geofence is not built with - Geofence.Builder. -
-
- -
-
- - - - -
-

- - public - - - - - GeofencingRequest - - build - () -

-
-
- - - -
-
- - - - -

Builds the GeofencingRequest object.

-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if no geofence has been added to this list -
-
- -
-
- - - - -
-

- - public - - - - - GeofencingRequest.Builder - - setInitialTrigger - (int initialTrigger) -

-
-
- - - -
-
- - - - -

Sets the geofence notification behavior at the moment when the geofences are added. The - default behavior is INITIAL_TRIGGER_ENTER and - INITIAL_TRIGGER_DWELL.

-
-
Parameters
- - - - -
initialTrigger - the notification behavior. It's a bit-wise of - INITIAL_TRIGGER_ENTER and/or - INITIAL_TRIGGER_EXIT and/or - INITIAL_TRIGGER_DWELL.
-
-
-
Returns
-
  • the builder object itself for method chaining -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/GeofencingRequest.html b/docs/html/reference/com/google/android/gms/location/GeofencingRequest.html deleted file mode 100644 index 61a4ddbfcb6e..000000000000 --- a/docs/html/reference/com/google/android/gms/location/GeofencingRequest.html +++ /dev/null @@ -1,1945 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeofencingRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GeofencingRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.GeofencingRequest
- - - - - - - -
- - -

Class Overview

-

Specifies the list of geofences to be monitored and how the geofence notifications should be - reported. -

- Refer to addGeofences(com.google.android.gms.common.api.GoogleApiClient, GeofencingRequest, android.app.PendingIntent) on how to monitor geofences. -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classGeofencingRequest.Builder - A builder that builds GeofencingRequest.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intINITIAL_TRIGGER_DWELL - A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_DWELL notification at the moment when the geofence is - added and if the device is already inside that geofence for some time. - - - -
intINITIAL_TRIGGER_ENTER - A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_ENTER notification at the moment when the geofence is - added and if the device is already inside that geofence. - - - -
intINITIAL_TRIGGER_EXIT - A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_EXIT notification at the moment when the geofence is - added and if the device is already outside that geofence. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<GeofencingRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - List<Geofence> - - getGeofences() - -
- Gets the list of geofences to be monitored. - - - -
- -
- - - - - - int - - getInitialTrigger() - -
- Gets the triggering behavior at the moment when the geofences are added. - - - -
- -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - INITIAL_TRIGGER_DWELL -

-
- - - - -
-
- - - - -

A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_DWELL notification at the moment when the geofence is - added and if the device is already inside that geofence for some time. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INITIAL_TRIGGER_ENTER -

-
- - - - -
-
- - - - -

A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_ENTER notification at the moment when the geofence is - added and if the device is already inside that geofence. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INITIAL_TRIGGER_EXIT -

-
- - - - -
-
- - - - -

A flag indicating that geofencing service should trigger - GEOFENCE_TRANSITION_EXIT notification at the moment when the geofence is - added and if the device is already outside that geofence. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<GeofencingRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<Geofence> - - getGeofences - () -

-
-
- - - -
-
- - - - -

Gets the list of geofences to be monitored.

-
-
Returns
-
  • the list of geofences to be monitored -
-
- -
-
- - - - -
-

- - public - - - - - int - - getInitialTrigger - () -

-
-
- - - -
-
- - - - -

Gets the triggering behavior at the moment when the geofences are added.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationAvailability.html b/docs/html/reference/com/google/android/gms/location/LocationAvailability.html deleted file mode 100644 index 8886fe6790d8..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationAvailability.html +++ /dev/null @@ -1,1888 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationAvailability | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationAvailability

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationAvailability
- - - - - - - -
- - -

Class Overview

-

Status on the availability of location data

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - LocationAvailabilityCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object other) - -
- - - - static - - LocationAvailability - - extractLocationAvailability(Intent intent) - -
- Extracts the LocationAvailability from an Intent. - - - -
- -
- - - - static - - boolean - - hasLocationAvailability(Intent intent) - -
- Returns true if an Intent contains a LocationAvailability. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isLocationAvailable() - -
- Returns true if the device location is known and reasonably up to date within the hints - requested by the active LocationRequests. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - LocationAvailabilityCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - LocationAvailability - - extractLocationAvailability - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts the LocationAvailability from an Intent. - -

This is a utility function which extracts the LocationAvailability - from the extras of an Intent that was sent in response to a location request.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - boolean - - hasLocationAvailability - (Intent intent) -

-
-
- - - -
-
- - - - -

Returns true if an Intent contains a LocationAvailability. - -

This is a utility function that can be called from inside an intent - receiver to make sure the received intent contains location availability data.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isLocationAvailable - () -

-
-
- - - -
-
- - - - -

Returns true if the device location is known and reasonably up to date within the hints - requested by the active LocationRequests. Failure to determine location may result - from a number of causes including disabled location settings or an inability to retrieve - sensor data in the device's environment. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationCallback.html b/docs/html/reference/com/google/android/gms/location/LocationCallback.html deleted file mode 100644 index 1f0e4caf1f6b..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationCallback.html +++ /dev/null @@ -1,1470 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

LocationCallback

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationCallback
- - - - - - - -
- - -

Class Overview

-

Used for receiving notifications from the FusedLocationProviderApi when the device - location has changed or can no longer be determined. The methods are called if the - LocationCallback has been registered with the location client using the - requestLocationUpdates(GoogleApiClient, LocationRequest, LocationCallback, Looper) - method. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LocationCallback() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onLocationAvailability(LocationAvailability locationAvailability) - -
- Called when there is a change in the availability of location data. - - - -
- -
- - - - - - void - - onLocationResult(LocationResult result) - -
- Called when device location information is available. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LocationCallback - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onLocationAvailability - (LocationAvailability locationAvailability) -

-
-
- - - -
-
- - - - -

Called when there is a change in the availability of location data. - -

When isLocationAvailable() returns false you can assume - that location will not be returned in onLocationResult(LocationResult) until something changes - in the device's settings or environment. Even when - isLocationAvailable() returns true the - onLocationResult(LocationResult) may not always be called regularly, however the device location - is known and both the most recently delivered location and - getLastLocation(GoogleApiClient) will be reasonably up to date given the - hints specified by the active LocationRequests.

-
-
Parameters
- - - - -
locationAvailability - The current status of location availability. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onLocationResult - (LocationResult result) -

-
-
- - - -
-
- - - - -

Called when device location information is available. - -

The most recent location returned by getLastLocation() is not - guaranteed to be immediately fresh, but will be reasonably up to date given the hints - specified by the active LocationRequests.

-
-
Parameters
- - - - -
result - The latest location result available. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationListener.html b/docs/html/reference/com/google/android/gms/location/LocationListener.html deleted file mode 100644 index 952aff15b334..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationListener.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

LocationListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.LocationListener
- - - - - - - -
- - -

Class Overview

-

Used for receiving notifications from the FusedLocationProviderApi when the location - has changed. The methods are called if the LocationListener has been registered with the - location client using the - requestLocationUpdates(GoogleApiClient, LocationRequest, LocationListener) or - requestLocationUpdates(GoogleApiClient, LocationRequest, LocationListener, Looper) methods. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onLocationChanged(Location location) - -
- Called when the location has changed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onLocationChanged - (Location location) -

-
-
- - - -
-
- - - - -

Called when the location has changed.

-
-
Parameters
- - - - -
location - The updated location. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationRequest.html b/docs/html/reference/com/google/android/gms/location/LocationRequest.html deleted file mode 100644 index d051d4179df4..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationRequest.html +++ /dev/null @@ -1,3185 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationRequest
- - - - - - - -
- - -

Class Overview

-

A data object that contains quality of service parameters for requests to - the FusedLocationProviderApi. - -

LocationRequest objects are used to request a quality of service for location updates from - the FusedLocationProviderApi. - -

For example, if your application wants high accuracy location it should create a location - request with setPriority(int) set to PRIORITY_HIGH_ACCURACY and - setInterval(long) to 5 seconds. This would be appropriate for mapping applications that are - showing your location in real-time. - -

At the other extreme, if you want negligible power impact, but to still receive location - updates when available, then create a location request with setPriority(int) set to - PRIORITY_NO_POWER. With this request your application will not trigger (and therefore - will not receive any power blame) any location updates, but will receive locations triggered by - other applications. This would be appropriate for applications that have no firm requirement - for location, but can take advantage when available. - -

In between these two extremes is a very common use-case, where applications definitely want - to receive updates at a specified interval, and can receive them faster when available, but - still want a low power impact. These applications should consider - PRIORITY_BALANCED_POWER_ACCURACY combined with a faster - setFastestInterval(long) (such as 1 minute) and a slower setInterval(long) - (such as 60 minutes). They will only be assigned power blame for the interval set by - setInterval(long), but can still receive locations triggered by other applications at a rate - up to setFastestInterval(long). This style of request is appropriate for many location aware - applications, including background usage. Do be careful to also throttle - setFastestInterval(long) if you perform heavy-weight work after receiving an update - such - as using the network. - -

Activities should strongly consider removing all location request when entering - the background (for example at onPause()), or at least swap the - request to a larger interval and lower quality. - -

Applications cannot specify the exact location sources, such as GPS, that are used by the - LocationClient. In fact, the system may have multiple location sources (providers) running and - may fuse the results from several sources into a single Location object. - -

Location requests from applications with - ACCESS_COARSE_LOCATION and not - ACCESS_FINE_LOCATION will be automatically throttled to a - slower interval, and the location object will be obfuscated to only show a coarse level of - accuracy. - -

All location requests are considered hints, and you may receive locations that are - more/less accurate, and faster/slower than requested. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intPRIORITY_BALANCED_POWER_ACCURACY - Used with setPriority(int) to request "block" level accuracy. - - - -
intPRIORITY_HIGH_ACCURACY - Used with setPriority(int) to request the most accurate locations available. - - - -
intPRIORITY_LOW_POWER - Used with setPriority(int) to request "city" level accuracy. - - - -
intPRIORITY_NO_POWER - Used with setPriority(int) to request the best accuracy possible with zero additional - power consumption. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - LocationRequestCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - LocationRequest - - create() - -
- Create a location request with default parameters. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object object) - -
- - - - - - long - - getExpirationTime() - -
- Get the request expiration time, in milliseconds since boot. - - - -
- -
- - - - - - long - - getFastestInterval() - -
- Get the fastest interval of this request, in milliseconds. - - - -
- -
- - - - - - long - - getInterval() - -
- Get the desired interval of this request, in milliseconds. - - - -
- -
- - - - - - long - - getMaxWaitTime() - -
- Gets the maximum wait time in milliseconds for location updates. - - - -
- -
- - - - - - int - - getNumUpdates() - -
- Get the number of updates requested. - - - -
- -
- - - - - - int - - getPriority() - -
- Get the quality of the request. - - - -
- -
- - - - - - float - - getSmallestDisplacement() - -
- Get the minimum displacement between location updates in meters - -

By default this is 0. - - - -

- -
- - - - - - int - - hashCode() - -
- - - - - - LocationRequest - - setExpirationDuration(long millis) - -
- Set the duration of this request, in milliseconds. - - - -
- -
- - - - - - LocationRequest - - setExpirationTime(long millis) - -
- Set the request expiration time, in millisecond since boot. - - - -
- -
- - - - - - LocationRequest - - setFastestInterval(long millis) - -
- Explicitly set the fastest interval for location updates, in milliseconds. - - - -
- -
- - - - - - LocationRequest - - setInterval(long millis) - -
- Set the desired interval for active location updates, in milliseconds. - - - -
- -
- - - - - - LocationRequest - - setMaxWaitTime(long millis) - -
- Sets the maximum wait time in milliseconds for location updates. - - - -
- -
- - - - - - LocationRequest - - setNumUpdates(int numUpdates) - -
- Set the number of location updates. - - - -
- -
- - - - - - LocationRequest - - setPriority(int priority) - -
- Set the priority of the request. - - - -
- -
- - - - - - LocationRequest - - setSmallestDisplacement(float smallestDisplacementMeters) - -
- Set the minimum displacement between location updates in meters - -

By default this is 0. - - - -

- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - PRIORITY_BALANCED_POWER_ACCURACY -

-
- - - - -
-
- - - - -

Used with setPriority(int) to request "block" level accuracy. - -

Block level accuracy is considered to be about 100 meter accuracy. Using a coarse - accuracy such as this often consumes less power. -

- - -
- Constant Value: - - - 102 - (0x00000066) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PRIORITY_HIGH_ACCURACY -

-
- - - - -
-
- - - - -

Used with setPriority(int) to request the most accurate locations available. - -

This will return the finest location available. -

- - -
- Constant Value: - - - 100 - (0x00000064) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PRIORITY_LOW_POWER -

-
- - - - -
-
- - - - -

Used with setPriority(int) to request "city" level accuracy. - -

City level accuracy is considered to be about 10km accuracy. Using a coarse accuracy - such as this often consumes less power. -

- - -
- Constant Value: - - - 104 - (0x00000068) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PRIORITY_NO_POWER -

-
- - - - -
-
- - - - -

Used with setPriority(int) to request the best accuracy possible with zero additional - power consumption. - -

No locations will be returned unless a different client has requested location updates - in which case this request will act as a passive listener to those locations. -

- - -
- Constant Value: - - - 105 - (0x00000069) - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - LocationRequestCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - LocationRequest - - create - () -

-
-
- - - -
-
- - - - -

Create a location request with default parameters. - -

Default parameters are for a block accuracy, slowly updated location. It can then be - adjusted as required by the applications before passing to the - FusedLocationProviderApi.

-
-
Returns
-
  • a new location request -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object object) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - long - - getExpirationTime - () -

-
-
- - - -
-
- - - - -

Get the request expiration time, in milliseconds since boot. - -

This value can be compared to elapsedRealtime() to determine the time - until expiration.

-
-
Returns
-
  • expiration time of request, in milliseconds since boot including suspend -
-
- -
-
- - - - -
-

- - public - - - - - long - - getFastestInterval - () -

-
-
- - - -
-
- - - - -

Get the fastest interval of this request, in milliseconds. - -

The system will never provide location updates faster than the minimum of - getFastestInterval() and getInterval().

-
-
Returns
-
  • fastest interval in milliseconds, exact -
-
- -
-
- - - - -
-

- - public - - - - - long - - getInterval - () -

-
-
- - - -
-
- - - - -

Get the desired interval of this request, in milliseconds.

-
-
Returns
-
  • desired interval in milliseconds, inexact -
-
- -
-
- - - - -
-

- - public - - - - - long - - getMaxWaitTime - () -

-
-
- - - -
-
- - - - -

Gets the maximum wait time in milliseconds for location updates. If the wait time - is smaller than the interval requested with setInterval(long), then the interval - will be used instead.

-
-
Returns
-
  • maximum wait time in milliseconds, inexact
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - int - - getNumUpdates - () -

-
-
- - - -
-
- - - - -

Get the number of updates requested. - -

By default this is MAX_VALUE, which indicates that locations are updated - until the request is explicitly removed.

-
-
Returns
-
  • number of updates -
-
- -
-
- - - - -
-

- - public - - - - - int - - getPriority - () -

-
-
- - - -
-
- - - - -

Get the quality of the request.

-
-
Returns
-
  • an accuracy constant -
-
- -
-
- - - - -
-

- - public - - - - - float - - getSmallestDisplacement - () -

-
-
- - - -
-
- - - - -

Get the minimum displacement between location updates in meters - -

By default this is 0.

-
-
Returns
-
  • minimum displacement between location updates in meters -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setExpirationDuration - (long millis) -

-
-
- - - -
-
- - - - -

Set the duration of this request, in milliseconds. - -

The duration begins immediately (and not when the request is passed to the location - client), so call this method again if the request is re-used at a later time. - -

The location client will automatically stop updates after the request expires. - -

The duration includes suspend time. Values less than 0 are allowed, but indicate that - the request has already expired.

-
-
Parameters
- - - - -
millis - duration of request in milliseconds
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setExpirationTime - (long millis) -

-
-
- - - -
-
- - - - -

Set the request expiration time, in millisecond since boot. - -

This expiration time uses the same time base as elapsedRealtime(). - -

The location client will automatically stop updates after the request expires. - -

The duration includes suspend time. Values before elapsedRealtime() - are allowed, but indicate that the request has already expired.

-
-
Parameters
- - - - -
millis - expiration time of request, in milliseconds since boot including suspend
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setFastestInterval - (long millis) -

-
-
- - - -
-
- - - - -

Explicitly set the fastest interval for location updates, in milliseconds. - -

This controls the fastest rate at which your application will receive location updates, - which might be faster than setInterval(long) in some situations (for example, if other - applications are triggering location updates). - -

This allows your application to passively acquire locations at a rate faster than it - actively acquires locations, saving power. - -

Unlike setInterval(long), this parameter is exact. Your application will never - receive updates faster than this value. - -

If you don't call this method, a fastest interval will be selected for you. It will be - a value faster than your active interval (setInterval(long)). - -

An interval of 0 is allowed, but not recommended, since location updates may be - extremely fast on future implementations. - -

If setFastestInterval(long) is set slower than setInterval(long), then your - effective fastest interval is setInterval(long).

-
-
Parameters
- - - - -
millis - fastest interval for updates in milliseconds, exact
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if the interval is less than zero
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setInterval - (long millis) -

-
-
- - - -
-
- - - - -

Set the desired interval for active location updates, in milliseconds. - -

The location client will actively try to obtain location updates for your application - at this interval, so it has a direct influence on the amount of power used by your - application. Choose your interval wisely. - -

This interval is inexact. You may not receive updates at all (if no location sources - are available), or you may receive them slower than requested. You may also receive them - faster than requested (if other applications are requesting location at a faster interval). - The fastest rate that you will receive updates can be controlled with - setFastestInterval(long). By default this fastest rate is 6x the interval frequency. - -

Applications with only the coarse location permission may have their interval silently - throttled. - -

An interval of 0 is allowed, but not recommended, since location updates may be extremely - fast on future implementations. - -

setPriority(int) and setInterval(long) are the most important parameters - on a location request.

-
-
Parameters
- - - - -
millis - desired interval in millisecond, inexact
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if the interval is less than zero
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setMaxWaitTime - (long millis) -

-
-
- - - -
-
- - - - -

Sets the maximum wait time in milliseconds for location updates. - -

If you pass a value at least 2x larger than the interval specified with - setInterval(long), then location delivery may be delayed and multiple locations can - be delivered at once. Locations are determined at the setInterval(long) rate, but can be - delivered in batch after the interval you set in this method. This can consume less battery - and give more accurate locations, depending on the device's hardware capabilities. You - should set this value to be as large as possible for your needs if you don't need - immediate location delivery.

-
-
Parameters
- - - - -
millis - desired maximum wait time in millisecond, inexact
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if the interval is less than zero
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setNumUpdates - (int numUpdates) -

-
-
- - - -
-
- - - - -

Set the number of location updates. - -

By default locations are continuously updated until the request is explicitly removed, - however you can optionally request a set number of updates. For example, if your - application only needs a single fresh location, then call this method with a value of 1 - before passing the request to the location client. - -

When using this option care must be taken to either explicitly remove the request - when no longer needed or to set an expiration with (setExpirationDuration(long) or - setExpirationTime(long). Otherwise in some cases if a location can't be computed, this - request could stay active indefinitely consuming power.

-
-
Parameters
- - - - -
numUpdates - the number of location updates requested
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if numUpdates is 0 or less
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setPriority - (int priority) -

-
-
- - - -
-
- - - - -

Set the priority of the request. - -

Use with a priority constant such as PRIORITY_HIGH_ACCURACY. No other values - are accepted. - -

The priority of the request is a strong hint to the LocationClient for which location - sources to use. For example, PRIORITY_HIGH_ACCURACY is more likely to use GPS, and - PRIORITY_BALANCED_POWER_ACCURACY is more likely to use WIFI & Cell tower - positioning, but it also depends on many other factors (such as which sources are available) - and is implementation dependent. - -

setPriority(int) and setInterval(long) are the most important parameters - on a location request.

-
-
Parameters
- - - - -
priority - an accuracy or power constant
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if the quality constant is not valid
-
- -
-
- - - - -
-

- - public - - - - - LocationRequest - - setSmallestDisplacement - (float smallestDisplacementMeters) -

-
-
- - - -
-
- - - - -

Set the minimum displacement between location updates in meters - -

By default this is 0.

-
-
Parameters
- - - - -
smallestDisplacementMeters - the smallest displacement in meters the user must move - between location updates.
-
-
-
Returns
-
  • the same object, so that setters can be chained -
-
-
-
Throws
- - - - -
IllegalArgumentException - if smallestDisplacementMeters is negative
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationResult.html b/docs/html/reference/com/google/android/gms/location/LocationResult.html deleted file mode 100644 index b9305b0e04af..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationResult.html +++ /dev/null @@ -1,1999 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationResult

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationResult
- - - - - - - -
- - -

Class Overview

-

A data class representing a geographic location result from the fused location provider. - -

All locations returned by getLocations() are guaranteed to have a valid latitude, - longitude, and UTC timestamp. On API level 17 or later they are also guaranteed to have - elapsed real-time since boot. All other parameters are optional. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - LocationResultCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - LocationResult - - create(List<Location> locations) - -
- Creates a LocationResult for the given locations. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object other) - -
- - - - static - - LocationResult - - extractResult(Intent intent) - -
- Extracts the LocationResult from an Intent. - - - -
- -
- - - - - - Location - - getLastLocation() - -
- Returns the most recent location available in this result, or null if no locations - are available. - - - -
- -
- - - - - - List<Location> - - getLocations() - -
- Returns locations computed, ordered from oldest to newest. - - - -
- -
- - - - static - - boolean - - hasResult(Intent intent) - -
- Returns true if an Intent contains a LocationResult. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel parcel, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - LocationResultCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - LocationResult - - create - (List<Location> locations) -

-
-
- - - -
-
- - - - -

Creates a LocationResult for the given locations. -

- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - LocationResult - - extractResult - (Intent intent) -

-
-
- - - -
-
- - - - -

Extracts the LocationResult from an Intent. - -

This is a utility function which extracts the LocationResult - from the extras of an Intent that was sent from the fused location provider.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - Location - - getLastLocation - () -

-
-
- - - -
-
- - - - -

Returns the most recent location available in this result, or null if no locations - are available. -

- -
-
- - - - -
-

- - public - - - - - List<Location> - - getLocations - () -

-
-
- - - -
-
- - - - -

Returns locations computed, ordered from oldest to newest. - -

No duplicate locations will be returned to any given listener (i.e. locations will not - overlap in time between subsequent calls to a listener). -

- -
-
- - - - -
-

- - public - static - - - - boolean - - hasResult - (Intent intent) -

-
-
- - - -
-
- - - - -

Returns true if an Intent contains a LocationResult. - -

This is a utility function that can be called from inside an intent - receiver to make sure the received intent is from the fused location provider.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel parcel, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationServices.html b/docs/html/reference/com/google/android/gms/location/LocationServices.html deleted file mode 100644 index 57beb69ae2bd..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationServices.html +++ /dev/null @@ -1,1450 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationServices | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

LocationServices

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationServices
- - - - - - - -
- - -

Class Overview

-

The main entry point for location services integration. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Token to pass to addApi(Api) to enable LocationServices. - - - -
- public - static - - FusedLocationProviderApiFusedLocationApi - Entry point to the fused location APIs. - - - -
- public - static - - GeofencingApiGeofencingApi - Entry point to the geofencing APIs. - - - -
- public - static - - SettingsApiSettingsApi - Entry point to the location settings-enabler dialog APIs. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable LocationServices. -

- - -
-
- - - - - -
-

- - public - static - - FusedLocationProviderApi - - FusedLocationApi -

-
- - - - -
-
- - - - -

Entry point to the fused location APIs. -

- - -
-
- - - - - -
-

- - public - static - - GeofencingApi - - GeofencingApi -

-
- - - - -
-
- - - - -

Entry point to the geofencing APIs. -

- - -
-
- - - - - -
-

- - public - static - - SettingsApi - - SettingsApi -

-
- - - - -
-
- - - - -

Entry point to the location settings-enabler dialog APIs. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.Builder.html b/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.Builder.html deleted file mode 100644 index c6aa83689144..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.Builder.html +++ /dev/null @@ -1,1615 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSettingsRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

LocationSettingsRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationSettingsRequest.Builder
- - - - - - - -
- - -

Class Overview

-

A builder that builds LocationSettingsRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LocationSettingsRequest.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LocationSettingsRequest.Builder - - addAllLocationRequests(Collection<LocationRequest> requests) - -
- Adds a collection of LocationRequests that the client is - interested in. - - - -
- -
- - - - - - LocationSettingsRequest.Builder - - addLocationRequest(LocationRequest request) - -
- Adds one LocationRequest that the client is interested in. - - - -
- -
- - - - - - LocationSettingsRequest - - build() - -
- Creates a LocationSettingsRequest that can be used with SettingsApi. - - - -
- -
- - - - - - LocationSettingsRequest.Builder - - setAlwaysShow(boolean show) - -
- Always show the dialog, without the "Never" option to suppress future dialogs from this - app. - - - -
- -
- - - - - - LocationSettingsRequest.Builder - - setNeedBle(boolean needBle) - -
- Sets whether the client wants BLE to be enabled. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LocationSettingsRequest.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LocationSettingsRequest.Builder - - addAllLocationRequests - (Collection<LocationRequest> requests) -

-
-
- - - -
-
- - - - -

Adds a collection of LocationRequests that the client is - interested in. Settings will be checked for optimal performance of all - LocationRequests. -

- -
-
- - - - -
-

- - public - - - - - LocationSettingsRequest.Builder - - addLocationRequest - (LocationRequest request) -

-
-
- - - -
-
- - - - -

Adds one LocationRequest that the client is interested in. - Settings will be checked for optimal performance of all - LocationRequests. -

- -
-
- - - - -
-

- - public - - - - - LocationSettingsRequest - - build - () -

-
-
- - - -
-
- - - - -

Creates a LocationSettingsRequest that can be used with SettingsApi. -

- -
-
- - - - -
-

- - public - - - - - LocationSettingsRequest.Builder - - setAlwaysShow - (boolean show) -

-
-
- - - -
-
- - - - -

Always show the dialog, without the "Never" option to suppress future dialogs from this - app. When this flag is set to true, the dialog will show up if the location settings do - not satisfy the request, even if a user has previously chosen "Never". - - NOTE: Only use this method if your dialog is the result of an explicit user-initiated - action that requires location to proceed. Canceling this dialog should also cancel the - initiated action. -

- -
-
- - - - -
-

- - public - - - - - LocationSettingsRequest.Builder - - setNeedBle - (boolean needBle) -

-
-
- - - -
-
- - - - -

Sets whether the client wants BLE to be enabled. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.html b/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.html deleted file mode 100644 index ab4764ce4a3a..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationSettingsRequest.html +++ /dev/null @@ -1,1581 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSettingsRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationSettingsRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationSettingsRequest
- - - - - - - -
- - -

Class Overview

-

Specifies the types of location services the client is interested in using. - Settings will be checked for optimal functionality of all requested services. - Use LocationSettingsRequest.Builder to construct this object. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classLocationSettingsRequest.Builder - A builder that builds LocationSettingsRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<LocationSettingsRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<LocationSettingsRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationSettingsResult.html b/docs/html/reference/com/google/android/gms/location/LocationSettingsResult.html deleted file mode 100644 index 024d0b1aaab2..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationSettingsResult.html +++ /dev/null @@ -1,1738 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSettingsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationSettingsResult

- - - - - extends Object
- - - - - - - implements - - Parcelable - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationSettingsResult
- - - - - - - -
- - -

Class Overview

-

Result of checking settings via checkLocationSettings(GoogleApiClient, LocationSettingsRequest), - indicates whether a dialog should be shown to ask the user's consent to - change their settings. - - The method getStatus() can be be used to confirm if the request was successful. If the - current location settings don't satisfy the app's requirements and the user has permission to - change the settings, the app could use startResolutionForResult(Activity, int) - to start an intent to show a dialog, asking for user's consent to change the settings. - - The current location settings states can be accessed via getLocationSettingsStates(). - See LocationSettingsResult for more details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - LocationSettingsResultCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - LocationSettingsStates - - getLocationSettingsStates() - -
- Retrieves the location settings states. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - LocationSettingsResultCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LocationSettingsStates - - getLocationSettingsStates - () -

-
-
- - - -
-
- - - - -

Retrieves the location settings states. -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationSettingsStates.html b/docs/html/reference/com/google/android/gms/location/LocationSettingsStates.html deleted file mode 100644 index 358a331c0862..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationSettingsStates.html +++ /dev/null @@ -1,2062 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSettingsStates | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationSettingsStates

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationSettingsStates
- - - - - - - -
- - -

Class Overview

-

Stores the current states of all location-related settings. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<LocationSettingsStates>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - static - - LocationSettingsStates - - fromIntent(Intent intent) - -
- Retrieves the location settings states from the intent extras. - - - -
- -
- - - - - - boolean - - isBlePresent() - -
- Whether BLE is present on the device. - - - -
- -
- - - - - - boolean - - isBleUsable() - -
- Whether BLE is enabled and is usable by the app. - - - -
- -
- - - - - - boolean - - isGpsPresent() - -
- Whether GPS provider is present on the device. - - - -
- -
- - - - - - boolean - - isGpsUsable() - -
- Whether GPS provider is enabled and is usable by the app. - - - -
- -
- - - - - - boolean - - isLocationPresent() - -
- Whether location is present on the device. - - - -
- -
- - - - - - boolean - - isLocationUsable() - -
- Whether location is enabled and is usable by the app. - - - -
- -
- - - - - - boolean - - isNetworkLocationPresent() - -
- Whether network location provider is present on the device. - - - -
- -
- - - - - - boolean - - isNetworkLocationUsable() - -
- Whether network location provider is enabled and usable by the app. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<LocationSettingsStates> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - LocationSettingsStates - - fromIntent - (Intent intent) -

-
-
- - - -
-
- - - - -

Retrieves the location settings states from the intent extras. - When the location settings dialog finishes, you can use this method to retrieve the current - location settings states from the intent in your - onActivityResult(int, int, Intent); -

- -
-
- - - - -
-

- - public - - - - - boolean - - isBlePresent - () -

-
-
- - - -
-
- - - - -

Whether BLE is present on the device. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isBleUsable - () -

-
-
- - - -
-
- - - - -

Whether BLE is enabled and is usable by the app. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isGpsPresent - () -

-
-
- - - -
-
- - - - -

Whether GPS provider is present on the device. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isGpsUsable - () -

-
-
- - - -
-
- - - - -

Whether GPS provider is enabled and is usable by the app. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isLocationPresent - () -

-
-
- - - -
-
- - - - -

Whether location is present on the device. - - This method returns true when either GPS or network location provider is present. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isLocationUsable - () -

-
-
- - - -
-
- - - - -

Whether location is enabled and is usable by the app. - - This method returns true when either GPS or network location provider is usable. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isNetworkLocationPresent - () -

-
-
- - - -
-
- - - - -

Whether network location provider is present on the device. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isNetworkLocationUsable - () -

-
-
- - - -
-
- - - - -

Whether network location provider is enabled and usable by the app. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationSettingsStatusCodes.html b/docs/html/reference/com/google/android/gms/location/LocationSettingsStatusCodes.html deleted file mode 100644 index 531be89ddcc7..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationSettingsStatusCodes.html +++ /dev/null @@ -1,1686 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSettingsStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

LocationSettingsStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.location.LocationSettingsStatusCodes
- - - - - - - -
- - -

Class Overview

-

Location settings specific status codes, for use in getStatusCode() -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSETTINGS_CHANGE_UNAVAILABLE - Location settings can't be changed to meet the requirements, no dialog pops up - - - - -
intUSER_LOCATION_REPORTING_UNAVAILABLE - User location reporting not available, no dialog pops up - - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - SETTINGS_CHANGE_UNAVAILABLE -

-
- - - - -
-
- - - - -

Location settings can't be changed to meet the requirements, no dialog pops up -

- - -
- Constant Value: - - - 8502 - (0x00002136) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - USER_LOCATION_REPORTING_UNAVAILABLE -

-
- - - - -
-
- - - - -

User location reporting not available, no dialog pops up -

- - -
- Constant Value: - - - 8503 - (0x00002137) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/LocationStatusCodes.html b/docs/html/reference/com/google/android/gms/location/LocationStatusCodes.html deleted file mode 100644 index a6b4d9d43d4a..000000000000 --- a/docs/html/reference/com/google/android/gms/location/LocationStatusCodes.html +++ /dev/null @@ -1,1540 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LocationStatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.LocationStatusCodes
- - - - - - - -
-

-

- This class is deprecated.
- Use GeofenceStatusCodes. - -

- -

Class Overview

-

Status codes that can be returned to listeners to indicate the success or failure of an - operation.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intERROR - An unspecified error occurred; no more specific information is available. - - - -
intGEOFENCE_NOT_AVAILABLE - Geofence service is not available now. - - - -
intGEOFENCE_TOO_MANY_GEOFENCES - Your app has registered more than 100 geofences. - - - -
intGEOFENCE_TOO_MANY_PENDING_INTENTS - You have provided more than 5 different PendingIntents to the - addGeofences(com.google.android.gms.common.api.GoogleApiClient, GeofencingRequest, PendingIntent) - call. - - - -
intSUCCESS - The operation was successful. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ERROR -

-
- - - - -
-
- - - - -

An unspecified error occurred; no more specific information is available. - The device logs may provide additional data. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_NOT_AVAILABLE -

-
- - - - -
-
- - - - -

Geofence service is not available now. Typically this is because the - user turned off location access in settings > location access. -

- - -
- Constant Value: - - - 1000 - (0x000003e8) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TOO_MANY_GEOFENCES -

-
- - - - -
-
- - - - -

Your app has registered more than 100 geofences. Remove unused ones - before adding new geofences. -

- - -
- Constant Value: - - - 1001 - (0x000003e9) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GEOFENCE_TOO_MANY_PENDING_INTENTS -

-
- - - - -
-
- - - - -

You have provided more than 5 different PendingIntents to the - addGeofences(com.google.android.gms.common.api.GoogleApiClient, GeofencingRequest, PendingIntent) - call. -

- - -
- Constant Value: - - - 1002 - (0x000003ea) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

The operation was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/SettingsApi.html b/docs/html/reference/com/google/android/gms/location/SettingsApi.html deleted file mode 100644 index 49ef4fa6709c..000000000000 --- a/docs/html/reference/com/google/android/gms/location/SettingsApi.html +++ /dev/null @@ -1,1196 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SettingsApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SettingsApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.SettingsApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with the location settings-enabler APIs. - -

This API makes it easy for an app to ensure that the device's system settings are properly - configured for the app's location needs. - -

When making a request to location services, the device's system settings may be in a state - that prevents an app from obtaining the location data that it needs. For example, GPS or Wi-Fi - scanning may be switched off. This intent makes it easy to: - -

    -
  • Determine if the relevant system settings are enabled on the device to carry out the desired - location request. -
  • Optionally, invoke a dialog that allows the user to enable the necessary location settings - with a single tap. -
- -

To use this API, first create a GoogleApiClient which supports at least - LocationServices.API. Then connect the client to Google Play - services: - - 

- mGoogleApiClient = new GoogleApiClient.Builder(context)
-     .addApi(LocationServices.API)
-     .addConnectionCallbacks(this)
-     .addOnConnectionFailedListener(this)
-     .build()
- ...
- mGoogleApiClient.connect();
- -

Then create a LocationSettingsRequest.Builder and add all of the - LocationRequests that the app will be using: - - 

- LocationSettingsRequest.Builder builder = new LocationSettingsRequest.Builder()
-     .addLocationRequest(mLocationRequestHighAccuracy)
-     .addLocationRequest(mLocationRequestBalancedPowerAccuracy);
- -

If the client is using BLE scans to derive location, it can request that BLE be enabled by - calling setNeedBle(boolean): - - 

- builder.setNeedBle(true);
- -

Then check whether current location settings are satisfied: - - 

- PendingResult<LocationSettingsResult> result =
-         LocationServices.SettingsApi.checkLocationSettings(mGoogleClient, builder.build());
- -

When the PendingResult returns, the client can check the location settings by looking - at the status code from the LocationSettingsResult object. The client can also retrieve - the current state of the relevant location settings by calling - getLocationSettingsStates(): - - 

- result.setResultCallback(new ResultCallback<LocationSettingsResult>() {
-     @Override
-     public void onResult(LocationSettingsResult result) {
-         final Status status = result.getStatus();
-         final LocationSettingsStates = result.getLocationSettingsStates();
-         switch (status.getStatusCode()) {
-             case LocationSettingsStatusCodes.SUCCESS:
-                 // All location settings are satisfied. The client can initialize location
-                 // requests here.
-                 ...
-                 break;
-             case LocationSettingsStatusCodes.RESOLUTION_REQUIRED:
-                 // Location settings are not satisfied. But could be fixed by showing the user
-                 // a dialog.
-                 try {
-                     // Show the dialog by calling startResolutionForResult(),
-                     // and check the result in onActivityResult().
-                     status.startResolutionForResult(
-                         OuterClass.this,
-                         REQUEST_CHECK_SETTINGS);
-                 } catch (SendIntentException e) {
-                     // Ignore the error.
-                 }
-                 break;
-             case LocationSettingsStatusCodes.SETTINGS_CHANGE_UNAVAILABLE:
-                 // Location settings are not satisfied. However, we have no way to fix the
-                 // settings so we won't show the dialog.
-                 ...
-                 break;
-         }
-     }
- });
- -

If the status code is RESOLUTION_REQUIRED, the client can - call startResolutionForResult(Activity, int) to bring up a dialog, asking for - user's permission to modify the location settings to satisfy those requests. The result of the - dialog will be returned via onActivityResult(int, int, Intent). If the client is interested in - which location providers are available, it can retrieve a LocationSettingsStates from the - Intent by calling fromIntent(Intent): - - 

- @Override
- protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-     final LocationSettingsStates states = LocationSettingsStates.fromIntent(intent);
-     switch (requestCode) {
-         case REQUEST_CHECK_SETTINGS:
-             switch (resultCode) {
-                 case Activity.RESULT_OK:
-                     // All required changes were successfully made
-                     ...
-                     break;
-                 case Activity.RESULT_CANCELED:
-                     // The user was asked to change settings, but chose not to
-                     ...
-                     break;
-                 default:
-                     break;
-             }
-             break;
-     }
- }
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<LocationSettingsResult> - - checkLocationSettings(GoogleApiClient client, LocationSettingsRequest locationSettingsRequest) - -
- Checks if the relevant system settings are enabled on the device to - carry out the desired location requests. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<LocationSettingsResult> - - checkLocationSettings - (GoogleApiClient client, LocationSettingsRequest locationSettingsRequest) -

-
-
- - - -
-
- - - - -

Checks if the relevant system settings are enabled on the device to - carry out the desired location requests.

-
-
Parameters
- - - - - - - -
client - an existing GoogleApiClient. It does not need to be connected at the time of - this call, but the result will be delayed until the connection is complete.
locationSettingsRequest - an object that contains all the location requirements that the - client is interested in.
-
-
-
Returns
-
  • result containing the status of the request. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/package-summary.html b/docs/html/reference/com/google/android/gms/location/package-summary.html deleted file mode 100644 index 25663bba9e39..000000000000 --- a/docs/html/reference/com/google/android/gms/location/package-summary.html +++ /dev/null @@ -1,1170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.location | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.location

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ActivityRecognitionApi - The main entry point for interacting with activity recognition.  - - - -
FusedLocationProviderApi - The main entry point for interacting with the fused location provider.  - - - -
Geofence - Represents a geographical region, also known as a geofence.  - - - -
GeofencingApi - The main entry point for interacting with the geofencing APIs.  - - - -
LocationListener - Used for receiving notifications from the FusedLocationProviderApi when the location - has changed.  - - - -
SettingsApi - The main entry point for interacting with the location settings-enabler APIs.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ActivityRecognition - The main entry point for activity recognition integration.  - - - -
ActivityRecognitionResult - Result of an activity recognition.  - - - -
DetectedActivity - The detected activity of the device with an an associated confidence.  - - - -
Geofence.Builder - A builder that builds Geofence.  - - - -
GeofenceStatusCodes - Geofence specific status codes, for use in getStatusCode() -  - - - -
GeofencingEvent - Represents an event from the GeofencingApi API.  - - - -
GeofencingRequest - Specifies the list of geofences to be monitored and how the geofence notifications should be - reported.  - - - -
GeofencingRequest.Builder - A builder that builds GeofencingRequest.  - - - -
LocationAvailability - Status on the availability of location data  - - - -
LocationCallback - Used for receiving notifications from the FusedLocationProviderApi when the device - location has changed or can no longer be determined.  - - - -
LocationRequest - A data object that contains quality of service parameters for requests to - the FusedLocationProviderApi.  - - - -
LocationResult - A data class representing a geographic location result from the fused location provider.  - - - -
LocationServices - The main entry point for location services integration.  - - - -
LocationSettingsRequest - Specifies the types of location services the client is interested in using.  - - - -
LocationSettingsRequest.Builder - A builder that builds LocationSettingsRequest.  - - - -
LocationSettingsResult - Result of checking settings via checkLocationSettings(GoogleApiClient, LocationSettingsRequest), - indicates whether a dialog should be shown to ask the user's consent to - change their settings.  - - - -
LocationSettingsStates - Stores the current states of all location-related settings.  - - - -
LocationSettingsStatusCodes - Location settings specific status codes, for use in getStatusCode() -  - - - -
LocationStatusCodes - - This class is deprecated. - Use GeofenceStatusCodes. -  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/AddPlaceRequest.html b/docs/html/reference/com/google/android/gms/location/places/AddPlaceRequest.html deleted file mode 100644 index 02dd871b5ca4..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/AddPlaceRequest.html +++ /dev/null @@ -1,2008 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AddPlaceRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AddPlaceRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.AddPlaceRequest
- - - - - - - -
- - -

Class Overview

-

Represents a Place that you would like to add to Google’s Places database. For example, - this may be a place that a user has added in your app. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AddPlaceRequest(String name, LatLng latLng, String address, List<Integer> placeTypes, String phoneNumber) - -
- Constructor for AddPlaceRequest. - - - -
- -
- - - - - - - - AddPlaceRequest(String name, LatLng latLng, String address, List<Integer> placeTypes, Uri uri) - -
- Constructor for AddPlaceRequest. - - - -
- -
- - - - - - - - AddPlaceRequest(String name, LatLng latLng, String address, List<Integer> placeTypes, String phoneNumber, Uri uri) - -
- Constructor for AddPlaceRequest. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getAddress() - -
- - - - - - LatLng - - getLatLng() - -
- - - - - - String - - getName() - -
- - - - - - String - - getPhoneNumber() - -
- - - - - - List<Integer> - - getPlaceTypes() - -
- - - - - - Uri - - getWebsiteUri() - -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AddPlaceRequest - (String name, LatLng latLng, String address, List<Integer> placeTypes, String phoneNumber) -

-
-
- - - -
-
- - - - -

Constructor for AddPlaceRequest.

-
-
Parameters
- - - - - - - - - - - - - - - - -
name - the full textual name of the business, point of interest, or other place. Limited - to 255 characters.
latLng - specifies the location of the place.
address - human-readable address of the place. If a place has a well-formatted, - human-readable address, it is more likely to pass the moderation process for inclusion - in the Google Places database.
placeTypes - list of place types that characterize this place. For a list of available - place types, see the documentation for the Place interface.
phoneNumber - the phone number of this place. -
-
- -
-
- - - - -
-

- - public - - - - - - - AddPlaceRequest - (String name, LatLng latLng, String address, List<Integer> placeTypes, Uri uri) -

-
-
- - - -
-
- - - - -

Constructor for AddPlaceRequest.

-
-
Parameters
- - - - - - - - - - - - - - - - -
name - the full textual name of the business, point of interest, or other place. Limited - to 255 characters.
latLng - specifies the location of the place.
address - human-readable address of the place. If a place has a well-formatted, - human-readable address, it is more likely to pass the moderation process for inclusion - in the Google Places database.
placeTypes - list of place types that characterize this place. For a list of available - place types, see the documentation for the Place interface.
uri - containing the address of the authoritative website for this place, such as a - business home page. If a place has a well-formatted website address, it is more likely - to pass the moderation process for inclusion in the Google Places database. -
-
- -
-
- - - - -
-

- - public - - - - - - - AddPlaceRequest - (String name, LatLng latLng, String address, List<Integer> placeTypes, String phoneNumber, Uri uri) -

-
-
- - - -
-
- - - - -

Constructor for AddPlaceRequest.

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
name - the full textual name of the business, point of interest, or other place. Limited - to 255 characters.
latLng - specifies the location of the place.
address - human-readable address of the place. If a place has a well-formatted, - human-readable address, it is more likely to pass the moderation process for inclusion - in the Google Places database.
placeTypes - list of place types that characterize this place. For a list of available - place types, see the documentation for the Place interface.
phoneNumber - the phone number of this place.
uri - containing the address of the authoritative website for this place, such as a - business home page. If a place has a well-formatted website address, it is more likely - to pass the moderation process for inclusion in the Google Places database. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getAddress - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LatLng - - getLatLng - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getPhoneNumber - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<Integer> - - getPlaceTypes - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Uri - - getWebsiteUri - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/AutocompleteFilter.html b/docs/html/reference/com/google/android/gms/location/places/AutocompleteFilter.html deleted file mode 100644 index 5d1e00d42e5f..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/AutocompleteFilter.html +++ /dev/null @@ -1,1659 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AutocompleteFilter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AutocompleteFilter

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.AutocompleteFilter
- - - - - - - -
- - -

Class Overview

-

Filter for customizing the autocomplete predictions from the Geo Data API. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - AutocompleteFilter - - create(Collection<Integer> placeTypes) - -
- Creates a filter for use with getAutocompletePredictions(GoogleApiClient, String, LatLngBounds, AutocompleteFilter) function. - - - -
- -
- - - - - - boolean - - equals(Object object) - -
- - - - - - Set<Integer> - - getPlaceTypes() - -
- Returns the place types being requested. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - AutocompleteFilter - - create - (Collection<Integer> placeTypes) -

-
-
- - - -
-
- - - - -

Creates a filter for use with getAutocompletePredictions(GoogleApiClient, String, LatLngBounds, AutocompleteFilter) function.

-
-
Parameters
- - - - -
placeTypes - The place types of predictions to be returned. Only places that have a type - in this set will be returned. A null or empty set is the same as a set containing all - possible place types. For a list of available place types, see the list of - supported types. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object object) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Set<Integer> - - getPlaceTypes - () -

-
-
- - - -
-
- - - - -

Returns the place types being requested. If the empty set is returned, it means all place - types are being requested. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.Substring.html b/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.Substring.html deleted file mode 100644 index c7da1f65cdad..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.Substring.html +++ /dev/null @@ -1,1104 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AutocompletePrediction.Substring | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

AutocompletePrediction.Substring

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.AutocompletePrediction.Substring
- - - - - - - -
- - -

Class Overview

-

Represents a matched substring in a query suggestion's description. -

- Each AutocompletePrediction.Substring contains an offset value and a length. These describe the location of - the entered term in the prediction result text, so that the term can be highlighted if - desired. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getLength() - -
- abstract - - - - - int - - getOffset() - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getLength - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getOffset - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.html b/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.html deleted file mode 100644 index 1055346ac209..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/AutocompletePrediction.html +++ /dev/null @@ -1,1387 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AutocompletePrediction | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

AutocompletePrediction

- - - - - - implements - - Freezable<AutocompletePrediction> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.AutocompletePrediction
- - - - - - - -
- - -

Class Overview

-

Represents a query's suggestions and its attributes, like matched substrings. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceAutocompletePrediction.Substring - Represents a matched substring in a query suggestion's description.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDescription() - -
- The description of a predicted place. - - - -
- -
- abstract - - - - - List<? extends AutocompletePrediction.Substring> - - getMatchedSubstrings() - -
- Get a list of matched substrings in a query suggestion's description. - - - -
- -
- abstract - - - - - String - - getPlaceId() - -
- Returns the place ID of the place being referred to by this prediction, or null if this - prediction is not for a place. - - - -
- -
- abstract - - - - - List<Integer> - - getPlaceTypes() - -
- Returns the list of place types associated with the place referred to by - getPlaceId(). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

The description of a predicted place. -

- Examples: -

    - Tacoma, Washington -
      - Taco Bell, Willitis, CA -

- -
-
- - - - -
-

- - public - - - abstract - - List<? extends AutocompletePrediction.Substring> - - getMatchedSubstrings - () -

-
-
- - - -
-
- - - - -

Get a list of matched substrings in a query suggestion's description. -

- Each AutocompletePrediction.Substring contains an offset value and a length. These describe the location of - the entered term in the prediction result text, so that the term can be highlighted if - desired.

-
-
Returns
-
  • a list of matched substrings in a query suggestion's description. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPlaceId - () -

-
-
- - - -
-
- - - - -

Returns the place ID of the place being referred to by this prediction, or null if this - prediction is not for a place. -

- -
-
- - - - -
-

- - public - - - abstract - - List<Integer> - - getPlaceTypes - () -

-
-
- - - -
-
- - - - -

Returns the list of place types associated with the place referred to by - getPlaceId(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/AutocompletePredictionBuffer.html b/docs/html/reference/com/google/android/gms/location/places/AutocompletePredictionBuffer.html deleted file mode 100644 index 2d14e2d4b8a6..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/AutocompletePredictionBuffer.html +++ /dev/null @@ -1,1991 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AutocompletePredictionBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

AutocompletePredictionBuffer

- - - - - - - - - extends AbstractDataBuffer<AutocompletePrediction>
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.location.places.AutocompletePrediction>
    ↳com.google.android.gms.location.places.AutocompletePredictionBuffer
- - - - - - - -
- - -

Class Overview

-

A DataBuffer that represents a list of AutocompletePredictionEntitys. -

- NOTE: The calling application must release() this object after it is done with it to - prevent a memory leak. Refer to the developer's guide - for more information about handling buffers. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - AutocompletePrediction - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - AutocompletePrediction - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/GeoDataApi.html b/docs/html/reference/com/google/android/gms/location/places/GeoDataApi.html deleted file mode 100644 index 23dc2afb14a4..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/GeoDataApi.html +++ /dev/null @@ -1,1244 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeoDataApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

GeoDataApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.GeoDataApi
- - - - - - - -
- - -

Class Overview

-

Main entry point for the Google Geo Data API. - -

- The Geo Data API provides access to Google's database of local place and business information. - A place, generally, is defined as a particular physical space that has a name. The GeoDataApi - provides access to getting places by ID, autocompleting a user's search query by name or - address, and adding places to Google's Places database. Most API methods may involve a - round-trip to a Google server. - -

- Some methods of the GeoDataApi API are subject to a quota limit, as mentioned in the description - of the methods concerned. - -

- See PlacesStatusCodes for detailed information about the error codes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<PlaceBuffer> - - addPlace(GoogleApiClient client, AddPlaceRequest addPlaceRequest) - -
- Add a place to Google's Places database. - - - -
- -
- abstract - - - - - PendingResult<AutocompletePredictionBuffer> - - getAutocompletePredictions(GoogleApiClient client, String query, LatLngBounds bounds, AutocompleteFilter filter) - -
- Get autocomplete predictions for a query, based on the name or address of a place. - - - -
- -
- abstract - - - - - PendingResult<PlaceBuffer> - - getPlaceById(GoogleApiClient client, String... placeIds) - -
- Returns the places for the given placeIds. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<PlaceBuffer> - - addPlace - (GoogleApiClient client, AddPlaceRequest addPlaceRequest) -

-
-
- - - -
-
- - - - -

Add a place to Google's Places database. - -

- By adding a place, you can supplement the data in the Google's database with data from your - application. This allows you to: - -

    -
  1. Instantly update the data in Google's database for your users. -
  2. Submit new places to a moderation queue for addition to the Google places database. -
  3. Differentiate your application from other apps with similar functionality. -
  4. Create applications that are targeted to a specific user base or geographic location. -

-
-
Returns
-
  • a buffer containing the added place. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<AutocompletePredictionBuffer> - - getAutocompletePredictions - (GoogleApiClient client, String query, LatLngBounds bounds, AutocompleteFilter filter) -

-
-
- - - -
-
- - - - -

Get autocomplete predictions for a query, based on the name or address of a place. - -

- Access to this method is subject to quota restrictions.

-
-
Parameters
- - - - - - - - - - -
query - for which the autocomplete predictions are to be fetched.
bounds - for geographically biasing the autocomplete predictions.
filter - criteria for customizing the autocomplete predictions.
-
-
-
Returns
-
  • a PendingResult containing the list of predictions for the query which match the - filter criteria, or an empty list if none match. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<PlaceBuffer> - - getPlaceById - (GoogleApiClient client, String... placeIds) -

-
-
- - - -
-
- - - - -

Returns the places for the given placeIds. -

- Note that the ID for given place, once returned by some Places API call, should always be - valid for passing to this method. However, place IDs can change over time, so the returned - Places may have a different IDs than the ones used for looking it up. This method might - return fewer places than requested if some of the places could not be resolved.

-
-
Parameters
- - - - -
placeIds - the IDs to look up. At least one ID should be provided.
-
-
-
Returns
-
  • a buffer containing the requested places. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/Place.html b/docs/html/reference/com/google/android/gms/location/places/Place.html deleted file mode 100644 index 2740dc27db01..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/Place.html +++ /dev/null @@ -1,8532 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Place | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Place

- - - - - - implements - - Freezable<Place> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.Place
- - - - - - - -
- - -

Class Overview

-

Represents a particular physical place. -

- A Place encapsulates information about a physical location, including its name, address, and any - other information we might have about it. -

- Note that generally some fields will be inapplicable to certain places, or the information may be - unknown. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTYPE_ACCOUNTING - - - - -
intTYPE_ADMINISTRATIVE_AREA_LEVEL_1 - - - - -
intTYPE_ADMINISTRATIVE_AREA_LEVEL_2 - - - - -
intTYPE_ADMINISTRATIVE_AREA_LEVEL_3 - - - - -
intTYPE_AIRPORT - - - - -
intTYPE_AMUSEMENT_PARK - - - - -
intTYPE_AQUARIUM - - - - -
intTYPE_ART_GALLERY - - - - -
intTYPE_ATM - - - - -
intTYPE_BAKERY - - - - -
intTYPE_BANK - - - - -
intTYPE_BAR - - - - -
intTYPE_BEAUTY_SALON - - - - -
intTYPE_BICYCLE_STORE - - - - -
intTYPE_BOOK_STORE - - - - -
intTYPE_BOWLING_ALLEY - - - - -
intTYPE_BUS_STATION - - - - -
intTYPE_CAFE - - - - -
intTYPE_CAMPGROUND - - - - -
intTYPE_CAR_DEALER - - - - -
intTYPE_CAR_RENTAL - - - - -
intTYPE_CAR_REPAIR - - - - -
intTYPE_CAR_WASH - - - - -
intTYPE_CASINO - - - - -
intTYPE_CEMETERY - - - - -
intTYPE_CHURCH - - - - -
intTYPE_CITY_HALL - - - - -
intTYPE_CLOTHING_STORE - - - - -
intTYPE_COLLOQUIAL_AREA - - - - -
intTYPE_CONVENIENCE_STORE - - - - -
intTYPE_COUNTRY - - - - -
intTYPE_COURTHOUSE - - - - -
intTYPE_DENTIST - - - - -
intTYPE_DEPARTMENT_STORE - - - - -
intTYPE_DOCTOR - - - - -
intTYPE_ELECTRICIAN - - - - -
intTYPE_ELECTRONICS_STORE - - - - -
intTYPE_EMBASSY - - - - -
intTYPE_ESTABLISHMENT - - - - -
intTYPE_FINANCE - - - - -
intTYPE_FIRE_STATION - - - - -
intTYPE_FLOOR - - - - -
intTYPE_FLORIST - - - - -
intTYPE_FOOD - - - - -
intTYPE_FUNERAL_HOME - - - - -
intTYPE_FURNITURE_STORE - - - - -
intTYPE_GAS_STATION - - - - -
intTYPE_GENERAL_CONTRACTOR - - - - -
intTYPE_GEOCODE - - - - -
intTYPE_GROCERY_OR_SUPERMARKET - - - - -
intTYPE_GYM - - - - -
intTYPE_HAIR_CARE - - - - -
intTYPE_HARDWARE_STORE - - - - -
intTYPE_HEALTH - - - - -
intTYPE_HINDU_TEMPLE - - - - -
intTYPE_HOME_GOODS_STORE - - - - -
intTYPE_HOSPITAL - - - - -
intTYPE_INSURANCE_AGENCY - - - - -
intTYPE_INTERSECTION - - - - -
intTYPE_JEWELRY_STORE - - - - -
intTYPE_LAUNDRY - - - - -
intTYPE_LAWYER - - - - -
intTYPE_LIBRARY - - - - -
intTYPE_LIQUOR_STORE - - - - -
intTYPE_LOCALITY - - - - -
intTYPE_LOCAL_GOVERNMENT_OFFICE - - - - -
intTYPE_LOCKSMITH - - - - -
intTYPE_LODGING - - - - -
intTYPE_MEAL_DELIVERY - - - - -
intTYPE_MEAL_TAKEAWAY - - - - -
intTYPE_MOSQUE - - - - -
intTYPE_MOVIE_RENTAL - - - - -
intTYPE_MOVIE_THEATER - - - - -
intTYPE_MOVING_COMPANY - - - - -
intTYPE_MUSEUM - - - - -
intTYPE_NATURAL_FEATURE - - - - -
intTYPE_NEIGHBORHOOD - - - - -
intTYPE_NIGHT_CLUB - - - - -
intTYPE_OTHER - - - - -
intTYPE_PAINTER - - - - -
intTYPE_PARK - - - - -
intTYPE_PARKING - - - - -
intTYPE_PET_STORE - - - - -
intTYPE_PHARMACY - - - - -
intTYPE_PHYSIOTHERAPIST - - - - -
intTYPE_PLACE_OF_WORSHIP - - - - -
intTYPE_PLUMBER - - - - -
intTYPE_POINT_OF_INTEREST - - - - -
intTYPE_POLICE - - - - -
intTYPE_POLITICAL - - - - -
intTYPE_POSTAL_CODE - - - - -
intTYPE_POSTAL_CODE_PREFIX - - - - -
intTYPE_POSTAL_TOWN - - - - -
intTYPE_POST_BOX - - - - -
intTYPE_POST_OFFICE - - - - -
intTYPE_PREMISE - - - - -
intTYPE_REAL_ESTATE_AGENCY - - - - -
intTYPE_RESTAURANT - - - - -
intTYPE_ROOFING_CONTRACTOR - - - - -
intTYPE_ROOM - - - - -
intTYPE_ROUTE - - - - -
intTYPE_RV_PARK - - - - -
intTYPE_SCHOOL - - - - -
intTYPE_SHOE_STORE - - - - -
intTYPE_SHOPPING_MALL - - - - -
intTYPE_SPA - - - - -
intTYPE_STADIUM - - - - -
intTYPE_STORAGE - - - - -
intTYPE_STORE - - - - -
intTYPE_STREET_ADDRESS - - - - -
intTYPE_SUBLOCALITY - - - - -
intTYPE_SUBLOCALITY_LEVEL_1 - - - - -
intTYPE_SUBLOCALITY_LEVEL_2 - - - - -
intTYPE_SUBLOCALITY_LEVEL_3 - - - - -
intTYPE_SUBLOCALITY_LEVEL_4 - - - - -
intTYPE_SUBLOCALITY_LEVEL_5 - - - - -
intTYPE_SUBPREMISE - - - - -
intTYPE_SUBWAY_STATION - - - - -
intTYPE_SYNAGOGUE - - - - -
intTYPE_SYNTHETIC_GEOCODE - - - - -
intTYPE_TAXI_STAND - - - - -
intTYPE_TRAIN_STATION - - - - -
intTYPE_TRANSIT_STATION - - - - -
intTYPE_TRAVEL_AGENCY - - - - -
intTYPE_UNIVERSITY - - - - -
intTYPE_VETERINARY_CARE - - - - -
intTYPE_ZOO - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - CharSequence - - getAddress() - -
- Returns a human readable address for this Place. - - - -
- -
- abstract - - - - - String - - getId() - -
- Returns the unique id of this Place. - - - -
- -
- abstract - - - - - LatLng - - getLatLng() - -
- Returns the location of this Place. - - - -
- -
- abstract - - - - - Locale - - getLocale() - -
- Returns the locale in which the names and addresses were localized. - - - -
- -
- abstract - - - - - CharSequence - - getName() - -
- Returns the name of this Place. - - - -
- -
- abstract - - - - - CharSequence - - getPhoneNumber() - -
- Returns the place's phone number in international format. - - - -
- -
- abstract - - - - - List<Integer> - - getPlaceTypes() - -
- Returns a list of place types for this Place. - - - -
- -
- abstract - - - - - int - - getPriceLevel() - -
- Returns the price level for this place on a scale from 0 (cheapest) to 4. - - - -
- -
- abstract - - - - - float - - getRating() - -
- Returns the place's rating, from 1.0 to 5.0, based on aggregated user reviews. - - - -
- -
- abstract - - - - - LatLngBounds - - getViewport() - -
- Returns a viewport for displaying this Place. - - - -
- -
- abstract - - - - - Uri - - getWebsiteUri() - -
- Returns the URI of the website of this Place. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - TYPE_ACCOUNTING -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ADMINISTRATIVE_AREA_LEVEL_1 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1001 - (0x000003e9) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ADMINISTRATIVE_AREA_LEVEL_2 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1002 - (0x000003ea) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ADMINISTRATIVE_AREA_LEVEL_3 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1003 - (0x000003eb) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_AIRPORT -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_AMUSEMENT_PARK -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_AQUARIUM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ART_GALLERY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ATM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BAKERY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BANK -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BAR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 9 - (0x00000009) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BEAUTY_SALON -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 10 - (0x0000000a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BICYCLE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 11 - (0x0000000b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BOOK_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 12 - (0x0000000c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BOWLING_ALLEY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 13 - (0x0000000d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_BUS_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 14 - (0x0000000e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAFE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 15 - (0x0000000f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAMPGROUND -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 16 - (0x00000010) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAR_DEALER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 17 - (0x00000011) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAR_RENTAL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 18 - (0x00000012) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAR_REPAIR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 19 - (0x00000013) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CAR_WASH -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 20 - (0x00000014) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CASINO -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 21 - (0x00000015) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CEMETERY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 22 - (0x00000016) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CHURCH -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 23 - (0x00000017) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CITY_HALL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 24 - (0x00000018) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CLOTHING_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 25 - (0x00000019) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_COLLOQUIAL_AREA -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1004 - (0x000003ec) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_CONVENIENCE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 26 - (0x0000001a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_COUNTRY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1005 - (0x000003ed) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_COURTHOUSE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 27 - (0x0000001b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_DENTIST -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 28 - (0x0000001c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_DEPARTMENT_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 29 - (0x0000001d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_DOCTOR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 30 - (0x0000001e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ELECTRICIAN -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 31 - (0x0000001f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ELECTRONICS_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 32 - (0x00000020) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_EMBASSY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 33 - (0x00000021) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ESTABLISHMENT -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 34 - (0x00000022) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FINANCE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 35 - (0x00000023) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FIRE_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 36 - (0x00000024) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FLOOR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1006 - (0x000003ee) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FLORIST -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 37 - (0x00000025) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FOOD -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 38 - (0x00000026) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FUNERAL_HOME -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 39 - (0x00000027) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_FURNITURE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 40 - (0x00000028) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GAS_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 41 - (0x00000029) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GENERAL_CONTRACTOR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 42 - (0x0000002a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GEOCODE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1007 - (0x000003ef) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GROCERY_OR_SUPERMARKET -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 43 - (0x0000002b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_GYM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 44 - (0x0000002c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HAIR_CARE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 45 - (0x0000002d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HARDWARE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 46 - (0x0000002e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HEALTH -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 47 - (0x0000002f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HINDU_TEMPLE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 48 - (0x00000030) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HOME_GOODS_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 49 - (0x00000031) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_HOSPITAL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 50 - (0x00000032) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_INSURANCE_AGENCY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 51 - (0x00000033) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_INTERSECTION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1008 - (0x000003f0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_JEWELRY_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 52 - (0x00000034) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LAUNDRY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 53 - (0x00000035) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LAWYER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 54 - (0x00000036) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LIBRARY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 55 - (0x00000037) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LIQUOR_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 56 - (0x00000038) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LOCALITY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1009 - (0x000003f1) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LOCAL_GOVERNMENT_OFFICE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 57 - (0x00000039) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LOCKSMITH -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 58 - (0x0000003a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_LODGING -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 59 - (0x0000003b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MEAL_DELIVERY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 60 - (0x0000003c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MEAL_TAKEAWAY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 61 - (0x0000003d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MOSQUE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 62 - (0x0000003e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MOVIE_RENTAL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 63 - (0x0000003f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MOVIE_THEATER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 64 - (0x00000040) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MOVING_COMPANY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 65 - (0x00000041) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_MUSEUM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 66 - (0x00000042) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_NATURAL_FEATURE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1010 - (0x000003f2) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_NEIGHBORHOOD -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1011 - (0x000003f3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_NIGHT_CLUB -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 67 - (0x00000043) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_OTHER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PAINTER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 68 - (0x00000044) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PARK -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 69 - (0x00000045) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PARKING -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 70 - (0x00000046) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PET_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 71 - (0x00000047) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PHARMACY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 72 - (0x00000048) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PHYSIOTHERAPIST -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 73 - (0x00000049) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PLACE_OF_WORSHIP -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 74 - (0x0000004a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PLUMBER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 75 - (0x0000004b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POINT_OF_INTEREST -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1013 - (0x000003f5) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POLICE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 76 - (0x0000004c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POLITICAL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1012 - (0x000003f4) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POSTAL_CODE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1015 - (0x000003f7) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POSTAL_CODE_PREFIX -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1016 - (0x000003f8) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POSTAL_TOWN -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1017 - (0x000003f9) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POST_BOX -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1014 - (0x000003f6) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_POST_OFFICE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 77 - (0x0000004d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_PREMISE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1018 - (0x000003fa) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_REAL_ESTATE_AGENCY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 78 - (0x0000004e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_RESTAURANT -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 79 - (0x0000004f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ROOFING_CONTRACTOR -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 80 - (0x00000050) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ROOM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1019 - (0x000003fb) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ROUTE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1020 - (0x000003fc) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_RV_PARK -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 81 - (0x00000051) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SCHOOL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 82 - (0x00000052) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SHOE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 83 - (0x00000053) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SHOPPING_MALL -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 84 - (0x00000054) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SPA -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 85 - (0x00000055) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_STADIUM -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 86 - (0x00000056) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_STORAGE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 87 - (0x00000057) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_STORE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 88 - (0x00000058) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_STREET_ADDRESS -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1021 - (0x000003fd) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1022 - (0x000003fe) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY_LEVEL_1 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1023 - (0x000003ff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY_LEVEL_2 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1024 - (0x00000400) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY_LEVEL_3 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1025 - (0x00000401) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY_LEVEL_4 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1026 - (0x00000402) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBLOCALITY_LEVEL_5 -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1027 - (0x00000403) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBPREMISE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1028 - (0x00000404) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SUBWAY_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 89 - (0x00000059) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SYNAGOGUE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 90 - (0x0000005a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_SYNTHETIC_GEOCODE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1029 - (0x00000405) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TAXI_STAND -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 91 - (0x0000005b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TRAIN_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 92 - (0x0000005c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TRANSIT_STATION -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1030 - (0x00000406) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_TRAVEL_AGENCY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 93 - (0x0000005d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_UNIVERSITY -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 94 - (0x0000005e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_VETERINARY_CARE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 95 - (0x0000005f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_ZOO -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 96 - (0x00000060) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - CharSequence - - getAddress - () -

-
-
- - - -
-
- - - - -

Returns a human readable address for this Place. May return null if the address is unknown. -

- The address is localized according to the locale returned by getLocale(). -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

Returns the unique id of this Place. -

- This ID can be passed to getPlaceById(GoogleApiClient, String...) to lookup the same place at a later - time, but it is not guaranteed that such a lookup will succeed (the place may no longer exist - in our database). It is possible that the returned Place in such a lookup will have a - different ID (so there may be multiple ID's for one given place). -

- -
-
- - - - -
-

- - public - - - abstract - - LatLng - - getLatLng - () -

-
-
- - - -
-
- - - - -

Returns the location of this Place. -

- The location is not necessarily the center of the Place, or any particular entry or exit - point, but some arbitrarily chosen point within the geographic extent of the Place. -

- -
-
- - - - -
-

- - public - - - abstract - - Locale - - getLocale - () -

-
-
- - - -
-
- - - - -

Returns the locale in which the names and addresses were localized. -

- -
-
- - - - -
-

- - public - - - abstract - - CharSequence - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name of this Place. -

- The name is localized according to the locale returned by getLocale(). -

- -
-
- - - - -
-

- - public - - - abstract - - CharSequence - - getPhoneNumber - () -

-
-
- - - -
-
- - - - -

Returns the place's phone number in international format. Returns null if no phone number is - known, or the place has no phone number. -

- International format includes the country code, and is prefixed with the plus (+) sign. For - example, the international phone number for Google's Mountain View, USA office is +1 - 650-253-0000. -

- -
-
- - - - -
-

- - public - - - abstract - - List<Integer> - - getPlaceTypes - () -

-
-
- - - -
-
- - - - -

Returns a list of place types for this Place. -

- The elements of this list are drawn from Place.TYPE_* constants, though one should - expect there could be new place types returned that were introduced after an app was - published. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getPriceLevel - () -

-
-
- - - -
-
- - - - -

Returns the price level for this place on a scale from 0 (cheapest) to 4. -

- If no price level is known, a negative value is returned. -

- The price level of the place, on a scale of 0 to 4. The exact amount indicated by a specific - value will vary from region to region. Price levels are interpreted as follows: -

    -
  • 0 — Free -
  • 1 — Inexpensive -
  • 2 — Moderate -
  • 3 — Expensive -
  • 4 — Very Expensive -
-

- -
-
- - - - -
-

- - public - - - abstract - - float - - getRating - () -

-
-
- - - -
-
- - - - -

Returns the place's rating, from 1.0 to 5.0, based on aggregated user reviews. -

- If no rating is known, a negative value is returned. -

- -
-
- - - - -
-

- - public - - - abstract - - LatLngBounds - - getViewport - () -

-
-
- - - -
-
- - - - -

Returns a viewport for displaying this Place. May return null if the size of the place is not - known. -

- This returns a viewport of a size that is suitable for displaying this Place. For example, a - Place representing a store may have a relatively small viewport, while a Place representing a - country may have a very large viewport. -

- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getWebsiteUri - () -

-
-
- - - -
-
- - - - -

Returns the URI of the website of this Place. Returns null if no website is known. -

- This is the URI of the website maintained by the Place, if available. Note this is a - third-party website not affiliated with the Places API. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceBuffer.html b/docs/html/reference/com/google/android/gms/location/places/PlaceBuffer.html deleted file mode 100644 index 84bc9e341699..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceBuffer.html +++ /dev/null @@ -1,2007 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlaceBuffer

- - - - - - - - - extends AbstractDataBuffer<Place>
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.location.places.Place>
    ↳com.google.android.gms.location.places.PlaceBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of Places. -

- NOTE: The calling application must release() this object after it is done with it to - prevent a memory leak. Refer to the developer's guide - for more information about handling buffers. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Place - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - CharSequence - - getAttributions() - -
- Returns the attributions to be shown to the user. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Place - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - CharSequence - - getAttributions - () -

-
-
- - - -
-
- - - - -

Returns the attributions to be shown to the user. -

- We recommend placing this information below any place information. See the - Google - Places API Policies for more details.

-
-
Returns
-
  • attributions in HTML format, or null if there are no attributions to display. -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceDetectionApi.html b/docs/html/reference/com/google/android/gms/location/places/PlaceDetectionApi.html deleted file mode 100644 index 250952f530ad..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceDetectionApi.html +++ /dev/null @@ -1,1168 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceDetectionApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

PlaceDetectionApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.PlaceDetectionApi
- - - - - - - -
- - -

Class Overview

-

Main entry point for the Google Place Detection API. - -

- The Place Detection API provides quick access to the device's current place, and offers the - opportunity to report the location of the device at a particular place (like a check in). - -

- Some methods of the PlaceDetectionAPI are subject to a quota limit, as mentioned in the - description of the methods concerned. - -

- See PlacesStatusCodes for detailed information about the error codes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<PlaceLikelihoodBuffer> - - getCurrentPlace(GoogleApiClient client, PlaceFilter filter) - -
- Returns an estimate of the place where the device is currently known to be located. - - - -
- -
- abstract - - - - - PendingResult<Status> - - reportDeviceAtPlace(GoogleApiClient client, PlaceReport report) - -
- Report that the device is currently at a particular place. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<PlaceLikelihoodBuffer> - - getCurrentPlace - (GoogleApiClient client, PlaceFilter filter) -

-
-
- - - -
-
- - - - -

Returns an estimate of the place where the device is currently known to be located. - -

- Generates a PlaceLikelihoodBuffer based on the device's last estimated location. Only places - which match the given filter will be returned. If the filter requests only coarse place - types, results may be obtained at lower latency and power cost, especially over repeated - calls. - -

- The returned values may be obtained by means of a network lookup. The results are a best - guess and are not guaranteed to be meaningful or correct. - -

- This API requires the calling application to have the - ACCESS_FINE_LOCATION permission. - -

- Access to this method is subject to quota restrictions.

-
-
Parameters
- - - - -
filter - filtering criteria for the results. If the filter is null, then default - filtering parameters are used (see PlaceFilter)
-
-
-
Returns
-
  • the PlaceLikelihoodBuffer, which may be empty if the place or location is not known - or does not match the filtering criteria -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - reportDeviceAtPlace - (GoogleApiClient client, PlaceReport report) -

-
-
- - - -
-
- - - - -

Report that the device is currently at a particular place.

-
-
Parameters
- - - - -
report - to be uploaded to the server. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceFilter.html b/docs/html/reference/com/google/android/gms/location/places/PlaceFilter.html deleted file mode 100644 index 1d99566ec924..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceFilter.html +++ /dev/null @@ -1,1849 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceFilter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlaceFilter

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.PlaceFilter
- - - - - - - -
- - -

Class Overview

-

Criteria for filtering results from the Google Place Detection API. - -

- A PlaceFilter allows you to restrict results to only those places that are of interest to them. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlaceFilter() - -
- Construct a PlaceFilter object without any constraints, i.e. - - - -
- -
- - - - - - - - PlaceFilter(boolean requireOpenNow, Collection<String> restrictToPlaceIds) - -
- Construct a PlaceFilter object. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object object) - -
- - - - - - Set<String> - - getPlaceIds() - -
- Returns the PlaceIds being requested. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isRestrictedToPlacesOpenNow() - -
- Return true if results are restricted to only places that are open now. - - - -
- -
- - - - - - boolean - - matches(Place place) - -
- Verifies whether the given Place matches all the restrictions defined by this filter. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlaceFilter - () -

-
-
- - - -
-
- - - - -

Construct a PlaceFilter object without any constraints, i.e. all places will match - this filter. -

- -
-
- - - - -
-

- - public - - - - - - - PlaceFilter - (boolean requireOpenNow, Collection<String> restrictToPlaceIds) -

-
-
- - - -
-
- - - - -

Construct a PlaceFilter object.

-
-
Parameters
- - - - - - - -
requireOpenNow - if true, return only places open now
restrictToPlaceIds - the specific PlaceIds to match -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object object) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Set<String> - - getPlaceIds - () -

-
-
- - - -
-
- - - - -

Returns the PlaceIds being requested. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isRestrictedToPlacesOpenNow - () -

-
-
- - - -
-
- - - - -

Return true if results are restricted to only places that are open now. -

- -
-
- - - - -
-

- - public - - - - - boolean - - matches - (Place place) -

-
-
- - - -
-
- - - - -

Verifies whether the given Place matches all the restrictions defined by this filter. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihood.html b/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihood.html deleted file mode 100644 index b9c232f6c78a..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihood.html +++ /dev/null @@ -1,1236 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceLikelihood | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

PlaceLikelihood

- - - - - - implements - - Freezable<PlaceLikelihood> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.location.places.PlaceLikelihood
- - - - - - - -
- - -

Class Overview

-

Represents a Place and the relative likelihood of the place being the best match within - the list of returned places for a single request. - -

- For more about likelihoods, see PlaceLikelihoodBuffer. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - float - - getLikelihood() - -
- Returns a value from 0.0 to 1.0 indicating the confidence that the user is at this place. - - - -
- -
- abstract - - - - - Place - - getPlace() - -
- Returns the place contained in this PlaceLikelihood. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - float - - getLikelihood - () -

-
-
- - - -
-
- - - - -

Returns a value from 0.0 to 1.0 indicating the confidence that the user is at this place. -

- The larger the value the more confident we are of the place returned. For example, a - likelihood of 0.75 means that the user is at least 75% likely to be at this place. -

- -
-
- - - - -
-

- - public - - - abstract - - Place - - getPlace - () -

-
-
- - - -
-
- - - - -

Returns the place contained in this PlaceLikelihood. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihoodBuffer.html b/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihoodBuffer.html deleted file mode 100644 index 8ee9995565b5..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceLikelihoodBuffer.html +++ /dev/null @@ -1,2064 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceLikelihoodBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlaceLikelihoodBuffer

- - - - - - - - - extends AbstractDataBuffer<PlaceLikelihood>
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.location.places.PlaceLikelihood>
    ↳com.google.android.gms.location.places.PlaceLikelihoodBuffer
- - - - - - - -
- - -

Class Overview

-

A DataBuffer that represents a list of PlaceLikelihoods. -

- A PlaceLikelihoodBuffer may contain a number of candidate Places, and an associated likelihood - for each Place being the correct Place. For example, the Places service may be uncertain what the - true Place is, but think it 55% likely to be PlaceA, and 35% likely to be PlaceB. The - corresponding PlaceLikelihoodBuffer has two members, one with likelihood 0.55 and the other with - likelihood 0.35. -

- The likelihoods are not guaranteed to be correct, and in a given PlaceLikelihoodBuffer they may - not sum to 1.0. -

- NOTE: The calling application must release() this object after it is done with it to - prevent a memory leak. Refer to the developer's guide - for more information about handling buffers. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PlaceLikelihood - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - CharSequence - - getAttributions() - -
- Returns the attributions to be shown to the user. - - - -
- -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PlaceLikelihood - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - CharSequence - - getAttributions - () -

-
-
- - - -
-
- - - - -

Returns the attributions to be shown to the user. -

- We recommend placing this information below any search results or place information. See the - Google - Places API Policies for more details.

-
-
Returns
-
  • attributions in HTML format, or null if there are no attributions to display. -
-
- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceReport.html b/docs/html/reference/com/google/android/gms/location/places/PlaceReport.html deleted file mode 100644 index 4b53c13ef89e..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceReport.html +++ /dev/null @@ -1,1881 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceReport | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlaceReport

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.PlaceReport
- - - - - - - -
- - -

Class Overview

-

An indication from the client that the device is currently located at a particular place. This is - usually triggered by a user action (e.g. check-in at a venue, Wallet tap to pay at a business) - such that we have strong confidence of the device's presence at that place. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - PlaceReportCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - PlaceReport - - create(String placeId, String tag) - -
- Creates a PlaceReport. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object that) - -
- - - - - - String - - getPlaceId() - -
- Identifies a particular place in the world. - - - -
- -
- - - - - - String - - getTag() - -
- Defines an app-specific context for the flow that triggered the report, such as - "redeem-offer" etc. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - PlaceReportCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - PlaceReport - - create - (String placeId, String tag) -

-
-
- - - -
-
- - - - -

Creates a PlaceReport.

-
-
Parameters
- - - - - - - -
placeId - ID of the place associated to this report
tag - an app-specific context for the flow that triggered the report, such as - "redeem-offer" etc. The maximum size is 4k, longer values will be silently truncated. -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object that) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getPlaceId - () -

-
-
- - - -
-
- - - - -

Identifies a particular place in the world. -

- -
-
- - - - -
-

- - public - - - - - String - - getTag - () -

-
-
- - - -
-
- - - - -

Defines an app-specific context for the flow that triggered the report, such as - "redeem-offer" etc. The maximum size is 4k, longer values will be silently truncated. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlaceTypes.html b/docs/html/reference/com/google/android/gms/location/places/PlaceTypes.html deleted file mode 100644 index ff7718e6db22..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlaceTypes.html +++ /dev/null @@ -1,1306 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlaceTypes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlaceTypes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.PlaceTypes
- - - - - - - -
- - -

Class Overview

-

Convenient groupings of place types. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Set<Integer>ALL - All place types that are known to the system. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Set<Integer> - - ALL -

-
- - - - -
-
- - - - -

All place types that are known to the system. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/Places.html b/docs/html/reference/com/google/android/gms/location/places/Places.html deleted file mode 100644 index 3aaced86b3e9..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/Places.html +++ /dev/null @@ -1,1448 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Places | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Places

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.Places
- - - - - - - -
- - -

Class Overview

-

The main entry point for apps to integrate with the Google Places service. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<PlacesOptions>GEO_DATA_API - Token to pass to addApi(Api) to enable GeoData features. - - - -
- public - static - final - GeoDataApiGeoDataApi - Methods and interfaces related to the Places API. - - - -
- public - static - final - Api<PlacesOptions>PLACE_DETECTION_API - Token to pass to addApi(Api) to enable PlaceDetection features. - - - -
- public - static - final - PlaceDetectionApiPlaceDetectionApi - Methods and interfaces related to the PlaceDetection API. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<PlacesOptions> - - GEO_DATA_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable GeoData features. -

- - -
-
- - - - - -
-

- - public - static - final - GeoDataApi - - GeoDataApi -

-
- - - - -
-
- - - - -

Methods and interfaces related to the Places API.

- - -
-
- - - - - -
-

- - public - static - final - Api<PlacesOptions> - - PLACE_DETECTION_API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable PlaceDetection features. -

- - -
-
- - - - - -
-

- - public - static - final - PlaceDetectionApi - - PlaceDetectionApi -

-
- - - - -
-
- - - - -

Methods and interfaces related to the PlaceDetection API.

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.Builder.html b/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.Builder.html deleted file mode 100644 index c3a83869cc52..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.Builder.html +++ /dev/null @@ -1,1367 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlacesOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

PlacesOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.PlacesOptions.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlacesOptions.Builder() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PlacesOptions - - build() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlacesOptions.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PlacesOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.html b/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.html deleted file mode 100644 index 2ed7a54e0b5f..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlacesOptions.html +++ /dev/null @@ -1,1301 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlacesOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlacesOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.Optional - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.PlacesOptions
- - - - - - - -
- - -

Class Overview

-

API configuration parameters for Places API. - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlacesOptions.Builder -   - - - -
- - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/PlacesStatusCodes.html b/docs/html/reference/com/google/android/gms/location/places/PlacesStatusCodes.html deleted file mode 100644 index bf5d8e30ef08..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/PlacesStatusCodes.html +++ /dev/null @@ -1,2024 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlacesStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlacesStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.location.places.PlacesStatusCodes
- - - - - - - -
- - -

Class Overview

-

Places API specific status codes, for use in getStatusCode() -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intACCESS_NOT_CONFIGURED - Operation failed due to an invalid quota project. - - - -
intDEVICE_RATE_LIMIT_EXCEEDED - The per-device rate limit (QPS limit) for the device has been exceeded. - - - -
intINVALID_ARGUMENT - Operation failed due to an invalid argument. - - - -
intKEY_EXPIRED - Operation failed due to an expired API key. - - - -
intKEY_INVALID - Operation failed due to an invalid API key. - - - -
intRATE_LIMIT_EXCEEDED - The overall rate limit (QPS limit) for the developer has been exceeded. - - - -
intUSAGE_LIMIT_EXCEEDED - The usage limit has been exceeded (could be daily or some other period). - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ACCESS_NOT_CONFIGURED -

-
- - - - -
-
- - - - -

Operation failed due to an invalid quota project. -

- - -
- Constant Value: - - - 9003 - (0x0000232b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DEVICE_RATE_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

The per-device rate limit (QPS limit) for the device has been exceeded. -

- - -
- Constant Value: - - - 9006 - (0x0000232e) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVALID_ARGUMENT -

-
- - - - -
-
- - - - -

Operation failed due to an invalid argument. -

- - -
- Constant Value: - - - 9004 - (0x0000232c) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - KEY_EXPIRED -

-
- - - - -
-
- - - - -

Operation failed due to an expired API key. -

- - -
- Constant Value: - - - 9007 - (0x0000232f) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - KEY_INVALID -

-
- - - - -
-
- - - - -

Operation failed due to an invalid API key. -

- - -
- Constant Value: - - - 9002 - (0x0000232a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RATE_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

The overall rate limit (QPS limit) for the developer has been exceeded. -

- - -
- Constant Value: - - - 9005 - (0x0000232d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - USAGE_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

The usage limit has been exceeded (could be daily or some other period). -

- - -
- Constant Value: - - - 9001 - (0x00002329) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • untranslated debug (not user-friendly!) string based on the current status code. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/package-summary.html b/docs/html/reference/com/google/android/gms/location/places/package-summary.html deleted file mode 100644 index 22ecd8d06ca0..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/package-summary.html +++ /dev/null @@ -1,1084 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.location.places | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.location.places

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AutocompletePrediction - Represents a query's suggestions and its attributes, like matched substrings.  - - - -
AutocompletePrediction.Substring - Represents a matched substring in a query suggestion's description.  - - - -
GeoDataApi - Main entry point for the Google Geo Data API.  - - - -
Place - Represents a particular physical place.  - - - -
PlaceDetectionApi - Main entry point for the Google Place Detection API.  - - - -
PlaceLikelihood - Represents a Place and the relative likelihood of the place being the best match within - the list of returned places for a single request.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AddPlaceRequest - Represents a Place that you would like to add to Google’s Places database.  - - - -
AutocompleteFilter - Filter for customizing the autocomplete predictions from the Geo Data API.  - - - -
AutocompletePredictionBuffer - A DataBuffer that represents a list of AutocompletePredictionEntitys.  - - - -
PlaceBuffer - Data structure providing access to a list of Places.  - - - -
PlaceFilter - Criteria for filtering results from the Google Place Detection API.  - - - -
PlaceLikelihoodBuffer - A DataBuffer that represents a list of PlaceLikelihoods.  - - - -
PlaceReport - An indication from the client that the device is currently located at a particular place.  - - - -
Places - The main entry point for apps to integrate with the Google Places service.  - - - -
PlacesOptions - API configuration parameters for Places API.  - - - -
PlacesOptions.Builder -   - - - -
PlacesStatusCodes - Places API specific status codes, for use in getStatusCode() -  - - - -
PlaceTypes - Convenient groupings of place types.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.IntentBuilder.html b/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.IntentBuilder.html deleted file mode 100644 index dc8bdd6db2b5..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.IntentBuilder.html +++ /dev/null @@ -1,1468 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlacePicker.IntentBuilder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

PlacePicker.IntentBuilder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.ui.PlacePicker.IntentBuilder
- - - - - - - -
- - -

Class Overview

-

Builder for a Place Picker launch intent. -

- After setting the optional parameters, call build(Context) and pass the intent to - startActivityForResult(android.content.Intent, int). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlacePicker.IntentBuilder() - -
- Create a new builder for launching the Place Picker UI. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Intent - - build(Context context) - -
- Retrieve the Intent as configured so far by the Builder. - - - -
- -
- - - - - - PlacePicker.IntentBuilder - - setLatLngBounds(LatLngBounds latLngBounds) - -
- Sets a starting LatLngBounds for the map. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlacePicker.IntentBuilder - () -

-
-
- - - -
-
- - - - -

Create a new builder for launching the Place Picker UI. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Intent - - build - (Context context) -

-
-
- - - -
-
- - - - -

Retrieve the Intent as configured so far by the Builder.

-
-
Returns
-
  • The current Intent being configured by this builder.
-
-
-
Throws
- - - - - - - - - - -
- GooglePlayServicesNotAvailableException
GooglePlayServicesRepairableException -
GooglePlayServicesNotAvailableException -
-
- -
-
- - - - -
-

- - public - - - - - PlacePicker.IntentBuilder - - setLatLngBounds - (LatLngBounds latLngBounds) -

-
-
- - - -
-
- - - - -

Sets a starting LatLngBounds for the map. - This will be used in the initial query. - If unspecified, starts at the device's current location. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.html b/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.html deleted file mode 100644 index 5fbeec34d703..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/ui/PlacePicker.html +++ /dev/null @@ -1,1610 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlacePicker | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlacePicker

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.location.places.ui.PlacePicker
- - - - - - - -
- - -

Class Overview

-

The Place Picker UI is a dialog that allows a user to pick a Place using an interactive - map. -

- Users can select the place they are at, or a place nearby. Apps can also initialize the map to a - particular viewport. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlacePicker.IntentBuilder - Builder for a Place Picker launch intent.  - - - -
- - - - - - - - - - - -
Constants
intRESULT_ERROR - Indicates that an error occurred. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlacePicker() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getAttributions(Intent intent) - -
- Returns an HTML string with required attributions that must be shown whenever the data in the - selected Place is used. - - - -
- -
- - - - static - - LatLngBounds - - getLatLngBounds(Intent intent) - -
- Returns the last LatLngBounds of the map if a selection was made. - - - -
- -
- - - - static - - Place - - getPlace(Intent intent, Context context) - -
- Retrieves the selected Place from the result intent. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - RESULT_ERROR -

-
- - - - -
-
- - - - -

Indicates that an error occurred. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlacePicker - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getAttributions - (Intent intent) -

-
-
- - - -
-
- - - - -

Returns an HTML string with required attributions that must be shown whenever the data in the - selected Place is used. - Please refer to the developer's guide for more information about attribution. - - One easy way to render this content is with a TextView: - 

-     String attributions = PlacePicker.getAttributions(selectedPlace);
-     TextView attributionsTextView = findViewById(R.id.attributions);
-     attributionsTextView.setText(Html.fromHtml(attributions))
-
-

- -
-
- - - - -
-

- - public - static - - - - LatLngBounds - - getLatLngBounds - (Intent intent) -

-
-
- - - -
-
- - - - -

Returns the last LatLngBounds of the map if a selection was made. -

- -
-
- - - - -
-

- - public - static - - - - Place - - getPlace - (Intent intent, Context context) -

-
-
- - - -
-
- - - - -

Retrieves the selected Place from the result intent.

-
-
Returns
-
  • The selected Place or null if no selection was made -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/location/places/ui/package-summary.html b/docs/html/reference/com/google/android/gms/location/places/ui/package-summary.html deleted file mode 100644 index 3108c76eb801..000000000000 --- a/docs/html/reference/com/google/android/gms/location/places/ui/package-summary.html +++ /dev/null @@ -1,897 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.location.places.ui | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.location.places.ui

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - -
PlacePicker - The Place Picker UI is a dialog that allows a user to pick a Place using an interactive - map.  - - - -
PlacePicker.IntentBuilder - Builder for a Place Picker launch intent.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html b/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html deleted file mode 100644 index a057d17abfd9..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html +++ /dev/null @@ -1,1254 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CameraUpdate | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CameraUpdate

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.CameraUpdate
- - - - - - - -
- - -

Class Overview

-

Defines a camera move. An object of this type can be used to modify a map's camera by calling - animateCamera(CameraUpdate), - animateCamera(CameraUpdate, GoogleMap.CancelableCallback) or - moveCamera(CameraUpdate). -

- To obtain a CameraUpdate use the factory class CameraUpdateFactory. -

- For example, to zoom in on a map, you can use the following code: - 

 GoogleMap map = ...;
-   map.animateCamera(CameraUpdateFactory.zoomIn());
-

-

Developer Guide

-

- For more information, read the Changing the View - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html b/docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html deleted file mode 100644 index 5a11b66c6eb8..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html +++ /dev/null @@ -1,2112 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CameraUpdateFactory | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CameraUpdateFactory

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.CameraUpdateFactory
- - - - - - - -
- - -

Class Overview

-

A class containing methods for creating CameraUpdate objects that change a map's camera. - To modify the map's camera, call animateCamera(CameraUpdate), - animateCamera(CameraUpdate, GoogleMap.CancelableCallback) or - moveCamera(CameraUpdate), using a CameraUpdate object created with this - class. -

- For example, to zoom in on a map, you can use the following code: - 

 GoogleMap map = ...;
-   map.animateCamera(CameraUpdateFactory.zoomIn());
-

- Prior to using any methods from this class, you must do one of the following to ensure that this - class is initialized: -

-

-

Developer Guide

-

- For more information, read the Changing the View - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - CameraUpdate - - newCameraPosition(CameraPosition cameraPosition) - -
- Returns a CameraUpdate that moves the camera to a specified CameraPosition. - - - -
- -
- - - - static - - CameraUpdate - - newLatLng(LatLng latLng) - -
- Returns a CameraUpdate that moves the center of the screen to a latitude and - longitude specified by a LatLng object. - - - -
- -
- - - - static - - CameraUpdate - - newLatLngBounds(LatLngBounds bounds, int padding) - -
- Returns a CameraUpdate that transforms the camera such that the specified - latitude/longitude bounds are centered on screen at the greatest possible zoom level. - - - -
- -
- - - - static - - CameraUpdate - - newLatLngBounds(LatLngBounds bounds, int width, int height, int padding) - -
- Returns a CameraUpdate that transforms the camera such that the specified - latitude/longitude bounds are centered on screen within a bounding box of specified - dimensions at the greatest possible zoom level. - - - -
- -
- - - - static - - CameraUpdate - - newLatLngZoom(LatLng latLng, float zoom) - -
- Returns a CameraUpdate that moves the center of the screen to a latitude and - longitude specified by a LatLng object, and moves to the given zoom level. - - - -
- -
- - - - static - - CameraUpdate - - scrollBy(float xPixel, float yPixel) - -
- Returns a CameraUpdate that scrolls the camera over the map, shifting the center of - view by the specified number of pixels in the x and y directions. - - - -
- -
- - - - static - - CameraUpdate - - zoomBy(float amount, Point focus) - -
- Returns a CameraUpdate that shifts the zoom level of the current camera viewpoint. - - - -
- -
- - - - static - - CameraUpdate - - zoomBy(float amount) - -
- Returns a CameraUpdate that shifts the zoom level of the current camera viewpoint. - - - -
- -
- - - - static - - CameraUpdate - - zoomIn() - -
- Returns a CameraUpdate that zooms in on the map by moving the viewpoint's height - closer to the Earth's surface. - - - -
- -
- - - - static - - CameraUpdate - - zoomOut() - -
- Returns a CameraUpdate that zooms out on the map by moving the viewpoint's height - farther away from the Earth's surface. - - - -
- -
- - - - static - - CameraUpdate - - zoomTo(float zoom) - -
- Returns a CameraUpdate that moves the camera viewpoint to a particular zoom level. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - CameraUpdate - - newCameraPosition - (CameraPosition cameraPosition) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that moves the camera to a specified CameraPosition. - In effect, this creates a transformation from the CameraPosition object's latitude, - longitude, zoom level, bearing and tilt.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - newLatLng - (LatLng latLng) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that moves the center of the screen to a latitude and - longitude specified by a LatLng object. This centers the camera on the LatLng - object.

-
-
Parameters
- - - - -
latLng - a LatLng object containing the desired latitude and longitude.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - newLatLngBounds - (LatLngBounds bounds, int padding) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that transforms the camera such that the specified - latitude/longitude bounds are centered on screen at the greatest possible zoom level. You can - specify padding, in order to inset the bounding box from the map view's edges. The returned - CameraUpdate has a bearing of 0 and a tilt of 0. -

- Do not change the camera with this camera update until the map has undergone layout (in order - for this method to correctly determine the appropriate bounding box and zoom level, the map - must have a size). Otherwise an IllegalStateException will be thrown. It is NOT - sufficient for the map to be available (i.e. getMap() returns a non-null - object); the view containing the map must have also undergone layout such that its dimensions - have been determined. If you cannot be sure that this has occured, use - newLatLngBounds(LatLngBounds, int, int, int) instead and provide the dimensions of - the map manually.

-
-
Parameters
- - - - - - - -
bounds - region to fit on screen
padding - space (in px) to leave between the bounding box edges and the view edges. This - value is applied to all four sides of the bounding box.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - newLatLngBounds - (LatLngBounds bounds, int width, int height, int padding) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that transforms the camera such that the specified - latitude/longitude bounds are centered on screen within a bounding box of specified - dimensions at the greatest possible zoom level. You can specify additional padding, to - further restrict the size of the bounding box. The returned CameraUpdate has a - bearing of 0 and a tilt of 0. -

- Unlike newLatLngBounds(LatLngBounds, int), you can use the CameraUpdate - returned by this method to change the camera prior to the map's the layout phase, because the - arguments specify the desired size of the bounding box.

-
-
Parameters
- - - - - - - - - - - - - -
bounds - the region to fit in the bounding box
width - bounding box width in pixels (px)
height - bounding box height in pixels (px)
padding - additional size restriction (in px) of the bounding box
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - newLatLngZoom - (LatLng latLng, float zoom) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that moves the center of the screen to a latitude and - longitude specified by a LatLng object, and moves to the given zoom level.

-
-
Parameters
- - - - - - - -
latLng - a LatLng object containing the desired latitude and longitude.
zoom - the desired zoom level, in the range of 2.0 to 21.0. Values below this range are - set to 2.0, and values above it are set to 21.0. Increase the value to zoom in. - Not all areas have tiles at the largest zoom levels.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - scrollBy - (float xPixel, float yPixel) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that scrolls the camera over the map, shifting the center of - view by the specified number of pixels in the x and y directions. -

- Examples: -

    -
  • If xPixel = 5 and yPixel = 0, the system scrolls right by moving the camera so that the - map appears to have shifted 5 pixels to the left.
    • -
  • If xPixel = 0 and yPixel = 5, the system scrolls down by moving the camera so that the - map appears to have shifted 5 pixels upwards.
    • -
-

- The scrolling is relative to the camera's current orientation. For example, if the camera is - bearing 90 degrees, then east is "up" and scrolling right will move the camera south.

-
-
Parameters
- - - - - - - -
xPixel - the number of pixels to scroll horizontally. A positive value moves the camera - to the right, with respect to its current orientation. A negative value moves the - camera to the left, with respect to its current orientation.
yPixel - the number of pixels to scroll vertically. A positive value moves the camera - downwards, with respect to its current orientation. A negative value moves the - camera upwards, with respect to its current orientation.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - zoomBy - (float amount, Point focus) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that shifts the zoom level of the current camera viewpoint. -

- A point specified by focus will remain fixed (i.e., it corresponds to the same lat/long both - before and after the zoom process). -

- This method is different to zoomTo(float) in that zoom is relative to the current - camera. -

- For example, if the LatLng (11.11, 22.22) is currently at the screen location (23, - 45). After calling this method with a zoom amount and this LatLng, the screen - location of this LatLng will still be (23, 45).

-
-
Parameters
- - - - - - - -
amount - amount to change the zoom level. Positive values indicate zooming closer to the - surface of the Earth while negative values indicate zooming away from the surface - of the Earth.
focus - pixel location on the screen that is to remain fixed after the zooming process. - The lat/long that was at that pixel location before the camera move will remain - the same after the camera has moved.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - zoomBy - (float amount) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that shifts the zoom level of the current camera viewpoint. -

- This method is different to zoomTo(float) in that zoom is relative to the current - camera.

-
-
Parameters
- - - - -
amount - amount to change the zoom level. Positive values indicate zooming closer to the - surface of the Earth while negative values indicate zooming away from the surface - of the Earth.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - zoomIn - () -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that zooms in on the map by moving the viewpoint's height - closer to the Earth's surface. The zoom increment is 1.0.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - zoomOut - () -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that zooms out on the map by moving the viewpoint's height - farther away from the Earth's surface. The zoom increment is -1.0.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - static - - - - CameraUpdate - - zoomTo - (float zoom) -

-
-
- - - -
-
- - - - -

Returns a CameraUpdate that moves the camera viewpoint to a particular zoom level.

-
-
Parameters
- - - - -
zoom - the desired zoom level, in the range of 2.0 to 21.0. Values below this range are - set to 2.0, and values above it are set to 21.0. Increase the value to zoom in. - Not all areas have tiles at the largest zoom levels. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html deleted file mode 100644 index d74877460864..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html +++ /dev/null @@ -1,1116 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.CancelableCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.CancelableCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.CancelableCallback
- - - - - - - -
- - -

Class Overview

-

A callback interface for reporting when a task is complete or cancelled. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onCancel() - -
- Invoked when a task is cancelled. - - - -
- -
- abstract - - - - - void - - onFinish() - -
- Invoked when a task is complete. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onCancel - () -

-
-
- - - -
-
- - - - -

Invoked when a task is cancelled. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onFinish - () -

-
-
- - - -
-
- - - - -

Invoked when a task is complete. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html deleted file mode 100644 index 09907ba3ddb2..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html +++ /dev/null @@ -1,1173 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.InfoWindowAdapter | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.InfoWindowAdapter

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.InfoWindowAdapter
- - - - - - - -
- - -

Class Overview

-

Provides views for customized rendering of info windows. -

- Methods on this provider are called when it is time to show an info window for a marker, - regardless of the cause (either a user gesture or a programmatic call to - showInfoWindow(). Since there is only one info window shown at any one time, - this provider may choose to reuse views, or it may choose to create new views on each method - invocation. -

- When constructing an info window, methods in this class are called in a defined order. To - replace the default info window, override getInfoWindow(Marker) with your custom rendering - and return null for getInfoContents(Marker). To replace only the info window - contents inside the default info window frame (the callout bubble), return null in - getInfoWindow(Marker) and override getInfoContents(Marker) instead. - -

-

Developer Guide

-

- For more information, read the - Info Windows - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - View - - getInfoContents(Marker marker) - -
- Provides custom contents for the default info window frame of a marker. - - - -
- -
- abstract - - - - - View - - getInfoWindow(Marker marker) - -
- Provides a custom info window for a marker. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - View - - getInfoContents - (Marker marker) -

-
-
- - - -
-
- - - - -

Provides custom contents for the default info window frame of a marker. This method is - only called if getInfoWindow(Marker) first returns null. If this method returns - a view, it will be placed inside the default info window frame. If you change this view - after this method is called, those changes will not necessarily be reflected in the - rendered info window. If this method returns null, the default rendering will be - used instead.

-
-
Parameters
- - - - -
marker - The marker for which an info window is being populated.
-
-
-
Returns
-
  • A custom view to display as contents in the info window for marker, or - null to use the default content rendering instead. -
-
- -
-
- - - - -
-

- - public - - - abstract - - View - - getInfoWindow - (Marker marker) -

-
-
- - - -
-
- - - - -

Provides a custom info window for a marker. If this method returns a view, it is used for - the entire info window. If you change this view after this method is called, those - changes will not necessarily be reflected in the rendered info window. If this method - returns null , the default info window frame will be used, with contents provided - by getInfoContents(Marker).

-
-
Parameters
- - - - -
marker - The marker for which an info window is being populated.
-
-
-
Returns
-
  • A custom info window for marker, or null to use the default - info window frame with custom contents. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html deleted file mode 100644 index da3843370082..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnCameraChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnCameraChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnCameraChangeListener
- - - - - - - -
- - -

Class Overview

-

Defines signatures for methods that are called when the camera changes position. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onCameraChange(CameraPosition position) - -
- Called after the camera position has changed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onCameraChange - (CameraPosition position) -

-
-
- - - -
-
- - - - -

Called after the camera position has changed. During an animation, this listener may not - be notified of intermediate camera positions. It is always called for the final position - in the animation. -

- This is called on the main thread.

-
-
Parameters
- - - - -
position - The CameraPosition at the end of the last camera change. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnIndoorStateChangeListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnIndoorStateChangeListener.html deleted file mode 100644 index 65456e582b16..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnIndoorStateChangeListener.html +++ /dev/null @@ -1,1143 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnIndoorStateChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnIndoorStateChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnIndoorStateChangeListener
- - - - - - - -
- - -

Class Overview

-

A listener for when the indoor state changes. Events are notified on the main thread. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onIndoorBuildingFocused() - -
- The map maintains a notion of focused building, which is the building currently - centered in the viewport or otherwise selected by the user through the UI or the location - provider. - - - -
- -
- abstract - - - - - void - - onIndoorLevelActivated(IndoorBuilding building) - -
- The map keeps track of the active level for each building which has been - visited or otherwise had a level selected. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onIndoorBuildingFocused - () -

-
-
- - - -
-
- - - - -

The map maintains a notion of focused building, which is the building currently - centered in the viewport or otherwise selected by the user through the UI or the location - provider. This callback is called when the focused building changes. -

- This method will only be called after the building data has become available. -

- The focused building is not referenced as a parameter of this method due to - synchronization issues: if multiple focus requests are handled, listeners may be - notified out-of-order, so should rely on getFocusedBuilding() itself to provide the most - up-to-date information. It is possible that more than one onIndoorBuildingFocused call - will be made without the focused building actually changing. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onIndoorLevelActivated - (IndoorBuilding building) -

-
-
- - - -
-
- - - - -

The map keeps track of the active level for each building which has been - visited or otherwise had a level selected. When that level changes, this callback will - be triggered regardless of whether the building is focused or not. This callback is also - called when the default level first becomes available. -

- This method will only be called after the building data has become available.

-
-
Parameters
- - - - -
building - the building for which the active level has changed, never null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html deleted file mode 100644 index 95e1a8cbfb84..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html +++ /dev/null @@ -1,1069 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnInfoWindowClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnInfoWindowClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnInfoWindowClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for click/tap events on a marker's info window. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onInfoWindowClick(Marker marker) - -
- Called when the marker's info window is clicked. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onInfoWindowClick - (Marker marker) -

-
-
- - - -
-
- - - - -

Called when the marker's info window is clicked.

-
-
Parameters
- - - - -
marker - The marker of the info window that was clicked. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html deleted file mode 100644 index ec01176c7592..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html +++ /dev/null @@ -1,1074 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMapClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMapClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMapClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the user taps on the map. -

- Listeners will be invoked on the main thread. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMapClick(LatLng point) - -
- Called when the user makes a tap gesture on the map, but only if none of the overlays of - the map handled the gesture. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMapClick - (LatLng point) -

-
-
- - - -
-
- - - - -

Called when the user makes a tap gesture on the map, but only if none of the overlays of - the map handled the gesture. Implementations of this method are always invoked on the - main thread.

-
-
Parameters
- - - - -
point - The point on the ground (projected from the screen point) that was tapped. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLoadedCallback.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLoadedCallback.html deleted file mode 100644 index a7489932557f..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLoadedCallback.html +++ /dev/null @@ -1,1064 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMapLoadedCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMapLoadedCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMapLoadedCallback
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the map has finished rendering. This occurs after all tiles - required to render the map have been fetched, and all labeling is complete. This event will - not fire if the map never loads due to connectivity issues, or if the map is continuously - changing and never completes loading due to the user constantly interacting with the map. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMapLoaded() - -
- Called when the map has finished rendering. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMapLoaded - () -

-
-
- - - -
-
- - - - -

Called when the map has finished rendering. This will only be called once. You must - request another callback if you want to be notified again. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html deleted file mode 100644 index d90f490cedfc..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html +++ /dev/null @@ -1,1074 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMapLongClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMapLongClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMapLongClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the user long presses on the map. -

- Listeners will be invoked on the main thread. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMapLongClick(LatLng point) - -
- Called when the user makes a long-press gesture on the map, but only if none of the - overlays of the map handled the gesture. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMapLongClick - (LatLng point) -

-
-
- - - -
-
- - - - -

Called when the user makes a long-press gesture on the map, but only if none of the - overlays of the map handled the gesture. Implementations of this method are always - invoked on the main thread.

-
-
Parameters
- - - - -
point - The point on the ground (projected from the screen point) that was pressed. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html deleted file mode 100644 index 1768243e88ba..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html +++ /dev/null @@ -1,1076 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMarkerClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMarkerClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMarkerClickListener
- - - - - - - -
- - -

Class Overview

-

Defines signatures for methods that are called when a marker is clicked or tapped. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - onMarkerClick(Marker marker) - -
- Called when a marker has been clicked or tapped. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - onMarkerClick - (Marker marker) -

-
-
- - - -
-
- - - - -

Called when a marker has been clicked or tapped.

-
-
Parameters
- - - - -
marker - The marker that was clicked.
-
-
-
Returns
-
  • true if the listener has consumed the event (i.e., the default behavior - should not occur), false otherwise (i.e., the default behavior should - occur). The default behavior is for the camera to move to the map and an info - window to appear. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html deleted file mode 100644 index a62a741b5e38..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html +++ /dev/null @@ -1,1203 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMarkerDragListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMarkerDragListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMarkerDragListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for drag events on markers. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMarkerDrag(Marker marker) - -
- Called repeatedly while a marker is being dragged. - - - -
- -
- abstract - - - - - void - - onMarkerDragEnd(Marker marker) - -
- Called when a marker has finished being dragged. - - - -
- -
- abstract - - - - - void - - onMarkerDragStart(Marker marker) - -
- Called when a marker starts being dragged. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMarkerDrag - (Marker marker) -

-
-
- - - -
-
- - - - -

Called repeatedly while a marker is being dragged. The marker's location can be accessed - via getPosition().

-
-
Parameters
- - - - -
marker - The marker being dragged. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onMarkerDragEnd - (Marker marker) -

-
-
- - - -
-
- - - - -

Called when a marker has finished being dragged. The marker's location can be accessed - via getPosition().

-
-
Parameters
- - - - -
marker - The marker that was dragged. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onMarkerDragStart - (Marker marker) -

-
-
- - - -
-
- - - - -

Called when a marker starts being dragged. The marker's location can be accessed via - getPosition(); this position may be different to the position prior to the - start of the drag because the marker is popped up above the touch point.

-
-
Parameters
- - - - -
marker - The marker being dragged. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationButtonClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationButtonClickListener.html deleted file mode 100644 index 5f17e92937ec..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationButtonClickListener.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMyLocationButtonClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMyLocationButtonClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMyLocationButtonClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the My Location button is clicked. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - boolean - - onMyLocationButtonClick() - -
- Called when the my location button is clicked. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - boolean - - onMyLocationButtonClick - () -

-
-
- - - -
-
- - - - -

Called when the my location button is clicked. -

-

Use FusedLocationProviderApi if you need to - obtain the user's current location.

-
-
Returns
-
  • true if the listener has consumed the event (i.e., the default behavior - should not occur), false otherwise (i.e., the default behavior should - occur). The default behavior is for the camera move such that it is centered on - the user location. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationChangeListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationChangeListener.html deleted file mode 100644 index 5932d2f8356a..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMyLocationChangeListener.html +++ /dev/null @@ -1,1081 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.OnMyLocationChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.OnMyLocationChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.OnMyLocationChangeListener
- - - - - - - -
-

-

- This interface is deprecated.
- use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. - -

- -

Class Overview

-

Callback interface for when the My Location dot/chevron (which signifies the user's location) - changes location.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMyLocationChange(Location location) - -
- Called when the Location of the My Location dot has changed (be it latitude/longitude, - bearing or accuracy). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMyLocationChange - (Location location) -

-
-
- - - -
-
- - - - -

Called when the Location of the My Location dot has changed (be it latitude/longitude, - bearing or accuracy).

-
-
Parameters
- - - - -
location - The current location of the My Location dot. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.SnapshotReadyCallback.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.SnapshotReadyCallback.html deleted file mode 100644 index 73bcb744eca4..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.SnapshotReadyCallback.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap.SnapshotReadyCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

GoogleMap.SnapshotReadyCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.GoogleMap.SnapshotReadyCallback
- - - - - - - -
- - -

Class Overview

-

Callback interface to notify when the snapshot has been taken. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onSnapshotReady(Bitmap snapshot) - -
- Invoked when the snapshot has been taken. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onSnapshotReady - (Bitmap snapshot) -

-
-
- - - -
-
- - - - -

Invoked when the snapshot has been taken.

-
-
Parameters
- - - - -
snapshot - A bitmap containing the map as it is currently rendered, or - null if the snapshot could not be taken. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMap.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.html deleted file mode 100644 index c59d041b9626..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMap.html +++ /dev/null @@ -1,4871 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMap | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GoogleMap

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.GoogleMap
- - - - - - - -
- - -

Class Overview

-

This is the main class of the Google Maps Android API and is the entry point for all methods - related to the map. You cannot instantiate a GoogleMap object directly, - rather, you must obtain one from the getMap() method on a MapFragment or - MapView that you have added to your application. -

- Note: Similar to a View object, a GoogleMap can only be read - and modified from the main thread. Calling GoogleMap methods from another thread will - result in an exception. -

-

Developer Guide

-

- To get started, read the Google Maps Android API v2 - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceGoogleMap.CancelableCallback - A callback interface for reporting when a task is complete or cancelled.  - - - -
- - - - - interfaceGoogleMap.InfoWindowAdapter - Provides views for customized rendering of info windows.  - - - -
- - - - - interfaceGoogleMap.OnCameraChangeListener - Defines signatures for methods that are called when the camera changes position.  - - - -
- - - - - interfaceGoogleMap.OnIndoorStateChangeListener - A listener for when the indoor state changes.  - - - -
- - - - - interfaceGoogleMap.OnInfoWindowClickListener - Callback interface for click/tap events on a marker's info window.  - - - -
- - - - - interfaceGoogleMap.OnMapClickListener - Callback interface for when the user taps on the map.  - - - -
- - - - - interfaceGoogleMap.OnMapLoadedCallback - Callback interface for when the map has finished rendering.  - - - -
- - - - - interfaceGoogleMap.OnMapLongClickListener - Callback interface for when the user long presses on the map.  - - - -
- - - - - interfaceGoogleMap.OnMarkerClickListener - Defines signatures for methods that are called when a marker is clicked or tapped.  - - - -
- - - - - interfaceGoogleMap.OnMarkerDragListener - Callback interface for drag events on markers.  - - - -
- - - - - interfaceGoogleMap.OnMyLocationButtonClickListener - Callback interface for when the My Location button is clicked.  - - - -
- - - - - interfaceGoogleMap.OnMyLocationChangeListener - - This interface is deprecated. - use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. -  - - - -
- - - - - interfaceGoogleMap.SnapshotReadyCallback - Callback interface to notify when the snapshot has been taken.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intMAP_TYPE_HYBRID - Satellite maps with a transparent layer of major streets. - - - -
intMAP_TYPE_NONE - No base map tiles. - - - -
intMAP_TYPE_NORMAL - Basic maps. - - - -
intMAP_TYPE_SATELLITE - Satellite maps with no labels. - - - -
intMAP_TYPE_TERRAIN - Terrain maps. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - Circle - - addCircle(CircleOptions options) - -
- Add a circle to this map. - - - -
- -
- - - final - - - GroundOverlay - - addGroundOverlay(GroundOverlayOptions options) - -
- Adds an image to this map. - - - -
- -
- - - final - - - Marker - - addMarker(MarkerOptions options) - -
- Adds a marker to this map. - - - -
- -
- - - final - - - Polygon - - addPolygon(PolygonOptions options) - -
- Adds a polygon to this map. - - - -
- -
- - - final - - - Polyline - - addPolyline(PolylineOptions options) - -
- Adds a polyline to this map. - - - -
- -
- - - final - - - TileOverlay - - addTileOverlay(TileOverlayOptions options) - -
- Adds a tile overlay to this map. - - - -
- -
- - - final - - - void - - animateCamera(CameraUpdate update, int durationMs, GoogleMap.CancelableCallback callback) - -
- Moves the map according to the update with an animation over a specified duration, and calls - an optional callback on completion. - - - -
- -
- - - final - - - void - - animateCamera(CameraUpdate update, GoogleMap.CancelableCallback callback) - -
- Animates the movement of the camera from the current position to the position defined in the - update and calls an optional callback on completion. - - - -
- -
- - - final - - - void - - animateCamera(CameraUpdate update) - -
- Animates the movement of the camera from the current position to the position defined in the - update. - - - -
- -
- - - final - - - void - - clear() - -
- Removes all markers, polylines, polygons, overlays, etc from the map. - - - -
- -
- - - final - - - CameraPosition - - getCameraPosition() - -
- Gets the current position of the camera. - - - -
- -
- - - - - - IndoorBuilding - - getFocusedBuilding() - -
- Gets the currently focused building. - - - -
- -
- - - final - - - int - - getMapType() - -
- Gets the type of map that's currently displayed. - - - -
- -
- - - final - - - float - - getMaxZoomLevel() - -
- Returns the maximum zoom level for the current camera position. - - - -
- -
- - - final - - - float - - getMinZoomLevel() - -
- Returns the minimum zoom level. - - - -
- -
- - - final - - - Location - - getMyLocation() - -
- - This method is deprecated. - use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. - - - - -
- -
- - - final - - - Projection - - getProjection() - -
- Returns a Projection object that you can use to convert between screen coordinates - and latitude/longitude coordinates. - - - -
- -
- - - final - - - UiSettings - - getUiSettings() - -
- Gets the user interface settings for the map. - - - -
- -
- - - final - - - boolean - - isBuildingsEnabled() - -
- Returns whether 3D buildings layer is enabled. - - - -
- -
- - - final - - - boolean - - isIndoorEnabled() - -
- Gets whether indoor maps are currently enabled. - - - -
- -
- - - final - - - boolean - - isMyLocationEnabled() - -
- Gets the status of the my-location layer. - - - -
- -
- - - final - - - boolean - - isTrafficEnabled() - -
- Checks whether the map is drawing traffic data. - - - -
- -
- - - final - - - void - - moveCamera(CameraUpdate update) - -
- Repositions the camera according to the instructions defined in the update. - - - -
- -
- - - final - - - void - - setBuildingsEnabled(boolean enabled) - -
- Turns the 3D buildings layer on or off. - - - -
- -
- - - final - - - void - - setContentDescription(String description) - -
- Sets a contentDescription for the map. - - - -
- -
- - - final - - - boolean - - setIndoorEnabled(boolean enabled) - -
- Sets whether indoor maps should be enabled. - - - -
- -
- - - final - - - void - - setInfoWindowAdapter(GoogleMap.InfoWindowAdapter adapter) - -
- Sets a custom renderer for the contents of info windows. - - - -
- -
- - - final - - - void - - setLocationSource(LocationSource source) - -
- Replaces the location source of the my-location layer. - - - -
- -
- - - final - - - void - - setMapType(int type) - -
- Sets the type of map tiles that should be displayed. - - - -
- -
- - - final - - - void - - setMyLocationEnabled(boolean enabled) - -
- Enables or disables the my-location layer. - - - -
- -
- - - final - - - void - - setOnCameraChangeListener(GoogleMap.OnCameraChangeListener listener) - -
- Sets a callback that's invoked when the camera changes. - - - -
- -
- - - final - - - void - - setOnIndoorStateChangeListener(GoogleMap.OnIndoorStateChangeListener listener) - -
- Sets or clears the listener for indoor events. - - - -
- -
- - - final - - - void - - setOnInfoWindowClickListener(GoogleMap.OnInfoWindowClickListener listener) - -
- Sets a callback that's invoked when a marker info window is clicked. - - - -
- -
- - - final - - - void - - setOnMapClickListener(GoogleMap.OnMapClickListener listener) - -
- Sets a callback that's invoked when the map is tapped. - - - -
- -
- - - - - - void - - setOnMapLoadedCallback(GoogleMap.OnMapLoadedCallback callback) - -
- Sets a callback that is invoked when this map has finished rendering. - - - -
- -
- - - final - - - void - - setOnMapLongClickListener(GoogleMap.OnMapLongClickListener listener) - -
- Sets a callback that's invoked when the map is long pressed. - - - -
- -
- - - final - - - void - - setOnMarkerClickListener(GoogleMap.OnMarkerClickListener listener) - -
- Sets a callback that's invoked when a marker is clicked. - - - -
- -
- - - final - - - void - - setOnMarkerDragListener(GoogleMap.OnMarkerDragListener listener) - -
- Sets a callback that's invoked when a marker is dragged. - - - -
- -
- - - final - - - void - - setOnMyLocationButtonClickListener(GoogleMap.OnMyLocationButtonClickListener listener) - -
- Sets a callback that's invoked when the my location button is clicked. - - - -
- -
- - - final - - - void - - setOnMyLocationChangeListener(GoogleMap.OnMyLocationChangeListener listener) - -
- - This method is deprecated. - use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. - - - - -
- -
- - - final - - - void - - setPadding(int left, int top, int right, int bottom) - -
- Sets padding on the map. - - - -
- -
- - - final - - - void - - setTrafficEnabled(boolean enabled) - -
- Turns the traffic layer on or off. - - - -
- -
- - - final - - - void - - snapshot(GoogleMap.SnapshotReadyCallback callback, Bitmap bitmap) - -
- Takes a snapshot of the map. - - - -
- -
- - - final - - - void - - snapshot(GoogleMap.SnapshotReadyCallback callback) - -
- Takes a snapshot of the map. - - - -
- -
- - - final - - - void - - stopAnimation() - -
- Stops the camera animation if there is one in progress. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - MAP_TYPE_HYBRID -

-
- - - - -
-
- - - - -

Satellite maps with a transparent layer of major streets.

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAP_TYPE_NONE -

-
- - - - -
-
- - - - -

No base map tiles.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAP_TYPE_NORMAL -

-
- - - - -
-
- - - - -

Basic maps.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAP_TYPE_SATELLITE -

-
- - - - -
-
- - - - -

Satellite maps with no labels.

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAP_TYPE_TERRAIN -

-
- - - - -
-
- - - - -

Terrain maps.

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - Circle - - addCircle - (CircleOptions options) -

-
-
- - - -
-
- - - - -

Add a circle to this map.

-
-
Parameters
- - - - -
options - A circle options object that defines how to render the Circle
-
-
-
Returns
-
  • The Circle object that is added to the map -
-
- -
-
- - - - -
-

- - public - - final - - - GroundOverlay - - addGroundOverlay - (GroundOverlayOptions options) -

-
-
- - - -
-
- - - - -

Adds an image to this map.

-
-
Parameters
- - - - -
options - A ground-overlay options object that defines how to render the overlay. - Options must have an image (AnchoredBitmap) and position specified.
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if either the image or the position is unspecified in the - options. -
-
- -
-
- - - - -
-

- - public - - final - - - Marker - - addMarker - (MarkerOptions options) -

-
-
- - - -
-
- - - - -

Adds a marker to this map. -

- The marker's icon is rendered on the map at the location Marker.position. Clicking the marker - centers the camera on the marker. If Marker.title is defined, the map shows an info box with - the marker's title and snippet. If the marker is draggable, long-clicking and then dragging - the marker moves it.

-
-
Parameters
- - - - -
options - A marker options object that defines how to render the marker.
-
-
-
Returns
-
  • The Marker that was added to the map. -
-
- -
-
- - - - -
-

- - public - - final - - - Polygon - - addPolygon - (PolygonOptions options) -

-
-
- - - -
-
- - - - -

Adds a polygon to this map.

-
-
Parameters
- - - - -
options - A polygon options object that defines how to render the Polygon.
-
-
-
Returns
-
  • The Polygon object that is added to the map. -
-
- -
-
- - - - -
-

- - public - - final - - - Polyline - - addPolyline - (PolylineOptions options) -

-
-
- - - -
-
- - - - -

Adds a polyline to this map.

-
-
Parameters
- - - - -
options - A polyline options object that defines how to render the Polyline.
-
-
-
Returns
-
  • The Polyline object that was added to the map. -
-
- -
-
- - - - -
-

- - public - - final - - - TileOverlay - - addTileOverlay - (TileOverlayOptions options) -

-
-
- - - -
-
- - - - -

Adds a tile overlay to this map. See TileOverlay for more information. -

- Note that unlike other overlays, if the map is recreated, tile overlays are not automatically - restored and must be re-added manually.

-
-
Parameters
- - - - -
options - A tile-overlay options object that defines how to render the overlay. Options - must have a TileProvider - specified, otherwise an IllegalArgumentException will be thrown.
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if the TileProvider is unspecified in the options. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - animateCamera - (CameraUpdate update, int durationMs, GoogleMap.CancelableCallback callback) -

-
-
- - - -
-
- - - - -

Moves the map according to the update with an animation over a specified duration, and calls - an optional callback on completion. See CameraUpdateFactory for a set of updates. -

- If getCameraPosition() is called during the animation, it will return the current - location of the camera in flight.

-
-
Parameters
- - - - - - - -
durationMs - The duration of the animation in milliseconds. This must be strictly - positive, otherwise an IllegalArgumentException will be thrown. -
callback - An optional callback to be notified from the main thread when the animation - stops. If the animation stops due to its natural completion, the callback will be - notified with onFinish(). If the animation stops due to - interruption by a later camera movement or a user gesture, - onCancel() will be called. The callback should not - attempt to move or animate the camera in its cancellation method. If a callback - isn't required, leave it as null.
-
- -
-
- - - - -
-

- - public - - final - - - void - - animateCamera - (CameraUpdate update, GoogleMap.CancelableCallback callback) -

-
-
- - - -
-
- - - - -

Animates the movement of the camera from the current position to the position defined in the - update and calls an optional callback on completion. See CameraUpdateFactory for a - set of updates. -

- During the animation, a call to getCameraPosition() returns an intermediate location - of the camera.

-
-
Parameters
- - - - - - - -
update - The change that should be applied to the camera.
callback - The callback to invoke from the main thread when the animation stops. If the - animation completes normally, onFinish() is called; - otherwise, onCancel() is called. Do not update or - animate the camera from within onCancel(). -
-
- -
-
- - - - -
-

- - public - - final - - - void - - animateCamera - (CameraUpdate update) -

-
-
- - - -
-
- - - - -

Animates the movement of the camera from the current position to the position defined in the - update. During the animation, a call to getCameraPosition() returns an intermediate - location of the camera. -

- See CameraUpdateFactory for a set of updates.

-
-
Parameters
- - - - -
update - The change that should be applied to the camera. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - clear - () -

-
-
- - - -
-
- - - - -

Removes all markers, polylines, polygons, overlays, etc from the map.

- -
-
- - - - -
-

- - public - - final - - - CameraPosition - - getCameraPosition - () -

-
-
- - - -
-
- - - - -

Gets the current position of the camera. -

- The CameraPosition returned is a snapshot of the current position, and will not - automatically update when the camera moves.

-
-
Returns
-
  • The current position of the Camera. -
-
- -
-
- - - - -
-

- - public - - - - - IndoorBuilding - - getFocusedBuilding - () -

-
-
- - - -
-
- - - - -

Gets the currently focused building.

-
-
Returns
-
  • The current focused building or null if no building is focused. -
-
- -
-
- - - - -
-

- - public - - final - - - int - - getMapType - () -

-
-
- - - -
-
- - - - -

Gets the type of map that's currently displayed. See MAP_TYPE_NORMAL, - MAP_TYPE_SATELLITE, MAP_TYPE_TERRAIN for possible values.

-
-
Returns
-
  • The map type. -
-
- -
-
- - - - -
-

- - public - - final - - - float - - getMaxZoomLevel - () -

-
-
- - - -
-
- - - - -

Returns the maximum zoom level for the current camera position. This takes into account what - map type is currently being used, e.g., satellite or terrain may have a lower max zoom level - than the base map tiles.

-
-
Returns
-
  • The maximum zoom level available at the current camera position. -
-
- -
-
- - - - -
-

- - public - - final - - - float - - getMinZoomLevel - () -

-
-
- - - -
-
- - - - -

Returns the minimum zoom level. This is the same for every location (unlike the maximum zoom - level) but may vary between devices and map sizes.

-
-
Returns
-
  • The minimum zoom level available. -
-
- -
-
- - - - -
-

- - public - - final - - - Location - - getMyLocation - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. - -

-

Returns the currently displayed user location, or null if there is no location data - available.

-
-
Returns
- -
-
-
Throws
- - - - -
IllegalStateException - if the my-location layer is not enabled.
-
- -
-
- - - - -
-

- - public - - final - - - Projection - - getProjection - () -

-
-
- - - -
-
- - - - -

Returns a Projection object that you can use to convert between screen coordinates - and latitude/longitude coordinates. -

- The Projection returned is a snapshot of the current projection, and will not - automatically update when the camera moves. As this operation is expensive, you should get - the projection only once per screen. Google Maps uses the Mercator projection to create its - maps from geographic data and convert points on the map into geographic coordinates.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - final - - - UiSettings - - getUiSettings - () -

-
-
- - - -
-
- - - - -

Gets the user interface settings for the map.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - final - - - boolean - - isBuildingsEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether 3D buildings layer is enabled.

-
-
Returns
-
  • True if buildings are enabled, false otherwise. -
-
- -
-
- - - - -
-

- - public - - final - - - boolean - - isIndoorEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether indoor maps are currently enabled.

-
-
Returns
-
  • true if indoor maps are enabled; false if indoor maps are disabled; -
-
- -
-
- - - - -
-

- - public - - final - - - boolean - - isMyLocationEnabled - () -

-
-
- - - -
-
- - - - -

Gets the status of the my-location layer.

-
-
Returns
-
  • True if the my-location layer is enabled, false otherwise. -
-
- -
-
- - - - -
-

- - public - - final - - - boolean - - isTrafficEnabled - () -

-
-
- - - -
-
- - - - -

Checks whether the map is drawing traffic data. This is subject to the availability of - traffic data.

-
-
Returns
-
  • True if traffic data is enabled, false otherwise. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - moveCamera - (CameraUpdate update) -

-
-
- - - -
-
- - - - -

Repositions the camera according to the instructions defined in the update. The move is - instantaneous, and a subsequent getCameraPosition() will reflect the new position. - See CameraUpdateFactory for a set of updates.

-
-
Parameters
- - - - -
update - The change that should be applied to the camera. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setBuildingsEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Turns the 3D buildings layer on or off.

-
-
Parameters
- - - - -
enabled - true to enable the 3D buildings layer; false to disable 3D - buildings. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setContentDescription - (String description) -

-
-
- - - -
-
- - - - -

Sets a contentDescription for the map. -

- This is used to provide a spoken description of the map in accessibility mode. The default - value is "Google Map"

-
-
Parameters
- - - - -
description - a string to use as a description. -
-
- -
-
- - - - -
-

- - public - - final - - - boolean - - setIndoorEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets whether indoor maps should be enabled. Currently, indoor maps can only be shown on one - map at a time and by default, this is the first map added to your application. To enable - indoor maps on another map, you must first disable indoor maps on the original map. If you - try to enable indoor maps when it is enabled on another map, nothing will happen and this - will return false. When Indoor is not enabled for a map, all methods related to - indoor will return null, or false.

-
-
Parameters
- - - - -
enabled - true to try to enable indoor maps; false to disable indoor - maps.
-
-
-
Returns
-
  • whether it was possible to enable indoor maps. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setInfoWindowAdapter - (GoogleMap.InfoWindowAdapter adapter) -

-
-
- - - -
-
- - - - -

Sets a custom renderer for the contents of info windows. -

- Like the map's event listeners, this state is not serialized with the map. If the map gets - re-created (e.g., due to a configuration change), you must ensure that you call this method - again in order to preserve the customization.

-
-
Parameters
- - - - -
adapter - The adapter to use for info window contents, or null to use the - default content rendering in info windows. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setLocationSource - (LocationSource source) -

-
-
- - - -
-
- - - - -

Replaces the location source of the my-location layer.

-
-
Parameters
- - - - -
source - A location source to use in the my-location layer. Set to null to use - the default location source. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setMapType - (int type) -

-
-
- - - -
-
- - - - -

Sets the type of map tiles that should be displayed. The allowable values are: -

-
-
Parameters
- - - - -
type - The type of map to display. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setMyLocationEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Enables or disables the my-location layer. -

- While enabled, the my-location layer continuously draws an indication of a user's current - location and bearing, and displays UI controls that allow a user to interact with their - location (for example, to enable or disable camera tracking of their location and bearing).

-
-
Parameters
- - - - -
enabled - True to enable; false to disable. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnCameraChangeListener - (GoogleMap.OnCameraChangeListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the camera changes.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the camera changes. To unset the callback, - use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnIndoorStateChangeListener - (GoogleMap.OnIndoorStateChangeListener listener) -

-
-
- - - -
-
- - - - -

Sets or clears the listener for indoor events. Only one listener can ever be set. Setting - a new listener will remove the previous listener.

-
-
Parameters
- - - - -
listener - the listener for indoor events if non-null; otherwise, clears the - listener -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnInfoWindowClickListener - (GoogleMap.OnInfoWindowClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when a marker info window is clicked.

-
-
Parameters
- - - - -
listener - The callback that's invoked when a marker info window is clicked. To unset - the callback, use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMapClickListener - (GoogleMap.OnMapClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the map is tapped.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the map is tapped. To unset the callback, - use null. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setOnMapLoadedCallback - (GoogleMap.OnMapLoadedCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback that is invoked when this map has finished rendering. The callback will only - be invoked once. - - If this method is called when the map is fully rendered, the callback will be invoked - immediately. This event will not fire if the map never loads due to connectivity issues, or - if the map is continuously changing and never completes loading due to the user constantly - interacting with the map.

-
-
Parameters
- - - - -
callback - The callback invoked when the map has finished rendering. To unset the - callback, use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMapLongClickListener - (GoogleMap.OnMapLongClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the map is long pressed.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the map is long pressed. To unset the - callback, use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMarkerClickListener - (GoogleMap.OnMarkerClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when a marker is clicked.

-
-
Parameters
- - - - -
listener - The callback that's invoked when a marker is clicked. To unset the callback, - use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMarkerDragListener - (GoogleMap.OnMarkerDragListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when a marker is dragged.

-
-
Parameters
- - - - -
listener - The callback that's invoked on marker drag events. To unset the callback, use - null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMyLocationButtonClickListener - (GoogleMap.OnMyLocationButtonClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the my location button is clicked. - -

If the listener returns true, the event is consumed and the default - behavior will not occur. If it returns false, the default behavior will occur (i.e. - The camera moves such that it is centered on the user's location).

-
-
Parameters
- - - - -
listener - The callback that's invoked when the My Location button is clicked. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnMyLocationChangeListener - (GoogleMap.OnMyLocationChangeListener listener) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. - -

-

Sets a callback that's invoked when the My Location dot changes location.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the My Location dot changes.
-
- -
-
- - - - -
-

- - public - - final - - - void - - setPadding - (int left, int top, int right, int bottom) -

-
-
- - - -
-
- - - - -

Sets padding on the map. - -

This method allows you to define a visible region on the map, to signal to the map that - portions of the map around the edges may be obscured, by setting padding on each of the four - edges of the map. Map functions will be adapted to the padding. For example, the zoom - controls, compass, copyright notices and Google logo will be moved to fit inside the defined - region, camera movements will be relative to the center of the visible region, etc.

-
-
Parameters
- - - - - - - - - - - - - -
left - the number of pixels of padding to be added on the left of the map.
top - the number of pixels of padding to be added on the top of the map.
right - the number of pixels of padding to be added on the right of the map.
bottom - the number of pixels of padding to be added on the bottom of the map. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setTrafficEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Turns the traffic layer on or off.

- -
-
- - - - -
-

- - public - - final - - - void - - snapshot - (GoogleMap.SnapshotReadyCallback callback, Bitmap bitmap) -

-
-
- - - -
-
- - - - -

Takes a snapshot of the map. - -

This method is equivalent to snapshot(SnapshotReadyCallback) but lets you - provide a preallocated Bitmap. If the bitmap does not match the current dimensions of - the map, another bitmap will be allocated that fits the map's dimensions. - -

Although in most cases the object passed by the callback method is the same as the one - given in the parameter to this method, in some cases the returned object can be different - (e.g., if the view's dimensions have changed by the time the snapshot is actually taken). - Thus, you should only trust the content of the bitmap passed by the callback method.

-
-
Parameters
- - - - - - - -
callback - Callback method invoked when the snapshot is taken.
bitmap - A preallocated bitmap. If null, behaves like - snapshot(SnapshotReadyCallback). -
-
- -
-
- - - - -
-

- - public - - final - - - void - - snapshot - (GoogleMap.SnapshotReadyCallback callback) -

-
-
- - - -
-
- - - - -

Takes a snapshot of the map. - -

You can use snapshots within your application when an interactive - map would be difficult, or impossible, to use. For example, images - produced with the snapshot() method can be used to display a - thumbnail of the map in your app, or a snapshot in the notification - center. - -

Note: Images of the map must not be - transmitted to your servers, or otherwise used outside of the - application. If you need to send a map to another application or user, - send data that allows them to reconstruct the map for the new user - instead of a snapshot.

-
-
Parameters
- - - - -
callback - Callback method invoked when the snapshot is taken. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - stopAnimation - () -

-
-
- - - -
-
- - - - -

Stops the camera animation if there is one in progress. When the method is called, the camera - stops moving immediately and remains in that position. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html b/docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html deleted file mode 100644 index 36bdc6631d3a..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html +++ /dev/null @@ -1,2905 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleMapOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GoogleMapOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.GoogleMapOptions
- - - - - - - -
- - -

Class Overview

-

Defines configuration GoogleMapOptions for a GoogleMap. These options can be used when - adding a map to your application programmatically (as opposed to via XML). If you are using a - MapFragment, you can pass these options in using the static factory method - newInstance(GoogleMapOptions). If you are using a MapView, you can - pass these options in using the constructor MapView(Context, GoogleMapOptions). -

- If you add a map using XML, then you can apply these options using custom XML tags. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GoogleMapOptions() - -
- Creates a new GoogleMapOptions object. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - GoogleMapOptions - - camera(CameraPosition camera) - -
- Specifies a the initial camera position for the map. - - - -
- -
- - - - - - GoogleMapOptions - - compassEnabled(boolean enabled) - -
- Specifies whether the compass should be enabled. - - - -
- -
- - - - static - - GoogleMapOptions - - createFromAttributes(Context context, AttributeSet attrs) - -
- Creates a GoogleMapsOptions from the attribute set - - - - -
- -
- - - - - - CameraPosition - - getCamera() - -
- - - - - - Boolean - - getCompassEnabled() - -
- - - - - - Boolean - - getLiteMode() - -
- - - - - - Boolean - - getMapToolbarEnabled() - -
- - - - - - int - - getMapType() - -
- - - - - - Boolean - - getRotateGesturesEnabled() - -
- - - - - - Boolean - - getScrollGesturesEnabled() - -
- - - - - - Boolean - - getTiltGesturesEnabled() - -
- - - - - - Boolean - - getUseViewLifecycleInFragment() - -
- - - - - - Boolean - - getZOrderOnTop() - -
- - - - - - Boolean - - getZoomControlsEnabled() - -
- - - - - - Boolean - - getZoomGesturesEnabled() - -
- - - - - - GoogleMapOptions - - liteMode(boolean enabled) - -
- Specifies whether the map should be created in lite mode. - - - -
- -
- - - - - - GoogleMapOptions - - mapToolbarEnabled(boolean enabled) - -
- Specifies whether the mapToolbar should be enabled. - - - -
- -
- - - - - - GoogleMapOptions - - mapType(int mapType) - -
- Specifies a change to the initial map type. - - - -
- -
- - - - - - GoogleMapOptions - - rotateGesturesEnabled(boolean enabled) - -
- Specifies whether rotate gestures should be enabled. - - - -
- -
- - - - - - GoogleMapOptions - - scrollGesturesEnabled(boolean enabled) - -
- Specifies whether scroll gestures should be enabled. - - - -
- -
- - - - - - GoogleMapOptions - - tiltGesturesEnabled(boolean enabled) - -
- Specifies whether tilt gestures should be enabled. - - - -
- -
- - - - - - GoogleMapOptions - - useViewLifecycleInFragment(boolean useViewLifecycleInFragment) - -
- When using a MapFragment, this flag specifies whether the lifecycle of the map - should be tied to the fragment's view or the fragment itself. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - GoogleMapOptions - - zOrderOnTop(boolean zOrderOnTop) - -
- Control whether the map view's surface is placed on top of its window. - - - -
- -
- - - - - - GoogleMapOptions - - zoomControlsEnabled(boolean enabled) - -
- Specifies whether the zoom controls should be enabled. - - - -
- -
- - - - - - GoogleMapOptions - - zoomGesturesEnabled(boolean enabled) - -
- Specifies whether zoom gestures should be enabled. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GoogleMapOptions - () -

-
-
- - - -
-
- - - - -

Creates a new GoogleMapOptions object. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - GoogleMapOptions - - camera - (CameraPosition camera) -

-
-
- - - -
-
- - - - -

Specifies a the initial camera position for the map. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - compassEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether the compass should be enabled. See - setCompassEnabled(boolean) for more details. The default value is - true. -

- -
-
- - - - -
-

- - public - static - - - - GoogleMapOptions - - createFromAttributes - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Creates a GoogleMapsOptions from the attribute set -

- -
-
- - - - -
-

- - public - - - - - CameraPosition - - getCamera - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the camera option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getCompassEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the compassEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getLiteMode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the liteMode option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getMapToolbarEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the mapToolbarEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - int - - getMapType - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the mapType option, or -1 if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getRotateGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the rotateGesturesEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getScrollGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the scrollGesturesEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getTiltGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the tiltGesturesEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getUseViewLifecycleInFragment - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the useViewLifecycleInFragment option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getZOrderOnTop - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the zOrderOnTop option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getZoomControlsEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the zoomControlsEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getZoomGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the zoomGesturesEnabled option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - liteMode - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether the map should be created in lite mode. The default value is - false. If lite mode is enabled, maps will load as static images. This improves - performance in the case where a lot of maps need to be displayed at the same time, for - example in a scrolling list, however lite-mode maps cannot be panned or zoomed by the user, - or tilted or rotated at all. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - mapToolbarEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether the mapToolbar should be enabled. See - setMapToolbarEnabled(boolean) for more details. The default value - is true. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - mapType - (int mapType) -

-
-
- - - -
-
- - - - -

Specifies a change to the initial map type. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - rotateGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether rotate gestures should be enabled. See - setRotateGesturesEnabled(boolean) for more details. The default value - is true. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - scrollGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether scroll gestures should be enabled. See - setScrollGesturesEnabled(boolean) for more details. The default value - is true. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - tiltGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether tilt gestures should be enabled. See - setTiltGesturesEnabled(boolean) for more details. The default value is - true. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - useViewLifecycleInFragment - (boolean useViewLifecycleInFragment) -

-
-
- - - -
-
- - - - -

When using a MapFragment, this flag specifies whether the lifecycle of the map - should be tied to the fragment's view or the fragment itself. The default value is - false, tying the lifecycle of the map to the fragment. -

- Using the lifecycle of the fragment allows faster rendering of the map when the fragment - is detached and reattached, because the underlying GL context is preserved. This has the - cost that detaching the fragment, but not destroying it, will not release memory used by - the map. -

- Using the lifecycle of a fragment's view means that a map is not reused when the fragment - is detached and reattached. This will cause the map to re-render from scratch, which can - take a few seconds. It also means that while a fragment is detached, and therefore has no - view, all GoogleMap methods will throw NullPointerException. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - zOrderOnTop - (boolean zOrderOnTop) -

-
-
- - - -
-
- - - - -

Control whether the map view's surface is placed on top of its window. See - setZOrderOnTop(boolean) for more details. Note that this - will cover all other views that could appear on the map (e.g., the zoom controls, the my - location button). -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - zoomControlsEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether the zoom controls should be enabled. See - setZoomControlsEnabled(boolean) for more details. The default value is - true. -

- -
-
- - - - -
-

- - public - - - - - GoogleMapOptions - - zoomGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Specifies whether zoom gestures should be enabled. See - setZoomGesturesEnabled(boolean) for more details. The default value is - true. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html b/docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html deleted file mode 100644 index dc32e6321459..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html +++ /dev/null @@ -1,1069 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSource.OnLocationChangedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

LocationSource.OnLocationChangedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.LocationSource.OnLocationChangedListener
- - - - - - - -
- - -

Class Overview

-

Handles a location update. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onLocationChanged(Location location) - -
- Called when a new user location is known. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onLocationChanged - (Location location) -

-
-
- - - -
-
- - - - -

Called when a new user location is known.

-
-
Parameters
- - - - -
location - new location. Must not be null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/LocationSource.html b/docs/html/reference/com/google/android/gms/maps/LocationSource.html deleted file mode 100644 index 009d82a317ed..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/LocationSource.html +++ /dev/null @@ -1,1187 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LocationSource | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

LocationSource

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.LocationSource
- - - - - - - -
- - -

Class Overview

-

Defines an interface for providing location data, typically to a GoogleMap object. -

- A GoogleMap object has a built-in location provider for its my-location layer, but it can - be replaced with another one that implements - this interface. -

- A GoogleMap object activates its location provider using - activate(OnLocationChangedListener). While active (between - activate(OnLocationChangedListener) and deactivate()), a location provider - should push periodic location updates to the listener registered in - activate(OnLocationChangedListener). It is the provider's responsibility to use location - services wisely according to the map's lifecycle state. For example, it should only using - battery-intensive services (like GPS) occasionally, or only while an activity is in the - foreground. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceLocationSource.OnLocationChangedListener - Handles a location update.  - - - -
- - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - activate(LocationSource.OnLocationChangedListener listener) - -
- Activates this provider. - - - -
- -
- abstract - - - - - void - - deactivate() - -
- Deactivates this provider. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - activate - (LocationSource.OnLocationChangedListener listener) -

-
-
- - - -
-
- - - - -

Activates this provider. This provider will notify the supplied listener periodically, until - you call deactivate(). Notifications will be broadcast on the main thread.

-
-
Parameters
- - - - -
listener - listener that's called when a new location is available
-
-
-
Throws
- - - - - - - -
IllegalStateException - if this provider is already active
IllegalArgumentException - if listener is null -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - deactivate - () -

-
-
- - - -
-
- - - - -

Deactivates this provider. The previously-registered callback is not notified of any further - updates.

-
-
Throws
- - - - -
IllegalStateException - if this provider is already inactive -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/MapFragment.html b/docs/html/reference/com/google/android/gms/maps/MapFragment.html deleted file mode 100644 index c5e9797e963b..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/MapFragment.html +++ /dev/null @@ -1,3989 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MapFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

MapFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.app.Fragment
    ↳com.google.android.gms.maps.MapFragment
- - - - - - - -
- - -

Class Overview

-

A Map component in an app. This fragment is the simplest way to place a map in an - application. It's a wrapper around a view of a map to automatically handle the necessary life - cycle needs. Being a fragment, this component can be added to an activity's layout file simply - with the XML below. - - 

- <fragment
-    class="com.google.android.gms.maps.MapFragment"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"/>
- - A GoogleMap must be acquired using getMapAsync(OnMapReadyCallback). - This class automatically initializes the maps system and the view. -

- A view can be removed when the MapFragment's onDestroyView() method is called and the - useViewLifecycleInFragment(boolean) option is set. When this happens - the MapFragment is no longer valid until the view is recreated again later when MapFragment's - onCreateView(LayoutInflater, ViewGroup, Bundle) method is called. -

- Any objects obtained from the GoogleMap is associated with the view. It's important to - not hold on to objects (e.g. Marker) beyond the - view's life. Otherwise it will cause a memory leak as the view cannot be released. -

- Use this class only if you are targeting API 12 and above. Otherwise, use SupportMapFragment. -

-

Developer Guide

-

- For more information, read the Google Maps Android API v2 - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MapFragment() - -
- Creates a map fragment. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - GoogleMap - - getMap() - -
- - This method is deprecated. - Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. - - - -
- -
- - - - - - void - - getMapAsync(OnMapReadyCallback callback) - -
- Sets a callback object which will be triggered when the GoogleMap instance is ready - to be used. - - - -
- -
- - - - static - - MapFragment - - newInstance() - -
- Creates a map fragment, using default options. - - - -
- -
- - - - static - - MapFragment - - newInstance(GoogleMapOptions options) - -
- Creates a map fragment with the given options. - - - -
- -
- - - - - - void - - onActivityCreated(Bundle savedInstanceState) - -
- - - - - - void - - onAttach(Activity activity) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onDestroyView() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- Parse attributes during inflation from a view hierarchy into the arguments we handle. - - - -
- -
- - - - - - void - - onLowMemory() - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - setArguments(Bundle args) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MapFragment - () -

-
-
- - - -
-
- - - - -

Creates a map fragment. This constructor is public only for use by an inflater. Use - newInstance() to create a MapFragment programmatically. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - GoogleMap - - getMap - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. -

-

Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - getMapAsync - (OnMapReadyCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback object which will be triggered when the GoogleMap instance is ready - to be used. - -

Note that: -

    -
  • This method must be called from the main thread. -
  • The callback will be executed in the main thread. -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • In the rare case where the GoogleMap is destroyed immediately after creation, the - callback is not triggered. -
  • The GoogleMap object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the map is ready to be used. -
-
- -
-
- - - - -
-

- - public - static - - - - MapFragment - - newInstance - () -

-
-
- - - -
-
- - - - -

Creates a map fragment, using default options.

- -
-
- - - - -
-

- - public - static - - - - MapFragment - - newInstance - (GoogleMapOptions options) -

-
-
- - - -
-
- - - - -

Creates a map fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityCreated - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onAttach - (Activity activity) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroyView - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Parse attributes during inflation from a view hierarchy into the arguments we handle. -

- -
-
- - - - -
-

- - public - - - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setArguments - (Bundle args) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/MapView.html b/docs/html/reference/com/google/android/gms/maps/MapView.html deleted file mode 100644 index c082043c279f..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/MapView.html +++ /dev/null @@ -1,15814 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MapView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

MapView

- - - - - - - - - - - - - - - - - extends FrameLayout
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳android.widget.FrameLayout
      ↳com.google.android.gms.maps.MapView
- - - - - - - -
- - -

Class Overview

-

A View which displays a map (with data obtained from the Google Maps service). When focused, it - will capture keypresses and touch gestures to move the map. -

- Users of this class must forward all the life cycle methods from the Activity or - Fragment containing this view to the corresponding ones in this class. In - particular, you must forward on the following methods: -

-

- A GoogleMap must be acquired using getMapAsync(OnMapReadyCallback). - The MapView automatically initializes the maps system and the view. -

- For a simpler method of displaying a Map use MapFragment (or SupportMapFragment) - if you are looking to target earlier platforms. -

- Note: You are advised not to add children to this view. -

-

Developer Guide

-

- For more information, read the Google Maps Android API v2 - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MapView(Context context) - -
- - - - - - - - MapView(Context context, AttributeSet attrs) - -
- - - - - - - - MapView(Context context, AttributeSet attrs, int defStyle) - -
- - - - - - - - MapView(Context context, GoogleMapOptions options) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - GoogleMap - - getMap() - -
- - This method is deprecated. - Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. - - - -
- -
- - - - - - void - - getMapAsync(OnMapReadyCallback callback) - -
- Returns a non-null instance of the GoogleMap, ready to be used. - - - -
- -
- - - final - - - void - - onCreate(Bundle savedInstanceState) - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onDestroy() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onLowMemory() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onPause() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onResume() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onSaveInstanceState(Bundle outState) - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.FrameLayout - -
- - -
-
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MapView - (Context context) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - MapView - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - MapView - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - MapView - (Context context, GoogleMapOptions options) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - GoogleMap - - getMap - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. -

-

Gets the underlying GoogleMap that is tied to this view.

-
-
Returns
-
  • the GoogleMap. Null if the view of the map is not yet ready. This can happen when - Google Play services is not available. If Google Play services becomes available - afterwards, calling this method again will initialize and return the GoogleMap. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getMapAsync - (OnMapReadyCallback callback) -

-
-
- - - -
-
- - - - -

Returns a non-null instance of the GoogleMap, ready to be used. - -

Note that: -

    -
  • This method must be called from the main thread. -
  • The callback will be executed in the main thread. -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • The GoogleMap object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the map is ready to be used. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html b/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html deleted file mode 100644 index 56b513c20286..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html +++ /dev/null @@ -1,1334 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MapsInitializer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MapsInitializer

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.MapsInitializer
- - - - - - - -
- - -

Class Overview

-

Use this class to initialize the Google Maps Android API if features need to be used before - obtaining a map. It must be called because some classes such as BitmapDescriptorFactory and - CameraUpdateFactory need to be initialized. -

- If you are using MapFragment or MapView and have already obtained a (non-null) - GoogleMap by calling getMap() on either of these classes, then you do not need to - worry about this class. See the sample application for some examples. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - int - - initialize(Context context) - -
- Initializes the Google Maps Android API so that its classes are ready for use. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - int - - initialize - (Context context) -

-
-
- - - -
-
- - - - -

Initializes the Google Maps Android API so that its classes are ready for use. If you are - using MapFragment or MapView and have already obtained a (non-null) - GoogleMap by calling getMap() on either of these classes, then it is not - necessary to call this.

-
-
Parameters
- - - - -
context - Required to fetch the necessary API resources and code. Must not be null.
-
-
-
Returns
-
  • A ConnectionResult error code. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/OnMapReadyCallback.html b/docs/html/reference/com/google/android/gms/maps/OnMapReadyCallback.html deleted file mode 100644 index 2e7cdc5102ef..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/OnMapReadyCallback.html +++ /dev/null @@ -1,1079 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnMapReadyCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnMapReadyCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.OnMapReadyCallback
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the map is ready to be used. - -

Once an instance of this interface is set on a MapFragment or - MapView object, the onMapReady(GoogleMap) method is - triggered when the map is ready to be used and provides a non-null instance - of GoogleMap. - -

If Google Play services is not installed on the device, the user will be - prompted to install it, and the onMapReady(GoogleMap) method will - only be triggered when the user has installed it and returned to the app. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMapReady(GoogleMap googleMap) - -
- Called when the map is ready to be used. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMapReady - (GoogleMap googleMap) -

-
-
- - - -
-
- - - - -

Called when the map is ready to be used.

-
-
Parameters
- - - - -
googleMap - A non-null instance of a GoogleMap associated with the - MapFragment or MapView that defines the callback. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/OnStreetViewPanoramaReadyCallback.html b/docs/html/reference/com/google/android/gms/maps/OnStreetViewPanoramaReadyCallback.html deleted file mode 100644 index 97604e7d30db..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/OnStreetViewPanoramaReadyCallback.html +++ /dev/null @@ -1,1082 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OnStreetViewPanoramaReadyCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

OnStreetViewPanoramaReadyCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.OnStreetViewPanoramaReadyCallback
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the Street View panorama is ready to be used. - -

Once an instance of this interface is set on a - StreetViewPanoramaFragment or StreetViewPanoramaView object, - the onStreetViewPanoramaReady(StreetViewPanorama) method is - triggered when the panorama is ready to be used and provides a non-null - instance of StreetViewPanorama. - -

If Google Play services is not installed on the device, the user will be - prompted to install it, and the - onStreetViewPanoramaReady(StreetViewPanorama) method will only be - triggered when the user has installed it and returned to the app. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStreetViewPanoramaReady(StreetViewPanorama panorama) - -
- Called when the Street View panorama is ready to be used. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStreetViewPanoramaReady - (StreetViewPanorama panorama) -

-
-
- - - -
-
- - - - -

Called when the Street View panorama is ready to be used.

-
-
Parameters
- - - - -
panorama - A non-null instance of a StreetViewPanorama associated - with the StreetViewPanoramaFragment or - StreetViewPanoramaView that defines the callback. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/Projection.html b/docs/html/reference/com/google/android/gms/maps/Projection.html deleted file mode 100644 index 808eb80ac67b..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/Projection.html +++ /dev/null @@ -1,1464 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Projection | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Projection

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.Projection
- - - - - - - -
- - -

Class Overview

-

A projection is used to translate between on screen location and geographic coordinates on the - surface of the Earth (LatLng). Screen location is in screen pixels (not display pixels) - with respect to the top left corner of the map (and not necessarily of the whole screen). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LatLng - - fromScreenLocation(Point point) - -
- Returns the geographic location that corresponds to a screen location. - - - -
- -
- - - - - - VisibleRegion - - getVisibleRegion() - -
- Gets a projection of the viewing frustum for converting between screen coordinates and - geo-latitude/longitude coordinates. - - - -
- -
- - - - - - Point - - toScreenLocation(LatLng location) - -
- Returns a screen location that corresponds to a geographical coordinate (LatLng). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LatLng - - fromScreenLocation - (Point point) -

-
-
- - - -
-
- - - - -

Returns the geographic location that corresponds to a screen location. The screen location is - specified in screen pixels (not display pixels) relative to the top left of the map (not the - top left of the whole screen).

-
-
Parameters
- - - - -
point - A Point on the screen in screen pixels.
-
-
-
Returns
-
  • The LatLng corresponding to the point on the screen, or null - if the ray through the given screen point does not intersect the ground plane (this - might be the case if the map is heavily tilted). -
-
- -
-
- - - - -
-

- - public - - - - - VisibleRegion - - getVisibleRegion - () -

-
-
- - - -
-
- - - - -

Gets a projection of the viewing frustum for converting between screen coordinates and - geo-latitude/longitude coordinates.

-
-
Returns
-
  • The projection of the viewing frustum in its current state. -
-
- -
-
- - - - -
-

- - public - - - - - Point - - toScreenLocation - (LatLng location) -

-
-
- - - -
-
- - - - -

Returns a screen location that corresponds to a geographical coordinate (LatLng). The - screen location is in screen pixels (not display pixels) relative to the top left of the map - (not of the whole screen).

-
-
Parameters
- - - - -
location - A LatLng on the map to convert to a screen location.
-
-
-
Returns
-
  • A Point representing the screen location in screen pixels. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener.html deleted file mode 100644 index 1b48cdb6a626..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener.html +++ /dev/null @@ -1,1072 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener
- - - - - - - -
- - -

Class Overview

-

A listener for when the StreetViewPanoramaCamera changes -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStreetViewPanoramaCameraChange(StreetViewPanoramaCamera camera) - -
- Called when the user makes changes to the camera on the panorama or if the camera is - changed programmatically. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStreetViewPanoramaCameraChange - (StreetViewPanoramaCamera camera) -

-
-
- - - -
-
- - - - -

Called when the user makes changes to the camera on the panorama or if the camera is - changed programmatically. Implementations of this method are always invoked on the - main thread.

-
-
Parameters
- - - - -
camera - The position the camera has changed to -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaChangeListener.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaChangeListener.html deleted file mode 100644 index 6ab59e426e98..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaChangeListener.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanorama.OnStreetViewPanoramaChangeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

StreetViewPanorama.OnStreetViewPanoramaChangeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaChangeListener
- - - - - - - -
- - -

Class Overview

-

A listener for when the Street View panorama loads a new panorama -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStreetViewPanoramaChange(StreetViewPanoramaLocation location) - -
- The StreetViewPanorama performs an animated transition from one location to another when - the user performs a manual navigation action. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStreetViewPanoramaChange - (StreetViewPanoramaLocation location) -

-
-
- - - -
-
- - - - -

The StreetViewPanorama performs an animated transition from one location to another when - the user performs a manual navigation action. This callback is called when the transition - animation has occurred and the rendering of the first panorama has occurred. This - callback also occurs when the developer sets a position and the rendering of the first - panorama has occurred. It is possible that not all the panoramas have loaded when this - callback is activated. Implementations of this method are always invoked on the - main thread.

-
-
Parameters
- - - - -
location - Location the StreetViewPanorama is changed to. Null if it is an invalid - panorama -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaClickListener.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaClickListener.html deleted file mode 100644 index 7e5ed1e36f73..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaClickListener.html +++ /dev/null @@ -1,1076 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanorama.OnStreetViewPanoramaClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

StreetViewPanorama.OnStreetViewPanoramaClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the user taps on the panorama. -

- Listeners will be invoked on the main thread -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStreetViewPanoramaClick(StreetViewPanoramaOrientation orientation) - -
- Called when the user makes a tap gesture on the panorama, but only if none of the - overlays of the panorama handled the gesture. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStreetViewPanoramaClick - (StreetViewPanoramaOrientation orientation) -

-
-
- - - -
-
- - - - -

Called when the user makes a tap gesture on the panorama, but only if none of the - overlays of the panorama handled the gesture. Implementations of this method are always - invoked on the main thread.

-
-
Parameters
- - - - -
orientation - The tilt and bearing values corresponding to the point on the screen - where the user tapped. These values have an absolute value within a specific - panorama, and are independent of the current orientation of the camera. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaLongClickListener.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaLongClickListener.html deleted file mode 100644 index 10e8e69afcc4..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaLongClickListener.html +++ /dev/null @@ -1,1077 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanorama.OnStreetViewPanoramaLongClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

StreetViewPanorama.OnStreetViewPanoramaLongClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaLongClickListener
- - - - - - - -
- - -

Class Overview

-

Callback interface for when the user long presses on the panorama. -

- Listeners will be invoked on the main thread -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStreetViewPanoramaLongClick(StreetViewPanoramaOrientation orientation) - -
- Called when the user makes a long-press gesture on the panorama, but only if none of the - overlays of the panorama handled the gesture. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStreetViewPanoramaLongClick - (StreetViewPanoramaOrientation orientation) -

-
-
- - - -
-
- - - - -

Called when the user makes a long-press gesture on the panorama, but only if none of the - overlays of the panorama handled the gesture. Implementations of this method are always - invoked on the main thread.

-
-
Parameters
- - - - -
orientation - The tilt and bearing values corresponding to the point on the screen - where the user long-pressed. These values have an absolute value within a - specific panorama, and are independent of the current orientation of the - camera. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.html deleted file mode 100644 index 33d4e7ab50fd..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanorama.html +++ /dev/null @@ -1,2659 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanorama | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanorama

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.StreetViewPanorama
- - - - - - - -
- - -

Class Overview

-

This is the main class of the Street View feature in the Google Maps Android API and is the - entry point for all methods related to Street View panoramas. You cannot instantiate a - StreetViewPanorama object directly, rather, you must obtain one from the - getStreetViewPanorama() method on a MapFragment or MapView that you have - added to your application. -

- Note: Similar to a View object, a StreetViewPanorama can only - be read and modified from the main thread. Calling StreetViewPanorama methods from - another thread will result in an exception. -

-

Developer Guide

-

- To get started with the Google Maps Android API, read the Google Maps Android API v2 - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceStreetViewPanorama.OnStreetViewPanoramaCameraChangeListener - A listener for when the StreetViewPanoramaCamera changes -  - - - -
- - - - - interfaceStreetViewPanorama.OnStreetViewPanoramaChangeListener - A listener for when the Street View panorama loads a new panorama -  - - - -
- - - - - interfaceStreetViewPanorama.OnStreetViewPanoramaClickListener - Callback interface for when the user taps on the panorama.  - - - -
- - - - - interfaceStreetViewPanorama.OnStreetViewPanoramaLongClickListener - Callback interface for when the user long presses on the panorama.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - animateTo(StreetViewPanoramaCamera camera, long duration) - -
- Changes the current camera position, orientation and zoom, to a given position over a - specified duration - - - -
- -
- - - - - - StreetViewPanoramaLocation - - getLocation() - -
- Returns the current location of the user and information regarding the current panorama's - adjacent panoramas - - - -
- -
- - - - - - StreetViewPanoramaCamera - - getPanoramaCamera() - -
- Returns the current orientation and zoom - - - -
- -
- - - - - - boolean - - isPanningGesturesEnabled() - -
- Returns whether or not the panning gestures are enabled for the user - - - -
- -
- - - - - - boolean - - isStreetNamesEnabled() - -
- Returns whether or not the street names appear on the panorama - - - -
- -
- - - - - - boolean - - isUserNavigationEnabled() - -
- Returns whether or not the navigation is enabled for the user. - - - -
- -
- - - - - - boolean - - isZoomGesturesEnabled() - -
- Returns whether or not the zoom gestures are enabled for the user - - - -
- -
- - - - - - Point - - orientationToPoint(StreetViewPanoramaOrientation orientation) - -
- Returns a screen location that corresponds to an orientation - (StreetViewPanoramaOrientation). - - - -
- -
- - - - - - StreetViewPanoramaOrientation - - pointToOrientation(Point point) - -
- Returns the orientation that corresponds to a screen location. - - - -
- -
- - - final - - - void - - setOnStreetViewPanoramaCameraChangeListener(StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener listener) - -
- Sets a callback that's invoked when the camera changes - - - -
- -
- - - final - - - void - - setOnStreetViewPanoramaChangeListener(StreetViewPanorama.OnStreetViewPanoramaChangeListener listener) - -
- Sets a callback that's invoked when the panorama changes - - - -
- -
- - - final - - - void - - setOnStreetViewPanoramaClickListener(StreetViewPanorama.OnStreetViewPanoramaClickListener listener) - -
- Sets a callback that's invoked when the panorama is tapped. - - - -
- -
- - - final - - - void - - setOnStreetViewPanoramaLongClickListener(StreetViewPanorama.OnStreetViewPanoramaLongClickListener listener) - -
- Sets a callback that's invoked when the panorama is long-pressed. - - - -
- -
- - - - - - void - - setPanningGesturesEnabled(boolean enablePanning) - -
- Sets whether the user is able to use panning gestures - - - -
- -
- - - - - - void - - setPosition(LatLng position) - -
- Sets the StreetViewPanorama to a given location - - - -
- -
- - - - - - void - - setPosition(String panoId) - -
- Sets the StreetViewPanorama to a given location - - - -
- -
- - - - - - void - - setPosition(LatLng position, int radius) - -
- Sets the StreetViewPanorama to a given location - - - -
- -
- - - - - - void - - setStreetNamesEnabled(boolean enableStreetNames) - -
- Sets whether the user is able to see street names on panoramas - - - -
- -
- - - - - - void - - setUserNavigationEnabled(boolean enableUserNavigation) - -
- Sets whether the user is able to move to another panorama - - - -
- -
- - - - - - void - - setZoomGesturesEnabled(boolean enableZoom) - -
- Sets whether the user is able to use zoom gestures - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - animateTo - (StreetViewPanoramaCamera camera, long duration) -

-
-
- - - -
-
- - - - -

Changes the current camera position, orientation and zoom, to a given position over a - specified duration

-
-
Parameters
- - - - - - - -
camera - The camera position to animate to
duration - The length of time, in milliseconds, it takes to transition from the current - camera position to the given one -
-
- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaLocation - - getLocation - () -

-
-
- - - -
-
- - - - -

Returns the current location of the user and information regarding the current panorama's - adjacent panoramas

-
-
Returns
-
  • The current location of the user -
-
- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera - - getPanoramaCamera - () -

-
-
- - - -
-
- - - - -

Returns the current orientation and zoom

-
-
Returns
-
  • The current camera -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isPanningGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether or not the panning gestures are enabled for the user

-
-
Returns
-
  • True if panning gestures are enabled -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isStreetNamesEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether or not the street names appear on the panorama

-
-
Returns
-
  • True if street names are shown -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isUserNavigationEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether or not the navigation is enabled for the user. This includes double tapping - as well as using the navigation links

-
-
Returns
-
  • True if navigation is enabled -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isZoomGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Returns whether or not the zoom gestures are enabled for the user

-
-
Returns
-
  • True if zoom gestures are enabled -
-
- -
-
- - - - -
-

- - public - - - - - Point - - orientationToPoint - (StreetViewPanoramaOrientation orientation) -

-
-
- - - -
-
- - - - -

Returns a screen location that corresponds to an orientation - (StreetViewPanoramaOrientation). The screen location is in screen pixels - (not display pixels) relative to the top left of the Street View panorama - (not of the whole screen).

-
-
Parameters
- - - - -
orientation - A StreetViewPanoramaOrientation on the Street View panorama to - convert to a screen location.
-
-
-
Returns
-
  • A Point representing the screen location in screen pixels. Returns null if - the orientation is unable to be projected on the screen (e.g. behind the user's - field of view) -
-
- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOrientation - - pointToOrientation - (Point point) -

-
-
- - - -
-
- - - - -

Returns the orientation that corresponds to a screen location. The screen location is - specified in screen pixels (not display pixels) relative to the top left of the Street View - panorama (not the top left of the whole screen).

-
-
Parameters
- - - - -
point - A Point on the screen in screen pixels.
-
-
-
Returns
-
  • The StreetViewPanoramaOrientation corresponding to the point on the - screen, or null if the Street View panorama has not been initialized or if - the given point is not a valid point on the screen -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnStreetViewPanoramaCameraChangeListener - (StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the camera changes

-
-
Parameters
- - - - -
listener - The callback that's invoked when the camera changes. To unset the callback, - use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnStreetViewPanoramaChangeListener - (StreetViewPanorama.OnStreetViewPanoramaChangeListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the panorama changes

-
-
Parameters
- - - - -
listener - The callback that's invoked when the panorama changes. To unset the callback, - use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnStreetViewPanoramaClickListener - (StreetViewPanorama.OnStreetViewPanoramaClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the panorama is tapped.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the panorama is tapped. To unset the - callback, use null. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - setOnStreetViewPanoramaLongClickListener - (StreetViewPanorama.OnStreetViewPanoramaLongClickListener listener) -

-
-
- - - -
-
- - - - -

Sets a callback that's invoked when the panorama is long-pressed.

-
-
Parameters
- - - - -
listener - The callback that's invoked when the panorama is long-pressed. To unset - the callback, use null. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPanningGesturesEnabled - (boolean enablePanning) -

-
-
- - - -
-
- - - - -

Sets whether the user is able to use panning gestures

-
-
Parameters
- - - - -
enablePanning - True if users are allowed to use panning gestures -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPosition - (LatLng position) -

-
-
- - - -
-
- - - - -

Sets the StreetViewPanorama to a given location

-
-
Parameters
- - - - -
position - Latitude and longitude of the desired location -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPosition - (String panoId) -

-
-
- - - -
-
- - - - -

Sets the StreetViewPanorama to a given location

-
-
Parameters
- - - - -
panoId - Panorama ID of the desired location -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPosition - (LatLng position, int radius) -

-
-
- - - -
-
- - - - -

Sets the StreetViewPanorama to a given location

-
-
Parameters
- - - - - - - -
position - Latitude and longitude of the desired location
radius - Radius, specified in meters, that defines the area in which to search for a - panorama, centered on the given latitude and longitude -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStreetNamesEnabled - (boolean enableStreetNames) -

-
-
- - - -
-
- - - - -

Sets whether the user is able to see street names on panoramas

-
-
Parameters
- - - - -
enableStreetNames - True if users are able to see street names on panoramas -
-
- -
-
- - - - -
-

- - public - - - - - void - - setUserNavigationEnabled - (boolean enableUserNavigation) -

-
-
- - - -
-
- - - - -

Sets whether the user is able to move to another panorama

-
-
Parameters
- - - - -
enableUserNavigation - True if users are allowed to move to another panorama -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZoomGesturesEnabled - (boolean enableZoom) -

-
-
- - - -
-
- - - - -

Sets whether the user is able to use zoom gestures

-
-
Parameters
- - - - -
enableZoom - True if users are allowed to use zoom gestures -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaFragment.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaFragment.html deleted file mode 100644 index 50c538dc3711..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaFragment.html +++ /dev/null @@ -1,3988 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.app.Fragment
    ↳com.google.android.gms.maps.StreetViewPanoramaFragment
- - - - - - - -
- - -

Class Overview

-

A StreetViewPanorama component in an app. This fragment is the simplest way to place a - Street View panorama in an application. It's a wrapper around a view of a panorama to - automatically handle the necessary life cycle needs. Being a fragment, this component can be - added to an activity's layout file simply with the XML below. - - 

- <fragment
-    class="com.google.android.gms.maps.StreetViewPanoramaFragment"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"/>
- - A StreetViewPanorama must be acquired using - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback). - The StreetViewPanoramaFragment automatically initializes the Street View system and the - view. - -

- A view can be removed when the StreetViewPanoramaFragment's onDestroyView() method is - called and the useViewLifecycleInFragment(boolean) option is - set. When this happens the StreetViewPanoramaFragment is no longer valid until the view is - recreated again later when MapFragment's onCreateView(LayoutInflater, ViewGroup, Bundle) - method is called. -

- Any object obtained from the StreetViewPanorama is associated with the view. It's - important to not hold on to objects beyond the view's life. Otherwise it will cause a memory leak - as the view cannot be released. -

- Use this class only if you are targeting API 12 and above. Otherwise, use - SupportStreetViewPanoramaFragment. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaFragment() - -
- Creates a streetview panorama fragment. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - StreetViewPanorama - - getStreetViewPanorama() - -
- - This method is deprecated. - Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. - - - -
- -
- - - - - - void - - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback callback) - -
- Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - - - -
- -
- - - - static - - StreetViewPanoramaFragment - - newInstance() - -
- Creates a streetview panorama fragment, using default options. - - - -
- -
- - - - static - - StreetViewPanoramaFragment - - newInstance(StreetViewPanoramaOptions options) - -
- Creates a streetview panorama fragment with the given options. - - - -
- -
- - - - - - void - - onActivityCreated(Bundle savedInstanceState) - -
- - - - - - void - - onAttach(Activity activity) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onDestroyView() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- Parse attributes during inflation from a view hierarchy into the arguments we handle. - - - -
- -
- - - - - - void - - onLowMemory() - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - setArguments(Bundle args) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaFragment - () -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment. This constructor is public only for use by an - inflater. Use newInstance() to create a StreetViewPanoramaFragment programmatically. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - StreetViewPanorama - - getStreetViewPanorama - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. -

-

Gets the underlying StreetViewPanorama that is tied to the view wrapped by this fragment.

-
-
Returns
-
  • the StreetViewPanorama. Null if the view of the fragment is not yet ready. This can - happen if the fragment lifecyle have not gone through - onCreateView(LayoutInflater, ViewGroup, Bundle) yet. This can also happen if - Google Play services is not available. If Google Play services becomes available - afterwards and the fragment have gone through - onCreateView(LayoutInflater, ViewGroup, Bundle), calling this method again - will initialize and return the StreetViewPanorama. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getStreetViewPanoramaAsync - (OnStreetViewPanoramaReadyCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - -

Note that: -

    -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • The callback will be executed in the main thread. -
  • The StreetViewPanorama object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the panorama is ready to be - used. -
-
- -
-
- - - - -
-

- - public - static - - - - StreetViewPanoramaFragment - - newInstance - () -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment, using default options.

- -
-
- - - - -
-

- - public - static - - - - StreetViewPanoramaFragment - - newInstance - (StreetViewPanoramaOptions options) -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityCreated - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onAttach - (Activity activity) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroyView - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Parse attributes during inflation from a view hierarchy into the arguments we handle. -

- -
-
- - - - -
-

- - public - - - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setArguments - (Bundle args) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaOptions.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaOptions.html deleted file mode 100644 index 696a3cfbd181..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaOptions.html +++ /dev/null @@ -1,2518 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

StreetViewPanoramaOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.StreetViewPanoramaOptions
- - - - - - - -
- - -

Class Overview

-

Defines configuration PanoramaOptions for a StreetViewPanorama. - These options can be used when adding a panorama to your application programmatically. - If you are using a StreetViewPanoramaFragment, you can pass these options in using the - static factory method newInstance(StreetViewPanoramaOptions). - If you are using a StreetViewPanoramaView, you can pass these options in using the - constructor - StreetViewPanoramaView(Context, StreetViewPanoramaOptions). -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaOptions() - -
- Creates a new StreetViewPanoramaOptions object. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Boolean - - getPanningGesturesEnabled() - -
- - - - - - String - - getPanoramaId() - -
- - - - - - LatLng - - getPosition() - -
- - - - - - Integer - - getRadius() - -
- - - - - - Boolean - - getStreetNamesEnabled() - -
- - - - - - StreetViewPanoramaCamera - - getStreetViewPanoramaCamera() - -
- - - - - - Boolean - - getUseViewLifecycleInFragment() - -
- - - - - - Boolean - - getUserNavigationEnabled() - -
- - - - - - Boolean - - getZoomGesturesEnabled() - -
- - - - - - StreetViewPanoramaOptions - - panningGesturesEnabled(boolean enabled) - -
- Toggles the ability for users to use pan around on panoramas using gestures. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - panoramaCamera(StreetViewPanoramaCamera camera) - -
- Specifies the initial camera for the Street View panorama. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - panoramaId(String panoId) - -
- Specifies the initial position for the Street View panorama based on a panorama id. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - position(LatLng position, Integer radius) - -
- Specifies the initial position for the Street View panorama based upon location and radius. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - position(LatLng position) - -
- Specifies the initial position for the Street View panorama based upon location. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - streetNamesEnabled(boolean enabled) - -
- Toggles the ability for users to see street names on panoramas. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - useViewLifecycleInFragment(boolean useViewLifecycleInFragment) - -
- When using a StreetViewPanoramaFragment, this flag specifies whether the lifecycle of - the Street View panorama should be tied to the fragment's view or the fragment itself. - - - -
- -
- - - - - - StreetViewPanoramaOptions - - userNavigationEnabled(boolean enabled) - -
- Toggles the ability for users to move between panoramas. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - StreetViewPanoramaOptions - - zoomGesturesEnabled(boolean enabled) - -
- Toggles the ability for users to zoom on panoramas using gestures. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaOptions - () -

-
-
- - - -
-
- - - - -

Creates a new StreetViewPanoramaOptions object. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Boolean - - getPanningGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • True if users are initially able to pan via gestures on Street View panoramas
-
- -
-
- - - - -
-

- - public - - - - - String - - getPanoramaId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The initial panorama ID for the Street View panorama, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - LatLng - - getPosition - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The initial position for the Street View panorama, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Integer - - getRadius - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The initial radius used to search for a Street View panorama, or null if - unspecified. -
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getStreetNamesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • True if users are initially able to see street names on Street View panoramas
-
- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera - - getStreetViewPanoramaCamera - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The initial camera for the Street View panorama, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getUseViewLifecycleInFragment - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the useViewLifecycleInFragment option, or null if unspecified.
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getUserNavigationEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • True if users are initially able to move to different Street View panoramas
-
- -
-
- - - - -
-

- - public - - - - - Boolean - - getZoomGesturesEnabled - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • True if users are initially able to zoom via gestures on Street View panoramas
-
- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - panningGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Toggles the ability for users to use pan around on panoramas using gestures. - See setPanningGesturesEnabled(boolean) for more details. - The default is true -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - panoramaCamera - (StreetViewPanoramaCamera camera) -

-
-
- - - -
-
- - - - -

Specifies the initial camera for the Street View panorama. -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - panoramaId - (String panoId) -

-
-
- - - -
-
- - - - -

Specifies the initial position for the Street View panorama based on a panorama id. - The position set by the panoramaID takes precedence over a position set by a LatLng -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - position - (LatLng position, Integer radius) -

-
-
- - - -
-
- - - - -

Specifies the initial position for the Street View panorama based upon location and radius. - The position set by the panoramaID, if set, takes precedence over a position set by a LatLng -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - position - (LatLng position) -

-
-
- - - -
-
- - - - -

Specifies the initial position for the Street View panorama based upon location. - The position set by the panoramaID, if set, takes precedence over a position set by a LatLng -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - streetNamesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Toggles the ability for users to see street names on panoramas. - See setStreetNamesEnabled(boolean) for more details. - The default is true -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - useViewLifecycleInFragment - (boolean useViewLifecycleInFragment) -

-
-
- - - -
-
- - - - -

When using a StreetViewPanoramaFragment, this flag specifies whether the lifecycle of - the Street View panorama should be tied to the fragment's view or the fragment itself. The - default value is false, tying the lifecycle of the Street View panorama to the - fragment. -

- Using the lifecycle of the fragment allows faster rendering of the Street View panorama when - the fragment is detached and reattached, because the underlying GL context is preserved. This - has the cost that detaching the fragment, but not destroying it, will not release memory used - by the panorama. -

- Using the lifecycle of a fragment's view means that a Street View panorama is not reused when - the fragment is detached and reattached. This will cause the map to re-render from scratch, - which can take a few seconds. It also means that while a fragment is detached, and therefore - has no view, all StreetViewPanorama methods will throw NullPointerException. -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - userNavigationEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Toggles the ability for users to move between panoramas. - See setUserNavigationEnabled(boolean) for more details. - The default is true -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOptions - - zoomGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Toggles the ability for users to zoom on panoramas using gestures. - See setZoomGesturesEnabled(boolean) for more details. - The default is true -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaView.html b/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaView.html deleted file mode 100644 index f461614b1ae8..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/StreetViewPanoramaView.html +++ /dev/null @@ -1,15814 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaView

- - - - - - - - - - - - - - - - - extends FrameLayout
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳android.widget.FrameLayout
      ↳com.google.android.gms.maps.StreetViewPanoramaView
- - - - - - - -
- - -

Class Overview

-

A View which displays a Street View panorama (with data obtained from the Google Maps service). - When focused, it will capture keypresses and touch gestures to move the panorama. -

- Users of this class must forward all the life cycle methods from the Activity or - Fragment containing this view to the corresponding ones in this class. In - particular, you must forward the following methods: -

-

- A StreetViewPanorama must be acquired using - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback). - The StreetViewPanoramaView automatically initializes the Street View system and the view. - -

- For a simpler method of displaying a StreetViewPanorama use StreetViewPanoramaFragment - (or SupportStreetViewPanoramaFragment) if you are looking to target earlier platforms. -

- Note: You are advised not to add children to this view. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaView(Context context) - -
- - - - - - - - StreetViewPanoramaView(Context context, AttributeSet attrs) - -
- - - - - - - - StreetViewPanoramaView(Context context, AttributeSet attrs, int defStyle) - -
- - - - - - - - StreetViewPanoramaView(Context context, StreetViewPanoramaOptions options) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - StreetViewPanorama - - getStreetViewPanorama() - -
- - This method is deprecated. - Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. - - - -
- -
- - - - - - void - - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback callback) - -
- Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - - - -
- -
- - - final - - - void - - onCreate(Bundle savedInstanceState) - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onDestroy() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onLowMemory() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onPause() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onResume() - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - final - - - void - - onSaveInstanceState(Bundle outState) - -
- You must call this method from the parent Activity/Fragment's corresponding method. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.FrameLayout - -
- - -
-
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaView - (Context context) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - StreetViewPanoramaView - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - StreetViewPanoramaView - (Context context, AttributeSet attrs, int defStyle) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - - - StreetViewPanoramaView - (Context context, StreetViewPanoramaOptions options) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - StreetViewPanorama - - getStreetViewPanorama - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. -

-

Gets the underlying StreetViewPanorama that is tied to this view.

-
-
Returns
-
  • the StreetViewPanorama. Null if the view is not yet ready. This can happen when - Google Play services is not available. If Google Play services becomes available - afterwards, calling this method again will initialize and return the panorama. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getStreetViewPanoramaAsync - (OnStreetViewPanoramaReadyCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - -

Note that: -

    -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • The callback will be executed in the main thread. -
  • The StreetViewPanorama object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the panorama is ready to be - used. -
-
- -
-
- - - - -
-

- - public - - final - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - final - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

You must call this method from the parent Activity/Fragment's corresponding method.

-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html b/docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html deleted file mode 100644 index 8548903cd910..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html +++ /dev/null @@ -1,3795 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SupportMapFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SupportMapFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.support.v4.app.Fragment
    ↳com.google.android.gms.maps.SupportMapFragment
- - - - - - - -
- - -

Class Overview

-

A Map component in an app. This fragment is the simplest way to place a map in an - application. It's a wrapper around a view of a map to automatically handle the necessary life - cycle needs. Being a fragment, this component can be added to an activity's layout file simply - with the XML below. - - 

- <fragment
-    class="com.google.android.gms.maps.SupportMapFragment"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"/>
- - A GoogleMap must be acquired using getMapAsync(OnMapReadyCallback). - This class automatically initializes the maps system and the view. -

- A view can be removed when the SupportMapFragment's onDestroyView() method is called and the - useViewLifecycleInFragment(boolean) option is set. When this happens - the SupportMapFragment is no longer valid until the view is recreated again later when SupportMapFragment's - onCreateView(LayoutInflater, ViewGroup, Bundle) method is called. -

- Any objects obtained from the GoogleMap is associated with the view. It's important to - not hold on to objects (e.g. Marker) beyond the - view's life. Otherwise it will cause a memory leak as the view cannot be released. -

- To use this class, you must include the Android support library in your build path. -

-

Developer Guide

-

- For more information, read the Google Maps Android API v2 - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SupportMapFragment() - -
- Creates a map fragment. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - GoogleMap - - getMap() - -
- - This method is deprecated. - Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. - - - -
- -
- - - - - - void - - getMapAsync(OnMapReadyCallback callback) - -
- Sets a callback object which will be triggered when the GoogleMap instance is ready - to be used. - - - -
- -
- - - - static - - SupportMapFragment - - newInstance() - -
- Creates a map fragment, using default options. - - - -
- -
- - - - static - - SupportMapFragment - - newInstance(GoogleMapOptions options) - -
- Creates a map fragment with the given options. - - - -
- -
- - - - - - void - - onActivityCreated(Bundle savedInstanceState) - -
- - - - - - void - - onAttach(Activity activity) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onDestroyView() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- Parse attributes during inflation from a view hierarchy into the arguments we handle. - - - -
- -
- - - - - - void - - onLowMemory() - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - setArguments(Bundle args) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.support.v4.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SupportMapFragment - () -

-
-
- - - -
-
- - - - -

Creates a map fragment. This constructor is public only for use by an inflater. Use - newInstance() to create a SupportMapFragment programmatically. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - GoogleMap - - getMap - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getMapAsync(OnMapReadyCallback) instead. The callback - method provides you with a GoogleMap instance guaranteed to be non-null and ready to - be used. -

-

Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - getMapAsync - (OnMapReadyCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback object which will be triggered when the GoogleMap instance is ready - to be used. - -

Note that: -

    -
  • This method must be called from the main thread. -
  • The callback will be executed in the main thread. -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • In the rare case where the GoogleMap is destroyed immediately after creation, the - callback is not triggered. -
  • The GoogleMap object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the map is ready to be used. -
-
- -
-
- - - - -
-

- - public - static - - - - SupportMapFragment - - newInstance - () -

-
-
- - - -
-
- - - - -

Creates a map fragment, using default options.

- -
-
- - - - -
-

- - public - static - - - - SupportMapFragment - - newInstance - (GoogleMapOptions options) -

-
-
- - - -
-
- - - - -

Creates a map fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityCreated - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onAttach - (Activity activity) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroyView - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Parse attributes during inflation from a view hierarchy into the arguments we handle. -

- -
-
- - - - -
-

- - public - - - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setArguments - (Bundle args) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/SupportStreetViewPanoramaFragment.html b/docs/html/reference/com/google/android/gms/maps/SupportStreetViewPanoramaFragment.html deleted file mode 100644 index 3370c4132e93..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/SupportStreetViewPanoramaFragment.html +++ /dev/null @@ -1,3794 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SupportStreetViewPanoramaFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SupportStreetViewPanoramaFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.support.v4.app.Fragment
    ↳com.google.android.gms.maps.SupportStreetViewPanoramaFragment
- - - - - - - -
- - -

Class Overview

-

A StreetViewPanorama component in an app. This fragment is the simplest way to place a - Street View panorama in an application. It's a wrapper around a view of a panorama to - automatically handle the necessary life cycle needs. Being a fragment, this component can be - added to an activity's layout file simply with the XML below. - - 

- <fragment
-    class="com.google.android.gms.maps.SupportStreetViewPanoramaFragment"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"/>
- - A StreetViewPanorama must be acquired using - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback). - The SupportStreetViewPanoramaFragment automatically initializes the Street View system and the - view. - -

- A view can be removed when the SupportStreetViewPanoramaFragment's onDestroyView() method is - called and the useViewLifecycleInFragment(boolean) option is - set. When this happens the SupportStreetViewPanoramaFragment is no longer valid until the view is - recreated again later when MapFragment's onCreateView(LayoutInflater, ViewGroup, Bundle) - method is called. -

- Any object obtained from the StreetViewPanorama is associated with the view. It's - important to not hold on to objects beyond the view's life. Otherwise it will cause a memory leak - as the view cannot be released. -

- Use this class only if you are targeting API 12 and above. Otherwise, use - SupportStreetViewPanoramaFragment. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SupportStreetViewPanoramaFragment() - -
- Creates a streetview panorama fragment. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - StreetViewPanorama - - getStreetViewPanorama() - -
- - This method is deprecated. - Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. - - - -
- -
- - - - - - void - - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback callback) - -
- Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - - - -
- -
- - - - static - - SupportStreetViewPanoramaFragment - - newInstance() - -
- Creates a streetview panorama fragment, using default options. - - - -
- -
- - - - static - - SupportStreetViewPanoramaFragment - - newInstance(StreetViewPanoramaOptions options) - -
- Creates a streetview panorama fragment with the given options. - - - -
- -
- - - - - - void - - onActivityCreated(Bundle savedInstanceState) - -
- - - - - - void - - onAttach(Activity activity) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onDestroyView() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- Parse attributes during inflation from a view hierarchy into the arguments we handle. - - - -
- -
- - - - - - void - - onLowMemory() - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - setArguments(Bundle args) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.support.v4.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SupportStreetViewPanoramaFragment - () -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment. This constructor is public only for use by an - inflater. Use newInstance() to create a SupportStreetViewPanoramaFragment programmatically. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - StreetViewPanorama - - getStreetViewPanorama - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use - getStreetViewPanoramaAsync(OnStreetViewPanoramaReadyCallback) - instead. The callback method provides you with a StreetViewPanorama instance - guaranteed to be non-null and ready to be used. -

-

Gets the underlying StreetViewPanorama that is tied to the view wrapped by this fragment.

-
-
Returns
-
  • the StreetViewPanorama. Null if the view of the fragment is not yet ready. This can - happen if the fragment lifecyle have not gone through - onCreateView(LayoutInflater, ViewGroup, Bundle) yet. This can also happen if - Google Play services is not available. If Google Play services becomes available - afterwards and the fragment have gone through - onCreateView(LayoutInflater, ViewGroup, Bundle), calling this method again - will initialize and return the StreetViewPanorama. -
-
- -
-
- - - - -
-

- - public - - - - - void - - getStreetViewPanoramaAsync - (OnStreetViewPanoramaReadyCallback callback) -

-
-
- - - -
-
- - - - -

Sets a callback object which will be triggered when the StreetViewPanorama instance - is ready to be used. - -

Note that: -

    -
  • In the case where Google Play services is not installed on the user's device, the - callback will not be triggered until the user installs it. -
  • The callback will be executed in the main thread. -
  • The StreetViewPanorama object provided by the callback is non-null. -

-
-
Parameters
- - - - -
callback - The callback object that will be triggered when the panorama is ready to be - used. -
-
- -
-
- - - - -
-

- - public - static - - - - SupportStreetViewPanoramaFragment - - newInstance - () -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment, using default options.

- -
-
- - - - -
-

- - public - static - - - - SupportStreetViewPanoramaFragment - - newInstance - (StreetViewPanoramaOptions options) -

-
-
- - - -
-
- - - - -

Creates a streetview panorama fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityCreated - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onAttach - (Activity activity) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroyView - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

Parse attributes during inflation from a view hierarchy into the arguments we handle. -

- -
-
- - - - -
-

- - public - - - - - void - - onLowMemory - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setArguments - (Bundle args) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/UiSettings.html b/docs/html/reference/com/google/android/gms/maps/UiSettings.html deleted file mode 100644 index 30063d942cbf..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/UiSettings.html +++ /dev/null @@ -1,2507 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UiSettings | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

UiSettings

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.UiSettings
- - - - - - - -
- - -

Class Overview

-

Settings for the user interface of a GoogleMap. To obtain this interface, call - getUiSettings(). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - isCompassEnabled() - -
- Gets whether the compass is enabled/disabled. - - - -
- -
- - - - - - boolean - - isIndoorLevelPickerEnabled() - -
- Gets whether the indoor level picker is enabled/disabled. - - - -
- -
- - - - - - boolean - - isMapToolbarEnabled() - -
- Gets whether the Map Toolbar is enabled/disabled. - - - -
- -
- - - - - - boolean - - isMyLocationButtonEnabled() - -
- Gets whether the my-location button is enabled/disabled. - - - -
- -
- - - - - - boolean - - isRotateGesturesEnabled() - -
- Gets whether rotate gestures are enabled/disabled. - - - -
- -
- - - - - - boolean - - isScrollGesturesEnabled() - -
- Gets whether scroll gestures are enabled/disabled. - - - -
- -
- - - - - - boolean - - isTiltGesturesEnabled() - -
- Gets whether tilt gestures are enabled/disabled. - - - -
- -
- - - - - - boolean - - isZoomControlsEnabled() - -
- Gets whether the zoom controls are enabled/disabled. - - - -
- -
- - - - - - boolean - - isZoomGesturesEnabled() - -
- Gets whether zoom gestures are enabled/disabled. - - - -
- -
- - - - - - void - - setAllGesturesEnabled(boolean enabled) - -
- Sets the preference for whether all gestures should be enabled or disabled. - - - -
- -
- - - - - - void - - setCompassEnabled(boolean enabled) - -
- Enables or disables the compass. - - - -
- -
- - - - - - void - - setIndoorLevelPickerEnabled(boolean enabled) - -
- Sets whether the indoor level picker is enabled when indoor mode is enabled. - - - -
- -
- - - - - - void - - setMapToolbarEnabled(boolean enabled) - -
- Sets the preference for whether the Map Toolbar should be enabled or disabled. - - - -
- -
- - - - - - void - - setMyLocationButtonEnabled(boolean enabled) - -
- Enables or disables the my-location button. - - - -
- -
- - - - - - void - - setRotateGesturesEnabled(boolean enabled) - -
- Sets the preference for whether rotate gestures should be enabled or disabled. - - - -
- -
- - - - - - void - - setScrollGesturesEnabled(boolean enabled) - -
- Sets the preference for whether scroll gestures should be enabled or disabled. - - - -
- -
- - - - - - void - - setTiltGesturesEnabled(boolean enabled) - -
- Sets the preference for whether tilt gestures should be enabled or disabled. - - - -
- -
- - - - - - void - - setZoomControlsEnabled(boolean enabled) - -
- Enables or disables the zoom controls. - - - -
- -
- - - - - - void - - setZoomGesturesEnabled(boolean enabled) - -
- Sets the preference for whether zoom gestures should be enabled or disabled. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - isCompassEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether the compass is enabled/disabled.

-
-
Returns
-
  • true if the compass is enabled; false if the compass is disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isIndoorLevelPickerEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether the indoor level picker is enabled/disabled. That is, whether the level picker - will appear when a building with indoor maps is focused.

-
-
Returns
-
  • true if the level picker is enabled; false if the level picker - is disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isMapToolbarEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether the Map Toolbar is enabled/disabled.

-
-
Returns
-
  • true if the Map Toolbar is enabled; false otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isMyLocationButtonEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether the my-location button is enabled/disabled.

-
-
Returns
-
  • true if the my-location button is enabled; false if the my-location - button is disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isRotateGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether rotate gestures are enabled/disabled.

-
-
Returns
-
  • true if rotate gestures are enabled; false if rotate gestures are - disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isScrollGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether scroll gestures are enabled/disabled.

-
-
Returns
-
  • true if scroll gestures are enabled; false if scroll gestures are - disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isTiltGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether tilt gestures are enabled/disabled.

-
-
Returns
-
  • true if tilt gestures are enabled; false if tilt gestures are - disabled. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isZoomControlsEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether the zoom controls are enabled/disabled.

-
-
Returns
-
  • true if the zoom controls are enabled; false if the zoom controls are - disabled; -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isZoomGesturesEnabled - () -

-
-
- - - -
-
- - - - -

Gets whether zoom gestures are enabled/disabled.

-
-
Returns
-
  • true if zoom gestures are enabled; false if zoom gestures are - disabled. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAllGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether all gestures should be enabled or disabled. If enabled, all - gestures are available; otherwise, all gestures are disabled. This doesn't restrict users - from tapping any on screen buttons to move the camera (e.g., compass or zoom controls), nor - does it restrict programmatic movements and animation.

-
-
Parameters
- - - - -
enabled - true to enable all gestures; false to disable all gestures. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setCompassEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Enables or disables the compass. The compass is an icon on the map that indicates the - direction of north on the map. If enabled, it is only shown when the camera is tilted or - rotated away from its default orientation (tilt of 0 and a bearing of 0). When a user clicks - the compass, the camera orients itself to its default orientation and fades away shortly - after. If disabled, the compass will never be displayed. -

- By default, the compass is enabled (and hence shown when the camera is not in the default - orientation).

-
-
Parameters
- - - - -
enabled - true to enable the compass; false to disable the compass. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setIndoorLevelPickerEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets whether the indoor level picker is enabled when indoor mode is enabled. If true, the - level picker will appear when a building with indoor maps is focused. If false, no level - picker will appear - an application will need to provide its own way of selecting levels. - The default behaviour is to show the level picker.

-
-
Parameters
- - - - -
enabled - true to show or false to hide the level picker. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setMapToolbarEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether the Map Toolbar should be enabled or disabled. If enabled, - users will see a bar with various context-dependent actions, including 'open this map in - the Google Maps app' and 'find directions to the highlighted marker in the Google Maps app'. -

By default, the Map Toolbar is enabled.

-
-
Parameters
- - - - -
enabled - true to enable the Map Toolbar; false to disable the Map - Toolbar. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setMyLocationButtonEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Enables or disables the my-location button. The my-location button causes the camera to move - such that the user's location is in the center of the map. If the button is enabled, it is - only shown when the my-location layer is enabled. -

- By default, the my-location button is enabled (and hence shown when the my-location layer is - enabled).

-
-
Parameters
- - - - -
enabled - true to enable the my-location button; false to disable the - my-location button. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setRotateGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether rotate gestures should be enabled or disabled. If enabled, - users can use a two-finger rotate gesture to rotate the camera. If disabled, users cannot - rotate the camera via gestures. This setting doesn't restrict the user from tapping the - compass icon to reset the camera orientation, nor does it restrict programmatic movements and - animation of the camera. -

- By default, rotate gestures are enabled.

-
-
Parameters
- - - - -
enabled - true to enable rotate gestures; false to disable rotate - gestures. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setScrollGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether scroll gestures should be enabled or disabled. If enabled, - users can swipe to pan the camera. If disabled, swiping has no effect. This setting doesn't - restrict programmatic movement and animation of the camera. -

- By default, scroll gestures are enabled.

-
-
Parameters
- - - - -
enabled - true to enable scroll gestures; false to disable scroll - gestures. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setTiltGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether tilt gestures should be enabled or disabled. If enabled, - users can use a two-finger vertical down swipe to tilt the camera. If disabled, users cannot - tilt the camera via gestures. This setting doesn't restrict users from tapping the compass - icon to reset the camera orientation, nor does it restrict programmatic movement and - animation of the camera. -

- By default, tilt gestures are enabled.

-
-
Parameters
- - - - -
enabled - true to enable tilt gestures; false to disable tilt gestures. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZoomControlsEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Enables or disables the zoom controls. If enabled, the zoom controls are a pair of buttons - (one for zooming in, one for zooming out) that appear on the screen. When pressed, they cause - the camera to zoom in (or out) by one zoom level. If disabled, the zoom controls are not - shown. -

- By default, the zoom controls are enabled.

-
-
Parameters
- - - - -
enabled - true to enable the zoom controls; false to disable the zoom - controls. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZoomGesturesEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets the preference for whether zoom gestures should be enabled or disabled. If enabled, - users can either double tap/two-finger tap or pinch to zoom the camera. If disabled, these - gestures have no effect. This setting doesn't affect the zoom buttons, nor does it restrict - programmatic movement and animation of the camera. -

- By default, zoom gestures are enabled.

-
-
Parameters
- - - - -
enabled - true to enable zoom gestures; false to disable zoom gestures. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html b/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html deleted file mode 100644 index cde369082800..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html +++ /dev/null @@ -1,1251 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BitmapDescriptor | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BitmapDescriptor

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.BitmapDescriptor
- - - - - - - -
- - -

Class Overview

-

Defines an image. For a marker, it can be used to set the image of the marker icon. For a ground - overlay, it can be used to set the image to place on the surface of the earth. To obtain a - BitmapDescriptor use the factory class BitmapDescriptorFactory. -

- Example of setting the icon of a marker - BitmapDescriptor. - 

 GoogleMap map = ... // get a map.
-   // Add a marker at San Francisco with an azure colored marker.
-   Marker marker = map.add(new MarkerOptions()
-       .position(new LatLng(37.7750, 122.4183))
-       .title("San Francisco")
-       .snippet("Population: 776733"))
-       .icon(BitmapDescriptorFactory.defaultMarker(BitmapDescriptorFactory.HUE_AZURE));
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html b/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html deleted file mode 100644 index 54d13163b02c..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html +++ /dev/null @@ -1,2272 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BitmapDescriptorFactory | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BitmapDescriptorFactory

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.BitmapDescriptorFactory
- - - - - - - -
- - -

Class Overview

-

Used to create a definition of an image, used for marker icons and ground overlays. -

- Prior to using any methods from this class, you must do one of the following to ensure that this - class is initialized: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
floatHUE_AZURE - - - - -
floatHUE_BLUE - - - - -
floatHUE_CYAN - - - - -
floatHUE_GREEN - - - - -
floatHUE_MAGENTA - - - - -
floatHUE_ORANGE - - - - -
floatHUE_RED - - - - -
floatHUE_ROSE - - - - -
floatHUE_VIOLET - - - - -
floatHUE_YELLOW - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - BitmapDescriptor - - defaultMarker() - -
- Creates a bitmap descriptor that refers to the default marker image. - - - -
- -
- - - - static - - BitmapDescriptor - - defaultMarker(float hue) - -
- Creates a bitmap descriptor that refers to a colorization of the default marker image. - - - -
- -
- - - - static - - BitmapDescriptor - - fromAsset(String assetName) - -
- Creates a BitmapDescriptor using the name of an image in the assets directory. - - - -
- -
- - - - static - - BitmapDescriptor - - fromBitmap(Bitmap image) - -
- Creates a bitmap descriptor from a given image. - - - -
- -
- - - - static - - BitmapDescriptor - - fromFile(String fileName) - -
- Creates a BitmapDescriptor using the name of an image file located in the internal - storage. - - - -
- -
- - - - static - - BitmapDescriptor - - fromPath(String absolutePath) - -
- Creates a bitmap descriptor from an absolute file path. - - - -
- -
- - - - static - - BitmapDescriptor - - fromResource(int resourceId) - -
- Creates a BitmapDescriptor using the resource id of an image. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - float - - HUE_AZURE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 210.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_BLUE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 240.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_CYAN -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 180.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_GREEN -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 120.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_MAGENTA -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 300.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_ORANGE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 30.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_RED -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 0.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_ROSE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 330.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_VIOLET -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 270.0 - - -
- -
-
- - - - - -
-

- - public - static - final - float - - HUE_YELLOW -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 60.0 - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - BitmapDescriptor - - defaultMarker - () -

-
-
- - - -
-
- - - - -

Creates a bitmap descriptor that refers to the default marker image.

- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - defaultMarker - (float hue) -

-
-
- - - -
-
- - - - -

Creates a bitmap descriptor that refers to a colorization of the default marker image. For - convenience, there is a predefined set of hue values. See example HUE_YELLOW.

-
-
Parameters
- - - - -
hue - The hue of the marker. Value must be greater or equal to 0 and less than 360. -
-
- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - fromAsset - (String assetName) -

-
-
- - - -
-
- - - - -

Creates a BitmapDescriptor using the name of an image in the assets directory.

-
-
Parameters
- - - - -
assetName - The name of an image in the assets directory.
-
-
-
Returns
-
  • the BitmapDescriptor that was loaded from the asset or null if failed - to load. -
-
- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - fromBitmap - (Bitmap image) -

-
-
- - - -
-
- - - - -

Creates a bitmap descriptor from a given image. -

- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - fromFile - (String fileName) -

-
-
- - - -
-
- - - - -

Creates a BitmapDescriptor using the name of an image file located in the internal - storage. In particular, this calls openFileInput(String).

-
-
Parameters
- - - - -
fileName - The name of the image file.
-
-
-
Returns
-
  • the BitmapDescriptor that was loaded from the asset or null if failed - to load. -
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - fromPath - (String absolutePath) -

-
-
- - - -
-
- - - - -

Creates a bitmap descriptor from an absolute file path.

-
-
Parameters
- - - - -
absolutePath - The absolute path of the image.
-
-
-
Returns
-
  • the BitmapDescriptor that was loaded from the absolute path or null - if failed to load. -
-
- -
-
- - - - -
-

- - public - static - - - - BitmapDescriptor - - fromResource - (int resourceId) -

-
-
- - - -
-
- - - - -

Creates a BitmapDescriptor using the resource id of an image.

-
-
Parameters
- - - - -
resourceId - The resource id of an image.
-
-
-
Returns
-
  • the BitmapDescriptor that was loaded from the asset or null if failed - to load. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html b/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html deleted file mode 100644 index 9440ec2098ad..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html +++ /dev/null @@ -1,1678 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CameraPosition.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

CameraPosition.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.CameraPosition.Builder
- - - - - - - -
- - -

Class Overview

-

Builds camera position.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CameraPosition.Builder() - -
- Creates an empty builder. - - - -
- -
- - - - - - - - CameraPosition.Builder(CameraPosition previous) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - CameraPosition.Builder - - bearing(float bearing) - -
- Sets the direction that the camera is pointing in, in degrees clockwise from north. - - - -
- -
- - - - - - CameraPosition - - build() - -
- Builds a CameraPosition. - - - -
- -
- - - - - - CameraPosition.Builder - - target(LatLng location) - -
- Sets the location that the camera is pointing at. - - - -
- -
- - - - - - CameraPosition.Builder - - tilt(float tilt) - -
- Sets the angle, in degrees, of the camera from the nadir (directly facing the Earth). - - - -
- -
- - - - - - CameraPosition.Builder - - zoom(float zoom) - -
- Sets the zoom level of the camera. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CameraPosition.Builder - () -

-
-
- - - -
-
- - - - -

Creates an empty builder. -

- -
-
- - - - -
-

- - public - - - - - - - CameraPosition.Builder - (CameraPosition previous) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - CameraPosition.Builder - - bearing - (float bearing) -

-
-
- - - -
-
- - - - -

Sets the direction that the camera is pointing in, in degrees clockwise from north. -

- -
-
- - - - -
-

- - public - - - - - CameraPosition - - build - () -

-
-
- - - -
-
- - - - -

Builds a CameraPosition.

- -
-
- - - - -
-

- - public - - - - - CameraPosition.Builder - - target - (LatLng location) -

-
-
- - - -
-
- - - - -

Sets the location that the camera is pointing at. -

- -
-
- - - - -
-

- - public - - - - - CameraPosition.Builder - - tilt - (float tilt) -

-
-
- - - -
-
- - - - -

Sets the angle, in degrees, of the camera from the nadir (directly facing the Earth). - When changing the camera position for a map, this value is restricted depending on the - zoom level of the camera. The restrictions are as follows: -

    -
  • For zoom levels less than 10 the maximum is 30. -
  • For zoom levels from 10 to 14 the maximum increases linearly from 30 to 45 (e.g. at - zoom level 12, the maximum is 37.5). -
  • For zoom levels from 14 to 15.5 the maximum increases linearly from 45 to 67.5. -
  • For zoom levels greater than 15.5 the maximum is 67.5. -
- The minimum is always 0 (directly down). If you specify a value outside this range and - try to move the camera to this camera position it will be clamped to these bounds. -

- -
-
- - - - -
-

- - public - - - - - CameraPosition.Builder - - zoom - (float zoom) -

-
-
- - - -
-
- - - - -

Sets the zoom level of the camera. Zoom level is defined such that at zoom level 0, the - whole world is approximately 256dp wide (assuming that the camera is not tilted). - Increasing the zoom level by 1 doubles the width of the world on the screen. Hence at - zoom level N, the width of the world is approximately 256 * 2 N dp, i.e., at - zoom level 2, the whole world is approximately 1024dp wide. -

- When changing the camera position for a map, the zoom level of the camera is restricted - to a certain range depending on various factors including location, map type and map - size. Use GoogleMap.getMinZoomLevel and - GoogleMap.getMaxZoomLevel - to find the restrictions. Note that the camera zoom need not be an integer value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html b/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html deleted file mode 100644 index 7e38f6192e86..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html +++ /dev/null @@ -1,2186 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CameraPosition | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CameraPosition

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.CameraPosition
- - - - - - - -
- - -

Class Overview

-

An immutable class that aggregates all camera position parameters. - -

-

Developer Guide

-

- For more information, read the Changing the View - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classCameraPosition.Builder - Builds camera position.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - floatbearing - Direction that the camera is pointing in, in degrees clockwise from north. - - - -
- public - - final - LatLngtarget - The location that the camera is pointing at. - - - -
- public - - final - floattilt - The angle, in degrees, of the camera angle from the nadir (directly facing the Earth). - - - -
- public - - final - floatzoom - Zoom level near the center of the screen. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CameraPosition(LatLng target, float zoom, float tilt, float bearing) - -
- Constructs a CameraPosition. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - CameraPosition.Builder - - builder() - -
- Creates a builder for a camera position. - - - -
- -
- - - - static - - CameraPosition.Builder - - builder(CameraPosition camera) - -
- Creates a builder for a camera position, initialized to a given position. - - - -
- -
- - - - static - - CameraPosition - - createFromAttributes(Context context, AttributeSet attrs) - -
- Creates a CameraPostion from the attribute set - - - - -
- -
- - - - - - boolean - - equals(Object o) - -
- - - final - static - - CameraPosition - - fromLatLngZoom(LatLng target, float zoom) - -
- Constructs a CameraPosition pointed for a particular target and zoom level. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - float - - bearing -

-
- - - - -
-
- - - - -

Direction that the camera is pointing in, in degrees clockwise from north. -

- - -
-
- - - - - -
-

- - public - - final - LatLng - - target -

-
- - - - -
-
- - - - -

The location that the camera is pointing at. -

- - -
-
- - - - - -
-

- - public - - final - float - - tilt -

-
- - - - -
-
- - - - -

The angle, in degrees, of the camera angle from the nadir (directly facing the Earth). See - tilt for details of restrictions on the range of values. -

- - -
-
- - - - - -
-

- - public - - final - float - - zoom -

-
- - - - -
-
- - - - -

Zoom level near the center of the screen. See zoom for the definition of the - camera's zoom level. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CameraPosition - (LatLng target, float zoom, float tilt, float bearing) -

-
-
- - - -
-
- - - - -

Constructs a CameraPosition.

-
-
Parameters
- - - - - - - - - - - - - -
target - The target location to align with the center of the screen.
zoom - Zoom level at target. See - zoom for details - of restrictions.
tilt - The camera angle, in degrees, from the nadir (directly down). See - tilt for details - of restrictions.
bearing - Direction that the camera is pointing in, in degrees clockwise from north. - This value will be normalized to be within 0 degrees inclusive and 360 degrees - exclusive.
-
-
-
Throws
- - - - - - - -
NullPointerException - if target is null
IllegalArgumentException - if tilt is outside the range of - 0 to 90 degrees inclusive. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - CameraPosition.Builder - - builder - () -

-
-
- - - -
-
- - - - -

Creates a builder for a camera position.

- -
-
- - - - -
-

- - public - static - - - - CameraPosition.Builder - - builder - (CameraPosition camera) -

-
-
- - - -
-
- - - - -

Creates a builder for a camera position, initialized to a given position.

- -
-
- - - - -
-

- - public - static - - - - CameraPosition - - createFromAttributes - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Creates a CameraPostion from the attribute set -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - final - - - CameraPosition - - fromLatLngZoom - (LatLng target, float zoom) -

-
-
- - - -
-
- - - - -

Constructs a CameraPosition pointed for a particular target and zoom level. The resultant - bearing is North, and the viewing angle is perpendicular to the Earth's surface. i.e., - directly facing the Earth's surface, with the top of the screen pointing North.

-
-
Parameters
- - - - - - - -
target - The target location to align with the center of the screen.
zoom - Zoom level at target. See - zoom(float) for - details on the range the value will be clamped to. The larger the value the more - zoomed in the camera is. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/Circle.html b/docs/html/reference/com/google/android/gms/maps/model/Circle.html deleted file mode 100644 index d5463c3927f4..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/Circle.html +++ /dev/null @@ -1,2348 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Circle | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Circle

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.Circle
- - - - - - - -
- - -

Class Overview

-

A circle on the earth's surface (spherical cap). - -

A circle has the following properties.

-
-
Center
-
The center of the Circle is specified as a LatLng.
-
Radius
-
The radius of the circle, specified in meters. It should be zero or greater.
-
Stroke Width
-
The width of the circle's outline in screen pixels. - The width is constant and independent of the camera's - zoom level. The default value is 10.
-
Stroke Color
-
The color of the circle outline in ARGB format, the same format used by - Color. The default value is black - (0xff000000).
-
Fill Color
-
The color of the circle fill in ARGB format, the same format used by - Color. The default value is transparent - (0x00000000).
-
Z-Index
-
The order in which this tile overlay is drawn with respect to other overlays (including - GroundOverlays, TileOverlays, Polylines, and Polygons but - not Markers). An overlay with a larger z-index is drawn over overlays with smaller - z-indices. The order of overlays with the same z-index is arbitrary. - The default zIndex is 0.
-
Visibility
-
Indicates if the circle is visible or invisible, i.e., whether it is drawn on the map. An - invisible circle is not drawn, but retains all of its other properties. The default is - true, i.e., visible.
-
- -

Methods that modify a Circle must be called on the main thread. If not, an - IllegalStateException will be thrown at runtime.

-

Example

- - 
 GoogleMap map;
- // ... get a map.
- // Add a circle in Sydney
- Circle circle = map.addCircle(new CircleOptions()
-     .center(new LatLng(-33.87365, 151.20689))
-     .radius(10000)
-     .strokeColor(Color.RED)
-     .fillColor(Color.BLUE));
-
- -

- Note that the current map renderer is unable to draw the circle fill - if the circle encompasses either the North or South pole. However, the - outline will still be drawn correctly. -

- -

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LatLng - - getCenter() - -
- Returns the center as a LatLng. - - - -
- -
- - - - - - int - - getFillColor() - -
- Returns the fill color of this Circle. - - - -
- -
- - - - - - String - - getId() - -
- Gets this circle's id. - - - -
- -
- - - - - - double - - getRadius() - -
- Returns the circle's radius, in meters. - - - -
- -
- - - - - - int - - getStrokeColor() - -
- Returns the stroke color. - - - -
- -
- - - - - - float - - getStrokeWidth() - -
- Returns the stroke width. - - - -
- -
- - - - - - float - - getZIndex() - -
- Returns the zIndex. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Checks whether the circle is visible. - - - -
- -
- - - - - - void - - remove() - -
- Removes this circle from the map. - - - -
- -
- - - - - - void - - setCenter(LatLng center) - -
- Sets the center using a LatLng. - - - -
- -
- - - - - - void - - setFillColor(int color) - -
- Sets the fill color. - - - -
- -
- - - - - - void - - setRadius(double radius) - -
- Sets the radius in meters. - - - -
- -
- - - - - - void - - setStrokeColor(int color) - -
- Sets the stroke color. - - - -
- -
- - - - - - void - - setStrokeWidth(float width) - -
- Sets the stroke width. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of the circle. - - - -
- -
- - - - - - void - - setZIndex(float zIndex) - -
- Sets the zIndex. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LatLng - - getCenter - () -

-
-
- - - -
-
- - - - -

Returns the center as a LatLng.

-
-
Returns
-
  • The geographic center as a LatLng. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getFillColor - () -

-
-
- - - -
-
- - - - -

Returns the fill color of this Circle.

-
-
Returns
-
  • The fill color of the circle in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this circle's id. The id will be unique amongst all Circles on a map. -

- -
-
- - - - -
-

- - public - - - - - double - - getRadius - () -

-
-
- - - -
-
- - - - -

Returns the circle's radius, in meters.

-
-
Returns
-
  • The radius in meters. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStrokeColor - () -

-
-
- - - -
-
- - - - -

Returns the stroke color.

-
-
Returns
-
  • The color of the circle in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getStrokeWidth - () -

-
-
- - - -
-
- - - - -

Returns the stroke width.

-
-
Returns
-
  • The width in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Returns the zIndex.

-
-
Returns
-
  • The zIndex of this circle. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Checks whether the circle is visible.

-
-
Returns
-
  • True if the circle is visible; false if it is invisible. -
-
- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes this circle from the map. -

- -
-
- - - - -
-

- - public - - - - - void - - setCenter - (LatLng center) -

-
-
- - - -
-
- - - - -

Sets the center using a LatLng. - -

The center must not be null, as there is no default value.

-
-
Parameters
- - - - -
center - The geographic center of the circle, specified as a LatLng.
-
-
-
Throws
- - - - -
NullPointerException - if center is null -
-
- -
-
- - - - -
-

- - public - - - - - void - - setFillColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the fill color. - -

The fill color is the color inside the circle, in the integer - format specified by Color. - If TRANSPARENT is used then no fill is drawn.

-
-
Parameters
- - - - -
color - The color in the Color format. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setRadius - (double radius) -

-
-
- - - -
-
- - - - -

Sets the radius in meters. - -

The radius must be zero or greater.

-
-
Parameters
- - - - -
radius - The radius, in meters.
-
-
-
Throws
- - - - -
IllegalArgumentException - if radius is negative -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStrokeColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the stroke color. - -

The stroke color is the color of this circle's outline, in the integer - format specified by Color. - If TRANSPARENT is used then no outline is drawn.

-
-
Parameters
- - - - -
color - The stroke color in the Color format. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStrokeWidth - (float width) -

-
-
- - - -
-
- - - - -

Sets the stroke width. - -

The stroke width is the width (in screen pixels) of the circle's - outline. It must be zero or greater. If it is zero then no outline is - drawn. The default value is 10.

-
-
Parameters
- - - - -
width - The stroke width, in screen pixels.
-
-
-
Throws
- - - - -
IllegalArgumentException - if width is negative -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of the circle. - -

If this circle is not visible then it will not be drawn. All other - state is preserved. Defaults to True.

-
-
Parameters
- - - - -
visible - false to make this circle invisible. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex. - -

Overlays (such as circles) with higher zIndices are drawn above - those with lower indices.

-
-
Parameters
- - - - -
zIndex - The zIndex value. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/CircleOptions.html b/docs/html/reference/com/google/android/gms/maps/model/CircleOptions.html deleted file mode 100644 index d4a025d97fac..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/CircleOptions.html +++ /dev/null @@ -1,2405 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CircleOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

CircleOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.CircleOptions
- - - - - - - -
- - -

Class Overview

-

Defines options for a Circle. - -

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CircleOptions() - -
- Creates circle options. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - CircleOptions - - center(LatLng center) - -
- Sets the center using a LatLng. - - - -
- -
- - - - - - CircleOptions - - fillColor(int color) - -
- Sets the fill color. - - - -
- -
- - - - - - LatLng - - getCenter() - -
- Returns the center as a LatLng. - - - -
- -
- - - - - - int - - getFillColor() - -
- Returns the fill color. - - - -
- -
- - - - - - double - - getRadius() - -
- Returns the circle's radius, in meters. - - - -
- -
- - - - - - int - - getStrokeColor() - -
- Returns the stroke color. - - - -
- -
- - - - - - float - - getStrokeWidth() - -
- Returns the stroke width. - - - -
- -
- - - - - - float - - getZIndex() - -
- Returns the zIndex. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Checks whether the circle is visible. - - - -
- -
- - - - - - CircleOptions - - radius(double radius) - -
- Sets the radius in meters. - - - -
- -
- - - - - - CircleOptions - - strokeColor(int color) - -
- Sets the stroke color. - - - -
- -
- - - - - - CircleOptions - - strokeWidth(float width) - -
- Sets the stroke width. - - - -
- -
- - - - - - CircleOptions - - visible(boolean visible) - -
- Sets the visibility. - - - -
- -
- - - - - - CircleOptions - - zIndex(float zIndex) - -
- Sets the zIndex. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CircleOptions - () -

-
-
- - - -
-
- - - - -

Creates circle options. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - CircleOptions - - center - (LatLng center) -

-
-
- - - -
-
- - - - -

Sets the center using a LatLng. - -

The center must not be null.

- -

This method is mandatory because there is no default center.

-
-
Parameters
- - - - -
center - The geographic center as a LatLng.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - fillColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the fill color. - -

The fill color is the color inside the circle, in the integer - format specified by Color. - If TRANSPARENT is used then no fill is drawn. - -

By default the fill color is transparent (0x00000000).

-
-
Parameters
- - - - -
color - color in the Color format
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - LatLng - - getCenter - () -

-
-
- - - -
-
- - - - -

Returns the center as a LatLng.

-
-
Returns
-
  • The geographic center as a LatLng. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getFillColor - () -

-
-
- - - -
-
- - - - -

Returns the fill color.

-
-
Returns
-
  • The color in the Color format. -
-
- -
-
- - - - -
-

- - public - - - - - double - - getRadius - () -

-
-
- - - -
-
- - - - -

Returns the circle's radius, in meters.

-
-
Returns
-
  • The radius in meters. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStrokeColor - () -

-
-
- - - -
-
- - - - -

Returns the stroke color.

-
-
Returns
-
  • The color in the Color format. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getStrokeWidth - () -

-
-
- - - -
-
- - - - -

Returns the stroke width.

-
-
Returns
-
  • The width in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Returns the zIndex.

-
-
Returns
-
  • The zIndex value. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Checks whether the circle is visible.

-
-
Returns
-
  • True if the circle is visible; false if it is invisible. -
-
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - radius - (double radius) -

-
-
- - - -
-
- - - - -

Sets the radius in meters. - -

The radius must be zero or greater. The default radius is zero.

-
-
Parameters
- - - - -
radius - radius in meters
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - strokeColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the stroke color. - -

The stroke color is the color of this circle's outline, in the integer - format specified by Color. - If TRANSPARENT is used then no outline is drawn.

- -

By default the stroke color is black (0xff000000).

-
-
Parameters
- - - - -
color - color in the Color format
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - strokeWidth - (float width) -

-
-
- - - -
-
- - - - -

Sets the stroke width. - -

The stroke width is the width (in screen pixels) of the circle's - outline. It must be zero or greater. If it is zero then no outline is - drawn.

- -

The default width is 10 pixels.

-
-
Parameters
- - - - -
width - width in screen pixels
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility. - -

If this circle is not visible then it is not drawn, but all other - state is preserved.

-
-
Parameters
- - - - -
visible - false to make this circle invisible
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - CircleOptions - - zIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex. - -

Overlays (such as circles) with higher zIndices are drawn above - those with lower indices. - -

By default the zIndex is 0.0.

-
-
Parameters
- - - - -
zIndex - zIndex value
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html b/docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html deleted file mode 100644 index 339454650bea..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html +++ /dev/null @@ -1,2610 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GroundOverlay | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GroundOverlay

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.GroundOverlay
- - - - - - - -
- - -

Class Overview

-

A ground overlay is an image that is fixed to a map. A ground overlay has the following - properties: -

-

-
Position
-
There are two ways to specify the position of the ground overlay: -
    -
  • Using a location: You must provide an image of the ground overlay, a LatLng to which - the anchor will be fixed and the width of the overlay (in meters). The anchor is, by default, 50% - from the top of the image and 50% from the left of the image. This can be changed. You can - optionally provide the height of the overlay (in meters). If you do not provide the height of the - overlay, it will be automatically calculated to preserve the proportions of the image.
    • -
  • Using a Bounds: You must provide a LatLngBounds which will contain the image.
    • -
- You must specify the position of the ground overlay before it is added to the map, otherwise an - IllegalArgumentException will be thrown when the ground overlay is added to the map. - Furthermore, you must only specify the position using one of these methods in the - GroundOverlayOptions object; otherwise an IllegalStateException will be thrown - when specifying using a second method.
-
Image
-
The image (as an BitmapDescriptor) to be used for this overlay. The image will be - scaled to fit the position provided. You must specify an image before adding the ground overlay - to the map; if not an IllegalArgumentException will be thrown when it is added to the - map.
-
Bearing
-
The amount that the image should be rotated in a clockwise direction. The center of the - rotation will be the image's anchor. This is optional and the default bearing is 0, i.e., the - image is aligned so that up is north.
-
zIndex
-
The order in which this ground overlay is drawn with respect to other overlays (including - Polylines and TileOverlays, but not Markers). An overlay with a larger - zIndex is drawn over overlays with smaller zIndexes. The order of overlays with the same zIndex - value is arbitrary. This is optional and the default zIndex is 0.
-
Transparency
-
Transparency of the ground overlay in the range [0..1] where 0 means the - overlay is opaque and 1 means the overlay is fully transparent. If the specified bitmap - is already partially transparent, the transparency of each pixel will be scaled accordingly (e.g. - if a pixel in the bitmap has an alpha value of 200 and you specify the transparency of the ground - overlay as 0.25, then the pixel will be rendered on the screen with an alpha value of 150). This - is optional and the default transparency is 0 (opaque).
-
Visibility
-
Indicates if the ground overlay is visible or invisible, i.e. whether it is drawn on the map. - An invisible ground overlay is not drawn, but retains all of its other properties. This is - optional and the default visibility is true, i.e., visible.
-
- Methods that modify a Polyline must be called on the UI thread. If not, an - IllegalStateException will be thrown at runtime. -

Example

- - 
 GoogleMap map = ...; // get a map.
- BitmapDescriptor image = ...; // get an image.
- LatLngBounds bounds = ...; // get a bounds
- // Adds a ground overlay with 50% transparency.
- GroundOverlay groundOverlay = map.addGroundOverlay(new GroundOverlayOptions()
-     .image(image)
-     .positionFromBounds(bounds)
-     .transparency(0.5));
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - float - - getBearing() - -
- Gets the bearing of the ground overlay in degrees clockwise from north. - - - -
- -
- - - - - - LatLngBounds - - getBounds() - -
- Gets the bounds for the ground overlay. - - - -
- -
- - - - - - float - - getHeight() - -
- Gets the height of the ground overlay. - - - -
- -
- - - - - - String - - getId() - -
- Gets this ground overlay's id. - - - -
- -
- - - - - - LatLng - - getPosition() - -
- Gets the location of the anchored point. - - - -
- -
- - - - - - float - - getTransparency() - -
- Gets the transparency of this ground overlay. - - - -
- -
- - - - - - float - - getWidth() - -
- Gets the width of the ground overlay. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex of this ground overlay. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isVisible() - -
- Gets the visibility of this ground overlay. - - - -
- -
- - - - - - void - - remove() - -
- Removes this ground overlay from the map. - - - -
- -
- - - - - - void - - setBearing(float bearing) - -
- Sets the bearing of the ground overlay (the direction that the vertical axis of the ground - overlay points) in degrees clockwise from north. - - - -
- -
- - - - - - void - - setDimensions(float width) - -
- Sets the dimensions of the ground overlay. - - - -
- -
- - - - - - void - - setDimensions(float width, float height) - -
- Sets the dimensions of the ground overlay. - - - -
- -
- - - - - - void - - setImage(BitmapDescriptor image) - -
- Sets the image for the Ground Overlay. - - - -
- -
- - - - - - void - - setPosition(LatLng latLng) - -
- Sets the position of the ground overlay by changing the location of the anchored point. - - - -
- -
- - - - - - void - - setPositionFromBounds(LatLngBounds bounds) - -
- Sets the position of the ground overlay by fitting it to the given LatLngBounds. - - - -
- -
- - - - - - void - - setTransparency(float transparency) - -
- Sets the transparency of this ground overlay. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of this ground overlay. - - - -
- -
- - - - - - void - - setZIndex(float zIndex) - -
- Sets the zIndex of this ground overlay. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - float - - getBearing - () -

-
-
- - - -
-
- - - - -

Gets the bearing of the ground overlay in degrees clockwise from north.

-
-
Returns
-
  • the bearing of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - LatLngBounds - - getBounds - () -

-
-
- - - -
-
- - - - -

Gets the bounds for the ground overlay. This ignores the rotation of the ground overlay.

-
-
Returns
-
  • a LatLngBounds that contains the ground overlay, ignoring rotation. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getHeight - () -

-
-
- - - -
-
- - - - -

Gets the height of the ground overlay.

-
-
Returns
-
  • the height of the ground overlay in meters. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this ground overlay's id. The id will be unique amongst all GroundOverlays on a map.

-
-
Returns
-
  • this ground overlay's id. -
-
- -
-
- - - - -
-

- - public - - - - - LatLng - - getPosition - () -

-
-
- - - -
-
- - - - -

Gets the location of the anchored point.

-
-
Returns
-
  • the position on the map (a LatLng). -
-
- -
-
- - - - -
-

- - public - - - - - float - - getTransparency - () -

-
-
- - - -
-
- - - - -

Gets the transparency of this ground overlay.

-
-
Returns
-
  • the transparency of this ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getWidth - () -

-
-
- - - -
-
- - - - -

Gets the width of the ground overlay.

-
-
Returns
-
  • the width of the ground overlay in meters. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex of this ground overlay.

-
-
Returns
-
  • the zIndex of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility of this ground overlay. Note that this does not return whether the ground - overlay is actually on screen, but whether it will be drawn if it is contained in the - camera's viewport.

-
-
Returns
-
  • this ground overlay's visibility. -
-
- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes this ground overlay from the map. After a ground overlay has been removed, the - behavior of all its methods is undefined. -

- -
-
- - - - -
-

- - public - - - - - void - - setBearing - (float bearing) -

-
-
- - - -
-
- - - - -

Sets the bearing of the ground overlay (the direction that the vertical axis of the ground - overlay points) in degrees clockwise from north. The rotation is performed about the anchor - point.

-
-
Parameters
- - - - -
bearing - bearing in degrees clockwise from north -
-
- -
-
- - - - -
-

- - public - - - - - void - - setDimensions - (float width) -

-
-
- - - -
-
- - - - -

Sets the dimensions of the ground overlay. The height of the ground overlay will be - calculated to preserve the proportions inherited from the bitmap.

-
-
Parameters
- - - - -
width - width in meters -
-
- -
-
- - - - -
-

- - public - - - - - void - - setDimensions - (float width, float height) -

-
-
- - - -
-
- - - - -

Sets the dimensions of the ground overlay. The image will be stretched (and hence may not - retain its proportions) to fit these dimensions.

-
-
Parameters
- - - - - - - -
width - width in meters
height - height in meters -
-
- -
-
- - - - -
-

- - public - - - - - void - - setImage - (BitmapDescriptor image) -

-
-
- - - -
-
- - - - -

Sets the image for the Ground Overlay. The new image will occupy the same bounds as the - old image.

-
-
Parameters
- - - - -
image - the BitmapDescriptor to use for this ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPosition - (LatLng latLng) -

-
-
- - - -
-
- - - - -

Sets the position of the ground overlay by changing the location of the anchored point. - Preserves all other properties of the image.

-
-
Parameters
- - - - -
latLng - a LatLng that is the new location to place the anchor point. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPositionFromBounds - (LatLngBounds bounds) -

-
-
- - - -
-
- - - - -

Sets the position of the ground overlay by fitting it to the given LatLngBounds. This - method will ignore the rotation (bearing) of the ground overlay when positioning it, but the - bearing will still be used when drawing it.

-
-
Parameters
- - - - -
bounds - a LatLngBounds in which to place the ground overlay -
-
- -
-
- - - - -
-

- - public - - - - - void - - setTransparency - (float transparency) -

-
-
- - - -
-
- - - - -

Sets the transparency of this ground overlay. See the documentation at the top of this class - for more information.

-
-
Parameters
- - - - -
transparency - a float in the range [0..1] where 0 means that the ground - overlay is opaque and 1 means that the ground overlay is transparent -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of this ground overlay. When not visible, a ground overlay is not drawn, - but it keeps all of its other properties.

-
-
Parameters
- - - - -
visible - if true, then the ground overlay is visible; if false, it is - not -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex of this ground overlay. See the documentation at the top of this class for - more information.

-
-
Parameters
- - - - -
zIndex - the zIndex of this ground overlay -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html b/docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html deleted file mode 100644 index fba321df631e..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html +++ /dev/null @@ -1,2966 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GroundOverlayOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GroundOverlayOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.GroundOverlayOptions
- - - - - - - -
- - -

Class Overview

-

Defines options for a ground overlay.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
floatNO_DIMENSION - Flag for when no dimension is specified for the height. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - GroundOverlayOptions() - -
- Creates a new set of ground overlay options. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - GroundOverlayOptions - - anchor(float u, float v) - -
- Specifies the anchor to be at a particular point in the image. - - - -
- -
- - - - - - GroundOverlayOptions - - bearing(float bearing) - -
- Specifies the bearing of the ground overlay in degrees clockwise from north. - - - -
- -
- - - - - - float - - getAnchorU() - -
- Horizontal distance, normalized to [0, 1], of the anchor from the left edge. - - - -
- -
- - - - - - float - - getAnchorV() - -
- Vertical distance, normalized to [0, 1], of the anchor from the top edge. - - - -
- -
- - - - - - float - - getBearing() - -
- Gets the bearing set for this options object. - - - -
- -
- - - - - - LatLngBounds - - getBounds() - -
- Gets the bounds set for this options object. - - - -
- -
- - - - - - float - - getHeight() - -
- Gets the height set for this options object. - - - -
- -
- - - - - - BitmapDescriptor - - getImage() - -
- Gets the image set for this options object. - - - -
- -
- - - - - - LatLng - - getLocation() - -
- Gets the location set for this options object. - - - -
- -
- - - - - - float - - getTransparency() - -
- Gets the transparency set for this options object. - - - -
- -
- - - - - - float - - getWidth() - -
- Gets the width set for this options object. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex set for this options object. - - - -
- -
- - - - - - GroundOverlayOptions - - image(BitmapDescriptor image) - -
- Specifies the image for this ground overlay. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility setting for this options object. - - - -
- -
- - - - - - GroundOverlayOptions - - position(LatLng location, float width, float height) - -
- Specifies the position for this ground overlay using an anchor point (a LatLng), - width and height (both in meters). - - - -
- -
- - - - - - GroundOverlayOptions - - position(LatLng location, float width) - -
- Specifies the position for this ground overlay using an anchor point (a LatLng) - and the width (in meters). - - - -
- -
- - - - - - GroundOverlayOptions - - positionFromBounds(LatLngBounds bounds) - -
- Specifies the position for this ground overlay. - - - -
- -
- - - - - - GroundOverlayOptions - - transparency(float transparency) - -
- Specifies the transparency of the ground overlay. - - - -
- -
- - - - - - GroundOverlayOptions - - visible(boolean visible) - -
- Specifies the visibility for the ground overlay. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - GroundOverlayOptions - - zIndex(float zIndex) - -
- Specifies the ground overlay's zIndex, i.e., the order in which it will be drawn. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - float - - NO_DIMENSION -

-
- - - - -
-
- - - - -

Flag for when no dimension is specified for the height.

- - -
- Constant Value: - - - -1.0 - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - GroundOverlayOptions - () -

-
-
- - - -
-
- - - - -

Creates a new set of ground overlay options.

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - GroundOverlayOptions - - anchor - (float u, float v) -

-
-
- - - -
-
- - - - -

Specifies the anchor to be at a particular point in the image. -

- The anchor specifies the point in the image that aligns with the ground overlay's - location. -

- The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0], where (0, - 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner. - - 

- *-----+-----+-----+-----*
- |     |     |     |     |
- |     |     |     |     |
- +-----+-----+-----+-----+
- |     |     |   X |     |   (U, V) = (0.7, 0.6)
- |     |     |     |     |
- *-----+-----+-----+-----*
-

-
-
Parameters
- - - - - - - -
u - u-coordinate of the anchor, as a ratio of the image width (in the range [0, 1])
v - v-coordinate of the anchor, as a ratio of the image height (in the range [0, 1])
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - bearing - (float bearing) -

-
-
- - - -
-
- - - - -

Specifies the bearing of the ground overlay in degrees clockwise from north. The rotation - is performed about the anchor point. If not specified, the default is 0 (i.e., up on the - image points north). -

- If a ground overlay with position set using positionFromBounds(LatLngBounds) is rotated, its - size will preserved and it will no longer be guaranteed to fit inside the bounds.

-
-
Parameters
- - - - -
bearing - the bearing in degrees clockwise from north. Values outside the range [0, - 360) will be normalized.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - float - - getAnchorU - () -

-
-
- - - -
-
- - - - -

Horizontal distance, normalized to [0, 1], of the anchor from the left edge.

-
-
Returns
-
  • the u value of the anchor. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getAnchorV - () -

-
-
- - - -
-
- - - - -

Vertical distance, normalized to [0, 1], of the anchor from the top edge.

-
-
Returns
-
  • the v value of the anchor. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getBearing - () -

-
-
- - - -
-
- - - - -

Gets the bearing set for this options object.

-
-
Returns
-
  • the bearing of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - LatLngBounds - - getBounds - () -

-
-
- - - -
-
- - - - -

Gets the bounds set for this options object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - float - - getHeight - () -

-
-
- - - -
-
- - - - -

Gets the height set for this options object.

-
-
Returns
-
  • the height of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - BitmapDescriptor - - getImage - () -

-
-
- - - -
-
- - - - -

Gets the image set for this options object.

-
-
Returns
-
  • the image of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - LatLng - - getLocation - () -

-
-
- - - -
-
- - - - -

Gets the location set for this options object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - float - - getTransparency - () -

-
-
- - - -
-
- - - - -

Gets the transparency set for this options object.

-
-
Returns
-
  • the transparency of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getWidth - () -

-
-
- - - -
-
- - - - -

Gets the width set for this options object.

-
-
Returns
-
  • the width of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex set for this options object.

-
-
Returns
-
  • the zIndex of the ground overlay. -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - image - (BitmapDescriptor image) -

-
-
- - - -
-
- - - - -

Specifies the image for this ground overlay. -

- To load an image as a texture (which is used to draw the image on a map), it must be - converted into an image with sides that are powers of two. This is so that a mipmap can - be created in order to render the texture at various zoom levels - see Mipmap (Wikipedia) for details. Hence, to - conserve memory by avoiding this conversion, it is advised that the dimensions of the - image are powers of two.

-
-
Parameters
- - - - -
image - the BitmapDescriptor to use for this ground overlay
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility setting for this options object.

-
-
Returns
-
  • true if the ground overlay is to be visible; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - position - (LatLng location, float width, float height) -

-
-
- - - -
-
- - - - -

Specifies the position for this ground overlay using an anchor point (a LatLng), - width and height (both in meters). When rendered, the image will be scaled to fit the - dimensions specified (i.e., its proportions will not necessarily be preserved).

-
-
Parameters
- - - - - - - - - - -
location - the location on the map LatLng to which the anchor point in the - given image will remain fixed. The anchor will remain fixed to the position on - the ground when transformations are applied (e.g., setDimensions, setBearing, - etc.).
width - the width of the overlay (in meters)
height - the height of the overlay (in meters)
-
-
-
Returns
- -
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if anchor is null
IllegalArgumentException - if width or height are negative
IllegalStateException - if the position was already set using - positionFromBounds(LatLngBounds) -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - position - (LatLng location, float width) -

-
-
- - - -
-
- - - - -

Specifies the position for this ground overlay using an anchor point (a LatLng) - and the width (in meters). When rendered, the image will retain its proportions from the - bitmap, i.e., the height will be calculated to preserve the original proportions of the - image.

-
-
Parameters
- - - - - - - -
location - the location on the map LatLng to which the anchor point in the - given image will remain fixed. The anchor will remain fixed to the position on - the ground when transformations are applied (e.g., setDimensions, setBearing, - etc.).
width - the width of the overlay (in meters). The height will be determined - automatically based on the image proportions.
-
-
-
Returns
- -
-
-
Throws
- - - - - - - - - - -
IllegalArgumentException - if anchor is null
IllegalArgumentException - if width is negative
IllegalStateException - if the position was already set using - positionFromBounds(LatLngBounds) -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - positionFromBounds - (LatLngBounds bounds) -

-
-
- - - -
-
- - - - -

Specifies the position for this ground overlay. When rendered, the image will be scaled - to fit the bounds (i.e., its proportions will not necessarily be preserved).

-
-
Parameters
- - - - -
bounds - a LatLngBounds in which to place the ground overlay
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalStateException - if the position was already set using - position(LatLng, float) or position(LatLng, float, float) -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - transparency - (float transparency) -

-
-
- - - -
-
- - - - -

Specifies the transparency of the ground overlay. The default transparency is 0 - (opaque).

-
-
Parameters
- - - - -
transparency - a float in the range [0..1] where 0 means that the - ground overlay is opaque and 1 means that the ground overlay is - transparent
-
-
-
Returns
- -
-
-
Throws
- - - - -
IllegalArgumentException - if the transparency is outside the range [0..1]. -
-
- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Specifies the visibility for the ground overlay. The default visibility is true.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - GroundOverlayOptions - - zIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Specifies the ground overlay's zIndex, i.e., the order in which it will be drawn. See the - documentation at the top of this class for more information about zIndex.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/IndoorBuilding.html b/docs/html/reference/com/google/android/gms/maps/model/IndoorBuilding.html deleted file mode 100644 index 155e09bd08d3..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/IndoorBuilding.html +++ /dev/null @@ -1,1587 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -IndoorBuilding | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

IndoorBuilding

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.IndoorBuilding
- - - - - - - -
- - -

Class Overview

-

Represents a building. -

- Two IndoorBuildings are .equal() if the physical building they represent is the same. However, - if a building's structural model changes, e.g., due to an update to Google's building models, - then an old IndoorBuilding object and a new IndoorBuilding object will be .equal(), but might - have different contents. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - int - - getActiveLevelIndex() - -
- Gets the index in the list returned by getLevels() of the level that is currently - active in this building (default if no active level was previously set). - - - -
- -
- - - - - - int - - getDefaultLevelIndex() - -
- Gets the index in the list returned by getLevels() of the default level for this - building. - - - -
- -
- - - - - - List<IndoorLevel> - - getLevels() - -
- Gets the levels in the building. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isUnderground() - -
- Returns true if the building is entirely underground. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getActiveLevelIndex - () -

-
-
- - - -
-
- - - - -

Gets the index in the list returned by getLevels() of the level that is currently - active in this building (default if no active level was previously set). -

- -
-
- - - - -
-

- - public - - - - - int - - getDefaultLevelIndex - () -

-
-
- - - -
-
- - - - -

Gets the index in the list returned by getLevels() of the default level for this - building. -

- -
-
- - - - -
-

- - public - - - - - List<IndoorLevel> - - getLevels - () -

-
-
- - - -
-
- - - - -

Gets the levels in the building. While a level is usually enclosed by a single building, a - level might be enclosed by several buildings (e.g., a carpark level might span multiple - buildings). The levels are in 'display order' from top to bottom. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isUnderground - () -

-
-
- - - -
-
- - - - -

Returns true if the building is entirely underground. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/IndoorLevel.html b/docs/html/reference/com/google/android/gms/maps/model/IndoorLevel.html deleted file mode 100644 index 93cf9feacd4a..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/IndoorLevel.html +++ /dev/null @@ -1,1528 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -IndoorLevel | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

IndoorLevel

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.IndoorLevel
- - - - - - - -
- - -

Class Overview

-

Represents a level in a building. -

- IndoorLevel objects are only equal by id. It is possible that may have different contents. -

- While a level is usually enclosed by a single building, a level might be enclosed by several - buildings (e.g., a carpark level might span multiple buildings). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - activate() - -
- Sets this level as the visible level in its building. - - - -
- -
- - - - - - boolean - - equals(Object other) - -
- - - - - - String - - getName() - -
- Localized display name for the level, e.g. - - - -
- -
- - - - - - String - - getShortName() - -
- Localized short display name for the level, e.g. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - activate - () -

-
-
- - - -
-
- - - - -

Sets this level as the visible level in its building. If a level is enclosed in several - buildings, then all those buildings will have this level set as active. -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

Localized display name for the level, e.g. "Ground floor". Returns an empty string if no - name is defined. -

- -
-
- - - - -
-

- - public - - - - - String - - getShortName - () -

-
-
- - - -
-
- - - - -

Localized short display name for the level, e.g. "1". Returns an empty string if no - shortName is defined. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/LatLng.html b/docs/html/reference/com/google/android/gms/maps/model/LatLng.html deleted file mode 100644 index f2f9225c7f39..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/LatLng.html +++ /dev/null @@ -1,1796 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LatLng | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LatLng

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.LatLng
- - - - - - - -
- - -

Class Overview

-

An immutable class representing a pair of latitude and longitude coordinates, stored as degrees. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - doublelatitude - Latitude, in degrees. - - - -
- public - - final - doublelongitude - Longitude, in degrees. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LatLng(double latitude, double longitude) - -
- Constructs a LatLng with the given latitude and longitude, measured in degrees. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object o) - -
- Tests if this LatLng is equal to another. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - double - - latitude -

-
- - - - -
-
- - - - -

Latitude, in degrees. This value is in the range [-90, 90].

- - -
-
- - - - - -
-

- - public - - final - double - - longitude -

-
- - - - -
-
- - - - -

Longitude, in degrees. This value is in the range [-180, 180).

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LatLng - (double latitude, double longitude) -

-
-
- - - -
-
- - - - -

Constructs a LatLng with the given latitude and longitude, measured in degrees.

-
-
Parameters
- - - - - - - -
latitude - The point's latitude. This will be clamped to between -90 degrees and +90 - degrees inclusive.
longitude - The point's longitude. This will be normalized to be within -180 degrees - inclusive and +180 degrees exclusive. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

Tests if this LatLng is equal to another. -

- Two points are considered equal if and only if their latitudes are bitwise equal and their - longitudes are bitwise equal. This means that two LatLngs that are very near, in - terms of geometric distance, might not be considered .equal(). -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html b/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html deleted file mode 100644 index 7d3716828d19..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html +++ /dev/null @@ -1,1463 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LatLngBounds.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

LatLngBounds.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.LatLngBounds.Builder
- - - - - - - -
- - -

Class Overview

-

This is a builder that is able to create a minimum bound based on a set of LatLng points.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LatLngBounds.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LatLngBounds - - build() - -
- Creates the LatLng bounds. - - - -
- -
- - - - - - LatLngBounds.Builder - - include(LatLng point) - -
- Includes this point for building of the bounds. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LatLngBounds.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LatLngBounds - - build - () -

-
-
- - - -
-
- - - - -

Creates the LatLng bounds.

-
-
Throws
- - - - -
IllegalStateException - if no points have been included. -
-
- -
-
- - - - -
-

- - public - - - - - LatLngBounds.Builder - - include - (LatLng point) -

-
-
- - - -
-
- - - - -

Includes this point for building of the bounds. The bounds will be extended in a minimum - way to include this point. -

- More precisely, it will consider extending the bounds both in the eastward and westward - directions (one of which may cross the antimeridian) and choose the smaller of the two. - In the case that both directions result in a LatLngBounds of the same size, this will - extend it in the eastward direction. For example, adding points (0, -179) and (1, 179) - will create a bound crossing the 180 longitude.

-
-
Parameters
- - - - -
point - A LatLng to be included in the bounds.
-
-
-
Returns
-
  • This builder object with a new point added. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html b/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html deleted file mode 100644 index 27cafc0d55e1..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html +++ /dev/null @@ -1,2093 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LatLngBounds | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LatLngBounds

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.LatLngBounds
- - - - - - - -
- - -

Class Overview

-

An immutable class representing a latitude/longitude aligned rectangle. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classLatLngBounds.Builder - This is a builder that is able to create a minimum bound based on a set of LatLng points.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - LatLngnortheast - Northeast corner of the bound. - - - -
- public - - final - LatLngsouthwest - Southwest corner of the bound. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - LatLngBounds(LatLng southwest, LatLng northeast) - -
- Creates a new bounds based on a southwest and a northeast corner. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - LatLngBounds.Builder - - builder() - -
- Creates a new builder. - - - -
- -
- - - - - - boolean - - contains(LatLng point) - -
- Returns whether this contains the given LatLng. - - - -
- -
- - - - - - boolean - - equals(Object o) - -
- - - - - - LatLng - - getCenter() - -
- Returns the center of this LatLngBounds. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - LatLngBounds - - including(LatLng point) - -
- Returns a new LatLngBounds that extends this LatLngBounds to include the given - LatLng. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - LatLng - - northeast -

-
- - - - -
-
- - - - -

Northeast corner of the bound.

- - -
-
- - - - - -
-

- - public - - final - LatLng - - southwest -

-
- - - - -
-
- - - - -

Southwest corner of the bound.

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - LatLngBounds - (LatLng southwest, LatLng northeast) -

-
-
- - - -
-
- - - - -

Creates a new bounds based on a southwest and a northeast corner. -

- The bounds conceptually includes all points where: -

    -
  • the latitude is in the range [northeast.latitude, southwest.latitude];
    • -
  • the longitude is in the range [southwest.longtitude, northeast.longitude] if - southwest.longtitude ≤ northeast.longitude; and
    • -
  • the longitude is in the range [southwest.longitude, 180) ∪ [-180, - northeast.longitude] if southwest.longtitude > northeast.longitude.
    • -

-
-
Parameters
- - - - - - - -
southwest - southwest corner
northeast - northeast corner
-
-
-
Throws
- - - - -
IllegalArgumentException - if the latitude of the northeast corner is below the - latitude of the southwest corner. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - LatLngBounds.Builder - - builder - () -

-
-
- - - -
-
- - - - -

Creates a new builder.

- -
-
- - - - -
-

- - public - - - - - boolean - - contains - (LatLng point) -

-
-
- - - -
-
- - - - -

Returns whether this contains the given LatLng.

-
-
Parameters
- - - - -
point - the LatLng to test
-
-
-
Returns
-
  • true if this contains the given point; false if not. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LatLng - - getCenter - () -

-
-
- - - -
-
- - - - -

Returns the center of this LatLngBounds. The center is simply the average of the coordinates - (taking into account if it crosses the antimeridian). This is approximately the geographical - center (it would be exact if the Earth were a perfect sphere). It will not necessarily be - the center of the rectangle as drawn on the map due to the Mercator projection.

-
-
Returns
-
  • A LatLng that is the center of the LatLngBounds. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LatLngBounds - - including - (LatLng point) -

-
-
- - - -
-
- - - - -

Returns a new LatLngBounds that extends this LatLngBounds to include the given - LatLng. This will return the smallest LatLngBounds that contains both this and the - extra point. -

- In particular, it will consider extending the bounds both in the eastward and westward - directions (one of which may cross the antimeridian) and choose the smaller of the two. In - the case that both directions result in a LatLngBounds of the same size, this will extend it - in the eastward direction.

-
-
Parameters
- - - - -
point - a LatLng to be included in the new bounds
-
-
-
Returns
-
  • A new LatLngBounds that contains this and the extra point. -
-
- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/Marker.html b/docs/html/reference/com/google/android/gms/maps/model/Marker.html deleted file mode 100644 index 50ea7132f7c3..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/Marker.html +++ /dev/null @@ -1,2868 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Marker | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Marker

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.Marker
- - - - - - - -
- - -

Class Overview

-

An icon placed at a particular point on the map's surface. A marker icon is drawn oriented - against the device's screen rather than the map's surface; i.e., it will not necessarily change - orientation due to map rotations, tilting, or zooming. -

- A marker has the following properties: -

-
Alpha
-
Sets the opacity of the marker. Defaults to 1.0.
-
Anchor
-
The point on the image that will be placed at the LatLng position of the marker. This - defaults to 50% from the left of the image and at the bottom of the image.
-
Position
-
The LatLng value for the marker's position on the map. You can change this value at - any time if you want to move the marker.
-
Title
-
A text string that's displayed in an info window when the user taps the marker. You can - change this value at any time.
-
Snippet
-
Additional text that's displayed below the title. You can change this value at any time.
-
Icon
-
A bitmap that's displayed for the marker. If the icon is left unset, a default icon is - displayed. You can specify an alternative coloring of the default icon using - defaultMarker(float).
-
Drag Status
-
If you want to allow the user to drag the marker, set this property to true. You can - change this value at any time. The default is false.
-
Visibility
-
By default, the marker is visible. To make the marker invisible, set this property to - false. You can change this value at any time.
-
Flat or Billboard
-
If the marker is flat against the map, it will remain stuck to the map as the camera rotates - and tilts but will still remain the same size as the camera zooms, unlike a - GroundOverlay. If the marker is a billboard, it will always be drawn facing the camera - and will rotate and tilt with the camera. The default is a billboard (false)
-
Rotation
-
The rotation of the marker in degrees clockwise about the marker's anchor point. The - axis of rotation is perpendicular to the marker. A rotation of 0 corresponds to the default - position of the marker. When the marker is flat on the map, the default position is North - aligned and the rotation is such that the marker always remains flat on the map. When the - marker is a billboard, the default position is pointing up and the rotation is such that the - marker is always facing the camera. The default value is 0.
-
-

Example

- - 
 GoogleMap map = ... // get a map.
- // Add a marker at San Francisco.
- Marker marker = map.addMarker(new MarkerOptions()
-     .position(new LatLng(37.7750, 122.4183))
-     .title("San Francisco")
-     .snippet("Population: 776733"));
- -

-

Developer Guide

-

- For more information, read the Markers - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - float - - getAlpha() - -
- Gets the alpha of the marker. - - - -
- -
- - - - - - String - - getId() - -
- Gets this marker's id. - - - -
- -
- - - - - - LatLng - - getPosition() - -
- Returns the position of the marker. - - - -
- -
- - - - - - float - - getRotation() - -
- Gets the rotation of the marker. - - - -
- -
- - - - - - String - - getSnippet() - -
- Gets the snippet of the marker. - - - -
- -
- - - - - - String - - getTitle() - -
- Gets the title of the marker. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - void - - hideInfoWindow() - -
- Hides the info window if it is shown from this marker. - - - -
- -
- - - - - - boolean - - isDraggable() - -
- Gets the draggability of the marker. - - - -
- -
- - - - - - boolean - - isFlat() - -
- Gets the flat setting of the Marker. - - - -
- -
- - - - - - boolean - - isInfoWindowShown() - -
- Returns whether the info window is currently shown above this marker. - - - -
- -
- - - - - - boolean - - isVisible() - -
- - - - - - void - - remove() - -
- Removes this marker from the map. - - - -
- -
- - - - - - void - - setAlpha(float alpha) - -
- Sets the alpha (opacity) of the marker. - - - -
- -
- - - - - - void - - setAnchor(float anchorU, float anchorV) - -
- Sets the anchor point for the marker. - - - -
- -
- - - - - - void - - setDraggable(boolean draggable) - -
- Sets the draggability of the marker. - - - -
- -
- - - - - - void - - setFlat(boolean flat) - -
- Sets whether this marker should be flat against the map true or a billboard facing - the camera false. - - - -
- -
- - - - - - void - - setIcon(BitmapDescriptor icon) - -
- Sets the icon for the marker. - - - -
- -
- - - - - - void - - setInfoWindowAnchor(float anchorU, float anchorV) - -
- Specifies the point in the marker image at which to anchor the info window when it is - displayed. - - - -
- -
- - - - - - void - - setPosition(LatLng latlng) - -
- Sets the position of the marker. - - - -
- -
- - - - - - void - - setRotation(float rotation) - -
- Sets the rotation of the marker in degrees clockwise about the marker's anchor point. - - - -
- -
- - - - - - void - - setSnippet(String snippet) - -
- Sets the snippet of the marker. - - - -
- -
- - - - - - void - - setTitle(String title) - -
- Sets the title of the marker. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of this marker. - - - -
- -
- - - - - - void - - showInfoWindow() - -
- Shows the info window of this marker on the map, if this marker isVisible(). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - float - - getAlpha - () -

-
-
- - - -
-
- - - - -

Gets the alpha of the marker.

-
-
Returns
-
  • the alpha of the marker in the range [0, 1]. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this marker's id. The id will be unique amongst all Markers on a map.

-
-
Returns
-
  • this marker's id. -
-
- -
-
- - - - -
-

- - public - - - - - LatLng - - getPosition - () -

-
-
- - - -
-
- - - - -

Returns the position of the marker.

-
-
Returns
-
  • A LatLng object specifying the marker's current position. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getRotation - () -

-
-
- - - -
-
- - - - -

Gets the rotation of the marker.

-
-
Returns
-
  • the rotation of the marker in degrees clockwise from the default position. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSnippet - () -

-
-
- - - -
-
- - - - -

Gets the snippet of the marker.

-
-
Returns
-
  • A string containing the marker's snippet. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Gets the title of the marker.

-
-
Returns
-
  • A string containing the marker's title. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - hideInfoWindow - () -

-
-
- - - -
-
- - - - -

Hides the info window if it is shown from this marker. -

- This method has no effect if this marker is not visible. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDraggable - () -

-
-
- - - -
-
- - - - -

Gets the draggability of the marker. When a marker is draggable, it can be moved by the user - by long pressing on the marker.

-
-
Returns
-
  • true if the marker is draggable; otherwise, returns false. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isFlat - () -

-
-
- - - -
-
- - - - -

Gets the flat setting of the Marker.

-
-
Returns
-
  • true if the marker is flat against the map; false if the marker - should face the camera. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isInfoWindowShown - () -

-
-
- - - -
-
- - - - -

Returns whether the info window is currently shown above this marker. This does not consider - whether or not the info window is actually visible on screen. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes this marker from the map. After a marker has been removed, the behavior of all its - methods is undefined. -

- -
-
- - - - -
-

- - public - - - - - void - - setAlpha - (float alpha) -

-
-
- - - -
-
- - - - -

Sets the alpha (opacity) of the marker. This is a value from 0 to 1, where 0 means the marker - is completely transparent and 1 means the marker is completely opaque. -

- -
-
- - - - -
-

- - public - - - - - void - - setAnchor - (float anchorU, float anchorV) -

-
-
- - - -
-
- - - - -

Sets the anchor point for the marker. -

- The anchor specifies the point in the icon image that is anchored to the marker's - position on the Earth's surface. -

- The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0], where (0, - 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner. The - anchoring point in a W x H image is the nearest discrete grid point in - a (W + 1) x (H + 1) grid, obtained by scaling the then rounding. For - example, in a 4 x 2 image, the anchor point (0.7, 0.6) resolves to the grid point at (3, - 1). - 

- *-----+-----+-----+-----*
- |     |     |     |     |
- |     |     |     |     |
- +-----+-----+-----+-----+
- |     |     |   X |     |   (U, V) = (0.7, 0.6)
- |     |     |     |     |
- *-----+-----+-----+-----*
-
- *-----+-----+-----+-----*
- |     |     |     |     |
- |     |     |     |     |
- +-----+-----+-----X-----+   (X, Y) = (3, 1)
- |     |     |     |     |
- |     |     |     |     |
- *-----+-----+-----+-----*
-

-
-
Parameters
- - - - - - - -
anchorU - u-coordinate of the anchor, as a ratio of the image width - (in the range [0, 1])
anchorV - v-coordinate of the anchor, as a ratio of the image height - (in the range [0, 1]) -
-
- -
-
- - - - -
-

- - public - - - - - void - - setDraggable - (boolean draggable) -

-
-
- - - -
-
- - - - -

Sets the draggability of the marker. When a marker is draggable, it can be moved by the user - by long pressing on the marker. -

- -
-
- - - - -
-

- - public - - - - - void - - setFlat - (boolean flat) -

-
-
- - - -
-
- - - - -

Sets whether this marker should be flat against the map true or a billboard facing - the camera false. -

- -
-
- - - - -
-

- - public - - - - - void - - setIcon - (BitmapDescriptor icon) -

-
-
- - - -
-
- - - - -

Sets the icon for the marker.

-
-
Parameters
- - - - -
icon - if null, the default marker is used. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setInfoWindowAnchor - (float anchorU, float anchorV) -

-
-
- - - -
-
- - - - -

Specifies the point in the marker image at which to anchor the info window when it is - displayed. This is specified in the same coordinate system as the anchor. See - setAnchor(float, float) for more details. The default is the top middle of the - image.

-
-
Parameters
- - - - - - - -
anchorU - u-coordinate of the info window anchor, as a ratio of the image width (in the - range [0, 1])
anchorV - v-coordinate of the info window anchor, as a ratio of the image height (in the - range [0, 1]) -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPosition - (LatLng latlng) -

-
-
- - - -
-
- - - - -

Sets the position of the marker. -

- -
-
- - - - -
-

- - public - - - - - void - - setRotation - (float rotation) -

-
-
- - - -
-
- - - - -

Sets the rotation of the marker in degrees clockwise about the marker's anchor point. The - axis of rotation is perpendicular to the marker. A rotation of 0 corresponds to the default - position of the marker. -

- -
-
- - - - -
-

- - public - - - - - void - - setSnippet - (String snippet) -

-
-
- - - -
-
- - - - -

Sets the snippet of the marker. -

- -
-
- - - - -
-

- - public - - - - - void - - setTitle - (String title) -

-
-
- - - -
-
- - - - -

Sets the title of the marker. -

- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of this marker. If set to false and an info window is currently - showing for this marker, this will hide the info window. -

- -
-
- - - - -
-

- - public - - - - - void - - showInfoWindow - () -

-
-
- - - -
-
- - - - -

Shows the info window of this marker on the map, if this marker isVisible().

-
-
Throws
- - - - -
IllegalArgumentException - if marker is not on this map -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html b/docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html deleted file mode 100644 index ba30ff26ae49..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html +++ /dev/null @@ -1,3038 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MarkerOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MarkerOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.MarkerOptions
- - - - - - - -
- - -

Class Overview

-

Defines MarkerOptions for a marker. - -

-

Developer Guide

-

- For more information, read the Markers developer - guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - MarkerOptions() - -
- Creates a new set of marker options. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MarkerOptions - - alpha(float alpha) - -
- Sets the alpha (opacity) of the marker. - - - -
- -
- - - - - - MarkerOptions - - anchor(float u, float v) - -
- Specifies the anchor to be at a particular point in the marker image. - - - -
- -
- - - - - - MarkerOptions - - draggable(boolean draggable) - -
- Sets the draggability for the marker. - - - -
- -
- - - - - - MarkerOptions - - flat(boolean flat) - -
- Sets whether this marker should be flat against the map true or a billboard facing - the camera false. - - - -
- -
- - - - - - float - - getAlpha() - -
- Gets the alpha set for this MarkerOptions object. - - - -
- -
- - - - - - float - - getAnchorU() - -
- Horizontal distance, normalized to [0, 1], of the anchor from the left edge. - - - -
- -
- - - - - - float - - getAnchorV() - -
- Vertical distance, normalized to [0, 1], of the anchor from the top edge. - - - -
- -
- - - - - - BitmapDescriptor - - getIcon() - -
- Gets the custom icon set for this MarkerOptions object. - - - -
- -
- - - - - - float - - getInfoWindowAnchorU() - -
- Horizontal distance, normalized to [0, 1], of the info window anchor from the left edge. - - - -
- -
- - - - - - float - - getInfoWindowAnchorV() - -
- Vertical distance, normalized to [0, 1], of the info window anchor from the top edge. - - - -
- -
- - - - - - LatLng - - getPosition() - -
- Returns the position set for this MarkerOptions object. - - - -
- -
- - - - - - float - - getRotation() - -
- Gets the rotation set for this MarkerOptions object. - - - -
- -
- - - - - - String - - getSnippet() - -
- Gets the snippet set for this MarkerOptions object. - - - -
- -
- - - - - - String - - getTitle() - -
- Gets the title set for this MarkerOptions object. - - - -
- -
- - - - - - MarkerOptions - - icon(BitmapDescriptor icon) - -
- Sets the icon for the marker. - - - -
- -
- - - - - - MarkerOptions - - infoWindowAnchor(float u, float v) - -
- Specifies the anchor point of the info window on the marker image. - - - -
- -
- - - - - - boolean - - isDraggable() - -
- Gets the draggability setting for this MarkerOptions object. - - - -
- -
- - - - - - boolean - - isFlat() - -
- Gets the flat setting for this MarkerOptions object. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility setting for this MarkerOptions object. - - - -
- -
- - - - - - MarkerOptions - - position(LatLng position) - -
- Sets the location for the marker. - - - -
- -
- - - - - - MarkerOptions - - rotation(float rotation) - -
- Sets the rotation of the marker in degrees clockwise about the marker's anchor point. - - - -
- -
- - - - - - MarkerOptions - - snippet(String snippet) - -
- Sets the snippet for the marker. - - - -
- -
- - - - - - MarkerOptions - - title(String title) - -
- Sets the title for the marker. - - - -
- -
- - - - - - MarkerOptions - - visible(boolean visible) - -
- Sets the visibility for the marker. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - MarkerOptions - () -

-
-
- - - -
-
- - - - -

Creates a new set of marker options. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MarkerOptions - - alpha - (float alpha) -

-
-
- - - -
-
- - - - -

Sets the alpha (opacity) of the marker. This is a value from 0 to 1, where 0 means the marker - is completely transparent and 1 means the marker is completely opaque.

-
-
Returns
-
  • the object for which the method was called, with the new alpha set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - anchor - (float u, float v) -

-
-
- - - -
-
- - - - -

Specifies the anchor to be at a particular point in the marker image. -

- The anchor specifies the point in the icon image that is anchored to the marker's - position on the Earth's surface. -

- The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0], where (0, - 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner. The - anchoring point in a W x H image is the nearest discrete grid point in - a (W + 1) x (H + 1) grid, obtained by scaling the then rounding. For - example, in a 4 x 2 image, the anchor point (0.7, 0.6) resolves to the grid point at (3, - 1). - 

- *-----+-----+-----+-----*
- |     |     |     |     |
- |     |     |     |     |
- +-----+-----+-----+-----+
- |     |     |   X |     |   (U, V) = (0.7, 0.6)
- |     |     |     |     |
- *-----+-----+-----+-----*
-
- *-----+-----+-----+-----*
- |     |     |     |     |
- |     |     |     |     |
- +-----+-----+-----X-----+   (X, Y) = (3, 1)
- |     |     |     |     |
- |     |     |     |     |
- *-----+-----+-----+-----*
-

-
-
Parameters
- - - - - - - -
u - u-coordinate of the anchor, as a ratio of the image width (in the range [0, 1])
v - v-coordinate of the anchor, as a ratio of the image height (in the range [0, 1])
-
-
-
Returns
-
  • the object for which the method was called, with the new anchor set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - draggable - (boolean draggable) -

-
-
- - - -
-
- - - - -

Sets the draggability for the marker.

-
-
Returns
-
  • the object for which the method was called, with the new draggable state set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - flat - (boolean flat) -

-
-
- - - -
-
- - - - -

Sets whether this marker should be flat against the map true or a billboard facing - the camera false. If the marker is flat against the map, it will remain stuck to the - map as the camera rotates and tilts but will still remain the same size as the camera zooms, - unlike a GroundOverlay. If the marker is a billboard, it will always be drawn facing - the camera and will rotate and tilt with the camera. The default value is false.

-
-
Returns
-
  • the object for which the method was called, with the new flat state set. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getAlpha - () -

-
-
- - - -
-
- - - - -

Gets the alpha set for this MarkerOptions object.

-
-
Returns
-
  • the alpha of the marker in the range [0, 1]. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getAnchorU - () -

-
-
- - - -
-
- - - - -

Horizontal distance, normalized to [0, 1], of the anchor from the left edge.

-
-
Returns
-
  • the u value of the anchor. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getAnchorV - () -

-
-
- - - -
-
- - - - -

Vertical distance, normalized to [0, 1], of the anchor from the top edge.

-
-
Returns
-
  • the v value of the anchor. -
-
- -
-
- - - - -
-

- - public - - - - - BitmapDescriptor - - getIcon - () -

-
-
- - - -
-
- - - - -

Gets the custom icon set for this MarkerOptions object.

-
-
Returns
-
  • An BitmapDescriptor representing the custom icon, or null if no - custom icon is set. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getInfoWindowAnchorU - () -

-
-
- - - -
-
- - - - -

Horizontal distance, normalized to [0, 1], of the info window anchor from the left edge.

-
-
Returns
-
  • the u value of the info window anchor. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getInfoWindowAnchorV - () -

-
-
- - - -
-
- - - - -

Vertical distance, normalized to [0, 1], of the info window anchor from the top edge.

-
-
Returns
-
  • the v value of the info window anchor. -
-
- -
-
- - - - -
-

- - public - - - - - LatLng - - getPosition - () -

-
-
- - - -
-
- - - - -

Returns the position set for this MarkerOptions object.

-
-
Returns
-
  • A LatLng object specifying the marker's current position. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getRotation - () -

-
-
- - - -
-
- - - - -

Gets the rotation set for this MarkerOptions object.

-
-
Returns
-
  • the rotation of the marker in degrees clockwise from the default position. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getSnippet - () -

-
-
- - - -
-
- - - - -

Gets the snippet set for this MarkerOptions object.

-
-
Returns
-
  • A string containing the marker's snippet. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

Gets the title set for this MarkerOptions object.

-
-
Returns
-
  • A string containing the marker's title. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - icon - (BitmapDescriptor icon) -

-
-
- - - -
-
- - - - -

Sets the icon for the marker.

-
-
Parameters
- - - - -
icon - if null, the default marker is used.
-
-
-
Returns
-
  • the object for which the method was called, with the new icon set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - infoWindowAnchor - (float u, float v) -

-
-
- - - -
-
- - - - -

Specifies the anchor point of the info window on the marker image. This is specified in the - same coordinate system as the anchor. See anchor(float, float) for more details. - The default is the top middle of the image.

-
-
Parameters
- - - - - - - -
u - u-coordinate of the info window anchor, as a ratio of the image width (in the range - [0, 1])
v - v-coordinate of the info window anchor, as a ratio of the image height (in the range - [0, 1])
-
-
-
Returns
-
  • the object for which the method was called, with the new info window anchor set. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isDraggable - () -

-
-
- - - -
-
- - - - -

Gets the draggability setting for this MarkerOptions object.

-
-
Returns
-
  • true if the marker is draggable; otherwise, returns false. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isFlat - () -

-
-
- - - -
-
- - - - -

Gets the flat setting for this MarkerOptions object.

-
-
Returns
-
  • true if the marker is flat against the map; false if the marker - should face the camera. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility setting for this MarkerOptions object.

-
-
Returns
-
  • true if the marker is visible; otherwise, returns false. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - position - (LatLng position) -

-
-
- - - -
-
- - - - -

Sets the location for the marker.

-
-
Returns
-
  • the object for which the method was called, with the new position set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - rotation - (float rotation) -

-
-
- - - -
-
- - - - -

Sets the rotation of the marker in degrees clockwise about the marker's anchor point. The - axis of rotation is perpendicular to the marker. A rotation of 0 corresponds to the default - position of the marker. When the marker is flat on the map, the default position is North - aligned and the rotation is such that the marker always remains flat on the map. When the - marker is a billboard, the default position is pointing up and the rotation is such that the - marker is always facing the camera. The default value is 0.

-
-
Returns
-
  • the object for which the method was called, with the new rotation set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - snippet - (String snippet) -

-
-
- - - -
-
- - - - -

Sets the snippet for the marker.

-
-
Returns
-
  • the object for which the method was called, with the new snippet set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - title - (String title) -

-
-
- - - -
-
- - - - -

Sets the title for the marker.

-
-
Returns
-
  • the object for which the method was called, with the new title set. -
-
- -
-
- - - - -
-

- - public - - - - - MarkerOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility for the marker.

-
-
Returns
-
  • the object for which the method was called, with the new visibility state set. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/Polygon.html b/docs/html/reference/com/google/android/gms/maps/model/Polygon.html deleted file mode 100644 index ce61d39212a1..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/Polygon.html +++ /dev/null @@ -1,2522 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Polygon | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Polygon

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.Polygon
- - - - - - - -
- - -

Class Overview

-

A polygon on the earth's surface. A polygon can be convex or concave, it may span the 180 - meridian and it can have holes that are not filled in. It has the following properties: -

-

-
Outline
-
The outline is specified by a list of vertices in clockwise or counterclockwise order. It is - not necessary for the start and end points to coincide; if they do not, the polygon will be - automatically closed. Line segments are drawn between consecutive points in the shorter of the - two directions (east or west). -
Holes
-
A hole is a region inside the polygon that is not filled. A hole is specified in exactly the - same way as the outline. A hole must be fully contained within the outline. Multiple holes can be - specified, however overlapping holes are not supported. -
Stroke Width
-
Line segment width in screen pixels. The width is constant and independent of the camera's - zoom level. The default value is 10.
-
Stroke Color
-
Line segment color in ARGB format, the same format used by Color. - The default value is black (0xff000000).
-
Fill Color
-
Fill color in ARGB format, the same format used by Color. The - default value is transparent (0x00000000). If the polygon geometry is not specified - correctly (see above for Outline and Holes), then no fill will be drawn.
-
Z-Index
-
The order in which this polygon is drawn with respect to other overlays, including - Polylines, Circles, GroundOverlays and TileOverlays, but - not Markers. An overlay with a larger z-index is drawn over overlays with - smaller z-indices. The order of overlays with the same z-index value is arbitrary. - The default is 0.
-
Visibility
-
Indicates if the polygon is visible or invisible, i.e., whether it is drawn on the map. An - invisible polygon is not drawn, but retains all of its other properties. The default is - true, i.e., visible.
-
Geodesic status
-
Indicates whether the segments of the polygon should be drawn as geodesics, as opposed to - straight lines on the Mercator projection. A geodesic is the shortest path between two points on - the Earth's surface. The geodesic curve is constructed assuming the Earth is a sphere
-
-

- Methods that modify a Polygon must be called on the main thread. If not, an - IllegalStateException will be thrown at runtime. -

Example

- - 
 GoogleMap map;
- // ... get a map.
- // Add a triangle in the Gulf of Guinea
- Polygon polygon = map.addPolygon(new PolygonOptions()
-     .add(new LatLng(0, 0), new LatLng(0, 5), new LatLng(3, 5), new LatLng(0, 0))
-     .strokeColor(Color.RED)
-     .fillColor(Color.BLUE));
-

-

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - int - - getFillColor() - -
- Gets the fill color of this polygon. - - - -
- -
- - - - - - List<List<LatLng>> - - getHoles() - -
- Returns a snapshot of the holes of this polygon at this time . - - - -
- -
- - - - - - String - - getId() - -
- Gets this polygon's id. - - - -
- -
- - - - - - List<LatLng> - - getPoints() - -
- Returns a snapshot of the vertices of this polygon at this time . - - - -
- -
- - - - - - int - - getStrokeColor() - -
- Gets the stroke color of this polygon. - - - -
- -
- - - - - - float - - getStrokeWidth() - -
- Gets the stroke width of this polygon. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex of this polygon. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isGeodesic() - -
- Gets whether each segment of the line is drawn as a geodesic or not. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility of this polygon. - - - -
- -
- - - - - - void - - remove() - -
- Removes the polygon from the map. - - - -
- -
- - - - - - void - - setFillColor(int color) - -
- Sets the fill color of this polygon. - - - -
- -
- - - - - - void - - setGeodesic(boolean geodesic) - -
- Sets whether to draw each segment of the line as a geodesic or not. - - - -
- -
- - - - - - void - - setHoles(List<? extends List<LatLng>> holes) - -
- Sets the holes of this polygon. - - - -
- -
- - - - - - void - - setPoints(List<LatLng> points) - -
- Sets the points of this polygon. - - - -
- -
- - - - - - void - - setStrokeColor(int color) - -
- Sets the stroke color of this polygon. - - - -
- -
- - - - - - void - - setStrokeWidth(float width) - -
- Sets the stroke width of this polygon. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of this polygon. - - - -
- -
- - - - - - void - - setZIndex(float zIndex) - -
- Sets the zIndex of this polygon. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getFillColor - () -

-
-
- - - -
-
- - - - -

Gets the fill color of this polygon.

-
-
Returns
-
  • the color in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - List<List<LatLng>> - - getHoles - () -

-
-
- - - -
-
- - - - -

Returns a snapshot of the holes of this polygon at this time . The list returned is a copy of - the list of holes and so changes to the polygon's holes will not be reflected by this list, - nor will changes to this list be reflected by the polygon. -

- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this polygon's id. The id will be unique amongst all Polygons on a map. -

- -
-
- - - - -
-

- - public - - - - - List<LatLng> - - getPoints - () -

-
-
- - - -
-
- - - - -

Returns a snapshot of the vertices of this polygon at this time . The list returned is a copy - of the list of vertices and so changes to the polygon's vertices will not be reflected by - this list, nor will changes to this list be reflected by the polygon. To change the vertices - of the polygon, call setPoints(List). -

- -
-
- - - - -
-

- - public - - - - - int - - getStrokeColor - () -

-
-
- - - -
-
- - - - -

Gets the stroke color of this polygon.

-
-
Returns
-
  • the color in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getStrokeWidth - () -

-
-
- - - -
-
- - - - -

Gets the stroke width of this polygon.

-
-
Returns
-
  • the width in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex of this polygon.

-
-
Returns
-
  • the zIndex of the polygon. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isGeodesic - () -

-
-
- - - -
-
- - - - -

Gets whether each segment of the line is drawn as a geodesic or not.

-
-
Returns
-
  • true if each segment is drawn as a geodesic; false if each segment is - drawn as a straight line on the Mercator projection. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility of this polygon.

-
-
Returns
-
  • this polygon visibility. -
-
- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes the polygon from the map. -

- -
-
- - - - -
-

- - public - - - - - void - - setFillColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the fill color of this polygon.

-
-
Parameters
- - - - -
color - the color in ARGB format -
-
- -
-
- - - - -
-

- - public - - - - - void - - setGeodesic - (boolean geodesic) -

-
-
- - - -
-
- - - - -

Sets whether to draw each segment of the line as a geodesic or not.

-
-
Parameters
- - - - -
geodesic - if true, then each segment is drawn as a geodesic; if false, - each segment is drawn as a straight line on the Mercator projection. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setHoles - (List<? extends List<LatLng>> holes) -

-
-
- - - -
-
- - - - -

Sets the holes of this polygon. This method will take a copy of the holes, so further - mutations to holes will have no effect on this polygon.

-
-
Parameters
- - - - -
holes - an list of holes, where a hole is an list of LatLngs. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPoints - (List<LatLng> points) -

-
-
- - - -
-
- - - - -

Sets the points of this polygon. This method will take a copy of the points, so further - mutations to points will have no effect on this polygon.

-
-
Parameters
- - - - -
points - a list of LatLngs that are the vertices of the polygon. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStrokeColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the stroke color of this polygon.

-
-
Parameters
- - - - -
color - the color in ARGB format -
-
- -
-
- - - - -
-

- - public - - - - - void - - setStrokeWidth - (float width) -

-
-
- - - -
-
- - - - -

Sets the stroke width of this polygon.

-
-
Parameters
- - - - -
width - the width in display pixels. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of this polygon. When not visible, a polygon is not drawn, but it keeps - all its other properties.

-
-
Parameters
- - - - -
visible - if true, then the polygon is visible; if false, it is not. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex of this polygon. Polygons with higher zIndices are drawn above those with - lower indices.

-
-
Parameters
- - - - -
zIndex - the zIndex of this polygon. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html b/docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html deleted file mode 100644 index 9975e2113ba4..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html +++ /dev/null @@ -1,2603 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PolygonOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PolygonOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.PolygonOptions
- - - - - - - -
- - -

Class Overview

-

Defines options for a polygon. -

-

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PolygonOptions() - -
- Creates polygon options. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PolygonOptions - - add(LatLng point) - -
- Adds a vertex to the outline of the polygon being built. - - - -
- -
- - - - - - PolygonOptions - - add(LatLng... points) - -
- Adds vertices to the outline of the polygon being built. - - - -
- -
- - - - - - PolygonOptions - - addAll(Iterable<LatLng> points) - -
- Adds vertices to the outline of the polygon being built. - - - -
- -
- - - - - - PolygonOptions - - addHole(Iterable<LatLng> points) - -
- Adds a hole to the polygon being built. - - - -
- -
- - - - - - PolygonOptions - - fillColor(int color) - -
- Specifies the polygon's fill color, as 32-bit ARGB. - - - -
- -
- - - - - - PolygonOptions - - geodesic(boolean geodesic) - -
- Specifies whether to draw each segment of this polygon as a geodesic. - - - -
- -
- - - - - - int - - getFillColor() - -
- Gets the fill color set for this Options object. - - - -
- -
- - - - - - List<List<LatLng>> - - getHoles() - -
- Gets the holes set for this Options object. - - - -
- -
- - - - - - List<LatLng> - - getPoints() - -
- Gets the outline set for this Options object. - - - -
- -
- - - - - - int - - getStrokeColor() - -
- Gets the stroke color set for this Options object. - - - -
- -
- - - - - - float - - getStrokeWidth() - -
- Gets the stroke width set for this Options object. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex set for this Options object. - - - -
- -
- - - - - - boolean - - isGeodesic() - -
- Gets the geodesic setting for this Options object. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility setting for this Options object. - - - -
- -
- - - - - - PolygonOptions - - strokeColor(int color) - -
- Specifies the polygon's stroke color, as 32-bit ARGB. - - - -
- -
- - - - - - PolygonOptions - - strokeWidth(float width) - -
- Specifies the polygon's stroke width, in display pixels. - - - -
- -
- - - - - - PolygonOptions - - visible(boolean visible) - -
- Specifies the visibility for the polygon. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - PolygonOptions - - zIndex(float zIndex) - -
- Specifies the polygon's zIndex, i.e., the order in which it will be drawn. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PolygonOptions - () -

-
-
- - - -
-
- - - - -

Creates polygon options. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PolygonOptions - - add - (LatLng point) -

-
-
- - - -
-
- - - - -

Adds a vertex to the outline of the polygon being built.

-
-
Returns
-
  • this PolygonOptions object with the given point added to the outline. -
-
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - add - (LatLng... points) -

-
-
- - - -
-
- - - - -

Adds vertices to the outline of the polygon being built.

-
-
Returns
-
  • this PolygonOptions object with the given points added to the outline. -
-
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - addAll - (Iterable<LatLng> points) -

-
-
- - - -
-
- - - - -

Adds vertices to the outline of the polygon being built.

-
-
Returns
-
  • this PolygonOptions object with the given points added to the outline. -
-
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - addHole - (Iterable<LatLng> points) -

-
-
- - - -
-
- - - - -

Adds a hole to the polygon being built.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - fillColor - (int color) -

-
-
- - - -
-
- - - - -

Specifies the polygon's fill color, as 32-bit ARGB. The default color is black ( - 0xff000000).

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - geodesic - (boolean geodesic) -

-
-
- - - -
-
- - - - -

Specifies whether to draw each segment of this polygon as a geodesic. The default setting is - false

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getFillColor - () -

-
-
- - - -
-
- - - - -

Gets the fill color set for this Options object.

-
-
Returns
-
  • the fill color of the polygon in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - List<List<LatLng>> - - getHoles - () -

-
-
- - - -
-
- - - - -

Gets the holes set for this Options object.

-
-
Returns
-
  • the list of Lists specifying the holes of the polygon. -
-
- -
-
- - - - -
-

- - public - - - - - List<LatLng> - - getPoints - () -

-
-
- - - -
-
- - - - -

Gets the outline set for this Options object.

-
-
Returns
-
  • the list of LatLngs specifying the vertices of the outline of the polygon. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStrokeColor - () -

-
-
- - - -
-
- - - - -

Gets the stroke color set for this Options object.

-
-
Returns
-
  • the stroke color of the polygon in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getStrokeWidth - () -

-
-
- - - -
-
- - - - -

Gets the stroke width set for this Options object.

-
-
Returns
-
  • the stroke width of the polygon in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex set for this Options object.

-
-
Returns
-
  • the zIndex of the polygon. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isGeodesic - () -

-
-
- - - -
-
- - - - -

Gets the geodesic setting for this Options object.

-
-
Returns
-
  • true if the polygon segments should be geodesics; false if they - should not be. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility setting for this Options object.

-
-
Returns
-
  • true if the polygon is to be visible; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - strokeColor - (int color) -

-
-
- - - -
-
- - - - -

Specifies the polygon's stroke color, as 32-bit ARGB. The default color is black ( - 0xff000000).

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - strokeWidth - (float width) -

-
-
- - - -
-
- - - - -

Specifies the polygon's stroke width, in display pixels. The default width is 10.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Specifies the visibility for the polygon. The default visibility is true.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - PolygonOptions - - zIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Specifies the polygon's zIndex, i.e., the order in which it will be drawn. See the - documentation at the top of this class for more information about zIndex.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/Polyline.html b/docs/html/reference/com/google/android/gms/maps/model/Polyline.html deleted file mode 100644 index a313b9188da9..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/Polyline.html +++ /dev/null @@ -1,2336 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Polyline | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Polyline

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.Polyline
- - - - - - - -
- - -

Class Overview

-

A polyline is a list of points, where line segments are drawn between consecutive points. A - polyline has the following properties: -

-

-
Points
-
The vertices of the line. Line segments are drawn between consecutive points. A polyline is - not closed by default; to form a closed polyline, the start and end points must be the - same. -
Width
-
Line segment width in screen pixels. The width is constant and independent of the camera's - zoom level. The default value is 10.
-
Color
-
Line segment color in ARGB format, the same format used by Color. - The default value is black (0xff000000).
-
Z-Index
-
The order in which this tile overlay is drawn with respect to other overlays (including - GroundOverlays, TileOverlays, Circles, and Polygons but - not Markers). An overlay with a larger z-index is drawn over overlays with smaller - z-indices. The order of overlays with the same z-index is arbitrary. The default - zIndex is 0.
-
Visibility
-
Indicates if the polyline is visible or invisible, i.e., whether it is drawn on the map. An - invisible polyline is not drawn, but retains all of its other properties. The default is - true, i.e., visible.
-
Geodesic status
-
Indicates whether the segments of the polyline should be drawn as geodesics, as opposed to - straight lines on the Mercator projection. A geodesic is the shortest path between two points on - the Earth's surface. The geodesic curve is constructed assuming the Earth is a sphere
-
-

- Methods that modify a Polyline must be called on the main thread. If not, an - IllegalStateException will be thrown at runtime. -

Example

- - 
 GoogleMap map;
- // ... get a map.
- // Add a thin red line from London to New York.
- Polyline line = map.addPolyline(new PolylineOptions()
-     .add(new LatLng(51.5, -0.1), new LatLng(40.7, -74.0))
-     .width(5)
-     .color(Color.RED));
-

-

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Polyline(IPolylineDelegate delegate) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object other) - -
- - - - - - int - - getColor() - -
- Gets the color of this polyline. - - - -
- -
- - - - - - String - - getId() - -
- Gets this polyline's id. - - - -
- -
- - - - - - List<LatLng> - - getPoints() - -
- Returns a snapshot of the vertices of this polyline at this time . - - - -
- -
- - - - - - float - - getWidth() - -
- Gets the width of this polyline. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex of this polyline. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isGeodesic() - -
- Gets whether each segment of the line is drawn as a geodesic or not. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility of this polyline. - - - -
- -
- - - - - - void - - remove() - -
- Removes this polyline from the map. - - - -
- -
- - - - - - void - - setColor(int color) - -
- Sets the color of this polyline. - - - -
- -
- - - - - - void - - setGeodesic(boolean geodesic) - -
- Sets whether to draw each segment of the line as a geodesic or not. - - - -
- -
- - - - - - void - - setPoints(List<LatLng> points) - -
- Sets the points of this polyline. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of this polyline. - - - -
- -
- - - - - - void - - setWidth(float width) - -
- Sets the width of this polyline. - - - -
- -
- - - - - - void - - setZIndex(float zIndex) - -
- Sets the zIndex of this polyline. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Polyline - (IPolylineDelegate delegate) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getColor - () -

-
-
- - - -
-
- - - - -

Gets the color of this polyline.

-
-
Returns
-
  • the color in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this polyline's id. The id will be unique amongst all Polylines on a map.

-
-
Returns
-
  • this polyline's id. -
-
- -
-
- - - - -
-

- - public - - - - - List<LatLng> - - getPoints - () -

-
-
- - - -
-
- - - - -

Returns a snapshot of the vertices of this polyline at this time . The list returned is a - copy of the list of vertices and so changes to the polyline's vertices will not be reflected - by this list, nor will changes to this list be reflected by the polyline. To change the - vertices of the polyline, call setPoints(List). -

- -
-
- - - - -
-

- - public - - - - - float - - getWidth - () -

-
-
- - - -
-
- - - - -

Gets the width of this polyline.

-
-
Returns
-
  • the width in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex of this polyline.

-
-
Returns
-
  • the zIndex of the polyline. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isGeodesic - () -

-
-
- - - -
-
- - - - -

Gets whether each segment of the line is drawn as a geodesic or not.

-
-
Returns
-
  • true if each segment is drawn as a geodesic; false if each segment is - drawn as a straight line on the Mercator projection. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility of this polyline.

-
-
Returns
-
  • this polyline's visibility. -
-
- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes this polyline from the map. After a polyline has been removed, the behavior of all - its methods is undefined. -

- -
-
- - - - -
-

- - public - - - - - void - - setColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the color of this polyline.

-
-
Parameters
- - - - -
color - the color in ARGB format -
-
- -
-
- - - - -
-

- - public - - - - - void - - setGeodesic - (boolean geodesic) -

-
-
- - - -
-
- - - - -

Sets whether to draw each segment of the line as a geodesic or not.

-
-
Parameters
- - - - -
geodesic - if true, then each segment is drawn as a geodesic; if false, - each segment is drawn as a straight line on the Mercator projection. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setPoints - (List<LatLng> points) -

-
-
- - - -
-
- - - - -

Sets the points of this polyline. This method will take a copy of the points, so further - mutations to points will have no effect on this polyline.

-
-
Parameters
- - - - -
points - an list of LatLngs that are the vertices of the polyline. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of this polyline. When not visible, a polyline is not drawn, but it keeps - all its other properties.

-
-
Parameters
- - - - -
visible - if true, then the polyline is visible; if false, it is not. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setWidth - (float width) -

-
-
- - - -
-
- - - - -

Sets the width of this polyline.

-
-
Parameters
- - - - -
width - the width in screen pixels -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex of this polyline. Polylines with higher zIndices are drawn above those with - lower indices.

-
-
Parameters
- - - - -
zIndex - the zIndex of this polyline. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html b/docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html deleted file mode 100644 index 838bb88ca8fe..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html +++ /dev/null @@ -1,2354 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PolylineOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PolylineOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.PolylineOptions
- - - - - - - -
- - -

Class Overview

-

Defines options for a polyline. -

-

Developer Guide

-

- For more information, read the Shapes - developer guide. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PolylineOptions() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PolylineOptions - - add(LatLng point) - -
- Adds a vertex to the end of the polyline being built. - - - -
- -
- - - - - - PolylineOptions - - add(LatLng... points) - -
- Adds vertices to the end of the polyline being built. - - - -
- -
- - - - - - PolylineOptions - - addAll(Iterable<LatLng> points) - -
- Adds vertices to the end of the polyline being built. - - - -
- -
- - - - - - PolylineOptions - - color(int color) - -
- Sets the color of the polyline as a 32-bit ARGB color. - - - -
- -
- - - - - - PolylineOptions - - geodesic(boolean geodesic) - -
- Specifies whether to draw each segment of this polyline as a geodesic. - - - -
- -
- - - - - - int - - getColor() - -
- Gets the color set for this Options object. - - - -
- -
- - - - - - List<LatLng> - - getPoints() - -
- Gets the points set for this Options object. - - - -
- -
- - - - - - float - - getWidth() - -
- Gets the width set for this Options object. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex set for this Options object. - - - -
- -
- - - - - - boolean - - isGeodesic() - -
- Gets the geodesic setting for this Options object. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility setting for this Options object. - - - -
- -
- - - - - - PolylineOptions - - visible(boolean visible) - -
- Specifies the visibility for the polyline. - - - -
- -
- - - - - - PolylineOptions - - width(float width) - -
- Sets the width of the polyline in screen pixels. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - PolylineOptions - - zIndex(float zIndex) - -
- Specifies the polyline's zIndex, i.e., the order in which it will be drawn. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PolylineOptions - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PolylineOptions - - add - (LatLng point) -

-
-
- - - -
-
- - - - -

Adds a vertex to the end of the polyline being built.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - add - (LatLng... points) -

-
-
- - - -
-
- - - - -

Adds vertices to the end of the polyline being built.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - addAll - (Iterable<LatLng> points) -

-
-
- - - -
-
- - - - -

Adds vertices to the end of the polyline being built.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - color - (int color) -

-
-
- - - -
-
- - - - -

Sets the color of the polyline as a 32-bit ARGB color. The default color is black ( - 0xff000000).

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - geodesic - (boolean geodesic) -

-
-
- - - -
-
- - - - -

Specifies whether to draw each segment of this polyline as a geodesic. The default setting is - false

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getColor - () -

-
-
- - - -
-
- - - - -

Gets the color set for this Options object.

-
-
Returns
-
  • the color of the polyline in ARGB format. -
-
- -
-
- - - - -
-

- - public - - - - - List<LatLng> - - getPoints - () -

-
-
- - - -
-
- - - - -

Gets the points set for this Options object.

-
-
Returns
-
  • the list of LatLngs specifying the vertices of the polyline. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getWidth - () -

-
-
- - - -
-
- - - - -

Gets the width set for this Options object.

-
-
Returns
-
  • the width of the polyline in screen pixels. -
-
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex set for this Options object.

-
-
Returns
-
  • the zIndex of the polyline. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isGeodesic - () -

-
-
- - - -
-
- - - - -

Gets the geodesic setting for this Options object.

-
-
Returns
-
  • true if the polyline segments should be geodesics; false they should - not be. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility setting for this Options object.

-
-
Returns
-
  • true if the polyline is to be visible; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Specifies the visibility for the polyline. The default visibility is true.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - width - (float width) -

-
-
- - - -
-
- - - - -

Sets the width of the polyline in screen pixels. The default is 10.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - PolylineOptions - - zIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Specifies the polyline's zIndex, i.e., the order in which it will be drawn. See the - documentation at the top of this class for more information about zIndex.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html b/docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html deleted file mode 100644 index 662aa3814e0d..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html +++ /dev/null @@ -1,1617 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -RuntimeRemoteException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

RuntimeRemoteException

- - - - - - - - - - - - - - - - - extends RuntimeException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳java.lang.RuntimeException
      ↳com.google.android.gms.maps.model.RuntimeRemoteException
- - - - - - - -
- - -

Class Overview

-

A RuntimeException wrapper for RemoteException. Thrown when normally there is something seriously - wrong and there is no way to recover. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - RuntimeRemoteException(RemoteException e) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - RuntimeRemoteException - (RemoteException e) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.Builder.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.Builder.html deleted file mode 100644 index c592154eba2d..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.Builder.html +++ /dev/null @@ -1,1826 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaCamera.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

StreetViewPanoramaCamera.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaCamera.Builder
- - - - - - - -
- - -

Class Overview

-

Builds panorama cameras.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - - floatbearing - - - - -
- public - - - floattilt - - - - -
- public - - - floatzoom - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaCamera.Builder() - -
- Creates an empty builder. - - - -
- -
- - - - - - - - StreetViewPanoramaCamera.Builder(StreetViewPanoramaCamera previous) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - StreetViewPanoramaCamera.Builder - - bearing(float bearing) - -
- Sets the direction that the camera is pointing in, in degrees clockwise from north. - - - -
- -
- - - - - - StreetViewPanoramaCamera - - build() - -
- Builds a StreetViewPanoramaCamera. - - - -
- -
- - - - - - StreetViewPanoramaCamera.Builder - - orientation(StreetViewPanoramaOrientation orientation) - -
- Sets the camera tilt and bearing based upon the given orientation's tilt and bearing - - - - -
- -
- - - - - - StreetViewPanoramaCamera.Builder - - tilt(float tilt) - -
- Sets the angle, in degrees, of the camera from the horizon of the panorama. - - - -
- -
- - - - - - StreetViewPanoramaCamera.Builder - - zoom(float zoom) - -
- Sets the zoom level of the camera. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - - float - - bearing -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - - - float - - tilt -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - - - float - - zoom -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaCamera.Builder - () -

-
-
- - - -
-
- - - - -

Creates an empty builder. -

- -
-
- - - - -
-

- - public - - - - - - - StreetViewPanoramaCamera.Builder - (StreetViewPanoramaCamera previous) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - StreetViewPanoramaCamera.Builder - - bearing - (float bearing) -

-
-
- - - -
-
- - - - -

Sets the direction that the camera is pointing in, in degrees clockwise from north. -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera - - build - () -

-
-
- - - -
-
- - - - -

Builds a StreetViewPanoramaCamera.

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera.Builder - - orientation - (StreetViewPanoramaOrientation orientation) -

-
-
- - - -
-
- - - - -

Sets the camera tilt and bearing based upon the given orientation's tilt and bearing -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera.Builder - - tilt - (float tilt) -

-
-
- - - -
-
- - - - -

Sets the angle, in degrees, of the camera from the horizon of the panorama. - This value is restricted to being between -90 (directly down) and 90 (directly up). -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaCamera.Builder - - zoom - (float zoom) -

-
-
- - - -
-
- - - - -

Sets the zoom level of the camera. - The original zoom level is set at 0. A zoom of 1 would double the magnification. - The zoom is clamped between 0 and the maximum zoom level. The maximum zoom level can vary - based upon the panorama. Clamped means that any value falling outside this range will be - set to the closest extreme that falls within the range. For example, a value of -1 will be - set to 0. Another example: If the maximum zoom for the panorama is 19, and the value is - given as 20, it will be set to 19. - Note that the camera zoom need not be an integer value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.html deleted file mode 100644 index f5441b111bb5..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.html +++ /dev/null @@ -1,2052 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaCamera | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaCamera

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaCamera
- - - - - - - -
- - -

Class Overview

-

An immutable class that aggregates all camera position parameters. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classStreetViewPanoramaCamera.Builder - Builds panorama cameras.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - floatbearing - Direction that the camera is pointing in, in degrees clockwise from north. - - - -
- public - - final - floattilt - The angle, in degrees, of the camera from the horizon of the panorama. - - - -
- public - - final - floatzoom - Zoom level near the centre of the screen. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaCamera(float zoom, float tilt, float bearing) - -
- Constructs a StreetViewPanoramaCamera. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - StreetViewPanoramaCamera.Builder - - builder(StreetViewPanoramaCamera camera) - -
- Creates a builder for a Street View panorama camera - - - -
- -
- - - - static - - StreetViewPanoramaCamera.Builder - - builder() - -
- Creates a builder for a Street View panorama camera. - - - -
- -
- - - - - - boolean - - equals(Object o) - -
- - - - - - StreetViewPanoramaOrientation - - getOrientation() - -
- Returns the particular camera's tilt and bearing as an orientation - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - float - - bearing -

-
- - - - -
-
- - - - -

Direction that the camera is pointing in, in degrees clockwise from north. -

- - -
-
- - - - - -
-

- - public - - final - float - - tilt -

-
- - - - -
-
- - - - -

The angle, in degrees, of the camera from the horizon of the panorama. See - tilt for details of restrictions on the range of values. -

- - -
-
- - - - - -
-

- - public - - final - float - - zoom -

-
- - - - -
-
- - - - -

Zoom level near the centre of the screen. See zoom for the definition of the - camera's zoom level. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaCamera - (float zoom, float tilt, float bearing) -

-
-
- - - -
-
- - - - -

Constructs a StreetViewPanoramaCamera.

-
-
Parameters
- - - - - - - - - - -
zoom - Zoom level of the camera to the panorama. See - zoom for - details of restrictions.
tilt - The camera angle, in degrees, from the horizon of the panorama. See - tilt for - details of restrictions.
bearing - Direction that the camera is pointing in, in degrees clockwise from north. - This value will be normalized to be within 0 degrees inclusive and 360 degrees - exclusive.
-
-
-
Throws
- - - - -
IllegalArgumentException - if tilt is outside the range of - -90 to 90 degrees inclusive. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - StreetViewPanoramaCamera.Builder - - builder - (StreetViewPanoramaCamera camera) -

-
-
- - - -
-
- - - - -

Creates a builder for a Street View panorama camera

- -
-
- - - - -
-

- - public - static - - - - StreetViewPanoramaCamera.Builder - - builder - () -

-
-
- - - -
-
- - - - -

Creates a builder for a Street View panorama camera.

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOrientation - - getOrientation - () -

-
-
- - - -
-
- - - - -

Returns the particular camera's tilt and bearing as an orientation

-
-
Returns
-
  • orientation Tilt and bearing of the camera -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLink.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLink.html deleted file mode 100644 index d2568caca08e..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLink.html +++ /dev/null @@ -1,1699 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaLink | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaLink

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaLink
- - - - - - - -
- - -

Class Overview

-

An immutable class that represents a link to another Street View panorama. - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - floatbearing - The direction of the linked Street View panorama, in degrees clockwise from north - - - - -
- public - - final - StringpanoId - Panorama ID of the linked Street View panorama - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - float - - bearing -

-
- - - - -
-
- - - - -

The direction of the linked Street View panorama, in degrees clockwise from north -

- - -
-
- - - - - -
-

- - public - - final - String - - panoId -

-
- - - - -
-
- - - - -

Panorama ID of the linked Street View panorama -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLocation.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLocation.html deleted file mode 100644 index 95cdc3fde75a..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaLocation.html +++ /dev/null @@ -1,1840 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaLocation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaLocation

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaLocation
- - - - - - - -
- - -

Class Overview

-

An immutable class that contains details of the user's current Street View panorama - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - StreetViewPanoramaLink[]links - Array of StreetViewPanoramaLink able to be reached from the current position - - - - -
- public - - final - StringpanoId - The panorama ID of the current Street View panorama - - - - -
- public - - final - LatLngposition - The location of the current Street View panorama - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaLocation(StreetViewPanoramaLink[] links, LatLng position, String panoId) - -
- Constructs a StreetViewPanoramaLocation. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - StreetViewPanoramaLink[] - - links -

-
- - - - -
-
- - - - -

Array of StreetViewPanoramaLink able to be reached from the current position -

- - -
-
- - - - - -
-

- - public - - final - String - - panoId -

-
- - - - -
-
- - - - -

The panorama ID of the current Street View panorama -

- - -
-
- - - - - -
-

- - public - - final - LatLng - - position -

-
- - - - -
-
- - - - -

The location of the current Street View panorama -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaLocation - (StreetViewPanoramaLink[] links, LatLng position, String panoId) -

-
-
- - - -
-
- - - - -

Constructs a StreetViewPanoramaLocation.

-
-
Parameters
- - - - - - - - - - -
links - List of StreetViewPanoramaLink reachable from the current position.
position - The location of the current Street View panorama.
panoId - Identification string for the current Street View panorama. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.Builder.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.Builder.html deleted file mode 100644 index 97e9ce55eac1..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.Builder.html +++ /dev/null @@ -1,1660 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaOrientation.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

StreetViewPanoramaOrientation.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaOrientation.Builder
- - - - - - - -
- - -

Class Overview

-

Builds Street View panorama orientations.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - - floatbearing - - - - -
- public - - - floattilt - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaOrientation.Builder() - -
- Creates an empty builder. - - - -
- -
- - - - - - - - StreetViewPanoramaOrientation.Builder(StreetViewPanoramaOrientation previous) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - StreetViewPanoramaOrientation.Builder - - bearing(float bearing) - -
- Sets the direction of the orientation, in degrees clockwise from north. - - - -
- -
- - - - - - StreetViewPanoramaOrientation - - build() - -
- Builds a StreetViewPanoramaOrientation. - - - -
- -
- - - - - - StreetViewPanoramaOrientation.Builder - - tilt(float tilt) - -
- Sets the angle, in degrees, of the orientation - This value is restricted to being between -90 (directly down) and 90 (directly up). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - - float - - bearing -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - - - float - - tilt -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaOrientation.Builder - () -

-
-
- - - -
-
- - - - -

Creates an empty builder. -

- -
-
- - - - -
-

- - public - - - - - - - StreetViewPanoramaOrientation.Builder - (StreetViewPanoramaOrientation previous) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - StreetViewPanoramaOrientation.Builder - - bearing - (float bearing) -

-
-
- - - -
-
- - - - -

Sets the direction of the orientation, in degrees clockwise from north. -

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOrientation - - build - () -

-
-
- - - -
-
- - - - -

Builds a StreetViewPanoramaOrientation.

- -
-
- - - - -
-

- - public - - - - - StreetViewPanoramaOrientation.Builder - - tilt - (float tilt) -

-
-
- - - -
-
- - - - -

Sets the angle, in degrees, of the orientation - This value is restricted to being between -90 (directly down) and 90 (directly up). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.html b/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.html deleted file mode 100644 index 63c9686d64c6..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.html +++ /dev/null @@ -1,1938 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -StreetViewPanoramaOrientation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

StreetViewPanoramaOrientation

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.StreetViewPanoramaOrientation
- - - - - - - -
- - -

Class Overview

-

An immutable class that aggregates all user point of view parameters. - -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classStreetViewPanoramaOrientation.Builder - Builds Street View panorama orientations.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - floatbearing - Direction of the orientation, in degrees clockwise from north. - - - -
- public - - final - floattilt - The angle, in degrees, of the orientation. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - StreetViewPanoramaOrientation(float tilt, float bearing) - -
- Constructs a StreetViewPanoramaOrientation. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - StreetViewPanoramaOrientation.Builder - - builder() - -
- Creates a builder for a Street View panorama orientation. - - - -
- -
- - - - static - - StreetViewPanoramaOrientation.Builder - - builder(StreetViewPanoramaOrientation orientation) - -
- Creates a builder for a Street View panorama orientation - - - -
- -
- - - - - - boolean - - equals(Object o) - -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - float - - bearing -

-
- - - - -
-
- - - - -

Direction of the orientation, in degrees clockwise from north. -

- - -
-
- - - - - -
-

- - public - - final - float - - tilt -

-
- - - - -
-
- - - - -

The angle, in degrees, of the orientation. See tilt for details of - restrictions on the range of values. -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - StreetViewPanoramaOrientation - (float tilt, float bearing) -

-
-
- - - -
-
- - - - -

Constructs a StreetViewPanoramaOrientation.

-
-
Parameters
- - - - - - - -
tilt - The angle, in degrees, of the orientation. See - tilt - for details of restrictions.
bearing - Direction of the orientation, in degrees clockwise from north. - This value will be normalized to be within 0 degrees inclusive and 360 degrees - exclusive.
-
-
-
Throws
- - - - -
IllegalArgumentException - if tilt is outside the range of -90 to 90 degrees - inclusive. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - StreetViewPanoramaOrientation.Builder - - builder - () -

-
-
- - - -
-
- - - - -

Creates a builder for a Street View panorama orientation.

- -
-
- - - - -
-

- - public - static - - - - StreetViewPanoramaOrientation.Builder - - builder - (StreetViewPanoramaOrientation orientation) -

-
-
- - - -
-
- - - - -

Creates a builder for a Street View panorama orientation

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/Tile.html b/docs/html/reference/com/google/android/gms/maps/model/Tile.html deleted file mode 100644 index 763ec1a3a86c..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/Tile.html +++ /dev/null @@ -1,1692 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Tile | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Tile

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.Tile
- - - - - - - -
- - -

Class Overview

-

Contains information about a Tile that is returned by a TileProvider. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - byte[]data - A byte array containing the image data. - - - -
- public - - final - intheight - The height of the image encoded by data in pixels. - - - -
- public - - final - intwidth - The width of the image encoded by data in pixels. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Tile(int width, int height, byte[] data) - -
- Constructs a Tile. - - - -
- -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - byte[] - - data -

-
- - - - -
-
- - - - -

A byte array containing the image data. The image will be created from this data by calling - decodeByteArray(byte[], int, int). -

- - -
-
- - - - - -
-

- - public - - final - int - - height -

-
- - - - -
-
- - - - -

The height of the image encoded by data in pixels.

- - -
-
- - - - - -
-

- - public - - final - int - - width -

-
- - - - -
-
- - - - -

The width of the image encoded by data in pixels.

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Tile - (int width, int height, byte[] data) -

-
-
- - - -
-
- - - - -

Constructs a Tile.

-
-
Parameters
- - - - - - - - - - -
width - the width of the image in pixels
height - the height of the image in pixels
data - A byte array containing the image data. The image will be created from this data - by calling decodeByteArray(byte[], int, int). -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html b/docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html deleted file mode 100644 index 09564a5ea37f..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html +++ /dev/null @@ -1,1961 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TileOverlay | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

TileOverlay

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.TileOverlay
- - - - - - - -
- - -

Class Overview

-

A Tile Overlay is a set of images which are displayed on top of the base map tiles. These tiles - may be transparent, allowing you to add features to existing maps. A tile overlay has the - following properties: -

-
Tile Provider
-
The TileProvider provides the images that are used in the tile overlay. You must - specify the tile provider before it is added to the map. The tile provider cannot be changed once - it has been added; however, you can modify the behavior of the tile provider to return different - images for specific coordinates. If the tiles provided by the tile provider change, you must call - clearTileCache() afterwards to ensure that the previous tiles are no longer rendered. -
-
Z-Index
-
The order in which this tile overlay is drawn with respect to other overlays (including - GroundOverlays, Circles, Polylines, and Polygons but - not Markers). An overlay with a larger z-index is drawn over overlays with smaller - z-indices. The order of overlays with the same z-index is arbitrary. The default - zIndex is 0.
-
Visibility
-
Indicates if the tile overlay is visible or invisible, i.e., whether it is drawn on the map. - An invisible tile overlay is not drawn, but retains all of its other properties. The default is - true, i.e., visible.
-
-

- You must only call methods in this class on the main thread. Failure to do so will result in an - IllegalStateException. -

Tile Coordinates

-

- Note that the world is projected using the Mercator projection (see Wikipedia) with the left (west) side - of the map corresponding to -180 degrees of longitude and the right (east) side of the map - corresponding to 180 degrees of longitude. To make the map square, the top (north) side of the - map corresponds to 85.0511 degrees of latitude and the bottom (south) side of the map corresponds - to -85.0511 degrees of latitude. Areas outside this latitude range are not rendered. -

- At each zoom level, the map is divided into tiles and only the tiles that overlap the screen are - downloaded and rendered. Each tile is square and the map is divided into tiles as follows: -

    -
  • At zoom level 0, one tile represents the entire world. The coordinates of that tile are (x, - y) = (0, 0). -
  • At zoom level 1, the world is divided into 4 tiles arranged in a 2 x 2 grid. -
  • ... -
  • At zoom level N, the world is divided into 4N tiles arranged in a 2N x - 2N grid. -
- Note that the minimum zoom level that the camera supports (which can depend on various factors) - is GoogleMap.getMinZoomLevel and - the maximum zoom level is GoogleMap.getMaxZoomLevel. -

- The coordinates of the tiles are measured from the top left (northwest) corner of the map. At - zoom level N, the x values of the tile coordinates range from 0 to 2N - 1 and - increase from west to east and the y values range from 0 to 2N - 1 and - increase from north to south. -

Example

- - 
 GoogleMap map; // ... get a map.
- TileProvider tileProvider; // ... create a tile provider.
- TileOverlay tileOverlay = map.addTileOverlay(
-     new TileOverlayOptions().tileProvider(tileProvider));
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - clearTileCache() - -
- Clears the tile cache so that all tiles will be requested again from the - TileProvider. - - - -
- -
- - - - - - boolean - - equals(Object other) - -
- - - - - - boolean - - getFadeIn() - -
- Gets whether the tiles should fade in. - - - -
- -
- - - - - - String - - getId() - -
- Gets this tile overlay's id. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex of this tile overlay. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isVisible() - -
- Gets the visibility of this tile overlay. - - - -
- -
- - - - - - void - - remove() - -
- Removes this tile overlay from the map. - - - -
- -
- - - - - - void - - setFadeIn(boolean fadeIn) - -
- Sets whether the tiles should fade in. - - - -
- -
- - - - - - void - - setVisible(boolean visible) - -
- Sets the visibility of this tile overlay. - - - -
- -
- - - - - - void - - setZIndex(float zIndex) - -
- Sets the zIndex of this tile overlay. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - clearTileCache - () -

-
-
- - - -
-
- - - - -

Clears the tile cache so that all tiles will be requested again from the - TileProvider. The current tiles from this tile overlay will also be cleared from the - map after calling this. -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object other) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - getFadeIn - () -

-
-
- - - -
-
- - - - -

Gets whether the tiles should fade in.

-
-
Returns
-
  • true if the tiles are to fade in; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

Gets this tile overlay's id. -

- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex of this tile overlay.

-
-
Returns
-
  • the zIndex of the tile overlay. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility of this tile overlay. Note that this does not return whether the tile - overlay is actually within the screen's viewport, but whether it will be drawn if it is - contained in the screen's viewport.

-
-
Returns
-
  • this tile overlay's visibility. -
-
- -
-
- - - - -
-

- - public - - - - - void - - remove - () -

-
-
- - - -
-
- - - - -

Removes this tile overlay from the map. -

- -
-
- - - - -
-

- - public - - - - - void - - setFadeIn - (boolean fadeIn) -

-
-
- - - -
-
- - - - -

Sets whether the tiles should fade in.

-
-
Parameters
- - - - -
fadeIn - if true, then the tiles will fade in; if false, the tiles - will not fade in. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVisible - (boolean visible) -

-
-
- - - -
-
- - - - -

Sets the visibility of this tile overlay. When not visible, a tile overlay is not drawn, but - it keeps all its other properties.

-
-
Parameters
- - - - -
visible - if true, then the tile overlay is visible; if false, it is - not. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setZIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Sets the zIndex of this tile overlay. See the documentation at the top of this class for more - information.

-
-
Parameters
- - - - -
zIndex - the zIndex of this tile overlay. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html b/docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html deleted file mode 100644 index dfef02c00ecb..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html +++ /dev/null @@ -1,2003 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TileOverlayOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

TileOverlayOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.TileOverlayOptions
- - - - - - - -
- - -

Class Overview

-

Defines options for a TileOverlay. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - TileOverlayOptions() - -
- Creates a new set of tile overlay options. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - TileOverlayOptions - - fadeIn(boolean fadeIn) - -
- Specifies whether the tiles should fade in. - - - -
- -
- - - - - - boolean - - getFadeIn() - -
- Gets whether the tiles should fade in. - - - -
- -
- - - - - - TileProvider - - getTileProvider() - -
- Gets the tile provider set for this TileOverlayOptions object. - - - -
- -
- - - - - - float - - getZIndex() - -
- Gets the zIndex set for this TileOverlayOptions object. - - - -
- -
- - - - - - boolean - - isVisible() - -
- Gets the visibility setting for this TileOverlayOptions object. - - - -
- -
- - - - - - TileOverlayOptions - - tileProvider(TileProvider tileProvider) - -
- Specifies the tile provider to use for this tile overlay. - - - -
- -
- - - - - - TileOverlayOptions - - visible(boolean visible) - -
- Specifies the visibility for the tile overlay. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - TileOverlayOptions - - zIndex(float zIndex) - -
- Specifies the tile overlay's zIndex, i.e., the order in which it will be drawn where overlays - with larger values are drawn above those with lower values. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - TileOverlayOptions - () -

-
-
- - - -
-
- - - - -

Creates a new set of tile overlay options.

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - TileOverlayOptions - - fadeIn - (boolean fadeIn) -

-
-
- - - -
-
- - - - -

Specifies whether the tiles should fade in. The default is true.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - boolean - - getFadeIn - () -

-
-
- - - -
-
- - - - -

Gets whether the tiles should fade in.

-
-
Returns
-
  • true if the tiles are to fade in; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - TileProvider - - getTileProvider - () -

-
-
- - - -
-
- - - - -

Gets the tile provider set for this TileOverlayOptions object.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - float - - getZIndex - () -

-
-
- - - -
-
- - - - -

Gets the zIndex set for this TileOverlayOptions object.

-
-
Returns
-
  • the zIndex of the tile overlay. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isVisible - () -

-
-
- - - -
-
- - - - -

Gets the visibility setting for this TileOverlayOptions object.

-
-
Returns
-
  • true if the tile overlay is to be visible; false if it is not. -
-
- -
-
- - - - -
-

- - public - - - - - TileOverlayOptions - - tileProvider - (TileProvider tileProvider) -

-
-
- - - -
-
- - - - -

Specifies the tile provider to use for this tile overlay.

-
-
Parameters
- - - - -
tileProvider - the TileProvider to use for this tile overlay.
-
-
-
Returns
-
  • the object for which the method was called, with the new tile provider set. -
-
- -
-
- - - - -
-

- - public - - - - - TileOverlayOptions - - visible - (boolean visible) -

-
-
- - - -
-
- - - - -

Specifies the visibility for the tile overlay. The default visibility is true.

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - TileOverlayOptions - - zIndex - (float zIndex) -

-
-
- - - -
-
- - - - -

Specifies the tile overlay's zIndex, i.e., the order in which it will be drawn where overlays - with larger values are drawn above those with lower values. See the documentation at the top - of this class for more information about zIndex.

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/TileProvider.html b/docs/html/reference/com/google/android/gms/maps/model/TileProvider.html deleted file mode 100644 index 1143ff8eb621..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/TileProvider.html +++ /dev/null @@ -1,1219 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TileProvider | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - Fields - - - - - - - | Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

TileProvider

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.maps.model.TileProvider
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

An interface for a class that provides the tile images for a TileOverlay. For information - about the tile coordinate system, see TileOverlay. -

- Calls to methods in this interface might be made from multiple threads so implementations of this - interface must be threadsafe. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - TileNO_TILE - Stub tile that is used to indicate that no tile exists for a specific tile coordinate. - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Tile - - getTile(int x, int y, int zoom) - -
- Returns the tile to be used for this tile coordinate. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Tile - - NO_TILE -

-
- - - - -
-
- - - - -

Stub tile that is used to indicate that no tile exists for a specific tile coordinate.

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Tile - - getTile - (int x, int y, int zoom) -

-
-
- - - -
-
- - - - -

Returns the tile to be used for this tile coordinate.

-
-
Parameters
- - - - - - - - - - -
x - The x coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
y - The y coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
zoom - The zoom level of the tile. This will be in the range [ - GoogleMap.getMinZoomLevel, - GoogleMap.getMaxZoomLevel] inclusive.
-
-
-
Returns
-
  • the Tile to be used for this tile coordinate. If you do not wish to provide a - tile for this tile coordinate, return NO_TILE. If the tile could not be - found at this point in time, return null and further requests might be made with an - exponential backoff. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html b/docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html deleted file mode 100644 index 02e9399a286f..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html +++ /dev/null @@ -1,1632 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -UrlTileProvider | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - Inherited Fields - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

UrlTileProvider

- - - - - extends Object
- - - - - - - implements - - TileProvider - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.UrlTileProvider
- - - - - - - -
- - -

Class Overview

-

A partial implementation of TileProvider that only requires a URL that points to an image - to be provided. -

- Note that this class requires that all the images have the same dimensions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From interface -com.google.android.gms.maps.model.TileProvider -
- - -
-
- - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - UrlTileProvider(int width, int height) - -
- Constructs a UrlTileProvider. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - Tile - - getTile(int x, int y, int zoom) - -
- Returns the tile to be used for this tile coordinate. - - - -
- -
- abstract - - - - - URL - - getTileUrl(int x, int y, int zoom) - -
- Returns a URL that points to the image to be used for this tile. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.maps.model.TileProvider - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - UrlTileProvider - (int width, int height) -

-
-
- - - -
-
- - - - -

Constructs a UrlTileProvider.

-
-
Parameters
- - - - - - - -
width - width of the images used for tiles
height - height of the images used for tiles -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - Tile - - getTile - (int x, int y, int zoom) -

-
-
- - - -
-
- - - - -

Returns the tile to be used for this tile coordinate.

-
-
Parameters
- - - - - - - - - - -
x - The x coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
y - The y coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
zoom - The zoom level of the tile. This will be in the range [ - GoogleMap.getMinZoomLevel, - GoogleMap.getMaxZoomLevel] inclusive.
-
-
-
Returns
-
  • the Tile to be used for this tile coordinate. If you do not wish to provide a - tile for this tile coordinate, return NO_TILE. If the tile could not be - found at this point in time, return null and further requests might be made with an - exponential backoff. -
-
- -
-
- - - - -
-

- - public - - - abstract - - URL - - getTileUrl - (int x, int y, int zoom) -

-
-
- - - -
-
- - - - -

Returns a URL that points to the image to be used for this tile. If no image is found - on the initial request, further requests will be made with an exponential backoff. If you do - not wish to provide an image for this tile coordinate, return null.

-
-
Parameters
- - - - - - - - - - -
x - The x coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
y - The y coordinate of the tile. This will be in the range [0, 2zoom - 1] - inclusive.
zoom - The zoom level of the tile. This will be in the range [ - GoogleMap.getMinZoomLevel, - GoogleMap.getMaxZoomLevel] - inclusive.
-
-
-
Returns
-
  • URL a URL that points to the image to be used for this tile. If you do not - wish to provide an image for this tile coordinate, return null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html b/docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html deleted file mode 100644 index 2126916b25a8..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html +++ /dev/null @@ -1,1975 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -VisibleRegion | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

VisibleRegion

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.maps.model.VisibleRegion
- - - - - - - -
- - -

Class Overview

-

Contains the four points defining the four-sided polygon that is visible in a map's camera. This - polygon can be a trapezoid instead of a rectangle, because a camera can have tilt. If the camera - is directly over the center of the camera, the shape is rectangular, but if the camera is tilted, - the shape will appear to be a trapezoid whose smallest side is closest to the point of view. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - - final - LatLngfarLeft - LatLng object that defines the far left corner of the camera. - - - -
- public - - final - LatLngfarRight - LatLng object that defines the far right corner of the camera. - - - -
- public - - final - LatLngBoundslatLngBounds - The smallest bounding box that includes the visible region defined in this class. - - - -
- public - - final - LatLngnearLeft - LatLng object that defines the bottom left corner of the camera. - - - -
- public - - final - LatLngnearRight - LatLng object that defines the bottom right corner of the camera. - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - VisibleRegion(LatLng nearLeft, LatLng nearRight, LatLng farLeft, LatLng farRight, LatLngBounds latLngBounds) - -
- Creates a new VisibleRegion given the four corners of the camera. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - equals(Object o) - -
- Compares this VisibleRegion to another object. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - LatLng - - farLeft -

-
- - - - -
-
- - - - -

LatLng object that defines the far left corner of the camera.

- - -
-
- - - - - -
-

- - public - - final - LatLng - - farRight -

-
- - - - -
-
- - - - -

LatLng object that defines the far right corner of the camera.

- - -
-
- - - - - -
-

- - public - - final - LatLngBounds - - latLngBounds -

-
- - - - -
-
- - - - -

The smallest bounding box that includes the visible region defined in this class. -

- If this box crosses the 180° meridian (the vertical line from north to south), the - longitude in farRight will be negative and the longitude in - farLeft will be positive. This rule also applies to nearRight and - nearLeft. -

- - -
-
- - - - - -
-

- - public - - final - LatLng - - nearLeft -

-
- - - - -
-
- - - - -

LatLng object that defines the bottom left corner of the camera.

- - -
-
- - - - - -
-

- - public - - final - LatLng - - nearRight -

-
- - - - -
-
- - - - -

LatLng object that defines the bottom right corner of the camera.

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - VisibleRegion - (LatLng nearLeft, LatLng nearRight, LatLng farLeft, LatLng farRight, LatLngBounds latLngBounds) -

-
-
- - - -
-
- - - - -

Creates a new VisibleRegion given the four corners of the camera. The LatLng parameters must - define a convex shape (the edges of the resulting shape mustn't cross). No bounds checking is - performed at runtime.

-
-
Parameters
- - - - - - - - - - - - - - - - -
nearLeft - a LatLng object containing the latitude and longitude of the near - left corner of the region.
nearRight - a LatLng object containing the latitude and longitude of the near - right corner of the region.
farLeft - a LatLng object containing the latitude and longitude of the far left - corner of the region.
farRight - a LatLng object containing the latitude and longitude of the far - right corner of the region.
latLngBounds - the smallest bounding box that includes the visible region defined in - this class. If this box crosses the 180° meridian (the vertical line from north to - south), the longitude in farRight will be negative and the longitude in - farLeft will be positive. Same applies to nearRight and - nearLeft. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

Compares this VisibleRegion to another object. If the other object is actually a - pointer to this object, or if all four corners and the bounds of the two objects are the - same, this method returns true. Otherwise, this method returns false.

-
-
Parameters
- - - - -
o - an Object. Return true if both objects are the same object, or if - all four corners and the bounds of the two objects are the same. Return false - otherwise. -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/model/package-summary.html b/docs/html/reference/com/google/android/gms/maps/model/package-summary.html deleted file mode 100644 index 94f85305f76e..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/model/package-summary.html +++ /dev/null @@ -1,1254 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.maps.model | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.maps.model

-
- -
- -
- - -
- Contains the Google Maps Android API model classes. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
TileProvider - An interface for a class that provides the tile images for a TileOverlay.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BitmapDescriptor - Defines an image.  - - - -
BitmapDescriptorFactory - Used to create a definition of an image, used for marker icons and ground overlays.  - - - -
CameraPosition - An immutable class that aggregates all camera position parameters.  - - - -
CameraPosition.Builder - Builds camera position.  - - - -
Circle - A circle on the earth's surface (spherical cap).  - - - -
CircleOptions - Defines options for a Circle.  - - - -
GroundOverlay - A ground overlay is an image that is fixed to a map.  - - - -
GroundOverlayOptions - Defines options for a ground overlay.  - - - -
IndoorBuilding - Represents a building.  - - - -
IndoorLevel - Represents a level in a building.  - - - -
LatLng - An immutable class representing a pair of latitude and longitude coordinates, stored as degrees.  - - - -
LatLngBounds - An immutable class representing a latitude/longitude aligned rectangle.  - - - -
LatLngBounds.Builder - This is a builder that is able to create a minimum bound based on a set of LatLng points.  - - - -
Marker - An icon placed at a particular point on the map's surface.  - - - -
MarkerOptions - Defines MarkerOptions for a marker.  - - - -
Polygon - A polygon on the earth's surface.  - - - -
PolygonOptions - Defines options for a polygon.  - - - -
Polyline - A polyline is a list of points, where line segments are drawn between consecutive points.  - - - -
PolylineOptions - Defines options for a polyline.  - - - -
StreetViewPanoramaCamera - An immutable class that aggregates all camera position parameters.  - - - -
StreetViewPanoramaCamera.Builder - Builds panorama cameras.  - - - -
StreetViewPanoramaLink - An immutable class that represents a link to another Street View panorama.  - - - -
StreetViewPanoramaLocation - An immutable class that contains details of the user's current Street View panorama - -  - - - -
StreetViewPanoramaOrientation - An immutable class that aggregates all user point of view parameters.  - - - -
StreetViewPanoramaOrientation.Builder - Builds Street View panorama orientations.  - - - -
Tile - Contains information about a Tile that is returned by a TileProvider.  - - - -
TileOverlay - A Tile Overlay is a set of images which are displayed on top of the base map tiles.  - - - -
TileOverlayOptions - Defines options for a TileOverlay.  - - - -
UrlTileProvider - A partial implementation of TileProvider that only requires a URL that points to an image - to be provided.  - - - -
VisibleRegion - Contains the four points defining the four-sided polygon that is visible in a map's camera.  - - - -
- -
- - - - - - - -

Exceptions

-
- - - - - - - - - - -
RuntimeRemoteException - A RuntimeException wrapper for RemoteException.  - - - -
- -
- - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/maps/package-summary.html b/docs/html/reference/com/google/android/gms/maps/package-summary.html deleted file mode 100644 index 4dbe85b8fdf9..000000000000 --- a/docs/html/reference/com/google/android/gms/maps/package-summary.html +++ /dev/null @@ -1,1299 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.maps | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.maps

-
- -
- -
- - -
- Contains the Google Maps Android API classes. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GoogleMap.CancelableCallback - A callback interface for reporting when a task is complete or cancelled.  - - - -
GoogleMap.InfoWindowAdapter - Provides views for customized rendering of info windows.  - - - -
GoogleMap.OnCameraChangeListener - Defines signatures for methods that are called when the camera changes position.  - - - -
GoogleMap.OnIndoorStateChangeListener - A listener for when the indoor state changes.  - - - -
GoogleMap.OnInfoWindowClickListener - Callback interface for click/tap events on a marker's info window.  - - - -
GoogleMap.OnMapClickListener - Callback interface for when the user taps on the map.  - - - -
GoogleMap.OnMapLoadedCallback - Callback interface for when the map has finished rendering.  - - - -
GoogleMap.OnMapLongClickListener - Callback interface for when the user long presses on the map.  - - - -
GoogleMap.OnMarkerClickListener - Defines signatures for methods that are called when a marker is clicked or tapped.  - - - -
GoogleMap.OnMarkerDragListener - Callback interface for drag events on markers.  - - - -
GoogleMap.OnMyLocationButtonClickListener - Callback interface for when the My Location button is clicked.  - - - -
GoogleMap.OnMyLocationChangeListener - - This interface is deprecated. - use FusedLocationProviderApi instead. - FusedLocationProviderApi provides improved location finding and power usage and is used by - the "My Location" blue dot. See the MyLocationDemoActivity in the sample applications folder - for example example code, or the - - Location Developer Guide. -  - - - -
GoogleMap.SnapshotReadyCallback - Callback interface to notify when the snapshot has been taken.  - - - -
LocationSource - Defines an interface for providing location data, typically to a GoogleMap object.  - - - -
LocationSource.OnLocationChangedListener - Handles a location update.  - - - -
OnMapReadyCallback - Callback interface for when the map is ready to be used.  - - - -
OnStreetViewPanoramaReadyCallback - Callback interface for when the Street View panorama is ready to be used.  - - - -
StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener - A listener for when the StreetViewPanoramaCamera changes -  - - - -
StreetViewPanorama.OnStreetViewPanoramaChangeListener - A listener for when the Street View panorama loads a new panorama -  - - - -
StreetViewPanorama.OnStreetViewPanoramaClickListener - Callback interface for when the user taps on the panorama.  - - - -
StreetViewPanorama.OnStreetViewPanoramaLongClickListener - Callback interface for when the user long presses on the panorama.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CameraUpdate - Defines a camera move.  - - - -
CameraUpdateFactory - A class containing methods for creating CameraUpdate objects that change a map's camera.  - - - -
GoogleMap - This is the main class of the Google Maps Android API and is the entry point for all methods - related to the map.  - - - -
GoogleMapOptions - Defines configuration GoogleMapOptions for a GoogleMap.  - - - -
MapFragment - A Map component in an app.  - - - -
MapsInitializer - Use this class to initialize the Google Maps Android API if features need to be used before - obtaining a map.  - - - -
MapView - A View which displays a map (with data obtained from the Google Maps service).  - - - -
Projection - A projection is used to translate between on screen location and geographic coordinates on the - surface of the Earth (LatLng).  - - - -
StreetViewPanorama - This is the main class of the Street View feature in the Google Maps Android API and is the - entry point for all methods related to Street View panoramas.  - - - -
StreetViewPanoramaFragment - A StreetViewPanorama component in an app.  - - - -
StreetViewPanoramaOptions - Defines configuration PanoramaOptions for a StreetViewPanorama.  - - - -
StreetViewPanoramaView - A View which displays a Street View panorama (with data obtained from the Google Maps service).  - - - -
SupportMapFragment - A Map component in an app.  - - - -
SupportStreetViewPanoramaFragment - A StreetViewPanorama component in an app.  - - - -
UiSettings - Settings for the user interface of a GoogleMap.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/Nearby.html b/docs/html/reference/com/google/android/gms/nearby/Nearby.html deleted file mode 100644 index 011f4cc71540..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/Nearby.html +++ /dev/null @@ -1,1355 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Nearby | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Nearby

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.nearby.Nearby
- - - - - - - -
- - -

Class Overview

-

API for communication with nearby devices. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>CONNECTIONS_API - API needed to be passed into the GoogleApiClient.Builder to use the Nearby - Connections API. - - - -
- public - static - final - ConnectionsConnections - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - CONNECTIONS_API -

-
- - - - -
-
- - - - -

API needed to be passed into the GoogleApiClient.Builder to use the Nearby - Connections API. -

- - -
-
- - - - - -
-

- - public - static - final - Connections - - Connections -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/AppIdentifier.html b/docs/html/reference/com/google/android/gms/nearby/connection/AppIdentifier.html deleted file mode 100644 index 9a3b1f490430..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/AppIdentifier.html +++ /dev/null @@ -1,1693 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppIdentifier | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppIdentifier

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.nearby.connection.AppIdentifier
- - - - - - - -
- - -

Class Overview

-

An identifier for an application; the value of the identifier should be the package name for - an Android application to be installed or launched to discover and communicate with the - advertised service (e.g. com.example.myapp). Google applications may use this data to - prompt the user to install the application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AppIdentifierCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AppIdentifier(String identifier) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getIdentifier() - -
- Retrieves the identifier string for this application (e.g. - - - -
- -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AppIdentifierCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AppIdentifier - (String identifier) -

-
-
- - - -
-
- - - - -

-
-
Parameters
- - - - -
identifier - The Android package name of an Android application to be installed or - launched to discover and communicate with the advertised service - (e.g. com.example.myapp). -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getIdentifier - () -

-
-
- - - -
-
- - - - -

Retrieves the identifier string for this application (e.g. com.example.mygame).

-
-
Returns
-
  • The identifier string. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/AppMetadata.html b/docs/html/reference/com/google/android/gms/nearby/connection/AppMetadata.html deleted file mode 100644 index 01865d0277af..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/AppMetadata.html +++ /dev/null @@ -1,1681 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AppMetadata | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

AppMetadata

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.nearby.connection.AppMetadata
- - - - - - - -
- - -

Class Overview

-

Metadata about an application. Contains one or more - AppIdentifier objects indicating - identifiers that can be used to install or launch application(s) - that can discover and communicate with the advertised service. Google applications may use this - data to prompt the user to install the application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - AppMetadataCreatorCREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - AppMetadata(List<AppIdentifier> appIdentifiers) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - List<AppIdentifier> - - getAppIdentifiers() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - AppMetadataCreator - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - AppMetadata - (List<AppIdentifier> appIdentifiers) -

-
-
- - - -
-
- - - - -

-
-
Parameters
- - - - -
appIdentifiers - One or more identifiers for application(s) that can discover and - communicate with the advertised service. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - List<AppIdentifier> - - getAppIdentifiers - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionRequestListener.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionRequestListener.html deleted file mode 100644 index 3386f652a9a5..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionRequestListener.html +++ /dev/null @@ -1,1081 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections.ConnectionRequestListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Connections.ConnectionRequestListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections.ConnectionRequestListener
- - - - - - - -
- - -

Class Overview

-

Listener invoked when a remote endpoint requests a connection to a local endpoint. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onConnectionRequest(String remoteEndpointId, String remoteDeviceId, String remoteEndpointName, byte[] payload) - -
- Called when a remote endpoint requests a connection to a local endpoint. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onConnectionRequest - (String remoteEndpointId, String remoteDeviceId, String remoteEndpointName, byte[] payload) -

-
-
- - - -
-
- - - - -

Called when a remote endpoint requests a connection to a local endpoint.

-
-
Parameters
- - - - - - - - - - - - - -
remoteEndpointId - The ID of the remote endpoint requesting a connection.
remoteDeviceId - The ID of the remote device requesting a connection.
remoteEndpointName - The human readable name of the remote endpoint.
payload - Bytes of a custom message sent with the connection request. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionResponseCallback.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionResponseCallback.html deleted file mode 100644 index 016a1e0fbab3..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.ConnectionResponseCallback.html +++ /dev/null @@ -1,1082 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections.ConnectionResponseCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Connections.ConnectionResponseCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections.ConnectionResponseCallback
- - - - - - - -
- - -

Class Overview

-

Callback for responses to connection requests. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onConnectionResponse(String remoteEndpointId, Status status, byte[] payload) - -
- Called when a response is received for a connection request. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onConnectionResponse - (String remoteEndpointId, Status status, byte[] payload) -

-
-
- - - -
-
- - - - -

Called when a response is received for a connection request.

-
-
Parameters
- - - - - - - - - - -
remoteEndpointId - The identifier for the remote endpoint that sent the response.
status - The status of the response. Valid values are - STATUS_OK, - STATUS_CONNECTION_REJECTED, and - STATUS_NOT_CONNECTED_TO_ENDPOINT.
payload - Bytes of a custom message provided in the connection response - (on success). This array will not exceed MAX_RELIABLE_MESSAGE_LEN bytes - in length. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.EndpointDiscoveryListener.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.EndpointDiscoveryListener.html deleted file mode 100644 index b761e661a8e4..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.EndpointDiscoveryListener.html +++ /dev/null @@ -1,1150 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections.EndpointDiscoveryListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Connections.EndpointDiscoveryListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections.EndpointDiscoveryListener
- - - - - - - -
- - -

Class Overview

-

Listener invoked during endpoint discovery. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onEndpointFound(String endpointId, String deviceId, String serviceId, String name) - -
- Called when a remote endpoint is discovered. - - - -
- -
- abstract - - - - - void - - onEndpointLost(String endpointId) - -
- Called when a remote endpoint is no longer discoverable; only called for endpoints - that previously had been passed to - onEndpointFound(String, String, String, String). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onEndpointFound - (String endpointId, String deviceId, String serviceId, String name) -

-
-
- - - -
-
- - - - -

Called when a remote endpoint is discovered.

-
-
Parameters
- - - - - - - - - - - - - -
endpointId - The ID of the remote endpoint that was discovered.
deviceId - The ID of the remote device that was discovered.
serviceId - The ID of the service of the remote endpoint.
name - The human readable name of the remote endpoint. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onEndpointLost - (String endpointId) -

-
-
- - - -
-
- - - - -

Called when a remote endpoint is no longer discoverable; only called for endpoints - that previously had been passed to - onEndpointFound(String, String, String, String).

-
-
Parameters
- - - - -
endpointId - The ID of the remote endpoint that was lost. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.MessageListener.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.MessageListener.html deleted file mode 100644 index a946691060cd..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.MessageListener.html +++ /dev/null @@ -1,1144 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections.MessageListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Connections.MessageListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections.MessageListener
- - - - - - - -
- - -

Class Overview

-

Listener for messages from a remote endpoint. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDisconnected(String remoteEndpointId) - -
- Called when a remote endpoint is disconnected / becomes unreachable. - - - -
- -
- abstract - - - - - void - - onMessageReceived(String remoteEndpointId, byte[] payload, boolean isReliable) - -
- Called when a message is received from a remote endpoint. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDisconnected - (String remoteEndpointId) -

-
-
- - - -
-
- - - - -

Called when a remote endpoint is disconnected / becomes unreachable.

-
-
Parameters
- - - - -
remoteEndpointId - The identifier for the remote endpoint that disconnected. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onMessageReceived - (String remoteEndpointId, byte[] payload, boolean isReliable) -

-
-
- - - -
-
- - - - -

Called when a message is received from a remote endpoint.

-
-
Parameters
- - - - - - - - - - -
remoteEndpointId - The identifier for the remote endpoint that sent the message.
payload - The bytes of the message sent by the remote endpoint. This array will not - exceed MAX_RELIABLE_MESSAGE_LEN bytes for reliable messages, or - MAX_UNRELIABLE_MESSAGE_LEN for unreliable ones.
isReliable - True if the message was sent reliably, false otherwise. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.StartAdvertisingResult.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.StartAdvertisingResult.html deleted file mode 100644 index 05c9b936dc5d..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.StartAdvertisingResult.html +++ /dev/null @@ -1,1168 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections.StartAdvertisingResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Connections.StartAdvertisingResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections.StartAdvertisingResult
- - - - - - - -
- - -

Class Overview

-

Result delivered when a local endpoint starts being advertised. -

- Possible status codes include: -

-

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getLocalEndpointName() - -
- Retrieves the human readable name for the local endpoint being advertised - (possibly after resolving name collisions.) - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getLocalEndpointName - () -

-
-
- - - -
-
- - - - -

Retrieves the human readable name for the local endpoint being advertised - (possibly after resolving name collisions.)

-
-
Returns
-
  • The name of the local endpoint. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.html b/docs/html/reference/com/google/android/gms/nearby/connection/Connections.html deleted file mode 100644 index 4a3eb1f64b30..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/Connections.html +++ /dev/null @@ -1,2534 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Connections | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Connections

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.nearby.connection.Connections
- - - - - - - -
- - -

Class Overview

-

Entry point for advertising and discovering nearby apps and services, and communicating with them - over established connections. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceConnections.ConnectionRequestListener - Listener invoked when a remote endpoint requests a connection to a local endpoint.  - - - -
- - - - - interfaceConnections.ConnectionResponseCallback - Callback for responses to connection requests.  - - - -
- - - - - interfaceConnections.EndpointDiscoveryListener - Listener invoked during endpoint discovery.  - - - -
- - - - - interfaceConnections.MessageListener - Listener for messages from a remote endpoint.  - - - -
- - - - - interfaceConnections.StartAdvertisingResult - Result delivered when a local endpoint starts being advertised.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
longDURATION_INDEFINITE - Value for duration meaning advertising / discovery should continue indefinitely until - the application asks it to stop. - - - -
intMAX_RELIABLE_MESSAGE_LEN - This gives the maximum payload size supported via the - sendReliableMessage(GoogleApiClient, String, byte[]), sendConnectionRequest(GoogleApiClient, String, String, byte[], Connections.ConnectionResponseCallback, Connections.MessageListener), - and acceptConnectionRequest(GoogleApiClient, String, byte[], Connections.MessageListener) methods. - - - -
intMAX_UNRELIABLE_MESSAGE_LEN - This gives the maximum payload size supported via the - sendUnreliableMessage(GoogleApiClient, String, byte[]) methods. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - acceptConnectionRequest(GoogleApiClient apiClient, String remoteEndpointId, byte[] payload, Connections.MessageListener messageListener) - -
- Accepts a connection request from a remote endpoint. - - - -
- -
- abstract - - - - - void - - disconnectFromEndpoint(GoogleApiClient apiClient, String remoteEndpointId) - -
- Disconnects from a remote endpoint. - - - -
- -
- abstract - - - - - String - - getLocalDeviceId(GoogleApiClient apiClient) - -
- Returns the ID of the device, used when communicating with other devices. - - - -
- -
- abstract - - - - - String - - getLocalEndpointId(GoogleApiClient apiClient) - -
- Returns the ID of the local endpoint, used when communicating with other devices. - - - -
- -
- abstract - - - - - PendingResult<Status> - - rejectConnectionRequest(GoogleApiClient apiClient, String remoteEndpointId) - -
- Rejects a connection request from a remote endpoint. - - - -
- -
- abstract - - - - - PendingResult<Status> - - sendConnectionRequest(GoogleApiClient apiClient, String name, String remoteEndpointId, byte[] payload, Connections.ConnectionResponseCallback connectionResponseCallback, Connections.MessageListener messageListener) - -
- Sends a request to connect to a remote endpoint. - - - -
- -
- abstract - - - - - void - - sendReliableMessage(GoogleApiClient apiClient, List<String> remoteEndpointIds, byte[] payload) - -
- Sends a message to a list of remote endpoints using a reliable protocol. - - - -
- -
- abstract - - - - - void - - sendReliableMessage(GoogleApiClient apiClient, String remoteEndpointId, byte[] payload) - -
- Sends a message to a remote endpoint using a reliable protocol. - - - -
- -
- abstract - - - - - void - - sendUnreliableMessage(GoogleApiClient apiClient, String remoteEndpointId, byte[] payload) - -
- Sends a message to a remote endpoint using an unreliable protocol. - - - -
- -
- abstract - - - - - void - - sendUnreliableMessage(GoogleApiClient apiClient, List<String> remoteEndpointIds, byte[] payload) - -
- Sends a message to a list of remote endpoints using an unreliable protocol. - - - -
- -
- abstract - - - - - PendingResult<Connections.StartAdvertisingResult> - - startAdvertising(GoogleApiClient apiClient, String name, AppMetadata appMetadata, long durationMillis, Connections.ConnectionRequestListener connectionRequestListener) - -
- Starts advertising an endpoint for a local app. - - - -
- -
- abstract - - - - - PendingResult<Status> - - startDiscovery(GoogleApiClient apiClient, String serviceId, long durationMillis, Connections.EndpointDiscoveryListener listener) - -
- Starts discovery for remote endpoints with the specified service ID. - - - -
- -
- abstract - - - - - void - - stopAdvertising(GoogleApiClient apiClient) - -
- Stops advertising a local endpoint. - - - -
- -
- abstract - - - - - void - - stopAllEndpoints(GoogleApiClient apiClient) - -
- Stops advertising and discovery and disconnects from all endpoints. - - - -
- -
- abstract - - - - - void - - stopDiscovery(GoogleApiClient apiClient, String serviceId) - -
- Stops discovery for remote endpoints with the specified service ID. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - long - - DURATION_INDEFINITE -

-
- - - - -
-
- - - - -

Value for duration meaning advertising / discovery should continue indefinitely until - the application asks it to stop. -

- - -
- Constant Value: - - - 0 - (0x0000000000000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_RELIABLE_MESSAGE_LEN -

-
- - - - -
-
- - - - -

This gives the maximum payload size supported via the - sendReliableMessage(GoogleApiClient, String, byte[]), sendConnectionRequest(GoogleApiClient, String, String, byte[], Connections.ConnectionResponseCallback, Connections.MessageListener), - and acceptConnectionRequest(GoogleApiClient, String, byte[], Connections.MessageListener) methods. -

- - -
- Constant Value: - - - 4096 - (0x00001000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MAX_UNRELIABLE_MESSAGE_LEN -

-
- - - - -
-
- - - - -

This gives the maximum payload size supported via the - sendUnreliableMessage(GoogleApiClient, String, byte[]) methods. -

- - -
- Constant Value: - - - 1168 - (0x00000490) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - acceptConnectionRequest - (GoogleApiClient apiClient, String remoteEndpointId, byte[] payload, Connections.MessageListener messageListener) -

-
-
- - - -
-
- - - - -

Accepts a connection request from a remote endpoint. This method must be called before - messages can be received from the remote endpoint. -

- Possible result status codes include: -

-

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointId - The identifier for the remote endpoint that sent the connection - request. Should match the value provided in a call to - onConnectionRequest(String, String, String, byte[]).
payload - Bytes of a custom message to send with the connection response. This message - must not exceed MAX_RELIABLE_MESSAGE_LEN bytes in length.
messageListener - A listener notified when a message is received from the remote - endpoint, or it disconnects.
-
-
-
Returns
-
  • PendingResult to access the status of the - operation when available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - disconnectFromEndpoint - (GoogleApiClient apiClient, String remoteEndpointId) -

-
-
- - - -
-
- - - - -

Disconnects from a remote endpoint. Messages can no longer be sent to or received from the - endpoint after this method is called. -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointId - The identifier for the remote endpoint to disconnect from. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getLocalDeviceId - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns the ID of the device, used when communicating with other devices. - This identifier will be the same for all clients on this device, and will be stable across - reboots of the device.

-
-
Returns
-
  • The local device id. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getLocalEndpointId - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Returns the ID of the local endpoint, used when communicating with other devices. - This identifier will be different for each - GoogleApiClient.

-
-
Returns
-
  • The local endpoint id. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - rejectConnectionRequest - (GoogleApiClient apiClient, String remoteEndpointId) -

-
-
- - - -
-
- - - - -

Rejects a connection request from a remote endpoint. -

- Possible result status codes include: -

-

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointId - The identifier for the remote endpoint that sent the connection - request. Should match the value provided in a call to - onConnectionRequest(String, String, String, byte[]).
-
-
-
Returns
-
  • PendingResult to access the status of the - operation when available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - sendConnectionRequest - (GoogleApiClient apiClient, String name, String remoteEndpointId, byte[] payload, Connections.ConnectionResponseCallback connectionResponseCallback, Connections.MessageListener messageListener) -

-
-
- - - -
-
- - - - -

Sends a request to connect to a remote endpoint. -

- Possible result status codes include: -

-

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
name - A human readable name for the local endpoint, to appear on the remote endpoint. - If null or empty, a name will be generated based on the device name or model.
remoteEndpointId - The identifier for the remote endpoint to which a connection request - will be sent. Should match the value provided in a call to - onEndpointFound(String, String, String, String)
payload - Bytes of a custom message to send with the connection request. This message - must not exceed MAX_RELIABLE_MESSAGE_LEN bytes in length.
connectionResponseCallback - A callback notified when the remote endpoint sends a - response to the connection request.
messageListener - A listener notified when a message is received from the remote - endpoint, or it disconnects.
-
-
-
Returns
-
  • PendingResult to access the status of the - operation when available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - sendReliableMessage - (GoogleApiClient apiClient, List<String> remoteEndpointIds, byte[] payload) -

-
-
- - - -
-
- - - - -

Sends a message to a list of remote endpoints using a reliable protocol. Reliable messages - will be retried until delivered, and are delivered in the order they were sent to a given - endpoint. Messages can only be sent to remote endpoints once a connection request was first - sent and accepted (in either direction). - -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointIds - The identifiers for the remote endpoints to which the message should - be sent.
payload - The bytes of the message to send to the remote endpoint. This message - must not exceed MAX_RELIABLE_MESSAGE_LEN bytes in length. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - sendReliableMessage - (GoogleApiClient apiClient, String remoteEndpointId, byte[] payload) -

-
-
- - - -
-
- - - - -

Sends a message to a remote endpoint using a reliable protocol. Reliable messages will be - retried until delivered, and are delivered in the order they were sent to a given endpoint. - Messages can only be sent to remote endpoints once a connection request was first sent and - accepted (in either direction). -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointId - The identifier for the remote endpoint to which the message should - be sent.
payload - The bytes of the message to send to the remote endpoint. This message - must not exceed MAX_RELIABLE_MESSAGE_LEN bytes in length. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - sendUnreliableMessage - (GoogleApiClient apiClient, String remoteEndpointId, byte[] payload) -

-
-
- - - -
-
- - - - -

Sends a message to a remote endpoint using an unreliable protocol. Unreliable messages may - be dropped or delivered out of order. Messages can only be sent to remote endpoints once a - connection request was first sent and accepted (in either direction). -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointId - The identifier for the remote endpoint to which the message should - be sent.
payload - The bytes of the message to send to the remote endpoint. This message - must not exceed MAX_UNRELIABLE_MESSAGE_LEN bytes in length. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - sendUnreliableMessage - (GoogleApiClient apiClient, List<String> remoteEndpointIds, byte[] payload) -

-
-
- - - -
-
- - - - -

Sends a message to a list of remote endpoints using an unreliable protocol. Unreliable - messages may be dropped or delivered out of order. Messages can only be sent to remote - endpoints once a connection request was first sent and accepted (in either direction). -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
remoteEndpointIds - The identifiers for the remote endpoints to which the message should - be sent.
payload - The bytes of the message to send to the remote endpoint. This message - must not exceed MAX_UNRELIABLE_MESSAGE_LEN bytes in length. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Connections.StartAdvertisingResult> - - startAdvertising - (GoogleApiClient apiClient, String name, AppMetadata appMetadata, long durationMillis, Connections.ConnectionRequestListener connectionRequestListener) -

-
-
- - - -
-
- - - - -

Starts advertising an endpoint for a local app. -

- To advertise an endpoint you must specify a service ID in a meta-data tag with the name - com.google.android.gms.nearby.connection.SERVICE_ID inside your application tag, - like so: - - - - -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
name - A human readable name for this endpoint, to appear on other devices. If null or - empty, a name will be generated based on the device name or model.
appMetadata - Metadata used to describe this application which can be used to - prompt the user to launch or install the application. If null, only applications - looking for the specified service ID will be able to discover this endpoint.
durationMillis - The duration of the advertisement in milliseconds, unless - stopAdvertising(com.google.android.gms.common.api.GoogleApiClient) is - called first. If DURATION_INDEFINITE is passed in, the advertisement - will continue indefinitely until - stopAdvertising(com.google.android.gms.common.api.GoogleApiClient) is - called.
connectionRequestListener - A listener notified when remote endpoints request a - connection to this endpoint.
-
-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - startDiscovery - (GoogleApiClient apiClient, String serviceId, long durationMillis, Connections.EndpointDiscoveryListener listener) -

-
-
- - - -
-
- - - - -

Starts discovery for remote endpoints with the specified service ID. -

- Possible result status codes include: -

-

- - Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - - - - - - - -
apiClient - The GoogleApiClient to - service the call.
serviceId - The ID for the service to be discovered, as specified in its - manifest.
durationMillis - The duration of discovery in milliseconds, unless - stopDiscovery(com.google.android.gms.common.api.GoogleApiClient, String) - is called first. If DURATION_INDEFINITE is passed in, discovery - will continue indefinitely until - stopDiscovery(com.google.android.gms.common.api.GoogleApiClient, String) - is called.
listener - A listener notified when a remote endpoint is discovered.
-
-
-
Returns
-
  • PendingResult to access the status of the - operation when available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - stopAdvertising - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Stops advertising a local endpoint. Should be called after calling - startAdvertising(com.google.android.gms.common.api.GoogleApiClient, String, AppMetadata, long, ConnectionRequestListener), as soon as the application no - longer needs to advertise itself or goes inactive. Messages can still be sent to remote - endpoints after advertising ends. -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to - service the call. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - stopAllEndpoints - (GoogleApiClient apiClient) -

-
-
- - - -
-
- - - - -

Stops advertising and discovery and disconnects from all endpoints. -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - -
apiClient - The GoogleApiClient to - service the call. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - stopDiscovery - (GoogleApiClient apiClient, String serviceId) -

-
-
- - - -
-
- - - - -

Stops discovery for remote endpoints with the specified service ID. Should be called - after calling startDiscovery(com.google.android.gms.common.api.GoogleApiClient, String, long, EndpointDiscoveryListener), with the same service ID value, as soon as the - client no longer needs to discover endpoints or goes inactive. Messages can still be sent to - remote endpoints after discovery ends. -

- Required API: CONNECTIONS_API
- Required Scopes: None

-
-
Parameters
- - - - - - - -
apiClient - The GoogleApiClient to - service the call.
serviceId - The ID for the service to stop being discovered. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/ConnectionsStatusCodes.html b/docs/html/reference/com/google/android/gms/nearby/connection/ConnectionsStatusCodes.html deleted file mode 100644 index 928ca68b780e..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/ConnectionsStatusCodes.html +++ /dev/null @@ -1,2085 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ConnectionsStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ConnectionsStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.nearby.connection.ConnectionsStatusCodes
- - - - - - - -
- - -

Class Overview

-

Status codes for nearby connections results. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSTATUS_ALREADY_ADVERTISING - The app is already advertising; call stopAdvertising() before trying to advertise again. - - - -
intSTATUS_ALREADY_CONNECTED_TO_ENDPOINT - The app is already connected to the specified endpoint. - - - -
intSTATUS_ALREADY_DISCOVERING - The app is already discovering the specified application ID; call stopDiscovery() before - trying to advertise again. - - - -
intSTATUS_CONNECTION_REJECTED - The remote endpoint rejected the connection request. - - - -
intSTATUS_ERROR - The operation failed, without any more information. - - - -
intSTATUS_NETWORK_NOT_CONNECTED - The device is not connected to a network (over Wifi or Ethernet). - - - -
intSTATUS_NOT_CONNECTED_TO_ENDPOINT - The remote endpoint is not connected; messages cannot be sent to it. - - - -
intSTATUS_OK - The operation was successful. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- Returns an untranslated debug (not user-friendly!) string based on the current status code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - STATUS_ALREADY_ADVERTISING -

-
- - - - -
-
- - - - -

The app is already advertising; call stopAdvertising() before trying to advertise again. -

- - -
- Constant Value: - - - 8001 - (0x00001f41) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ALREADY_CONNECTED_TO_ENDPOINT -

-
- - - - -
-
- - - - -

The app is already connected to the specified endpoint. Multiple connections to a remote - endpoint cannot be maintained simultaneously. -

- - -
- Constant Value: - - - 8003 - (0x00001f43) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ALREADY_DISCOVERING -

-
- - - - -
-
- - - - -

The app is already discovering the specified application ID; call stopDiscovery() before - trying to advertise again. -

- - -
- Constant Value: - - - 8002 - (0x00001f42) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_CONNECTION_REJECTED -

-
- - - - -
-
- - - - -

The remote endpoint rejected the connection request. -

- - -
- Constant Value: - - - 8004 - (0x00001f44) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_ERROR -

-
- - - - -
-
- - - - -

The operation failed, without any more information. -

- - -
- Constant Value: - - - 13 - (0x0000000d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NETWORK_NOT_CONNECTED -

-
- - - - -
-
- - - - -

The device is not connected to a network (over Wifi or Ethernet). Prompt the user to - connect their device when this status code is returned. -

- - -
- Constant Value: - - - 8000 - (0x00001f40) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_NOT_CONNECTED_TO_ENDPOINT -

-
- - - - -
-
- - - - -

The remote endpoint is not connected; messages cannot be sent to it. -

- - -
- Constant Value: - - - 8005 - (0x00001f45) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STATUS_OK -

-
- - - - -
-
- - - - -

The operation was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

Returns an untranslated debug (not user-friendly!) string based on the current status code. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/connection/package-summary.html b/docs/html/reference/com/google/android/gms/nearby/connection/package-summary.html deleted file mode 100644 index 0b382e2ce9d9..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/connection/package-summary.html +++ /dev/null @@ -1,986 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.nearby.connection | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.nearby.connection

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Connections - Entry point for advertising and discovering nearby apps and services, and communicating with them - over established connections.  - - - -
Connections.ConnectionRequestListener - Listener invoked when a remote endpoint requests a connection to a local endpoint.  - - - -
Connections.ConnectionResponseCallback - Callback for responses to connection requests.  - - - -
Connections.EndpointDiscoveryListener - Listener invoked during endpoint discovery.  - - - -
Connections.MessageListener - Listener for messages from a remote endpoint.  - - - -
Connections.StartAdvertisingResult - Result delivered when a local endpoint starts being advertised.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
AppIdentifier - An identifier for an application; the value of the identifier should be the package name for - an Android application to be installed or launched to discover and communicate with the - advertised service (e.g.  - - - -
AppMetadata - Metadata about an application.  - - - -
ConnectionsStatusCodes - Status codes for nearby connections results.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/nearby/package-summary.html b/docs/html/reference/com/google/android/gms/nearby/package-summary.html deleted file mode 100644 index 9797d472a964..000000000000 --- a/docs/html/reference/com/google/android/gms/nearby/package-summary.html +++ /dev/null @@ -1,885 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.nearby | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.nearby

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - -
Nearby - API for communication with nearby devices.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/package-summary.html b/docs/html/reference/com/google/android/gms/package-summary.html deleted file mode 100644 index d9cf28e0045e..000000000000 --- a/docs/html/reference/com/google/android/gms/package-summary.html +++ /dev/null @@ -1,984 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms

-
- -
- -
- - - - - - - - - - - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
R -   - - - -
R.attr -   - - - -
R.color -   - - - -
R.drawable -   - - - -
R.id -   - - - -
R.integer -   - - - -
R.raw -   - - - -
R.string -   - - - -
R.style -   - - - -
R.styleable -   - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/panorama/Panorama.html b/docs/html/reference/com/google/android/gms/panorama/Panorama.html deleted file mode 100644 index b29ae793e090..000000000000 --- a/docs/html/reference/com/google/android/gms/panorama/Panorama.html +++ /dev/null @@ -1,1353 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Panorama | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Panorama

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.panorama.Panorama
- - - - - - - -
- - -

Class Overview

-

The main entry point for panorama integration. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Token to pass to addApi(Api) to enable the Panorama features. - - - -
- public - static - final - PanoramaApiPanoramaApi - The entry point for interacting with the Panorama API. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the Panorama features.

- - -
-
- - - - - -
-

- - public - static - final - PanoramaApi - - PanoramaApi -

-
- - - - -
-
- - - - -

The entry point for interacting with the Panorama API. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.PanoramaResult.html b/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.PanoramaResult.html deleted file mode 100644 index 57e855974cab..000000000000 --- a/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.PanoramaResult.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PanoramaApi.PanoramaResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

PanoramaApi.PanoramaResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.panorama.PanoramaApi.PanoramaResult
- - - - - - - -
- - -

Class Overview

-

Result interface for loading panorama info. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Intent - - getViewerIntent() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Intent - - getViewerIntent - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • If the image is a panorama this is not null and will launch a viewer when - started. If the image is not a panorama this will be null. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.html b/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.html deleted file mode 100644 index c61495befe1d..000000000000 --- a/docs/html/reference/com/google/android/gms/panorama/PanoramaApi.html +++ /dev/null @@ -1,1165 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PanoramaApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

PanoramaApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.panorama.PanoramaApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with Panorama viewer. This class provides methods for - obtaining an Intent to view a Panorama. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfacePanoramaApi.PanoramaResult - Result interface for loading panorama info.  - - - -
- - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<PanoramaApi.PanoramaResult> - - loadPanoramaInfo(GoogleApiClient client, Uri uri) - -
- Loads information about a panorama. - - - -
- -
- abstract - - - - - PendingResult<PanoramaApi.PanoramaResult> - - loadPanoramaInfoAndGrantAccess(GoogleApiClient client, Uri uri) - -
- Loads information about a panorama from a content provider. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<PanoramaApi.PanoramaResult> - - loadPanoramaInfo - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Loads information about a panorama.

-
-
Parameters
- - - - -
uri - the URI of the panorama to load info about. May be a file:, content:, - or android_resource: scheme. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<PanoramaApi.PanoramaResult> - - loadPanoramaInfoAndGrantAccess - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Loads information about a panorama from a content provider. This method will also explicitly - grant and revoke access to the URI while the load is happening so images in content providers - may be inspected without giving permission to an entire content provider. The returned viewer - intent will also have the FLAG_GRANT_READ_URI_PERMISSION set so the viewer has - access.

-
-
Parameters
- - - - -
uri - the URI of the panorama to load info about. May only be a content: scheme. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/panorama/package-summary.html b/docs/html/reference/com/google/android/gms/panorama/package-summary.html deleted file mode 100644 index 7316821d626a..000000000000 --- a/docs/html/reference/com/google/android/gms/panorama/package-summary.html +++ /dev/null @@ -1,917 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.panorama | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.panorama

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
PanoramaApi - The main entry point for interacting with Panorama viewer.  - - - -
PanoramaApi.PanoramaResult - Result interface for loading panorama info.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - -
Panorama - The main entry point for panorama integration.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Account.html b/docs/html/reference/com/google/android/gms/plus/Account.html deleted file mode 100644 index 8b31153d60d2..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Account.html +++ /dev/null @@ -1,1241 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Account | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Account

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.Account
- - - - - - - -
- - -

Class Overview

-

The main entry point for Google+ account management. To use these features, you should add the - API to your GoogleApiClient.Builder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - clearDefaultAccount(GoogleApiClient googleApiClient) - -
- - This method is deprecated. - replaced with - clearDefaultAccountAndReconnect() - - - - -
- -
- abstract - - - - - String - - getAccountName(GoogleApiClient googleApiClient) - -
- Gets the account name resolved by Google Play services. - - - -
- -
- abstract - - - - - PendingResult<Status> - - revokeAccessAndDisconnect(GoogleApiClient googleApiClient) - -
- Revokes access given to the current application. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - clearDefaultAccount - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- replaced with - clearDefaultAccountAndReconnect() - -

-

Removes the default account set in Google Play services for your app. - Subsequent calls to connect() will return a resolution intent - that will let the user select a different account. -

- If the user chooses the same account, no consent will be required since - access to the app is not revoked. Users should also be given the option - to revoke access with revokeAccessAndDisconnect(GoogleApiClient). -

- Required API: API

-
-
Parameters
- - - - -
googleApiClient - The connected GoogleApiClient to service the call.
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getAccountName - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Gets the account name resolved by Google Play services. The permission - <uses-permission android:name="android.permission.GET_ACCOUNTS" /> - must be declared in your AndroidManifest.xml to use this method. -

- Required API: API

-
-
Parameters
- - - - -
googleApiClient - The connected GoogleApiClient to service the call.
-
-
-
Returns
-
  • The account name. If the user has not selected an account, null is returned.
-
-
-
Throws
- - - - -
SecurityException - If your app doesn't have the - GET_ACCOUNTS permission. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - revokeAccessAndDisconnect - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Revokes access given to the current application. -

- Required API: API

-
-
Parameters
- - - - -
googleApiClient - The connected GoogleApiClient to service the call.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Moments.LoadMomentsResult.html b/docs/html/reference/com/google/android/gms/plus/Moments.LoadMomentsResult.html deleted file mode 100644 index 210e566778e3..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Moments.LoadMomentsResult.html +++ /dev/null @@ -1,1319 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Moments.LoadMomentsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Moments.LoadMomentsResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.Moments.LoadMomentsResult
- - - - - - - -
- - -

Class Overview

-

Information about the set of moments that was loaded.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - MomentBuffer - - getMomentBuffer() - -
- Returns the requested moments. - - - -
- -
- abstract - - - - - String - - getNextPageToken() - -
- Returns the continuation token, which is used to page through large result sets. - - - -
- -
- abstract - - - - - String - - getUpdated() - -
- Returns the time at which this collection of moments was last updated. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - MomentBuffer - - getMomentBuffer - () -

-
-
- - - -
-
- - - - -

Returns the requested moments. The listener must close this object when finished. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getNextPageToken - () -

-
-
- - - -
-
- - - - -

Returns the continuation token, which is used to page through large result sets. Provide - this value in a subsequent request to return the next page of results. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getUpdated - () -

-
-
- - - -
-
- - - - -

Returns the time at which this collection of moments was last updated. Formatted as an - RFC 3339 timestamp. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Moments.html b/docs/html/reference/com/google/android/gms/plus/Moments.html deleted file mode 100644 index c26d0888d655..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Moments.html +++ /dev/null @@ -1,1364 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Moments | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Moments

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.Moments
- - - - - - - -
- - -

Class Overview

-

Methods and interfaces related to moments in Google+. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceMoments.LoadMomentsResult - Information about the set of moments that was loaded.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Moments.LoadMomentsResult> - - load(GoogleApiClient googleApiClient, int maxResults, String pageToken, Uri targetUrl, String type, String userId) - -
- Lists all of the moments for a particular user. - - - -
- -
- abstract - - - - - PendingResult<Moments.LoadMomentsResult> - - load(GoogleApiClient googleApiClient) - -
- Lists all of the moments for the currently signed-in user. - - - -
- -
- abstract - - - - - PendingResult<Status> - - remove(GoogleApiClient googleApiClient, String momentId) - -
- Deletes a moment. - - - -
- -
- abstract - - - - - PendingResult<Status> - - write(GoogleApiClient googleApiClient, Moment moment) - -
- Writes a moment. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Moments.LoadMomentsResult> - - load - (GoogleApiClient googleApiClient, int maxResults, String pageToken, Uri targetUrl, String type, String userId) -

-
-
- - - -
-
- - - - -

Lists all of the moments for a particular user. For more information, see - - https://developers.google.com/+/api/latest/moments/list. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - - - - - - - - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
maxResults - The maximum number of moments to include in the response, which is used - for paging. For any response, the actual number returned might be less than the - specified maxResults.
pageToken - The continuation token, which is used to page through large result sets. - To get the next page of results, set this parameter to the value of - nextPageToken from the previous response.
targetUrl - Only moments containing this targetUrl will be returned.
type - Only moments of this type will be returned.
userId - The ID of the user to get moments for. The special value "me" can be used to - indicate the authenticated user.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Moments.LoadMomentsResult> - - load - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Lists all of the moments for the currently signed-in user. For more information, see - - https://developers.google.com/+/api/latest/moments/list. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - remove - (GoogleApiClient googleApiClient, String momentId) -

-
-
- - - -
-
- - - - -

Deletes a moment. For more information, see - - https://developers.google.com/+/api/latest/moments/remove. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - -
googleApiClient - The connected GoogleApiClient to service the call.
momentId - The ID of the moment to delete.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - write - (GoogleApiClient googleApiClient, Moment moment) -

-
-
- - - -
-
- - - - -

Writes a moment. For more information, see - - https://developers.google.com/+/api/latest/moments/insert. -

- This is a fire-and-forget method that writes the user's moment asynchronously, but reports - back immediately. If there is a network error, Google Play services attempts to send the - request again when the device comes back online. Requests can fail if there are problems with - the account or format of specified in moment. To debug, run adb logcat in a - terminal and find errors related to moments in the output. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - -
googleApiClient - The connected GoogleApiClient to service the call.
moment - The moment description.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/People.LoadPeopleResult.html b/docs/html/reference/com/google/android/gms/plus/People.LoadPeopleResult.html deleted file mode 100644 index db1f51e8d5d7..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/People.LoadPeopleResult.html +++ /dev/null @@ -1,1262 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -People.LoadPeopleResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

People.LoadPeopleResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.People.LoadPeopleResult
- - - - - - - -
- - -

Class Overview

-

Information about the set of people that was loaded.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getNextPageToken() - -
- Returns the continuation token, which is used to page through large result sets. - - - -
- -
- abstract - - - - - PersonBuffer - - getPersonBuffer() - -
- Returns the requested people. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getNextPageToken - () -

-
-
- - - -
-
- - - - -

Returns the continuation token, which is used to page through large result sets. Provide - this value in a subsequent request to return the next page of results. -

- -
-
- - - - -
-

- - public - - - abstract - - PersonBuffer - - getPersonBuffer - () -

-
-
- - - -
-
- - - - -

Returns the requested people. The listener must close this object when finished. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/People.OrderBy.html b/docs/html/reference/com/google/android/gms/plus/People.OrderBy.html deleted file mode 100644 index d64a9d6ae14c..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/People.OrderBy.html +++ /dev/null @@ -1,1121 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -People.OrderBy | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

People.OrderBy

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.People.OrderBy
- - - - - - - -
- - -

Class Overview

-

Constants to declare the order to return people in. -

- These constants are used with the loadVisible(GoogleApiClient, int, String) method. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intALPHABETICAL - Constant used to load people ordered by their display name. - - - -
intBEST - Constant used to load people ordered based on their relevance to the viewer. - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ALPHABETICAL -

-
- - - - -
-
- - - - -

Constant used to load people ordered by their display name. -

- This constant is used with the loadVisible(GoogleApiClient, int, String) - method. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BEST -

-
- - - - -
-
- - - - -

Constant used to load people ordered based on their relevance to the viewer. -

- This constant is used with the loadVisible(GoogleApiClient, int, String) method. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/People.html b/docs/html/reference/com/google/android/gms/plus/People.html deleted file mode 100644 index 251ed0bcdf3e..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/People.html +++ /dev/null @@ -1,1534 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -People | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

People

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.People
- - - - - - - -
- - -

Class Overview

-

Methods and interfaces related to people in Google+. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfacePeople.LoadPeopleResult - Information about the set of people that was loaded.  - - - -
- - - - - interfacePeople.OrderBy - Constants to declare the order to return people in.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Person - - getCurrentPerson(GoogleApiClient googleApiClient) - -
- Returns profile information for the current user. - - - -
- -
- abstract - - - - - PendingResult<People.LoadPeopleResult> - - load(GoogleApiClient googleApiClient, String... personIds) - -
- Loads a list of specified people. - - - -
- -
- abstract - - - - - PendingResult<People.LoadPeopleResult> - - load(GoogleApiClient googleApiClient, Collection<String> personIds) - -
- Loads a list of specified people. - - - -
- -
- abstract - - - - - PendingResult<People.LoadPeopleResult> - - loadConnected(GoogleApiClient googleApiClient) - -
- Loads a list of visible people in the authenticated user’s circles that are signed into the - same app with Google+. - - - -
- -
- abstract - - - - - PendingResult<People.LoadPeopleResult> - - loadVisible(GoogleApiClient googleApiClient, String pageToken) - -
- Loads the list of visible people in the user's circles. - - - -
- -
- abstract - - - - - PendingResult<People.LoadPeopleResult> - - loadVisible(GoogleApiClient googleApiClient, int orderBy, String pageToken) - -
- Loads the list of visible people in the user's circles. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Person - - getCurrentPerson - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Returns profile information for the current user. For more information, see: - - https://developers.google.com/+/api/latest/people/get. -

- This method can return null if the required scopes weren't specified in the - GoogleApiClient.Builder, or if there was a network error while - connecting. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN or SCOPE_PLUS_PROFILE

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call.
-
-
-
Returns
-
  • Profile information for the current user, if available, or null otherwise. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<People.LoadPeopleResult> - - load - (GoogleApiClient googleApiClient, String... personIds) -

-
-
- - - -
-
- - - - -

Loads a list of specified people. -

- This call returns all information in Person, but only for the people - specified and for data that is public in their profiles. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
personIds - The ids of people to load. This should match the user id that would be - sent to - https://developers.google.com/+/api/latest/people/get
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<People.LoadPeopleResult> - - load - (GoogleApiClient googleApiClient, Collection<String> personIds) -

-
-
- - - -
-
- - - - -

Loads a list of specified people. -

- This call returns all information in Person, but only for the people - specified and for data that is public in their profiles. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
personIds - The IDs of people to load. This should match the user id that would be - sent to - https://developers.google.com/+/api/latest/people/get
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<People.LoadPeopleResult> - - loadConnected - (GoogleApiClient googleApiClient) -

-
-
- - - -
-
- - - - -

Loads a list of visible people in the authenticated user’s circles that are signed into the - same app with Google+. For more information, see: - - https://developers.google.com/+/api/latest/people/list. -

- Each Person will contain the id, displayName, - image, objectType, and url fields populated. - To retrieve additional profile data, use the load(GoogleApiClient, String...) method. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - -
googleApiClient - The GoogleApiClient to service the call. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<People.LoadPeopleResult> - - loadVisible - (GoogleApiClient googleApiClient, String pageToken) -

-
-
- - - -
-
- - - - -

Loads the list of visible people in the user's circles. For more information, see: - - https://developers.google.com/+/api/latest/people/list. -

- Each Person will contain the id, displayName, - image, objectType, and url fields populated. - To retrieve additional profile data, use the load(GoogleApiClient, String...) method. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
pageToken - Result of getNextPageToken() to get the next page of - data. Pass in null to get the first page.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<People.LoadPeopleResult> - - loadVisible - (GoogleApiClient googleApiClient, int orderBy, String pageToken) -

-
-
- - - -
-
- - - - -

Loads the list of visible people in the user's circles. For more information, see: - - https://developers.google.com/+/api/latest/people/list. -

- Each Person will contain the id, displayName, - image, objectType, and url fields populated. - To retrieve additional profile data, use the load(GoogleApiClient, String...) method. -

- Required API: API
- Required Scopes: SCOPE_PLUS_LOGIN

-
-
Parameters
- - - - - - - - - - -
googleApiClient - The GoogleApiClient to service the call.
orderBy - The order to return people in. Valid values are:

- ALPHABETICAL - Order the people by their display name. - BEST - Order people based on the relevance to the viewer.

pageToken - Result of getNextPageToken() to get the next page of - data. Pass in null to get the first page.
-
-
-
Returns
-
  • the PendingResult for notification and access to the result when it's available. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.Builder.html b/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.Builder.html deleted file mode 100644 index 16eee8254056..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.Builder.html +++ /dev/null @@ -1,1498 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plus.PlusOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Plus.PlusOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.Plus.PlusOptions.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Plus.PlusOptions.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Plus.PlusOptions.Builder - - addActivityTypes(String... activityTypes) - -
- Specify which user's app activity types can be written to Google+. - - - -
- -
- - - - - - Plus.PlusOptions - - build() - -
- - - - - - Plus.PlusOptions.Builder - - setServerClientId(String clientId) - -
- Specify the optional 3rd party server client ID for offline auth. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Plus.PlusOptions.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Plus.PlusOptions.Builder - - addActivityTypes - (String... activityTypes) -

-
-
- - - -
-
- - - - -

Specify which user's app activity types can be written to Google+. This must be used - with the SCOPE_PLUS_LOGIN OAuth 2.0 scope. -

- See Types of app - activity for the full list of valid app activity types. Example usage: - - 

- googleApiClientBuilder.addPlusActivityType(
-         "http://schemas.google.com/AddActivity",
-         "http://schemas.google.com/BuyActivity");
-

-
-
Parameters
- - - - -
activityTypes - The user's app activity types that can be written to Google. -
-
- -
-
- - - - -
-

- - public - - - - - Plus.PlusOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Plus.PlusOptions.Builder - - setServerClientId - (String clientId) -

-
-
- - - -
-
- - - - -

Specify the optional 3rd party server client ID for offline auth. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.html b/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.html deleted file mode 100644 index 17bb650ec132..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Plus.PlusOptions.html +++ /dev/null @@ -1,1365 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plus.PlusOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Plus.PlusOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.Optional - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.Plus.PlusOptions
- - - - - - - -
- - -

Class Overview

-

API configuration parameters for Google+. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlus.PlusOptions.Builder -   - - - -
- - - - - - - - - - -
Public Methods
- - - - static - - Plus.PlusOptions.Builder - - builder() - -
- - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Plus.PlusOptions.Builder - - builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/Plus.html b/docs/html/reference/com/google/android/gms/plus/Plus.html deleted file mode 100644 index cc98e01374f9..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/Plus.html +++ /dev/null @@ -1,1584 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plus | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Plus

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.Plus
- - - - - - - -
- - -

Class Overview

-

The main entry point for Google+ integration. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlus.PlusOptions - API configuration parameters for Google+.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Plus.PlusOptions>API - Token to pass to addApi(Api) to enable the Google+ features. - - - -
- public - static - final - AccountAccountApi - Provides access to account management API methods. - - - -
- public - static - final - MomentsMomentsApi - Methods and interfaces related to moments in Google+. - - - -
- public - static - final - PeoplePeopleApi - Methods and interfaces related to people in Google+. - - - -
- public - static - final - ScopeSCOPE_PLUS_LOGIN - OAuth 2.0 scope for accessing the user's name, basic profile info, list of people in the - user's circles, and writing app activities to Google. - - - -
- public - static - final - ScopeSCOPE_PLUS_PROFILE - OAuth 2.0 scope for accessing the user's Google+ profile data. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Plus.PlusOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the Google+ features. -

- To configure additional Google+ options, provide a Plus.PlusOptions object to - addApi(Api). -

- - -
-
- - - - - -
-

- - public - static - final - Account - - AccountApi -

-
- - - - -
-
- - - - -

Provides access to account management API methods.

- - -
-
- - - - - -
-

- - public - static - final - Moments - - MomentsApi -

-
- - - - -
-
- - - - -

Methods and interfaces related to moments in Google+.

- - -
-
- - - - - -
-

- - public - static - final - People - - PeopleApi -

-
- - - - -
-
- - - - -

Methods and interfaces related to people in Google+.

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_PLUS_LOGIN -

-
- - - - -
-
- - - - -

OAuth 2.0 scope for accessing the user's name, basic profile info, list of people in the - user's circles, and writing app activities to Google. - -

When using this scope, your app will have access to:

-
    -
  • the user's full name, profile picture, Google+ profile ID, age range, and language
    • -
  • people the user has circled, represented as a list of public profiles
    • -
  • any other publicly available information on the user's Google+ profile
    • -
  • write app activities (moments) to Google.
    • -
-

- - -
-
- - - - - -
-

- - public - static - final - Scope - - SCOPE_PLUS_PROFILE -

-
- - - - -
-
- - - - -

OAuth 2.0 scope for accessing the user's Google+ profile data. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.DefaultOnPlusOneClickListener.html b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.DefaultOnPlusOneClickListener.html deleted file mode 100644 index 8ba835257121..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.DefaultOnPlusOneClickListener.html +++ /dev/null @@ -1,1556 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusOneButton.DefaultOnPlusOneClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- protected - - - - class -

PlusOneButton.DefaultOnPlusOneClickListener

- - - - - extends Object
- - - - - - - implements - - PlusOneButton.OnPlusOneClickListener - - View.OnClickListener - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.PlusOneButton.DefaultOnPlusOneClickListener
- - - - - - - -
- - -

Class Overview

-

This is an View.OnClickListener that will proxy clicks to an - attached PlusOneButton.OnPlusOneClickListener, or default to attempt to start - the intent using an Activity context. - - Important: The implementation of onClick(android.view.View) - used by DefaultOnPlusOneClickListener relies on the tag of this class' - PlusOneButtonView remaining unused. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlusOneButton.DefaultOnPlusOneClickListener(PlusOneButton.OnPlusOneClickListener proxy) - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onClick(View view) - -
- - - - - - void - - onPlusOneClick(Intent intent) - -
- Called when the +1 button is clicked. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.plus.PlusOneButton.OnPlusOneClickListener - -
- - -
-
- -From interface - - android.view.View.OnClickListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlusOneButton.DefaultOnPlusOneClickListener - (PlusOneButton.OnPlusOneClickListener proxy) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onClick - (View view) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPlusOneClick - (Intent intent) -

-
-
- - - -
-
- - - - -

Called when the +1 button is clicked. Start the intent passed to this method - to display the +1 confirmation dialog Activity with - startActivityForResult(Intent, int).

-
-
Parameters
- - - - -
intent - The intent to display the +1 confirmation dialog. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html deleted file mode 100644 index 28ff721a9443..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html +++ /dev/null @@ -1,1134 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusOneButton.OnPlusOneClickListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

PlusOneButton.OnPlusOneClickListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.PlusOneButton.OnPlusOneClickListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

A listener for +1 button clicks. Implement this interface and call - startActivityForResult(Intent, int). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onPlusOneClick(Intent intent) - -
- Called when the +1 button is clicked. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onPlusOneClick - (Intent intent) -

-
-
- - - -
-
- - - - -

Called when the +1 button is clicked. Start the intent passed to this method - to display the +1 confirmation dialog Activity with - startActivityForResult(Intent, int).

-
-
Parameters
- - - - -
intent - The intent to display the +1 confirmation dialog. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.html b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.html deleted file mode 100644 index 73b64415bec6..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusOneButton.html +++ /dev/null @@ -1,16196 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusOneButton | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - | Protected Methods - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlusOneButton

- - - - - - - - - - - - - - - - - extends FrameLayout
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳android.widget.FrameLayout
      ↳com.google.android.gms.plus.PlusOneButton
- - - - - - - -
- - -

Class Overview

-

The +1 button to recommend a URL on Google+. The button fetches +1 data from - Google Play services. The +1 attributes can be set via XML, provided the - PlusOneButton element has - xmlns:plus="http://schemas.android.com/apk/lib/com.google.android.gms.plus" set. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlusOneButton.DefaultOnPlusOneClickListener - This is an View.OnClickListener that will proxy clicks to an - attached PlusOneButton.OnPlusOneClickListener, or default to attempt to start - the intent using an Activity context.  - - - -
- - - - - interfacePlusOneButton.OnPlusOneClickListener - A listener for +1 button clicks.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intANNOTATION_BUBBLE - Display the number of users who have +1'd the URL in a graphic next to the button (default). - - - -
intANNOTATION_INLINE - Display profile pictures of connected users who have +1'd the URL and a count of users who - have +1'd the URL. - - - -
intANNOTATION_NONE - Do not render any additional annotations. - - - -
intDEFAULT_ACTIVITY_REQUEST_CODE - An empty ActivityRequestCode to serve as the default before the code has been assigned. - - - -
intSIZE_MEDIUM - The medium button size. - - - -
intSIZE_SMALL - The small button size. - - - -
intSIZE_STANDARD - The standard button size. - - - -
intSIZE_TALL - The tall button size. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlusOneButton(Context context) - -
- Creates a +1 button of SIZE_STANDARD size with an - ANNOTATION_BUBBLE annotation. - - - -
- -
- - - - - - - - PlusOneButton(Context context, AttributeSet attrs) - -
- Creates a +1 button of SIZE_STANDARD size with an - ANNOTATION_BUBBLE annotation. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - initialize(String url, PlusOneButton.OnPlusOneClickListener plusOneClickListener) - -
- Updates the +1 button with a client and URL. - - - -
- -
- - - - - - void - - initialize(String url, int activityRequestCode) - -
- Updates the +1 button with a URL. - - - -
- -
- - - - - - void - - setAnnotation(int annotation) - -
- Sets the annotation to display next to the +1 button. - - - -
- -
- - - - - - void - - setOnPlusOneClickListener(PlusOneButton.OnPlusOneClickListener listener) - -
- Sets the PlusOneButton.OnPlusOneClickListener to handle clicks. - - - -
- -
- - - - - - void - - setSize(int size) - -
- Sets the size of the +1 button. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Protected Methods
- - - - static - - int - - getAnnotation(Context context, AttributeSet attrs) - -
- - - - static - - int - - getSize(Context context, AttributeSet attrs) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.FrameLayout - -
- - -
-
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ANNOTATION_BUBBLE -

-
- - - - -
-
- - - - -

Display the number of users who have +1'd the URL in a graphic next to the button (default). -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ANNOTATION_INLINE -

-
- - - - -
-
- - - - -

Display profile pictures of connected users who have +1'd the URL and a count of users who - have +1'd the URL. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ANNOTATION_NONE -

-
- - - - -
-
- - - - -

Do not render any additional annotations. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DEFAULT_ACTIVITY_REQUEST_CODE -

-
- - - - -
-
- - - - -

An empty ActivityRequestCode to serve as the default before the code has been assigned. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_MEDIUM -

-
- - - - -
-
- - - - -

The medium button size. See Button sizes for - more information. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_SMALL -

-
- - - - -
-
- - - - -

The small button size. See Button sizes for - more information. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_STANDARD -

-
- - - - -
-
- - - - -

The standard button size. See Button sizes for - more information. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SIZE_TALL -

-
- - - - -
-
- - - - -

The tall button size. See Button sizes for - more information. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlusOneButton - (Context context) -

-
-
- - - -
-
- - - - -

Creates a +1 button of SIZE_STANDARD size with an - ANNOTATION_BUBBLE annotation.

-
-
Parameters
- - - - -
context - The context to use, usually your Activity. -
-
- -
-
- - - - -
-

- - public - - - - - - - PlusOneButton - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

Creates a +1 button of SIZE_STANDARD size with an - ANNOTATION_BUBBLE annotation.

-
-
Parameters
- - - - - - - -
context - The context to use, usually your Activity.
attrs - The attributes of the XML tag that is inflating the view. -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - initialize - (String url, PlusOneButton.OnPlusOneClickListener plusOneClickListener) -

-
-
- - - -
-
- - - - -

Updates the +1 button with a client and URL. Most apps call this method each time - the button is in focus (for example, in the Activity onResume method).

-
-
Parameters
- - - - - - - -
url - The URL to be +1'd.
plusOneClickListener - A listener for +1 clicks. -
-
- -
-
- - - - -
-

- - public - - - - - void - - initialize - (String url, int activityRequestCode) -

-
-
- - - -
-
- - - - -

Updates the +1 button with a URL. Most apps call this method each time the button is in - focus (for example, in the Activity onResume method). To use this method, the PlusOneButton - must be placed in an Activity. Use initialize(String, OnPlusOneClickListener) - otherwise.

-
-
Parameters
- - - - - - - -
url - The URL to be +1'd.
activityRequestCode - The request code to use when opening the +1 Activity. - This value must be an unsigned 16 bit integer. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setAnnotation - (int annotation) -

-
-
- - - -
-
- - - - -

Sets the annotation to display next to the +1 button. This can also be set - using the attribute plus:annotation="none|bubble|inline".

-
-
Parameters
- - - - -
annotation - The annotation. See ANNOTATION_NONE, - ANNOTATION_BUBBLE, and - ANNOTATION_INLINE. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setOnPlusOneClickListener - (PlusOneButton.OnPlusOneClickListener listener) -

-
-
- - - -
-
- - - - -

Sets the PlusOneButton.OnPlusOneClickListener to handle clicks. Call this if - you want to customize launching the +1 confirmation Activity from a - +1 button click.

-
-
Parameters
- - - - -
listener - The listener, or null for default behavior. -
-
- -
-
- - - - -
-

- - public - - - - - void - - setSize - (int size) -

-
-
- - - -
-
- - - - -

Sets the size of the +1 button. This can also be set using the - attribute plus:size="small|medium|tall|standard".

-
-
Parameters
- - - - -
size - The size. See SIZE_SMALL, SIZE_MEDIUM, - SIZE_TALL, and SIZE_STANDARD. -
-
- -
-
- - - - - - - -

Protected Methods

- - - - - -
-

- - protected - static - - - - int - - getAnnotation - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - protected - static - - - - int - - getSize - (Context context, AttributeSet attrs) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusOneDummyView.html b/docs/html/reference/com/google/android/gms/plus/PlusOneDummyView.html deleted file mode 100644 index 9d569d66b8d7..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusOneDummyView.html +++ /dev/null @@ -1,15192 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusOneDummyView | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PlusOneDummyView

- - - - - - - - - - - - - - - - - extends FrameLayout
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳android.widget.FrameLayout
      ↳com.google.android.gms.plus.PlusOneDummyView
- - - - - - - -
- - -

Class Overview

-

A class used to statically generate dummy views in the event of an error retrieving - a PlusOneButton from the apk -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringTAG - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.view.ViewGroup -
- - -
-
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.view.View -
- - -
-
- - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlusOneDummyView(Context context, int size) - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.widget.FrameLayout - -
- - -
-
- -From class - - android.view.ViewGroup - -
- - -
-
- -From class - - android.view.View - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.ViewParent - -
- - -
-
- -From interface - - android.view.ViewManager - -
- - -
-
- -From interface - - android.graphics.drawable.Drawable.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.accessibility.AccessibilityEventSource - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - TAG -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - "PlusOneDummyView" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlusOneDummyView - (Context context, int size) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html b/docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html deleted file mode 100644 index 3e5f2eb89793..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html +++ /dev/null @@ -1,2143 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusShare.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

PlusShare.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.PlusShare.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PlusShare.Builder(Context context) - -
- Create a new Builder for launching a sharing action from the given context. - - - -
- -
- - - - - - - - PlusShare.Builder(Activity launchingActivity) - -
- Create a new Builder for launching a sharing action from launchingActivity. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PlusShare.Builder - - addCallToAction(String label, Uri uri, String deepLinkId) - -
- Adds a call-to-action button for an interactive post. - - - -
- -
- - - - - - PlusShare.Builder - - addStream(Uri streamUri) - -
- Add a stream URI to the data that should be shared. - - - -
- -
- - - - - - Intent - - getIntent() - -
- Retrieve the Intent as configured so far by the Builder. - - - -
- -
- - - - - - PlusShare.Builder - - setContentDeepLinkId(String deepLinkId, String title, String description, Uri thumbnailUri) - -
- Include a deep-link ID to a resource to share on Google+. - - - -
- -
- - - - - - PlusShare.Builder - - setContentDeepLinkId(String deepLinkId) - -
- Include a deep-link URI of a resource to share on Google+. - - - -
- -
- - - - - - PlusShare.Builder - - setContentUrl(Uri uri) - -
- Sets a URL to link to from the content on the web. - - - -
- -
- - - - - - PlusShare.Builder - - setRecipients(Person user, List<Person> recipientList) - -
- Sets a list of people to send the interactive post to. - - - -
- -
- - - - - - PlusShare.Builder - - setStream(Uri streamUri) - -
- Set a stream URI to the data that should be shared. - - - -
- -
- - - - - - PlusShare.Builder - - setText(CharSequence text) - -
- Set a pre-filled message to be sent as part of the share. - - - -
- -
- - - - - - PlusShare.Builder - - setType(String mimeType) - -
- Set the type of data being shared. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PlusShare.Builder - (Context context) -

-
-
- - - -
-
- - - - -

Create a new Builder for launching a sharing action from the given context.

-
-
Parameters
- - - - -
context - Context that the share will be launched from -
-
- -
-
- - - - -
-

- - public - - - - - - - PlusShare.Builder - (Activity launchingActivity) -

-
-
- - - -
-
- - - - -

Create a new Builder for launching a sharing action from launchingActivity.

-
-
Parameters
- - - - -
launchingActivity - Activity that the share will be launched from -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PlusShare.Builder - - addCallToAction - (String label, Uri uri, String deepLinkId) -

-
-
- - - -
-
- - - - -

Adds a call-to-action button for an interactive post. To use this method, you must have - passed a signed-in PlusClient to the - Builder.Builder(Activity, PlusClient) constructor or an - IllegalStateException will be thrown.

-
-
Parameters
- - - - - - - - - - -
label - The call-to-action label. Choose a value from the list of - - list
uri - The URL to link to when the user clicks the call-to-action. This parameter - is required.
deepLinkId - A deep-link ID to send to mobile clients when the user - clicks the call-to-action. This parameter is optional. -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - addStream - (Uri streamUri) -

-
-
- - - -
-
- - - - -

Add a stream URI to the data that should be shared. If this is not the first - stream URI added the final intent constructed will become an ACTION_SEND_MULTIPLE - intent. Not all apps will handle both ACTION_SEND and ACTION_SEND_MULTIPLE.

-
-
Parameters
- - - - -
streamUri - URI of the stream to share.
-
-
-
Returns
-
  • This Builder for method chaining.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - Intent - - getIntent - () -

-
-
- - - -
-
- - - - -

Retrieve the Intent as configured so far by the Builder.

-
-
Returns
-
  • The current Intent being configured by this builder -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setContentDeepLinkId - (String deepLinkId, String title, String description, Uri thumbnailUri) -

-
-
- - - -
-
- - - - -

Include a deep-link ID to a resource to share on Google+.

-
-
Parameters
- - - - - - - - - - - - - -
deepLinkId - The deep-link ID to a resource to share on Google+. - This parameter is required.
title - The title of the resource. Used if there is no content URL to display. - This parameter is optional.
description - The description of a resource. Used if there is no content URL to - display. This parameter is optional.
thumbnailUri - The thumbnailUri for a resource. Used if there is no content URL to - display. This parameter is optional.
-
-
-
Returns
-
  • This Builder for method chaining. -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setContentDeepLinkId - (String deepLinkId) -

-
-
- - - -
-
- - - - -

Include a deep-link URI of a resource to share on Google+.

-
-
Parameters
- - - - -
deepLinkId - The deep-link ID to a resource to share on Google+. - This parameter is required.
-
-
-
Returns
-
  • This Builder for method chaining. -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setContentUrl - (Uri uri) -

-
-
- - - -
-
- - - - -

Sets a URL to link to from the content on the web. The content URL is required when - used in conjunction with addCallToAction(String, Uri, String) to build an - interactive post, and to provide the user context for the call-to-action button.

-
-
Parameters
- - - - -
uri - the URL to link to on the web.
-
-
-
Returns
-
  • This Builder for method chaining. -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setRecipients - (Person user, List<Person> recipientList) -

-
-
- - - -
-
- - - - -

Sets a list of people to send the interactive post to. - -

This sets the initial people to share with, but the user can change who the post - is shared with before posting. A maximum of ten recipients are allowed.

-
-
Parameters
- - - - - - - -
user - The user to send the post as, see - getCurrentPerson(com.google.android.gms.common.api.GoogleApiClient).
recipientList - A list of recipients. See load(GoogleApiClient, String...) and - createPerson(String, String).
-
-
-
Returns
-
  • This Builder for method chaining. -
-
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setStream - (Uri streamUri) -

-
-
- - - -
-
- - - - -

Set a stream URI to the data that should be shared. - -

This replaces all currently set stream URIs and will produce a single-stream - ACTION_SEND intent.

-
-
Parameters
- - - - -
streamUri - URI of the stream to share
-
-
-
Returns
-
  • This Builder for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setText - (CharSequence text) -

-
-
- - - -
-
- - - - -

Set a pre-filled message to be sent as part of the share. - This may be a styled CharSequence.

-
-
Parameters
- - - - -
text - Text to share
-
-
-
Returns
-
  • This Builder for method chaining
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - PlusShare.Builder - - setType - (String mimeType) -

-
-
- - - -
-
- - - - -

Set the type of data being shared.

-
-
Parameters
- - - - -
mimeType - mimetype of the shared data
-
-
-
Returns
-
  • This Builder for method chaining
-
-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/PlusShare.html b/docs/html/reference/com/google/android/gms/plus/PlusShare.html deleted file mode 100644 index 4e8bfb3410f9..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/PlusShare.html +++ /dev/null @@ -1,2228 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PlusShare | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - - | Protected Ctors - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PlusShare

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.PlusShare
- - - - - - - -
- - -

Class Overview

-

Utility class for including resources in posts shared on Google+ through - an ACTION_SEND intent. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPlusShare.Builder -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEXTRA_CALL_TO_ACTION - Used as a bundle extra field to describe a call-to-action button for a post on Google+. - - - -
StringEXTRA_CONTENT_DEEP_LINK_ID - Used as a string extra field in ACTION_SEND intents to - specify a resource to be shared on Google+. - - - -
StringEXTRA_CONTENT_DEEP_LINK_METADATA - Used as a bundle extra field in ACTION_SEND intents to - describe a resource to be shared on Google+. - - - -
StringEXTRA_CONTENT_URL - This is a URL for the content of the post. - - - -
StringEXTRA_IS_INTERACTIVE_POST - Extra indicating that this is an interactive post. - - - -
StringEXTRA_SENDER_ID - The ID of the sender on Google+. - - - -
StringKEY_CALL_TO_ACTION_DEEP_LINK_ID - Bundle key used for the String deep-link ID of the call-to-action button. - - - -
StringKEY_CALL_TO_ACTION_LABEL - Bundle key used for the String label placeholder text of the call-to-action button. - - - -
StringKEY_CALL_TO_ACTION_URL - Bundle key used for the String URL of the call-to-action button. - - - -
StringKEY_CONTENT_DEEP_LINK_METADATA_DESCRIPTION - Bundle key used for the String description of the resource shared on Google+. - - - -
StringKEY_CONTENT_DEEP_LINK_METADATA_THUMBNAIL_URL - Bundle key used for the String thumbnail URL of the resource shared on Google+. - - - -
StringKEY_CONTENT_DEEP_LINK_METADATA_TITLE - Bundle key used for the String title of the resource shared on Google+. - - - -
StringPARAM_CONTENT_DEEP_LINK_ID - The query parameter containing the deep-link ID. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Protected Constructors
- - - - - - - - PlusShare() - -
- - This constructor is deprecated. - Use PlusShare.Builder instead. - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Person - - createPerson(String id, String displayName) - -
- Creates a person to use as a recipient with the given ID and display name. - - - -
- -
- - - - static - - String - - getDeepLinkId(Intent intent) - -
- Get the incoming deep link. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EXTRA_CALL_TO_ACTION -

-
- - - - -
-
- - - - -

Used as a bundle extra field to describe a call-to-action button for a post on Google+. -

- - -
- Constant Value: - - - "com.google.android.apps.plus.CALL_TO_ACTION" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CONTENT_DEEP_LINK_ID -

-
- - - - -
-
- - - - -

Used as a string extra field in ACTION_SEND intents to - specify a resource to be shared on Google+. -

- - -
- Constant Value: - - - "com.google.android.apps.plus.CONTENT_DEEP_LINK_ID" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CONTENT_DEEP_LINK_METADATA -

-
- - - - -
-
- - - - -

Used as a bundle extra field in ACTION_SEND intents to - describe a resource to be shared on Google+. You should only set this extra with - EXTRA_CONTENT_DEEP_LINK_ID, and when the deep-link ID is not a URI. -

- - -
- Constant Value: - - - "com.google.android.apps.plus.CONTENT_DEEP_LINK_METADATA" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_CONTENT_URL -

-
- - - - -
-
- - - - -

This is a URL for the content of the post. -

- - -
- Constant Value: - - - "com.google.android.apps.plus.CONTENT_URL" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_IS_INTERACTIVE_POST -

-
- - - - -
-
- - - - -

Extra indicating that this is an interactive post. -

- - -
- Constant Value: - - - "com.google.android.apps.plus.GOOGLE_INTERACTIVE_POST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_SENDER_ID -

-
- - - - -
-
- - - - -

The ID of the sender on Google+.

-
-
See Also
- -
- - -
- Constant Value: - - - "com.google.android.apps.plus.SENDER_ID" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CALL_TO_ACTION_DEEP_LINK_ID -

-
- - - - -
-
- - - - -

Bundle key used for the String deep-link ID of the call-to-action button. - This key is used in the EXTRA_CALL_TO_ACTION bundle. -

- - -
- Constant Value: - - - "deepLinkId" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CALL_TO_ACTION_LABEL -

-
- - - - -
-
- - - - -

Bundle key used for the String label placeholder text of the call-to-action button. - This key is used in the EXTRA_CALL_TO_ACTION bundle. -

- - -
- Constant Value: - - - "label" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CALL_TO_ACTION_URL -

-
- - - - -
-
- - - - -

Bundle key used for the String URL of the call-to-action button. - This key is used in the EXTRA_CALL_TO_ACTION bundle. -

- - -
- Constant Value: - - - "url" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CONTENT_DEEP_LINK_METADATA_DESCRIPTION -

-
- - - - -
-
- - - - -

Bundle key used for the String description of the resource shared on Google+. - This key is used in the EXTRA_CONTENT_DEEP_LINK_METADATA bundle. -

- - -
- Constant Value: - - - "description" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CONTENT_DEEP_LINK_METADATA_THUMBNAIL_URL -

-
- - - - -
-
- - - - -

Bundle key used for the String thumbnail URL of the resource shared on Google+. - This key is used in the EXTRA_CONTENT_DEEP_LINK_METADATA bundle. -

- - -
- Constant Value: - - - "thumbnailUrl" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - KEY_CONTENT_DEEP_LINK_METADATA_TITLE -

-
- - - - -
-
- - - - -

Bundle key used for the String title of the resource shared on Google+. - This key is used in the EXTRA_CONTENT_DEEP_LINK_METADATA bundle. -

- - -
- Constant Value: - - - "title" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - PARAM_CONTENT_DEEP_LINK_ID -

-
- - - - -
-
- - - - -

The query parameter containing the deep-link ID. This is populated when a deep link is - clicked from a Google+ post. -

- - -
- Constant Value: - - - "deep_link_id" - - -
- -
-
- - - - - - - - - - - - - - -

Protected Constructors

- - - - - -
-

- - protected - - - - - - - PlusShare - () -

-
-
- - - -
-
- - - -

-

- This constructor is deprecated.
- Use PlusShare.Builder instead. - -

-

- -
-
- - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Person - - createPerson - (String id, String displayName) -

-
-
- - - -
-
- - - - -

Creates a person to use as a recipient with the given ID and display name. - See setRecipients(Person, List).

-
-
Parameters
- - - - - - - -
id - The recipient's ID, see getId().
displayName - The recipient's display name, see getDisplayName(). -
-
- -
-
- - - - -
-

- - public - static - - - - String - - getDeepLinkId - (Intent intent) -

-
-
- - - -
-
- - - - -

Get the incoming deep link.

-
-
Parameters
- - - - -
intent - The intent passed to your activity, containing a deep_link_id.
-
-
-
Returns
-
  • The deep-link ID. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.Builder.html b/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.Builder.html deleted file mode 100644 index e4787256178c..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.Builder.html +++ /dev/null @@ -1,4429 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ItemScope.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

ItemScope.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.moments.ItemScope.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ItemScope.Builder() - -
- Constructs a new Builder. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - ItemScope - - build() - -
- Constructs a ItemScope with the current properties. - - - -
- -
- - - - - - ItemScope.Builder - - setAbout(ItemScope about) - -
- The subject matter of the content. - - - -
- -
- - - - - - ItemScope.Builder - - setAdditionalName(List<String> additionalName) - -
- An additional name for a Person, can be used for a middle name. - - - -
- -
- - - - - - ItemScope.Builder - - setAddress(ItemScope address) - -
- Postal address. - - - -
- -
- - - - - - ItemScope.Builder - - setAddressCountry(String addressCountry) - -
- Address country. - - - -
- -
- - - - - - ItemScope.Builder - - setAddressLocality(String addressLocality) - -
- Address locality. - - - -
- -
- - - - - - ItemScope.Builder - - setAddressRegion(String addressRegion) - -
- Address region. - - - -
- -
- - - - - - ItemScope.Builder - - setAssociated_media(List<ItemScope> associated_media) - -
- The encoding. - - - -
- -
- - - - - - ItemScope.Builder - - setAttendeeCount(int attendeeCount) - -
- Number of attendees. - - - -
- -
- - - - - - ItemScope.Builder - - setAttendees(List<ItemScope> attendees) - -
- A person attending the event. - - - -
- -
- - - - - - ItemScope.Builder - - setAudio(ItemScope audio) - -
- From http://schema.org/MusicRecording, the audio file. - - - -
- -
- - - - - - ItemScope.Builder - - setAuthor(List<ItemScope> author) - -
- The person or persons who created this result. - - - -
- -
- - - - - - ItemScope.Builder - - setBestRating(String bestRating) - -
- Best possible rating value that a result might obtain. - - - -
- -
- - - - - - ItemScope.Builder - - setBirthDate(String birthDate) - -
- Date of birth. - - - -
- -
- - - - - - ItemScope.Builder - - setByArtist(ItemScope byArtist) - -
- From http://schema.org/MusicRecording, the artist that performed this recording. - - - -
- -
- - - - - - ItemScope.Builder - - setCaption(String caption) - -
- The caption for this object. - - - -
- -
- - - - - - ItemScope.Builder - - setContentSize(String contentSize) - -
- File size in (mega/kilo) bytes. - - - -
- -
- - - - - - ItemScope.Builder - - setContentUrl(String contentUrl) - -
- Actual bytes of the media object, for example the image file or video file. - - - -
- -
- - - - - - ItemScope.Builder - - setContributor(List<ItemScope> contributor) - -
- A list of contributors to this result. - - - -
- -
- - - - - - ItemScope.Builder - - setDateCreated(String dateCreated) - -
- The date the result was created such as the date that a review was first created. - - - -
- -
- - - - - - ItemScope.Builder - - setDateModified(String dateModified) - -
- The date the result was last modified such as the date that a review was last edited. - - - -
- -
- - - - - - ItemScope.Builder - - setDatePublished(String datePublished) - -
- The initial date that the result was published. - - - -
- -
- - - - - - ItemScope.Builder - - setDescription(String description) - -
- The string that describes the content of the result. - - - -
- -
- - - - - - ItemScope.Builder - - setDuration(String duration) - -
- The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. - - - -
- -
- - - - - - ItemScope.Builder - - setEmbedUrl(String embedUrl) - -
- A URL pointing to a player for a specific video. - - - -
- -
- - - - - - ItemScope.Builder - - setEndDate(String endDate) - -
- The end date and time of the event (in ISO 8601 date format). - - - -
- -
- - - - - - ItemScope.Builder - - setFamilyName(String familyName) - -
- Family name. - - - -
- -
- - - - - - ItemScope.Builder - - setGender(String gender) - -
- Gender of the person. - - - -
- -
- - - - - - ItemScope.Builder - - setGeo(ItemScope geo) - -
- Geo coordinates. - - - -
- -
- - - - - - ItemScope.Builder - - setGivenName(String givenName) - -
- Given name. - - - -
- -
- - - - - - ItemScope.Builder - - setHeight(String height) - -
- The height of the media object. - - - -
- -
- - - - - - ItemScope.Builder - - setId(String id) - -
- An identifier for the target. - - - -
- -
- - - - - - ItemScope.Builder - - setImage(String image) - -
- A URL to the image that represents this result. - - - -
- -
- - - - - - ItemScope.Builder - - setInAlbum(ItemScope inAlbum) - -
- From http://schema.org/MusicRecording, which album a song is in. - - - -
- -
- - - - - - ItemScope.Builder - - setLatitude(double latitude) - -
- Latitude. - - - -
- -
- - - - - - ItemScope.Builder - - setLocation(ItemScope location) - -
- The location of the event or organization. - - - -
- -
- - - - - - ItemScope.Builder - - setLongitude(double longitude) - -
- Longitude. - - - -
- -
- - - - - - ItemScope.Builder - - setName(String name) - -
- The name of the result. - - - -
- -
- - - - - - ItemScope.Builder - - setPartOfTVSeries(ItemScope partOfTVSeries) - -
- Property of http://schema.org/TVEpisode indicating which series the episode belongs to. - - - -
- -
- - - - - - ItemScope.Builder - - setPerformers(List<ItemScope> performers) - -
- The main performer or performers of the event-for example, a presenter, musician, or - actor. - - - -
- -
- - - - - - ItemScope.Builder - - setPlayerType(String playerType) - -
- Player type that is required. - - - -
- -
- - - - - - ItemScope.Builder - - setPostOfficeBoxNumber(String postOfficeBoxNumber) - -
- Post office box number. - - - -
- -
- - - - - - ItemScope.Builder - - setPostalCode(String postalCode) - -
- Postal code. - - - -
- -
- - - - - - ItemScope.Builder - - setRatingValue(String ratingValue) - -
- Rating value. - - - -
- -
- - - - - - ItemScope.Builder - - setReviewRating(ItemScope reviewRating) - -
- Review rating. - - - -
- -
- - - - - - ItemScope.Builder - - setStartDate(String startDate) - -
- The start date and time of the event (in ISO 8601 date format). - - - -
- -
- - - - - - ItemScope.Builder - - setStreetAddress(String streetAddress) - -
- Street address. - - - -
- -
- - - - - - ItemScope.Builder - - setText(String text) - -
- The text that is the result of the app activity. - - - -
- -
- - - - - - ItemScope.Builder - - setThumbnail(ItemScope thumbnail) - -
- Thumbnail image for an image or video. - - - -
- -
- - - - - - ItemScope.Builder - - setThumbnailUrl(String thumbnailUrl) - -
- A URL to a thumbnail image that represents this result. - - - -
- -
- - - - - - ItemScope.Builder - - setTickerSymbol(String tickerSymbol) - -
- The exchange traded instrument associated with a Corporation object. - - - -
- -
- - - - - - ItemScope.Builder - - setType(String type) - -
- The schema.org URL that best describes the referenced target and matches the type of - moment. - - - -
- -
- - - - - - ItemScope.Builder - - setUrl(String url) - -
- The URL that points to the result object. - - - -
- -
- - - - - - ItemScope.Builder - - setWidth(String width) - -
- The width of the media object. - - - -
- -
- - - - - - ItemScope.Builder - - setWorstRating(String worstRating) - -
- Worst possible rating value that a result might obtain. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ItemScope.Builder - () -

-
-
- - - -
-
- - - - -

Constructs a new Builder. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - ItemScope - - build - () -

-
-
- - - -
-
- - - - -

Constructs a ItemScope with the current properties. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAbout - (ItemScope about) -

-
-
- - - -
-
- - - - -

The subject matter of the content. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAdditionalName - (List<String> additionalName) -

-
-
- - - -
-
- - - - -

An additional name for a Person, can be used for a middle name. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAddress - (ItemScope address) -

-
-
- - - -
-
- - - - -

Postal address. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAddressCountry - (String addressCountry) -

-
-
- - - -
-
- - - - -

Address country. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAddressLocality - (String addressLocality) -

-
-
- - - -
-
- - - - -

Address locality. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAddressRegion - (String addressRegion) -

-
-
- - - -
-
- - - - -

Address region. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAssociated_media - (List<ItemScope> associated_media) -

-
-
- - - -
-
- - - - -

The encoding. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAttendeeCount - (int attendeeCount) -

-
-
- - - -
-
- - - - -

Number of attendees. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAttendees - (List<ItemScope> attendees) -

-
-
- - - -
-
- - - - -

A person attending the event. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAudio - (ItemScope audio) -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, the audio file. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setAuthor - (List<ItemScope> author) -

-
-
- - - -
-
- - - - -

The person or persons who created this result. In the example of restaurant reviews, this - might be the reviewer's name. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setBestRating - (String bestRating) -

-
-
- - - -
-
- - - - -

Best possible rating value that a result might obtain. This property defines the upper - bound for the ratingValue. For example, you might have a 5 star rating scale, you would - provide 5 as the value for this property. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setBirthDate - (String birthDate) -

-
-
- - - -
-
- - - - -

Date of birth. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setByArtist - (ItemScope byArtist) -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, the artist that performed this recording. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setCaption - (String caption) -

-
-
- - - -
-
- - - - -

The caption for this object. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setContentSize - (String contentSize) -

-
-
- - - -
-
- - - - -

File size in (mega/kilo) bytes. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setContentUrl - (String contentUrl) -

-
-
- - - -
-
- - - - -

Actual bytes of the media object, for example the image file or video file. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setContributor - (List<ItemScope> contributor) -

-
-
- - - -
-
- - - - -

A list of contributors to this result. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setDateCreated - (String dateCreated) -

-
-
- - - -
-
- - - - -

The date the result was created such as the date that a review was first created. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setDateModified - (String dateModified) -

-
-
- - - -
-
- - - - -

The date the result was last modified such as the date that a review was last edited. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setDatePublished - (String datePublished) -

-
-
- - - -
-
- - - - -

The initial date that the result was published. For example, a user writes a comment on a - blog, which has a result.dateCreated of when they submit it. If the blog users comment - moderation, the result.datePublished value would match the date when the owner approved - the message. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

The string that describes the content of the result. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setDuration - (String duration) -

-
-
- - - -
-
- - - - -

The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setEmbedUrl - (String embedUrl) -

-
-
- - - -
-
- - - - -

A URL pointing to a player for a specific video. In general, this is the information in - the src element of an embed tag and should not be the same as the content of the loc tag. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setEndDate - (String endDate) -

-
-
- - - -
-
- - - - -

The end date and time of the event (in ISO 8601 date format). -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setFamilyName - (String familyName) -

-
-
- - - -
-
- - - - -

Family name. This property can be used with givenName instead of the name property. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setGender - (String gender) -

-
-
- - - -
-
- - - - -

Gender of the person. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setGeo - (ItemScope geo) -

-
-
- - - -
-
- - - - -

Geo coordinates. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setGivenName - (String givenName) -

-
-
- - - -
-
- - - - -

Given name. This property can be used with familyName instead of the name property. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setHeight - (String height) -

-
-
- - - -
-
- - - - -

The height of the media object. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setId - (String id) -

-
-
- - - -
-
- - - - -

An identifier for the target. Your app can choose how to identify targets. The target.id - is required if you are writing an activity that does not have a corresponding web page or - target.url property. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setImage - (String image) -

-
-
- - - -
-
- - - - -

A URL to the image that represents this result. For example, if a user writes a review of - a restaurant and attaches a photo of their meal, you might use that photo as the - result.image. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setInAlbum - (ItemScope inAlbum) -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, which album a song is in. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setLatitude - (double latitude) -

-
-
- - - -
-
- - - - -

Latitude. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setLocation - (ItemScope location) -

-
-
- - - -
-
- - - - -

The location of the event or organization. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setLongitude - (double longitude) -

-
-
- - - -
-
- - - - -

Longitude. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setName - (String name) -

-
-
- - - -
-
- - - - -

The name of the result. In the example of a restaurant review, this might be the summary - the user gave their review such as "Great ambiance, but overpriced." -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setPartOfTVSeries - (ItemScope partOfTVSeries) -

-
-
- - - -
-
- - - - -

Property of http://schema.org/TVEpisode indicating which series the episode belongs to. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setPerformers - (List<ItemScope> performers) -

-
-
- - - -
-
- - - - -

The main performer or performers of the event-for example, a presenter, musician, or - actor. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setPlayerType - (String playerType) -

-
-
- - - -
-
- - - - -

Player type that is required. For example: Flash or Silverlight. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setPostOfficeBoxNumber - (String postOfficeBoxNumber) -

-
-
- - - -
-
- - - - -

Post office box number. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setPostalCode - (String postalCode) -

-
-
- - - -
-
- - - - -

Postal code. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setRatingValue - (String ratingValue) -

-
-
- - - -
-
- - - - -

Rating value. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setReviewRating - (ItemScope reviewRating) -

-
-
- - - -
-
- - - - -

Review rating. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setStartDate - (String startDate) -

-
-
- - - -
-
- - - - -

The start date and time of the event (in ISO 8601 date format). -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setStreetAddress - (String streetAddress) -

-
-
- - - -
-
- - - - -

Street address. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setText - (String text) -

-
-
- - - -
-
- - - - -

The text that is the result of the app activity. For example, if a user leaves a review - of a restaurant, this might be the text of the review. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setThumbnail - (ItemScope thumbnail) -

-
-
- - - -
-
- - - - -

Thumbnail image for an image or video. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setThumbnailUrl - (String thumbnailUrl) -

-
-
- - - -
-
- - - - -

A URL to a thumbnail image that represents this result. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setTickerSymbol - (String tickerSymbol) -

-
-
- - - -
-
- - - - -

The exchange traded instrument associated with a Corporation object. The tickerSymbol is - expressed as an exchange and an instrument name separated by a space character. For the - exchange component of the tickerSymbol attribute, we reccommend using the controlled - vocaulary of Market Identifier Codes (MIC) specified in ISO15022. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setType - (String type) -

-
-
- - - -
-
- - - - -

The schema.org URL that best describes the referenced target and matches the type of - moment. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setUrl - (String url) -

-
-
- - - -
-
- - - - -

The URL that points to the result object. For example, a permalink directly to a - restaurant reviewer's comment. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setWidth - (String width) -

-
-
- - - -
-
- - - - -

The width of the media object. -

- -
-
- - - - -
-

- - public - - - - - ItemScope.Builder - - setWorstRating - (String worstRating) -

-
-
- - - -
-
- - - - -

Worst possible rating value that a result might obtain. This property defines the lower - bound for the ratingValue. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.html b/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.html deleted file mode 100644 index 1cf118354634..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/ItemScope.html +++ /dev/null @@ -1,7206 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ItemScope | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

ItemScope

- - - - - - implements - - Freezable<ItemScope> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.moments.ItemScope
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classItemScope.Builder -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ItemScope - - getAbout() - -
- The subject matter of the content. - - - -
- -
- abstract - - - - - List<String> - - getAdditionalName() - -
- An additional name for a Person, can be used for a middle name. - - - -
- -
- abstract - - - - - ItemScope - - getAddress() - -
- Postal address. - - - -
- -
- abstract - - - - - String - - getAddressCountry() - -
- Address country. - - - -
- -
- abstract - - - - - String - - getAddressLocality() - -
- Address locality. - - - -
- -
- abstract - - - - - String - - getAddressRegion() - -
- Address region. - - - -
- -
- abstract - - - - - List<ItemScope> - - getAssociated_media() - -
- The encoding. - - - -
- -
- abstract - - - - - int - - getAttendeeCount() - -
- Number of attendees. - - - -
- -
- abstract - - - - - List<ItemScope> - - getAttendees() - -
- A person attending the event. - - - -
- -
- abstract - - - - - ItemScope - - getAudio() - -
- From http://schema.org/MusicRecording, the audio file. - - - -
- -
- abstract - - - - - List<ItemScope> - - getAuthor() - -
- The person or persons who created this result. - - - -
- -
- abstract - - - - - String - - getBestRating() - -
- Best possible rating value that a result might obtain. - - - -
- -
- abstract - - - - - String - - getBirthDate() - -
- Date of birth. - - - -
- -
- abstract - - - - - ItemScope - - getByArtist() - -
- From http://schema.org/MusicRecording, the artist that performed this recording. - - - -
- -
- abstract - - - - - String - - getCaption() - -
- The caption for this object. - - - -
- -
- abstract - - - - - String - - getContentSize() - -
- File size in (mega/kilo) bytes. - - - -
- -
- abstract - - - - - String - - getContentUrl() - -
- Actual bytes of the media object, for example the image file or video file. - - - -
- -
- abstract - - - - - List<ItemScope> - - getContributor() - -
- A list of contributors to this result. - - - -
- -
- abstract - - - - - String - - getDateCreated() - -
- The date the result was created such as the date that a review was first created. - - - -
- -
- abstract - - - - - String - - getDateModified() - -
- The date the result was last modified such as the date that a review was last edited. - - - -
- -
- abstract - - - - - String - - getDatePublished() - -
- The initial date that the result was published. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- The string that describes the content of the result. - - - -
- -
- abstract - - - - - String - - getDuration() - -
- The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. - - - -
- -
- abstract - - - - - String - - getEmbedUrl() - -
- A URL pointing to a player for a specific video. - - - -
- -
- abstract - - - - - String - - getEndDate() - -
- The end date and time of the event (in ISO 8601 date format). - - - -
- -
- abstract - - - - - String - - getFamilyName() - -
- Family name. - - - -
- -
- abstract - - - - - String - - getGender() - -
- Gender of the person. - - - -
- -
- abstract - - - - - ItemScope - - getGeo() - -
- Geo coordinates. - - - -
- -
- abstract - - - - - String - - getGivenName() - -
- Given name. - - - -
- -
- abstract - - - - - String - - getHeight() - -
- The height of the media object. - - - -
- -
- abstract - - - - - String - - getId() - -
- An identifier for the target. - - - -
- -
- abstract - - - - - String - - getImage() - -
- A URL to the image that represents this result. - - - -
- -
- abstract - - - - - ItemScope - - getInAlbum() - -
- From http://schema.org/MusicRecording, which album a song is in. - - - -
- -
- abstract - - - - - double - - getLatitude() - -
- Latitude. - - - -
- -
- abstract - - - - - ItemScope - - getLocation() - -
- The location of the event or organization. - - - -
- -
- abstract - - - - - double - - getLongitude() - -
- Longitude. - - - -
- -
- abstract - - - - - String - - getName() - -
- The name of the result. - - - -
- -
- abstract - - - - - ItemScope - - getPartOfTVSeries() - -
- Property of http://schema.org/TVEpisode indicating which series the episode belongs to. - - - -
- -
- abstract - - - - - List<ItemScope> - - getPerformers() - -
- The main performer or performers of the event-for example, a presenter, musician, or actor. - - - -
- -
- abstract - - - - - String - - getPlayerType() - -
- Player type that is required. - - - -
- -
- abstract - - - - - String - - getPostOfficeBoxNumber() - -
- Post office box number. - - - -
- -
- abstract - - - - - String - - getPostalCode() - -
- Postal code. - - - -
- -
- abstract - - - - - String - - getRatingValue() - -
- Rating value. - - - -
- -
- abstract - - - - - ItemScope - - getReviewRating() - -
- Review rating. - - - -
- -
- abstract - - - - - String - - getStartDate() - -
- The start date and time of the event (in ISO 8601 date format). - - - -
- -
- abstract - - - - - String - - getStreetAddress() - -
- Street address. - - - -
- -
- abstract - - - - - String - - getText() - -
- The text that is the result of the app activity. - - - -
- -
- abstract - - - - - ItemScope - - getThumbnail() - -
- Thumbnail image for an image or video. - - - -
- -
- abstract - - - - - String - - getThumbnailUrl() - -
- A URL to a thumbnail image that represents this result. - - - -
- -
- abstract - - - - - String - - getTickerSymbol() - -
- The exchange traded instrument associated with a Corporation object. - - - -
- -
- abstract - - - - - String - - getType() - -
- The schema.org URL that best describes the referenced target and matches the type of moment. - - - -
- -
- abstract - - - - - String - - getUrl() - -
- The URL that points to the result object. - - - -
- -
- abstract - - - - - String - - getWidth() - -
- The width of the media object. - - - -
- -
- abstract - - - - - String - - getWorstRating() - -
- Worst possible rating value that a result might obtain. - - - -
- -
- abstract - - - - - boolean - - hasAbout() - -
- Indicates whether the "about" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAdditionalName() - -
- Indicates whether the "additionalName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAddress() - -
- Indicates whether the "address" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAddressCountry() - -
- Indicates whether the "addressCountry" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAddressLocality() - -
- Indicates whether the "addressLocality" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAddressRegion() - -
- Indicates whether the "addressRegion" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAssociated_media() - -
- Indicates whether the "associated_media" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAttendeeCount() - -
- Indicates whether the "attendeeCount" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAttendees() - -
- Indicates whether the "attendees" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAudio() - -
- Indicates whether the "audio" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAuthor() - -
- Indicates whether the "author" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasBestRating() - -
- Indicates whether the "bestRating" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasBirthDate() - -
- Indicates whether the "birthDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasByArtist() - -
- Indicates whether the "byArtist" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasCaption() - -
- Indicates whether the "caption" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasContentSize() - -
- Indicates whether the "contentSize" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasContentUrl() - -
- Indicates whether the "contentUrl" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasContributor() - -
- Indicates whether the "contributor" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDateCreated() - -
- Indicates whether the "dateCreated" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDateModified() - -
- Indicates whether the "dateModified" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDatePublished() - -
- Indicates whether the "datePublished" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDescription() - -
- Indicates whether the "description" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDuration() - -
- Indicates whether the "duration" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasEmbedUrl() - -
- Indicates whether the "embedUrl" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasEndDate() - -
- Indicates whether the "endDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasFamilyName() - -
- Indicates whether the "familyName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasGender() - -
- Indicates whether the "gender" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasGeo() - -
- Indicates whether the "geo" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasGivenName() - -
- Indicates whether the "givenName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasHeight() - -
- Indicates whether the "height" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasId() - -
- Indicates whether the "id" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasImage() - -
- Indicates whether the "image" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasInAlbum() - -
- Indicates whether the "inAlbum" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLatitude() - -
- Indicates whether the "latitude" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLocation() - -
- Indicates whether the "location" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLongitude() - -
- Indicates whether the "longitude" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasName() - -
- Indicates whether the "name" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPartOfTVSeries() - -
- Indicates whether the "partOfTVSeries" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPerformers() - -
- Indicates whether the "performers" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPlayerType() - -
- Indicates whether the "playerType" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPostOfficeBoxNumber() - -
- Indicates whether the "postOfficeBoxNumber" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPostalCode() - -
- Indicates whether the "postalCode" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasRatingValue() - -
- Indicates whether the "ratingValue" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasReviewRating() - -
- Indicates whether the "reviewRating" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasStartDate() - -
- Indicates whether the "startDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasStreetAddress() - -
- Indicates whether the "streetAddress" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasText() - -
- Indicates whether the "text" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasThumbnail() - -
- Indicates whether the "thumbnail" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasThumbnailUrl() - -
- Indicates whether the "thumbnailUrl" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasTickerSymbol() - -
- Indicates whether the "tickerSymbol" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasType() - -
- Indicates whether the "type" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasUrl() - -
- Indicates whether the "url" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasWidth() - -
- Indicates whether the "width" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasWorstRating() - -
- Indicates whether the "worstRating" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ItemScope - - getAbout - () -

-
-
- - - -
-
- - - - -

The subject matter of the content. -

- -
-
- - - - -
-

- - public - - - abstract - - List<String> - - getAdditionalName - () -

-
-
- - - -
-
- - - - -

An additional name for a Person, can be used for a middle name. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getAddress - () -

-
-
- - - -
-
- - - - -

Postal address. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getAddressCountry - () -

-
-
- - - -
-
- - - - -

Address country. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getAddressLocality - () -

-
-
- - - -
-
- - - - -

Address locality. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getAddressRegion - () -

-
-
- - - -
-
- - - - -

Address region. -

- -
-
- - - - -
-

- - public - - - abstract - - List<ItemScope> - - getAssociated_media - () -

-
-
- - - -
-
- - - - -

The encoding. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getAttendeeCount - () -

-
-
- - - -
-
- - - - -

Number of attendees. -

- -
-
- - - - -
-

- - public - - - abstract - - List<ItemScope> - - getAttendees - () -

-
-
- - - -
-
- - - - -

A person attending the event. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getAudio - () -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, the audio file. -

- -
-
- - - - -
-

- - public - - - abstract - - List<ItemScope> - - getAuthor - () -

-
-
- - - -
-
- - - - -

The person or persons who created this result. In the example of restaurant reviews, this - might be the reviewer's name. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getBestRating - () -

-
-
- - - -
-
- - - - -

Best possible rating value that a result might obtain. This property defines the upper bound - for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 - as the value for this property. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getBirthDate - () -

-
-
- - - -
-
- - - - -

Date of birth. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getByArtist - () -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, the artist that performed this recording. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getCaption - () -

-
-
- - - -
-
- - - - -

The caption for this object. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getContentSize - () -

-
-
- - - -
-
- - - - -

File size in (mega/kilo) bytes. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getContentUrl - () -

-
-
- - - -
-
- - - - -

Actual bytes of the media object, for example the image file or video file. -

- -
-
- - - - -
-

- - public - - - abstract - - List<ItemScope> - - getContributor - () -

-
-
- - - -
-
- - - - -

A list of contributors to this result. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDateCreated - () -

-
-
- - - -
-
- - - - -

The date the result was created such as the date that a review was first created. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDateModified - () -

-
-
- - - -
-
- - - - -

The date the result was last modified such as the date that a review was last edited. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDatePublished - () -

-
-
- - - -
-
- - - - -

The initial date that the result was published. For example, a user writes a comment on a - blog, which has a result.dateCreated of when they submit it. If the blog users comment - moderation, the result.datePublished value would match the date when the owner approved the - message. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

The string that describes the content of the result. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDuration - () -

-
-
- - - -
-
- - - - -

The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getEmbedUrl - () -

-
-
- - - -
-
- - - - -

A URL pointing to a player for a specific video. In general, this is the information in the - src element of an embed tag and should not be the same as the content of the loc tag. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getEndDate - () -

-
-
- - - -
-
- - - - -

The end date and time of the event (in ISO 8601 date format). -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getFamilyName - () -

-
-
- - - -
-
- - - - -

Family name. This property can be used with givenName instead of the name property. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getGender - () -

-
-
- - - -
-
- - - - -

Gender of the person. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getGeo - () -

-
-
- - - -
-
- - - - -

Geo coordinates. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getGivenName - () -

-
-
- - - -
-
- - - - -

Given name. This property can be used with familyName instead of the name property. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getHeight - () -

-
-
- - - -
-
- - - - -

The height of the media object. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

An identifier for the target. Your app can choose how to identify targets. The target.id is - required if you are writing an activity that does not have a corresponding web page or - target.url property. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getImage - () -

-
-
- - - -
-
- - - - -

A URL to the image that represents this result. For example, if a user writes a review of a - restaurant and attaches a photo of their meal, you might use that photo as the result.image. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getInAlbum - () -

-
-
- - - -
-
- - - - -

From http://schema.org/MusicRecording, which album a song is in. -

- -
-
- - - - -
-

- - public - - - abstract - - double - - getLatitude - () -

-
-
- - - -
-
- - - - -

Latitude. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getLocation - () -

-
-
- - - -
-
- - - - -

The location of the event or organization. -

- -
-
- - - - -
-

- - public - - - abstract - - double - - getLongitude - () -

-
-
- - - -
-
- - - - -

Longitude. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

The name of the result. In the example of a restaurant review, this might be the summary the - user gave their review such as "Great ambiance, but overpriced." -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getPartOfTVSeries - () -

-
-
- - - -
-
- - - - -

Property of http://schema.org/TVEpisode indicating which series the episode belongs to. -

- -
-
- - - - -
-

- - public - - - abstract - - List<ItemScope> - - getPerformers - () -

-
-
- - - -
-
- - - - -

The main performer or performers of the event-for example, a presenter, musician, or actor. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getPlayerType - () -

-
-
- - - -
-
- - - - -

Player type that is required. For example: Flash or Silverlight. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getPostOfficeBoxNumber - () -

-
-
- - - -
-
- - - - -

Post office box number. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getPostalCode - () -

-
-
- - - -
-
- - - - -

Postal code. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getRatingValue - () -

-
-
- - - -
-
- - - - -

Rating value. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getReviewRating - () -

-
-
- - - -
-
- - - - -

Review rating. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getStartDate - () -

-
-
- - - -
-
- - - - -

The start date and time of the event (in ISO 8601 date format). -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getStreetAddress - () -

-
-
- - - -
-
- - - - -

Street address. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getText - () -

-
-
- - - -
-
- - - - -

The text that is the result of the app activity. For example, if a user leaves a review of a - restaurant, this might be the text of the review. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getThumbnail - () -

-
-
- - - -
-
- - - - -

Thumbnail image for an image or video. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getThumbnailUrl - () -

-
-
- - - -
-
- - - - -

A URL to a thumbnail image that represents this result. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getTickerSymbol - () -

-
-
- - - -
-
- - - - -

The exchange traded instrument associated with a Corporation object. The tickerSymbol is - expressed as an exchange and an instrument name separated by a space character. For the - exchange component of the tickerSymbol attribute, we reccommend using the controlled - vocaulary of Market Identifier Codes (MIC) specified in ISO15022. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getType - () -

-
-
- - - -
-
- - - - -

The schema.org URL that best describes the referenced target and matches the type of moment. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getUrl - () -

-
-
- - - -
-
- - - - -

The URL that points to the result object. For example, a permalink directly to a restaurant - reviewer's comment. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getWidth - () -

-
-
- - - -
-
- - - - -

The width of the media object. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getWorstRating - () -

-
-
- - - -
-
- - - - -

Worst possible rating value that a result might obtain. This property defines the lower bound - for the ratingValue. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAbout - () -

-
-
- - - -
-
- - - - -

Indicates whether the "about" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAdditionalName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "additionalName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAddress - () -

-
-
- - - -
-
- - - - -

Indicates whether the "address" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAddressCountry - () -

-
-
- - - -
-
- - - - -

Indicates whether the "addressCountry" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAddressLocality - () -

-
-
- - - -
-
- - - - -

Indicates whether the "addressLocality" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAddressRegion - () -

-
-
- - - -
-
- - - - -

Indicates whether the "addressRegion" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAssociated_media - () -

-
-
- - - -
-
- - - - -

Indicates whether the "associated_media" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAttendeeCount - () -

-
-
- - - -
-
- - - - -

Indicates whether the "attendeeCount" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAttendees - () -

-
-
- - - -
-
- - - - -

Indicates whether the "attendees" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAudio - () -

-
-
- - - -
-
- - - - -

Indicates whether the "audio" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAuthor - () -

-
-
- - - -
-
- - - - -

Indicates whether the "author" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasBestRating - () -

-
-
- - - -
-
- - - - -

Indicates whether the "bestRating" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasBirthDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "birthDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasByArtist - () -

-
-
- - - -
-
- - - - -

Indicates whether the "byArtist" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCaption - () -

-
-
- - - -
-
- - - - -

Indicates whether the "caption" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasContentSize - () -

-
-
- - - -
-
- - - - -

Indicates whether the "contentSize" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasContentUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "contentUrl" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasContributor - () -

-
-
- - - -
-
- - - - -

Indicates whether the "contributor" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDateCreated - () -

-
-
- - - -
-
- - - - -

Indicates whether the "dateCreated" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDateModified - () -

-
-
- - - -
-
- - - - -

Indicates whether the "dateModified" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDatePublished - () -

-
-
- - - -
-
- - - - -

Indicates whether the "datePublished" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDescription - () -

-
-
- - - -
-
- - - - -

Indicates whether the "description" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDuration - () -

-
-
- - - -
-
- - - - -

Indicates whether the "duration" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasEmbedUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "embedUrl" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasEndDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "endDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasFamilyName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "familyName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGender - () -

-
-
- - - -
-
- - - - -

Indicates whether the "gender" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGeo - () -

-
-
- - - -
-
- - - - -

Indicates whether the "geo" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGivenName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "givenName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasHeight - () -

-
-
- - - -
-
- - - - -

Indicates whether the "height" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasId - () -

-
-
- - - -
-
- - - - -

Indicates whether the "id" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasImage - () -

-
-
- - - -
-
- - - - -

Indicates whether the "image" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasInAlbum - () -

-
-
- - - -
-
- - - - -

Indicates whether the "inAlbum" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLatitude - () -

-
-
- - - -
-
- - - - -

Indicates whether the "latitude" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLocation - () -

-
-
- - - -
-
- - - - -

Indicates whether the "location" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLongitude - () -

-
-
- - - -
-
- - - - -

Indicates whether the "longitude" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "name" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPartOfTVSeries - () -

-
-
- - - -
-
- - - - -

Indicates whether the "partOfTVSeries" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPerformers - () -

-
-
- - - -
-
- - - - -

Indicates whether the "performers" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPlayerType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "playerType" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPostOfficeBoxNumber - () -

-
-
- - - -
-
- - - - -

Indicates whether the "postOfficeBoxNumber" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPostalCode - () -

-
-
- - - -
-
- - - - -

Indicates whether the "postalCode" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasRatingValue - () -

-
-
- - - -
-
- - - - -

Indicates whether the "ratingValue" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasReviewRating - () -

-
-
- - - -
-
- - - - -

Indicates whether the "reviewRating" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasStartDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "startDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasStreetAddress - () -

-
-
- - - -
-
- - - - -

Indicates whether the "streetAddress" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasText - () -

-
-
- - - -
-
- - - - -

Indicates whether the "text" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasThumbnail - () -

-
-
- - - -
-
- - - - -

Indicates whether the "thumbnail" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasThumbnailUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "thumbnailUrl" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasTickerSymbol - () -

-
-
- - - -
-
- - - - -

Indicates whether the "tickerSymbol" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "type" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "url" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasWidth - () -

-
-
- - - -
-
- - - - -

Indicates whether the "width" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasWorstRating - () -

-
-
- - - -
-
- - - - -

Indicates whether the "worstRating" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.Builder.html b/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.Builder.html deleted file mode 100644 index ca4886294e23..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.Builder.html +++ /dev/null @@ -1,1665 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Moment.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Moment.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.moments.Moment.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Moment.Builder() - -
- Constructs a new Builder. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Moment - - build() - -
- Constructs a Moment with the current properties. - - - -
- -
- - - - - - Moment.Builder - - setId(String id) - -
- The moment ID. - - - -
- -
- - - - - - Moment.Builder - - setResult(ItemScope result) - -
- The object generated by performing the action on the target. - - - -
- -
- - - - - - Moment.Builder - - setStartDate(String startDate) - -
- Time stamp of when the action occurred in RFC3339 format. - - - -
- -
- - - - - - Moment.Builder - - setTarget(ItemScope target) - -
- The object on which the action was performed. - - - -
- -
- - - - - - Moment.Builder - - setType(String type) - -
- The Google schema for the type of moment to write. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Moment.Builder - () -

-
-
- - - -
-
- - - - -

Constructs a new Builder. -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Moment - - build - () -

-
-
- - - -
-
- - - - -

Constructs a Moment with the current properties. -

- -
-
- - - - -
-

- - public - - - - - Moment.Builder - - setId - (String id) -

-
-
- - - -
-
- - - - -

The moment ID. -

- -
-
- - - - -
-

- - public - - - - - Moment.Builder - - setResult - (ItemScope result) -

-
-
- - - -
-
- - - - -

The object generated by performing the action on the target. For example, a user writes a - review of a restaurant, the target is the restaurant and the result is the review. -

- -
-
- - - - -
-

- - public - - - - - Moment.Builder - - setStartDate - (String startDate) -

-
-
- - - -
-
- - - - -

Time stamp of when the action occurred in RFC3339 format. -

- -
-
- - - - -
-

- - public - - - - - Moment.Builder - - setTarget - (ItemScope target) -

-
-
- - - -
-
- - - - -

The object on which the action was performed. -

- -
-
- - - - -
-

- - public - - - - - Moment.Builder - - setType - (String type) -

-
-
- - - -
-
- - - - -

The Google schema for the type of moment to write. For example, - http://schemas.google.com/AddActivity. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.html b/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.html deleted file mode 100644 index 847868462d9d..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/Moment.html +++ /dev/null @@ -1,1703 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Moment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Moment

- - - - - - implements - - Freezable<Moment> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.moments.Moment
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMoment.Builder -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getId() - -
- The moment ID. - - - -
- -
- abstract - - - - - ItemScope - - getResult() - -
- The object generated by performing the action on the target. - - - -
- -
- abstract - - - - - String - - getStartDate() - -
- Time stamp of when the action occurred in RFC3339 format. - - - -
- -
- abstract - - - - - ItemScope - - getTarget() - -
- The object on which the action was performed. - - - -
- -
- abstract - - - - - String - - getType() - -
- The Google schema for the type of moment to write. - - - -
- -
- abstract - - - - - boolean - - hasId() - -
- Indicates whether the "id" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasResult() - -
- Indicates whether the "result" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasStartDate() - -
- Indicates whether the "startDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasTarget() - -
- Indicates whether the "target" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasType() - -
- Indicates whether the "type" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

The moment ID. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getResult - () -

-
-
- - - -
-
- - - - -

The object generated by performing the action on the target. For example, a user writes a - review of a restaurant, the target is the restaurant and the result is the review. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getStartDate - () -

-
-
- - - -
-
- - - - -

Time stamp of when the action occurred in RFC3339 format. -

- -
-
- - - - -
-

- - public - - - abstract - - ItemScope - - getTarget - () -

-
-
- - - -
-
- - - - -

The object on which the action was performed. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getType - () -

-
-
- - - -
-
- - - - -

The Google schema for the type of moment to write. For example, - http://schemas.google.com/AddActivity. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasId - () -

-
-
- - - -
-
- - - - -

Indicates whether the "id" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasResult - () -

-
-
- - - -
-
- - - - -

Indicates whether the "result" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasStartDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "startDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasTarget - () -

-
-
- - - -
-
- - - - -

Indicates whether the "target" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "type" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/MomentBuffer.html b/docs/html/reference/com/google/android/gms/plus/model/moments/MomentBuffer.html deleted file mode 100644 index 16bae0702ea1..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/MomentBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MomentBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MomentBuffer

- - - - - - - - - extends AbstractDataBuffer<Moment>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.plus.model.moments.Moment>
    ↳com.google.android.gms.plus.model.moments.MomentBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of Moment objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Moment - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Moment - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/moments/package-summary.html b/docs/html/reference/com/google/android/gms/plus/model/moments/package-summary.html deleted file mode 100644 index b75c860d60ec..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/moments/package-summary.html +++ /dev/null @@ -1,939 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.plus.model.moments | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.plus.model.moments

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
ItemScope -   - - - -
Moment -   - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
ItemScope.Builder -   - - - -
Moment.Builder -   - - - -
MomentBuffer - Data structure providing access to a list of Moment objects.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.AgeRange.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.AgeRange.html deleted file mode 100644 index 05b4650bcd7e..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.AgeRange.html +++ /dev/null @@ -1,1341 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.AgeRange | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.AgeRange

- - - - - - implements - - Freezable<Person.AgeRange> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.AgeRange
- - - - - - - -
- - -

Class Overview

-

The age range of the person. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getMax() - -
- The age range's upper bound, if any. - - - -
- -
- abstract - - - - - int - - getMin() - -
- The age range's lower bound, if any. - - - -
- -
- abstract - - - - - boolean - - hasMax() - -
- Indicates whether the "max" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasMin() - -
- Indicates whether the "min" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getMax - () -

-
-
- - - -
-
- - - - -

The age range's upper bound, if any. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getMin - () -

-
-
- - - -
-
- - - - -

The age range's lower bound, if any. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasMax - () -

-
-
- - - -
-
- - - - -

Indicates whether the "max" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasMin - () -

-
-
- - - -
-
- - - - -

Indicates whether the "min" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverInfo.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverInfo.html deleted file mode 100644 index 871a2855e092..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverInfo.html +++ /dev/null @@ -1,1345 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Cover.CoverInfo | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Cover.CoverInfo

- - - - - - implements - - Freezable<Person.Cover.CoverInfo> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Cover.CoverInfo
- - - - - - - -
- - -

Class Overview

-

Extra information about the cover photo. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getLeftImageOffset() - -
- The difference between the left position of the cover image and the actual displayed cover - image. - - - -
- -
- abstract - - - - - int - - getTopImageOffset() - -
- The difference between the top position of the cover image and the actual displayed cover - image. - - - -
- -
- abstract - - - - - boolean - - hasLeftImageOffset() - -
- Indicates whether the "leftImageOffset" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasTopImageOffset() - -
- Indicates whether the "topImageOffset" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getLeftImageOffset - () -

-
-
- - - -
-
- - - - -

The difference between the left position of the cover image and the actual displayed cover - image. Only valid for banner layout. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getTopImageOffset - () -

-
-
- - - -
-
- - - - -

The difference between the top position of the cover image and the actual displayed cover - image. Only valid for banner layout. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLeftImageOffset - () -

-
-
- - - -
-
- - - - -

Indicates whether the "leftImageOffset" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasTopImageOffset - () -

-
-
- - - -
-
- - - - -

Indicates whether the "topImageOffset" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverPhoto.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverPhoto.html deleted file mode 100644 index 78119978bf15..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.CoverPhoto.html +++ /dev/null @@ -1,1453 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Cover.CoverPhoto | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Cover.CoverPhoto

- - - - - - implements - - Freezable<Person.Cover.CoverPhoto> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Cover.CoverPhoto
- - - - - - - -
- - -

Class Overview

-

The person's primary cover image. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getHeight() - -
- The height of the image. - - - -
- -
- abstract - - - - - String - - getUrl() - -
- The URL of the image. - - - -
- -
- abstract - - - - - int - - getWidth() - -
- The width of the image. - - - -
- -
- abstract - - - - - boolean - - hasHeight() - -
- Indicates whether the "height" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasUrl() - -
- Indicates whether the "url" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasWidth() - -
- Indicates whether the "width" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getHeight - () -

-
-
- - - -
-
- - - - -

The height of the image. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getUrl - () -

-
-
- - - -
-
- - - - -

The URL of the image. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getWidth - () -

-
-
- - - -
-
- - - - -

The width of the image. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasHeight - () -

-
-
- - - -
-
- - - - -

Indicates whether the "height" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "url" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasWidth - () -

-
-
- - - -
-
- - - - -

Indicates whether the "width" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.Layout.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.Layout.html deleted file mode 100644 index abbaee00f792..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.Layout.html +++ /dev/null @@ -1,1312 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Cover.Layout | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.Cover.Layout

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.Cover.Layout
- - - - - - - -
- - -

Class Overview

-

The layout of the cover art. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBANNER - One large image banner. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - BANNER -

-
- - - - -
-
- - - - -

One large image banner. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.html deleted file mode 100644 index c8ea457f00bb..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Cover.html +++ /dev/null @@ -1,1517 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Cover | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Cover

- - - - - - implements - - Freezable<Person.Cover> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Cover
- - - - - - - -
- - -

Class Overview

-

The cover photo content. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfacePerson.Cover.CoverInfo - Extra information about the cover photo.  - - - -
- - - - - interfacePerson.Cover.CoverPhoto - The person's primary cover image.  - - - -
- - - - - classPerson.Cover.Layout - The layout of the cover art.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Person.Cover.CoverInfo - - getCoverInfo() - -
- Extra information about the cover photo. - - - -
- -
- abstract - - - - - Person.Cover.CoverPhoto - - getCoverPhoto() - -
- The person's primary cover image. - - - -
- -
- abstract - - - - - int - - getLayout() - -
- The layout of the cover art. - - - -
- -
- abstract - - - - - boolean - - hasCoverInfo() - -
- Indicates whether the "coverInfo" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasCoverPhoto() - -
- Indicates whether the "coverPhoto" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLayout() - -
- Indicates whether the "layout" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Person.Cover.CoverInfo - - getCoverInfo - () -

-
-
- - - -
-
- - - - -

Extra information about the cover photo. -

- -
-
- - - - -
-

- - public - - - abstract - - Person.Cover.CoverPhoto - - getCoverPhoto - () -

-
-
- - - -
-
- - - - -

The person's primary cover image. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getLayout - () -

-
-
- - - -
-
- - - - -

The layout of the cover art. Possible values include, but are not limited to, the following - values: - - "banner" - One large image banner. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCoverInfo - () -

-
-
- - - -
-
- - - - -

Indicates whether the "coverInfo" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCoverPhoto - () -

-
-
- - - -
-
- - - - -

Indicates whether the "coverPhoto" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLayout - () -

-
-
- - - -
-
- - - - -

Indicates whether the "layout" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Gender.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Gender.html deleted file mode 100644 index 8dea2af611e8..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Gender.html +++ /dev/null @@ -1,1420 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Gender | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.Gender

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.Gender
- - - - - - - -
- - -

Class Overview

-

The person's gender. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intFEMALE - Female gender. - - - -
intMALE - Male gender. - - - -
intOTHER - Other. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - FEMALE -

-
- - - - -
-
- - - - -

Female gender. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MALE -

-
- - - - -
-
- - - - -

Male gender. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - OTHER -

-
- - - - -
-
- - - - -

Other. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Image.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Image.html deleted file mode 100644 index acada0a7b75c..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Image.html +++ /dev/null @@ -1,1230 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Image | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Image

- - - - - - implements - - Freezable<Person.Image> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Image
- - - - - - - -
- - -

Class Overview

-

The representation of the person's profile photo. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getUrl() - -
- The URL of the person's profile photo. - - - -
- -
- abstract - - - - - boolean - - hasUrl() - -
- Indicates whether the "url" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getUrl - () -

-
-
- - - -
-
- - - - -

The URL of the person's profile photo. To resize the image and crop it to a square, append - the query string ?sz=x, where x is the dimension in pixels of each side. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "url" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Name.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Name.html deleted file mode 100644 index c78be46ae04f..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Name.html +++ /dev/null @@ -1,1789 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Name | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Name

- - - - - - implements - - Freezable<Person.Name> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Name
- - - - - - - -
- - -

Class Overview

-

An object representation of the individual components of a person's name. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getFamilyName() - -
- The family name (last name) of this person. - - - -
- -
- abstract - - - - - String - - getFormatted() - -
- The full name of this person, including middle names, suffixes, etc. - - - -
- -
- abstract - - - - - String - - getGivenName() - -
- The given name (first name) of this person. - - - -
- -
- abstract - - - - - String - - getHonorificPrefix() - -
- The honorific prefixes (such as "Dr." or "Mrs.") for this person. - - - -
- -
- abstract - - - - - String - - getHonorificSuffix() - -
- The honorific suffixes (such as "Jr.") for this person. - - - -
- -
- abstract - - - - - String - - getMiddleName() - -
- The middle name of this person. - - - -
- -
- abstract - - - - - boolean - - hasFamilyName() - -
- Indicates whether the "familyName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasFormatted() - -
- Indicates whether the "formatted" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasGivenName() - -
- Indicates whether the "givenName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasHonorificPrefix() - -
- Indicates whether the "honorificPrefix" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasHonorificSuffix() - -
- Indicates whether the "honorificSuffix" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasMiddleName() - -
- Indicates whether the "middleName" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getFamilyName - () -

-
-
- - - -
-
- - - - -

The family name (last name) of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getFormatted - () -

-
-
- - - -
-
- - - - -

The full name of this person, including middle names, suffixes, etc. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getGivenName - () -

-
-
- - - -
-
- - - - -

The given name (first name) of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getHonorificPrefix - () -

-
-
- - - -
-
- - - - -

The honorific prefixes (such as "Dr." or "Mrs.") for this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getHonorificSuffix - () -

-
-
- - - -
-
- - - - -

The honorific suffixes (such as "Jr.") for this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getMiddleName - () -

-
-
- - - -
-
- - - - -

The middle name of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasFamilyName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "familyName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasFormatted - () -

-
-
- - - -
-
- - - - -

Indicates whether the "formatted" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGivenName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "givenName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasHonorificPrefix - () -

-
-
- - - -
-
- - - - -

Indicates whether the "honorificPrefix" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasHonorificSuffix - () -

-
-
- - - -
-
- - - - -

Indicates whether the "honorificSuffix" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasMiddleName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "middleName" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.ObjectType.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.ObjectType.html deleted file mode 100644 index fbe7bdf6bcc0..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.ObjectType.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.ObjectType | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.ObjectType

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.ObjectType
- - - - - - - -
- - -

Class Overview

-

Type of person within Google+. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intPAGE - represents a page. - - - -
intPERSON - represents an actual person. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - PAGE -

-
- - - - -
-
- - - - -

represents a page. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - PERSON -

-
- - - - -
-
- - - - -

represents an actual person. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.Type.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.Type.html deleted file mode 100644 index d529bcd06afe..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.Type.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Organizations.Type | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.Organizations.Type

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.Organizations.Type
- - - - - - - -
- - -

Class Overview

-

The type of organization. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intSCHOOL - School. - - - -
intWORK - Work. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - SCHOOL -

-
- - - - -
-
- - - - -

School. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WORK -

-
- - - - -
-
- - - - -

Work. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.html deleted file mode 100644 index 086436e2f0fc..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Organizations.html +++ /dev/null @@ -1,2154 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Organizations | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Organizations

- - - - - - implements - - Freezable<Person.Organizations> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Organizations
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPerson.Organizations.Type - The type of organization.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDepartment() - -
- The department within the organization. - - - -
- -
- abstract - - - - - String - - getDescription() - -
- A short description of the person's role in this organization. - - - -
- -
- abstract - - - - - String - - getEndDate() - -
- The date that the person left this organization. - - - -
- -
- abstract - - - - - String - - getLocation() - -
- The location of this organization. - - - -
- -
- abstract - - - - - String - - getName() - -
- The name of the organization. - - - -
- -
- abstract - - - - - String - - getStartDate() - -
- The date that the person joined this organization. - - - -
- -
- abstract - - - - - String - - getTitle() - -
- The person's job title or role within the organization. - - - -
- -
- abstract - - - - - int - - getType() - -
- The type of organization. - - - -
- -
- abstract - - - - - boolean - - hasDepartment() - -
- Indicates whether the "department" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDescription() - -
- Indicates whether the "description" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasEndDate() - -
- Indicates whether the "endDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLocation() - -
- Indicates whether the "location" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasName() - -
- Indicates whether the "name" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPrimary() - -
- Indicates whether the "primary" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasStartDate() - -
- Indicates whether the "startDate" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasTitle() - -
- Indicates whether the "title" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasType() - -
- Indicates whether the "type" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - isPrimary() - -
- If "true", indicates this organization is the person's primary one, which is typically - interpreted as the current one. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDepartment - () -

-
-
- - - -
-
- - - - -

The department within the organization. Deprecated. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

A short description of the person's role in this organization. Deprecated. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getEndDate - () -

-
-
- - - -
-
- - - - -

The date that the person left this organization. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getLocation - () -

-
-
- - - -
-
- - - - -

The location of this organization. Deprecated. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

The name of the organization. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getStartDate - () -

-
-
- - - -
-
- - - - -

The date that the person joined this organization. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getTitle - () -

-
-
- - - -
-
- - - - -

The person's job title or role within the organization. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getType - () -

-
-
- - - -
-
- - - - -

The type of organization. Possible values include, but are not limited to, the following - values: - - "work" - Work. - - "school" - School. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDepartment - () -

-
-
- - - -
-
- - - - -

Indicates whether the "department" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDescription - () -

-
-
- - - -
-
- - - - -

Indicates whether the "description" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasEndDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "endDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLocation - () -

-
-
- - - -
-
- - - - -

Indicates whether the "location" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "name" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPrimary - () -

-
-
- - - -
-
- - - - -

Indicates whether the "primary" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasStartDate - () -

-
-
- - - -
-
- - - - -

Indicates whether the "startDate" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasTitle - () -

-
-
- - - -
-
- - - - -

Indicates whether the "title" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "type" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isPrimary - () -

-
-
- - - -
-
- - - - -

If "true", indicates this organization is the person's primary one, which is typically - interpreted as the current one. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.PlacesLived.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.PlacesLived.html deleted file mode 100644 index f5a84d41a569..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.PlacesLived.html +++ /dev/null @@ -1,1337 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.PlacesLived | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.PlacesLived

- - - - - - implements - - Freezable<Person.PlacesLived> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.PlacesLived
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getValue() - -
- A place where this person has lived. - - - -
- -
- abstract - - - - - boolean - - hasPrimary() - -
- Indicates whether the "primary" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasValue() - -
- Indicates whether the "value" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - isPrimary() - -
- If "true", this place of residence is this person's primary residence. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getValue - () -

-
-
- - - -
-
- - - - -

A place where this person has lived. For example: "Seattle, WA", "Near Toronto". -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPrimary - () -

-
-
- - - -
-
- - - - -

Indicates whether the "primary" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasValue - () -

-
-
- - - -
-
- - - - -

Indicates whether the "value" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isPrimary - () -

-
-
- - - -
-
- - - - -

If "true", this place of residence is this person's primary residence. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.RelationshipStatus.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.RelationshipStatus.html deleted file mode 100644 index fa606bc0cad1..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.RelationshipStatus.html +++ /dev/null @@ -1,1744 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.RelationshipStatus | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.RelationshipStatus

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.RelationshipStatus
- - - - - - - -
- - -

Class Overview

-

The person's relationship status. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intENGAGED - Person is engaged. - - - -
intIN_A_RELATIONSHIP - Person is in a relationship. - - - -
intIN_CIVIL_UNION - Person is in a civil union. - - - -
intIN_DOMESTIC_PARTNERSHIP - Person is in a domestic partnership. - - - -
intITS_COMPLICATED - The relationship is complicated. - - - -
intMARRIED - Person is married. - - - -
intOPEN_RELATIONSHIP - Person is in an open relationship. - - - -
intSINGLE - Person is single. - - - -
intWIDOWED - Person is widowed. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ENGAGED -

-
- - - - -
-
- - - - -

Person is engaged. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IN_A_RELATIONSHIP -

-
- - - - -
-
- - - - -

Person is in a relationship. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IN_CIVIL_UNION -

-
- - - - -
-
- - - - -

Person is in a civil union. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - IN_DOMESTIC_PARTNERSHIP -

-
- - - - -
-
- - - - -

Person is in a domestic partnership. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ITS_COMPLICATED -

-
- - - - -
-
- - - - -

The relationship is complicated. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MARRIED -

-
- - - - -
-
- - - - -

Person is married. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - OPEN_RELATIONSHIP -

-
- - - - -
-
- - - - -

Person is in an open relationship. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SINGLE -

-
- - - - -
-
- - - - -

Person is single. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WIDOWED -

-
- - - - -
-
- - - - -

Person is widowed. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.Type.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.Type.html deleted file mode 100644 index ae0adb09be13..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.Type.html +++ /dev/null @@ -1,1474 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Urls.Type | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Person.Urls.Type

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.plus.model.people.Person.Urls.Type
- - - - - - - -
- - -

Class Overview

-

The type of URL. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCONTRIBUTOR - URL for which this person is a contributor to. - - - -
intOTHER - Other. - - - -
intOTHER_PROFILE - URL for another profile. - - - -
intWEBSITE - URL for this Google+ Page's primary website. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CONTRIBUTOR -

-
- - - - -
-
- - - - -

URL for which this person is a contributor to. -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - OTHER -

-
- - - - -
-
- - - - -

Other. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - OTHER_PROFILE -

-
- - - - -
-
- - - - -

URL for another profile. -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WEBSITE -

-
- - - - -
-
- - - - -

URL for this Google+ Page's primary website. -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.html deleted file mode 100644 index 6e88aa6b1630..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.Urls.html +++ /dev/null @@ -1,1481 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person.Urls | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Person.Urls

- - - - - - implements - - Freezable<Person.Urls> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person.Urls
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classPerson.Urls.Type - The type of URL.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getLabel() - -
- The label of the URL. - - - -
- -
- abstract - - - - - int - - getType() - -
- The type of URL. - - - -
- -
- abstract - - - - - String - - getValue() - -
- The URL value. - - - -
- -
- abstract - - - - - boolean - - hasLabel() - -
- Indicates whether the "label" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasType() - -
- Indicates whether the "type" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasValue() - -
- Indicates whether the "value" field is explicitly set to a value. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getLabel - () -

-
-
- - - -
-
- - - - -

The label of the URL. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getType - () -

-
-
- - - -
-
- - - - -

The type of URL. Possible values include, but are not limited to, the following values: - - "otherProfile" - URL for another profile. - - "contributor" - URL to a site for which this person is a contributor. - - "website" - URL for this Google+ Page's primary website. - - "other" - Other URL. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getValue - () -

-
-
- - - -
-
- - - - -

The URL value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLabel - () -

-
-
- - - -
-
- - - - -

Indicates whether the "label" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "type" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasValue - () -

-
-
- - - -
-
- - - - -

Indicates whether the "value" field is explicitly set to a value. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/Person.html b/docs/html/reference/com/google/android/gms/plus/model/people/Person.html deleted file mode 100644 index df4a875b9b21..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/Person.html +++ /dev/null @@ -1,4000 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Person | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Person

- - - - - - implements - - Freezable<Person> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.plus.model.people.Person
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfacePerson.AgeRange - The age range of the person.  - - - -
- - - - - interfacePerson.Cover - The cover photo content.  - - - -
- - - - - classPerson.Gender - The person's gender.  - - - -
- - - - - interfacePerson.Image - The representation of the person's profile photo.  - - - -
- - - - - interfacePerson.Name - An object representation of the individual components of a person's name.  - - - -
- - - - - classPerson.ObjectType - Type of person within Google+.  - - - -
- - - - - interfacePerson.Organizations -   - - - -
- - - - - interfacePerson.PlacesLived -   - - - -
- - - - - classPerson.RelationshipStatus - The person's relationship status.  - - - -
- - - - - interfacePerson.Urls -   - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getAboutMe() - -
- A short biography for this person. - - - -
- -
- abstract - - - - - Person.AgeRange - - getAgeRange() - -
- The age range of the person. - - - -
- -
- abstract - - - - - String - - getBirthday() - -
- The person's date of birth, represented as YYYY-MM-DD. - - - -
- -
- abstract - - - - - String - - getBraggingRights() - -
- The "bragging rights" line of this person. - - - -
- -
- abstract - - - - - int - - getCircledByCount() - -
- If a Google+ Page and for followers who are visible, the number of people who have added this - page to a circle. - - - -
- -
- abstract - - - - - Person.Cover - - getCover() - -
- The cover photo content. - - - -
- -
- abstract - - - - - String - - getCurrentLocation() - -
- The current location for this person. - - - -
- -
- abstract - - - - - String - - getDisplayName() - -
- The name of this person, which is suitable for display. - - - -
- -
- abstract - - - - - int - - getGender() - -
- The person's gender. - - - -
- -
- abstract - - - - - String - - getId() - -
- The ID of this person. - - - -
- -
- abstract - - - - - Person.Image - - getImage() - -
- The representation of the person's profile photo. - - - -
- -
- abstract - - - - - String - - getLanguage() - -
- The user's preferred language for rendering. - - - -
- -
- abstract - - - - - Person.Name - - getName() - -
- An object representation of the individual components of a person's name. - - - -
- -
- abstract - - - - - String - - getNickname() - -
- The nickname of this person. - - - -
- -
- abstract - - - - - int - - getObjectType() - -
- Type of person within Google+. - - - -
- -
- abstract - - - - - List<Person.Organizations> - - getOrganizations() - -
- A list of current or past organizations with which this person is associated. - - - -
- -
- abstract - - - - - List<Person.PlacesLived> - - getPlacesLived() - -
- A list of places where this person has lived. - - - -
- -
- abstract - - - - - int - - getPlusOneCount() - -
- If a Google+ Page, the number of people who have +1'd this page. - - - -
- -
- abstract - - - - - int - - getRelationshipStatus() - -
- The person's relationship status. - - - -
- -
- abstract - - - - - String - - getTagline() - -
- The brief description (tagline) of this person. - - - -
- -
- abstract - - - - - String - - getUrl() - -
- The URL of this person's profile. - - - -
- -
- abstract - - - - - List<Person.Urls> - - getUrls() - -
- A list of URLs for this person. - - - -
- -
- abstract - - - - - boolean - - hasAboutMe() - -
- Indicates whether the "aboutMe" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasAgeRange() - -
- Indicates whether the "ageRange" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasBirthday() - -
- Indicates whether the "birthday" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasBraggingRights() - -
- Indicates whether the "braggingRights" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasCircledByCount() - -
- Indicates whether the "circledByCount" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasCover() - -
- Indicates whether the "cover" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasCurrentLocation() - -
- Indicates whether the "currentLocation" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasDisplayName() - -
- Indicates whether the "displayName" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasGender() - -
- Indicates whether the "gender" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasId() - -
- Indicates whether the "id" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasImage() - -
- Indicates whether the "image" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasIsPlusUser() - -
- Indicates whether the "isPlusUser" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasLanguage() - -
- Indicates whether the "language" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasName() - -
- Indicates whether the "name" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasNickname() - -
- Indicates whether the "nickname" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasObjectType() - -
- Indicates whether the "objectType" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasOrganizations() - -
- Indicates whether the "organizations" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPlacesLived() - -
- Indicates whether the "placesLived" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasPlusOneCount() - -
- Indicates whether the "plusOneCount" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasRelationshipStatus() - -
- Indicates whether the "relationshipStatus" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasTagline() - -
- Indicates whether the "tagline" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasUrl() - -
- Indicates whether the "url" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasUrls() - -
- Indicates whether the "urls" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - hasVerified() - -
- Indicates whether the "verified" field is explicitly set to a value. - - - -
- -
- abstract - - - - - boolean - - isPlusUser() - -
- Whether this user has signed up for Google+. - - - -
- -
- abstract - - - - - boolean - - isVerified() - -
- Whether the person or Google+ Page has been verified. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getAboutMe - () -

-
-
- - - -
-
- - - - -

A short biography for this person. -

- -
-
- - - - -
-

- - public - - - abstract - - Person.AgeRange - - getAgeRange - () -

-
-
- - - -
-
- - - - -

The age range of the person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getBirthday - () -

-
-
- - - -
-
- - - - -

The person's date of birth, represented as YYYY-MM-DD. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getBraggingRights - () -

-
-
- - - -
-
- - - - -

The "bragging rights" line of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getCircledByCount - () -

-
-
- - - -
-
- - - - -

If a Google+ Page and for followers who are visible, the number of people who have added this - page to a circle. -

- -
-
- - - - -
-

- - public - - - abstract - - Person.Cover - - getCover - () -

-
-
- - - -
-
- - - - -

The cover photo content. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getCurrentLocation - () -

-
-
- - - -
-
- - - - -

The current location for this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

The name of this person, which is suitable for display. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getGender - () -

-
-
- - - -
-
- - - - -

The person's gender. Possible values include, but are not limited to, the following values: - - "male" - Male gender. - - "female" - Female gender. - - "other" - Other. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

The ID of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - Person.Image - - getImage - () -

-
-
- - - -
-
- - - - -

The representation of the person's profile photo. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getLanguage - () -

-
-
- - - -
-
- - - - -

The user's preferred language for rendering. -

- -
-
- - - - -
-

- - public - - - abstract - - Person.Name - - getName - () -

-
-
- - - -
-
- - - - -

An object representation of the individual components of a person's name. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getNickname - () -

-
-
- - - -
-
- - - - -

The nickname of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getObjectType - () -

-
-
- - - -
-
- - - - -

Type of person within Google+. Possible values include, but are not limited to, the following - values: - - "person" - represents an actual person. - - "page" - represents a page. -

- -
-
- - - - -
-

- - public - - - abstract - - List<Person.Organizations> - - getOrganizations - () -

-
-
- - - -
-
- - - - -

A list of current or past organizations with which this person is associated. -

- -
-
- - - - -
-

- - public - - - abstract - - List<Person.PlacesLived> - - getPlacesLived - () -

-
-
- - - -
-
- - - - -

A list of places where this person has lived. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getPlusOneCount - () -

-
-
- - - -
-
- - - - -

If a Google+ Page, the number of people who have +1'd this page. -

- -
-
- - - - -
-

- - public - - - abstract - - int - - getRelationshipStatus - () -

-
-
- - - -
-
- - - - -

The person's relationship status. Possible values include, but are not limited to, the - following values: - - "single" - Person is single. - - "in_a_relationship" - Person is in a relationship. - - "engaged" - Person is engaged. - - "married" - Person is married. - - "its_complicated" - The relationship is complicated. - - "open_relationship" - Person is in an open relationship. - - "widowed" - Person is widowed. - - "in_domestic_partnership" - Person is in a domestic partnership. - - "in_civil_union" - Person is in a civil union. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getTagline - () -

-
-
- - - -
-
- - - - -

The brief description (tagline) of this person. -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getUrl - () -

-
-
- - - -
-
- - - - -

The URL of this person's profile. -

- -
-
- - - - -
-

- - public - - - abstract - - List<Person.Urls> - - getUrls - () -

-
-
- - - -
-
- - - - -

A list of URLs for this person. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAboutMe - () -

-
-
- - - -
-
- - - - -

Indicates whether the "aboutMe" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasAgeRange - () -

-
-
- - - -
-
- - - - -

Indicates whether the "ageRange" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasBirthday - () -

-
-
- - - -
-
- - - - -

Indicates whether the "birthday" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasBraggingRights - () -

-
-
- - - -
-
- - - - -

Indicates whether the "braggingRights" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCircledByCount - () -

-
-
- - - -
-
- - - - -

Indicates whether the "circledByCount" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCover - () -

-
-
- - - -
-
- - - - -

Indicates whether the "cover" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasCurrentLocation - () -

-
-
- - - -
-
- - - - -

Indicates whether the "currentLocation" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasDisplayName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "displayName" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasGender - () -

-
-
- - - -
-
- - - - -

Indicates whether the "gender" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasId - () -

-
-
- - - -
-
- - - - -

Indicates whether the "id" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasImage - () -

-
-
- - - -
-
- - - - -

Indicates whether the "image" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasIsPlusUser - () -

-
-
- - - -
-
- - - - -

Indicates whether the "isPlusUser" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasLanguage - () -

-
-
- - - -
-
- - - - -

Indicates whether the "language" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasName - () -

-
-
- - - -
-
- - - - -

Indicates whether the "name" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasNickname - () -

-
-
- - - -
-
- - - - -

Indicates whether the "nickname" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasObjectType - () -

-
-
- - - -
-
- - - - -

Indicates whether the "objectType" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasOrganizations - () -

-
-
- - - -
-
- - - - -

Indicates whether the "organizations" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPlacesLived - () -

-
-
- - - -
-
- - - - -

Indicates whether the "placesLived" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasPlusOneCount - () -

-
-
- - - -
-
- - - - -

Indicates whether the "plusOneCount" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasRelationshipStatus - () -

-
-
- - - -
-
- - - - -

Indicates whether the "relationshipStatus" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasTagline - () -

-
-
- - - -
-
- - - - -

Indicates whether the "tagline" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasUrl - () -

-
-
- - - -
-
- - - - -

Indicates whether the "url" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasUrls - () -

-
-
- - - -
-
- - - - -

Indicates whether the "urls" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - hasVerified - () -

-
-
- - - -
-
- - - - -

Indicates whether the "verified" field is explicitly set to a value. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isPlusUser - () -

-
-
- - - -
-
- - - - -

Whether this user has signed up for Google+. -

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isVerified - () -

-
-
- - - -
-
- - - - -

Whether the person or Google+ Page has been verified. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/PersonBuffer.html b/docs/html/reference/com/google/android/gms/plus/model/people/PersonBuffer.html deleted file mode 100644 index e6dd143836cf..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/PersonBuffer.html +++ /dev/null @@ -1,1816 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PersonBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PersonBuffer

- - - - - - - - - extends AbstractDataBuffer<Person>
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.plus.model.people.Person>
    ↳com.google.android.gms.plus.model.people.PersonBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure providing access to a list of Person objects. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Person - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Person - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/model/people/package-summary.html b/docs/html/reference/com/google/android/gms/plus/model/people/package-summary.html deleted file mode 100644 index b6ff25d5a45c..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/model/people/package-summary.html +++ /dev/null @@ -1,1071 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.plus.model.people | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.plus.model.people

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Person -   - - - -
Person.AgeRange - The age range of the person.  - - - -
Person.Cover - The cover photo content.  - - - -
Person.Cover.CoverInfo - Extra information about the cover photo.  - - - -
Person.Cover.CoverPhoto - The person's primary cover image.  - - - -
Person.Image - The representation of the person's profile photo.  - - - -
Person.Name - An object representation of the individual components of a person's name.  - - - -
Person.Organizations -   - - - -
Person.PlacesLived -   - - - -
Person.Urls -   - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Person.Cover.Layout - The layout of the cover art.  - - - -
Person.Gender - The person's gender.  - - - -
Person.ObjectType - Type of person within Google+.  - - - -
Person.Organizations.Type - The type of organization.  - - - -
Person.RelationshipStatus - The person's relationship status.  - - - -
Person.Urls.Type - The type of URL.  - - - -
PersonBuffer - Data structure providing access to a list of Person objects.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/plus/package-summary.html b/docs/html/reference/com/google/android/gms/plus/package-summary.html deleted file mode 100644 index 4dac6f270625..000000000000 --- a/docs/html/reference/com/google/android/gms/plus/package-summary.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.plus | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.plus

-
- -
- -
- - -
- Contains the Google+ platform for Android. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Account - The main entry point for Google+ account management.  - - - -
Moments - Methods and interfaces related to moments in Google+.  - - - -
Moments.LoadMomentsResult - Information about the set of moments that was loaded.  - - - -
People - Methods and interfaces related to people in Google+.  - - - -
People.LoadPeopleResult - Information about the set of people that was loaded.  - - - -
People.OrderBy - Constants to declare the order to return people in.  - - - -
PlusOneButton.OnPlusOneClickListener - A listener for +1 button clicks.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Plus - The main entry point for Google+ integration.  - - - -
Plus.PlusOptions - API configuration parameters for Google+.  - - - -
Plus.PlusOptions.Builder -   - - - -
PlusOneButton - The +1 button to recommend a URL on Google+.  - - - -
PlusOneButton.DefaultOnPlusOneClickListener - This is an View.OnClickListener that will proxy clicks to an - attached PlusOneButton.OnPlusOneClickListener, or default to attempt to start - the intent using an Activity context.  - - - -
PlusOneDummyView - A class used to statically generate dummy views in the event of an error retrieving - a PlusOneButton from the apk -  - - - -
PlusShare - Utility class for including resources in posts shared on Google+ through - an ACTION_SEND intent.  - - - -
PlusShare.Builder -   - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/safetynet/SafetyNet.html b/docs/html/reference/com/google/android/gms/safetynet/SafetyNet.html deleted file mode 100644 index 1b26decfc2e5..000000000000 --- a/docs/html/reference/com/google/android/gms/safetynet/SafetyNet.html +++ /dev/null @@ -1,1359 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SafetyNet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SafetyNet

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.safetynet.SafetyNet
- - - - - - - -
- - -

Class Overview

-

The SafetyNet API provides security related features to app developers. - - To use SafetyNet, enable the API. SafetyNetApi provides the entry point for - interacting with SafetyNet. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - The API necessary to use SafetyNet. - - - -
- public - static - final - SafetyNetApiSafetyNetApi - The entry point for interacting with the SafetyNet APIs which provides security related - features. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

The API necessary to use SafetyNet. -

- - -
-
- - - - - -
-

- - public - static - final - SafetyNetApi - - SafetyNetApi -

-
- - - - -
-
- - - - -

The entry point for interacting with the SafetyNet APIs which provides security related - features. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.AttestationResult.html b/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.AttestationResult.html deleted file mode 100644 index 9edc99d75b92..000000000000 --- a/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.AttestationResult.html +++ /dev/null @@ -1,1154 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SafetyNetApi.AttestationResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

SafetyNetApi.AttestationResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.safetynet.SafetyNetApi.AttestationResult
- - - - - - - -
- - -

Class Overview

-

Result that contains an attestation result. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getJwsResult() - -
- Gets the JWS result. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getJwsResult - () -

-
-
- - - -
-
- - - - -

Gets the JWS result. - - Result is in JSON Web Signature format. See: - https://tools.ietf.org/html/draft-ietf-jose-json-web-signature-33 - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.html b/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.html deleted file mode 100644 index 7b0fa5987487..000000000000 --- a/docs/html/reference/com/google/android/gms/safetynet/SafetyNetApi.html +++ /dev/null @@ -1,1099 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SafetyNetApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SafetyNetApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.safetynet.SafetyNetApi
- - - - - - - -
- - -

Class Overview

-

The main entry point for interacting with SafetyNet. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceSafetyNetApi.AttestationResult - Result that contains an attestation result.  - - - -
- - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<SafetyNetApi.AttestationResult> - - attest(GoogleApiClient client, byte[] nonce) - -
- Provides attestation results for the device. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<SafetyNetApi.AttestationResult> - - attest - (GoogleApiClient client, byte[] nonce) -

-
-
- - - -
-
- - - - -

Provides attestation results for the device.

-
-
Parameters
- - - - - - - -
client - The GoogleApiClient to service the call. The client must be - connected using connect() before invoking this method.
nonce - A cryptographic nonce used for anti-replay and tracking of requests. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/safetynet/package-summary.html b/docs/html/reference/com/google/android/gms/safetynet/package-summary.html deleted file mode 100644 index 9a709caa6cdf..000000000000 --- a/docs/html/reference/com/google/android/gms/safetynet/package-summary.html +++ /dev/null @@ -1,917 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.safetynet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.safetynet

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
SafetyNetApi - The main entry point for interacting with SafetyNet.  - - - -
SafetyNetApi.AttestationResult - Result that contains an attestation result.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - -
SafetyNet - The SafetyNet API provides security related features to app developers.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/GoogleNowAuthState.html b/docs/html/reference/com/google/android/gms/search/GoogleNowAuthState.html deleted file mode 100644 index c0e8f26bc727..000000000000 --- a/docs/html/reference/com/google/android/gms/search/GoogleNowAuthState.html +++ /dev/null @@ -1,1574 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GoogleNowAuthState | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

GoogleNowAuthState

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.search.GoogleNowAuthState
- - - - - - - -
- - -

Class Overview

-

Output of - getGoogleNowAuth(com.google.android.gms.common.api.GoogleApiClient, String). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - String - - getAccessToken() - -
- Returns the OAuth access token or null if access token is unavailable. - - - -
- -
- - - - - - String - - getAuthCode() - -
- Returns the OAuth authorization code or null if authorization code is unavailable. - - - -
- -
- - - - - - long - - getNextAllowedTimeMillis() - -
- If the request was rejected by the throttler then the next allowed request wall time - (milliseconds since epoch) is returned. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - String - - getAccessToken - () -

-
-
- - - -
-
- - - - -

Returns the OAuth access token or null if access token is unavailable. -

- Access token is made available instead of auth code when an authorization code was already - issued for the web app client ID. This access token may be used with the Now API or it can be - revoked to subsequently obtain a new auth code. -

- -
-
- - - - -
-

- - public - - - - - String - - getAuthCode - () -

-
-
- - - -
-
- - - - -

Returns the OAuth authorization code or null if authorization code is unavailable. -

- The authorization code may be sent to the web application where it can be sent along with the - client secret to the Google OAuth server to obtain a pair of refresh and access tokens. For - details see - Cross-client - Identity. -

- If an authorization code was already issued for the web app client ID then an authorization - code will not be available and an access token will be made available instead. See - getAccessToken(). -

- -
-
- - - - -
-

- - public - - - - - long - - getNextAllowedTimeMillis - () -

-
-
- - - -
-
- - - - -

If the request was rejected by the throttler then the next allowed request wall time - (milliseconds since epoch) is returned. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/SearchAuth.StatusCodes.html b/docs/html/reference/com/google/android/gms/search/SearchAuth.StatusCodes.html deleted file mode 100644 index 8cfc56fb150f..000000000000 --- a/docs/html/reference/com/google/android/gms/search/SearchAuth.StatusCodes.html +++ /dev/null @@ -1,1599 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAuth.StatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

SearchAuth.StatusCodes

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.search.SearchAuth.StatusCodes
- - - - - - - -
- - -

Class Overview

-

Status codes for SearchAuth API containing a combination of common status codes and custom - status codes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAUTH_DISABLED - Authorization for the requested access is disabled for the caller. - - - -
intAUTH_THROTTLED - API call has been rejected by the throttler. - - - -
intDEVELOPER_ERROR - The application is misconfigured. - - - -
intINTERNAL_ERROR - An internal error occurred. - - - -
intSUCCESS - The operation was successful. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - SearchAuth.StatusCodes() - -
- - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - AUTH_DISABLED -

-
- - - - -
-
- - - - -

Authorization for the requested access is disabled for the caller. For example, it may be - disabled due to opt-outs or lack of opt-ins by the user. -

- - -
- Constant Value: - - - 10000 - (0x00002710) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - AUTH_THROTTLED -

-
- - - - -
-
- - - - -

API call has been rejected by the throttler. Retry on or after - getNextAllowedTimeMillis(). -

- - -
- Constant Value: - - - 10001 - (0x00002711) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DEVELOPER_ERROR -

-
- - - - -
-
- - - - -

The application is misconfigured. This error is not recoverable and will be treated as fatal. - The developer should look at the logs after this to determine more actionable information. -

- - -
- Constant Value: - - - 10 - (0x0000000a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INTERNAL_ERROR -

-
- - - - -
-
- - - - -

An internal error occurred. Retrying should resolve the problem. -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

The operation was successful. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SearchAuth.StatusCodes - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/SearchAuth.html b/docs/html/reference/com/google/android/gms/search/SearchAuth.html deleted file mode 100644 index 7d73953b384f..000000000000 --- a/docs/html/reference/com/google/android/gms/search/SearchAuth.html +++ /dev/null @@ -1,1383 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAuth | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

SearchAuth

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.search.SearchAuth
- - - - - - - -
- - -

Class Overview

-

The main entry point to the SearchAuth APIs. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classSearchAuth.StatusCodes - Status codes for SearchAuth API containing a combination of common status codes and custom - status codes.  - - - -
- - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Api.ApiOptions.NoOptions>API - Identifies the SearchAuth API when used with addApi(Api). - - - -
- public - static - final - SearchAuthApiSearchAuthApi - Entry point to the SearchAuth API methods. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Api.ApiOptions.NoOptions> - - API -

-
- - - - -
-
- - - - -

Identifies the SearchAuth API when used with addApi(Api). -

- - -
-
- - - - - -
-

- - public - static - final - SearchAuthApi - - SearchAuthApi -

-
- - - - -
-
- - - - -

Entry point to the SearchAuth API methods. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/SearchAuthApi.GoogleNowAuthResult.html b/docs/html/reference/com/google/android/gms/search/SearchAuthApi.GoogleNowAuthResult.html deleted file mode 100644 index 099818a147f4..000000000000 --- a/docs/html/reference/com/google/android/gms/search/SearchAuthApi.GoogleNowAuthResult.html +++ /dev/null @@ -1,1151 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAuthApi.GoogleNowAuthResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

SearchAuthApi.GoogleNowAuthResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.search.SearchAuthApi.GoogleNowAuthResult
- - - - - - - -
- - -

Class Overview

-

Result of getGoogleNowAuth(GoogleApiClient, String). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - GoogleNowAuthState - - getGoogleNowAuthState() - -
- Returns the auth state if getStatus() indicates success. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - GoogleNowAuthState - - getGoogleNowAuthState - () -

-
-
- - - -
-
- - - - -

Returns the auth state if getStatus() indicates success. - Otherwise, returns null. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/SearchAuthApi.html b/docs/html/reference/com/google/android/gms/search/SearchAuthApi.html deleted file mode 100644 index 218e068cce18..000000000000 --- a/docs/html/reference/com/google/android/gms/search/SearchAuthApi.html +++ /dev/null @@ -1,1145 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SearchAuthApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

SearchAuthApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.search.SearchAuthApi
- - - - - - - -
- - -

Class Overview

-

API for Google Search auth. -

- Usage example: - 

- SearchAuthApi searchAuthApi = SearchAuth.SearchAuthApi;
- GoogleApiClient client = new GoogleApiClient.Builder(context)
-         .addApi(SearchAuth.API)
-         .build();
- client.connect();
-
- try {
-     // Invoke methods of searchAuthApi.
- } finally {
-     client.disconnect();
- }
- 
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceSearchAuthApi.GoogleNowAuthResult - Result of getGoogleNowAuth(GoogleApiClient, String).  - - - -
- - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<SearchAuthApi.GoogleNowAuthResult> - - getGoogleNowAuth(GoogleApiClient client, String webAppClientId) - -
- Obtains authorization for the caller to use the Now API to publish to the Google Now user, - if any, on this device. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<SearchAuthApi.GoogleNowAuthResult> - - getGoogleNowAuth - (GoogleApiClient client, String webAppClientId) -

-
-
- - - -
-
- - - - -

Obtains authorization for the caller to use the Now API to publish to the Google Now user, - if any, on this device. -

- Usage example: - 

- SearchAuthApi.GoogleNowAuthResult authResult;
- try {
-     authResult = searchAuthApi.getGoogleNowAuth(client, WEB_APP_CLIENT_ID)
-             .await();
- } finally {
-     client.disconnect();
- }
-
- Status status = authResult.getStatus();
- if (status.isSuccess()) {
-     GoogleNowAuthState authState = authResult.getGoogleNowAuthState();
-     if (authState.getAuthCode() != null) {
-         // Send auth code to your server and from your server obtain OAuth refresh
-         // and access tokens.
-     } else if (authState.getAccessToken() != null) {
-         // Already obtained auth code before. To get a new auth code revoke this
-         // token and retry.
-     }
- }
- 
-

-
-
Parameters
- - - - - - - -
client - GoogleApiClient that includes API.
webAppClientId - Client ID, in the Google Developer Console, of the web application - that will be using the Now API.
-
-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/search/package-summary.html b/docs/html/reference/com/google/android/gms/search/package-summary.html deleted file mode 100644 index 81102604f1db..000000000000 --- a/docs/html/reference/com/google/android/gms/search/package-summary.html +++ /dev/null @@ -1,946 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.search | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.search

-
- -
- -
- - -
- Contains the Search APIs - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
SearchAuthApi - API for Google Search auth.  - - - -
SearchAuthApi.GoogleNowAuthResult - Result of getGoogleNowAuth(GoogleApiClient, String).  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - -
GoogleNowAuthState - Output of - getGoogleNowAuth(com.google.android.gms.common.api.GoogleApiClient, String).  - - - -
SearchAuth - The main entry point to the SearchAuth APIs.  - - - -
SearchAuth.StatusCodes - Status codes for SearchAuth API containing a combination of common status codes and custom - status codes.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/security/ProviderInstaller.ProviderInstallListener.html b/docs/html/reference/com/google/android/gms/security/ProviderInstaller.ProviderInstallListener.html deleted file mode 100644 index 3fb3b9541f8e..000000000000 --- a/docs/html/reference/com/google/android/gms/security/ProviderInstaller.ProviderInstallListener.html +++ /dev/null @@ -1,1136 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ProviderInstaller.ProviderInstallListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

ProviderInstaller.ProviderInstallListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.security.ProviderInstaller.ProviderInstallListener
- - - - - - - -
- - -

Class Overview

-

Callback for notification of the result of provider installation. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onProviderInstallFailed(int errorCode, Intent recoveryIntent) - -
- Called when installing the provider fails. - - - -
- -
- abstract - - - - - void - - onProviderInstalled() - -
- Called when installing the provider succeeds. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onProviderInstallFailed - (int errorCode, Intent recoveryIntent) -

-
-
- - - -
-
- - - - -

Called when installing the provider fails. This method is always called on the UI thread. - -

Implementers may use errorCode with the standard UI elements provided by - GooglePlayServicesUtil; or recoveryIntent to implement custom UI.

-
-
Parameters
- - - - - - - -
errorCode - error code for the failure, for use with - showErrorDialogFragment(int, Activity, Fragment, int, DialogInterface.OnCancelListener) or - showErrorNotification(int, Context)
recoveryIntent - if non-null, an intent that can be used to install or update - Google Play Services such that the provider can be installed -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onProviderInstalled - () -

-
-
- - - -
-
- - - - -

Called when installing the provider succeeds. This method is always called on the UI - thread. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/security/ProviderInstaller.html b/docs/html/reference/com/google/android/gms/security/ProviderInstaller.html deleted file mode 100644 index 7a1a33100f7b..000000000000 --- a/docs/html/reference/com/google/android/gms/security/ProviderInstaller.html +++ /dev/null @@ -1,1559 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ProviderInstaller | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - | Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ProviderInstaller

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.security.ProviderInstaller
- - - - - - - -
- - -

Class Overview

-

A utility class for installing a dynamically updatable Provider to replace - the platform default provider. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceProviderInstaller.ProviderInstallListener - Callback for notification of the result of provider installation.  - - - -
- - - - - - - - - - - -
Constants
StringPROVIDER_NAME - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ProviderInstaller() - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - void - - installIfNeeded(Context context) - -
- Installs the dynamically updatable security provider, if it's not already installed. - - - -
- -
- - - - static - - void - - installIfNeededAsync(Context context, ProviderInstaller.ProviderInstallListener listener) - -
- Asynchronously installs the dynamically updatable security provider, if it's not already - installed. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - PROVIDER_NAME -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - "GmsCore_OpenSSL" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ProviderInstaller - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - installIfNeeded - (Context context) -

-
-
- - - -
-
- - - - -

Installs the dynamically updatable security provider, if it's not already installed. -

-
-
Throws
- - - - - - - -
GooglePlayServicesRepairableException -
GooglePlayServicesNotAvailableException -
-
- -
-
- - - - -
-

- - public - static - - - - void - - installIfNeededAsync - (Context context, ProviderInstaller.ProviderInstallListener listener) -

-
-
- - - -
-
- - - - -

Asynchronously installs the dynamically updatable security provider, if it's not already - installed. This method must be called on the UI thread.

-
-
Parameters
- - - - -
listener - called when the installation completes -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/security/package-summary.html b/docs/html/reference/com/google/android/gms/security/package-summary.html deleted file mode 100644 index 8fedd3a378f2..000000000000 --- a/docs/html/reference/com/google/android/gms/security/package-summary.html +++ /dev/null @@ -1,907 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.security | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.security

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - -
ProviderInstaller.ProviderInstallListener - Callback for notification of the result of provider installation.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - -
ProviderInstaller - A utility class for installing a dynamically updatable Provider to replace - the platform default provider.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallMacroCallback.html b/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallMacroCallback.html deleted file mode 100644 index 17c840c41048..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallMacroCallback.html +++ /dev/null @@ -1,1075 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Container.FunctionCallMacroCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Container.FunctionCallMacroCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.tagmanager.Container.FunctionCallMacroCallback
- - - - - - - -
- - -

Class Overview

-

Callback that is provided by the application to calculate the value of a custom macro. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Object - - getValue(String functionName, Map<String, Object> parameters) - -
- Callback is given the Function Name of the macro and a map of named parameters (the map - may contain String, Double, Boolean, Integer, Long, Map, or List values). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Object - - getValue - (String functionName, Map<String, Object> parameters) -

-
-
- - - -
-
- - - - -

Callback is given the Function Name of the macro and a map of named parameters (the map - may contain String, Double, Boolean, Integer, Long, Map, or List values). It should - return an object which is the calculated value of the macro. -

- The functionName is the same name by which the callback was registered. It's - provided as a convenience to allow a single callback to be registered for multiple - function call macros. -

- When application code makes a call to push an event to the data layer or to get a data - value from a Container, that may cause this callback to execute. The callback - will execute on the same thread as the push or get call.

-
-
Returns
-
  • a String, Double, Boolean, Integer, or Long -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallTagCallback.html b/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallTagCallback.html deleted file mode 100644 index afed8abd5518..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/Container.FunctionCallTagCallback.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Container.FunctionCallTagCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Container.FunctionCallTagCallback

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.tagmanager.Container.FunctionCallTagCallback
- - - - - - - -
- - -

Class Overview

-

Callback that is provided by the application to execute a custom tag.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - execute(String functionName, Map<String, Object> parameters) - -
- Callback is given the Function Name of the macro and a map of named parameters (the map - may contain String, Double, Boolean, Integer, Long, Map, or List values). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - execute - (String functionName, Map<String, Object> parameters) -

-
-
- - - -
-
- - - - -

Callback is given the Function Name of the macro and a map of named parameters (the map - may contain String, Double, Boolean, Integer, Long, Map, or List values). -

- The functionName is the same name by which the Callback was registered. It's - provided as a convenience to allow a single Callback to be registered for multiple - function call tags. -

- When application code makes a call to push an event to the data layer, that may cause - this callback to execute. The callback will execute on the same thread as the push - call. - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/Container.html b/docs/html/reference/com/google/android/gms/tagmanager/Container.html deleted file mode 100644 index 372be65ee868..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/Container.html +++ /dev/null @@ -1,1970 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Container | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Container

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.tagmanager.Container
- - - - - - - -
- - -

Class Overview

-

An object that provides access to container values. Container objects must be created via - one of the TagManager loadContainer calls. - Once a container is created, it can be queried for key values which may depend on rules - established for the container. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceContainer.FunctionCallMacroCallback - Callback that is provided by the application to calculate the value of a custom macro.  - - - -
- - - - - interfaceContainer.FunctionCallTagCallback - Callback that is provided by the application to execute a custom tag.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - getBoolean(String key) - -
- Returns a boolean representing the configuration value for the given key. - - - -
- -
- - - - - - String - - getContainerId() - -
- Returns the container id. - - - -
- -
- - - - - - double - - getDouble(String key) - -
- Returns a double representing the configuration value for the given key. - - - -
- -
- - - - - - long - - getLastRefreshTime() - -
- Returns the last time (in milliseconds since midnight, January 1, 1970 UTC) that this - container was refreshed from the network. - - - -
- -
- - - - - - long - - getLong(String key) - -
- Returns a long representing the configuration value for the given key. - - - -
- -
- - - - - - String - - getString(String key) - -
- Returns a string representing the configuration value for the given key. - - - -
- -
- - - - - - boolean - - isDefault() - -
- Returns whether this is a default container, or one refreshed from the server. - - - -
- -
- - - - - - void - - registerFunctionCallMacroCallback(String customMacroName, Container.FunctionCallMacroCallback customMacroCallback) - -
- Registers the given macro callback to handle a given function call macro. - - - -
- -
- - - - - - void - - registerFunctionCallTagCallback(String customTagName, Container.FunctionCallTagCallback customTagCallback) - -
- Registers the tag callback to handle a given function call tag. - - - -
- -
- - - - - - void - - unregisterFunctionCallMacroCallback(String customMacroName) - -
- Unregisters any macro callback for the given macro. - - - -
- -
- - - - - - void - - unregisterFunctionCallTagCallback(String customTagName) - -
- Unregisters any tag callback for the given tag. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - getBoolean - (String key) -

-
-
- - - -
-
- - - - -

Returns a boolean representing the configuration value for the given key. If the container - has no value for this key, false will be returned. -

- -
-
- - - - -
-

- - public - - - - - String - - getContainerId - () -

-
-
- - - -
-
- - - - -

Returns the container id. -

- -
-
- - - - -
-

- - public - - - - - double - - getDouble - (String key) -

-
-
- - - -
-
- - - - -

Returns a double representing the configuration value for the given key. If the container has - no value for this key, 0 will be returned. -

- -
-
- - - - -
-

- - public - - - - - long - - getLastRefreshTime - () -

-
-
- - - -
-
- - - - -

Returns the last time (in milliseconds since midnight, January 1, 1970 UTC) that this - container was refreshed from the network. -

- -
-
- - - - -
-

- - public - - - - - long - - getLong - (String key) -

-
-
- - - -
-
- - - - -

Returns a long representing the configuration value for the given key. If the container has - no value for this key, 0 will be returned. -

- -
-
- - - - -
-

- - public - - - - - String - - getString - (String key) -

-
-
- - - -
-
- - - - -

Returns a string representing the configuration value for the given key. If the container has - no value for this key, an empty string will be returned. -

- -
-
- - - - -
-

- - public - - - - - boolean - - isDefault - () -

-
-
- - - -
-
- - - - -

Returns whether this is a default container, or one refreshed from the server. -

- -
-
- - - - -
-

- - public - - - - - void - - registerFunctionCallMacroCallback - (String customMacroName, Container.FunctionCallMacroCallback customMacroCallback) -

-
-
- - - -
-
- - - - -

Registers the given macro callback to handle a given function call macro.

-
-
Parameters
- - - - - - - -
customMacroName - the name of the macro which is being registered
customMacroCallback - the callback to register -
-
- -
-
- - - - -
-

- - public - - - - - void - - registerFunctionCallTagCallback - (String customTagName, Container.FunctionCallTagCallback customTagCallback) -

-
-
- - - -
-
- - - - -

Registers the tag callback to handle a given function call tag.

-
-
Parameters
- - - - - - - -
customTagName - the name of the tag which is being registered
customTagCallback - the callback to register -
-
- -
-
- - - - -
-

- - public - - - - - void - - unregisterFunctionCallMacroCallback - (String customMacroName) -

-
-
- - - -
-
- - - - -

Unregisters any macro callback for the given macro.

-
-
Parameters
- - - - -
customMacroName - the name of the macro which is being unregistered -
-
- -
-
- - - - -
-

- - public - - - - - void - - unregisterFunctionCallTagCallback - (String customTagName) -

-
-
- - - -
-
- - - - -

Unregisters any tag callback for the given tag.

-
-
Parameters
- - - - -
customTagName - the name of the tag which is being unregistered -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.ContainerAvailableListener.html b/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.ContainerAvailableListener.html deleted file mode 100644 index 39c0f0b4166a..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.ContainerAvailableListener.html +++ /dev/null @@ -1,1071 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ContainerHolder.ContainerAvailableListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

ContainerHolder.ContainerAvailableListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.tagmanager.ContainerHolder.ContainerAvailableListener
- - - - - - - -
- - -

Class Overview

-

Listener object that is called when a new container is available. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onContainerAvailable(ContainerHolder containerHolder, String containerVersion) - -
- Called to signify that a new container is available in the container holder. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onContainerAvailable - (ContainerHolder containerHolder, String containerVersion) -

-
-
- - - -
-
- - - - -

Called to signify that a new container is available in the container holder. This - container is not yet active; in order to actually begin using the container, call - getContainer().

-
-
Parameters
- - - - -
containerVersion - the version of the container that is now available -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.html b/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.html deleted file mode 100644 index ebabc632b97f..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/ContainerHolder.html +++ /dev/null @@ -1,1387 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ContainerHolder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

ContainerHolder

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.tagmanager.ContainerHolder
- - - - - - - -
- - -

Class Overview

-

Holder for an active container. This container holder holds a container and also manages new - versions of the container that may become available (through loading a saved version of the - container from disk or from a network refresh). -

- This holder can be a successful Result, in which case getContainer() returns a - non-null container, and getStatus() returns Status.RESULT_SUCCESS, or an - unsuccessful Result in which case getContainer returns null and - getStatus returns an unsuccessful status. -

- When a new version of a container becomes available, if a ContainerHolder.ContainerAvailableListener has - been registered, it will be called. Any subsequent call to getContainer will make that - container active, deactivate any previous container, and return the newly-active container. Only - active containers fire tags; tags in non-active containers never fire. -

- Although the ContainerHolder will download new versions of the container from the network - on a regular basis (approximately every twelve hours), you can make an explicit request to - download a new version with refresh(). -

- If you ever want to stop container refreshing, call release(). Network activity to check - for new versions will stop, and last returned container via - getContainer() will no longer be usable. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceContainerHolder.ContainerAvailableListener - Listener object that is called when a new container is available.  - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Container - - getContainer() - -
- Returns the last loaded container. - - - -
- -
- abstract - - - - - void - - refresh() - -
- Requests a refresh from the network. - - - -
- -
- abstract - - - - - void - - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener listener) - -
- Sets a listener that will be called when a new container becomes available (whether - in response to an explicit refresh() call, via the automatic refreshing that occurs, - or as part of the initial loading of the container). - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Container - - getContainer - () -

-
-
- - - -
-
- - - - -

Returns the last loaded container. If that container is not already active, makes it - active, and makes any previously loaded container inactive. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - refresh - () -

-
-
- - - -
-
- - - - -

Requests a refresh from the network. This call is asynchronous, so the refresh will not - occur immediately. -

- In order to limit the frequency of network communication, the refresh method is throttled. - After you call refresh(), you need to wait at least 15 minutes before calling - this method again, otherwise, the subsequent call will be a no-op. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - setContainerAvailableListener - (ContainerHolder.ContainerAvailableListener listener) -

-
-
- - - -
-
- - - - -

Sets a listener that will be called when a new container becomes available (whether - in response to an explicit refresh() call, via the automatic refreshing that occurs, - or as part of the initial loading of the container). That new - container won't become active until getContainer() is called. -

- If there is a pending container available when the listener is added, it will be called - immediately. -

- The listener will be called on the the looper of the handler with which the container was - loaded, or the main looper if no such handler was provided.

-
-
Parameters
- - - - -
listener - the listener to register (or null to unregister) -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/DataLayer.html b/docs/html/reference/com/google/android/gms/tagmanager/DataLayer.html deleted file mode 100644 index e01d5c776cda..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/DataLayer.html +++ /dev/null @@ -1,1926 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataLayer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataLayer

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.tagmanager.DataLayer
- - - - - - - -
- - -

Class Overview

-

The data layer is a map holding generic information about the application. It uses a standard set - of keys so it can be read by any party that understands the specification. The data layer state - is updated through its API. For example, an app might start with the following dataLayer: - - 

-   {
-     "title": "Original screen title"
-   }
-
- - As the state/data of an app can change, the app can update the dataLayer with a call such as: - - 
-   dataLayer.push(DataLayer.mapOf("title", "New screen title"));
-
- - Now the data layer contains: - - 
-   {
-     "title": "New screen title"
-   }
-
- - After another push happens: - - 
- dataLayer.push(DataLayer.mapOf("xyz", 3));
-
- - The dataLayer contains: - - 
-   {
-     "title": "New screen title",
-     "xyz": 3
-   }
-
- - The following example demonstrates how array and map merging works. If the original dataLayer - contains: - - 
-   {
-     "items": ["item1", null, "item2", {"a": "aValue", "b": "bValue"}]
-   }
-
- - After this push happens: - - 
- dataLayer.push("items", DataLayer.listOf(null, "item6", DataLayer.OBJECT_NOT_PRESENT,
-     DataLayer.mapOf("a", null)));
-
- - The dataLayer contains: - - 
-   {
-     "items": [null, "item6", "item2", {"a": null, "b": "bValue"}]
-   }
-
-

- Pushes happen synchronously; after the push, changes have been reflected in the model. -

- When an event is pushed to the data layer, rules for tags are evaluated and any - tags matching this event will fire. For example, given a container with a tag whose firing rule - is that "event" is equal to "openScreen", after this push: - - 

- dataLayer.pushEvent("openScreen", DataLayer.mapOf());
-
- - that tag will fire. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringEVENT_KEY - If a map is pushed containing this key, it's treated as an event, and tags are evaluated. - - - -
- - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - ObjectOBJECT_NOT_PRESENT - Values of this type used in a List causes the List to be sparse when merging; it's as if - there were no element at that index. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Object - - get(String key) - -
- Returns the object in the model associated with the given key. - - - -
- -
- - - - static - - List<Object> - - listOf(Object... objects) - -
- Utility method that creates a list. - - - -
- -
- - - - static - - Map<String, Object> - - mapOf(Object... objects) - -
- Utility method that creates a map. - - - -
- -
- - - - - - void - - push(Map<String, Object> update) - -
- Merges the given update object into the existing data model, calling any - listeners with the update (after the merge occurs). - - - -
- -
- - - - - - void - - push(String key, Object value) - -
- Pushes a key/value pair of data to the data layer. - - - -
- -
- - - - - - void - - pushEvent(String eventName, Map<String, Object> update) - -
- Pushes an event, along with an update map, to the data layer. - - - -
- -
- - - - - - String - - toString() - -
- Returns a human readable string representing the Data Layer object. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - EVENT_KEY -

-
- - - - -
-
- - - - -

If a map is pushed containing this key, it's treated as an event, and tags are evaluated. -

- - -
- Constant Value: - - - "event" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Object - - OBJECT_NOT_PRESENT -

-
- - - - -
-
- - - - -

Values of this type used in a List causes the List to be sparse when merging; it's as if - there were no element at that index. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Object - - get - (String key) -

-
-
- - - -
-
- - - - -

Returns the object in the model associated with the given key. If the key is not found, - null is returned. -

- The key can can have embedded periods. For example: a key of "a.b.c" - returns a map with key "c" in a map with key - "b" in a map with key "a" in the - model. -

- -
-
- - - - -
-

- - public - static - - - - List<Object> - - listOf - (Object... objects) -

-
-
- - - -
-
- - - - -

Utility method that creates a list. -

- For example, the following creates a list containing "object1" and - "object2": - - 

- List<Object> list = DataLayer.listOf("object1", "object2");
-
-

- -
-
- - - - -
-

- - public - static - - - - Map<String, Object> - - mapOf - (Object... objects) -

-
-
- - - -
-
- - - - -

Utility method that creates a map. The parameters should be pairs of key values. -

- For example, the following creates a map mapping "key1" to - "value1" and "key2" - to "value2": - - 

- Map<String, Object> map = DataLayer.mapOf("key1", "value1",
-         "key2", "value2");
-

-
-
Throws
- - - - -
IllegalArgumentException - if there are an odd number of parameters or a key is not a - string -
-
- -
-
- - - - -
-

- - public - - - - - void - - push - (Map<String, Object> update) -

-
-
- - - -
-
- - - - -

Merges the given update object into the existing data model, calling any - listeners with the update (after the merge occurs). -

- If you want to represent a missing value (like an empty index in a List), use the - OBJECT_NOT_PRESENT object. -

- If another thread is executing a push, this call blocks until that thread is finished. -

- This is normally a synchronous call. However, if, while the thread is executing the push, - another push happens from the same thread, then that second push is asynchronous (the second - push will return before changes have been made to the data layer). This second push from the - same thread can occur, for example, if a data layer push is made in response to a tag firing. -

- If the update contains the key event, rules will be evaluated and - matching tags will fire.

-
-
Parameters
- - - - -
update - the update object to process -
-
- -
-
- - - - -
-

- - public - - - - - void - - push - (String key, Object value) -

-
-
- - - -
-
- - - - -

Pushes a key/value pair of data to the data layer. This is just a convenience method that - calls push(DataLayer.mapOf(key, value)). -

- A key with value event will cause rules to be evaluated and matching tags - to be fired. -

- -
-
- - - - -
-

- - public - - - - - void - - pushEvent - (String eventName, Map<String, Object> update) -

-
-
- - - -
-
- - - - -

Pushes an event, along with an update map, to the data layer. -

- This is just a convenience method that pushes a map containing a key event whose - value is eventName along with the contents of update via - push(Map). -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

Returns a human readable string representing the Data Layer object. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerReceiver.html b/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerReceiver.html deleted file mode 100644 index e07894af3cbd..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerReceiver.html +++ /dev/null @@ -1,1727 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InstallReferrerReceiver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InstallReferrerReceiver

- - - - - - - - - - - - - extends CampaignTrackingReceiver
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.BroadcastReceiver
    ↳com.google.android.gms.analytics.CampaignTrackingReceiver
     ↳com.google.android.gms.tagmanager.InstallReferrerReceiver
- - - - - - - -
- - -

Class Overview

-

The Google Play com.android.vending.INSTALL_REFERRER Intent is broadcast when an - app is installed from the Google Play Store. This BroadcastReceiver listens for that - Intent, passing the install referrer data to GTM for Mobile Apps and Google Analytics. -

- To enable this receiver, add the following to your AndroidManifest.xml file: - - 

- <!-- Used for install referrer tracking-->
- <service android:name="com.google.android.gms.tagmanager.InstallReferrerService"/>
- <receiver
-     android:name="com.google.android.gms.tagmanager.InstallReferrerReceiver"
-     android:exported="true">
-     <intent-filter>
-         <action android:name="com.android.vending.INSTALL_REFERRER" />
-     </intent-filter>
- </receiver>
- 
-
- - This receiver will automatically invoke the Google Analytics receiver to set the - Campaign data. If both the Google Analytics SDK and Google Tag Manager SDKs are in use, - only this receiver needs to be enabled. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - InstallReferrerReceiver() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.CampaignTrackingReceiver - -
- - -
-
- -From class - - android.content.BroadcastReceiver - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - InstallReferrerReceiver - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerService.html b/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerService.html deleted file mode 100644 index 5358f87c1d10..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/InstallReferrerService.html +++ /dev/null @@ -1,6246 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InstallReferrerService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InstallReferrerService

- - - - - - - - - - - - - - - - - - - - - extends CampaignTrackingService
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.analytics.CampaignTrackingService
       ↳com.google.android.gms.tagmanager.InstallReferrerService
- - - - - - - -
- - -

Class Overview

-

IntentService for handling the Google Play Store's INSTALL_REFERRER intent. This service will - be launched from InstallReferrerReceiver. See that class for details. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - InstallReferrerService() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.analytics.CampaignTrackingService - -
- - -
-
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - InstallReferrerService - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/PreviewActivity.html b/docs/html/reference/com/google/android/gms/tagmanager/PreviewActivity.html deleted file mode 100644 index 2866d1a1f1eb..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/PreviewActivity.html +++ /dev/null @@ -1,10264 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PreviewActivity | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - | Inherited Fields - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PreviewActivity

- - - - - - - - - - - - - - - - - - - - - extends Activity
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.view.ContextThemeWrapper
      ↳android.app.Activity
       ↳com.google.android.gms.tagmanager.PreviewActivity
- - - - - - - -
- - -

Class Overview

-

An Activity to preview the app with previewed container version. -

- To use the preview function, the app should add the following snippet into its - AndroidManifest.xml: (where <package_name> needs to be replaced by your package name) -

<activity android:name="com.google.android.gms.tagmanager.PreviewActivity"
-                    android:label="@string/app_name">
-        <intent-filter>
-                <data android:scheme="tagmanager.c.<package_name>" />
-                <action android:name="android.intent.action.VIEW" />
-                <category android:name="android.intent.category.DEFAULT" />
-                <category android:name="android.intent.category.BROWSABLE"/>
-        </intent-filter>
-</activity>
- 
-
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Activity -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Fields
- - From class -android.app.Activity -
- - -
-
- - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PreviewActivity() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - Prepares for previewing a non-published container and then launches - the launch activity for this package. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Activity - -
- - -
-
- -From class - - android.view.ContextThemeWrapper - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.view.LayoutInflater.Factory2 - -
- - -
-
- -From interface - - android.view.Window.Callback - -
- - -
-
- -From interface - - android.view.KeyEvent.Callback - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.view.LayoutInflater.Factory - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PreviewActivity - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- - Prepares for previewing a non-published container and then launches - the launch activity for this package. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/TagManager.html b/docs/html/reference/com/google/android/gms/tagmanager/TagManager.html deleted file mode 100644 index 8e2b682fd2e5..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/TagManager.html +++ /dev/null @@ -1,2181 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -TagManager | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

TagManager

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.tagmanager.TagManager
- - - - - - - -
- - -

Class Overview

-

This is the mobile implementation of Google Tag Manager (GTM). Sample usage: - - 

- TagManager tagManager = TagManager.getInstance(context);
- PendingResult pending = tagManager.loadContainerPreferNonDefault(
-         myContainerId,    // container ID of the form "GTM-XXXX"
-         R.raw.GTM-XXXX,   // the resource ID of the default container
-         true);            // the default container is in JSON format (as opposed to binary)
- ...
- ContainerHolder containerHolder = pending.await(2, TimeUnit.SECONDS);
- if (containerHolder.getStatus() != Status.RESULT_SUCCESS) {
-        // deal with failure
- }
- String value = containerHolder.getContainer().getString("myKey");
-
- DataLayer dataLayer = TagManager.getInstance(context).getDataLayer();
- dataLayer.pushEvent("openScreen", DataLayer.mapOf("screenName", "Main Page"));
-
- - A container is a collection of macros, tags and rules. It is created within the GTM application, and is assigned a container ID. This - container ID is the one used within this API. -

- The Container class provides methods for retrieving values given a key. The routines - getBoolean(String), getDouble(String), - getLong(String), getString(String) return the current value - for the key of a value collection macro, depending on the rules associated with the container. -

- As an example, if your container has a value collection macro with a key speed whose - value is 32, and the enabling rule is Language is "en"; and another value collection - macro with a key speed whose value is 45, and the enabling rule is Language is - not "en", then making the following call: - - 

- container.getLong("speed")
-
- - will return either 32 if the current language of the device is English, or 45 otherwise. -

- The data layer is a map holding generic information about the application. The DataLayer - class provides methods to push and retrieve data from the data layer. Pushing an - event key to the data layer will cause tags that match this event to fire. -

- An initial version of the container is bundled with the application. It should be placed as a - raw resource in the res/raw directory. When you call one of the - loadContainer... methods, you'll pass in the assigned ID (R.raw.filename); the - container will be returned with those bundled rules/macros. You will create the container in the - UI and use the Download button to download it. Alternatively, you can provide a JSON file - containing key/value pairs. -

- You can modify the container in the UI and publish a new version. In that case, the next time the - mobile app refreshes the container from the network (currently every 12 hours), it will get that - new version. When you call getContainer(), it'll make that new container - active and return it. Calling one of the get... routines on that container will return - a value computed using the most recent rules. -

- The downloaded container is saved locally; when you call one of the loadContainer... - methods, it will first load the default container, and will then load any saved container. If - none is found, or if it is older than 12 hours, it will try to retrieve a newer version from the - network. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - dispatch() - -
- Manually dispatches queued events (tracking pixels, etc) if a network connection is - available. - - - -
- -
- - - - - - DataLayer - - getDataLayer() - -
- Returns the data layer object that is used by the tag manager. - - - -
- -
- - - - static - - TagManager - - getInstance(Context context) - -
- Get the singleton instance of the TagManager class, creating it if necessary. - - - -
- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerDefaultOnly(String containerId, int defaultContainerResourceId, Handler handler) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as either of the following happens: -

    -
  • the default container is loaded, or -
  • no default container is found. - - - -
- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerDefaultOnly(String containerId, int defaultContainerResourceId) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as either of the following happens: -

    -
  • the default container is loaded, or -
  • no default container is found. - - - -
- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerPreferFresh(String containerId, int defaultContainerResourceId) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerPreferFresh(String containerId, int defaultContainerResourceId, Handler handler) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerPreferNonDefault(String containerId, int defaultContainerResourceId) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

- -
- - - - - - PendingResult<ContainerHolder> - - loadContainerPreferNonDefault(String containerId, int defaultContainerResourceId, Handler handler) - -
-

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

- -
- - - - - - void - - setVerboseLoggingEnabled(boolean enableVerboseLogging) - -
- Sets whether or not verbose logging is enabled. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - dispatch - () -

-
-
- - - -
-
- - - - -

Manually dispatches queued events (tracking pixels, etc) if a network connection is - available. Dispatching after significant application events can help to ensure - accurate reporting. Calling dispatch frequently can cause excessive battery drain and should - be avoided. -

- -
-
- - - - -
-

- - public - - - - - DataLayer - - getDataLayer - () -

-
-
- - - -
-
- - - - -

Returns the data layer object that is used by the tag manager. -

- -
-
- - - - -
-

- - public - static - - - - TagManager - - getInstance - (Context context) -

-
-
- - - -
-
- - - - -

Get the singleton instance of the TagManager class, creating it if necessary. -

- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerDefaultOnly - (String containerId, int defaultContainerResourceId, Handler handler) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as either of the following happens: -

    -
  • the default container is loaded, or -
  • no default container is found. -
-

If no default container is found, - getContainer() will return null and - getStatus() will return an error). - -

The returned ContainerHolder will not be updated from disk, or from the network. - The intended use is during development: this provides a way for developers to add new - container key/value pairs without having to use the GTM UI or needing a network connection. - A developer can add new key/value pairs to a JSON default container, and then use this call - to load that container. - -

You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging.

-
-
Parameters
- - - - - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY).
handler - the handler on whose thread the callback set with - setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener) - is invoked -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerDefaultOnly - (String containerId, int defaultContainerResourceId) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as either of the following happens: -

    -
  • the default container is loaded, or -
  • no default container is found. -
-

If no default container is found, - getContainer() will return null and - getStatus() will return an error). - -

The returned ContainerHolder will not be updated from disk, or from the network. - The intended use is during development: this provides a way for developers to add new - container key/value pairs without having to use the GTM UI or needing a network connection. - A developer can add new key/value pairs to a JSON default container, and then use this call - to load that container. - -

You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging. - -

Any callback set by setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener), - will be invoked on the main looper thread.

-
-
Parameters
- - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY). -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerPreferFresh - (String containerId, int defaultContainerResourceId) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

-

- If a timeout occurs, the container available from getContainer() will - be: -

    -
  • a saved container which has not recently been refreshed (stale). -
  • a default container (if no stale container is available, or could not be loaded before - the timeout). -
  • null (if no default container is available, or a saved or default container - couldn't be loaded before the timeout). In this case, getStatus() will - return an error. -
- Use isDefault() if you need to know whether the container you have is a - default container. Use getLastRefreshTime() to determine when the container - was last refreshed. -

- You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging. -

-

Any callback set by setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener), - will be invoked on the main looper thread.

-
-
Parameters
- - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY). Pass -1 if you have - no default container. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerPreferFresh - (String containerId, int defaultContainerResourceId, Handler handler) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

-

If a timeout occurs, the container available from getContainer() - will be: -

    -
  • a saved container which has not recently been refreshed (stale). -
  • a default container (if no stale container is available, or could not be loaded before - the timeout). -
  • null (if no default container is available, or a saved or default container - couldn't be loaded before the timeout). In this case, getStatus() - will return an error. -
- - Use isDefault() if you need to know whether the container you have is a - default container. Use getLastRefreshTime() to determine when the container - was last refreshed. -

-

You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging.

-
-
Parameters
- - - - - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY). Pass -1 if you have no default container.
handler - the handler on whose thread the callback set with - setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener) - is invoked -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerPreferNonDefault - (String containerId, int defaultContainerResourceId) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

-

If a timeout occurs, the container available from getContainer() - will (initially) be a default container, if available (if no default container is available, - getContainer() will return null and - getStatus() will return an error). Use isDefault() if - you need to know whether the container you have is a default container. - -

You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging. - -

Any callback set by setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener), - will be invoked on the main looper thread.

-
-
Parameters
- - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY). Pass -1 if you have no default container. -
-
- -
-
- - - - -
-

- - public - - - - - PendingResult<ContainerHolder> - - loadContainerPreferNonDefault - (String containerId, int defaultContainerResourceId, Handler handler) -

-
-
- - - -
-
- - - - -

The ContainerHolder will be available from the returned PendingResult as - soon as one of the following happens: -

- -

If a timeout occurs, the container available from getContainer() - will (initially) be a default container, if available (if no default container is available, - getContainer() will return null and - getStatus() will return an error). Use isDefault() if - you need to know whether the container you have is a default container. - - -

You should not call any of the loadContainer methods a second time with a given - containerId, since a different ContainerHolder will be returned which will - hold a different container. Those separate containers will each fire any tags within them, - which would cause double-tagging.

-
-
Parameters
- - - - - - - - - - -
containerId - the ID of the container to load
defaultContainerResourceId - the resource ID of the default container (for example, - R.raw.GTM_XYZZY if you stored your container in - res/raw/GTM_XYZZY). Pass -1 if you have no default container.
handler - the handler on whose thread the callback set with - setResultCallback(ResultCallback) or - setContainerAvailableListener(ContainerHolder.ContainerAvailableListener) - is invoked -
-
- -
-
- - - - -
-

- - public - - - - - void - - setVerboseLoggingEnabled - (boolean enableVerboseLogging) -

-
-
- - - -
-
- - - - -

Sets whether or not verbose logging is enabled. By default, verbose logging is not enabled. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/tagmanager/package-summary.html b/docs/html/reference/com/google/android/gms/tagmanager/package-summary.html deleted file mode 100644 index 1caa5120f4e0..000000000000 --- a/docs/html/reference/com/google/android/gms/tagmanager/package-summary.html +++ /dev/null @@ -1,995 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.tagmanager | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.tagmanager

-
- -
- -
- - - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Container.FunctionCallMacroCallback - Callback that is provided by the application to calculate the value of a custom macro.  - - - -
Container.FunctionCallTagCallback - Callback that is provided by the application to execute a custom tag.  - - - -
ContainerHolder - Holder for an active container.  - - - -
ContainerHolder.ContainerAvailableListener - Listener object that is called when a new container is available.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Container - An object that provides access to container values.  - - - -
DataLayer - The data layer is a map holding generic information about the application.  - - - -
InstallReferrerReceiver - The Google Play com.android.vending.INSTALL_REFERRER Intent is broadcast when an - app is installed from the Google Play Store.  - - - -
InstallReferrerService - IntentService for handling the Google Play Store's INSTALL_REFERRER intent.  - - - -
PreviewActivity - An Activity to preview the app with previewed container version.  - - - -
TagManager - This is the mobile implementation of Google Tag Manager (GTM).  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Address.html b/docs/html/reference/com/google/android/gms/wallet/Address.html deleted file mode 100644 index ac6dc62e6442..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Address.html +++ /dev/null @@ -1,2185 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Address | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Address

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Address
- - - - - - - -
- - -

Class Overview

-

Parcelable representing an address. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<Address>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getAddress1() - -
- - - - - - String - - getAddress2() - -
- - - - - - String - - getAddress3() - -
- - - - - - String - - getCity() - -
- - - - - - String - - getCompanyName() - -
- - - - - - String - - getCountryCode() - -
- - - - - - String - - getName() - -
- - - - - - String - - getPhoneNumber() - -
- - - - - - String - - getPostalCode() - -
- - - - - - String - - getState() - -
- - - - - - int - - getVersionCode() - -
- - - - - - boolean - - isPostBox() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<Address> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAddress1 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The first line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress2 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The second line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAddress3 - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The third line of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCity - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The city. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCompanyName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The company name of the address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCountryCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The ISO-3166 country code. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Name of the person at this address. This is the name on the credit card for a - billing address or a recipient for a shipping address. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPhoneNumber - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The billing phone number associated with the address. Will only be returned if - requested in the MaskedWalletRequest. Note: This could be an international phone - number. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPostalCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The postal code. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - String - - getState - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The state. If omitted, defaults to "". -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isPostBox - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Whether the address is a post box or not. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Cart.Builder.html b/docs/html/reference/com/google/android/gms/wallet/Cart.Builder.html deleted file mode 100644 index 1dd0ced4fa16..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Cart.Builder.html +++ /dev/null @@ -1,1530 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cart.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Cart.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Cart.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a Cart. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Cart.Builder - - addLineItem(LineItem lineItem) - -
- Adds a line item to the shopping cart. - - - -
- -
- - - - - - Cart - - build() - -
- - - - - - Cart.Builder - - setCurrencyCode(String currencyCode) - -
- Required field. - - - -
- -
- - - - - - Cart.Builder - - setLineItems(List<LineItem> lineItems) - -
- Sets the line items in the shopping cart. - - - -
- -
- - - - - - Cart.Builder - - setTotalPrice(String totalPrice) - -
- Required field. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Cart.Builder - - addLineItem - (LineItem lineItem) -

-
-
- - - -
-
- - - - -

Adds a line item to the shopping cart. -

- -
-
- - - - -
-

- - public - - - - - Cart - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Cart.Builder - - setCurrencyCode - (String currencyCode) -

-
-
- - - -
-
- - - - -

Required field. Sets the ISO 4217 currency code of the transaction. -

- -
-
- - - - -
-

- - public - - - - - Cart.Builder - - setLineItems - (List<LineItem> lineItems) -

-
-
- - - -
-
- - - - -

Sets the line items in the shopping cart. Removes any previous line items associated with - this cart. -

- -
-
- - - - -
-

- - public - - - - - Cart.Builder - - setTotalPrice - (String totalPrice) -

-
-
- - - -
-
- - - - -

Required field. Sets the total price of the cart. The format of this string follows the - regex: [0-9]+(\.[0-9][0-9])? -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Cart.html b/docs/html/reference/com/google/android/gms/wallet/Cart.html deleted file mode 100644 index 46198a788091..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Cart.html +++ /dev/null @@ -1,1834 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Cart | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Cart

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Cart
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a shopping cart. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classCart.Builder - Builder to create a Cart.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<Cart>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getCurrencyCode() - -
- - - - - - ArrayList<LineItem> - - getLineItems() - -
- - - - - - String - - getTotalPrice() - -
- - - - - - int - - getVersionCode() - -
- - - - static - - Cart.Builder - - newBuilder() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<Cart> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCurrencyCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the ISO 4217 currency code of the transaction -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<LineItem> - - getLineItems - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the line items in the cart -
-
- -
-
- - - - -
-

- - public - - - - - String - - getTotalPrice - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the total price -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - Cart.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/CountrySpecification.html b/docs/html/reference/com/google/android/gms/wallet/CountrySpecification.html deleted file mode 100644 index 76a04edb4a38..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/CountrySpecification.html +++ /dev/null @@ -1,1740 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CountrySpecification | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

CountrySpecification

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.CountrySpecification
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a country. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<CountrySpecification>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - CountrySpecification(String countryCode) - -
- Constructs a country specification based on a country code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getCountryCode() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<CountrySpecification> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - CountrySpecification - (String countryCode) -

-
-
- - - -
-
- - - - -

Constructs a country specification based on a country code. - - Country code should follow the ISO 3166-2 format (ex: "US", "CA", "JP"). Providing a - country code that is not supported or malformed will return - ERROR_CODE_INVALID_PARAMETERS.

-
-
Parameters
- - - - -
countryCode - an ISO 3166-2 formatted country code -
-
- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCountryCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the country code for this specification. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/EnableWalletOptimizationReceiver.html b/docs/html/reference/com/google/android/gms/wallet/EnableWalletOptimizationReceiver.html deleted file mode 100644 index 71770799433d..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/EnableWalletOptimizationReceiver.html +++ /dev/null @@ -1,1708 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -EnableWalletOptimizationReceiver | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

EnableWalletOptimizationReceiver

- - - - - - - - - extends BroadcastReceiver
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.BroadcastReceiver
    ↳com.google.android.gms.wallet.EnableWalletOptimizationReceiver
- - - - - - - -
- - -

Class Overview

-

A dummy BroadcastReceiver used with an IntentFilter specifying action - ACTION_ENABLE_WALLET_OPTIMIZATION to signal that your application uses - Wallet. See ACTION_ENABLE_WALLET_OPTIMIZATION for details of using it. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - EnableWalletOptimizationReceiver() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - void - - onReceive(Context context, Intent intent) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.content.BroadcastReceiver - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - EnableWalletOptimizationReceiver - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - void - - onReceive - (Context context, Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/FullWallet.html b/docs/html/reference/com/google/android/gms/wallet/FullWallet.html deleted file mode 100644 index 4c15522dfafe..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/FullWallet.html +++ /dev/null @@ -1,2189 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FullWallet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

FullWallet

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.FullWallet
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a full wallet response. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<FullWallet>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - Address - - getBillingAddress() - -
- - This method is deprecated. - Use getBuyerBillingAddress() instead. - - - - -
- -
- - - - - - UserAddress - - getBuyerBillingAddress() - -
- - - - - - UserAddress - - getBuyerShippingAddress() - -
- - - - - - String - - getEmail() - -
- - - - - - String - - getGoogleTransactionId() - -
- - - - - - InstrumentInfo[] - - getInstrumentInfos() - -
- Returns an array of finer grained details about the instruments used in this Google Wallet - transaction. - - - -
- -
- - - - - - String - - getMerchantTransactionId() - -
- - - - - - String[] - - getPaymentDescriptions() - -
- Returns an array of strings used for user-facing messaging about payment instruments used - for funding this Google Wallet transaction. - - - -
- -
- - - - - - ProxyCard - - getProxyCard() - -
- - - - - - Address - - getShippingAddress() - -
- - This method is deprecated. - Use getBuyerShippingAddress() instead. - - - - -
- -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<FullWallet> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Address - - getBillingAddress - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getBuyerBillingAddress() instead. - -

-

-
-
Returns
-
  • Billing address associated with the payment instrument.
-
- -
-
- - - - -
-

- - public - - - - - UserAddress - - getBuyerBillingAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the billing address associated with the buyer's payment instrument -
-
- -
-
- - - - -
-

- - public - - - - - UserAddress - - getBuyerShippingAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the buyer's shipping address -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEmail - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • buyer's email -
-
- -
-
- - - - -
-

- - public - - - - - String - - getGoogleTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Google's unique identifier for this transaction, will be identical to the value - passed in FullWalletRequest. -
-
- -
-
- - - - -
-

- - public - - - - - InstrumentInfo[] - - getInstrumentInfos - () -

-
-
- - - -
-
- - - - -

Returns an array of finer grained details about the instruments used in this Google Wallet - transaction. Details here can be parsed and used for customer support, etc..., but - should not be displayed to the user. -

- NOTE: This list of details is not guaranteed to have the same ordering or length as - getPaymentDescriptions().

-
-
Returns
-
  • list of instrument info (if available), otherwise null. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMerchantTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • An optional merchant identifier for this transaction, will be identical to the value - passed in FullWalletRequest -
-
- -
-
- - - - -
-

- - public - - - - - String[] - - getPaymentDescriptions - () -

-
-
- - - -
-
- - - - -

Returns an array of strings used for user-facing messaging about payment instruments used - for funding this Google Wallet transaction. Do not attempt to parse the contents of this - array as the format, contents and length may change at any time. -

- IMPORTANT: This list is sorted in the order of how messages should be displayed. You - are required to show each of these sources to inform the buyer of their funding sources for - the transaction. See Google Wallet UI guide for details. Each payment description is not - guaranteed to match a consistent pattern and you should not try to parse this data. See - getInstrumentInfos() for a stable API of instrument information.

-
-
Returns
-
  • A list of user-facing messages about payment instruments used to fund the Google - Wallet transaction. -
-
- -
-
- - - - -
-

- - public - - - - - ProxyCard - - getProxyCard - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The one-time credit card to use for payment processing -
-
- -
-
- - - - -
-

- - public - - - - - Address - - getShippingAddress - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getBuyerShippingAddress() instead. - -

-

-
-
Returns
-
  • Buyer's shipping address
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.Builder.html b/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.Builder.html deleted file mode 100644 index e47b4d21f0ef..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.Builder.html +++ /dev/null @@ -1,1477 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FullWalletRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

FullWalletRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.FullWalletRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a FullWalletRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - FullWalletRequest - - build() - -
- - - - - - FullWalletRequest.Builder - - setCart(Cart cart) - -
- Sets the shopping cart. - - - -
- -
- - - - - - FullWalletRequest.Builder - - setGoogleTransactionId(String googleTransactionId) - -
- Sets Google's unique identifier for this transaction. - - - -
- -
- - - - - - FullWalletRequest.Builder - - setMerchantTransactionId(String merchantTransactionId) - -
- Sets an optional merchant identifier for the transaction. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - FullWalletRequest - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - FullWalletRequest.Builder - - setCart - (Cart cart) -

-
-
- - - -
-
- - - - -

Sets the shopping cart. This field is required unless this request is for a billing - agreement. If this request is for a billing agreement, this field is inapplicable and - should not be set. -

- -
-
- - - - -
-

- - public - - - - - FullWalletRequest.Builder - - setGoogleTransactionId - (String googleTransactionId) -

-
-
- - - -
-
- - - - -

Sets Google's unique identifier for this transaction. This field is required and must be - identical to the value returned in an earlier MaskedWallet in the same - transaction. -

- -
-
- - - - -
-

- - public - - - - - FullWalletRequest.Builder - - setMerchantTransactionId - (String merchantTransactionId) -

-
-
- - - -
-
- - - - -

Sets an optional merchant identifier for the transaction. The value will be echoed back - in FullWallet, but is not otherwise used by the Wallet API. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.html b/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.html deleted file mode 100644 index 00a8404d882a..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/FullWalletRequest.html +++ /dev/null @@ -1,1834 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -FullWalletRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

FullWalletRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.FullWalletRequest
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a full wallet request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classFullWalletRequest.Builder - Builder to create a FullWalletRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<FullWalletRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - Cart - - getCart() - -
- - - - - - String - - getGoogleTransactionId() - -
- - - - - - String - - getMerchantTransactionId() - -
- - - - - - int - - getVersionCode() - -
- - - - static - - FullWalletRequest.Builder - - newBuilder() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<FullWalletRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Cart - - getCart - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the shopping cart -
-
- -
-
- - - - -
-

- - public - - - - - String - - getGoogleTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Google's unique identifier for this transaction -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMerchantTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • an optional merchant identifier for the transaction -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - FullWalletRequest.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/GiftCardWalletObject.html b/docs/html/reference/com/google/android/gms/wallet/GiftCardWalletObject.html deleted file mode 100644 index 68e804d08e58..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/GiftCardWalletObject.html +++ /dev/null @@ -1,1652 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GiftCardWalletObject | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

GiftCardWalletObject

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.GiftCardWalletObject
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a gift card wallet object. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<GiftCardWalletObject>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getId() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<GiftCardWalletObject> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The unique identifier for this Wallet Object. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/InstrumentInfo.html b/docs/html/reference/com/google/android/gms/wallet/InstrumentInfo.html deleted file mode 100644 index 277a223df198..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/InstrumentInfo.html +++ /dev/null @@ -1,1749 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -InstrumentInfo | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

InstrumentInfo

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.InstrumentInfo
- - - - - - - -
- - -

Class Overview

-

Parcelable representing more detailed information about a payment instrument. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<InstrumentInfo>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getInstrumentDetails() - -
- Details of an instrument that has a finite set of formats. - - - -
- -
- - - - - - String - - getInstrumentType() - -
- Type of an instrument that has a finite set of values. - - - -
- -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<InstrumentInfo> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getInstrumentDetails - () -

-
-
- - - -
-
- - - - -

Details of an instrument that has a finite set of formats. These details should not - be displayed to the user, but can be used when the details of a user's instrument - are needed. An example would be a customer support call when the user only knows that one of - their credit cards were charged. -

- You can rely on the format of instrument details not changing once it is defined for a - given form of payment in a transaction (i.e. Instrument details of a credit card are always - the last four digits of the card). However, you should be able to handle new formats that - could be introduced in the future (i.e. InstantBuy adds support for a new form of payment - where last four credit card digits has no meaning and other information is returned). -

- Current expected formats for elements of this array are: -

    -
  • Credit cards return the last four digits of the card selected
    • -

-
-
Returns
-
  • instrument details that will not be null, but can be the empty string -
-
- -
-
- - - - -
-

- - public - - - - - String - - getInstrumentType - () -

-
-
- - - -
-
- - - - -

Type of an instrument that has a finite set of values. This type should not - be displayed to the user, but can be used when the details of a user's instrument are needed. - An example would be a customer support call when the user only knows that one of their credit - cards were charged. -

- You can rely on an instrument type not changing once it is defined for a given instrument - in a transaction (i.e. Purchasing with a single Visa card will always return VISA). However, - you should be able to handle elements that are not defined in the expected list below - (i.e. InstantBuy adds support for a new form of of payment not listed below). -

- Current expected values for elements of this array are: -

    -
  • VISA
    • -
  • MASTERCARD
    • -
  • DISCOVER
    • -
  • AMEX
    • -

-
-
Returns
-
  • an instrument type that will be non-empty -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/LineItem.Builder.html b/docs/html/reference/com/google/android/gms/wallet/LineItem.Builder.html deleted file mode 100644 index 42a2253d61b4..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/LineItem.Builder.html +++ /dev/null @@ -1,1649 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LineItem.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LineItem.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.LineItem.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a LineItem. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - LineItem - - build() - -
- - - - - - LineItem.Builder - - setCurrencyCode(String currencyCode) - -
- Sets the ISO 4217 currency code of the transaction. - - - -
- -
- - - - - - LineItem.Builder - - setDescription(String description) - -
- Sets the description of the line item. - - - -
- -
- - - - - - LineItem.Builder - - setQuantity(String quantity) - -
- Sets the number of items purchased. - - - -
- -
- - - - - - LineItem.Builder - - setRole(int role) - -
- Supply the role only to distinguish tax and shipping from regular items. - - - -
- -
- - - - - - LineItem.Builder - - setTotalPrice(String totalPrice) - -
- Sets the total price for this line item. - - - -
- -
- - - - - - LineItem.Builder - - setUnitPrice(String unitPrice) - -
- Sets the unit price per item. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - LineItem - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setCurrencyCode - (String currencyCode) -

-
-
- - - -
-
- - - - -

Sets the ISO 4217 currency code of the transaction. -

- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setDescription - (String description) -

-
-
- - - -
-
- - - - -

Sets the description of the line item. -

- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setQuantity - (String quantity) -

-
-
- - - -
-
- - - - -

Sets the number of items purchased. The format of this string follows the regex: - [0-9]+(\.[0-9])? -

- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setRole - (int role) -

-
-
- - - -
-
- - - - -

Supply the role only to distinguish tax and shipping from regular items. Valid values - are defined in LineItem.Role. Defaults to REGULAR, indicating a regular item. - Only one TAX entry is permitted.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setTotalPrice - (String totalPrice) -

-
-
- - - -
-
- - - - -

Sets the total price for this line item. The format of this string follows the regex: - ^-?[0-9]+(\.[0-9][0-9])? -

- -
-
- - - - -
-

- - public - - - - - LineItem.Builder - - setUnitPrice - (String unitPrice) -

-
-
- - - -
-
- - - - -

Sets the unit price per item. The format of this string follows the regex: - ^-?[0-9]+(\.[0-9][0-9])? -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/LineItem.Role.html b/docs/html/reference/com/google/android/gms/wallet/LineItem.Role.html deleted file mode 100644 index 8879b87a862b..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/LineItem.Role.html +++ /dev/null @@ -1,1172 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LineItem.Role | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

LineItem.Role

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.LineItem.Role
- - - - - - - -
- - -

Class Overview

-

Role of a line item.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intREGULAR - Regular item. - - - -
intSHIPPING - Shipping cost item. - - - -
intTAX - Tax item. - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - REGULAR -

-
- - - - -
-
- - - - -

Regular item. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SHIPPING -

-
- - - - -
-
- - - - -

Shipping cost item. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TAX -

-
- - - - -
-
- - - - -

Tax item. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/LineItem.html b/docs/html/reference/com/google/android/gms/wallet/LineItem.html deleted file mode 100644 index b618f609b7ea..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/LineItem.html +++ /dev/null @@ -1,2014 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LineItem | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LineItem

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.LineItem
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a line item in a shopping cart. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classLineItem.Builder - Builder to create a LineItem.  - - - -
- - - - - interfaceLineItem.Role - Role of a line item.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<LineItem>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getCurrencyCode() - -
- - - - - - String - - getDescription() - -
- - - - - - String - - getQuantity() - -
- - - - - - int - - getRole() - -
- - - - - - String - - getTotalPrice() - -
- - - - - - String - - getUnitPrice() - -
- - - - - - int - - getVersionCode() - -
- - - - static - - LineItem.Builder - - newBuilder() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<LineItem> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCurrencyCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the ISO 4217 currency code of the transaction -
-
- -
-
- - - - -
-

- - public - - - - - String - - getDescription - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the description -
-
- -
-
- - - - -
-

- - public - - - - - String - - getQuantity - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the quantity -
-
- -
-
- - - - -
-

- - public - - - - - int - - getRole - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the role
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - String - - getTotalPrice - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the total price -
-
- -
-
- - - - -
-

- - public - - - - - String - - getUnitPrice - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the unit price -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - LineItem.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/LoyaltyWalletObject.html b/docs/html/reference/com/google/android/gms/wallet/LoyaltyWalletObject.html deleted file mode 100644 index 8adcc8310efb..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/LoyaltyWalletObject.html +++ /dev/null @@ -1,2025 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -LoyaltyWalletObject | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

LoyaltyWalletObject

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.LoyaltyWalletObject
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a loyalty wallet object. An example loyalty wallet object could be a - rewards membership where the membership id is placed in the accountId. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<LoyaltyWalletObject>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getAccountId() - -
- - - - - - String - - getAccountName() - -
- - - - - - String - - getBarcodeAlternateText() - -
- - - - - - String - - getBarcodeType() - -
- - - - - - String - - getBarcodeValue() - -
- - - - - - String - - getId() - -
- - - - - - String - - getIssuerName() - -
- - - - - - String - - getProgramName() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<LoyaltyWalletObject> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAccountId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Loyalty account identifier to be displayed to the user (ex: "12345678"). -
-
- -
-
- - - - -
-

- - public - - - - - String - - getAccountName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Loyalty account holder name (ex: "John Smith"). -
-
- -
-
- - - - -
-

- - public - - - - - String - - getBarcodeAlternateText - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Human-readable text to display to the user in addition to the encoded barcode value - (ex: "3492013"). -
-
- -
-
- - - - -
-

- - public - - - - - String - - getBarcodeType - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Barcode type. Possible values include "codabar", "qrCode", "textOnly", etc... -
-
- -
-
- - - - -
-

- - public - - - - - String - - getBarcodeValue - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Encoded barcode value. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The unique identifier for this Wallet Object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getIssuerName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The name of who issued this loyalty object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getProgramName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The name of the loyalty program associated to this object. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.Builder.html b/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.Builder.html deleted file mode 100644 index 97c018719e8b..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.Builder.html +++ /dev/null @@ -1,1832 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MaskedWallet.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MaskedWallet.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.MaskedWallet.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a MaskedWallet. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MaskedWallet - - build() - -
- - - - - - MaskedWallet.Builder - - setBillingAddress(Address billingAddress) - -
- - - - - - MaskedWallet.Builder - - setBuyerBillingAddress(UserAddress buyerBillingAddress) - -
- - - - - - MaskedWallet.Builder - - setBuyerShippingAddress(UserAddress buyerShippingAddress) - -
- - - - - - MaskedWallet.Builder - - setEmail(String email) - -
- - - - - - MaskedWallet.Builder - - setGoogleTransactionId(String googleTransactionId) - -
- - - - - - MaskedWallet.Builder - - setInstrumentInfos(InstrumentInfo[] instrumentInfos) - -
- - - - - - MaskedWallet.Builder - - setLoyaltyWalletObjects(LoyaltyWalletObject[] loyaltyWalletObjects) - -
- - - - - - MaskedWallet.Builder - - setMerchantTransactionId(String merchantTransactionId) - -
- - - - - - MaskedWallet.Builder - - setOfferWalletObjects(OfferWalletObject[] offerWalletObjects) - -
- - - - - - MaskedWallet.Builder - - setPaymentDescriptions(String[] paymentDescriptions) - -
- - - - - - MaskedWallet.Builder - - setShippingAddress(Address shippingAddress) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MaskedWallet - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setBillingAddress - (Address billingAddress) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setBuyerBillingAddress - (UserAddress buyerBillingAddress) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setBuyerShippingAddress - (UserAddress buyerShippingAddress) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setEmail - (String email) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setGoogleTransactionId - (String googleTransactionId) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setInstrumentInfos - (InstrumentInfo[] instrumentInfos) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setLoyaltyWalletObjects - (LoyaltyWalletObject[] loyaltyWalletObjects) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setMerchantTransactionId - (String merchantTransactionId) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setOfferWalletObjects - (OfferWalletObject[] offerWalletObjects) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setPaymentDescriptions - (String[] paymentDescriptions) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet.Builder - - setShippingAddress - (Address shippingAddress) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.html b/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.html deleted file mode 100644 index e36f8458baa3..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/MaskedWallet.html +++ /dev/null @@ -1,2318 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MaskedWallet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MaskedWallet

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.MaskedWallet
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a masked wallet response. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMaskedWallet.Builder - Builder to create a MaskedWallet.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<MaskedWallet>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - Address - - getBillingAddress() - -
- - This method is deprecated. - Use getBuyerBillingAddress() instead. - - - - -
- -
- - - - - - UserAddress - - getBuyerBillingAddress() - -
- - - - - - UserAddress - - getBuyerShippingAddress() - -
- - - - - - String - - getEmail() - -
- - - - - - String - - getGoogleTransactionId() - -
- - - - - - InstrumentInfo[] - - getInstrumentInfos() - -
- Returns an array of finer grained details about the instruments used in this Google Wallet - transaction. - - - -
- -
- - - - - - LoyaltyWalletObject[] - - getLoyaltyWalletObjects() - -
- - - - - - String - - getMerchantTransactionId() - -
- - - - - - OfferWalletObject[] - - getOfferWalletObjects() - -
- - - - - - String[] - - getPaymentDescriptions() - -
- Returns an array of strings used for user-facing messaging about payment instruments used - for funding this Google Wallet transaction. - - - -
- -
- - - - - - Address - - getShippingAddress() - -
- - This method is deprecated. - Use getBuyerShippingAddress() instead. - - - - -
- -
- - - - - - int - - getVersionCode() - -
- - - - static - - MaskedWallet.Builder - - newBuilderFrom(MaskedWallet maskedWallet) - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<MaskedWallet> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Address - - getBillingAddress - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getBuyerBillingAddress() instead. - -

-

-
-
Returns
-
  • Billing address associated with the payment instrument.
-
- -
-
- - - - -
-

- - public - - - - - UserAddress - - getBuyerBillingAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • address associated with the buyer's payment instrument -
-
- -
-
- - - - -
-

- - public - - - - - UserAddress - - getBuyerShippingAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • buyer's shipping address -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEmail - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • buyer's email. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getGoogleTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Google's unique identifier for this transaction. You will store this in your - application. Its value is required to be in the googleTransactionId field on all subsequent - change masked wallet and full wallet requests pertaining to this transaction. -
-
- -
-
- - - - -
-

- - public - - - - - InstrumentInfo[] - - getInstrumentInfos - () -

-
-
- - - -
-
- - - - -

Returns an array of finer grained details about the instruments used in this Google Wallet - transaction. Details here can be parsed and used for customer support, etc..., but - should not be displayed to the user. -

- NOTE: This list of details is not guaranteed to have the same ordering or length as - getPaymentDescriptions().

-
-
Returns
-
  • list of instrument info (if available), otherwise null. -
-
- -
-
- - - - -
-

- - public - - - - - LoyaltyWalletObject[] - - getLoyaltyWalletObjects - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Buyer's loyalty wallet objects -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMerchantTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - OfferWalletObject[] - - getOfferWalletObjects - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Buyer's offer wallet objects -
-
- -
-
- - - - -
-

- - public - - - - - String[] - - getPaymentDescriptions - () -

-
-
- - - -
-
- - - - -

Returns an array of strings used for user-facing messaging about payment instruments used - for funding this Google Wallet transaction. Do not attempt to parse the contents of this - array as the format, contents and length may change at any time. -

- IMPORTANT: This list is sorted in the order of how messages should be displayed. You - are required to show each of these sources to inform the buyer of their funding sources for - the transaction. See Google Wallet UI guide for details. Each payment description is not - guaranteed to match a consistent pattern and you should not try to parse this data. See - getInstrumentInfos() for a stable API of instrument information.

-
-
Returns
-
  • A list of user-facing messages about payment instruments used to fund the Google - Wallet transaction. -
-
- -
-
- - - - -
-

- - public - - - - - Address - - getShippingAddress - () -

-
-
- - - -
-
- - - -

-

- This method is deprecated.
- Use getBuyerShippingAddress() instead. - -

-

-
-
Returns
-
  • Buyer's shipping address
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - MaskedWallet.Builder - - newBuilderFrom - (MaskedWallet maskedWallet) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.Builder.html b/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.Builder.html deleted file mode 100644 index 0fc3a7fb2326..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.Builder.html +++ /dev/null @@ -1,2109 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MaskedWalletRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MaskedWalletRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.MaskedWalletRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a MaskedWalletRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - MaskedWalletRequest.Builder - - addAllowedCountrySpecificationForShipping(CountrySpecification countrySpecification) - -
- Sets an optional set of country specifications that should be allowed for shipping. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - addAllowedCountrySpecificationsForShipping(Collection<CountrySpecification> countrySpecifications) - -
- - - - - - MaskedWalletRequest - - build() - -
- - - - - - MaskedWalletRequest.Builder - - setAllowDebitCard(boolean allowDebitCard) - -
- Indicates whether a debit card may be used for this transaction. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setAllowPrepaidCard(boolean allowPrepaidCard) - -
- Indicates whether a prepaid card may be used for this transaction. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setCart(Cart cart) - -
- Sets an optional shopping cart to use for this purchase. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setCurrencyCode(String currencyCode) - -
- Required field. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setEstimatedTotalPrice(String estimatedTotalPrice) - -
- Required field. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setIsBillingAgreement(boolean isBillingAgreement) - -
- Indicates whether this request is for a billing agreement rather than for a one time - purchase. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setMerchantName(String merchantName) - -
- Sets an optional merchant name to be displayed on any UI in the checkout flow. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setMerchantTransactionId(String merchantTransactionId) - -
- Sets an optional merchant identifier for the transaction. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setPhoneNumberRequired(boolean phoneNumberRequired) - -
- Indicates whether a phone number is required from the user. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setShippingAddressRequired(boolean shippingAddressRequired) - -
- Indicates whether shipping information is required from the user. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setShouldRetrieveWalletObjects(boolean shouldRetrieveWalletObjects) - -
- Indicates that relevant Wallet Object information should be returned with the - MaskedWallet. - - - -
- -
- - - - - - MaskedWalletRequest.Builder - - setUseMinimalBillingAddress(boolean useMinimalBillingAddress) - -
- Indicates that only minimal billing information (name and zip code) is required. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - addAllowedCountrySpecificationForShipping - (CountrySpecification countrySpecification) -

-
-
- - - -
-
- - - - -

Sets an optional set of country specifications that should be allowed for shipping. - If omitted or a null / empty array is provided the API will default to using a country - specification that only allows shipping in the US. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - addAllowedCountrySpecificationsForShipping - (Collection<CountrySpecification> countrySpecifications) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setAllowDebitCard - (boolean allowDebitCard) -

-
-
- - - -
-
- - - - -

Indicates whether a debit card may be used for this transaction. - If omitted, defaults to true. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setAllowPrepaidCard - (boolean allowPrepaidCard) -

-
-
- - - -
-
- - - - -

Indicates whether a prepaid card may be used for this transaction. - If omitted, defaults to true. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setCart - (Cart cart) -

-
-
- - - -
-
- - - - -

Sets an optional shopping cart to use for this purchase. - - Supplying as much information about your transaction in the cart can help InstantBuy - improve the user experience during the payment flow. If you add a shipping or tax line - item to this cart, make sure to use a description that informs the user that the line - items are estimates (such as "Estimated Shipping"). -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setCurrencyCode - (String currencyCode) -

-
-
- - - -
-
- - - - -

Required field. Sets the ISO 4217 currency code of the transaction. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setEstimatedTotalPrice - (String estimatedTotalPrice) -

-
-
- - - -
-
- - - - -

Required field. Sets the total price of the shopping cart. The format of this string - follows the regex: [0-9]+(\.[0-9][0-9])?. This information will be used by Google risk - and fraud systems to try to lower fraud losses for merchants while maintaining a good - user experience. The total price inclusive of tax and shipping currently can not be - greater than $1800. Any amounts larger could be declined when authorized. Use your best - estimate for tax and shipping when calculating total order price. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setIsBillingAgreement - (boolean isBillingAgreement) -

-
-
- - - -
-
- - - - -

Indicates whether this request is for a billing agreement rather than for a one time - purchase. If true, estimated total price and cart are inapplicable and should not - be set. If omitted, defaults to false. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setMerchantName - (String merchantName) -

-
-
- - - -
-
- - - - -

Sets an optional merchant name to be displayed on any UI in the checkout flow. If - omitted, the merchant display name configured in the merchant's account settings will be - used. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setMerchantTransactionId - (String merchantTransactionId) -

-
-
- - - -
-
- - - - -

Sets an optional merchant identifier for the transaction. The value will be echoed back - in MaskedWallet and FullWallet, but is not otherwise used by the Wallet - API. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setPhoneNumberRequired - (boolean phoneNumberRequired) -

-
-
- - - -
-
- - - - -

Indicates whether a phone number is required from the user. Only request the phone number - when it's required to process the order since it can increase friction during the - purchase flow. If omitted, defaults to false. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setShippingAddressRequired - (boolean shippingAddressRequired) -

-
-
- - - -
-
- - - - -

Indicates whether shipping information is required from the user. If omitted, defaults to - false. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setShouldRetrieveWalletObjects - (boolean shouldRetrieveWalletObjects) -

-
-
- - - -
-
- - - - -

Indicates that relevant Wallet Object information should be returned with the - MaskedWallet. Only set this to true if you have also integrated with the Google - Wallet Objects API. If omitted, defaults to false. -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest.Builder - - setUseMinimalBillingAddress - (boolean useMinimalBillingAddress) -

-
-
- - - -
-
- - - - -

Indicates that only minimal billing information (name and zip code) is required. This - field is mutually exclusive with shipping address required. Use only one or the other. - If omitted, defaults to false. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.html b/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.html deleted file mode 100644 index dd3221f38693..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/MaskedWalletRequest.html +++ /dev/null @@ -1,2419 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MaskedWalletRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

MaskedWalletRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.MaskedWalletRequest
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a masked wallet request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classMaskedWalletRequest.Builder - Builder to create a MaskedWalletRequest.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<MaskedWalletRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - boolean - - allowDebitCard() - -
- - - - - - boolean - - allowPrepaidCard() - -
- - - - - - int - - describeContents() - -
- - - - - - ArrayList<CountrySpecification> - - getAllowedCountrySpecificationsForShipping() - -
- - - - - - CountrySpecification[] - - getAllowedShippingCountrySpecifications() - -
- - - - - - Cart - - getCart() - -
- - - - - - String - - getCurrencyCode() - -
- - - - - - String - - getEstimatedTotalPrice() - -
- - - - - - String - - getMerchantName() - -
- - - - - - String - - getMerchantTransactionId() - -
- - - - - - int - - getVersionCode() - -
- - - - - - boolean - - isBillingAgreement() - -
- - - - - - boolean - - isPhoneNumberRequired() - -
- - - - - - boolean - - isShippingAddressRequired() - -
- - - - static - - MaskedWalletRequest.Builder - - newBuilder() - -
- - - - - - boolean - - shouldRetrieveWalletObjects() - -
- - - - - - boolean - - useMinimalBillingAddress() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<MaskedWalletRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - boolean - - allowDebitCard - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether a debit card may be used as the backing card for this transaction -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - allowPrepaidCard - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether a prepaid card may be used as the backing card for this transaction -
-
- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - ArrayList<CountrySpecification> - - getAllowedCountrySpecificationsForShipping - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • a list of countries that are allowed for shipping addresses -
-
- -
-
- - - - -
-

- - public - - - - - CountrySpecification[] - - getAllowedShippingCountrySpecifications - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the allowed set of shipping country specifications -
-
- -
-
- - - - -
-

- - public - - - - - Cart - - getCart - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the shopping cart -
-
- -
-
- - - - -
-

- - public - - - - - String - - getCurrencyCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the ISO 4217 currency code of the transaction -
-
- -
-
- - - - -
-

- - public - - - - - String - - getEstimatedTotalPrice - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the estimated total price of the shopping cart -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMerchantName - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the merchant name that overrides the default display name in the merchant's account - settings -
-
- -
-
- - - - -
-

- - public - - - - - String - - getMerchantTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • your own unique identifier for the transaction -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isBillingAgreement - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether this request is for a billing agreement rather than for a one time purchase -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isPhoneNumberRequired - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether a user phone number is required -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - isShippingAddressRequired - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • whether a user shipping address is required -
-
- -
-
- - - - -
-

- - public - static - - - - MaskedWalletRequest.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - shouldRetrieveWalletObjects - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • indicates that any relevant Wallet Objects should be returned. -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - useMinimalBillingAddress - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • indicates that only a minimal billing address associated with user's payment - instrument is desired. -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Builder.html b/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Builder.html deleted file mode 100644 index 97d56b219062..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Builder.html +++ /dev/null @@ -1,1478 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NotifyTransactionStatusRequest.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

NotifyTransactionStatusRequest.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.NotifyTransactionStatusRequest.Builder
- - - - - - - -
- - -

Class Overview

-

Builder to create a NotifyTransactionStatusRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - NotifyTransactionStatusRequest - - build() - -
- - - - - - NotifyTransactionStatusRequest.Builder - - setDetailedReason(String detailedReason) - -
- Sets any additional information about why the ProxyCard transaction failed. - - - -
- -
- - - - - - NotifyTransactionStatusRequest.Builder - - setGoogleTransactionId(String googleTransactionId) - -
- Sets Google's unique identifier for this transaction. - - - -
- -
- - - - - - NotifyTransactionStatusRequest.Builder - - setStatus(int status) - -
- Sets the status received from processing the ProxyCard in a FullWallet - response. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - NotifyTransactionStatusRequest - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - NotifyTransactionStatusRequest.Builder - - setDetailedReason - (String detailedReason) -

-
-
- - - -
-
- - - - -

Sets any additional information about why the ProxyCard transaction failed. This - field should only be set with a corresponding NotifyTransactionStatusRequest.Status.Error status. -

- -
-
- - - - -
-

- - public - - - - - NotifyTransactionStatusRequest.Builder - - setGoogleTransactionId - (String googleTransactionId) -

-
-
- - - -
-
- - - - -

Sets Google's unique identifier for this transaction. This field is required and must be - identical to the value returned in an earlier FullWallet in the same - transaction. -

- -
-
- - - - -
-

- - public - - - - - NotifyTransactionStatusRequest.Builder - - setStatus - (int status) -

-
-
- - - -
-
- - - - -

Sets the status received from processing the ProxyCard in a FullWallet - response. This field is required and must be one of the values in NotifyTransactionStatusRequest.Status or - NotifyTransactionStatusRequest.Status.Error. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.Error.html b/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.Error.html deleted file mode 100644 index d24d5d5fd844..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.Error.html +++ /dev/null @@ -1,1377 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NotifyTransactionStatusRequest.Status.Error | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

NotifyTransactionStatusRequest.Status.Error

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.NotifyTransactionStatusRequest.Status.Error
- - - - - - - -
- - -

Class Overview

-

Failure statuses received from processing a ProxyCard. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAVS_DECLINE - - - - -
intBAD_CARD - - - - -
intBAD_CVC - - - - -
intDECLINED - - - - -
intFRAUD_DECLINE - - - - -
intOTHER - - - - -
intUNKNOWN - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - AVS_DECLINE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 7 - (0x00000007) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BAD_CARD -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BAD_CVC -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DECLINED -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FRAUD_DECLINE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 8 - (0x00000008) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - OTHER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 6 - (0x00000006) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.html b/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.html deleted file mode 100644 index 51938742bf2f..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.html +++ /dev/null @@ -1,1084 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NotifyTransactionStatusRequest.Status | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

NotifyTransactionStatusRequest.Status

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.NotifyTransactionStatusRequest.Status
- - - - - - - -
- - -

Class Overview

-

Status received from processing a ProxyCard. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceNotifyTransactionStatusRequest.Status.Error - Failure statuses received from processing a ProxyCard.  - - - -
- - - - - - - - - - - -
Constants
intSUCCESS - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - SUCCESS -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.html b/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.html deleted file mode 100644 index 88c2d0744852..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.html +++ /dev/null @@ -1,1858 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NotifyTransactionStatusRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

NotifyTransactionStatusRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.NotifyTransactionStatusRequest
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a notify transaction status request. - - Required fields: - - googleTransactionId - see setGoogleTransactionId(String) for details - - status - see setStatus(int) for details - - Optional fields: - - detailedReason - defaults to null - see setDetailedReason(String) for details -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classNotifyTransactionStatusRequest.Builder - Builder to create a NotifyTransactionStatusRequest.  - - - -
- - - - - interfaceNotifyTransactionStatusRequest.Status - Status received from processing a ProxyCard.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<NotifyTransactionStatusRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getDetailedReason() - -
- - - - - - String - - getGoogleTransactionId() - -
- - - - - - int - - getStatus() - -
- - - - - - int - - getVersionCode() - -
- - - - static - - NotifyTransactionStatusRequest.Builder - - newBuilder() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<NotifyTransactionStatusRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getDetailedReason - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Additional information about why the ProxyCard transaction failed -
-
- -
-
- - - - -
-

- - public - - - - - String - - getGoogleTransactionId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Google's unique identifier for this transaction -
-
- -
-
- - - - -
-

- - public - - - - - int - - getStatus - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - NotifyTransactionStatusRequest.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/OfferWalletObject.html b/docs/html/reference/com/google/android/gms/wallet/OfferWalletObject.html deleted file mode 100644 index 1cc4ffa637b2..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/OfferWalletObject.html +++ /dev/null @@ -1,1710 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -OfferWalletObject | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

OfferWalletObject

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.OfferWalletObject
- - - - - - - -
- - -

Class Overview

-

Parcelable representing an offer wallet object. This could represent an offer from the merchant - such as a coupon, etc. It has a buyerId that identifies the user to the merchant. If the offer - is associated to a loyalty program, then this could be an identifier for that program. The offer - also has a redemptionCode that will typically be used in the transaction, like a discount code - or similar that the user would otherwise have to enter manually. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<OfferWalletObject>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getId() - -
- - - - - - String - - getRedemptionCode() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<OfferWalletObject> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The unique identifier for this Wallet Object. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getRedemptionCode - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The redemption code of the offer. This would be a coupon code or similar that user - could enter to gain a discount, reward, etc. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/PaymentInstrumentType.html b/docs/html/reference/com/google/android/gms/wallet/PaymentInstrumentType.html deleted file mode 100644 index 5da8cda203be..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/PaymentInstrumentType.html +++ /dev/null @@ -1,1710 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PaymentInstrumentType | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

PaymentInstrumentType

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.PaymentInstrumentType
- - - - - - - -
- - -

Class Overview

-

Payment instrument types that a merchant can support. The values match - CreditCardFormFields.FopType, except UNKNOWN, which is not a valid payment instrument type for a - merchant to support. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intAMEX - - - - -
intCHROME_PROXY_CARD_TYPE - - - - -
intDISCOVER - - - - -
intJCB - - - - -
intMASTER_CARD - - - - -
intVISA - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - PaymentInstrumentType() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - ArrayList<Integer> - - getAll() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - AMEX -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CHROME_PROXY_CARD_TYPE -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DISCOVER -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - JCB -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MASTER_CARD -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - VISA -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - PaymentInstrumentType - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ArrayList<Integer> - - getAll - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Payments.html b/docs/html/reference/com/google/android/gms/wallet/Payments.html deleted file mode 100644 index f1a5a7ea5af5..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Payments.html +++ /dev/null @@ -1,1482 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Payments | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Payments

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.Payments
- - - - - - - -
- - -

Class Overview

-

Entry point for interacting with Wallet buyflow APIs. - -

- To allow the user to select and change the account associated with the transaction and Google - transaction ID, use null or simply do not set it using - setAccountName(String). No special action is required when a user - changes the selected account through the UI in this case, and the Google transaction ID - associated with the transaction can continue to be used. -

- To specify the account and prevent the user from selecting another account, set the account - using setAccountName(String). To change the account, construct a - new GoogleApiClient with the new account and do not reuse the Google transaction ID associated - with the old account - this is a new transaction. -

- We recommend that you apply for API access at - http://getinstantbuy.withgoogle.com/ - before starting development. During development, use the sandbox environment by specifying - ENVIRONMENT_SANDBOX using - setEnvironment(int). For production access, you must specify - ENVIRONMENT_PRODUCTION. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - changeMaskedWallet(GoogleApiClient googleApiClient, String googleTransactionId, String merchantTransactionId, int requestCode) - -
- This method brings up a Google Wallet selector screen to allow your customer to select a new - payment instrument or shipping address from their Google Wallet. - - - -
- -
- abstract - - - - - void - - checkForPreAuthorization(GoogleApiClient googleApiClient, int requestCode) - -
- This API checks to see if a user has previously authorized the application to access their - Wallet account. - - - -
- -
- abstract - - - - - void - - isNewUser(GoogleApiClient googleApiClient, int requestCode) - -
- Checks if this is a new user, i.e. - - - -
- -
- abstract - - - - - void - - loadFullWallet(GoogleApiClient googleApiClient, FullWalletRequest request, int requestCode) - -
- Requests a FullWallet, which contains the payment credentials. - - - -
- -
- abstract - - - - - void - - loadMaskedWallet(GoogleApiClient googleApiClient, MaskedWalletRequest request, int requestCode) - -
- If an application has authorization, loadMaskedWallet() allows you to skip the Google Wallet - selector and directly request the masked payment credentials. - - - -
- -
- abstract - - - - - void - - notifyTransactionStatus(GoogleApiClient googleApiClient, NotifyTransactionStatusRequest request) - -
- Sends a notification to Google on whether the transaction succeeded or failed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - changeMaskedWallet - (GoogleApiClient googleApiClient, String googleTransactionId, String merchantTransactionId, int requestCode) -

-
-
- - - -
-
- - - - -

This method brings up a Google Wallet selector screen to allow your customer to select a new - payment instrument or shipping address from their Google Wallet.

-
-
Parameters
- - - - - - - - - - - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API
googleTransactionId - Required field. Must be identical to the value returned in an - earlier MaskedWallet in the same transaction.
merchantTransactionId - Optional merchant identifier for the transaction. The value - will be echoed back in MaskedWallet, but is not - otherwise used by the Wallet API. To omit, pass null
requestCode - will be passed back in onActivityResult where you can retrieve the result - via EXTRA_MASKED_WALLET. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - checkForPreAuthorization - (GoogleApiClient googleApiClient, int requestCode) -

-
-
- - - -
-
- - - - -

This API checks to see if a user has previously authorized the application to access their - Wallet account.

-
-
Parameters
- - - - - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API
requestCode - will be passed back in onActivityResult where you can retrieve the result - via EXTRA_IS_USER_PREAUTHORIZED. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - isNewUser - (GoogleApiClient googleApiClient, int requestCode) -

-
-
- - - -
-
- - - - -

Checks if this is a new user, i.e. if they have used Instant Buy to make a purchase for your - app before or not. If the user has multiple accounts on the device, each will be checked. If - any of the accounts has been used to make an Instant Buy purchase with your app, then false - will be returned. True is only returned if none of the accounts on the device have used - Instant Buy to make a purchase with your app.

-
-
Parameters
- - - - - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API
requestCode - will be passed back in onActivityResult where you can retrieve the result - via EXTRA_IS_NEW_USER. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - loadFullWallet - (GoogleApiClient googleApiClient, FullWalletRequest request, int requestCode) -

-
-
- - - -
-
- - - - -

Requests a FullWallet, which contains the payment credentials. You can retrieve the - FullWallet in onActivityResult using the requestCode that - you provide to this method. If there is a problem with the transaction then the Google Wallet - selector will be shown and a MaskedWallet will be returned to reflect new selections - by the user. -

- This function should only be called when the customer confirms the purchase. -

- Important: Because the credentials are in plain text it is important to transfer the payment - credentials following - PCI - standards.

-
-
Parameters
- - - - - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API
requestCode - will be passed back in onActivityResult where you can retrieve the result - via EXTRA_FULL_WALLET or - EXTRA_MASKED_WALLET if the user had to make new - selections. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - loadMaskedWallet - (GoogleApiClient googleApiClient, MaskedWalletRequest request, int requestCode) -

-
-
- - - -
-
- - - - -

If an application has authorization, loadMaskedWallet() allows you to skip the Google Wallet - selector and directly request the masked payment credentials. This provides a more seamless - purchase experience for your customers. When you call this method, the Google Wallet selector - will be shown only if necessary. Either way, you can retrieve the MaskedWallet in - onActivityResult using the specified requestCode.

-
-
Parameters
- - - - - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API
requestCode - will be passed back in onActivityResult where you can retrieve the result - via EXTRA_MASKED_WALLET. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - notifyTransactionStatus - (GoogleApiClient googleApiClient, NotifyTransactionStatusRequest request) -

-
-
- - - -
-
- - - - -

Sends a notification to Google on whether the transaction succeeded or failed. This should - always be called after payment processing as well as any failed validation checks.

-
-
Parameters
- - - - -
googleApiClient - An instance of GoogleApiClient configured to use the Wallet - API -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/ProxyCard.html b/docs/html/reference/com/google/android/gms/wallet/ProxyCard.html deleted file mode 100644 index ba3c104e9afc..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/ProxyCard.html +++ /dev/null @@ -1,1811 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ProxyCard | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

ProxyCard

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.ProxyCard
- - - - - - - -
- - -

Class Overview

-

Parcelable representing a credit card. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<ProxyCard>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getCvn() - -
- - - - - - int - - getExpirationMonth() - -
- - - - - - int - - getExpirationYear() - -
- - - - - - String - - getPan() - -
- - - - - - int - - getVersionCode() - -
- - - - - - void - - writeToParcel(Parcel out, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<ProxyCard> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getCvn - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The card verification number. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getExpirationMonth - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Expiration month, 1-12 -
-
- -
-
- - - - -
-

- - public - - - - - int - - getExpirationYear - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • Expiration year, 4-digit -
-
- -
-
- - - - -
-

- - public - - - - - String - - getPan - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • The primary account number of the card. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getVersionCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel out, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.Builder.html b/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.Builder.html deleted file mode 100644 index a8688cd324f5..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.Builder.html +++ /dev/null @@ -1,1463 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wallet.WalletOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Wallet.WalletOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Wallet.WalletOptions.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Wallet.WalletOptions.Builder() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Wallet.WalletOptions - - build() - -
- - - - - - Wallet.WalletOptions.Builder - - setEnvironment(int environment) - -
- - - - - - Wallet.WalletOptions.Builder - - setTheme(int theme) - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Wallet.WalletOptions.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Wallet.WalletOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Wallet.WalletOptions.Builder - - setEnvironment - (int environment) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Wallet.WalletOptions.Builder - - setTheme - (int theme) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.html b/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.html deleted file mode 100644 index 66e55a79d087..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Wallet.WalletOptions.html +++ /dev/null @@ -1,1413 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wallet.WalletOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Wallet.WalletOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.HasOptions - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Wallet.WalletOptions
- - - - - - - -
- - -

Class Overview

-

Options for using the Wallet API. To create an instance, use the - Wallet.WalletOptions.Builder. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWallet.WalletOptions.Builder -   - - - -
- - - - - - - - - - - - - - - - - - -
Fields
- public - - final - intenvironment - The Google Wallet environment to use. - - - -
- public - - final - inttheme - The theme to use for Wallet running on Android OS with - SDK_INT - >= HONEYCOMB. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - - final - int - - environment -

-
- - - - -
-
- - - - -

The Google Wallet environment to use. Specify ENVIRONMENT_SANDBOX - until you have applied for and been granted access to the Production environment. - Defaults to ENVIRONMENT_SANDBOX. -

- - -
-
- - - - - -
-

- - public - - final - int - - theme -

-
- - - - -
-
- - - - -

The theme to use for Wallet running on Android OS with - SDK_INT - >= HONEYCOMB. The only legitimate values are - THEME_DARK and THEME_LIGHT - as those are the only supported themes. User-created themes are not supported. - Value ignored for Android OS with SDK_INT - < HONEYCOMB. Defaults to - THEME_DARK. -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/Wallet.html b/docs/html/reference/com/google/android/gms/wallet/Wallet.html deleted file mode 100644 index 15d8d8b5ff6f..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/Wallet.html +++ /dev/null @@ -1,1709 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wallet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

Wallet

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.Wallet
- - - - - - - -
- - -

Class Overview

-

The main entry point for Google Wallet integration. You need to build a GoogleApiClient - using the API and the appropriate Wallet.WalletOptions. Once you have called - connect() and your listener has received the - onConnected(android.os.Bundle) callback, then you can - call the various Wallet APIs. - -

- When your app is done using Wallet, call disconnect(), - even if the async result from connect() has not yet been - delivered. -

- You should instantiate an instance of GoogleApiClient in your Activity's - onCreate(Bundle) method and then call connect() in - onStart() and disconnect() in - onStop(), regardless of the state. -

- For comments and requirements specific to different Wallet APIs, please see each API interface's - header comments. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWallet.WalletOptions - Options for using the Wallet API.  - - - -
- - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Wallet.WalletOptions>API - Add this to your GoogleApiClient via addApi(Api) to enable - Wallet features. - - - -
- public - static - final - PaymentsPayments - Methods for interacting with Wallet payments APIs. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - void - - changeMaskedWallet(GoogleApiClient googleApiClient, String googleTransactionId, String merchantTransactionId, int requestCode) - -
- Use changeMaskedWallet(GoogleApiClient, String, String, int) from - Payments. - - - -
- -
- - - - static - - void - - checkForPreAuthorization(GoogleApiClient googleApiClient, int requestCode) - -
- Use checkForPreAuthorization(GoogleApiClient, int) from Payments. - - - -
- -
- - - - static - - void - - loadFullWallet(GoogleApiClient googleApiClient, FullWalletRequest request, int requestCode) - -
- Use loadFullWallet(GoogleApiClient, FullWalletRequest, int) from - Payments. - - - -
- -
- - - - static - - void - - loadMaskedWallet(GoogleApiClient googleApiClient, MaskedWalletRequest request, int requestCode) - -
- Use loadMaskedWallet(GoogleApiClient, MaskedWalletRequest, int) from - Payments. - - - -
- -
- - - - static - - void - - notifyTransactionStatus(GoogleApiClient googleApiClient, NotifyTransactionStatusRequest request) - -
- Use notifyTransactionStatus(GoogleApiClient, NotifyTransactionStatusRequest) - from Payments. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Wallet.WalletOptions> - - API -

-
- - - - -
-
- - - - -

Add this to your GoogleApiClient via addApi(Api) to enable - Wallet features. -

- To configure additional Wallet options, provide a Wallet.WalletOptions object to - addApi(Api). -

- - -
-
- - - - - -
-

- - public - static - final - Payments - - Payments -

-
- - - - -
-
- - - - -

Methods for interacting with Wallet payments APIs. -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - changeMaskedWallet - (GoogleApiClient googleApiClient, String googleTransactionId, String merchantTransactionId, int requestCode) -

-
-
- - - -
-
- - - - -

Use changeMaskedWallet(GoogleApiClient, String, String, int) from - Payments. -

- -
-
- - - - -
-

- - public - static - - - - void - - checkForPreAuthorization - (GoogleApiClient googleApiClient, int requestCode) -

-
-
- - - -
-
- - - - -

Use checkForPreAuthorization(GoogleApiClient, int) from Payments. -

- -
-
- - - - -
-

- - public - static - - - - void - - loadFullWallet - (GoogleApiClient googleApiClient, FullWalletRequest request, int requestCode) -

-
-
- - - -
-
- - - - -

Use loadFullWallet(GoogleApiClient, FullWalletRequest, int) from - Payments. -

- -
-
- - - - -
-

- - public - static - - - - void - - loadMaskedWallet - (GoogleApiClient googleApiClient, MaskedWalletRequest request, int requestCode) -

-
-
- - - -
-
- - - - -

Use loadMaskedWallet(GoogleApiClient, MaskedWalletRequest, int) from - Payments. -

- -
-
- - - - -
-

- - public - static - - - - void - - notifyTransactionStatus - (GoogleApiClient googleApiClient, NotifyTransactionStatusRequest request) -

-
-
- - - -
-
- - - - -

Use notifyTransactionStatus(GoogleApiClient, NotifyTransactionStatusRequest) - from Payments. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/WalletConstants.html b/docs/html/reference/com/google/android/gms/wallet/WalletConstants.html deleted file mode 100644 index 834fa46a6391..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/WalletConstants.html +++ /dev/null @@ -1,2827 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletConstants | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletConstants

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.WalletConstants
- - - - - - - -
- - -

Class Overview

-

Collection of constant values used by the ClientLibrary. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringACTION_ENABLE_WALLET_OPTIMIZATION - Name of an action to use in an IntentFilter for a BroadcastReceiver that is a signal from - your application that it uses Wallet, and thus the system should make the appropriate - optimizations. - - - -
intENVIRONMENT_PRODUCTION - Environment constant for running in production with the most stringent application / merchant - requirements. - - - -
intENVIRONMENT_SANDBOX - Environment constant for running in sandbox with relaxed application / merchant requirements. - - - -
intENVIRONMENT_STRICT_SANDBOX - Environment constant for running in sandbox with more stringent application / merchant - requirements. - - - -
intERROR_CODE_AUTHENTICATION_FAILURE - Not immediately recoverable error. - - - -
intERROR_CODE_BUYER_ACCOUNT_ERROR - Not immediately recoverable error. - - - -
intERROR_CODE_INVALID_PARAMETERS - Not immediately recoverable error. - - - -
intERROR_CODE_INVALID_TRANSACTION - Not immediately recoverable error. - - - -
intERROR_CODE_MERCHANT_ACCOUNT_ERROR - Not immediately recoverable error. - - - -
intERROR_CODE_SERVICE_UNAVAILABLE - Not immediately recoverable error. - - - -
intERROR_CODE_SPENDING_LIMIT_EXCEEDED - Recoverable error. - - - -
intERROR_CODE_UNKNOWN - Not immediately recoverable error. - - - -
intERROR_CODE_UNSUPPORTED_API_VERSION - Not immediately recoverable error. - - - -
StringEXTRA_ERROR_CODE - Extra for retrieving an error code from the Intent passed to onActivityResult - - - - -
StringEXTRA_FULL_WALLET - Extra for retrieving a FullWallet from the Intent passed to onActivityResult - - - - -
StringEXTRA_IS_NEW_USER - Extra for retrieving a boolean indicating if the user has used Instant Buy with your app - before or not. - - - -
StringEXTRA_IS_USER_PREAUTHORIZED - Extra for retrieving a boolean indicating if the user has pre-authorized your app or not - - - - -
StringEXTRA_MASKED_WALLET - Extra for retrieving a MaskedWallet from the Intent passed to onActivityResult - - - - -
StringEXTRA_MASKED_WALLET_REQUEST - Extra for retrieving the masked wallet request from the Bundle passed to - onStateChanged(WalletFragment, int, int, android.os.Bundle) - when transitioning to PROCESSING. - - - -
StringMETADATA_TAG_WALLET_API_ENABLED - Name of the metadata tag that is a signal from your application that it uses Wallet APIs. - - - -
intRESULT_ERROR - Response code passed to onActivityResult in the case of an error - - - -
intSTYLE_NO_TRANSITION - Constant passed to - setWindowTransitionsStyle(int) - to set the style of window transition to have no animations and simply appear and disappear - when starting and finishing. - - - -
intSTYLE_SLIDE_TRANSITION - Constant passed to - setWindowTransitionsStyle(int) - to set the style of window transitions to slide them up when starting and down when - when finishing. - - - -
intTHEME_DARK - Theme constant passed to setTheme(int) to use a dark - theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB. - - - -
intTHEME_HOLO_DARK - - This constant is deprecated. - use THEME_DARK - - - - -
intTHEME_HOLO_LIGHT - - This constant is deprecated. - use THEME_LIGHT - - - - -
intTHEME_LIGHT - Theme constant passed to setTheme(int) to use a light - theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - ACTION_ENABLE_WALLET_OPTIMIZATION -

-
- - - - -
-
- - - - -

Name of an action to use in an IntentFilter for a BroadcastReceiver that is a signal from - your application that it uses Wallet, and thus the system should make the appropriate - optimizations. Example of using the action: - - - - - - - - ... - -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.ENABLE_WALLET_OPTIMIZATION" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ENVIRONMENT_PRODUCTION -

-
- - - - -
-
- - - - -

Environment constant for running in production with the most stringent application / merchant - requirements. - -

    -
  1. Requires the application is uploaded to the Google Play Store.
    2. -
  2. Requires a Google Wallet merchant account to be used to upload this application to the - Google Play Store.
    3. -
-

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ENVIRONMENT_SANDBOX -

-
- - - - -
-
- - - - -

Environment constant for running in sandbox with relaxed application / merchant requirements. - This environment is suggested for early development and for easily testing the Wallet SDK. - -

    -
  1. Does not require the application to be uploaded to the Google Play Store.
    2. -
  2. Does not require a Google Wallet merchant account to be used to upload this application - to the Google Play Store.
    3. -
-

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ENVIRONMENT_STRICT_SANDBOX -

-
- - - - -
-
- - - - -

Environment constant for running in sandbox with more stringent application / merchant - requirements. This environment is suggested when finishing integration with the Wallet SDK - and imposes the same requirements as ENVIRONMENT_PRODUCTION. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_AUTHENTICATION_FAILURE -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - There was a failure in retrieving an authentication token for the buyer's Google Account. - This could be because Google's AbstractAccountAuthenticator is not - installed or failed to respond, or could be due to an invalid Google account, or could be - caused by some internal error. Note however that this error will NOT be returned if - authentication failed because of a network error or because the buyer cancelled the - operation.

-
-
See Also
- -
- - -
- Constant Value: - - - 411 - (0x0000019b) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_BUYER_ACCOUNT_ERROR -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - There are problems with the buyer's account (e.g closed account, unsupported country) -

- - -
- Constant Value: - - - 409 - (0x00000199) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INVALID_PARAMETERS -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - The request had missing or invalid parameters. -

- - -
- Constant Value: - - - 404 - (0x00000194) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_INVALID_TRANSACTION -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - loadFullWallet or changeMaskedWallet was called outside the context of a transaction. For - example, loadFullWallet was called without a successful call to loadMaskedWallet. -

- - -
- Constant Value: - - - 410 - (0x0000019a) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_MERCHANT_ACCOUNT_ERROR -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - There is a problem with the merchant Google Wallet account. -

- - -
- Constant Value: - - - 405 - (0x00000195) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_SERVICE_UNAVAILABLE -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - The InstantBuy service is temporarily off-line for all requests. -

- - -
- Constant Value: - - - 402 - (0x00000192) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_SPENDING_LIMIT_EXCEEDED -

-
- - - - -
-
- - - - -

Recoverable error. - The payment amount in the request put the buyer over their spending limit. The buyer may - still be able to use Google Wallet for a smaller purchase. -

- - -
- Constant Value: - - - 406 - (0x00000196) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_UNKNOWN -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - An unknown type of error has occurred. -

- - -
- Constant Value: - - - 413 - (0x0000019d) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - ERROR_CODE_UNSUPPORTED_API_VERSION -

-
- - - - -
-
- - - - -

Not immediately recoverable error. - The server API version of the request is no longer supported. This error is not recoverable - and should be treated as fatal. -

- - -
- Constant Value: - - - 412 - (0x0000019c) - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_ERROR_CODE -

-
- - - - -
-
- - - - -

Extra for retrieving an error code from the Intent passed to onActivityResult -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.EXTRA_ERROR_CODE" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_FULL_WALLET -

-
- - - - -
-
- - - - -

Extra for retrieving a FullWallet from the Intent passed to onActivityResult -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.EXTRA_FULL_WALLET" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_IS_NEW_USER -

-
- - - - -
-
- - - - -

Extra for retrieving a boolean indicating if the user has used Instant Buy with your app - before or not. -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.EXTRA_IS_NEW_USER" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_IS_USER_PREAUTHORIZED -

-
- - - - -
-
- - - - -

Extra for retrieving a boolean indicating if the user has pre-authorized your app or not -

- - -
- Constant Value: - - - "com.google.android.gm.wallet.EXTRA_IS_USER_PREAUTHORIZED" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_MASKED_WALLET -

-
- - - - -
-
- - - - -

Extra for retrieving a MaskedWallet from the Intent passed to onActivityResult -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.EXTRA_MASKED_WALLET" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - EXTRA_MASKED_WALLET_REQUEST -

-
- - - - -
-
- - - - -

Extra for retrieving the masked wallet request from the Bundle passed to - onStateChanged(WalletFragment, int, int, android.os.Bundle) - when transitioning to PROCESSING. -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.EXTRA_MASKED_WALLET_REQUEST" - - -
- -
-
- - - - - -
-

- - public - static - final - String - - METADATA_TAG_WALLET_API_ENABLED -

-
- - - - -
-
- - - - -

Name of the metadata tag that is a signal from your application that it uses Wallet APIs. - Note: - In future versions this metadata tag will be required in your application manifest to use - Wallet APIs in your app. - - Example of using the tag: - - - ... - -

- - -
- Constant Value: - - - "com.google.android.gms.wallet.api.enabled" - - -
- -
-
- - - - - -
-

- - public - static - final - int - - RESULT_ERROR -

-
- - - - -
-
- - - - -

Response code passed to onActivityResult in the case of an error

-
-
See Also
- -
- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STYLE_NO_TRANSITION -

-
- - - - -
-
- - - - -

Constant passed to - setWindowTransitionsStyle(int) - to set the style of window transition to have no animations and simply appear and disappear - when starting and finishing. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - STYLE_SLIDE_TRANSITION -

-
- - - - -
-
- - - - -

Constant passed to - setWindowTransitionsStyle(int) - to set the style of window transitions to slide them up when starting and down when - when finishing. It is the default style. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_DARK -

-
- - - - -
-
- - - - -

Theme constant passed to setTheme(int) to use a dark - theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB. This will provide the dark version of - either Holo or Material based on the API level of the device. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_HOLO_DARK -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- use THEME_DARK - -

-

Theme constant passed to setTheme(int) to use Holo Dark - theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB.

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_HOLO_LIGHT -

-
- - - - -
-
- - - -

-

- This constant is deprecated.
- use THEME_LIGHT - -

-

Theme constant passed to setTheme(int) to use Holo - Light theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB.

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - THEME_LIGHT -

-
- - - - -
-
- - - - -

Theme constant passed to setTheme(int) to use a light - theme for Wallet on Android OS with SDK_INT - >= HONEYCOMB. This will provide the light version of - either Holo or Material based on the API level of the device. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonAppearance.html b/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonAppearance.html deleted file mode 100644 index 537cbadd959a..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonAppearance.html +++ /dev/null @@ -1,1424 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BuyButtonAppearance | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BuyButtonAppearance

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.BuyButtonAppearance
- - - - - - - -
- - -

Class Overview

-

Options for Wallet button appearance.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCLASSIC - Buy button will use classic assets. - - - -
intGRAYSCALE - Buy button will use grayscale assets. - - - -
intMONOCHROME - Buy button will use monochrome assets. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CLASSIC -

-
- - - - -
-
- - - - -

Buy button will use classic assets. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - GRAYSCALE -

-
- - - - -
-
- - - - -

Buy button will use grayscale assets. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MONOCHROME -

-
- - - - -
-
- - - - -

Buy button will use monochrome assets. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonText.html b/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonText.html deleted file mode 100644 index 86dbf4477926..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/BuyButtonText.html +++ /dev/null @@ -1,1482 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -BuyButtonText | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

BuyButtonText

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.BuyButtonText
- - - - - - - -
- - -

Class Overview

-

Options for text displayed on the Wallet buy button.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBOOK_NOW - "Book now" - - - - -
intBUY_NOW - "Buy now" - - - - -
intBUY_WITH_GOOGLE - "Buy with Google" - - - - -
intDONATE_WITH_GOOGLE - "Donate with Google" - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - BOOK_NOW -

-
- - - - -
-
- - - - -

"Book now" -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BUY_NOW -

-
- - - - -
-
- - - - -

"Buy now" -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - BUY_WITH_GOOGLE -

-
- - - - -
-
- - - - -

"Buy with Google" -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DONATE_WITH_GOOGLE -

-
- - - - -
-
- - - - -

"Donate with Google" -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/Dimension.html b/docs/html/reference/com/google/android/gms/wallet/fragment/Dimension.html deleted file mode 100644 index 921de6dfb721..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/Dimension.html +++ /dev/null @@ -1,1698 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dimension | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Dimension

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.Dimension
- - - - - - - -
- - -

Class Overview

-

Constants for specifying dimensions in WalletFragmentStyle. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intMATCH_PARENT - Special value for width/height of a view. - - - -
intUNIT_DIP - Dimension unit - device independent pixels - - - - -
intUNIT_IN - Dimension unit - inches - - - - -
intUNIT_MM - Dimension unit - millimeters - - - - -
intUNIT_PT - Dimension unit - points - - - - -
intUNIT_PX - Dimension unit - raw pixels - - - - -
intUNIT_SP - Dimension unit - scaled pixel - - - - -
intWRAP_CONTENT - Special value for width/height of a view. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - MATCH_PARENT -

-
- - - - -
-
- - - - -

Special value for width/height of a view. It means that the view wants to be as big as its - parent, minus the parent's padding, if any. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_DIP -

-
- - - - -
-
- - - - -

Dimension unit - device independent pixels -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_IN -

-
- - - - -
-
- - - - -

Dimension unit - inches -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_MM -

-
- - - - -
-
- - - - -

Dimension unit - millimeters -

- - -
- Constant Value: - - - 5 - (0x00000005) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_PT -

-
- - - - -
-
- - - - -

Dimension unit - points -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_PX -

-
- - - - -
-
- - - - -

Dimension unit - raw pixels -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNIT_SP -

-
- - - - -
-
- - - - -

Dimension unit - scaled pixel -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WRAP_CONTENT -

-
- - - - -
-
- - - - -

Special value for width/height of a view. It means the view wants to be just large enough - to fit its own internal content, taking its own padding into account. -

- - -
- Constant Value: - - - -2 - (0xfffffffe) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.OnStateChangedListener.html b/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.OnStateChangedListener.html deleted file mode 100644 index 0486d59033e9..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.OnStateChangedListener.html +++ /dev/null @@ -1,1048 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SupportWalletFragment.OnStateChangedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

SupportWalletFragment.OnStateChangedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.fragment.SupportWalletFragment.OnStateChangedListener
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStateChanged(SupportWalletFragment fragment, int oldState, int newState, Bundle extras) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStateChanged - (SupportWalletFragment fragment, int oldState, int newState, Bundle extras) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.html b/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.html deleted file mode 100644 index cb7d54c4d158..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.html +++ /dev/null @@ -1,3874 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SupportWalletFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

SupportWalletFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.support.v4.app.Fragment
    ↳com.google.android.gms.wallet.fragment.SupportWalletFragment
- - - - - - - -
- - -

Class Overview

-

This fragment is the simplest way to place a Wallet buy button or selection details UI - in an application for the InstantBuy API. It automatically handles life cycle and user events, - producing a MaskedWallet in the end. Being a fragment, the component can be added - to an activity's layout with the XML below. - - Buy Button mode: - 

- <fragment
-    android:name="com.google.android.gms.wallet.fragment.SupportWalletFragment"
-    android:layout_width="match_parent"
-    android:layout_height="wrap_content"
-    wallet:environment="sandbox"
-    wallet:fragmentMode="buyButton"/>
- - Selection Details mode: - 
- <fragment
-    android:name="com.google.android.gms.wallet.fragment.SupportWalletFragment"
-    android:layout_width="match_parent"
-    android:layout_height="wrap_content"
-    wallet:environment="sandbox"
-    wallet:fragmentMode="selectionDetails"/>
- - Alternatively it may also be created programmatically with - newInstance(WalletFragmentOptions) and added to the activity's fragment manager. -

- The fragment must be initialized exactly once by calling - initialize(WalletFragmentInitParams). This sets a MaskedWalletRequest - for buy button mode or MaskedWallet for selection details mode. For buy button mode the - request may be modified with updateMaskedWalletRequest(MaskedWalletRequest). - When the button is clicked, the masked payment credentials of the user will be retrieved and - returned in your activity's onActivityResult callback with a request code specified in - WalletFragmentInitParams. -

- The fragment may be in one of four states at any time. It starts out in - UNINITIALIZED. UI components are disabled in this state. - Once initialize(WalletFragmentInitParams) is called, the fragment transitions into - READY, where it is ready for user interaction. - When the buy/change button is clicked, it transitions into PROCESSING. - The button will be disabled to prevent further user interaction. Finally when the masked wallet - result comes back, the fragment goes back into READY. - Sometimes the fragment can also get into WALLET_UNAVAILABLE when - the Wallet service is temporarily not available. UI components will be disabled in this state. - You may receive state transition updates by setting a SupportWalletFragment.OnStateChangedListener via - setOnStateChangedListener(OnStateChangedListener). -

- To use this class, you must include the Android support library in your build path. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceSupportWalletFragment.OnStateChangedListener -   - - - -
- - - - - - - - - - -
Public Constructors
- - - - - - - - SupportWalletFragment() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getState() - -
- Returns the current state of the fragment. - - - -
- -
- - - - - - void - - initialize(WalletFragmentInitParams initParams) - -
- Initializes the fragment. - - - -
- -
- - - - static - - SupportWalletFragment - - newInstance(WalletFragmentOptions options) - -
- Creates a Wallet fragment with the given options. - - - -
- -
- - - - - - void - - onActivityResult(int requestCode, int resultCode, Intent data) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - onStart() - -
- - - - - - void - - onStop() - -
- - - - - - void - - setEnabled(boolean enabled) - -
- Sets a boolean that will enable or disable the fragment's UI components when it's in - READY. - - - -
- -
- - - - - - void - - setOnStateChangedListener(SupportWalletFragment.OnStateChangedListener listener) - -
- Sets a listener to receive state transition callbacks. - - - -
- -
- - - - - - void - - updateMaskedWallet(MaskedWallet maskedWallet) - -
- Modifies the MaskedWallet. - - - -
- -
- - - - - - void - - updateMaskedWalletRequest(MaskedWalletRequest request) - -
- Modifies the MaskedWalletRequest. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.support.v4.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - SupportWalletFragment - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getState - () -

-
-
- - - -
-
- - - - -

Returns the current state of the fragment. See WalletFragmentState for list of - possible values. Note that UNKNOWN may be returned under the - following circumstances: -

    -
  • before onStart() is executed
    • -
  • when Google Play services is unavailable or requires update
    • -
-

- -
-
- - - - -
-

- - public - - - - - void - - initialize - (WalletFragmentInitParams initParams) -

-
-
- - - -
-
- - - - -

Initializes the fragment. This must be called exactly once. Any further invocations after - the first will be ignored. -

- -
-
- - - - -
-

- - public - static - - - - SupportWalletFragment - - newInstance - (WalletFragmentOptions options) -

-
-
- - - -
-
- - - - -

Creates a Wallet fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityResult - (int requestCode, int resultCode, Intent data) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onStart - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onStop - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets a boolean that will enable or disable the fragment's UI components when it's in - READY. The UI components can not be disabled in other states - and the boolean has no effect. This method is meant for temporarily disabling the buy - button while you load data or update UI in your app. -

- -
-
- - - - -
-

- - public - - - - - void - - setOnStateChangedListener - (SupportWalletFragment.OnStateChangedListener listener) -

-
-
- - - -
-
- - - - -

Sets a listener to receive state transition callbacks. -

- -
-
- - - - -
-

- - public - - - - - void - - updateMaskedWallet - (MaskedWallet maskedWallet) -

-
-
- - - -
-
- - - - -

Modifies the MaskedWallet. This should be called after - initialize(WalletFragmentInitParams). Any non-null maskedWallet - passed in here takes precedence over the MaskedWallet in - WalletFragmentInitParams passed in initialize(WalletFragmentInitParams). -

- -
-
- - - - -
-

- - public - - - - - void - - updateMaskedWalletRequest - (MaskedWalletRequest request) -

-
-
- - - -
-
- - - - -

Modifies the MaskedWalletRequest. This should be called after - initialize(WalletFragmentInitParams). Any non-null request passed in here - takes precedence over the MaskedWalletRequest in WalletFragmentInitParams - passed in initialize(WalletFragmentInitParams). -

- Note that any user buy button click event before this method call would load a masked wallet - using whatever MaskedWalletRequest available at that time. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.OnStateChangedListener.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.OnStateChangedListener.html deleted file mode 100644 index 5ff997cea1bc..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.OnStateChangedListener.html +++ /dev/null @@ -1,1048 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragment.OnStateChangedListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - static - - - interface -

WalletFragment.OnStateChangedListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wallet.fragment.WalletFragment.OnStateChangedListener
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onStateChanged(WalletFragment fragment, int oldState, int newState, Bundle extras) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onStateChanged - (WalletFragment fragment, int oldState, int newState, Bundle extras) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.html deleted file mode 100644 index 6d727e746d3f..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragment.html +++ /dev/null @@ -1,4068 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragment

- - - - - - - - - extends Fragment
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.app.Fragment
    ↳com.google.android.gms.wallet.fragment.WalletFragment
- - - - - - - -
- - -

Class Overview

-

This fragment is the simplest way to place a Wallet buy button or selection details UI - in an application for the InstantBuy API. It automatically handles life cycle and user events, - producing a MaskedWallet in the end. Being a fragment, the component can be added - to an activity's layout with the XML below. - - Buy Button mode: - 

- <fragment
-    android:name="com.google.android.gms.wallet.fragment.WalletFragment"
-    android:layout_width="match_parent"
-    android:layout_height="wrap_content"
-    wallet:environment="sandbox"
-    wallet:fragmentMode="buyButton"/>
- - Selection Details mode: - 
- <fragment
-    android:name="com.google.android.gms.wallet.fragment.WalletFragment"
-    android:layout_width="match_parent"
-    android:layout_height="wrap_content"
-    wallet:environment="sandbox"
-    wallet:fragmentMode="selectionDetails"/>
- - Alternatively it may also be created programmatically with - newInstance(WalletFragmentOptions) and added to the activity's fragment manager. -

- The fragment must be initialized exactly once by calling - initialize(WalletFragmentInitParams). This sets a MaskedWalletRequest - for buy button mode or MaskedWallet for selection details mode. For buy button mode the - request may be modified with updateMaskedWalletRequest(MaskedWalletRequest). - When the button is clicked, the masked payment credentials of the user will be retrieved and - returned in your activity's onActivityResult callback with a request code specified in - WalletFragmentInitParams. -

- The fragment may be in one of four states at any time. It starts out in - UNINITIALIZED. UI components are disabled in this state. - Once initialize(WalletFragmentInitParams) is called, the fragment transitions into - READY, where it is ready for user interaction. - When the buy/change button is clicked, it transitions into PROCESSING. - The button will be disabled to prevent further user interaction. Finally when the masked wallet - result comes back, the fragment goes back into READY. - Sometimes the fragment can also get into WALLET_UNAVAILABLE when - the Wallet service is temporarily not available. UI components will be disabled in this state. - You may receive state transition updates by setting a WalletFragment.OnStateChangedListener via - setOnStateChangedListener(OnStateChangedListener). -

- Use this class only if you are targeting API 12 and above. Otherwise, use SupportWalletFragment. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceWalletFragment.OnStateChangedListener -   - - - -
- - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WalletFragment() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getState() - -
- Returns the current state of the fragment. - - - -
- -
- - - - - - void - - initialize(WalletFragmentInitParams initParams) - -
- Initializes the fragment. - - - -
- -
- - - - static - - WalletFragment - - newInstance(WalletFragmentOptions options) - -
- Creates a Wallet fragment with the given options. - - - -
- -
- - - - - - void - - onActivityResult(int requestCode, int resultCode, Intent data) - -
- - - - - - void - - onCreate(Bundle savedInstanceState) - -
- - - - - - View - - onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) - -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState) - -
- - - - - - void - - onPause() - -
- - - - - - void - - onResume() - -
- - - - - - void - - onSaveInstanceState(Bundle outState) - -
- - - - - - void - - onStart() - -
- - - - - - void - - onStop() - -
- - - - - - void - - setEnabled(boolean enabled) - -
- Sets a boolean that will enable or disable the fragment's UI components when it's in - READY. - - - -
- -
- - - - - - void - - setOnStateChangedListener(WalletFragment.OnStateChangedListener listener) - -
- Sets a listener to receive state transition callbacks. - - - -
- -
- - - - - - void - - updateMaskedWallet(MaskedWallet maskedWallet) - -
- Modifies the MaskedWallet. - - - -
- -
- - - - - - void - - updateMaskedWalletRequest(MaskedWalletRequest request) - -
- Modifies the MaskedWalletRequest. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Fragment - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - android.view.View.OnCreateContextMenuListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WalletFragment - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getState - () -

-
-
- - - -
-
- - - - -

Returns the current state of the fragment. See WalletFragmentState for list of - possible values. Note that UNKNOWN may be returned under the - following circumstances: -

    -
  • before onStart() is executed
    • -
  • when Google Play services is unavailable or requires update
    • -
-

- -
-
- - - - -
-

- - public - - - - - void - - initialize - (WalletFragmentInitParams initParams) -

-
-
- - - -
-
- - - - -

Initializes the fragment. This must be called exactly once. Any further invocations after - the first will be ignored. -

- -
-
- - - - -
-

- - public - static - - - - WalletFragment - - newInstance - (WalletFragmentOptions options) -

-
-
- - - -
-
- - - - -

Creates a Wallet fragment with the given options. -

- -
-
- - - - -
-

- - public - - - - - void - - onActivityResult - (int requestCode, int resultCode, Intent data) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - (Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - View - - onCreateView - (LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInflate - (Activity activity, AttributeSet attrs, Bundle savedInstanceState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onPause - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onResume - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onSaveInstanceState - (Bundle outState) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onStart - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onStop - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - setEnabled - (boolean enabled) -

-
-
- - - -
-
- - - - -

Sets a boolean that will enable or disable the fragment's UI components when it's in - READY. The UI components can not be disabled in other states - and the boolean has no effect. This method is meant for temporarily disabling the buy - button while you load data or update UI in your app. -

- -
-
- - - - -
-

- - public - - - - - void - - setOnStateChangedListener - (WalletFragment.OnStateChangedListener listener) -

-
-
- - - -
-
- - - - -

Sets a listener to receive state transition callbacks. -

- -
-
- - - - -
-

- - public - - - - - void - - updateMaskedWallet - (MaskedWallet maskedWallet) -

-
-
- - - -
-
- - - - -

Modifies the MaskedWallet. This should be called after - initialize(WalletFragmentInitParams). Any non-null maskedWallet - passed in here takes precedence over the MaskedWallet in - WalletFragmentInitParams passed in initialize(WalletFragmentInitParams). -

- -
-
- - - - -
-

- - public - - - - - void - - updateMaskedWalletRequest - (MaskedWalletRequest request) -

-
-
- - - -
-
- - - - -

Modifies the MaskedWalletRequest. This should be called after - initialize(WalletFragmentInitParams). Any non-null request passed in here - takes precedence over the MaskedWalletRequest in WalletFragmentInitParams - passed in initialize(WalletFragmentInitParams). -

- Note that any user buy button click event before this method call would load a masked wallet - using whatever MaskedWalletRequest available at that time. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.Builder.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.Builder.html deleted file mode 100644 index 64a7ad51b7eb..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.Builder.html +++ /dev/null @@ -1,1532 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentInitParams.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentInitParams.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentInitParams.Builder
- - - - - - - -
- - -

Class Overview

-

Builder for building a WalletFragmentInitParams. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - WalletFragmentInitParams - - build() - -
- - - - - - WalletFragmentInitParams.Builder - - setAccountName(String accountName) - -
- Specify a Google account name on the device that should be used. - - - -
- -
- - - - - - WalletFragmentInitParams.Builder - - setMaskedWallet(MaskedWallet maskedWallet) - -
- Sets a MaskedWallet to be used for displaying masked wallet details. - - - -
- -
- - - - - - WalletFragmentInitParams.Builder - - setMaskedWalletRequest(MaskedWalletRequest request) - -
- Sets a MaskedWalletRequest for retrieving the user's masked payment credentials. - - - -
- -
- - - - - - WalletFragmentInitParams.Builder - - setMaskedWalletRequestCode(int requestCode) - -
- Sets a request code to be passed back in onActivityResult for the masked wallet result. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - WalletFragmentInitParams - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentInitParams.Builder - - setAccountName - (String accountName) -

-
-
- - - -
-
- - - - -

Specify a Google account name on the device that should be used. If not set, the user - might be asked to select an account if multiple accounts are present on the device. -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentInitParams.Builder - - setMaskedWallet - (MaskedWallet maskedWallet) -

-
-
- - - -
-
- - - - -

Sets a MaskedWallet to be used for displaying masked wallet details. - Exactly one of MaskedWalletRequest or MaskedWallet should be set. -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentInitParams.Builder - - setMaskedWalletRequest - (MaskedWalletRequest request) -

-
-
- - - -
-
- - - - -

Sets a MaskedWalletRequest for retrieving the user's masked payment credentials. - Exactly one of MaskedWalletRequest or MaskedWallet should be set. -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentInitParams.Builder - - setMaskedWalletRequestCode - (int requestCode) -

-
-
- - - -
-
- - - - -

Sets a request code to be passed back in onActivityResult for the masked wallet result. - This is required and must be non-negative. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.html deleted file mode 100644 index 52c1ba56c811..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.html +++ /dev/null @@ -1,1828 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentInitParams | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentInitParams

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentInitParams
- - - - - - - -
- - -

Class Overview

-

Parameters for initializing WalletFragment. - Pass this to initialize(WalletFragmentInitParams). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWalletFragmentInitParams.Builder - Builder for building a WalletFragmentInitParams.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<WalletFragmentInitParams>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - String - - getAccountName() - -
- - - - - - MaskedWallet - - getMaskedWallet() - -
- - - - - - MaskedWalletRequest - - getMaskedWalletRequest() - -
- - - - - - int - - getMaskedWalletRequestCode() - -
- - - - static - - WalletFragmentInitParams.Builder - - newBuilder() - -
- Returns a new builder for building a WalletFragmentInitParams. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<WalletFragmentInitParams> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getAccountName - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWallet - - getMaskedWallet - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - MaskedWalletRequest - - getMaskedWalletRequest - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getMaskedWalletRequestCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - WalletFragmentInitParams.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

Returns a new builder for building a WalletFragmentInitParams. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentMode.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentMode.html deleted file mode 100644 index 4a7f65befdb5..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentMode.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentMode | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentMode

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentMode
- - - - - - - -
- - -

Class Overview

-

Set of constants which define Wallet fragment modes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intBUY_BUTTON - Buy button mode. - - - -
intSELECTION_DETAILS - Selection details mode. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - BUY_BUTTON -

-
- - - - -
-
- - - - -

Buy button mode. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - SELECTION_DETAILS -

-
- - - - -
-
- - - - -

Selection details mode. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.Builder.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.Builder.html deleted file mode 100644 index 741a0f08d588..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.Builder.html +++ /dev/null @@ -1,1637 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentOptions.Builder
- - - - - - - -
- - -

Class Overview

-

Builder for building WalletFragmentOptions. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - WalletFragmentOptions - - build() - -
- - - - - - WalletFragmentOptions.Builder - - setEnvironment(int environment) - -
- Sets the Google Wallet environment to use. - - - -
- -
- - - - - - WalletFragmentOptions.Builder - - setFragmentStyle(int styleResourceId) - -
- Sets a set of attributes to customize the look and feel of the UI components of a - WalletFragment. - - - -
- -
- - - - - - WalletFragmentOptions.Builder - - setFragmentStyle(WalletFragmentStyle fragmentStyle) - -
- Sets a set of attributes to customize the look and feel of the UI components of a - WalletFragment. - - - -
- -
- - - - - - WalletFragmentOptions.Builder - - setMode(int mode) - -
- Sets the mode of the wallet fragment. - - - -
- -
- - - - - - WalletFragmentOptions.Builder - - setTheme(int theme) - -
- Sets a theme for the Wallet selector on Android OS with - SDK_INT - >= HONEYCOMB. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - WalletFragmentOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentOptions.Builder - - setEnvironment - (int environment) -

-
-
- - - -
-
- - - - -

Sets the Google Wallet environment to use. Specify - ENVIRONMENT_SANDBOX until you have applied for and been granted - access to the Production environment. - Defaults to ENVIRONMENT_SANDBOX.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentOptions.Builder - - setFragmentStyle - (int styleResourceId) -

-
-
- - - -
-
- - - - -

Sets a set of attributes to customize the look and feel of the UI components of a - WalletFragment. - If not set explicitly the default style - WalletFragmentDefaultStyle will be used. - In most cases you will need to customize the style of the wallet fragment so that - the UI of the fragment better matches the UI of the application.

-
-
Parameters
- - - - -
styleResourceId - id of a style resource that defines the attributes. See - WalletFragmentStyle for a list of - attributes available
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentOptions.Builder - - setFragmentStyle - (WalletFragmentStyle fragmentStyle) -

-
-
- - - -
-
- - - - -

Sets a set of attributes to customize the look and feel of the UI components of a - WalletFragment.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentOptions.Builder - - setMode - (int mode) -

-
-
- - - -
-
- - - - -

Sets the mode of the wallet fragment. - Supported modes are defined by WalletFragmentMode. - Defaults to BUY_BUTTON.

-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentOptions.Builder - - setTheme - (int theme) -

-
-
- - - -
-
- - - - -

Sets a theme for the Wallet selector on Android OS with - SDK_INT - >= HONEYCOMB. The only legitimate values are - THEME_DARK and THEME_LIGHT - as those are the only supported themes. User-created themes are not supported. - Value ignored for Android OS with SDK_INT - < HONEYCOMB. Defaults to - THEME_DARK.

-
-
See Also
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.html deleted file mode 100644 index 95ba843389df..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.html +++ /dev/null @@ -1,1833 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentOptions

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentOptions
- - - - - - - -
- - -

Class Overview

-

Defines configurations for WalletFragment. You can pass the options in using the static - factory method newInstance(WalletFragmentOptions). If you add a Wallet - fragment using XML, you can apply these options using custom XML tags.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWalletFragmentOptions.Builder - Builder for building WalletFragmentOptions.  - - - -
- - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<WalletFragmentOptions>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - int - - getEnvironment() - -
- - - - - - WalletFragmentStyle - - getFragmentStyle() - -
- - - - - - int - - getMode() - -
- - - - - - int - - getTheme() - -
- - - - static - - WalletFragmentOptions.Builder - - newBuilder() - -
- Returns a new builder for building a WalletFragmentOptions. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<WalletFragmentOptions> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getEnvironment - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - getFragmentStyle - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getMode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - int - - getTheme - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - static - - - - WalletFragmentOptions.Builder - - newBuilder - () -

-
-
- - - -
-
- - - - -

Returns a new builder for building a WalletFragmentOptions. -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentState.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentState.html deleted file mode 100644 index fa92a19bcc63..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentState.html +++ /dev/null @@ -1,1531 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentState | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentState

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentState
- - - - - - - -
- - -

Class Overview

-

State of WalletFragment. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intPROCESSING - The user has clicked the buy/change button and is waiting for the result. - - - -
intREADY - The fragment has been initialized and its UI components are ready for user interaction. - - - -
intUNINITIALIZED - The fragment starts in this state. - - - -
intUNKNOWN - Only returned before onStart is called or if Google Play Services is - unavailable or requires update. - - - -
intWALLET_UNAVAILABLE - Wallet service is temporarily not available. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - PROCESSING -

-
- - - - -
-
- - - - -

The user has clicked the buy/change button and is waiting for the result. - The buy button will be disabled to prevent further user interaction. -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - READY -

-
- - - - -
-
- - - - -

The fragment has been initialized and its UI components are ready for user interaction. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNINITIALIZED -

-
- - - - -
-
- - - - -

The fragment starts in this state. UI components are disabled. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN -

-
- - - - -
-
- - - - -

Only returned before onStart is called or if Google Play Services is - unavailable or requires update. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - WALLET_UNAVAILABLE -

-
- - - - -
-
- - - - -

Wallet service is temporarily not available. UI components are disabled. -

- - -
- Constant Value: - - - 4 - (0x00000004) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentStyle.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentStyle.html deleted file mode 100644 index 6aec1a41fc75..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletFragmentStyle.html +++ /dev/null @@ -1,2741 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletFragmentStyle | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletFragmentStyle

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletFragmentStyle
- - - - - - - -
- - -

Class Overview

-

Defines attributes to customize the look and feel of WalletFragment, to be used in - setFragmentStyle(WalletFragmentStyle). You may also - specify these attributes using custom XML tags in a style resource and either add - wallet:fragmentStyle="@style/MyWalletFragmentCustomStyle" to your - <fragment> tag or pass the id of the style resource in - setFragmentStyle(int). - - See WalletFragmentDefaultStyle for - an example of the wallet fragment style. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<WalletFragmentStyle>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WalletFragmentStyle() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - describeContents() - -
- - - - - - WalletFragmentStyle - - setBuyButtonAppearance(int buyButtonAppearance) - -
- Sets the appearance of the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setBuyButtonHeight(int height) - -
- Specifies a height for the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setBuyButtonHeight(int unit, float height) - -
- Specifies a height for the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setBuyButtonText(int buyButtonText) - -
- Sets text for the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setBuyButtonWidth(int width) - -
- Specifies a width for the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setBuyButtonWidth(int unit, float width) - -
- Specifies a width for the buy button. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsBackgroundColor(int color) - -
- Sets the color for the masked wallet details view background. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsBackgroundResource(int resourceId) - -
- Sets the drawable resource id for the masked wallet details view background. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonBackgroundColor(int color) - -
- Sets the color for the masked wallet details "Change" button background. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonBackgroundResource(int resourceId) - -
- Sets the drawable resource id for the masked wallet details "Change" button background. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonTextAppearance(int resourceId) - -
- Sets the text appearance for the masked wallet details "Change" button text. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsHeaderTextAppearance(int resourceId) - -
- Sets text appearance for the headers describing masked wallet details. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsLogoImageType(int imageType) - -
- Sets the type of the wallet image logo in masked wallet details view. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsLogoTextColor(int color) - -
- Sets the color for the masked wallet details logo text. - - - -
- -
- - - - - - WalletFragmentStyle - - setMaskedWalletDetailsTextAppearance(int resourceId) - -
- Sets text appearance for the masked wallet details. - - - -
- -
- - - - - - WalletFragmentStyle - - setStyleResourceId(int id) - -
- Sets resource id of the style which will be used to customize wallet fragment UI. - - - -
- -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<WalletFragmentStyle> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WalletFragmentStyle - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonAppearance - (int buyButtonAppearance) -

-
-
- - - -
-
- - - - -

Sets the appearance of the buy button. - See BuyButtonAppearance for the list of possible values. - Defaults to CLASSIC. - This will override the buy button appearance defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
buyButtonAppearance - appearance of the buy button
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonHeight - (int height) -

-
-
- - - -
-
- - - - -

Specifies a height for the buy button. The height includes a padding of 8dp (4dp on each - side). The padding is used for a border around the button in pressed and focused states. - The range of height supported is 40dp~72dp. - This will override the buy button height defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
height - height in pixels, or MATCH_PARENT, - WRAP_CONTENT -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonHeight - (int unit, float height) -

-
-
- - - -
-
- - - - -

Specifies a height for the buy button. The height includes a padding of 8dp (4dp on each - side). The padding is used for a border around the button in pressed and focused states. - The range of height supported is 40dp~72dp. - This will override the buy button height defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - - - - -
unit - unit of the height value. See constants starting with UNIT_ in Dimension - for a list of supported units
height - value of the height -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonText - (int buyButtonText) -

-
-
- - - -
-
- - - - -

Sets text for the buy button. - This will override the buy button text defined in any style passed in - setStyleResourceId(int). - See BuyButtonText for the list of possible values. - Defaults to BUY_WITH_GOOGLE.

-
-
Parameters
- - - - -
buyButtonText - text on the buy button
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonWidth - (int width) -

-
-
- - - -
-
- - - - -

Specifies a width for the buy button. The width includes a padding of 8dp (4dp on each - side). The padding is used for a border around the button in pressed and focused states. - A minimum width is enforced, and is computed from the height of the button and the width - of the button text. - This will override the buy button width defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
width - width in pixels, or MATCH_PARENT, - WRAP_CONTENT -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setBuyButtonWidth - (int unit, float width) -

-
-
- - - -
-
- - - - -

Specifies a width for the buy button. The width includes a padding of 8dp (4dp on each - side). The padding is used for a border around the button in pressed and focused states. - A minimum width is enforced, and is computed from the height of the button and the width - of the button text. - This will override the buy button width defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - - - - -
unit - unit of the width value. See constants starting with UNIT_ in Dimension - for a list of supported units
width - value of the width -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsBackgroundColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the color for the masked wallet details view background. - This will override the color defined in any style passed in - setStyleResourceId(int) and background drawable which was previously set.

-
-
Parameters
- - - - -
color - the color as defined in android.graphics.Color -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsBackgroundResource - (int resourceId) -

-
-
- - - -
-
- - - - -

Sets the drawable resource id for the masked wallet details view background. - This will override the drawable defined in any style passed in - setStyleResourceId(int) and background color which was previously set.

-
-
Parameters
- - - - -
resourceId - the id of the drawable resource. -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonBackgroundColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the color for the masked wallet details "Change" button background. - This will override the background defined in any style passed in - setStyleResourceId(int) and drawable resource id which was previously set for - button background.

-
-
Parameters
- - - - -
color - the color as defined in android.graphics.Color -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonBackgroundResource - (int resourceId) -

-
-
- - - -
-
- - - - -

Sets the drawable resource id for the masked wallet details "Change" button background. - This will override the background defined in any style passed in - setStyleResourceId(int) and color previously set for the button background.

-
-
Parameters
- - - - -
resourceId - the id of the drawable resource. -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsButtonTextAppearance - (int resourceId) -

-
-
- - - -
-
- - - - -

Sets the text appearance for the masked wallet details "Change" button text. - This will override the text appearance defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
resourceId - the id of a TextAppearance style -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsHeaderTextAppearance - (int resourceId) -

-
-
- - - -
-
- - - - -

Sets text appearance for the headers describing masked wallet details. - This will override the text appearance defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
resourceId - the id of a TextAppearance style -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsLogoImageType - (int imageType) -

-
-
- - - -
-
- - - - -

Sets the type of the wallet image logo in masked wallet details view. - See WalletLogoImageType for the list of possible values. - Defaults to CLASSIC. - This will override the image type defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
imageType - the type of the logo image.
-
-
-
See Also
- -
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsLogoTextColor - (int color) -

-
-
- - - -
-
- - - - -

Sets the color for the masked wallet details logo text. - This will override the text color defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
color - the color as defined in android.graphics.Color -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setMaskedWalletDetailsTextAppearance - (int resourceId) -

-
-
- - - -
-
- - - - -

Sets text appearance for the masked wallet details. - This will override the text appearance defined in any style passed in - setStyleResourceId(int).

-
-
Parameters
- - - - -
resourceId - the id of a TextAppearance style -
-
- -
-
- - - - -
-

- - public - - - - - WalletFragmentStyle - - setStyleResourceId - (int id) -

-
-
- - - -
-
- - - - -

Sets resource id of the style which will be used to customize wallet fragment UI. - If not set explicitly the default style - WalletFragmentDefaultStyle will be used. - In most cases you will need to customize the style of the wallet fragment so that - the UI of the fragment better matches the UI of the application.

-
-
Parameters
- - - - -
id - id of a style defined in xml -
-
- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletLogoImageType.html b/docs/html/reference/com/google/android/gms/wallet/fragment/WalletLogoImageType.html deleted file mode 100644 index c37c77020fb6..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/WalletLogoImageType.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WalletLogoImageType | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WalletLogoImageType

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wallet.fragment.WalletLogoImageType
- - - - - - - -
- - -

Class Overview

-

Wallet logo image types. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCLASSIC - Classic wallet logo image. - - - -
intMONOCHROME - Monochrome wallet logo image. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CLASSIC -

-
- - - - -
-
- - - - -

Classic wallet logo image. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - MONOCHROME -

-
- - - - -
-
- - - - -

Monochrome wallet logo image. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/fragment/package-summary.html b/docs/html/reference/com/google/android/gms/wallet/fragment/package-summary.html deleted file mode 100644 index 912e174220a1..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/fragment/package-summary.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.wallet.fragment | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.wallet.fragment

-
- -
- -
- - -
- Contains WalletFragment. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - -
SupportWalletFragment.OnStateChangedListener -   - - - -
WalletFragment.OnStateChangedListener -   - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BuyButtonAppearance - Options for Wallet button appearance.  - - - -
BuyButtonText - Options for text displayed on the Wallet buy button.  - - - -
Dimension - Constants for specifying dimensions in WalletFragmentStyle.  - - - -
SupportWalletFragment - This fragment is the simplest way to place a Wallet buy button or selection details UI - in an application for the InstantBuy API.  - - - -
WalletFragment - This fragment is the simplest way to place a Wallet buy button or selection details UI - in an application for the InstantBuy API.  - - - -
WalletFragmentInitParams - Parameters for initializing WalletFragment.  - - - -
WalletFragmentInitParams.Builder - Builder for building a WalletFragmentInitParams.  - - - -
WalletFragmentMode - Set of constants which define Wallet fragment modes.  - - - -
WalletFragmentOptions - Defines configurations for WalletFragment.  - - - -
WalletFragmentOptions.Builder - Builder for building WalletFragmentOptions.  - - - -
WalletFragmentState - State of WalletFragment.  - - - -
WalletFragmentStyle - Defines attributes to customize the look and feel of WalletFragment, to be used in - setFragmentStyle(WalletFragmentStyle).  - - - -
WalletLogoImageType - Wallet logo image types.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wallet/package-summary.html b/docs/html/reference/com/google/android/gms/wallet/package-summary.html deleted file mode 100644 index 285432bfd1b3..000000000000 --- a/docs/html/reference/com/google/android/gms/wallet/package-summary.html +++ /dev/null @@ -1,1221 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.wallet | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.wallet

-
- -
- -
- - -
- Contains the Wallet Client for Google Play services. - -
- - - - - - - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LineItem.Role - Role of a line item.  - - - -
NotifyTransactionStatusRequest.Status - Status received from processing a ProxyCard.  - - - -
NotifyTransactionStatusRequest.Status.Error - Failure statuses received from processing a ProxyCard.  - - - -
Payments - Entry point for interacting with Wallet buyflow APIs.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Address - Parcelable representing an address.  - - - -
Cart - Parcelable representing a shopping cart.  - - - -
Cart.Builder - Builder to create a Cart.  - - - -
CountrySpecification - Parcelable representing a country.  - - - -
EnableWalletOptimizationReceiver - A dummy BroadcastReceiver used with an IntentFilter specifying action - ACTION_ENABLE_WALLET_OPTIMIZATION to signal that your application uses - Wallet.  - - - -
FullWallet - Parcelable representing a full wallet response.  - - - -
FullWalletRequest - Parcelable representing a full wallet request.  - - - -
FullWalletRequest.Builder - Builder to create a FullWalletRequest.  - - - -
GiftCardWalletObject - Parcelable representing a gift card wallet object.  - - - -
InstrumentInfo - Parcelable representing more detailed information about a payment instrument.  - - - -
LineItem - Parcelable representing a line item in a shopping cart.  - - - -
LineItem.Builder - Builder to create a LineItem.  - - - -
LoyaltyWalletObject - Parcelable representing a loyalty wallet object.  - - - -
MaskedWallet - Parcelable representing a masked wallet response.  - - - -
MaskedWallet.Builder - Builder to create a MaskedWallet.  - - - -
MaskedWalletRequest - Parcelable representing a masked wallet request.  - - - -
MaskedWalletRequest.Builder - Builder to create a MaskedWalletRequest.  - - - -
NotifyTransactionStatusRequest - Parcelable representing a notify transaction status request.  - - - -
NotifyTransactionStatusRequest.Builder - Builder to create a NotifyTransactionStatusRequest.  - - - -
OfferWalletObject - Parcelable representing an offer wallet object.  - - - -
PaymentInstrumentType - Payment instrument types that a merchant can support.  - - - -
ProxyCard - Parcelable representing a credit card.  - - - -
Wallet - The main entry point for Google Wallet integration.  - - - -
Wallet.WalletOptions - Options for using the Wallet API.  - - - -
Wallet.WalletOptions.Builder -   - - - -
WalletConstants - Collection of constant values used by the ClientLibrary.  - - - -
- -
- - - - - - - - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Asset.html b/docs/html/reference/com/google/android/gms/wearable/Asset.html deleted file mode 100644 index 9c59bbd415ec..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Asset.html +++ /dev/null @@ -1,2099 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Asset | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Asset

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.Asset
- - - - - - - -
- - -

Class Overview

-

An asset is a binary blob shared between data items that is replicated across the wearable - network on demand. -

- It may represent an asset not yet added with the Android Wear network. - DataItemAssets are representations of an asset after it has been added to the - network through a PutDataRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<Asset>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - Asset - - createFromBytes(byte[] assetData) - -
- Creates an Asset using a byte array. - - - -
- -
- - - - static - - Asset - - createFromFd(ParcelFileDescriptor fd) - -
- Creates an Asset using a file descriptor. - - - -
- -
- - - - static - - Asset - - createFromRef(String digest) - -
- Create an Asset using an existing Asset's digest. - - - -
- -
- - - - static - - Asset - - createFromUri(Uri uri) - -
- Creates an Asset using a content URI. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - boolean - - equals(Object o) - -
- - - - - - String - - getDigest() - -
- Returns the digest associated with the asset data. - - - -
- -
- - - - - - ParcelFileDescriptor - - getFd() - -
- Returns the file descriptor referencing the asset. - - - -
- -
- - - - - - Uri - - getUri() - -
- Returns the uri referencing the asset data. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<Asset> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - Asset - - createFromBytes - (byte[] assetData) -

-
-
- - - -
-
- - - - -

Creates an Asset using a byte array. -

- -
-
- - - - -
-

- - public - static - - - - Asset - - createFromFd - (ParcelFileDescriptor fd) -

-
-
- - - -
-
- - - - -

Creates an Asset using a file descriptor. The FD should be closed after being successfully - sent in a putDataItem request. -

- -
-
- - - - -
-

- - public - static - - - - Asset - - createFromRef - (String digest) -

-
-
- - - -
-
- - - - -

Create an Asset using an existing Asset's digest. -

- -
-
- - - - -
-

- - public - static - - - - Asset - - createFromUri - (Uri uri) -

-
-
- - - -
-
- - - - -

Creates an Asset using a content URI. Google Play services must have permission to read this - Uri. -

- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - getDigest - () -

-
-
- - - -
-
- - - - -

Returns the digest associated with the asset data. A digest is a content identifier used to - identify the asset across devices.

-
-
Returns
-
  • the Asset's digest, or null if the digest is unset -
-
- -
-
- - - - -
-

- - public - - - - - ParcelFileDescriptor - - getFd - () -

-
-
- - - -
-
- - - - -

Returns the file descriptor referencing the asset. -

- -
-
- - - - -
-

- - public - - - - - Uri - - getUri - () -

-
-
- - - -
-
- - - - -

Returns the uri referencing the asset data. -

- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.AddLocalCapabilityResult.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.AddLocalCapabilityResult.html deleted file mode 100644 index 1f8ac165ee7e..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.AddLocalCapabilityResult.html +++ /dev/null @@ -1,1076 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi.AddLocalCapabilityResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

CapabilityApi.AddLocalCapabilityResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi.AddLocalCapabilityResult
- - - - - - - -
- - -

Class Overview

-

Result returned from addLocalCapability(GoogleApiClient, String)

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.CapabilityListener.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.CapabilityListener.html deleted file mode 100644 index 4ff03a4dbcf5..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.CapabilityListener.html +++ /dev/null @@ -1,1111 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi.CapabilityListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

CapabilityApi.CapabilityListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi.CapabilityListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Listener for changes in the reachable nodes providing a capability.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onCapabilityChanged(CapabilityInfo capabilityInfo) - -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onCapabilityChanged - (CapabilityInfo capabilityInfo) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetAllCapabilitiesResult.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetAllCapabilitiesResult.html deleted file mode 100644 index af629639640a..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetAllCapabilitiesResult.html +++ /dev/null @@ -1,1141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi.GetAllCapabilitiesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

CapabilityApi.GetAllCapabilitiesResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi.GetAllCapabilitiesResult
- - - - - - - -
- - -

Class Overview

-

Result returned from getAllCapabilities(GoogleApiClient, int)

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Map<String, CapabilityInfo> - - getAllCapabilities() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Map<String, CapabilityInfo> - - getAllCapabilities - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetCapabilityResult.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetCapabilityResult.html deleted file mode 100644 index daf13c517464..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.GetCapabilityResult.html +++ /dev/null @@ -1,1141 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi.GetCapabilityResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

CapabilityApi.GetCapabilityResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi.GetCapabilityResult
- - - - - - - -
- - -

Class Overview

-

Result returned from getCapability(GoogleApiClient, String, int)

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - CapabilityInfo - - getCapability() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - CapabilityInfo - - getCapability - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.RemoveLocalCapabilityResult.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.RemoveLocalCapabilityResult.html deleted file mode 100644 index 83df493ad8d8..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.RemoveLocalCapabilityResult.html +++ /dev/null @@ -1,1076 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi.RemoveLocalCapabilityResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

CapabilityApi.RemoveLocalCapabilityResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi.RemoveLocalCapabilityResult
- - - - - - - -
- - -

Class Overview

-

Result returned from removeLocalCapability(GoogleApiClient, String)

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.html deleted file mode 100644 index 2950a2523874..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityApi.html +++ /dev/null @@ -1,1594 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

CapabilityApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityApi
- - - - - - - -
- - -

Class Overview

-

Exposes an API to learn about capabilities provided by nodes on the Wear network. - -

Capabilities are local to an application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceCapabilityApi.AddLocalCapabilityResult - Result returned from addLocalCapability(GoogleApiClient, String)   - - - -
- - - - - interfaceCapabilityApi.CapabilityListener - Listener for changes in the reachable nodes providing a capability.  - - - -
- - - - - interfaceCapabilityApi.GetAllCapabilitiesResult - Result returned from getAllCapabilities(GoogleApiClient, int)   - - - -
- - - - - interfaceCapabilityApi.GetCapabilityResult - Result returned from getCapability(GoogleApiClient, String, int)   - - - -
- - - - - interfaceCapabilityApi.RemoveLocalCapabilityResult - Result returned from removeLocalCapability(GoogleApiClient, String)   - - - -
- - - - - - - - - - - - - - - - - - -
Constants
intFILTER_ALL - Filter type for - getCapability(GoogleApiClient, String, int), - getAllCapabilities(GoogleApiClient, int): - If this filter is set then the full set of nodes that declare the given capability will - be included in the capability's CapabilityInfo. - - - -
intFILTER_REACHABLE - Filter type for - getCapability(GoogleApiClient, String, int), - getAllCapabilities(GoogleApiClient, int): - If this filter is set then only reachable nodes that declare the given capability will - be included in the capability's CapabilityInfo. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addCapabilityListener(GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability) - -
- Registers a listener to be notified of capabilities being added to or removed from the Wear - network. - - - -
- -
- abstract - - - - - PendingResult<CapabilityApi.AddLocalCapabilityResult> - - addLocalCapability(GoogleApiClient client, String capability) - -
- Announces that a capability has become available on the local node. - - - -
- -
- abstract - - - - - PendingResult<CapabilityApi.GetAllCapabilitiesResult> - - getAllCapabilities(GoogleApiClient client, int nodeFilter) - -
- Returns information about all capabilities, including the nodes that declare - those capabilities. - - - -
- -
- abstract - - - - - PendingResult<CapabilityApi.GetCapabilityResult> - - getCapability(GoogleApiClient client, String capability, int nodeFilter) - -
- Returns information about a capability, including the nodes that declare that capability. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeCapabilityListener(GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability) - -
- Removes a listener which was previously added through addCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String). - - - -
- -
- abstract - - - - - PendingResult<CapabilityApi.RemoveLocalCapabilityResult> - - removeLocalCapability(GoogleApiClient client, String capability) - -
- Announces that a capability is no longer available on the local node. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - FILTER_ALL -

-
- - - - -
-
- - - - -

Filter type for - getCapability(GoogleApiClient, String, int), - getAllCapabilities(GoogleApiClient, int): - If this filter is set then the full set of nodes that declare the given capability will - be included in the capability's CapabilityInfo. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FILTER_REACHABLE -

-
- - - - -
-
- - - - -

Filter type for - getCapability(GoogleApiClient, String, int), - getAllCapabilities(GoogleApiClient, int): - If this filter is set then only reachable nodes that declare the given capability will - be included in the capability's CapabilityInfo. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addCapabilityListener - (GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability) -

-
-
- - - -
-
- - - - -

Registers a listener to be notified of capabilities being added to or removed from the Wear - network. - Calls to this method should be balanced with removeCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String) to avoid - leaking resources. - -

Callers wishing to be notified of events in the background should use - WearableListenerService. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<CapabilityApi.AddLocalCapabilityResult> - - addLocalCapability - (GoogleApiClient client, String capability) -

-
-
- - - -
-
- - - - -

Announces that a capability has become available on the local node. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<CapabilityApi.GetAllCapabilitiesResult> - - getAllCapabilities - (GoogleApiClient client, int nodeFilter) -

-
-
- - - -
-
- - - - -

Returns information about all capabilities, including the nodes that declare - those capabilities. The filter parameter controls whether all nodes are returned, - FILTER_ALL, or only those that are currently reachable by this node, - FILTER_REACHABLE. -

The local node will never be returned in the set of nodes. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<CapabilityApi.GetCapabilityResult> - - getCapability - (GoogleApiClient client, String capability, int nodeFilter) -

-
-
- - - -
-
- - - - -

Returns information about a capability, including the nodes that declare that capability. - The filter parameter controls whether all nodes are returned, FILTER_ALL, or - only those that are currently reachable by this node, FILTER_REACHABLE. -

The local node will never be returned in the set of nodes. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeCapabilityListener - (GoogleApiClient client, CapabilityApi.CapabilityListener listener, String capability) -

-
-
- - - -
-
- - - - -

Removes a listener which was previously added through addCapabilityListener(GoogleApiClient, CapabilityApi.CapabilityListener, String). - The listener is only removed from listening for the capability provided and will - continue to receive messages for any other capabilities it was previously registered for - that have not also been removed. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<CapabilityApi.RemoveLocalCapabilityResult> - - removeLocalCapability - (GoogleApiClient client, String capability) -

-
-
- - - -
-
- - - - -

Announces that a capability is no longer available on the local node. - Note: this will not remove any capabilities announced in the Manifest for an app. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/CapabilityInfo.html b/docs/html/reference/com/google/android/gms/wearable/CapabilityInfo.html deleted file mode 100644 index fdde207017b5..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/CapabilityInfo.html +++ /dev/null @@ -1,1117 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -CapabilityInfo | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

CapabilityInfo

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.CapabilityInfo
- - - - - - - -
- - -

Class Overview

-

Information about a Capability on the network and where it is available. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getName() - -
- Returns the name of the capability. - - - -
- -
- abstract - - - - - Set<Node> - - getNodes() - -
- Returns the set of nodes for the capability. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getName - () -

-
-
- - - -
-
- - - - -

Returns the name of the capability. -

- -
-
- - - - -
-

- - public - - - abstract - - Set<Node> - - getNodes - () -

-
-
- - - -
-
- - - - -

Returns the set of nodes for the capability. Disconnected nodes may or may not be included in - the set. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Channel.GetInputStreamResult.html b/docs/html/reference/com/google/android/gms/wearable/Channel.GetInputStreamResult.html deleted file mode 100644 index c1f9fc12d72a..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Channel.GetInputStreamResult.html +++ /dev/null @@ -1,1211 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Channel.GetInputStreamResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Channel.GetInputStreamResult

- - - - - - implements - - Releasable - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.Channel.GetInputStreamResult
- - - - - - - -
- - -

Class Overview

-

Result of getInputStream(GoogleApiClient). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - InputStream - - getInputStream() - -
- Returns an input stream which can read data from the remote node. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - InputStream - - getInputStream - () -

-
-
- - - -
-
- - - - -

Returns an input stream which can read data from the remote node. The stream should be - closed when no longer needed. This method will only return null if this result's - status was not success. - -

The returned stream will throw IOException on read if any connection - errors occur. This exception might be a ChannelIOException. - -

Since data for this stream comes over the network, reads may block for a long - time. - -

Multiple calls to this method will return the same instance. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Channel.GetOutputStreamResult.html b/docs/html/reference/com/google/android/gms/wearable/Channel.GetOutputStreamResult.html deleted file mode 100644 index 5edfe44e4569..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Channel.GetOutputStreamResult.html +++ /dev/null @@ -1,1212 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Channel.GetOutputStreamResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

Channel.GetOutputStreamResult

- - - - - - implements - - Releasable - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.Channel.GetOutputStreamResult
- - - - - - - -
- - -

Class Overview

-

Result of getOutputStream(GoogleApiClient). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - OutputStream - - getOutputStream() - -
- Returns an output stream which can send data to a remote node. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - OutputStream - - getOutputStream - () -

-
-
- - - -
-
- - - - -

Returns an output stream which can send data to a remote node. The stream should be - closed when no longer needed. This method will only return null if this result's - status was not success. - -

The returned stream will throw IOException on write if any connection - errors occur. This exception might be a ChannelIOException. - -

Data written to this stream is buffered. If you wish to send the current data - without waiting for the buffer to fill up, flush the - stream. - -

Multiple calls to this method will return the same instance. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Channel.html b/docs/html/reference/com/google/android/gms/wearable/Channel.html deleted file mode 100644 index 48b80da89d58..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Channel.html +++ /dev/null @@ -1,2016 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Channel | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

Channel

- - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.Channel
- - - - - - - -
- - -

Class Overview

-

A channel created through openChannel(GoogleApiClient, String, String). - -

The implementation of this interface is parcelable and immutable, and implements - reasonable equals(Object) and hashCode() methods, so - can be used in collections. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceChannel.GetInputStreamResult - Result of getInputStream(GoogleApiClient).  - - - -
- - - - - interfaceChannel.GetOutputStreamResult - Result of getOutputStream(GoogleApiClient).  - - - -
- - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addListener(GoogleApiClient client, ChannelApi.ChannelListener listener) - -
- Registers a listener to be notified of events for this channel. - - - -
- -
- abstract - - - - - PendingResult<Status> - - close(GoogleApiClient client) - -
- Closes this channel, making any future operations on it invalid. - - - -
- -
- abstract - - - - - PendingResult<Status> - - close(GoogleApiClient client, int errorCode) - -
- Closes this channel, passing an application-defined error code to the remote node. - - - -
- -
- abstract - - - - - PendingResult<Channel.GetInputStreamResult> - - getInputStream(GoogleApiClient client) - -
- Opens the input side of the channel to receive data from the remote node. - - - -
- -
- abstract - - - - - String - - getNodeId() - -
- Returns the node ID of the node on the other side of the channel. - - - -
- -
- abstract - - - - - PendingResult<Channel.GetOutputStreamResult> - - getOutputStream(GoogleApiClient client) - -
- Opens the output side of the channel to send data to the remote node. - - - -
- -
- abstract - - - - - String - - getPath() - -
- Returns the path that was used to open the channel. - - - -
- -
- abstract - - - - - PendingResult<Status> - - receiveFile(GoogleApiClient client, Uri uri, boolean append) - -
- Reads input from this channel into a file. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeListener(GoogleApiClient client, ChannelApi.ChannelListener listener) - -
- Removes a listener which was previously added through - addListener(GoogleApiClient, ChannelApi.ChannelListener). - - - -
- -
- abstract - - - - - PendingResult<Status> - - sendFile(GoogleApiClient client, Uri uri, long startOffset, long length) - -
- Reads from a file into the output side of the channel. - - - -
- -
- abstract - - - - - PendingResult<Status> - - sendFile(GoogleApiClient client, Uri uri) - -
- Reads from a file into the output side of the channel. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addListener - (GoogleApiClient client, ChannelApi.ChannelListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to be notified of events for this channel. This is the same as - addListener(GoogleApiClient, ChannelApi.ChannelListener), but the listener - will only be notified of events for this channel. The listener will not receive - onChannelOpened(Channel) events. - -

Calls to this method should balanced with - removeListener(GoogleApiClient, ChannelApi.ChannelListener) to avoid - leaking resources.

-
-
Parameters
- - - - - - - -
client - a connected client
listener - a listener which will be notified of changes to the specified stream -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - close - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Closes this channel, making any future operations on it invalid. - -

This method behaves like close(GoogleApiClient, int), with - errorCode == 0.

-
-
Parameters
- - - - -
client - a connected client -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - close - (GoogleApiClient client, int errorCode) -

-
-
- - - -
-
- - - - -

Closes this channel, passing an application-defined error code to the remote node. The error - code will be passed to onChannelClosed(Channel, int, int), and will cause - remote reads and writes to the channel to fail with ChannelIOException. - -

The InputStream and OutputStream returned from - getInputStream(GoogleApiClient) or getOutputStream(GoogleApiClient) should - be closed prior to calling this method. If they are not, both streams will throw - ChannelIOException on the next read or write operation. - -

errorCode == 0 is used to indicate that no error occurred.

-
-
Parameters
- - - - - - - -
client - a connected client
errorCode - an app-defined error code to pass to the remote node -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Channel.GetInputStreamResult> - - getInputStream - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Opens the input side of the channel to receive data from the remote node. Methods on the - returned input stream may throw ChannelIOException. See - GetInputStreamResult.getInputStream() - -

This method should only be used once on any channel, and once it was called, - receiveFile(GoogleApiClient, Uri, boolean) cannot be used.

-
-
Parameters
- - - - -
client - a connected client -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getNodeId - () -

-
-
- - - -
-
- - - - -

Returns the node ID of the node on the other side of the channel.

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Channel.GetOutputStreamResult> - - getOutputStream - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Opens the output side of the channel to send data to the remote node. Methods on the - returned output stream may throw ChannelIOException. See - GetOutputStreamResult.getOutputStream() - -

This method should only be used once on any channel, and once it was called, - sendFile(GoogleApiClient, Uri, long, long) cannot be used.

-
-
Parameters
- - - - -
client - a connected client -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getPath - () -

-
-
- - - -
-
- - - - -

Returns the path that was used to open the channel.

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - receiveFile - (GoogleApiClient client, Uri uri, boolean append) -

-
-
- - - -
-
- - - - -

Reads input from this channel into a file. This is equivalent to calling - getInputStream(GoogleApiClient), reading from the input stream and - writing it to a file, but is implemented more efficiently. Writing to the file - will be done in a background process owned by Google Play Services. - -

This method should only be used once on any channel, and once it was called, - getInputStream(GoogleApiClient) cannot be used. The channel should not be - immediately closed after calling this method. To be notified when the file is ready, - install a ChannelApi.ChannelListener, with an implementation of - onInputClosed(Channel, int, int).

-
-
Parameters
- - - - - - - - - - -
client - a connected client
uri - URI of the file into which data should be written. This should be a - file URI for a file which is accessible to - the current process for writing.
append - if true, data from the channel will be appended to the file, instead of - overwriting it. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeListener - (GoogleApiClient client, ChannelApi.ChannelListener listener) -

-
-
- - - -
-
- - - - -

Removes a listener which was previously added through - addListener(GoogleApiClient, ChannelApi.ChannelListener).

-
-
Parameters
- - - - - - - -
client - a connected client
listener - a listener which was added using - addListener(GoogleApiClient, ChannelApi.ChannelListener) -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - sendFile - (GoogleApiClient client, Uri uri, long startOffset, long length) -

-
-
- - - -
-
- - - - -

Reads from a file into the output side of the channel. This is equivalent to calling - getOutputStream(GoogleApiClient), reading from a file and writing - into the OutputStream, but is implemented more efficiently. Reading from the file - will be done in a background process owned by Google Play Services. - -

This method should only be used once on any channel, and once it was called, - getOutputStream(GoogleApiClient) cannot be used. The channel should not be - immediately closed after calling this method. To be notified when the file has been sent, - install a ChannelApi.ChannelListener, with an implementation of - onOutputClosed(Channel, int, int).

-
-
Parameters
- - - - - - - - - - - - - -
client - a connected client
uri - URI of the file from which data should be read. This should be a - file URI for a file which is accessible to - the current process for reading.
startOffset - byte offset from which to start reading
length - maximum number of bytes to read from the file, or -1 if the file - should be read to its end. If the file doesn't contain enough bytes to reach - length, fewer bytes will be read. -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - sendFile - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Reads from a file into the output side of the channel. This is equivalent to calling - getOutputStream(GoogleApiClient), reading from a file and writing - into the OutputStream, but is implemented more efficiently. Reading from the file - will be done in a background process owned by Google Play Services. - -

This method should only be used once on any channel, and once it was called, - getOutputStream(GoogleApiClient) cannot be used. The channel should not be - immediately closed after calling this method. To be notified when the file has been sent, - install a ChannelApi.ChannelListener, with an implementation of - onOutputClosed(Channel, int, int). - -

This method is identical to calling - sendFile(GoogleApiClient, Uri, long, long) with offset == 0 - and length == -1.

-
-
Parameters
- - - - - - - -
client - a connected client
uri - URI of the file from which data should be read. This should be a - file URI for a file which is accessible to - the current process for reading. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.ChannelListener.html b/docs/html/reference/com/google/android/gms/wearable/ChannelApi.ChannelListener.html deleted file mode 100644 index c0aa90b7c9c3..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.ChannelListener.html +++ /dev/null @@ -1,1590 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChannelApi.ChannelListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

ChannelApi.ChannelListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.ChannelApi.ChannelListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

A listener which will be notified on changes to channels. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intCLOSE_REASON_DISCONNECTED - Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the closing is due to a remote node being disconnected. - - - -
intCLOSE_REASON_LOCAL_CLOSE - Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the stream is closed due to the local node calling - close(GoogleApiClient) or close(GoogleApiClient, int). - - - -
intCLOSE_REASON_NORMAL - Value passed to onInputClosed(Channel, int, int) or onOutputClosed(Channel, int, int) (but not - onChannelClosed(Channel, int, int)), when the stream was closed under normal conditions, e.g the - whole file was read, or the OutputStream on the remote node was closed - normally. - - - -
intCLOSE_REASON_REMOTE_CLOSE - Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the stream is closed due to the remote node calling - close(GoogleApiClient) or close(GoogleApiClient, int). - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onChannelClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when a channel is closed. - - - -
- -
- abstract - - - - - void - - onChannelOpened(Channel channel) - -
- Called when a new channel is opened by a remote node. - - - -
- -
- abstract - - - - - void - - onInputClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when the input side of a channel is closed. - - - -
- -
- abstract - - - - - void - - onOutputClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when the output side of a channel is closed. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - CLOSE_REASON_DISCONNECTED -

-
- - - - -
-
- - - - -

Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the closing is due to a remote node being disconnected. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CLOSE_REASON_LOCAL_CLOSE -

-
- - - - -
-
- - - - -

Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the stream is closed due to the local node calling - close(GoogleApiClient) or close(GoogleApiClient, int). -

- - -
- Constant Value: - - - 3 - (0x00000003) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CLOSE_REASON_NORMAL -

-
- - - - -
-
- - - - -

Value passed to onInputClosed(Channel, int, int) or onOutputClosed(Channel, int, int) (but not - onChannelClosed(Channel, int, int)), when the stream was closed under normal conditions, e.g the - whole file was read, or the OutputStream on the remote node was closed - normally. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - CLOSE_REASON_REMOTE_CLOSE -

-
- - - - -
-
- - - - -

Value passed to onChannelClosed(Channel, int, int), onInputClosed(Channel, int, int) and - onOutputClosed(Channel, int, int) when the stream is closed due to the remote node calling - close(GoogleApiClient) or close(GoogleApiClient, int). -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onChannelClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when a channel is closed. This can happen through an explicit call to - close(GoogleApiClient) or close(GoogleApiClient, int) on - either side of the connection, or due to disconnecting from the remote node.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the channel closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - or CLOSE_REASON_LOCAL_CLOSE.
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onChannelOpened - (Channel channel) -

-
-
- - - -
-
- - - - -

Called when a new channel is opened by a remote node.

- -
-
- - - - -
-

- - public - - - abstract - - void - - onInputClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when the input side of a channel is closed.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the input closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED - or CLOSE_REASON_NORMAL. -
-
- -
-
- - - - -
-

- - public - - - abstract - - void - - onOutputClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when the output side of a channel is closed.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the output closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED - or CLOSE_REASON_NORMAL. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.CloseReason.html b/docs/html/reference/com/google/android/gms/wearable/ChannelApi.CloseReason.html deleted file mode 100644 index 42759bf54743..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.CloseReason.html +++ /dev/null @@ -1,1126 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChannelApi.CloseReason | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - - - Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - abstract - @interface -

ChannelApi.CloseReason

- - - - - - implements - - Annotation - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.ChannelApi.CloseReason
- - - - - - - -
- - -

Class Overview

-

An annotation for values passed to onChannelClosed(Channel, int, int), and other methods - on the ChannelApi.ChannelListener interface. Annotated method parameters will always take one - of the following values: -

-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - java.lang.annotation.Annotation - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.OpenChannelResult.html b/docs/html/reference/com/google/android/gms/wearable/ChannelApi.OpenChannelResult.html deleted file mode 100644 index 4f1cd4b4d3d5..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.OpenChannelResult.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChannelApi.OpenChannelResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

ChannelApi.OpenChannelResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.ChannelApi.OpenChannelResult
- - - - - - - -
- - -

Class Overview

-

Result of openChannel(GoogleApiClient, String, String). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Channel - - getChannel() - -
- Returns the newly created channel, or null, if the connection couldn't be - opened. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Channel - - getChannel - () -

-
-
- - - -
-
- - - - -

Returns the newly created channel, or null, if the connection couldn't be - opened. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.html b/docs/html/reference/com/google/android/gms/wearable/ChannelApi.html deleted file mode 100644 index e6773f74e87b..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/ChannelApi.html +++ /dev/null @@ -1,1302 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChannelApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

ChannelApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.ChannelApi
- - - - - - - -
- - -

Class Overview

-

Client interface for Wearable Channel API. Allows apps on a wearable device to send and receive - data from other wearable nodes. - -

Channels are bidirectional. Each side, both the initiator and the receiver may both read and - write to the channel by using getOutputStream(GoogleApiClient) and - getInputStream(GoogleApiClient). Once a channel is established, the API - for the initiator and receiver are identical. - -

Channels are only available when the wearable nodes are connected. When the remote node - disconnects, all existing channels will be closed. Any listeners (added through - addListener(GoogleApiClient, ChannelListener) and any installed - WearableListenerService) will be notified of the channel closing. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceChannelApi.ChannelListener - A listener which will be notified on changes to channels.  - - - -
- - - - - @interfaceChannelApi.CloseReason - An annotation for values passed to onChannelClosed(Channel, int, int), and other methods - on the ChannelApi.ChannelListener interface.  - - - -
- - - - - interfaceChannelApi.OpenChannelResult - Result of openChannel(GoogleApiClient, String, String).  - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addListener(GoogleApiClient client, ChannelApi.ChannelListener listener) - -
- Registers a listener to be notified of channel events. - - - -
- -
- abstract - - - - - PendingResult<ChannelApi.OpenChannelResult> - - openChannel(GoogleApiClient client, String nodeId, String path) - -
- Opens a channel to exchange data with a remote node. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeListener(GoogleApiClient client, ChannelApi.ChannelListener listener) - -
- Removes a listener which was previously added through - addListener(GoogleApiClient, ChannelListener). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addListener - (GoogleApiClient client, ChannelApi.ChannelListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to be notified of channel events. Calls to this method should - balanced with removeListener(GoogleApiClient, ChannelListener) to avoid leaking - resources. - -

Callers wishing to be notified of events in the background should use - WearableListenerService.

-
-
Parameters
- - - - - - - -
client - a connected client
listener - a listener which will be notified of changes to any channel -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<ChannelApi.OpenChannelResult> - - openChannel - (GoogleApiClient client, String nodeId, String path) -

-
-
- - - -
-
- - - - -

Opens a channel to exchange data with a remote node. - -

Channel which are no longer needed should be closed using - close(GoogleApiClient). - -

This call involves a network round trip, so may be long running. client must - remain connected during that time, or the request will be cancelled (like any other Play - Services API calls).

-
-
Parameters
- - - - - - - - - - -
client - a connected client
nodeId - the node ID of a wearable node, as returned from - getConnectedNodes(GoogleApiClient)
path - an app-specific identifier for the channel -
-
- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeListener - (GoogleApiClient client, ChannelApi.ChannelListener listener) -

-
-
- - - -
-
- - - - -

Removes a listener which was previously added through - addListener(GoogleApiClient, ChannelListener).

-
-
Parameters
- - - - - - - -
client - a connected client
listener - a listener which was added using - addListener(GoogleApiClient, ChannelListener) -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/ChannelIOException.html b/docs/html/reference/com/google/android/gms/wearable/ChannelIOException.html deleted file mode 100644 index 4f2e9c86c447..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/ChannelIOException.html +++ /dev/null @@ -1,1757 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -ChannelIOException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

ChannelIOException

- - - - - - - - - - - - - - - - - extends IOException
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳java.io.IOException
      ↳com.google.android.gms.wearable.ChannelIOException
- - - - - - - -
- - -

Class Overview

-

A subclass of IOException which can be thrown from the streams returned by - getInputStream(GoogleApiClient) and - getOutputStream(GoogleApiClient). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - ChannelIOException(String message, int closeReason, int appSpecificErrorCode) - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - int - - getAppSpecificErrorCode() - -
- Returns the app-specific error code passed to close(GoogleApiClient, int) - if that's the reason for the stream closing, or 0 otherwise. - - - -
- -
- - - - - - int - - getCloseReason() - -
- Returns one of CLOSE_REASON_NORMAL, - CLOSE_REASON_DISCONNECTED, - CLOSE_REASON_REMOTE_CLOSE, - or CLOSE_REASON_LOCAL_CLOSE, to indicate - the reason for the stream closing. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Throwable - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - ChannelIOException - (String message, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - int - - getAppSpecificErrorCode - () -

-
-
- - - -
-
- - - - -

Returns the app-specific error code passed to close(GoogleApiClient, int) - if that's the reason for the stream closing, or 0 otherwise. -

- -
-
- - - - -
-

- - public - - - - - int - - getCloseReason - () -

-
-
- - - -
-
- - - - -

Returns one of CLOSE_REASON_NORMAL, - CLOSE_REASON_DISCONNECTED, - CLOSE_REASON_REMOTE_CLOSE, - or CLOSE_REASON_LOCAL_CLOSE, to indicate - the reason for the stream closing. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataApi.DataItemResult.html b/docs/html/reference/com/google/android/gms/wearable/DataApi.DataItemResult.html deleted file mode 100644 index 2274546b3003..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataApi.DataItemResult.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataApi.DataItemResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DataApi.DataItemResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataApi.DataItemResult
- - - - - - - -
- - -

Class Overview

-

Contains a single data item.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DataItem - - getDataItem() - -
- Returns a data item, or null if the item does not exit. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DataItem - - getDataItem - () -

-
-
- - - -
-
- - - - -

Returns a data item, or null if the item does not exit.

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataApi.DataListener.html b/docs/html/reference/com/google/android/gms/wearable/DataApi.DataListener.html deleted file mode 100644 index b977b69d268d..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataApi.DataListener.html +++ /dev/null @@ -1,1127 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataApi.DataListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DataApi.DataListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataApi.DataListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Used with addListener(GoogleApiClient, DataApi.DataListener) to receive data events.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onDataChanged(DataEventBuffer dataEvents) - -
- Notification that a set of data items have been changed or deleted. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onDataChanged - (DataEventBuffer dataEvents) -

-
-
- - - -
-
- - - - -

Notification that a set of data items have been changed or deleted. The data buffer is - released upon completion of this method. If a caller wishes to use the events outside - this callback, they should be sure to freeze the - DataEvent objects they wish to use. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataApi.DeleteDataItemsResult.html b/docs/html/reference/com/google/android/gms/wearable/DataApi.DeleteDataItemsResult.html deleted file mode 100644 index 641cbf54d363..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataApi.DeleteDataItemsResult.html +++ /dev/null @@ -1,1149 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataApi.DeleteDataItemsResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DataApi.DeleteDataItemsResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataApi.DeleteDataItemsResult
- - - - - - - -
- - -

Class Overview

-

Contains the number of deleted items.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getNumDeleted() - -
- Returns the number of items deleted by deleteDataItems(GoogleApiClient, Uri). - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getNumDeleted - () -

-
-
- - - -
-
- - - - -

Returns the number of items deleted by deleteDataItems(GoogleApiClient, Uri). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataApi.GetFdForAssetResult.html b/docs/html/reference/com/google/android/gms/wearable/DataApi.GetFdForAssetResult.html deleted file mode 100644 index 0b598bfe46a2..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataApi.GetFdForAssetResult.html +++ /dev/null @@ -1,1259 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataApi.GetFdForAssetResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

DataApi.GetFdForAssetResult

- - - - - - implements - - Result - - Releasable - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataApi.GetFdForAssetResult
- - - - - - - -
- - -

Class Overview

-

Contains a file descriptor for the requested asset. - -

This object should be released after use. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - ParcelFileDescriptor - - getFd() - -
- Returns a file descriptor for the requested asset. - - - -
- -
- abstract - - - - - InputStream - - getInputStream() - -
- Returns an input stream wrapping the file descriptor. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - ParcelFileDescriptor - - getFd - () -

-
-
- - - -
-
- - - - -

Returns a file descriptor for the requested asset.

- -
-
- - - - -
-

- - public - - - abstract - - InputStream - - getInputStream - () -

-
-
- - - -
-
- - - - -

Returns an input stream wrapping the file descriptor. When this input stream is closed, - the file descriptor is, as well. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataApi.html b/docs/html/reference/com/google/android/gms/wearable/DataApi.html deleted file mode 100644 index 33703572e290..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataApi.html +++ /dev/null @@ -1,1929 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataApi
- - - - - - - -
- - -

Class Overview

-

Exposes an API for components to read or write data items and - assets. - -

A DataItem is synchronized across all devices in an Android Wear network. It is - possible to set data items while not connected to any nodes. Those data items will be - synchronized when the nodes eventually come online. - -

Data items are private to the application that created them, and are only accessible by that - application on other nodes. They should generally be small in size, relying on - assets for the transfer of larger, more persistent data objects such as - images. - -

DataItem URI format

- Each data item is identified by a URI, accessible with getUri(), that - indicates the item's creator and path. Fully specified URIs follow the following format: - - 
wear://<node_id>/<path>
- - where <node_id> is the node ID of the wearable node that created - the data item, and <path> is an application-defined path. This means that given a - data item's URI, calling getHost() will return the creator's node ID. - -

In some of the methods below (such as getDataItems(GoogleApiClient, Uri)), it is - possible to omit the node ID from the URI, and only leave a path. In that case, the URI may - refer to multiple data items, since multiple nodes may create data items with the same path. - Partially specified data item URIs follow the following format: - - 

wear:/<path>
- - Note the single / after wear:. - -

Concurrency

- Concurrent modification of data items from different nodes may result in inconsistent results. It - is recommended that apps are built with some concept of ownership of data items. Two common - patterns are: -
    -
  • Creator owns data items: Data items may be updated only by the original creator node. -
  • Producer-consumer: One node is responsible for creating a data item, and a second node is - responsible for deleting it, once it has been processed. Data items should have unique IDs when - using this pattern, and data items should not be modified once created. -
-

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceDataApi.DataItemResult - Contains a single data item.  - - - -
- - - - - interfaceDataApi.DataListener - Used with addListener(GoogleApiClient, DataApi.DataListener) to receive data events.  - - - -
- - - - - interfaceDataApi.DeleteDataItemsResult - Contains the number of deleted items.  - - - -
- - - - - interfaceDataApi.GetFdForAssetResult - Contains a file descriptor for the requested asset.  - - - -
- - - - - - - - - - - - - - - - - - -
Constants
intFILTER_LITERAL - Filter type for - getDataItems(GoogleApiClient, Uri, int), - deleteDataItems(GoogleApiClient, Uri, int): - if this filter is set, the given URI will be taken as a literal path, and the operation - will apply to the matching item only. - - - -
intFILTER_PREFIX - Filter type for - getDataItems(GoogleApiClient, Uri, int), - deleteDataItems(GoogleApiClient, Uri, int): - if this filter is set, the given URI will be taken as a path prefix, and the operation - will apply to all matching items. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addListener(GoogleApiClient client, DataApi.DataListener listener) - -
- Registers a listener to receive data item changed and deleted events. - - - -
- -
- abstract - - - - - PendingResult<DataApi.DeleteDataItemsResult> - - deleteDataItems(GoogleApiClient client, Uri uri, int filterType) - -
- Removes all specified data items from the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<DataApi.DeleteDataItemsResult> - - deleteDataItems(GoogleApiClient client, Uri uri) - -
- Removes all specified data items from the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<DataApi.DataItemResult> - - getDataItem(GoogleApiClient client, Uri uri) - -
- Retrieves a single DataItem from the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<DataItemBuffer> - - getDataItems(GoogleApiClient client) - -
- Retrieves all data items from the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<DataItemBuffer> - - getDataItems(GoogleApiClient client, Uri uri, int filterType) - -
- Retrieves all data items matching the provided URI and filter type, from - the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<DataItemBuffer> - - getDataItems(GoogleApiClient client, Uri uri) - -
- Retrieves all data items matching the provided URI, from the Android Wear - network. - - - -
- -
- abstract - - - - - PendingResult<DataApi.GetFdForAssetResult> - - getFdForAsset(GoogleApiClient client, DataItemAsset asset) - -
- Retrieves a ParcelFileDescriptor pointing at the bytes of an asset. - - - -
- -
- abstract - - - - - PendingResult<DataApi.GetFdForAssetResult> - - getFdForAsset(GoogleApiClient client, Asset asset) - -
- Retrieves a ParcelFileDescriptor pointing at the bytes of an asset. - - - -
- -
- abstract - - - - - PendingResult<DataApi.DataItemResult> - - putDataItem(GoogleApiClient client, PutDataRequest request) - -
- Adds a DataItem to the Android Wear network. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeListener(GoogleApiClient client, DataApi.DataListener listener) - -
- Removes a data listener which was previously added through - addListener(GoogleApiClient, DataListener). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - FILTER_LITERAL -

-
- - - - -
-
- - - - -

Filter type for - getDataItems(GoogleApiClient, Uri, int), - deleteDataItems(GoogleApiClient, Uri, int): - if this filter is set, the given URI will be taken as a literal path, and the operation - will apply to the matching item only. -

- - -
- Constant Value: - - - 0 - (0x00000000) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - FILTER_PREFIX -

-
- - - - -
-
- - - - -

Filter type for - getDataItems(GoogleApiClient, Uri, int), - deleteDataItems(GoogleApiClient, Uri, int): - if this filter is set, the given URI will be taken as a path prefix, and the operation - will apply to all matching items. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addListener - (GoogleApiClient client, DataApi.DataListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to receive data item changed and deleted events. This call should be - balanced with a call to removeListener(GoogleApiClient, DataListener), to avoid - leaking resources. - -

The listener will be notified of changes initiated by this node. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.DeleteDataItemsResult> - - deleteDataItems - (GoogleApiClient client, Uri uri, int filterType) -

-
-
- - - -
-
- - - - -

Removes all specified data items from the Android Wear network. - -

If uri is fully specified, this method will delete at - most one data item. If uri contains no host, multiple data items may be - deleted, since different nodes may create data items with the same path. See - DataApi for details of the URI format. - -

The filterType parameter changes the interpretation of uri. - For example, if uri represents a path prefix, all items matching that - prefix will be deleted. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.DeleteDataItemsResult> - - deleteDataItems - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Removes all specified data items from the Android Wear network. - -

If uri is fully specified, this method will delete at - most one data item. If uri contains no host, multiple data items may be - deleted, since different nodes may create data items with the same path. See - DataApi for details of the URI format. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.DataItemResult> - - getDataItem - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Retrieves a single DataItem from the Android Wear network. A fully qualified URI - must be specified. The URI's host must be the ID of the node that created the item. - -

See DataApi for details of the URI format. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataItemBuffer> - - getDataItems - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Retrieves all data items from the Android Wear network. - -

Callers must call release() on the returned buffer when finished - processing results. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataItemBuffer> - - getDataItems - (GoogleApiClient client, Uri uri, int filterType) -

-
-
- - - -
-
- - - - -

Retrieves all data items matching the provided URI and filter type, from - the Android Wear network. - -

The URI must contain a path. If uri is fully specified, at most one data item - will be returned. If uri contains no host, multiple data items may be returned, - since different nodes may create data items with the same path. See DataApi for - details of the URI format. - -

Callers must call release() on the returned buffer when finished - processing results. - -

The filterType parameter changes the interpretation of uri. - For example, if uri represents a path prefix, all items matching that prefix - will be returned. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataItemBuffer> - - getDataItems - (GoogleApiClient client, Uri uri) -

-
-
- - - -
-
- - - - -

Retrieves all data items matching the provided URI, from the Android Wear - network. - -

The URI must contain a path. If uri is fully specified, at most one data item - will be returned. If uri contains no host, multiple data items may be returned, - since different nodes may create data items with the same path. See DataApi for - details of the URI format. - -

Callers must call release() on the returned buffer when finished - processing results. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.GetFdForAssetResult> - - getFdForAsset - (GoogleApiClient client, DataItemAsset asset) -

-
-
- - - -
-
- - - - -

Retrieves a ParcelFileDescriptor pointing at the bytes of an asset. Only assets - previously stored in a DataItem may be retrieved. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.GetFdForAssetResult> - - getFdForAsset - (GoogleApiClient client, Asset asset) -

-
-
- - - -
-
- - - - -

Retrieves a ParcelFileDescriptor pointing at the bytes of an asset. Only assets - previously stored in a DataItem may be retrieved. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<DataApi.DataItemResult> - - putDataItem - (GoogleApiClient client, PutDataRequest request) -

-
-
- - - -
-
- - - - -

Adds a DataItem to the Android Wear network. The updated item is synchronized across - all devices. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeListener - (GoogleApiClient client, DataApi.DataListener listener) -

-
-
- - - -
-
- - - - -

Removes a data listener which was previously added through - addListener(GoogleApiClient, DataListener). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataEvent.html b/docs/html/reference/com/google/android/gms/wearable/DataEvent.html deleted file mode 100644 index 78035d45b513..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataEvent.html +++ /dev/null @@ -1,1351 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataEvent

- - - - - - implements - - Freezable<DataEvent> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataEvent
- - - - - - - -
- - -

Class Overview

-

Data interface for data events. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intTYPE_CHANGED - Indicates that the enclosing DataEvent was triggered by a data item being added or changed. - - - -
intTYPE_DELETED - Indicates that the enclosing DataEvent was triggered by a data item being deleted. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - DataItem - - getDataItem() - -
- abstract - - - - - int - - getType() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - TYPE_CHANGED -

-
- - - - -
-
- - - - -

Indicates that the enclosing DataEvent was triggered by a data item being added or changed. -

- - -
- Constant Value: - - - 1 - (0x00000001) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TYPE_DELETED -

-
- - - - -
-
- - - - -

Indicates that the enclosing DataEvent was triggered by a data item being deleted. -

- - -
- Constant Value: - - - 2 - (0x00000002) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - DataItem - - getDataItem - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the data item modified in this event. An event of TYPE_DELETED will only - have its {DataItem#getUri} populated. -
-
- -
-
- - - - -
-

- - public - - - abstract - - int - - getType - () -

-
-
- - - -
-
- - - - -

-
-
Returns
- -
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataEventBuffer.html b/docs/html/reference/com/google/android/gms/wearable/DataEventBuffer.html deleted file mode 100644 index da748cd52179..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataEventBuffer.html +++ /dev/null @@ -1,1990 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataEventBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataEventBuffer

- - - - - - - - - extends AbstractDataBuffer<DataEvent>
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.wearable.DataEvent>
    ↳com.google.android.gms.wearable.DataEventBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure holding references to a set of events.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - DataEvent - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - DataEvent - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataItem.html b/docs/html/reference/com/google/android/gms/wearable/DataItem.html deleted file mode 100644 index e3f1b0e83bae..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataItem.html +++ /dev/null @@ -1,1354 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataItem | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataItem

- - - - - - implements - - Freezable<DataItem> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataItem
- - - - - - - -
- - -

Class Overview

-

The base object of data stored in the Android Wear network. DataItem are replicated - across all devices in the network. It contains a small blob of data and associated assets. -

- A DataItem is identified by its Uri, which contains its creator and a path. -

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Map<String, DataItemAsset> - - getAssets() - -
- A map of assets associated with this data item. - - - -
- -
- abstract - - - - - byte[] - - getData() - -
- An array of data stored at the specified Uri. - - - -
- -
- abstract - - - - - Uri - - getUri() - -
- Returns the DataItem's Uri. - - - -
- -
- abstract - - - - - DataItem - - setData(byte[] data) - -
- Sets the data in a data item. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Map<String, DataItemAsset> - - getAssets - () -

-
-
- - - -
-
- - - - -

A map of assets associated with this data item. DataMapItem may be used to store - structured data in the network, including assets. -

- -
-
- - - - -
-

- - public - - - abstract - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

An array of data stored at the specified Uri. DataMapItem may be used - to store structured data in the network. -

- -
-
- - - - -
-

- - public - - - abstract - - Uri - - getUri - () -

-
-
- - - -
-
- - - - -

Returns the DataItem's Uri. getHost() returns the id of the node that created it. -

- -
-
- - - - -
-

- - public - - - abstract - - DataItem - - setData - (byte[] data) -

-
-
- - - -
-
- - - - -

Sets the data in a data item. -

- The current maximum data item size limit is approximtely 100k. Data items should generally - be much smaller than this limit. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataItemAsset.html b/docs/html/reference/com/google/android/gms/wearable/DataItemAsset.html deleted file mode 100644 index 294c62b526e4..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataItemAsset.html +++ /dev/null @@ -1,1225 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataItemAsset | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - interface -

DataItemAsset

- - - - - - implements - - Freezable<DataItemAsset> - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.DataItemAsset
- - - - - - - -
- - -

Class Overview

-

A reference to an asset stored in a data item. Used to fetch file descriptors using - getFdForAsset(GoogleApiClient, DataItemAsset). -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDataItemKey() - -
- abstract - - - - - String - - getId() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.data.Freezable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDataItemKey - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the identifier used to address this asset in the context of an existing - DataItem. -
-
- -
-
- - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the Android Wear-wide unique identifier for a particular asset. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataItemBuffer.html b/docs/html/reference/com/google/android/gms/wearable/DataItemBuffer.html deleted file mode 100644 index 5129d91b05ec..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataItemBuffer.html +++ /dev/null @@ -1,1985 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataItemBuffer | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataItemBuffer

- - - - - - - - - extends AbstractDataBuffer<DataItem>
- - - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.data.AbstractDataBuffer<com.google.android.gms.wearable.DataItem>
    ↳com.google.android.gms.wearable.DataItemBuffer
- - - - - - - -
- - -

Class Overview

-

Data structure holding reference to a set of DataItems.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - DataItem - - get(int position) - -
- Get the item at the specified position. - - - -
- -
- - - - - - int - - getCount() - -
- - - - - - Status - - getStatus() - -
- Returns the status of this result. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.data.AbstractDataBuffer - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - com.google.android.gms.common.data.DataBuffer - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- -From interface - - java.lang.Iterable - -
- - -
-
- -From interface - - com.google.android.gms.common.api.Releasable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - DataItem - - get - (int position) -

-
-
- - - -
-
- - - - -

Get the item at the specified position. Note that the objects returned from subsequent - invocations of this method for the same position may not be identical objects, but will be - equal in value. In other words: -

- buffer.get(i) == buffer.get(i) may return false. -

- buffer.get(i).equals(buffer.get(i)) will return true.

-
-
Parameters
- - - - -
position - The position of the item to retrieve.
-
-
-
Returns
-
  • the item at position in this buffer. -
-
- -
-
- - - - -
-

- - public - - - - - int - - getCount - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Status - - getStatus - () -

-
-
- - - -
-
- - - - -

Returns the status of this result. Use isSuccess() to determine whether the - call was successful, and getStatusCode() to determine what the error cause - was. - -

Certain errors are due to failures that can be resolved by launching a particular intent. - The resolution intent is available via getResolution(). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataMap.html b/docs/html/reference/com/google/android/gms/wearable/DataMap.html deleted file mode 100644 index 5e955edac88b..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataMap.html +++ /dev/null @@ -1,5176 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataMap | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataMap

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.DataMap
- - - - - - - -
- - -

Class Overview

-

A map of data supported by PutDataMapRequest and DataMapItems. - - DataMap may convert to and from Bundles, but will drop any types - not explicitly supported by DataMap in the conversion process. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringTAG - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - DataMap() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - ArrayList<DataMap> - - arrayListFromBundleArrayList(ArrayList<Bundle> bundleArrayList) - -
- Returns an ArrayList of DataMaps from an ArrayList of Bundles. - - - -
- -
- - - - - - void - - clear() - -
- Removes all elements from the mapping of this DataMap. - - - -
- -
- - - - - - boolean - - containsKey(String key) - -
- Returns true if the given key is contained in the mapping - of this DataMap. - - - -
- -
- - - - - - boolean - - equals(Object o) - -
- Returns true if the given Object is a DataMap equivalent to - this one. - - - -
- -
- - - - static - - DataMap - - fromBundle(Bundle bundle) - -
- Returns a DataMap from a Bundle. - - - -
- -
- - - - static - - DataMap - - fromByteArray(byte[] bytes) - -
- Returns a DataMap from a byte[]. - - - -
- -
- - - - - <T> - T - - get(String key) - -
- Returns the entry with the given key as an object. - - - -
- -
- - - - - - Asset - - getAsset(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - boolean - - getBoolean(String key) - -
- Returns the value associated with the given key, or false if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - boolean - - getBoolean(String key, boolean defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - byte - - getByte(String key) - -
- Returns the value associated with the given key, or (byte) 0 if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - byte - - getByte(String key, byte defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - byte[] - - getByteArray(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - DataMap - - getDataMap(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - ArrayList<DataMap> - - getDataMapArrayList(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - double - - getDouble(String key) - -
- Returns the value associated with the given key, or 0.0 if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - double - - getDouble(String key, double defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - float - - getFloat(String key) - -
- Returns the value associated with the given key, or 0.0f if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - float - - getFloat(String key, float defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - float[] - - getFloatArray(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - int - - getInt(String key, int defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - int - - getInt(String key) - -
- Returns the value associated with the given key, or 0 if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - ArrayList<Integer> - - getIntegerArrayList(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - long - - getLong(String key) - -
- Returns the value associated with the given key, or 0L if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - long - - getLong(String key, long defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - long[] - - getLongArray(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - String - - getString(String key, String defaultValue) - -
- Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key. - - - -
- -
- - - - - - String - - getString(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - String[] - - getStringArray(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - ArrayList<String> - - getStringArrayList(String key) - -
- Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key. - - - -
- -
- - - - - - int - - hashCode() - -
- - - - - - boolean - - isEmpty() - -
- Returns true if the mapping of this DataMap is empty, false otherwise. - - - -
- -
- - - - - - Set<String> - - keySet() - -
- Returns a Set containing the Strings used as keys in this DataMap. - - - -
- -
- - - - - - void - - putAll(DataMap dataMap) - -
- Inserts all mappings from the given DataMap into this DataMap. - - - -
- -
- - - - - - void - - putAsset(String key, Asset value) - -
- Inserts an Asset into the mapping of this DataMap, replacing - any existing Asset for the given key. - - - -
- -
- - - - - - void - - putBoolean(String key, boolean value) - -
- Inserts a Boolean value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putByte(String key, byte value) - -
- Inserts a byte value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putByteArray(String key, byte[] value) - -
- Inserts a byte array value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putDataMap(String key, DataMap value) - -
- Inserts a DataMap into the mapping of this DataMap, replacing - any existing DataMap for the given key. - - - -
- -
- - - - - - void - - putDataMapArrayList(String key, ArrayList<DataMap> value) - -
- Inserts an ArrayList value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putDouble(String key, double value) - -
- Inserts a double value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putFloat(String key, float value) - -
- Inserts a float value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putFloatArray(String key, float[] value) - -
- Inserts a float array value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putInt(String key, int value) - -
- Inserts an int value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putIntegerArrayList(String key, ArrayList<Integer> value) - -
- Inserts an ArrayList value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putLong(String key, long value) - -
- Inserts a long value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putLongArray(String key, long[] value) - -
- Inserts a long array value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putString(String key, String value) - -
- Inserts a String value into the mapping of this DataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putStringArray(String key, String[] value) - -
- Inserts a String array value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - void - - putStringArrayList(String key, ArrayList<String> value) - -
- Inserts an ArrayList value into the mapping of this dataMap, replacing - any existing value for the given key. - - - -
- -
- - - - - - Object - - remove(String key) - -
- Removes any entry with the given key from the mapping of this dataMap. - - - -
- -
- - - - - - int - - size() - -
- Returns the number of key-value pairs in this map. - - - -
- -
- - - - - - Bundle - - toBundle() - -
- Returns a Bundle containing all the elements on this DataMap. - - - -
- -
- - - - - - byte[] - - toByteArray() - -
- Returns a serialized byte[] representing this DataMap. - - - -
- -
- - - - - - String - - toString() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - TAG -

-
- - - - -
-
- - - - -

- - -
- Constant Value: - - - "DataMap" - - -
- -
-
- - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - DataMap - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - ArrayList<DataMap> - - arrayListFromBundleArrayList - (ArrayList<Bundle> bundleArrayList) -

-
-
- - - -
-
- - - - -

Returns an ArrayList of DataMaps from an ArrayList of Bundles. - Any elements in the Bundles not supported by DataMap will be dropped.

-
-
Returns
-
  • an ArrayList of DataMaps -
-
- -
-
- - - - -
-

- - public - - - - - void - - clear - () -

-
-
- - - -
-
- - - - -

Removes all elements from the mapping of this DataMap. -

- -
-
- - - - -
-

- - public - - - - - boolean - - containsKey - (String key) -

-
-
- - - -
-
- - - - -

Returns true if the given key is contained in the mapping - of this DataMap.

-
-
Parameters
- - - - -
key - a String key
-
-
-
Returns
-
  • true if the key is part of the mapping, false otherwise -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - equals - (Object o) -

-
-
- - - -
-
- - - - -

Returns true if the given Object is a DataMap equivalent to - this one. -

- -
-
- - - - -
-

- - public - static - - - - DataMap - - fromBundle - (Bundle bundle) -

-
-
- - - -
-
- - - - -

Returns a DataMap from a Bundle. The input Bundle is expected to contain - only elements supported by DataMap. Any elements in the Bundle not - supported by DataMap will be dropped.

-
-
Returns
-
  • a DataMap from a Bundle object -
-
- -
-
- - - - -
-

- - public - static - - - - DataMap - - fromByteArray - (byte[] bytes) -

-
-
- - - -
-
- - - - -

Returns a DataMap from a byte[].

-
-
Parameters
- - - - -
bytes - the bytes of the DataMap to convert
-
-
-
Returns
-
  • a new DataMap out of the input bytes -
-
- -
-
- - - - -
-

- - public - - - - - T - - get - (String key) -

-
-
- - - -
-
- - - - -

Returns the entry with the given key as an object.

-
-
Parameters
- - - - -
key - a String key
-
-
-
Returns
-
  • an Object, or null -
-
- -
-
- - - - -
-

- - public - - - - - Asset - - getAsset - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a String value, or null -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - getBoolean - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or false if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • a boolean value -
-
- -
-
- - - - -
-

- - public - - - - - boolean - - getBoolean - (String key, boolean defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • a boolean value -
-
- -
-
- - - - -
-

- - public - - - - - byte - - getByte - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or (byte) 0 if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • a byte value -
-
- -
-
- - - - -
-

- - public - - - - - byte - - getByte - (String key, byte defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • a byte value -
-
- -
-
- - - - -
-

- - public - - - - - byte[] - - getByteArray - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a byte[] value, or null -
-
- -
-
- - - - -
-

- - public - - - - - DataMap - - getDataMap - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a String value, or null -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<DataMap> - - getDataMapArrayList - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • an ArrayList value, or null -
-
- -
-
- - - - -
-

- - public - - - - - double - - getDouble - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or 0.0 if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • a double value -
-
- -
-
- - - - -
-

- - public - - - - - double - - getDouble - (String key, double defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • a double value -
-
- -
-
- - - - -
-

- - public - - - - - float - - getFloat - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or 0.0f if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • a float value -
-
- -
-
- - - - -
-

- - public - - - - - float - - getFloat - (String key, float defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • a float value -
-
- -
-
- - - - -
-

- - public - - - - - float[] - - getFloatArray - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a float[] value, or null -
-
- -
-
- - - - -
-

- - public - - - - - int - - getInt - (String key, int defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • an int value -
-
- -
-
- - - - -
-

- - public - - - - - int - - getInt - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or 0 if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • an int value -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<Integer> - - getIntegerArrayList - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • an ArrayList value, or null -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLong - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or 0L if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - -
key - a String
-
-
-
Returns
-
  • a long value -
-
- -
-
- - - - -
-

- - public - - - - - long - - getLong - (String key, long defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • a long value -
-
- -
-
- - - - -
-

- - public - - - - - long[] - - getLongArray - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a long[] value, or null -
-
- -
-
- - - - -
-

- - public - - - - - String - - getString - (String key, String defaultValue) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or defaultValue if - no mapping of the desired type exists for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
defaultValue - Value to return if key does not exist
-
-
-
Returns
-
  • the String value associated with the given key, or defaultValue - if no valid String object is currently mapped to that key. -
-
- -
-
- - - - -
-

- - public - - - - - String - - getString - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a String value, or null -
-
- -
-
- - - - -
-

- - public - - - - - String[] - - getStringArray - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • a String[] value, or null -
-
- -
-
- - - - -
-

- - public - - - - - ArrayList<String> - - getStringArrayList - (String key) -

-
-
- - - -
-
- - - - -

Returns the value associated with the given key, or null if - no mapping of the desired type exists for the given key or a null - value is explicitly associated with the key.

-
-
Parameters
- - - - -
key - a String, or null
-
-
-
Returns
-
  • an ArrayList value, or null -
-
- -
-
- - - - -
-

- - public - - - - - int - - hashCode - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - boolean - - isEmpty - () -

-
-
- - - -
-
- - - - -

Returns true if the mapping of this DataMap is empty, false otherwise. -

- -
-
- - - - -
-

- - public - - - - - Set<String> - - keySet - () -

-
-
- - - -
-
- - - - -

Returns a Set containing the Strings used as keys in this DataMap.

-
-
Returns
-
  • a Set of String keys -
-
- -
-
- - - - -
-

- - public - - - - - void - - putAll - (DataMap dataMap) -

-
-
- - - -
-
- - - - -

Inserts all mappings from the given DataMap into this DataMap.

-
-
Parameters
- - - - -
dataMap - a DataMap -
-
- -
-
- - - - -
-

- - public - - - - - void - - putAsset - (String key, Asset value) -

-
-
- - - -
-
- - - - -

Inserts an Asset into the mapping of this DataMap, replacing - any existing Asset for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an Asset, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putBoolean - (String key, boolean value) -

-
-
- - - -
-
- - - - -

Inserts a Boolean value into the mapping of this DataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a Boolean, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putByte - (String key, byte value) -

-
-
- - - -
-
- - - - -

Inserts a byte value into the mapping of this DataMap, replacing - any existing value for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a byte -
-
- -
-
- - - - -
-

- - public - - - - - void - - putByteArray - (String key, byte[] value) -

-
-
- - - -
-
- - - - -

Inserts a byte array value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a byte array object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putDataMap - (String key, DataMap value) -

-
-
- - - -
-
- - - - -

Inserts a DataMap into the mapping of this DataMap, replacing - any existing DataMap for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an Asset, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putDataMapArrayList - (String key, ArrayList<DataMap> value) -

-
-
- - - -
-
- - - - -

Inserts an ArrayList value into the mapping of this DataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an ArrayList object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putDouble - (String key, double value) -

-
-
- - - -
-
- - - - -

Inserts a double value into the mapping of this DataMap, replacing - any existing value for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a double -
-
- -
-
- - - - -
-

- - public - - - - - void - - putFloat - (String key, float value) -

-
-
- - - -
-
- - - - -

Inserts a float value into the mapping of this dataMap, replacing - any existing value for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a float -
-
- -
-
- - - - -
-

- - public - - - - - void - - putFloatArray - (String key, float[] value) -

-
-
- - - -
-
- - - - -

Inserts a float array value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a float array object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putInt - (String key, int value) -

-
-
- - - -
-
- - - - -

Inserts an int value into the mapping of this DataMap, replacing - any existing value for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an int, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putIntegerArrayList - (String key, ArrayList<Integer> value) -

-
-
- - - -
-
- - - - -

Inserts an ArrayList value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an ArrayList object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putLong - (String key, long value) -

-
-
- - - -
-
- - - - -

Inserts a long value into the mapping of this DataMap, replacing - any existing value for the given key.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a long -
-
- -
-
- - - - -
-

- - public - - - - - void - - putLongArray - (String key, long[] value) -

-
-
- - - -
-
- - - - -

Inserts a long array value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a long array object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putString - (String key, String value) -

-
-
- - - -
-
- - - - -

Inserts a String value into the mapping of this DataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a String, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putStringArray - (String key, String[] value) -

-
-
- - - -
-
- - - - -

Inserts a String array value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - a String array object, or null -
-
- -
-
- - - - -
-

- - public - - - - - void - - putStringArrayList - (String key, ArrayList<String> value) -

-
-
- - - -
-
- - - - -

Inserts an ArrayList value into the mapping of this dataMap, replacing - any existing value for the given key. Either key or value may be null.

-
-
Parameters
- - - - - - - -
key - a String, or null
value - an ArrayList object, or null -
-
- -
-
- - - - -
-

- - public - - - - - Object - - remove - (String key) -

-
-
- - - -
-
- - - - -

Removes any entry with the given key from the mapping of this dataMap.

-
-
Parameters
- - - - -
key - a String key -
-
- -
-
- - - - -
-

- - public - - - - - int - - size - () -

-
-
- - - -
-
- - - - -

Returns the number of key-value pairs in this map. -

- -
-
- - - - -
-

- - public - - - - - Bundle - - toBundle - () -

-
-
- - - -
-
- - - - -

Returns a Bundle containing all the elements on this DataMap. A data map converted in this - way should only be read after converting it with fromBundle(Bundle).

-
-
Returns
-
  • a Bundle containing all supported elements on this DataMap. -
-
- -
-
- - - - -
-

- - public - - - - - byte[] - - toByteArray - () -

-
-
- - - -
-
- - - - -

Returns a serialized byte[] representing this DataMap. -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/DataMapItem.html b/docs/html/reference/com/google/android/gms/wearable/DataMapItem.html deleted file mode 100644 index 8775452e5e16..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/DataMapItem.html +++ /dev/null @@ -1,1421 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DataMapItem | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

DataMapItem

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.DataMapItem
- - - - - - - -
- - -

Class Overview

-

Creates a new dataItem-like object containing structured and serializable data. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - DataMapItem - - fromDataItem(DataItem dataItem) - -
- Provides a DataMapItem wrapping a dataItem. - - - -
- -
- - - - - - DataMap - - getDataMap() - -
- - - - - - Uri - - getUri() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - DataMapItem - - fromDataItem - (DataItem dataItem) -

-
-
- - - -
-
- - - - -

Provides a DataMapItem wrapping a dataItem. -

- A DataItem passed to this method does not need to be frozen (freeze()), - this method freezes the object.

-
-
Parameters
- - - - -
dataItem - the base for the wrapped DataMapItem. dataItem should not be - modified after wrapping it. -
-
- -
-
- - - - -
-

- - public - - - - - DataMap - - getDataMap - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Uri - - getUri - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/MessageApi.MessageListener.html b/docs/html/reference/com/google/android/gms/wearable/MessageApi.MessageListener.html deleted file mode 100644 index 6e1c28786cd3..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/MessageApi.MessageListener.html +++ /dev/null @@ -1,1123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MessageApi.MessageListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

MessageApi.MessageListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.MessageApi.MessageListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Used with addListener(GoogleApiClient, MessageApi.MessageListener) to receive message events. - -

Callers wishing to be notified of events in the background should use - WearableListenerService. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onMessageReceived(MessageEvent messageEvent) - -
- Notification that a message has been received. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onMessageReceived - (MessageEvent messageEvent) -

-
-
- - - -
-
- - - - -

Notification that a message has been received. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/MessageApi.SendMessageResult.html b/docs/html/reference/com/google/android/gms/wearable/MessageApi.SendMessageResult.html deleted file mode 100644 index 32c35703378f..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/MessageApi.SendMessageResult.html +++ /dev/null @@ -1,1152 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MessageApi.SendMessageResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

MessageApi.SendMessageResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.MessageApi.SendMessageResult
- - - - - - - -
- - -

Class Overview

-

Contains the request id assigned to the message. On failure, the id will be - UNKNOWN_REQUEST_ID and the status will be unsuccessful. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - int - - getRequestId() - -
- Returns an ID used to identify the sent message. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - int - - getRequestId - () -

-
-
- - - -
-
- - - - -

Returns an ID used to identify the sent message. If getStatus() is - not successful, this value will be UNKNOWN_REQUEST_ID. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/MessageApi.html b/docs/html/reference/com/google/android/gms/wearable/MessageApi.html deleted file mode 100644 index 66307e382a94..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/MessageApi.html +++ /dev/null @@ -1,1327 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MessageApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

MessageApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.MessageApi
- - - - - - - -
- - -

Class Overview

-

Exposes an API for components to send messages to other nodes. -

- Messages are delivered to connected network nodes. A message is considered successful if it has - been queued for delivery to the specified node. A message will only be queued if the specified - node is connected. The DataApi should be used for messages to nodes which - are not currently connected (to be delivered on connection). -

- Messages should generally contain ephemeral, small payloads. Use assets - with the DataApi to store more persistent or larger data efficiently. -

- A message is private to the application that created it and accessible only by that - application on other nodes. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceMessageApi.MessageListener - Used with addListener(GoogleApiClient, MessageApi.MessageListener) to receive message events.  - - - -
- - - - - interfaceMessageApi.SendMessageResult - Contains the request id assigned to the message.  - - - -
- - - - - - - - - - - -
Constants
intUNKNOWN_REQUEST_ID - A value returned by getRequestId() when sendMessage(GoogleApiClient, String, String, byte[]) fails. - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addListener(GoogleApiClient client, MessageApi.MessageListener listener) - -
- Registers a listener to be notified of received messages. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeListener(GoogleApiClient client, MessageApi.MessageListener listener) - -
- Removes a message listener which was previously added through - addListener(GoogleApiClient, MessageListener). - - - -
- -
- abstract - - - - - PendingResult<MessageApi.SendMessageResult> - - sendMessage(GoogleApiClient client, String nodeId, String path, byte[] data) - -
- Sends byte[] data to the specified node. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - UNKNOWN_REQUEST_ID -

-
- - - - -
-
- - - - -

A value returned by getRequestId() when sendMessage(GoogleApiClient, String, String, byte[]) fails. -

- - -
- Constant Value: - - - -1 - (0xffffffff) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addListener - (GoogleApiClient client, MessageApi.MessageListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to be notified of received messages. Calls to this method should - be balanced with removeListener(GoogleApiClient, MessageListener) to avoid leaking - resources. - -

Callers wishing to be notified of events in the background should use - WearableListenerService. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeListener - (GoogleApiClient client, MessageApi.MessageListener listener) -

-
-
- - - -
-
- - - - -

Removes a message listener which was previously added through - addListener(GoogleApiClient, MessageListener). -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<MessageApi.SendMessageResult> - - sendMessage - (GoogleApiClient client, String nodeId, String path, byte[] data) -

-
-
- - - -
-
- - - - -

Sends byte[] data to the specified node.

-
-
Parameters
- - - - - - - - - - -
nodeId - identifier for a particular node on the Android Wear network. Valid targets - may be obtained through getConnectedNodes(GoogleApiClient) or from - the host in getUri().
path - identifier used to specify a particular endpoint at the receiving node
data - small array of information to pass to the target node. Generally not larger - than 100k
-
-
-
Returns
-
  • a PendingResult that is set when the message is queued to be sent. - A successful result doesn't guarantee delivery. -
-
- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/MessageEvent.html b/docs/html/reference/com/google/android/gms/wearable/MessageEvent.html deleted file mode 100644 index 49bcfadacc6f..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/MessageEvent.html +++ /dev/null @@ -1,1224 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -MessageEvent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

MessageEvent

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.MessageEvent
- - - - - - - -
- - -

Class Overview

-

Information about a message received by a listener. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - byte[] - - getData() - -
- Returns the data passed by the message. - - - -
- -
- abstract - - - - - String - - getPath() - -
- Returns the path the message is being delivered to - - - -
- -
- abstract - - - - - int - - getRequestId() - -
- Returns the request id of the message, generated by the sender - - - -
- -
- abstract - - - - - String - - getSourceNodeId() - -
- Returns the node ID of the sender. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

Returns the data passed by the message.

- -
-
- - - - -
-

- - public - - - abstract - - String - - getPath - () -

-
-
- - - -
-
- - - - -

Returns the path the message is being delivered to

- -
-
- - - - -
-

- - public - - - abstract - - int - - getRequestId - () -

-
-
- - - -
-
- - - - -

Returns the request id of the message, generated by the sender

- -
-
- - - - -
-

- - public - - - abstract - - String - - getSourceNodeId - () -

-
-
- - - -
-
- - - - -

Returns the node ID of the sender.

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Node.html b/docs/html/reference/com/google/android/gms/wearable/Node.html deleted file mode 100644 index a29696a9968f..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Node.html +++ /dev/null @@ -1,1172 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Node | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

Node

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.Node
- - - - - - - -
- - -

Class Overview

-

Information about a particular node in the Android Wear network. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - String - - getDisplayName() - -
- Returns a human readable description of the node. - - - -
- -
- abstract - - - - - String - - getId() - -
- Returns an opaque string that represents a node in the Android Wear network. - - - -
- -
- abstract - - - - - boolean - - isNearby() - -
- Indicates that this node can be considered geographically nearby the local node. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - String - - getDisplayName - () -

-
-
- - - -
-
- - - - -

Returns a human readable description of the node. Sometimes generated from the Bluetooth - device name -

- -
-
- - - - -
-

- - public - - - abstract - - String - - getId - () -

-
-
- - - -
-
- - - - -

Returns an opaque string that represents a node in the Android Wear network.

- -
-
- - - - -
-

- - public - - - abstract - - boolean - - isNearby - () -

-
-
- - - -
-
- - - - -

Indicates that this node can be considered geographically nearby the local node. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetConnectedNodesResult.html b/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetConnectedNodesResult.html deleted file mode 100644 index 14c660a14c7f..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetConnectedNodesResult.html +++ /dev/null @@ -1,1150 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NodeApi.GetConnectedNodesResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

NodeApi.GetConnectedNodesResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.NodeApi.GetConnectedNodesResult
- - - - - - - -
- - -

Class Overview

-

Contains a list of connected nodes.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - List<Node> - - getNodes() - -
- Returns a list of connected nodes, either directly or indirectly via a directly - connected node. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - List<Node> - - getNodes - () -

-
-
- - - -
-
- - - - -

Returns a list of connected nodes, either directly or indirectly via a directly - connected node. This list doesn't include the local node.

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetLocalNodeResult.html b/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetLocalNodeResult.html deleted file mode 100644 index 8e460c93f695..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/NodeApi.GetLocalNodeResult.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NodeApi.GetLocalNodeResult | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

NodeApi.GetLocalNodeResult

- - - - - - implements - - Result - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.NodeApi.GetLocalNodeResult
- - - - - - - -
- - -

Class Overview

-

Contains the name and id that represents this device.

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - Node - - getNode() - -
- Returns a Node object which represents this device. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From interface - - com.google.android.gms.common.api.Result - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - Node - - getNode - () -

-
-
- - - -
-
- - - - -

Returns a Node object which represents this device.

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/NodeApi.NodeListener.html b/docs/html/reference/com/google/android/gms/wearable/NodeApi.NodeListener.html deleted file mode 100644 index 3b29be943606..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/NodeApi.NodeListener.html +++ /dev/null @@ -1,1192 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NodeApi.NodeListener | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - interface -

NodeApi.NodeListener

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.NodeApi.NodeListener
- - - - - - -
- - Known Indirect Subclasses - -
- - -
-
- - -
- - -

Class Overview

-

Used with addListener(GoogleApiClient, NodeApi.NodeListener) to receive node events.

- - - -
-
See Also
- -
- - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - void - - onPeerConnected(Node peer) - -
- Notification that a peer is now reachable by this node. - - - -
- -
- abstract - - - - - void - - onPeerDisconnected(Node peer) - -
- Notification that a peer has been disconnected from this node or is no longer reachable - by this node. - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - void - - onPeerConnected - (Node peer) -

-
-
- - - -
-
- - - - -

Notification that a peer is now reachable by this node. It may be directly connected - to this node or it may be reachable only via a directly connected node. - -

Changes to a node's hop count or nearby status alone will not trigger an - onPeerConnected(Node) event as long as the node was already connected. - -

Since multiple nodes can be connected to a network at the same time, - peer connected and disconnected events can come in any order. -

- -
-
- - - - -
-

- - public - - - abstract - - void - - onPeerDisconnected - (Node peer) -

-
-
- - - -
-
- - - - -

Notification that a peer has been disconnected from this node or is no longer reachable - by this node. - -

Since multiple nodes can be connected to a network at the same time, - peer connected and disconnected events can come in any order. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/NodeApi.html b/docs/html/reference/com/google/android/gms/wearable/NodeApi.html deleted file mode 100644 index 64a3d3d068a3..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/NodeApi.html +++ /dev/null @@ -1,1301 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NodeApi | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - -
- -
-
- - - - -
-
- - - - -
- public - - - - interface -

NodeApi

- - - - - - - - - - - -
- -
- -
- - - - - - - - - -
com.google.android.gms.wearable.NodeApi
- - - - - - - -
- - -

Class Overview

-

Exposes an API for to learn about local or connected Nodes. -

- Node events are delivered to all applications on a device. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - interfaceNodeApi.GetConnectedNodesResult - Contains a list of connected nodes.  - - - -
- - - - - interfaceNodeApi.GetLocalNodeResult - Contains the name and id that represents this device.  - - - -
- - - - - interfaceNodeApi.NodeListener - Used with addListener(GoogleApiClient, NodeApi.NodeListener) to receive node events.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- abstract - - - - - PendingResult<Status> - - addListener(GoogleApiClient client, NodeApi.NodeListener listener) - -
- Registers a listener to receive all node events. - - - -
- -
- abstract - - - - - PendingResult<NodeApi.GetConnectedNodesResult> - - getConnectedNodes(GoogleApiClient client) - -
- Gets a list of nodes to which this device is currently connected, either directly or - indirectly via a directly connected node. - - - -
- -
- abstract - - - - - PendingResult<NodeApi.GetLocalNodeResult> - - getLocalNode(GoogleApiClient client) - -
- Gets the Node that refers to this device. - - - -
- -
- abstract - - - - - PendingResult<Status> - - removeListener(GoogleApiClient client, NodeApi.NodeListener listener) - -
- Removes a listener which was previously added through - addListener(GoogleApiClient, NodeListener). - - - -
- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - abstract - - PendingResult<Status> - - addListener - (GoogleApiClient client, NodeApi.NodeListener listener) -

-
-
- - - -
-
- - - - -

Registers a listener to receive all node events. Calls to this method should be balanced - with removeListener(GoogleApiClient, NodeListener), to avoid leaking resources. - -

Callers wishing to be notified of node events in the background should use - WearableListenerService. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<NodeApi.GetConnectedNodesResult> - - getConnectedNodes - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Gets a list of nodes to which this device is currently connected, either directly or - indirectly via a directly connected node. - -

The returned list will not include the - local node. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<NodeApi.GetLocalNodeResult> - - getLocalNode - (GoogleApiClient client) -

-
-
- - - -
-
- - - - -

Gets the Node that refers to this device. The information in the returned - Node can be passed to other devices using the MessageApi, for example. -

- -
-
- - - - -
-

- - public - - - abstract - - PendingResult<Status> - - removeListener - (GoogleApiClient client, NodeApi.NodeListener listener) -

-
-
- - - -
-
- - - - -

Removes a listener which was previously added through - addListener(GoogleApiClient, NodeListener). -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/PutDataMapRequest.html b/docs/html/reference/com/google/android/gms/wearable/PutDataMapRequest.html deleted file mode 100644 index 58c80b51af4c..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/PutDataMapRequest.html +++ /dev/null @@ -1,1592 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PutDataMapRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - - - Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PutDataMapRequest

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.PutDataMapRequest
- - - - - - - -
- - -

Class Overview

-

PutDataMapRequest is a DataMap-aware version of PutDataRequest. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - PutDataRequest - - asPutDataRequest() - -
- Creates a PutDataRequest containing the data and assets in this - PutDataMapRequest. - - - -
- -
- - - - static - - PutDataMapRequest - - create(String path) - -
- Creates a PutDataMapRequest with the provided, complete, path. - - - -
- -
- - - - static - - PutDataMapRequest - - createFromDataMapItem(DataMapItem source) - -
- Creates a PutDataMapRequest from a DataMapItem using the provided source. - - - -
- -
- - - - static - - PutDataMapRequest - - createWithAutoAppendedId(String pathPrefix) - -
- Creates a PutDataMapRequest with a randomly generated id prefixed with the provided - path. - - - -
- -
- - - - - - DataMap - - getDataMap() - -
- - - - - - Uri - - getUri() - -
- Returns a Uri for the pending data item. - - - -
- -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - PutDataRequest - - asPutDataRequest - () -

-
-
- - - -
-
- - - - -

Creates a PutDataRequest containing the data and assets in this - PutDataMapRequest. -

- -
-
- - - - -
-

- - public - static - - - - PutDataMapRequest - - create - (String path) -

-
-
- - - -
-
- - - - -

Creates a PutDataMapRequest with the provided, complete, path.

- -
-
- - - - -
-

- - public - static - - - - PutDataMapRequest - - createFromDataMapItem - (DataMapItem source) -

-
-
- - - -
-
- - - - -

Creates a PutDataMapRequest from a DataMapItem using the provided source.

- -
-
- - - - -
-

- - public - static - - - - PutDataMapRequest - - createWithAutoAppendedId - (String pathPrefix) -

-
-
- - - -
-
- - - - -

Creates a PutDataMapRequest with a randomly generated id prefixed with the provided - path. -

- -
-
- - - - -
-

- - public - - - - - DataMap - - getDataMap - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • the structured data associated with this data item.
-
- -
-
- - - - -
-

- - public - - - - - Uri - - getUri - () -

-
-
- - - -
-
- - - - -

Returns a Uri for the pending data item. If this is a modification of an existing - data item, getHost() will return the id of the node that originally created it. - Otherwise, a new data item will be created with the requesting device's node. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/PutDataRequest.html b/docs/html/reference/com/google/android/gms/wearable/PutDataRequest.html deleted file mode 100644 index aedcfce16ebc..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/PutDataRequest.html +++ /dev/null @@ -1,2327 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PutDataRequest | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - | Fields - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

PutDataRequest

- - - - - extends Object
- - - - - - - implements - - Parcelable - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.PutDataRequest
- - - - - - - -
- - -

Class Overview

-

PutDataRequest is used to create new data items in the Android Wear network. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
StringWEAR_URI_SCHEME - URI scheme to use for Wear URIs. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From interface -android.os.Parcelable -
- - -
-
- - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Creator<PutDataRequest>CREATOR - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - PutDataRequest - - create(String path) - -
- Creates a dataItem with the provided, complete, path. - - - -
- -
- - - - static - - PutDataRequest - - createFromDataItem(DataItem source) - -
- Creates a PutDataRequest from an existing DataItem using the provided source. - - - -
- -
- - - - static - - PutDataRequest - - createWithAutoAppendedId(String pathPrefix) - -
- Creates a PutDataRequest with a randomly generated id prefixed with the provided - path. - - - -
- -
- - - - - - int - - describeContents() - -
- - - - - - Asset - - getAsset(String key) - -
- Returns an asset previously added with putAsset(String, Asset). - - - -
- -
- - - - - - Map<String, Asset> - - getAssets() - -
- - - - - - byte[] - - getData() - -
- An array of data stored at the specfied Uri. - - - -
- -
- - - - - - Uri - - getUri() - -
- Returns a Uri for the pending data item. - - - -
- -
- - - - - - boolean - - hasAsset(String key) - -
- - - - - - PutDataRequest - - putAsset(String key, Asset value) - -
- Adds an asset to the data item. - - - -
- -
- - - - - - PutDataRequest - - removeAsset(String key) - -
- Removes a previoulsy added asset. - - - -
- -
- - - - - - PutDataRequest - - setData(byte[] data) - -
- Sets the data in a data item. - - - -
- -
- - - - - - String - - toString(boolean verbose) - -
- - - - - - String - - toString() - -
- - - - - - void - - writeToParcel(Parcel dest, int flags) - -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.os.Parcelable - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - String - - WEAR_URI_SCHEME -

-
- - - - -
-
- - - - -

URI scheme to use for Wear URIs. See DataApi for details of the Wear URI format. -

- - -
- Constant Value: - - - "wear" - - -
- -
-
- - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Creator<PutDataRequest> - - CREATOR -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - PutDataRequest - - create - (String path) -

-
-
- - - -
-
- - - - -

Creates a dataItem with the provided, complete, path.

- -
-
- - - - -
-

- - public - static - - - - PutDataRequest - - createFromDataItem - (DataItem source) -

-
-
- - - -
-
- - - - -

Creates a PutDataRequest from an existing DataItem using the provided source.

- -
-
- - - - -
-

- - public - static - - - - PutDataRequest - - createWithAutoAppendedId - (String pathPrefix) -

-
-
- - - -
-
- - - - -

Creates a PutDataRequest with a randomly generated id prefixed with the provided - path. -

- -
-
- - - - -
-

- - public - - - - - int - - describeContents - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - Asset - - getAsset - (String key) -

-
-
- - - -
-
- - - - -

Returns an asset previously added with putAsset(String, Asset).

- -
-
- - - - -
-

- - public - - - - - Map<String, Asset> - - getAssets - () -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • unmodifiable map of assets on this dataItem. -
-
- -
-
- - - - -
-

- - public - - - - - byte[] - - getData - () -

-
-
- - - -
-
- - - - -

An array of data stored at the specfied Uri. PutDataMapRequest may be used - to store structured data in the network. -

- -
-
- - - - -
-

- - public - - - - - Uri - - getUri - () -

-
-
- - - -
-
- - - - -

Returns a Uri for the pending data item. If this is a modification of an existing - data item, getHost() will return the id of the node that originally created it. - Otherwise, a new data item will be created with the requesting device's node. -

- -
-
- - - - -
-

- - public - - - - - boolean - - hasAsset - (String key) -

-
-
- - - -
-
- - - - -

-
-
Returns
-
  • true if the asset exists in this data item.
-
- -
-
- - - - -
-

- - public - - - - - PutDataRequest - - putAsset - (String key, Asset value) -

-
-
- - - -
-
- - - - -

Adds an asset to the data item.

- -
-
- - - - -
-

- - public - - - - - PutDataRequest - - removeAsset - (String key) -

-
-
- - - -
-
- - - - -

Removes a previoulsy added asset.

- -
-
- - - - -
-

- - public - - - - - PutDataRequest - - setData - (byte[] data) -

-
-
- - - -
-
- - - - -

Sets the data in a data item.

- -
-
- - - - -
-

- - public - - - - - String - - toString - (boolean verbose) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - String - - toString - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - writeToParcel - (Parcel dest, int flags) -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.Builder.html b/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.Builder.html deleted file mode 100644 index 2c75e28b0fcd..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.Builder.html +++ /dev/null @@ -1,1367 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wearable.WearableOptions.Builder | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - - - - - - - - - Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - - - class -

Wearable.WearableOptions.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.Wearable.WearableOptions.Builder
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - Wearable.WearableOptions.Builder() - -
- - - - - - - - - - - - - - - - - - -
Public Methods
- - - - - - Wearable.WearableOptions - - build() - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - Wearable.WearableOptions.Builder - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - - - - Wearable.WearableOptions - - build - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.html b/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.html deleted file mode 100644 index 7fea53e92058..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Wearable.WearableOptions.html +++ /dev/null @@ -1,1300 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wearable.WearableOptions | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - static - final - - class -

Wearable.WearableOptions

- - - - - extends Object
- - - - - - - implements - - Api.ApiOptions.Optional - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.Wearable.WearableOptions
- - - - - - - -
- - -

Class Overview

-

API configuration parameters for Wearable API. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWearable.WearableOptions.Builder -   - - - -
- - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/Wearable.html b/docs/html/reference/com/google/android/gms/wearable/Wearable.html deleted file mode 100644 index df138a5f932b..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/Wearable.html +++ /dev/null @@ -1,1571 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Wearable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - -
- -Summary: - - Nested Classes - - - - - - - - - | Fields - - - - - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - - class -

Wearable

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.wearable.Wearable
- - - - - - - -
- - -

Class Overview

-

An API for the Android Wear platform. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nested Classes
- - - - - classWearable.WearableOptions - API configuration parameters for Wearable API.  - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields
- public - static - final - Api<Wearable.WearableOptions>API - Token to pass to addApi(Api) to enable the - Wearable features. - - - -
- public - static - final - CapabilityApiCapabilityApi - - - - -
- public - static - final - ChannelApiChannelApi - - - - -
- public - static - final - DataApiDataApi - - - - -
- public - static - final - MessageApiMessageApi - - - - -
- public - static - final - NodeApiNodeApi - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - -

Fields

- - - - - - -
-

- - public - static - final - Api<Wearable.WearableOptions> - - API -

-
- - - - -
-
- - - - -

Token to pass to addApi(Api) to enable the - Wearable features. -

- - -
-
- - - - - -
-

- - public - static - final - CapabilityApi - - CapabilityApi -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - final - ChannelApi - - ChannelApi -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - final - DataApi - - DataApi -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - final - MessageApi - - MessageApi -

-
- - - - -
-
- - - - -

- - -
-
- - - - - -
-

- - public - static - final - NodeApi - - NodeApi -

-
- - - - -
-
- - - - -

- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/WearableListenerService.html b/docs/html/reference/com/google/android/gms/wearable/WearableListenerService.html deleted file mode 100644 index 3f752123019b..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/WearableListenerService.html +++ /dev/null @@ -1,7388 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableListenerService | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - - Inherited Constants - - - - - - | Ctors - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - - abstract - class -

WearableListenerService

- - - - - - - - - - - - - - - - - extends Service
- - - - - - - implements - - DataApi.DataListener - - MessageApi.MessageListener - - NodeApi.NodeListener - - CapabilityApi.CapabilityListener - - ChannelApi.ChannelListener - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳android.content.Context
    ↳android.content.ContextWrapper
     ↳android.app.Service
      ↳com.google.android.gms.wearable.WearableListenerService
- - - - - - - -
- - -

Class Overview

-

Receives events from other nodes, such as data changes, messages or connectivity events. -

- The life-cycle of this service is managed by Android Wear. This service will - be bound to and events delivered as a result of changes through the DataApi, - MessageApi as well as events indicating a device has connected or disconnected from the - Android Wear network. -

- Applications expecting to be notified of events while in the background should extend this - class. Activities and other short-lived Android components may use addListener(GoogleApiClient, DataApi.DataListener), - addListener(GoogleApiClient, MessageApi.MessageListener) and addListener(GoogleApiClient, NodeApi.NodeListener) to receive events for a limited - period of time. -

- Only one WearableListenerService may be specified for an application. -

- Implementors could use a LocalBroadcastManager to dispatch events to other components in - an application. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -android.app.Service -
- - -
-
- - From class -android.content.Context -
- - -
-
- - From interface -android.content.ComponentCallbacks2 -
- - -
-
- - From interface -com.google.android.gms.wearable.ChannelApi.ChannelListener -
- - -
-
- - - - - - - - - - - - - - - - - - - - - -
Public Constructors
- - - - - - - - WearableListenerService() - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - final - - - IBinder - - onBind(Intent intent) - -
- - - - - - void - - onCapabilityChanged(CapabilityInfo capabilityInfo) - -
- - - - - - void - - onChannelClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when a channel is closed. - - - -
- -
- - - - - - void - - onChannelOpened(Channel channel) - -
- Called when a new channel is opened by a remote node. - - - -
- -
- - - - - - void - - onConnectedNodes(List<Node> connectedNodes) - -
- - - - - - void - - onCreate() - -
- - - - - - void - - onDataChanged(DataEventBuffer dataEvents) - -
- Receives data changed events. - - - -
- -
- - - - - - void - - onDestroy() - -
- - - - - - void - - onInputClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when the input side of a channel is closed. - - - -
- -
- - - - - - void - - onMessageReceived(MessageEvent messageEvent) - -
- Receives message events. - - - -
- -
- - - - - - void - - onOutputClosed(Channel channel, int closeReason, int appSpecificErrorCode) - -
- Called when the output side of a channel is closed. - - - -
- -
- - - - - - void - - onPeerConnected(Node peer) - -
- Notification that a peer is now reachable by this node. - - - -
- -
- - - - - - void - - onPeerDisconnected(Node peer) - -
- Notification that a peer has been disconnected from this node or is no longer reachable - by this node. - - - -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - android.app.Service - -
- - -
-
- -From class - - android.content.ContextWrapper - -
- - -
-
- -From class - - android.content.Context - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- -From interface - - android.content.ComponentCallbacks2 - -
- - -
-
- -From interface - - com.google.android.gms.wearable.DataApi.DataListener - -
- - -
-
- -From interface - - com.google.android.gms.wearable.MessageApi.MessageListener - -
- - -
-
- -From interface - - com.google.android.gms.wearable.NodeApi.NodeListener - -
- - -
-
- -From interface - - com.google.android.gms.wearable.CapabilityApi.CapabilityListener - -
- - -
-
- -From interface - - com.google.android.gms.wearable.ChannelApi.ChannelListener - -
- - -
-
- -From interface - - android.content.ComponentCallbacks - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Constructors

- - - - - -
-

- - public - - - - - - - WearableListenerService - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - - final - - - IBinder - - onBind - (Intent intent) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCapabilityChanged - (CapabilityInfo capabilityInfo) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onChannelClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when a channel is closed. This can happen through an explicit call to - close(GoogleApiClient) or close(GoogleApiClient, int) on - either side of the connection, or due to disconnecting from the remote node.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the channel closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - or CLOSE_REASON_LOCAL_CLOSE.
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onChannelOpened - (Channel channel) -

-
-
- - - -
-
- - - - -

Called when a new channel is opened by a remote node.

- -
-
- - - - -
-

- - public - - - - - void - - onConnectedNodes - (List<Node> connectedNodes) -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onCreate - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onDataChanged - (DataEventBuffer dataEvents) -

-
-
- - - -
-
- - - - -

Receives data changed events. The provided buffer will be closed after this method - completes. Use freeze() on items in the buffer to use them outside of this - callscope. -

- Multiple data events may delivered in a single call and may only contain final-state - modifications of a data item. (Eg, multiple calls to putDataItem changing the value of the - data item's getData() may only appear as a single event, with the last - modification expressed). -

- Applications needing to track the of all its data items, may use - getDataItems(GoogleApiClient) on boot to retrieve all existing data items. -

- -
-
- - - - -
-

- - public - - - - - void - - onDestroy - () -

-
-
- - - -
-
- - - - -

- -
-
- - - - -
-

- - public - - - - - void - - onInputClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when the input side of a channel is closed.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the input closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED - or CLOSE_REASON_NORMAL. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onMessageReceived - (MessageEvent messageEvent) -

-
-
- - - -
-
- - - - -

Receives message events. -

- -
-
- - - - -
-

- - public - - - - - void - - onOutputClosed - (Channel channel, int closeReason, int appSpecificErrorCode) -

-
-
- - - -
-
- - - - -

Called when the output side of a channel is closed.

-
-
Parameters
- - - - - - - -
closeReason - the reason for the output closing. One of - CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, - CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode - the error code specified on close(GoogleApiClient), - or 0 if closeReason is CLOSE_REASON_DISCONNECTED - or CLOSE_REASON_NORMAL. -
-
- -
-
- - - - -
-

- - public - - - - - void - - onPeerConnected - (Node peer) -

-
-
- - - -
-
- - - - -

Notification that a peer is now reachable by this node. It may be directly connected - to this node or it may be reachable only via a directly connected node. - -

Changes to a node's hop count or nearby status alone will not trigger an - onPeerConnected(Node) event as long as the node was already connected. - -

Since multiple nodes can be connected to a network at the same time, - peer connected and disconnected events can come in any order. -

- -
-
- - - - -
-

- - public - - - - - void - - onPeerDisconnected - (Node peer) -

-
-
- - - -
-
- - - - -

Notification that a peer has been disconnected from this node or is no longer reachable - by this node. - -

Since multiple nodes can be connected to a network at the same time, - peer connected and disconnected events can come in any order. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/WearableStatusCodes.html b/docs/html/reference/com/google/android/gms/wearable/WearableStatusCodes.html deleted file mode 100644 index d25264d61724..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/WearableStatusCodes.html +++ /dev/null @@ -1,2074 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -WearableStatusCodes | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- -Summary: - - - - - - Constants - - - - | Inherited Constants - - - - - - - - | Methods - - - - - | Inherited Methods - -| [Expand All] - -
-
- - - - -
-
- - - - -
- public - - final - - class -

WearableStatusCodes

- - - - - - - - - extends CommonStatusCodes
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - -
java.lang.Object
   ↳com.google.android.gms.common.api.CommonStatusCodes
    ↳com.google.android.gms.wearable.WearableStatusCodes
- - - - - - - -
- - -

Class Overview

-

Error codes for wearable API failures. These values may be returned by APIs to indicate the - success or failure of a request. -

- - - - - -
- - - - - - - - - - - - - - - - -
- - -

Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Constants
intASSET_UNAVAILABLE - Indicates that the requested asset is unavailable. - - - -
intDATA_ITEM_TOO_LARGE - Indicates that the data item was too large to set. - - - -
intDUPLICATE_CAPABILITY - Indicates that the specified capability already exists. - - - -
intDUPLICATE_LISTENER - Indicates that the specified listener is already registered. - - - -
intINVALID_TARGET_NODE - Indicates that the targeted node is not a valid node in the wearable network. - - - -
intTARGET_NODE_NOT_CONNECTED - Indicates that the targeted node is not accessible in the wearable network. - - - -
intUNKNOWN_CAPABILITY - Indicates that the specified capability is not recognized. - - - -
intUNKNOWN_LISTENER - Indicates that the specified listener is not recognized. - - - -
- - - - - - - - - - - - - - - -
- [Expand] -
Inherited Constants
- - From class -com.google.android.gms.common.api.CommonStatusCodes -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Public Methods
- - - - static - - String - - getStatusCodeString(int statusCode) - -
- Returns an untranslated debug (not user-friendly!) string based on the current status code. - - - -
- -
- - - - - - - - - - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - com.google.android.gms.common.api.CommonStatusCodes - -
- - -
-
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - -

Constants

- - - - - - -
-

- - public - static - final - int - - ASSET_UNAVAILABLE -

-
- - - - -
-
- - - - -

Indicates that the requested asset is unavailable.

- - -
- Constant Value: - - - 4005 - (0x00000fa5) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DATA_ITEM_TOO_LARGE -

-
- - - - -
-
- - - - -

Indicates that the data item was too large to set.

- - -
- Constant Value: - - - 4003 - (0x00000fa3) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DUPLICATE_CAPABILITY -

-
- - - - -
-
- - - - -

Indicates that the specified capability already exists.

- - -
- Constant Value: - - - 4006 - (0x00000fa6) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - DUPLICATE_LISTENER -

-
- - - - -
-
- - - - -

Indicates that the specified listener is already registered.

- - -
- Constant Value: - - - 4001 - (0x00000fa1) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - INVALID_TARGET_NODE -

-
- - - - -
-
- - - - -

Indicates that the targeted node is not a valid node in the wearable network.

- - -
- Constant Value: - - - 4004 - (0x00000fa4) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - TARGET_NODE_NOT_CONNECTED -

-
- - - - -
-
- - - - -

Indicates that the targeted node is not accessible in the wearable network.

- - -
- Constant Value: - - - 4000 - (0x00000fa0) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN_CAPABILITY -

-
- - - - -
-
- - - - -

Indicates that the specified capability is not recognized.

- - -
- Constant Value: - - - 4007 - (0x00000fa7) - - -
- -
-
- - - - - -
-

- - public - static - final - int - - UNKNOWN_LISTENER -

-
- - - - -
-
- - - - -

Indicates that the specified listener is not recognized.

- - -
- Constant Value: - - - 4002 - (0x00000fa2) - - -
- -
-
- - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - String - - getStatusCodeString - (int statusCode) -

-
-
- - - -
-
- - - - -

Returns an untranslated debug (not user-friendly!) string based on the current status code. -

- -
-
- - - - - - - - - - - - - -
- -
- -
- - - - - - - - diff --git a/docs/html/reference/com/google/android/gms/wearable/package-summary.html b/docs/html/reference/com/google/android/gms/wearable/package-summary.html deleted file mode 100644 index c9a7cadc6bdc..000000000000 --- a/docs/html/reference/com/google/android/gms/wearable/package-summary.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -com.google.android.gms.wearable | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-
- - - - -
-
- -
- package -

com.google.android.gms.wearable

-
- -
- -
- - - - - - - -

Annotations

-
- - - - - - - - - - -
ChannelApi.CloseReason - An annotation for values passed to onChannelClosed(Channel, int, int), and other methods - on the ChannelApi.ChannelListener interface.  - - - -
- -
- - - - -

Interfaces

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CapabilityApi - Exposes an API to learn about capabilities provided by nodes on the Wear network.  - - - -
CapabilityApi.AddLocalCapabilityResult - Result returned from addLocalCapability(GoogleApiClient, String)   - - - -
CapabilityApi.CapabilityListener - Listener for changes in the reachable nodes providing a capability.  - - - -
CapabilityApi.GetAllCapabilitiesResult - Result returned from getAllCapabilities(GoogleApiClient, int)   - - - -
CapabilityApi.GetCapabilityResult - Result returned from getCapability(GoogleApiClient, String, int)   - - - -
CapabilityApi.RemoveLocalCapabilityResult - Result returned from removeLocalCapability(GoogleApiClient, String)   - - - -
CapabilityInfo - Information about a Capability on the network and where it is available.  - - - -
Channel - A channel created through openChannel(GoogleApiClient, String, String).  - - - -
Channel.GetInputStreamResult - Result of getInputStream(GoogleApiClient).  - - - -
Channel.GetOutputStreamResult - Result of getOutputStream(GoogleApiClient).  - - - -
ChannelApi - Client interface for Wearable Channel API.  - - - -
ChannelApi.ChannelListener - A listener which will be notified on changes to channels.  - - - -
ChannelApi.OpenChannelResult - Result of openChannel(GoogleApiClient, String, String).  - - - -
DataApi - Exposes an API for components to read or write data items and - assets.  - - - -
DataApi.DataItemResult - Contains a single data item.  - - - -
DataApi.DataListener - Used with addListener(GoogleApiClient, DataApi.DataListener) to receive data events.  - - - -
DataApi.DeleteDataItemsResult - Contains the number of deleted items.  - - - -
DataApi.GetFdForAssetResult - Contains a file descriptor for the requested asset.  - - - -
DataEvent - Data interface for data events.  - - - -
DataItem - The base object of data stored in the Android Wear network.  - - - -
DataItemAsset - A reference to an asset stored in a data item.  - - - -
MessageApi - Exposes an API for components to send messages to other nodes.  - - - -
MessageApi.MessageListener - Used with addListener(GoogleApiClient, MessageApi.MessageListener) to receive message events.  - - - -
MessageApi.SendMessageResult - Contains the request id assigned to the message.  - - - -
MessageEvent - Information about a message received by a listener.  - - - -
Node - Information about a particular node in the Android Wear network.  - - - -
NodeApi - Exposes an API for to learn about local or connected Nodes.  - - - -
NodeApi.GetConnectedNodesResult - Contains a list of connected nodes.  - - - -
NodeApi.GetLocalNodeResult - Contains the name and id that represents this device.  - - - -
NodeApi.NodeListener - Used with addListener(GoogleApiClient, NodeApi.NodeListener) to receive node events.  - - - -
- -
- - - - -

Classes

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Asset - An asset is a binary blob shared between data items that is replicated across the wearable - network on demand.  - - - -
DataEventBuffer - Data structure holding references to a set of events.  - - - -
DataItemBuffer - Data structure holding reference to a set of DataItems.  - - - -
DataMap - A map of data supported by PutDataMapRequest and DataMapItems.  - - - -
DataMapItem - Creates a new dataItem-like object containing structured and serializable data.  - - - -
PutDataMapRequest - PutDataMapRequest is a DataMap-aware version of PutDataRequest.  - - - -
PutDataRequest - PutDataRequest is used to create new data items in the Android Wear network.  - - - -
Wearable - An API for the Android Wear platform.  - - - -
Wearable.WearableOptions - API configuration parameters for Wearable API.  - - - -
Wearable.WearableOptions.Builder -   - - - -
WearableListenerService - Receives events from other nodes, such as data changes, messages or connectivity events.  - - - -
WearableStatusCodes - Error codes for wearable API failures.  - - - -
- -
- - - - - - - -

Exceptions

-
- - - - - - - - - - -
ChannelIOException - A subclass of IOException which can be thrown from the streams returned by - getInputStream(GoogleApiClient) and - getOutputStream(GoogleApiClient).  - - - -
- -
- - - - - - - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/gcm-packages.html b/docs/html/reference/gcm-packages.html deleted file mode 100644 index 9c6efaca8ee0..000000000000 --- a/docs/html/reference/gcm-packages.html +++ /dev/null @@ -1,690 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Package Index | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - -
- -
-

Package Index

-
- -
- -
-

-
- - - - - - - - - - - - - - - - -
- com.google.android.gcm

DEPRECATED — please use the GoogleCloudMessaging API instead of this client helper library — see GCM Client for more information.

- com.google.android.gcm.server

Helper library for GCM HTTP server operations — see GCM Server for more information.

- - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/gcm_lists.js b/docs/html/reference/gcm_lists.js deleted file mode 100644 index 2672fab556fc..000000000000 --- a/docs/html/reference/gcm_lists.js +++ /dev/null @@ -1,18 +0,0 @@ -var GCM_DATA = [ - { id:0, label:"com.google.android.gcm", link:"reference/com/google/android/gcm/package-summary.html", type:"package", deprecated:"false" }, - { id:1, label:"com.google.android.gcm.GCMBaseIntentService", link:"reference/com/google/android/gcm/GCMBaseIntentService.html", type:"class", deprecated:"true" }, - { id:2, label:"com.google.android.gcm.GCMBroadcastReceiver", link:"reference/com/google/android/gcm/GCMBroadcastReceiver.html", type:"class", deprecated:"true" }, - { id:3, label:"com.google.android.gcm.GCMConstants", link:"reference/com/google/android/gcm/GCMConstants.html", type:"class", deprecated:"true" }, - { id:4, label:"com.google.android.gcm.GCMRegistrar", link:"reference/com/google/android/gcm/GCMRegistrar.html", type:"class", deprecated:"true" }, - { id:5, label:"com.google.android.gcm.server", link:"reference/com/google/android/gcm/server/package-summary.html", type:"package", deprecated:"false" }, - { id:6, label:"com.google.android.gcm.server.Constants", link:"reference/com/google/android/gcm/server/Constants.html", type:"class", deprecated:"false" }, - { id:7, label:"com.google.android.gcm.server.InvalidRequestException", link:"reference/com/google/android/gcm/server/InvalidRequestException.html", type:"class", deprecated:"false" }, - { id:8, label:"com.google.android.gcm.server.Message", link:"reference/com/google/android/gcm/server/Message.html", type:"class", deprecated:"false" }, - { id:9, label:"com.google.android.gcm.server.Message.Builder", link:"reference/com/google/android/gcm/server/Message.Builder.html", type:"class", deprecated:"false" }, - { id:10, label:"com.google.android.gcm.server.MulticastResult", link:"reference/com/google/android/gcm/server/MulticastResult.html", type:"class", deprecated:"false" }, - { id:11, label:"com.google.android.gcm.server.MulticastResult.Builder", link:"reference/com/google/android/gcm/server/MulticastResult.Builder.html", type:"class", deprecated:"false" }, - { id:12, label:"com.google.android.gcm.server.Result", link:"reference/com/google/android/gcm/server/Result.html", type:"class", deprecated:"false" }, - { id:13, label:"com.google.android.gcm.server.Result.Builder", link:"reference/com/google/android/gcm/server/Result.Builder.html", type:"class", deprecated:"false" }, - { id:14, label:"com.google.android.gcm.server.Sender", link:"reference/com/google/android/gcm/server/Sender.html", type:"class", deprecated:"false" } - - ]; diff --git a/docs/html/reference/gms-packages.html b/docs/html/reference/gms-packages.html deleted file mode 100644 index 73d355e4afb8..000000000000 --- a/docs/html/reference/gms-packages.html +++ /dev/null @@ -1,1263 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Package Index | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
- - - - - - - - -
-
- - -
- - - - - - - -
- -
-

Package Index

-
- -
- -
-

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- com.google.android.gms
- com.google.android.gms.actionsContains classes for Google Search Actions.
- com.google.android.gms.adsContains classes for Google Mobile Ads.
- com.google.android.gms.ads.doubleclickContains classes for DoubleClick for Publishers.
- com.google.android.gms.ads.identifier
- com.google.android.gms.ads.mediationContains classes for Google Mobile Ads mediation adapters.
- com.google.android.gms.ads.mediation.admobContains classes for the AdMob mediation adapter.
- com.google.android.gms.ads.mediation.customeventContains classes for Google Mobile Ads mediation custom events.
- com.google.android.gms.ads.purchaseContains classes for In-App Purchase Ads.
- com.google.android.gms.ads.searchContains classes for Search Ads for Apps.
- com.google.android.gms.analytics
- com.google.android.gms.analytics.ecommerce
- com.google.android.gms.appindexing
- com.google.android.gms.appstateContains classes for manipulating saved app state data.
- com.google.android.gms.authContains classes for authenticating Google accounts.
- com.google.android.gms.castContains classes for interacting with Google Cast devices.
- com.google.android.gms.commonContains utility classes for Google Play services.
- com.google.android.gms.common.annotation
- com.google.android.gms.common.api
- com.google.android.gms.common.dataContains classes for accessing data from Google Play services.
- com.google.android.gms.common.imagesContains classes for loading images from Google Play services.
- com.google.android.gms.drive
- com.google.android.gms.drive.events
- com.google.android.gms.drive.metadata
- com.google.android.gms.drive.query
- com.google.android.gms.drive.widget
- com.google.android.gms.fitnessContains the Google Fit APIs.
- com.google.android.gms.fitness.dataContains the Google Fit data model.
- com.google.android.gms.fitness.requestContains request objects used in Google Fit API methods.
- com.google.android.gms.fitness.resultContains response objects used in Google Fit API methods.
- com.google.android.gms.fitness.serviceContains APIs for exposing third-party sensors to Google Fit using a service.
- com.google.android.gms.gamesContains the games client class.
- com.google.android.gms.games.achievementContains classes for loading and updating achievements.
- com.google.android.gms.games.event
- com.google.android.gms.games.leaderboardContains data classes for leaderboards.
- com.google.android.gms.games.multiplayerContains data classes for multiplayer functionality.
- com.google.android.gms.games.multiplayer.realtimeContains data classes for real-time multiplayer functionality.
- com.google.android.gms.games.multiplayer.turnbasedContains data classes for turn-based multiplayer functionality.
- com.google.android.gms.games.quest
- com.google.android.gms.games.request
- com.google.android.gms.games.snapshotContains data classes for snapshot functionality.
- com.google.android.gms.gcm
- com.google.android.gms.identity.intents
- com.google.android.gms.identity.intents.model
- com.google.android.gms.location
- com.google.android.gms.location.places
- com.google.android.gms.location.places.ui
- com.google.android.gms.mapsContains the Google Maps Android API classes.
- com.google.android.gms.maps.modelContains the Google Maps Android API model classes.
- com.google.android.gms.nearby
- com.google.android.gms.nearby.connection
- com.google.android.gms.panorama
- com.google.android.gms.plusContains the Google+ platform for Android.
- com.google.android.gms.plus.model.moments
- com.google.android.gms.plus.model.people
- com.google.android.gms.safetynet
- com.google.android.gms.searchContains the Search APIs -
- com.google.android.gms.security
- com.google.android.gms.tagmanager
- com.google.android.gms.walletContains the Wallet Client for Google Play services.
- com.google.android.gms.wallet.fragmentContains WalletFragment.
- com.google.android.gms.wearable
- - -
-
- -
- - - - - - - - diff --git a/docs/html/reference/gms_lists.js b/docs/html/reference/gms_lists.js deleted file mode 100644 index 466db55c569c..000000000000 --- a/docs/html/reference/gms_lists.js +++ /dev/null @@ -1,733 +0,0 @@ -var GMS_DATA = [ - { id:0, label:"com.google.android.gms", link:"reference/com/google/android/gms/package-summary.html", type:"package", deprecated:"false" }, - { id:1, label:"com.google.android.gms.R", link:"reference/com/google/android/gms/R.html", type:"class", deprecated:"false" }, - { id:2, label:"com.google.android.gms.R.attr", link:"reference/com/google/android/gms/R.attr.html", type:"class", deprecated:"false" }, - { id:3, label:"com.google.android.gms.R.color", link:"reference/com/google/android/gms/R.color.html", type:"class", deprecated:"false" }, - { id:4, label:"com.google.android.gms.R.drawable", link:"reference/com/google/android/gms/R.drawable.html", type:"class", deprecated:"false" }, - { id:5, label:"com.google.android.gms.R.id", link:"reference/com/google/android/gms/R.id.html", type:"class", deprecated:"false" }, - { id:6, label:"com.google.android.gms.R.integer", link:"reference/com/google/android/gms/R.integer.html", type:"class", deprecated:"false" }, - { id:7, label:"com.google.android.gms.R.raw", link:"reference/com/google/android/gms/R.raw.html", type:"class", deprecated:"false" }, - { id:8, label:"com.google.android.gms.R.string", link:"reference/com/google/android/gms/R.string.html", type:"class", deprecated:"false" }, - { id:9, label:"com.google.android.gms.R.style", link:"reference/com/google/android/gms/R.style.html", type:"class", deprecated:"false" }, - { id:10, label:"com.google.android.gms.R.styleable", link:"reference/com/google/android/gms/R.styleable.html", type:"class", deprecated:"false" }, - { id:11, label:"com.google.android.gms.actions", link:"reference/com/google/android/gms/actions/package-summary.html", type:"package", deprecated:"false" }, - { id:12, label:"com.google.android.gms.actions.ItemListIntents", link:"reference/com/google/android/gms/actions/ItemListIntents.html", type:"class", deprecated:"false" }, - { id:13, label:"com.google.android.gms.actions.NoteIntents", link:"reference/com/google/android/gms/actions/NoteIntents.html", type:"class", deprecated:"false" }, - { id:14, label:"com.google.android.gms.actions.ReserveIntents", link:"reference/com/google/android/gms/actions/ReserveIntents.html", type:"class", deprecated:"false" }, - { id:15, label:"com.google.android.gms.actions.SearchIntents", link:"reference/com/google/android/gms/actions/SearchIntents.html", type:"class", deprecated:"false" }, - { id:16, label:"com.google.android.gms.ads", link:"reference/com/google/android/gms/ads/package-summary.html", type:"package", deprecated:"false" }, - { id:17, label:"com.google.android.gms.ads.AdListener", link:"reference/com/google/android/gms/ads/AdListener.html", type:"class", deprecated:"false" }, - { id:18, label:"com.google.android.gms.ads.AdRequest", link:"reference/com/google/android/gms/ads/AdRequest.html", type:"class", deprecated:"false" }, - { id:19, label:"com.google.android.gms.ads.AdRequest.Builder", link:"reference/com/google/android/gms/ads/AdRequest.Builder.html", type:"class", deprecated:"false" }, - { id:20, label:"com.google.android.gms.ads.AdSize", link:"reference/com/google/android/gms/ads/AdSize.html", type:"class", deprecated:"false" }, - { id:21, label:"com.google.android.gms.ads.AdView", link:"reference/com/google/android/gms/ads/AdView.html", type:"class", deprecated:"false" }, - { id:22, label:"com.google.android.gms.ads.InterstitialAd", link:"reference/com/google/android/gms/ads/InterstitialAd.html", type:"class", deprecated:"false" }, - { id:23, label:"com.google.android.gms.ads.doubleclick", link:"reference/com/google/android/gms/ads/doubleclick/package-summary.html", type:"package", deprecated:"false" }, - { id:24, label:"com.google.android.gms.ads.doubleclick.AppEventListener", link:"reference/com/google/android/gms/ads/doubleclick/AppEventListener.html", type:"class", deprecated:"false" }, - { id:25, label:"com.google.android.gms.ads.doubleclick.CustomRenderedAd", link:"reference/com/google/android/gms/ads/doubleclick/CustomRenderedAd.html", type:"class", deprecated:"false" }, - { id:26, label:"com.google.android.gms.ads.doubleclick.OnCustomRenderedAdLoadedListener", link:"reference/com/google/android/gms/ads/doubleclick/OnCustomRenderedAdLoadedListener.html", type:"class", deprecated:"false" }, - { id:27, label:"com.google.android.gms.ads.doubleclick.PublisherAdRequest", link:"reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.html", type:"class", deprecated:"false" }, - { id:28, label:"com.google.android.gms.ads.doubleclick.PublisherAdRequest.Builder", link:"reference/com/google/android/gms/ads/doubleclick/PublisherAdRequest.Builder.html", type:"class", deprecated:"false" }, - { id:29, label:"com.google.android.gms.ads.doubleclick.PublisherAdView", link:"reference/com/google/android/gms/ads/doubleclick/PublisherAdView.html", type:"class", deprecated:"false" }, - { id:30, label:"com.google.android.gms.ads.doubleclick.PublisherInterstitialAd", link:"reference/com/google/android/gms/ads/doubleclick/PublisherInterstitialAd.html", type:"class", deprecated:"false" }, - { id:31, label:"com.google.android.gms.ads.identifier", link:"reference/com/google/android/gms/ads/identifier/package-summary.html", type:"package", deprecated:"false" }, - { id:32, label:"com.google.android.gms.ads.identifier.AdvertisingIdClient", link:"reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.html", type:"class", deprecated:"false" }, - { id:33, label:"com.google.android.gms.ads.identifier.AdvertisingIdClient.Info", link:"reference/com/google/android/gms/ads/identifier/AdvertisingIdClient.Info.html", type:"class", deprecated:"false" }, - { id:34, label:"com.google.android.gms.ads.mediation", link:"reference/com/google/android/gms/ads/mediation/package-summary.html", type:"package", deprecated:"false" }, - { id:35, label:"com.google.android.gms.ads.mediation.MediationAdRequest", link:"reference/com/google/android/gms/ads/mediation/MediationAdRequest.html", type:"class", deprecated:"false" }, - { id:36, label:"com.google.android.gms.ads.mediation.MediationAdapter", link:"reference/com/google/android/gms/ads/mediation/MediationAdapter.html", type:"class", deprecated:"false" }, - { id:37, label:"com.google.android.gms.ads.mediation.MediationBannerAdapter", link:"reference/com/google/android/gms/ads/mediation/MediationBannerAdapter.html", type:"class", deprecated:"false" }, - { id:38, label:"com.google.android.gms.ads.mediation.MediationBannerListener", link:"reference/com/google/android/gms/ads/mediation/MediationBannerListener.html", type:"class", deprecated:"false" }, - { id:39, label:"com.google.android.gms.ads.mediation.MediationInterstitialAdapter", link:"reference/com/google/android/gms/ads/mediation/MediationInterstitialAdapter.html", type:"class", deprecated:"false" }, - { id:40, label:"com.google.android.gms.ads.mediation.MediationInterstitialListener", link:"reference/com/google/android/gms/ads/mediation/MediationInterstitialListener.html", type:"class", deprecated:"false" }, - { id:41, label:"com.google.android.gms.ads.mediation.NetworkExtras", link:"reference/com/google/android/gms/ads/mediation/NetworkExtras.html", type:"class", deprecated:"true" }, - { id:42, label:"com.google.android.gms.ads.mediation.admob", link:"reference/com/google/android/gms/ads/mediation/admob/package-summary.html", type:"package", deprecated:"false" }, - { id:43, label:"com.google.android.gms.ads.mediation.admob.AdMobExtras", link:"reference/com/google/android/gms/ads/mediation/admob/AdMobExtras.html", type:"class", deprecated:"true" }, - { id:44, label:"com.google.android.gms.ads.mediation.customevent", link:"reference/com/google/android/gms/ads/mediation/customevent/package-summary.html", type:"package", deprecated:"false" }, - { id:45, label:"com.google.android.gms.ads.mediation.customevent.CustomEvent", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEvent.html", type:"class", deprecated:"false" }, - { id:46, label:"com.google.android.gms.ads.mediation.customevent.CustomEventBanner", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventBanner.html", type:"class", deprecated:"false" }, - { id:47, label:"com.google.android.gms.ads.mediation.customevent.CustomEventBannerListener", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventBannerListener.html", type:"class", deprecated:"false" }, - { id:48, label:"com.google.android.gms.ads.mediation.customevent.CustomEventExtras", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventExtras.html", type:"class", deprecated:"true" }, - { id:49, label:"com.google.android.gms.ads.mediation.customevent.CustomEventInterstitial", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitial.html", type:"class", deprecated:"false" }, - { id:50, label:"com.google.android.gms.ads.mediation.customevent.CustomEventInterstitialListener", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventInterstitialListener.html", type:"class", deprecated:"false" }, - { id:51, label:"com.google.android.gms.ads.mediation.customevent.CustomEventListener", link:"reference/com/google/android/gms/ads/mediation/customevent/CustomEventListener.html", type:"class", deprecated:"false" }, - { id:52, label:"com.google.android.gms.ads.purchase", link:"reference/com/google/android/gms/ads/purchase/package-summary.html", type:"package", deprecated:"false" }, - { id:53, label:"com.google.android.gms.ads.purchase.InAppPurchase", link:"reference/com/google/android/gms/ads/purchase/InAppPurchase.html", type:"class", deprecated:"false" }, - { id:54, label:"com.google.android.gms.ads.purchase.InAppPurchaseListener", link:"reference/com/google/android/gms/ads/purchase/InAppPurchaseListener.html", type:"class", deprecated:"false" }, - { id:55, label:"com.google.android.gms.ads.purchase.InAppPurchaseResult", link:"reference/com/google/android/gms/ads/purchase/InAppPurchaseResult.html", type:"class", deprecated:"false" }, - { id:56, label:"com.google.android.gms.ads.purchase.PlayStorePurchaseListener", link:"reference/com/google/android/gms/ads/purchase/PlayStorePurchaseListener.html", type:"class", deprecated:"false" }, - { id:57, label:"com.google.android.gms.ads.search", link:"reference/com/google/android/gms/ads/search/package-summary.html", type:"package", deprecated:"false" }, - { id:58, label:"com.google.android.gms.ads.search.SearchAdRequest", link:"reference/com/google/android/gms/ads/search/SearchAdRequest.html", type:"class", deprecated:"false" }, - { id:59, label:"com.google.android.gms.ads.search.SearchAdRequest.Builder", link:"reference/com/google/android/gms/ads/search/SearchAdRequest.Builder.html", type:"class", deprecated:"false" }, - { id:60, label:"com.google.android.gms.ads.search.SearchAdView", link:"reference/com/google/android/gms/ads/search/SearchAdView.html", type:"class", deprecated:"false" }, - { id:61, label:"com.google.android.gms.analytics", link:"reference/com/google/android/gms/analytics/package-summary.html", type:"package", deprecated:"false" }, - { id:62, label:"com.google.android.gms.analytics.AnalyticsReceiver", link:"reference/com/google/android/gms/analytics/AnalyticsReceiver.html", type:"class", deprecated:"false" }, - { id:63, label:"com.google.android.gms.analytics.AnalyticsService", link:"reference/com/google/android/gms/analytics/AnalyticsService.html", type:"class", deprecated:"false" }, - { id:64, label:"com.google.android.gms.analytics.CampaignTrackingReceiver", link:"reference/com/google/android/gms/analytics/CampaignTrackingReceiver.html", type:"class", deprecated:"false" }, - { id:65, label:"com.google.android.gms.analytics.CampaignTrackingService", link:"reference/com/google/android/gms/analytics/CampaignTrackingService.html", type:"class", deprecated:"false" }, - { id:66, label:"com.google.android.gms.analytics.ExceptionParser", link:"reference/com/google/android/gms/analytics/ExceptionParser.html", type:"class", deprecated:"false" }, - { id:67, label:"com.google.android.gms.analytics.ExceptionReporter", link:"reference/com/google/android/gms/analytics/ExceptionReporter.html", type:"class", deprecated:"false" }, - { id:68, label:"com.google.android.gms.analytics.GoogleAnalytics", link:"reference/com/google/android/gms/analytics/GoogleAnalytics.html", type:"class", deprecated:"false" }, - { id:69, label:"com.google.android.gms.analytics.HitBuilders", link:"reference/com/google/android/gms/analytics/HitBuilders.html", type:"class", deprecated:"false" }, - { id:70, label:"com.google.android.gms.analytics.HitBuilders.AppViewBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.AppViewBuilder.html", type:"class", deprecated:"true" }, - { id:71, label:"com.google.android.gms.analytics.HitBuilders.EventBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.EventBuilder.html", type:"class", deprecated:"false" }, - { id:72, label:"com.google.android.gms.analytics.HitBuilders.ExceptionBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.ExceptionBuilder.html", type:"class", deprecated:"false" }, - { id:73, label:"com.google.android.gms.analytics.HitBuilders.HitBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.HitBuilder.html", type:"class", deprecated:"false" }, - { id:74, label:"com.google.android.gms.analytics.HitBuilders.ItemBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.ItemBuilder.html", type:"class", deprecated:"true" }, - { id:75, label:"com.google.android.gms.analytics.HitBuilders.ScreenViewBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.ScreenViewBuilder.html", type:"class", deprecated:"false" }, - { id:76, label:"com.google.android.gms.analytics.HitBuilders.SocialBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.SocialBuilder.html", type:"class", deprecated:"false" }, - { id:77, label:"com.google.android.gms.analytics.HitBuilders.TimingBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.TimingBuilder.html", type:"class", deprecated:"false" }, - { id:78, label:"com.google.android.gms.analytics.HitBuilders.TransactionBuilder", link:"reference/com/google/android/gms/analytics/HitBuilders.TransactionBuilder.html", type:"class", deprecated:"true" }, - { id:79, label:"com.google.android.gms.analytics.Logger", link:"reference/com/google/android/gms/analytics/Logger.html", type:"class", deprecated:"true" }, - { id:80, label:"com.google.android.gms.analytics.Logger.LogLevel", link:"reference/com/google/android/gms/analytics/Logger.LogLevel.html", type:"class", deprecated:"true" }, - { id:81, label:"com.google.android.gms.analytics.StandardExceptionParser", link:"reference/com/google/android/gms/analytics/StandardExceptionParser.html", type:"class", deprecated:"false" }, - { id:82, label:"com.google.android.gms.analytics.Tracker", link:"reference/com/google/android/gms/analytics/Tracker.html", type:"class", deprecated:"false" }, - { id:83, label:"com.google.android.gms.analytics.ecommerce", link:"reference/com/google/android/gms/analytics/ecommerce/package-summary.html", type:"package", deprecated:"false" }, - { id:84, label:"com.google.android.gms.analytics.ecommerce.Product", link:"reference/com/google/android/gms/analytics/ecommerce/Product.html", type:"class", deprecated:"false" }, - { id:85, label:"com.google.android.gms.analytics.ecommerce.ProductAction", link:"reference/com/google/android/gms/analytics/ecommerce/ProductAction.html", type:"class", deprecated:"false" }, - { id:86, label:"com.google.android.gms.analytics.ecommerce.Promotion", link:"reference/com/google/android/gms/analytics/ecommerce/Promotion.html", type:"class", deprecated:"false" }, - { id:87, label:"com.google.android.gms.appindexing", link:"reference/com/google/android/gms/appindexing/package-summary.html", type:"package", deprecated:"false" }, - { id:88, label:"com.google.android.gms.appindexing.Action", link:"reference/com/google/android/gms/appindexing/Action.html", type:"class", deprecated:"false" }, - { id:89, label:"com.google.android.gms.appindexing.Action.Builder", link:"reference/com/google/android/gms/appindexing/Action.Builder.html", type:"class", deprecated:"false" }, - { id:90, label:"com.google.android.gms.appindexing.AndroidAppUri", link:"reference/com/google/android/gms/appindexing/AndroidAppUri.html", type:"class", deprecated:"false" }, - { id:91, label:"com.google.android.gms.appindexing.AppIndex", link:"reference/com/google/android/gms/appindexing/AppIndex.html", type:"class", deprecated:"false" }, - { id:92, label:"com.google.android.gms.appindexing.AppIndexApi", link:"reference/com/google/android/gms/appindexing/AppIndexApi.html", type:"class", deprecated:"false" }, - { id:93, label:"com.google.android.gms.appindexing.AppIndexApi.ActionResult", link:"reference/com/google/android/gms/appindexing/AppIndexApi.ActionResult.html", type:"class", deprecated:"true" }, - { id:94, label:"com.google.android.gms.appindexing.AppIndexApi.AppIndexingLink", link:"reference/com/google/android/gms/appindexing/AppIndexApi.AppIndexingLink.html", type:"class", deprecated:"true" }, - { id:95, label:"com.google.android.gms.appindexing.Thing", link:"reference/com/google/android/gms/appindexing/Thing.html", type:"class", deprecated:"false" }, - { id:96, label:"com.google.android.gms.appindexing.Thing.Builder", link:"reference/com/google/android/gms/appindexing/Thing.Builder.html", type:"class", deprecated:"false" }, - { id:97, label:"com.google.android.gms.appstate", link:"reference/com/google/android/gms/appstate/package-summary.html", type:"package", deprecated:"false" }, - { id:98, label:"com.google.android.gms.appstate.AppState", link:"reference/com/google/android/gms/appstate/AppState.html", type:"class", deprecated:"true" }, - { id:99, label:"com.google.android.gms.appstate.AppStateBuffer", link:"reference/com/google/android/gms/appstate/AppStateBuffer.html", type:"class", deprecated:"false" }, - { id:100, label:"com.google.android.gms.appstate.AppStateManager", link:"reference/com/google/android/gms/appstate/AppStateManager.html", type:"class", deprecated:"true" }, - { id:101, label:"com.google.android.gms.appstate.AppStateManager.StateConflictResult", link:"reference/com/google/android/gms/appstate/AppStateManager.StateConflictResult.html", type:"class", deprecated:"false" }, - { id:102, label:"com.google.android.gms.appstate.AppStateManager.StateDeletedResult", link:"reference/com/google/android/gms/appstate/AppStateManager.StateDeletedResult.html", type:"class", deprecated:"false" }, - { id:103, label:"com.google.android.gms.appstate.AppStateManager.StateListResult", link:"reference/com/google/android/gms/appstate/AppStateManager.StateListResult.html", type:"class", deprecated:"false" }, - { id:104, label:"com.google.android.gms.appstate.AppStateManager.StateLoadedResult", link:"reference/com/google/android/gms/appstate/AppStateManager.StateLoadedResult.html", type:"class", deprecated:"false" }, - { id:105, label:"com.google.android.gms.appstate.AppStateManager.StateResult", link:"reference/com/google/android/gms/appstate/AppStateManager.StateResult.html", type:"class", deprecated:"false" }, - { id:106, label:"com.google.android.gms.appstate.AppStateStatusCodes", link:"reference/com/google/android/gms/appstate/AppStateStatusCodes.html", type:"class", deprecated:"false" }, - { id:107, label:"com.google.android.gms.auth", link:"reference/com/google/android/gms/auth/package-summary.html", type:"package", deprecated:"false" }, - { id:108, label:"com.google.android.gms.auth.AccountChangeEvent", link:"reference/com/google/android/gms/auth/AccountChangeEvent.html", type:"class", deprecated:"false" }, - { id:109, label:"com.google.android.gms.auth.AccountChangeEventsRequest", link:"reference/com/google/android/gms/auth/AccountChangeEventsRequest.html", type:"class", deprecated:"false" }, - { id:110, label:"com.google.android.gms.auth.AccountChangeEventsResponse", link:"reference/com/google/android/gms/auth/AccountChangeEventsResponse.html", type:"class", deprecated:"false" }, - { id:111, label:"com.google.android.gms.auth.GoogleAuthException", link:"reference/com/google/android/gms/auth/GoogleAuthException.html", type:"class", deprecated:"false" }, - { id:112, label:"com.google.android.gms.auth.GoogleAuthUtil", link:"reference/com/google/android/gms/auth/GoogleAuthUtil.html", type:"class", deprecated:"false" }, - { id:113, label:"com.google.android.gms.auth.GooglePlayServicesAvailabilityException", link:"reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html", type:"class", deprecated:"false" }, - { id:114, label:"com.google.android.gms.auth.UserRecoverableAuthException", link:"reference/com/google/android/gms/auth/UserRecoverableAuthException.html", type:"class", deprecated:"false" }, - { id:115, label:"com.google.android.gms.auth.UserRecoverableNotifiedException", link:"reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html", type:"class", deprecated:"false" }, - { id:116, label:"com.google.android.gms.cast", link:"reference/com/google/android/gms/cast/package-summary.html", type:"package", deprecated:"false" }, - { id:117, label:"com.google.android.gms.cast.ApplicationMetadata", link:"reference/com/google/android/gms/cast/ApplicationMetadata.html", type:"class", deprecated:"false" }, - { id:118, label:"com.google.android.gms.cast.Cast", link:"reference/com/google/android/gms/cast/Cast.html", type:"class", deprecated:"false" }, - { id:119, label:"com.google.android.gms.cast.Cast.ApplicationConnectionResult", link:"reference/com/google/android/gms/cast/Cast.ApplicationConnectionResult.html", type:"class", deprecated:"false" }, - { id:120, label:"com.google.android.gms.cast.Cast.CastApi", link:"reference/com/google/android/gms/cast/Cast.CastApi.html", type:"class", deprecated:"false" }, - { id:121, label:"com.google.android.gms.cast.Cast.CastOptions", link:"reference/com/google/android/gms/cast/Cast.CastOptions.html", type:"class", deprecated:"false" }, - { id:122, label:"com.google.android.gms.cast.Cast.CastOptions.Builder", link:"reference/com/google/android/gms/cast/Cast.CastOptions.Builder.html", type:"class", deprecated:"false" }, - { id:123, label:"com.google.android.gms.cast.Cast.Listener", link:"reference/com/google/android/gms/cast/Cast.Listener.html", type:"class", deprecated:"false" }, - { id:124, label:"com.google.android.gms.cast.Cast.MessageReceivedCallback", link:"reference/com/google/android/gms/cast/Cast.MessageReceivedCallback.html", type:"class", deprecated:"false" }, - { id:125, label:"com.google.android.gms.cast.CastDevice", link:"reference/com/google/android/gms/cast/CastDevice.html", type:"class", deprecated:"false" }, - { id:126, label:"com.google.android.gms.cast.CastMediaControlIntent", link:"reference/com/google/android/gms/cast/CastMediaControlIntent.html", type:"class", deprecated:"false" }, - { id:127, label:"com.google.android.gms.cast.CastStatusCodes", link:"reference/com/google/android/gms/cast/CastStatusCodes.html", type:"class", deprecated:"false" }, - { id:128, label:"com.google.android.gms.cast.LaunchOptions", link:"reference/com/google/android/gms/cast/LaunchOptions.html", type:"class", deprecated:"false" }, - { id:129, label:"com.google.android.gms.cast.LaunchOptions.Builder", link:"reference/com/google/android/gms/cast/LaunchOptions.Builder.html", type:"class", deprecated:"false" }, - { id:130, label:"com.google.android.gms.cast.MediaInfo", link:"reference/com/google/android/gms/cast/MediaInfo.html", type:"class", deprecated:"false" }, - { id:131, label:"com.google.android.gms.cast.MediaInfo.Builder", link:"reference/com/google/android/gms/cast/MediaInfo.Builder.html", type:"class", deprecated:"false" }, - { id:132, label:"com.google.android.gms.cast.MediaMetadata", link:"reference/com/google/android/gms/cast/MediaMetadata.html", type:"class", deprecated:"false" }, - { id:133, label:"com.google.android.gms.cast.MediaStatus", link:"reference/com/google/android/gms/cast/MediaStatus.html", type:"class", deprecated:"false" }, - { id:134, label:"com.google.android.gms.cast.MediaTrack", link:"reference/com/google/android/gms/cast/MediaTrack.html", type:"class", deprecated:"false" }, - { id:135, label:"com.google.android.gms.cast.MediaTrack.Builder", link:"reference/com/google/android/gms/cast/MediaTrack.Builder.html", type:"class", deprecated:"false" }, - { id:136, label:"com.google.android.gms.cast.RemoteMediaPlayer", link:"reference/com/google/android/gms/cast/RemoteMediaPlayer.html", type:"class", deprecated:"false" }, - { id:137, label:"com.google.android.gms.cast.RemoteMediaPlayer.MediaChannelResult", link:"reference/com/google/android/gms/cast/RemoteMediaPlayer.MediaChannelResult.html", type:"class", deprecated:"false" }, - { id:138, label:"com.google.android.gms.cast.RemoteMediaPlayer.OnMetadataUpdatedListener", link:"reference/com/google/android/gms/cast/RemoteMediaPlayer.OnMetadataUpdatedListener.html", type:"class", deprecated:"false" }, - { id:139, label:"com.google.android.gms.cast.RemoteMediaPlayer.OnStatusUpdatedListener", link:"reference/com/google/android/gms/cast/RemoteMediaPlayer.OnStatusUpdatedListener.html", type:"class", deprecated:"false" }, - { id:140, label:"com.google.android.gms.cast.TextTrackStyle", link:"reference/com/google/android/gms/cast/TextTrackStyle.html", type:"class", deprecated:"false" }, - { id:141, label:"com.google.android.gms.common", link:"reference/com/google/android/gms/common/package-summary.html", type:"package", deprecated:"false" }, - { id:142, label:"com.google.android.gms.common.AccountPicker", link:"reference/com/google/android/gms/common/AccountPicker.html", type:"class", deprecated:"false" }, - { id:143, label:"com.google.android.gms.common.ConnectionResult", link:"reference/com/google/android/gms/common/ConnectionResult.html", type:"class", deprecated:"false" }, - { id:144, label:"com.google.android.gms.common.ErrorDialogFragment", link:"reference/com/google/android/gms/common/ErrorDialogFragment.html", type:"class", deprecated:"false" }, - { id:145, label:"com.google.android.gms.common.GoogleApiAvailability", link:"reference/com/google/android/gms/common/GoogleApiAvailability.html", type:"class", deprecated:"false" }, - { id:146, label:"com.google.android.gms.common.GooglePlayServicesNotAvailableException", link:"reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html", type:"class", deprecated:"false" }, - { id:147, label:"com.google.android.gms.common.GooglePlayServicesRepairableException", link:"reference/com/google/android/gms/common/GooglePlayServicesRepairableException.html", type:"class", deprecated:"false" }, - { id:148, label:"com.google.android.gms.common.GooglePlayServicesUtil", link:"reference/com/google/android/gms/common/GooglePlayServicesUtil.html", type:"class", deprecated:"false" }, - { id:149, label:"com.google.android.gms.common.Scopes", link:"reference/com/google/android/gms/common/Scopes.html", type:"class", deprecated:"false" }, - { id:150, label:"com.google.android.gms.common.SignInButton", link:"reference/com/google/android/gms/common/SignInButton.html", type:"class", deprecated:"false" }, - { id:151, label:"com.google.android.gms.common.SupportErrorDialogFragment", link:"reference/com/google/android/gms/common/SupportErrorDialogFragment.html", type:"class", deprecated:"false" }, - { id:152, label:"com.google.android.gms.common.UserRecoverableException", link:"reference/com/google/android/gms/common/UserRecoverableException.html", type:"class", deprecated:"false" }, - { id:153, label:"com.google.android.gms.common.annotation", link:"reference/com/google/android/gms/common/annotation/package-summary.html", type:"package", deprecated:"false" }, - { id:154, label:"com.google.android.gms.common.annotation.KeepName", link:"reference/com/google/android/gms/common/annotation/KeepName.html", type:"class", deprecated:"false" }, - { id:155, label:"com.google.android.gms.common.api", link:"reference/com/google/android/gms/common/api/package-summary.html", type:"package", deprecated:"false" }, - { id:156, label:"com.google.android.gms.common.api.Api", link:"reference/com/google/android/gms/common/api/Api.html", type:"class", deprecated:"false" }, - { id:157, label:"com.google.android.gms.common.api.Api.ApiOptions", link:"reference/com/google/android/gms/common/api/Api.ApiOptions.html", type:"class", deprecated:"false" }, - { id:158, label:"com.google.android.gms.common.api.Api.ApiOptions.HasOptions", link:"reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions.html", type:"class", deprecated:"false" }, - { id:159, label:"com.google.android.gms.common.api.Api.ApiOptions.NoOptions", link:"reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions.html", type:"class", deprecated:"false" }, - { id:160, label:"com.google.android.gms.common.api.Api.ApiOptions.NotRequiredOptions", link:"reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions.html", type:"class", deprecated:"false" }, - { id:161, label:"com.google.android.gms.common.api.Api.ApiOptions.Optional", link:"reference/com/google/android/gms/common/api/Api.ApiOptions.Optional.html", type:"class", deprecated:"false" }, - { id:162, label:"com.google.android.gms.common.api.Batch", link:"reference/com/google/android/gms/common/api/Batch.html", type:"class", deprecated:"false" }, - { id:163, label:"com.google.android.gms.common.api.Batch.Builder", link:"reference/com/google/android/gms/common/api/Batch.Builder.html", type:"class", deprecated:"false" }, - { id:164, label:"com.google.android.gms.common.api.BatchResult", link:"reference/com/google/android/gms/common/api/BatchResult.html", type:"class", deprecated:"false" }, - { id:165, label:"com.google.android.gms.common.api.BatchResultToken", link:"reference/com/google/android/gms/common/api/BatchResultToken.html", type:"class", deprecated:"false" }, - { id:166, label:"com.google.android.gms.common.api.CommonStatusCodes", link:"reference/com/google/android/gms/common/api/CommonStatusCodes.html", type:"class", deprecated:"false" }, - { id:167, label:"com.google.android.gms.common.api.GoogleApiClient", link:"reference/com/google/android/gms/common/api/GoogleApiClient.html", type:"class", deprecated:"false" }, - { id:168, label:"com.google.android.gms.common.api.GoogleApiClient.Builder", link:"reference/com/google/android/gms/common/api/GoogleApiClient.Builder.html", type:"class", deprecated:"false" }, - { id:169, label:"com.google.android.gms.common.api.GoogleApiClient.ConnectionCallbacks", link:"reference/com/google/android/gms/common/api/GoogleApiClient.ConnectionCallbacks.html", type:"class", deprecated:"false" }, - { id:170, label:"com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener", link:"reference/com/google/android/gms/common/api/GoogleApiClient.OnConnectionFailedListener.html", type:"class", deprecated:"false" }, - { id:171, label:"com.google.android.gms.common.api.GoogleApiClient.ServerAuthCodeCallbacks", link:"reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.html", type:"class", deprecated:"false" }, - { id:172, label:"com.google.android.gms.common.api.GoogleApiClient.ServerAuthCodeCallbacks.CheckResult", link:"reference/com/google/android/gms/common/api/GoogleApiClient.ServerAuthCodeCallbacks.CheckResult.html", type:"class", deprecated:"false" }, - { id:173, label:"com.google.android.gms.common.api.PendingResult", link:"reference/com/google/android/gms/common/api/PendingResult.html", type:"class", deprecated:"false" }, - { id:174, label:"com.google.android.gms.common.api.PendingResults", link:"reference/com/google/android/gms/common/api/PendingResults.html", type:"class", deprecated:"false" }, - { id:175, label:"com.google.android.gms.common.api.Releasable", link:"reference/com/google/android/gms/common/api/Releasable.html", type:"class", deprecated:"false" }, - { id:176, label:"com.google.android.gms.common.api.Result", link:"reference/com/google/android/gms/common/api/Result.html", type:"class", deprecated:"false" }, - { id:177, label:"com.google.android.gms.common.api.ResultCallback", link:"reference/com/google/android/gms/common/api/ResultCallback.html", type:"class", deprecated:"false" }, - { id:178, label:"com.google.android.gms.common.api.Scope", link:"reference/com/google/android/gms/common/api/Scope.html", type:"class", deprecated:"false" }, - { id:179, label:"com.google.android.gms.common.api.Status", link:"reference/com/google/android/gms/common/api/Status.html", type:"class", deprecated:"false" }, - { id:180, label:"com.google.android.gms.common.data", link:"reference/com/google/android/gms/common/data/package-summary.html", type:"package", deprecated:"false" }, - { id:181, label:"com.google.android.gms.common.data.AbstractDataBuffer", link:"reference/com/google/android/gms/common/data/AbstractDataBuffer.html", type:"class", deprecated:"false" }, - { id:182, label:"com.google.android.gms.common.data.DataBuffer", link:"reference/com/google/android/gms/common/data/DataBuffer.html", type:"class", deprecated:"false" }, - { id:183, label:"com.google.android.gms.common.data.DataBufferObserver", link:"reference/com/google/android/gms/common/data/DataBufferObserver.html", type:"class", deprecated:"false" }, - { id:184, label:"com.google.android.gms.common.data.DataBufferObserver.Observable", link:"reference/com/google/android/gms/common/data/DataBufferObserver.Observable.html", type:"class", deprecated:"false" }, - { id:185, label:"com.google.android.gms.common.data.DataBufferObserverSet", link:"reference/com/google/android/gms/common/data/DataBufferObserverSet.html", type:"class", deprecated:"false" }, - { id:186, label:"com.google.android.gms.common.data.DataBufferUtils", link:"reference/com/google/android/gms/common/data/DataBufferUtils.html", type:"class", deprecated:"false" }, - { id:187, label:"com.google.android.gms.common.data.Freezable", link:"reference/com/google/android/gms/common/data/Freezable.html", type:"class", deprecated:"false" }, - { id:188, label:"com.google.android.gms.common.data.FreezableUtils", link:"reference/com/google/android/gms/common/data/FreezableUtils.html", type:"class", deprecated:"false" }, - { id:189, label:"com.google.android.gms.common.images", link:"reference/com/google/android/gms/common/images/package-summary.html", type:"package", deprecated:"false" }, - { id:190, label:"com.google.android.gms.common.images.ImageManager", link:"reference/com/google/android/gms/common/images/ImageManager.html", type:"class", deprecated:"false" }, - { id:191, label:"com.google.android.gms.common.images.ImageManager.OnImageLoadedListener", link:"reference/com/google/android/gms/common/images/ImageManager.OnImageLoadedListener.html", type:"class", deprecated:"false" }, - { id:192, label:"com.google.android.gms.common.images.WebImage", link:"reference/com/google/android/gms/common/images/WebImage.html", type:"class", deprecated:"false" }, - { id:193, label:"com.google.android.gms.drive", link:"reference/com/google/android/gms/drive/package-summary.html", type:"package", deprecated:"false" }, - { id:194, label:"com.google.android.gms.drive.CreateFileActivityBuilder", link:"reference/com/google/android/gms/drive/CreateFileActivityBuilder.html", type:"class", deprecated:"false" }, - { id:195, label:"com.google.android.gms.drive.Drive", link:"reference/com/google/android/gms/drive/Drive.html", type:"class", deprecated:"false" }, - { id:196, label:"com.google.android.gms.drive.DriveApi", link:"reference/com/google/android/gms/drive/DriveApi.html", type:"class", deprecated:"false" }, - { id:197, label:"com.google.android.gms.drive.DriveApi.DriveContentsResult", link:"reference/com/google/android/gms/drive/DriveApi.DriveContentsResult.html", type:"class", deprecated:"false" }, - { id:198, label:"com.google.android.gms.drive.DriveApi.DriveIdResult", link:"reference/com/google/android/gms/drive/DriveApi.DriveIdResult.html", type:"class", deprecated:"false" }, - { id:199, label:"com.google.android.gms.drive.DriveApi.MetadataBufferResult", link:"reference/com/google/android/gms/drive/DriveApi.MetadataBufferResult.html", type:"class", deprecated:"false" }, - { id:200, label:"com.google.android.gms.drive.DriveContents", link:"reference/com/google/android/gms/drive/DriveContents.html", type:"class", deprecated:"false" }, - { id:201, label:"com.google.android.gms.drive.DriveFile", link:"reference/com/google/android/gms/drive/DriveFile.html", type:"class", deprecated:"false" }, - { id:202, label:"com.google.android.gms.drive.DriveFile.DownloadProgressListener", link:"reference/com/google/android/gms/drive/DriveFile.DownloadProgressListener.html", type:"class", deprecated:"false" }, - { id:203, label:"com.google.android.gms.drive.DriveFolder", link:"reference/com/google/android/gms/drive/DriveFolder.html", type:"class", deprecated:"false" }, - { id:204, label:"com.google.android.gms.drive.DriveFolder.DriveFileResult", link:"reference/com/google/android/gms/drive/DriveFolder.DriveFileResult.html", type:"class", deprecated:"false" }, - { id:205, label:"com.google.android.gms.drive.DriveFolder.DriveFolderResult", link:"reference/com/google/android/gms/drive/DriveFolder.DriveFolderResult.html", type:"class", deprecated:"false" }, - { id:206, label:"com.google.android.gms.drive.DriveId", link:"reference/com/google/android/gms/drive/DriveId.html", type:"class", deprecated:"false" }, - { id:207, label:"com.google.android.gms.drive.DrivePreferencesApi", link:"reference/com/google/android/gms/drive/DrivePreferencesApi.html", type:"class", deprecated:"false" }, - { id:208, label:"com.google.android.gms.drive.DrivePreferencesApi.FileUploadPreferencesResult", link:"reference/com/google/android/gms/drive/DrivePreferencesApi.FileUploadPreferencesResult.html", type:"class", deprecated:"false" }, - { id:209, label:"com.google.android.gms.drive.DriveResource", link:"reference/com/google/android/gms/drive/DriveResource.html", type:"class", deprecated:"false" }, - { id:210, label:"com.google.android.gms.drive.DriveResource.MetadataResult", link:"reference/com/google/android/gms/drive/DriveResource.MetadataResult.html", type:"class", deprecated:"false" }, - { id:211, label:"com.google.android.gms.drive.DriveStatusCodes", link:"reference/com/google/android/gms/drive/DriveStatusCodes.html", type:"class", deprecated:"false" }, - { id:212, label:"com.google.android.gms.drive.ExecutionOptions", link:"reference/com/google/android/gms/drive/ExecutionOptions.html", type:"class", deprecated:"false" }, - { id:213, label:"com.google.android.gms.drive.ExecutionOptions.Builder", link:"reference/com/google/android/gms/drive/ExecutionOptions.Builder.html", type:"class", deprecated:"false" }, - { id:214, label:"com.google.android.gms.drive.FileUploadPreferences", link:"reference/com/google/android/gms/drive/FileUploadPreferences.html", type:"class", deprecated:"false" }, - { id:215, label:"com.google.android.gms.drive.Metadata", link:"reference/com/google/android/gms/drive/Metadata.html", type:"class", deprecated:"false" }, - { id:216, label:"com.google.android.gms.drive.MetadataBuffer", link:"reference/com/google/android/gms/drive/MetadataBuffer.html", type:"class", deprecated:"false" }, - { id:217, label:"com.google.android.gms.drive.MetadataChangeSet", link:"reference/com/google/android/gms/drive/MetadataChangeSet.html", type:"class", deprecated:"false" }, - { id:218, label:"com.google.android.gms.drive.MetadataChangeSet.Builder", link:"reference/com/google/android/gms/drive/MetadataChangeSet.Builder.html", type:"class", deprecated:"false" }, - { id:219, label:"com.google.android.gms.drive.OpenFileActivityBuilder", link:"reference/com/google/android/gms/drive/OpenFileActivityBuilder.html", type:"class", deprecated:"false" }, - { id:220, label:"com.google.android.gms.drive.events", link:"reference/com/google/android/gms/drive/events/package-summary.html", type:"package", deprecated:"false" }, - { id:221, label:"com.google.android.gms.drive.events.ChangeEvent", link:"reference/com/google/android/gms/drive/events/ChangeEvent.html", type:"class", deprecated:"false" }, - { id:222, label:"com.google.android.gms.drive.events.ChangeListener", link:"reference/com/google/android/gms/drive/events/ChangeListener.html", type:"class", deprecated:"false" }, - { id:223, label:"com.google.android.gms.drive.events.CompletionEvent", link:"reference/com/google/android/gms/drive/events/CompletionEvent.html", type:"class", deprecated:"false" }, - { id:224, label:"com.google.android.gms.drive.events.CompletionListener", link:"reference/com/google/android/gms/drive/events/CompletionListener.html", type:"class", deprecated:"false" }, - { id:225, label:"com.google.android.gms.drive.events.DriveEvent", link:"reference/com/google/android/gms/drive/events/DriveEvent.html", type:"class", deprecated:"false" }, - { id:226, label:"com.google.android.gms.drive.events.DriveEventService", link:"reference/com/google/android/gms/drive/events/DriveEventService.html", type:"class", deprecated:"false" }, - { id:227, label:"com.google.android.gms.drive.events.ResourceEvent", link:"reference/com/google/android/gms/drive/events/ResourceEvent.html", type:"class", deprecated:"false" }, - { id:228, label:"com.google.android.gms.drive.metadata", link:"reference/com/google/android/gms/drive/metadata/package-summary.html", type:"package", deprecated:"false" }, - { id:229, label:"com.google.android.gms.drive.metadata.CustomPropertyKey", link:"reference/com/google/android/gms/drive/metadata/CustomPropertyKey.html", type:"class", deprecated:"false" }, - { id:230, label:"com.google.android.gms.drive.metadata.MetadataField", link:"reference/com/google/android/gms/drive/metadata/MetadataField.html", type:"class", deprecated:"false" }, - { id:231, label:"com.google.android.gms.drive.metadata.SearchableCollectionMetadataField", link:"reference/com/google/android/gms/drive/metadata/SearchableCollectionMetadataField.html", type:"class", deprecated:"false" }, - { id:232, label:"com.google.android.gms.drive.metadata.SearchableMetadataField", link:"reference/com/google/android/gms/drive/metadata/SearchableMetadataField.html", type:"class", deprecated:"false" }, - { id:233, label:"com.google.android.gms.drive.metadata.SearchableOrderedMetadataField", link:"reference/com/google/android/gms/drive/metadata/SearchableOrderedMetadataField.html", type:"class", deprecated:"false" }, - { id:234, label:"com.google.android.gms.drive.metadata.SortableMetadataField", link:"reference/com/google/android/gms/drive/metadata/SortableMetadataField.html", type:"class", deprecated:"false" }, - { id:235, label:"com.google.android.gms.drive.query", link:"reference/com/google/android/gms/drive/query/package-summary.html", type:"package", deprecated:"false" }, - { id:236, label:"com.google.android.gms.drive.query.Filter", link:"reference/com/google/android/gms/drive/query/Filter.html", type:"class", deprecated:"false" }, - { id:237, label:"com.google.android.gms.drive.query.Filters", link:"reference/com/google/android/gms/drive/query/Filters.html", type:"class", deprecated:"false" }, - { id:238, label:"com.google.android.gms.drive.query.Query", link:"reference/com/google/android/gms/drive/query/Query.html", type:"class", deprecated:"false" }, - { id:239, label:"com.google.android.gms.drive.query.Query.Builder", link:"reference/com/google/android/gms/drive/query/Query.Builder.html", type:"class", deprecated:"false" }, - { id:240, label:"com.google.android.gms.drive.query.SearchableField", link:"reference/com/google/android/gms/drive/query/SearchableField.html", type:"class", deprecated:"false" }, - { id:241, label:"com.google.android.gms.drive.query.SortOrder", link:"reference/com/google/android/gms/drive/query/SortOrder.html", type:"class", deprecated:"false" }, - { id:242, label:"com.google.android.gms.drive.query.SortOrder.Builder", link:"reference/com/google/android/gms/drive/query/SortOrder.Builder.html", type:"class", deprecated:"false" }, - { id:243, label:"com.google.android.gms.drive.query.SortableField", link:"reference/com/google/android/gms/drive/query/SortableField.html", type:"class", deprecated:"false" }, - { id:244, label:"com.google.android.gms.drive.widget", link:"reference/com/google/android/gms/drive/widget/package-summary.html", type:"package", deprecated:"false" }, - { id:245, label:"com.google.android.gms.drive.widget.DataBufferAdapter", link:"reference/com/google/android/gms/drive/widget/DataBufferAdapter.html", type:"class", deprecated:"false" }, - { id:246, label:"com.google.android.gms.fitness", link:"reference/com/google/android/gms/fitness/package-summary.html", type:"package", deprecated:"false" }, - { id:247, label:"com.google.android.gms.fitness.BleApi", link:"reference/com/google/android/gms/fitness/BleApi.html", type:"class", deprecated:"false" }, - { id:248, label:"com.google.android.gms.fitness.ConfigApi", link:"reference/com/google/android/gms/fitness/ConfigApi.html", type:"class", deprecated:"false" }, - { id:249, label:"com.google.android.gms.fitness.Fitness", link:"reference/com/google/android/gms/fitness/Fitness.html", type:"class", deprecated:"false" }, - { id:250, label:"com.google.android.gms.fitness.FitnessActivities", link:"reference/com/google/android/gms/fitness/FitnessActivities.html", type:"class", deprecated:"false" }, - { id:251, label:"com.google.android.gms.fitness.FitnessStatusCodes", link:"reference/com/google/android/gms/fitness/FitnessStatusCodes.html", type:"class", deprecated:"false" }, - { id:252, label:"com.google.android.gms.fitness.HistoryApi", link:"reference/com/google/android/gms/fitness/HistoryApi.html", type:"class", deprecated:"false" }, - { id:253, label:"com.google.android.gms.fitness.HistoryApi.ViewIntentBuilder", link:"reference/com/google/android/gms/fitness/HistoryApi.ViewIntentBuilder.html", type:"class", deprecated:"false" }, - { id:254, label:"com.google.android.gms.fitness.RecordingApi", link:"reference/com/google/android/gms/fitness/RecordingApi.html", type:"class", deprecated:"false" }, - { id:255, label:"com.google.android.gms.fitness.SensorsApi", link:"reference/com/google/android/gms/fitness/SensorsApi.html", type:"class", deprecated:"false" }, - { id:256, label:"com.google.android.gms.fitness.SessionsApi", link:"reference/com/google/android/gms/fitness/SessionsApi.html", type:"class", deprecated:"false" }, - { id:257, label:"com.google.android.gms.fitness.SessionsApi.ViewIntentBuilder", link:"reference/com/google/android/gms/fitness/SessionsApi.ViewIntentBuilder.html", type:"class", deprecated:"false" }, - { id:258, label:"com.google.android.gms.fitness.data", link:"reference/com/google/android/gms/fitness/data/package-summary.html", type:"package", deprecated:"false" }, - { id:259, label:"com.google.android.gms.fitness.data.BleDevice", link:"reference/com/google/android/gms/fitness/data/BleDevice.html", type:"class", deprecated:"false" }, - { id:260, label:"com.google.android.gms.fitness.data.Bucket", link:"reference/com/google/android/gms/fitness/data/Bucket.html", type:"class", deprecated:"false" }, - { id:261, label:"com.google.android.gms.fitness.data.DataPoint", link:"reference/com/google/android/gms/fitness/data/DataPoint.html", type:"class", deprecated:"false" }, - { id:262, label:"com.google.android.gms.fitness.data.DataSet", link:"reference/com/google/android/gms/fitness/data/DataSet.html", type:"class", deprecated:"false" }, - { id:263, label:"com.google.android.gms.fitness.data.DataSource", link:"reference/com/google/android/gms/fitness/data/DataSource.html", type:"class", deprecated:"false" }, - { id:264, label:"com.google.android.gms.fitness.data.DataSource.Builder", link:"reference/com/google/android/gms/fitness/data/DataSource.Builder.html", type:"class", deprecated:"false" }, - { id:265, label:"com.google.android.gms.fitness.data.DataType", link:"reference/com/google/android/gms/fitness/data/DataType.html", type:"class", deprecated:"false" }, - { id:266, label:"com.google.android.gms.fitness.data.Device", link:"reference/com/google/android/gms/fitness/data/Device.html", type:"class", deprecated:"false" }, - { id:267, label:"com.google.android.gms.fitness.data.Field", link:"reference/com/google/android/gms/fitness/data/Field.html", type:"class", deprecated:"false" }, - { id:268, label:"com.google.android.gms.fitness.data.Session", link:"reference/com/google/android/gms/fitness/data/Session.html", type:"class", deprecated:"false" }, - { id:269, label:"com.google.android.gms.fitness.data.Session.Builder", link:"reference/com/google/android/gms/fitness/data/Session.Builder.html", type:"class", deprecated:"false" }, - { id:270, label:"com.google.android.gms.fitness.data.Subscription", link:"reference/com/google/android/gms/fitness/data/Subscription.html", type:"class", deprecated:"false" }, - { id:271, label:"com.google.android.gms.fitness.data.Value", link:"reference/com/google/android/gms/fitness/data/Value.html", type:"class", deprecated:"false" }, - { id:272, label:"com.google.android.gms.fitness.request", link:"reference/com/google/android/gms/fitness/request/package-summary.html", type:"package", deprecated:"false" }, - { id:273, label:"com.google.android.gms.fitness.request.BleScanCallback", link:"reference/com/google/android/gms/fitness/request/BleScanCallback.html", type:"class", deprecated:"false" }, - { id:274, label:"com.google.android.gms.fitness.request.DataDeleteRequest", link:"reference/com/google/android/gms/fitness/request/DataDeleteRequest.html", type:"class", deprecated:"false" }, - { id:275, label:"com.google.android.gms.fitness.request.DataDeleteRequest.Builder", link:"reference/com/google/android/gms/fitness/request/DataDeleteRequest.Builder.html", type:"class", deprecated:"false" }, - { id:276, label:"com.google.android.gms.fitness.request.DataReadRequest", link:"reference/com/google/android/gms/fitness/request/DataReadRequest.html", type:"class", deprecated:"false" }, - { id:277, label:"com.google.android.gms.fitness.request.DataReadRequest.Builder", link:"reference/com/google/android/gms/fitness/request/DataReadRequest.Builder.html", type:"class", deprecated:"false" }, - { id:278, label:"com.google.android.gms.fitness.request.DataSourcesRequest", link:"reference/com/google/android/gms/fitness/request/DataSourcesRequest.html", type:"class", deprecated:"false" }, - { id:279, label:"com.google.android.gms.fitness.request.DataSourcesRequest.Builder", link:"reference/com/google/android/gms/fitness/request/DataSourcesRequest.Builder.html", type:"class", deprecated:"false" }, - { id:280, label:"com.google.android.gms.fitness.request.DataTypeCreateRequest", link:"reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.html", type:"class", deprecated:"false" }, - { id:281, label:"com.google.android.gms.fitness.request.DataTypeCreateRequest.Builder", link:"reference/com/google/android/gms/fitness/request/DataTypeCreateRequest.Builder.html", type:"class", deprecated:"false" }, - { id:282, label:"com.google.android.gms.fitness.request.OnDataPointListener", link:"reference/com/google/android/gms/fitness/request/OnDataPointListener.html", type:"class", deprecated:"false" }, - { id:283, label:"com.google.android.gms.fitness.request.SensorRequest", link:"reference/com/google/android/gms/fitness/request/SensorRequest.html", type:"class", deprecated:"false" }, - { id:284, label:"com.google.android.gms.fitness.request.SensorRequest.Builder", link:"reference/com/google/android/gms/fitness/request/SensorRequest.Builder.html", type:"class", deprecated:"false" }, - { id:285, label:"com.google.android.gms.fitness.request.SessionInsertRequest", link:"reference/com/google/android/gms/fitness/request/SessionInsertRequest.html", type:"class", deprecated:"false" }, - { id:286, label:"com.google.android.gms.fitness.request.SessionInsertRequest.Builder", link:"reference/com/google/android/gms/fitness/request/SessionInsertRequest.Builder.html", type:"class", deprecated:"false" }, - { id:287, label:"com.google.android.gms.fitness.request.SessionReadRequest", link:"reference/com/google/android/gms/fitness/request/SessionReadRequest.html", type:"class", deprecated:"false" }, - { id:288, label:"com.google.android.gms.fitness.request.SessionReadRequest.Builder", link:"reference/com/google/android/gms/fitness/request/SessionReadRequest.Builder.html", type:"class", deprecated:"false" }, - { id:289, label:"com.google.android.gms.fitness.request.StartBleScanRequest", link:"reference/com/google/android/gms/fitness/request/StartBleScanRequest.html", type:"class", deprecated:"false" }, - { id:290, label:"com.google.android.gms.fitness.request.StartBleScanRequest.Builder", link:"reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder.html", type:"class", deprecated:"false" }, - { id:291, label:"com.google.android.gms.fitness.result", link:"reference/com/google/android/gms/fitness/result/package-summary.html", type:"package", deprecated:"false" }, - { id:292, label:"com.google.android.gms.fitness.result.BleDevicesResult", link:"reference/com/google/android/gms/fitness/result/BleDevicesResult.html", type:"class", deprecated:"false" }, - { id:293, label:"com.google.android.gms.fitness.result.DailyTotalResult", link:"reference/com/google/android/gms/fitness/result/DailyTotalResult.html", type:"class", deprecated:"false" }, - { id:294, label:"com.google.android.gms.fitness.result.DataReadResult", link:"reference/com/google/android/gms/fitness/result/DataReadResult.html", type:"class", deprecated:"false" }, - { id:295, label:"com.google.android.gms.fitness.result.DataSourcesResult", link:"reference/com/google/android/gms/fitness/result/DataSourcesResult.html", type:"class", deprecated:"false" }, - { id:296, label:"com.google.android.gms.fitness.result.DataTypeResult", link:"reference/com/google/android/gms/fitness/result/DataTypeResult.html", type:"class", deprecated:"false" }, - { id:297, label:"com.google.android.gms.fitness.result.ListSubscriptionsResult", link:"reference/com/google/android/gms/fitness/result/ListSubscriptionsResult.html", type:"class", deprecated:"false" }, - { id:298, label:"com.google.android.gms.fitness.result.SessionReadResult", link:"reference/com/google/android/gms/fitness/result/SessionReadResult.html", type:"class", deprecated:"false" }, - { id:299, label:"com.google.android.gms.fitness.result.SessionStopResult", link:"reference/com/google/android/gms/fitness/result/SessionStopResult.html", type:"class", deprecated:"false" }, - { id:300, label:"com.google.android.gms.fitness.service", link:"reference/com/google/android/gms/fitness/service/package-summary.html", type:"package", deprecated:"false" }, - { id:301, label:"com.google.android.gms.fitness.service.FitnessSensorService", link:"reference/com/google/android/gms/fitness/service/FitnessSensorService.html", type:"class", deprecated:"false" }, - { id:302, label:"com.google.android.gms.fitness.service.FitnessSensorServiceRequest", link:"reference/com/google/android/gms/fitness/service/FitnessSensorServiceRequest.html", type:"class", deprecated:"false" }, - { id:303, label:"com.google.android.gms.fitness.service.SensorEventDispatcher", link:"reference/com/google/android/gms/fitness/service/SensorEventDispatcher.html", type:"class", deprecated:"false" }, - { id:304, label:"com.google.android.gms.games", link:"reference/com/google/android/gms/games/package-summary.html", type:"package", deprecated:"false" }, - { id:305, label:"com.google.android.gms.games.Game", link:"reference/com/google/android/gms/games/Game.html", type:"class", deprecated:"false" }, - { id:306, label:"com.google.android.gms.games.GameBuffer", link:"reference/com/google/android/gms/games/GameBuffer.html", type:"class", deprecated:"false" }, - { id:307, label:"com.google.android.gms.games.GameEntity", link:"reference/com/google/android/gms/games/GameEntity.html", type:"class", deprecated:"false" }, - { id:308, label:"com.google.android.gms.games.Games", link:"reference/com/google/android/gms/games/Games.html", type:"class", deprecated:"false" }, - { id:309, label:"com.google.android.gms.games.Games.GamesOptions", link:"reference/com/google/android/gms/games/Games.GamesOptions.html", type:"class", deprecated:"false" }, - { id:310, label:"com.google.android.gms.games.Games.GamesOptions.Builder", link:"reference/com/google/android/gms/games/Games.GamesOptions.Builder.html", type:"class", deprecated:"false" }, - { id:311, label:"com.google.android.gms.games.GamesActivityResultCodes", link:"reference/com/google/android/gms/games/GamesActivityResultCodes.html", type:"class", deprecated:"false" }, - { id:312, label:"com.google.android.gms.games.GamesMetadata", link:"reference/com/google/android/gms/games/GamesMetadata.html", type:"class", deprecated:"false" }, - { id:313, label:"com.google.android.gms.games.GamesMetadata.LoadGamesResult", link:"reference/com/google/android/gms/games/GamesMetadata.LoadGamesResult.html", type:"class", deprecated:"false" }, - { id:314, label:"com.google.android.gms.games.GamesStatusCodes", link:"reference/com/google/android/gms/games/GamesStatusCodes.html", type:"class", deprecated:"false" }, - { id:315, label:"com.google.android.gms.games.Notifications", link:"reference/com/google/android/gms/games/Notifications.html", type:"class", deprecated:"false" }, - { id:316, label:"com.google.android.gms.games.PageDirection", link:"reference/com/google/android/gms/games/PageDirection.html", type:"class", deprecated:"false" }, - { id:317, label:"com.google.android.gms.games.Player", link:"reference/com/google/android/gms/games/Player.html", type:"class", deprecated:"false" }, - { id:318, label:"com.google.android.gms.games.PlayerBuffer", link:"reference/com/google/android/gms/games/PlayerBuffer.html", type:"class", deprecated:"false" }, - { id:319, label:"com.google.android.gms.games.PlayerEntity", link:"reference/com/google/android/gms/games/PlayerEntity.html", type:"class", deprecated:"false" }, - { id:320, label:"com.google.android.gms.games.PlayerLevel", link:"reference/com/google/android/gms/games/PlayerLevel.html", type:"class", deprecated:"false" }, - { id:321, label:"com.google.android.gms.games.PlayerLevelInfo", link:"reference/com/google/android/gms/games/PlayerLevelInfo.html", type:"class", deprecated:"false" }, - { id:322, label:"com.google.android.gms.games.Players", link:"reference/com/google/android/gms/games/Players.html", type:"class", deprecated:"false" }, - { id:323, label:"com.google.android.gms.games.Players.LoadPlayersResult", link:"reference/com/google/android/gms/games/Players.LoadPlayersResult.html", type:"class", deprecated:"false" }, - { id:324, label:"com.google.android.gms.games.Players.LoadProfileSettingsResult", link:"reference/com/google/android/gms/games/Players.LoadProfileSettingsResult.html", type:"class", deprecated:"false" }, - { id:325, label:"com.google.android.gms.games.achievement", link:"reference/com/google/android/gms/games/achievement/package-summary.html", type:"package", deprecated:"false" }, - { id:326, label:"com.google.android.gms.games.achievement.Achievement", link:"reference/com/google/android/gms/games/achievement/Achievement.html", type:"class", deprecated:"false" }, - { id:327, label:"com.google.android.gms.games.achievement.AchievementBuffer", link:"reference/com/google/android/gms/games/achievement/AchievementBuffer.html", type:"class", deprecated:"false" }, - { id:328, label:"com.google.android.gms.games.achievement.AchievementEntity", link:"reference/com/google/android/gms/games/achievement/AchievementEntity.html", type:"class", deprecated:"false" }, - { id:329, label:"com.google.android.gms.games.achievement.Achievements", link:"reference/com/google/android/gms/games/achievement/Achievements.html", type:"class", deprecated:"false" }, - { id:330, label:"com.google.android.gms.games.achievement.Achievements.LoadAchievementsResult", link:"reference/com/google/android/gms/games/achievement/Achievements.LoadAchievementsResult.html", type:"class", deprecated:"false" }, - { id:331, label:"com.google.android.gms.games.achievement.Achievements.UpdateAchievementResult", link:"reference/com/google/android/gms/games/achievement/Achievements.UpdateAchievementResult.html", type:"class", deprecated:"false" }, - { id:332, label:"com.google.android.gms.games.event", link:"reference/com/google/android/gms/games/event/package-summary.html", type:"package", deprecated:"false" }, - { id:333, label:"com.google.android.gms.games.event.Event", link:"reference/com/google/android/gms/games/event/Event.html", type:"class", deprecated:"false" }, - { id:334, label:"com.google.android.gms.games.event.EventBuffer", link:"reference/com/google/android/gms/games/event/EventBuffer.html", type:"class", deprecated:"false" }, - { id:335, label:"com.google.android.gms.games.event.EventEntity", link:"reference/com/google/android/gms/games/event/EventEntity.html", type:"class", deprecated:"false" }, - { id:336, label:"com.google.android.gms.games.event.Events", link:"reference/com/google/android/gms/games/event/Events.html", type:"class", deprecated:"false" }, - { id:337, label:"com.google.android.gms.games.event.Events.LoadEventsResult", link:"reference/com/google/android/gms/games/event/Events.LoadEventsResult.html", type:"class", deprecated:"false" }, - { id:338, label:"com.google.android.gms.games.leaderboard", link:"reference/com/google/android/gms/games/leaderboard/package-summary.html", type:"package", deprecated:"false" }, - { id:339, label:"com.google.android.gms.games.leaderboard.Leaderboard", link:"reference/com/google/android/gms/games/leaderboard/Leaderboard.html", type:"class", deprecated:"false" }, - { id:340, label:"com.google.android.gms.games.leaderboard.LeaderboardBuffer", link:"reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer.html", type:"class", deprecated:"false" }, - { id:341, label:"com.google.android.gms.games.leaderboard.LeaderboardScore", link:"reference/com/google/android/gms/games/leaderboard/LeaderboardScore.html", type:"class", deprecated:"false" }, - { id:342, label:"com.google.android.gms.games.leaderboard.LeaderboardScoreBuffer", link:"reference/com/google/android/gms/games/leaderboard/LeaderboardScoreBuffer.html", type:"class", deprecated:"false" }, - { id:343, label:"com.google.android.gms.games.leaderboard.LeaderboardVariant", link:"reference/com/google/android/gms/games/leaderboard/LeaderboardVariant.html", type:"class", deprecated:"false" }, - { id:344, label:"com.google.android.gms.games.leaderboard.Leaderboards", link:"reference/com/google/android/gms/games/leaderboard/Leaderboards.html", type:"class", deprecated:"false" }, - { id:345, label:"com.google.android.gms.games.leaderboard.Leaderboards.LeaderboardMetadataResult", link:"reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult.html", type:"class", deprecated:"false" }, - { id:346, label:"com.google.android.gms.games.leaderboard.Leaderboards.LoadPlayerScoreResult", link:"reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadPlayerScoreResult.html", type:"class", deprecated:"false" }, - { id:347, label:"com.google.android.gms.games.leaderboard.Leaderboards.LoadScoresResult", link:"reference/com/google/android/gms/games/leaderboard/Leaderboards.LoadScoresResult.html", type:"class", deprecated:"false" }, - { id:348, label:"com.google.android.gms.games.leaderboard.Leaderboards.SubmitScoreResult", link:"reference/com/google/android/gms/games/leaderboard/Leaderboards.SubmitScoreResult.html", type:"class", deprecated:"false" }, - { id:349, label:"com.google.android.gms.games.leaderboard.ScoreSubmissionData", link:"reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.html", type:"class", deprecated:"false" }, - { id:350, label:"com.google.android.gms.games.leaderboard.ScoreSubmissionData.Result", link:"reference/com/google/android/gms/games/leaderboard/ScoreSubmissionData.Result.html", type:"class", deprecated:"false" }, - { id:351, label:"com.google.android.gms.games.multiplayer", link:"reference/com/google/android/gms/games/multiplayer/package-summary.html", type:"package", deprecated:"false" }, - { id:352, label:"com.google.android.gms.games.multiplayer.Invitation", link:"reference/com/google/android/gms/games/multiplayer/Invitation.html", type:"class", deprecated:"false" }, - { id:353, label:"com.google.android.gms.games.multiplayer.InvitationBuffer", link:"reference/com/google/android/gms/games/multiplayer/InvitationBuffer.html", type:"class", deprecated:"false" }, - { id:354, label:"com.google.android.gms.games.multiplayer.InvitationEntity", link:"reference/com/google/android/gms/games/multiplayer/InvitationEntity.html", type:"class", deprecated:"false" }, - { id:355, label:"com.google.android.gms.games.multiplayer.Invitations", link:"reference/com/google/android/gms/games/multiplayer/Invitations.html", type:"class", deprecated:"false" }, - { id:356, label:"com.google.android.gms.games.multiplayer.Invitations.LoadInvitationsResult", link:"reference/com/google/android/gms/games/multiplayer/Invitations.LoadInvitationsResult.html", type:"class", deprecated:"false" }, - { id:357, label:"com.google.android.gms.games.multiplayer.Multiplayer", link:"reference/com/google/android/gms/games/multiplayer/Multiplayer.html", type:"class", deprecated:"false" }, - { id:358, label:"com.google.android.gms.games.multiplayer.OnInvitationReceivedListener", link:"reference/com/google/android/gms/games/multiplayer/OnInvitationReceivedListener.html", type:"class", deprecated:"false" }, - { id:359, label:"com.google.android.gms.games.multiplayer.Participant", link:"reference/com/google/android/gms/games/multiplayer/Participant.html", type:"class", deprecated:"false" }, - { id:360, label:"com.google.android.gms.games.multiplayer.ParticipantBuffer", link:"reference/com/google/android/gms/games/multiplayer/ParticipantBuffer.html", type:"class", deprecated:"false" }, - { id:361, label:"com.google.android.gms.games.multiplayer.ParticipantEntity", link:"reference/com/google/android/gms/games/multiplayer/ParticipantEntity.html", type:"class", deprecated:"false" }, - { id:362, label:"com.google.android.gms.games.multiplayer.ParticipantResult", link:"reference/com/google/android/gms/games/multiplayer/ParticipantResult.html", type:"class", deprecated:"false" }, - { id:363, label:"com.google.android.gms.games.multiplayer.ParticipantUtils", link:"reference/com/google/android/gms/games/multiplayer/ParticipantUtils.html", type:"class", deprecated:"false" }, - { id:364, label:"com.google.android.gms.games.multiplayer.Participatable", link:"reference/com/google/android/gms/games/multiplayer/Participatable.html", type:"class", deprecated:"false" }, - { id:365, label:"com.google.android.gms.games.multiplayer.realtime", link:"reference/com/google/android/gms/games/multiplayer/realtime/package-summary.html", type:"package", deprecated:"false" }, - { id:366, label:"com.google.android.gms.games.multiplayer.realtime.RealTimeMessage", link:"reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessage.html", type:"class", deprecated:"false" }, - { id:367, label:"com.google.android.gms.games.multiplayer.realtime.RealTimeMessageReceivedListener", link:"reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMessageReceivedListener.html", type:"class", deprecated:"false" }, - { id:368, label:"com.google.android.gms.games.multiplayer.realtime.RealTimeMultiplayer", link:"reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.html", type:"class", deprecated:"false" }, - { id:369, label:"com.google.android.gms.games.multiplayer.realtime.RealTimeMultiplayer.ReliableMessageSentCallback", link:"reference/com/google/android/gms/games/multiplayer/realtime/RealTimeMultiplayer.ReliableMessageSentCallback.html", type:"class", deprecated:"false" }, - { id:370, label:"com.google.android.gms.games.multiplayer.realtime.Room", link:"reference/com/google/android/gms/games/multiplayer/realtime/Room.html", type:"class", deprecated:"false" }, - { id:371, label:"com.google.android.gms.games.multiplayer.realtime.RoomConfig", link:"reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.html", type:"class", deprecated:"false" }, - { id:372, label:"com.google.android.gms.games.multiplayer.realtime.RoomConfig.Builder", link:"reference/com/google/android/gms/games/multiplayer/realtime/RoomConfig.Builder.html", type:"class", deprecated:"false" }, - { id:373, label:"com.google.android.gms.games.multiplayer.realtime.RoomEntity", link:"reference/com/google/android/gms/games/multiplayer/realtime/RoomEntity.html", type:"class", deprecated:"false" }, - { id:374, label:"com.google.android.gms.games.multiplayer.realtime.RoomStatusUpdateListener", link:"reference/com/google/android/gms/games/multiplayer/realtime/RoomStatusUpdateListener.html", type:"class", deprecated:"false" }, - { id:375, label:"com.google.android.gms.games.multiplayer.realtime.RoomUpdateListener", link:"reference/com/google/android/gms/games/multiplayer/realtime/RoomUpdateListener.html", type:"class", deprecated:"false" }, - { id:376, label:"com.google.android.gms.games.multiplayer.turnbased", link:"reference/com/google/android/gms/games/multiplayer/turnbased/package-summary.html", type:"package", deprecated:"false" }, - { id:377, label:"com.google.android.gms.games.multiplayer.turnbased.LoadMatchesResponse", link:"reference/com/google/android/gms/games/multiplayer/turnbased/LoadMatchesResponse.html", type:"class", deprecated:"false" }, - { id:378, label:"com.google.android.gms.games.multiplayer.turnbased.OnTurnBasedMatchUpdateReceivedListener", link:"reference/com/google/android/gms/games/multiplayer/turnbased/OnTurnBasedMatchUpdateReceivedListener.html", type:"class", deprecated:"false" }, - { id:379, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatch", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatch.html", type:"class", deprecated:"false" }, - { id:380, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchBuffer", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchBuffer.html", type:"class", deprecated:"false" }, - { id:381, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.html", type:"class", deprecated:"false" }, - { id:382, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig.Builder", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchConfig.Builder.html", type:"class", deprecated:"false" }, - { id:383, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchEntity", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMatchEntity.html", type:"class", deprecated:"false" }, - { id:384, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.html", type:"class", deprecated:"false" }, - { id:385, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.CancelMatchResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.CancelMatchResult.html", type:"class", deprecated:"false" }, - { id:386, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.InitiateMatchResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.InitiateMatchResult.html", type:"class", deprecated:"false" }, - { id:387, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LeaveMatchResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LeaveMatchResult.html", type:"class", deprecated:"false" }, - { id:388, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LoadMatchResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchResult.html", type:"class", deprecated:"false" }, - { id:389, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.LoadMatchesResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.LoadMatchesResult.html", type:"class", deprecated:"false" }, - { id:390, label:"com.google.android.gms.games.multiplayer.turnbased.TurnBasedMultiplayer.UpdateMatchResult", link:"reference/com/google/android/gms/games/multiplayer/turnbased/TurnBasedMultiplayer.UpdateMatchResult.html", type:"class", deprecated:"false" }, - { id:391, label:"com.google.android.gms.games.quest", link:"reference/com/google/android/gms/games/quest/package-summary.html", type:"package", deprecated:"false" }, - { id:392, label:"com.google.android.gms.games.quest.Milestone", link:"reference/com/google/android/gms/games/quest/Milestone.html", type:"class", deprecated:"false" }, - { id:393, label:"com.google.android.gms.games.quest.MilestoneBuffer", link:"reference/com/google/android/gms/games/quest/MilestoneBuffer.html", type:"class", deprecated:"false" }, - { id:394, label:"com.google.android.gms.games.quest.MilestoneEntity", link:"reference/com/google/android/gms/games/quest/MilestoneEntity.html", type:"class", deprecated:"false" }, - { id:395, label:"com.google.android.gms.games.quest.Quest", link:"reference/com/google/android/gms/games/quest/Quest.html", type:"class", deprecated:"false" }, - { id:396, label:"com.google.android.gms.games.quest.QuestBuffer", link:"reference/com/google/android/gms/games/quest/QuestBuffer.html", type:"class", deprecated:"false" }, - { id:397, label:"com.google.android.gms.games.quest.QuestEntity", link:"reference/com/google/android/gms/games/quest/QuestEntity.html", type:"class", deprecated:"false" }, - { id:398, label:"com.google.android.gms.games.quest.QuestUpdateListener", link:"reference/com/google/android/gms/games/quest/QuestUpdateListener.html", type:"class", deprecated:"false" }, - { id:399, label:"com.google.android.gms.games.quest.Quests", link:"reference/com/google/android/gms/games/quest/Quests.html", type:"class", deprecated:"false" }, - { id:400, label:"com.google.android.gms.games.quest.Quests.AcceptQuestResult", link:"reference/com/google/android/gms/games/quest/Quests.AcceptQuestResult.html", type:"class", deprecated:"false" }, - { id:401, label:"com.google.android.gms.games.quest.Quests.ClaimMilestoneResult", link:"reference/com/google/android/gms/games/quest/Quests.ClaimMilestoneResult.html", type:"class", deprecated:"false" }, - { id:402, label:"com.google.android.gms.games.quest.Quests.LoadQuestsResult", link:"reference/com/google/android/gms/games/quest/Quests.LoadQuestsResult.html", type:"class", deprecated:"false" }, - { id:403, label:"com.google.android.gms.games.request", link:"reference/com/google/android/gms/games/request/package-summary.html", type:"package", deprecated:"false" }, - { id:404, label:"com.google.android.gms.games.request.GameRequest", link:"reference/com/google/android/gms/games/request/GameRequest.html", type:"class", deprecated:"false" }, - { id:405, label:"com.google.android.gms.games.request.GameRequestBuffer", link:"reference/com/google/android/gms/games/request/GameRequestBuffer.html", type:"class", deprecated:"false" }, - { id:406, label:"com.google.android.gms.games.request.GameRequestEntity", link:"reference/com/google/android/gms/games/request/GameRequestEntity.html", type:"class", deprecated:"false" }, - { id:407, label:"com.google.android.gms.games.request.OnRequestReceivedListener", link:"reference/com/google/android/gms/games/request/OnRequestReceivedListener.html", type:"class", deprecated:"false" }, - { id:408, label:"com.google.android.gms.games.request.Requests", link:"reference/com/google/android/gms/games/request/Requests.html", type:"class", deprecated:"false" }, - { id:409, label:"com.google.android.gms.games.request.Requests.LoadRequestsResult", link:"reference/com/google/android/gms/games/request/Requests.LoadRequestsResult.html", type:"class", deprecated:"false" }, - { id:410, label:"com.google.android.gms.games.request.Requests.UpdateRequestsResult", link:"reference/com/google/android/gms/games/request/Requests.UpdateRequestsResult.html", type:"class", deprecated:"false" }, - { id:411, label:"com.google.android.gms.games.snapshot", link:"reference/com/google/android/gms/games/snapshot/package-summary.html", type:"package", deprecated:"false" }, - { id:412, label:"com.google.android.gms.games.snapshot.Snapshot", link:"reference/com/google/android/gms/games/snapshot/Snapshot.html", type:"class", deprecated:"false" }, - { id:413, label:"com.google.android.gms.games.snapshot.SnapshotContents", link:"reference/com/google/android/gms/games/snapshot/SnapshotContents.html", type:"class", deprecated:"false" }, - { id:414, label:"com.google.android.gms.games.snapshot.SnapshotEntity", link:"reference/com/google/android/gms/games/snapshot/SnapshotEntity.html", type:"class", deprecated:"false" }, - { id:415, label:"com.google.android.gms.games.snapshot.SnapshotMetadata", link:"reference/com/google/android/gms/games/snapshot/SnapshotMetadata.html", type:"class", deprecated:"false" }, - { id:416, label:"com.google.android.gms.games.snapshot.SnapshotMetadataBuffer", link:"reference/com/google/android/gms/games/snapshot/SnapshotMetadataBuffer.html", type:"class", deprecated:"false" }, - { id:417, label:"com.google.android.gms.games.snapshot.SnapshotMetadataChange", link:"reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.html", type:"class", deprecated:"false" }, - { id:418, label:"com.google.android.gms.games.snapshot.SnapshotMetadataChange.Builder", link:"reference/com/google/android/gms/games/snapshot/SnapshotMetadataChange.Builder.html", type:"class", deprecated:"false" }, - { id:419, label:"com.google.android.gms.games.snapshot.SnapshotMetadataEntity", link:"reference/com/google/android/gms/games/snapshot/SnapshotMetadataEntity.html", type:"class", deprecated:"false" }, - { id:420, label:"com.google.android.gms.games.snapshot.Snapshots", link:"reference/com/google/android/gms/games/snapshot/Snapshots.html", type:"class", deprecated:"false" }, - { id:421, label:"com.google.android.gms.games.snapshot.Snapshots.CommitSnapshotResult", link:"reference/com/google/android/gms/games/snapshot/Snapshots.CommitSnapshotResult.html", type:"class", deprecated:"false" }, - { id:422, label:"com.google.android.gms.games.snapshot.Snapshots.DeleteSnapshotResult", link:"reference/com/google/android/gms/games/snapshot/Snapshots.DeleteSnapshotResult.html", type:"class", deprecated:"false" }, - { id:423, label:"com.google.android.gms.games.snapshot.Snapshots.LoadSnapshotsResult", link:"reference/com/google/android/gms/games/snapshot/Snapshots.LoadSnapshotsResult.html", type:"class", deprecated:"false" }, - { id:424, label:"com.google.android.gms.games.snapshot.Snapshots.OpenSnapshotResult", link:"reference/com/google/android/gms/games/snapshot/Snapshots.OpenSnapshotResult.html", type:"class", deprecated:"false" }, - { id:425, label:"com.google.android.gms.gcm", link:"reference/com/google/android/gms/gcm/package-summary.html", type:"package", deprecated:"false" }, - { id:426, label:"com.google.android.gms.gcm.GoogleCloudMessaging", link:"reference/com/google/android/gms/gcm/GoogleCloudMessaging.html", type:"class", deprecated:"false" }, - { id:427, label:"com.google.android.gms.identity.intents", link:"reference/com/google/android/gms/identity/intents/package-summary.html", type:"package", deprecated:"false" }, - { id:428, label:"com.google.android.gms.identity.intents.Address", link:"reference/com/google/android/gms/identity/intents/Address.html", type:"class", deprecated:"false" }, - { id:429, label:"com.google.android.gms.identity.intents.Address.AddressOptions", link:"reference/com/google/android/gms/identity/intents/Address.AddressOptions.html", type:"class", deprecated:"false" }, - { id:430, label:"com.google.android.gms.identity.intents.AddressConstants", link:"reference/com/google/android/gms/identity/intents/AddressConstants.html", type:"class", deprecated:"false" }, - { id:431, label:"com.google.android.gms.identity.intents.AddressConstants.ErrorCodes", link:"reference/com/google/android/gms/identity/intents/AddressConstants.ErrorCodes.html", type:"class", deprecated:"false" }, - { id:432, label:"com.google.android.gms.identity.intents.AddressConstants.Extras", link:"reference/com/google/android/gms/identity/intents/AddressConstants.Extras.html", type:"class", deprecated:"false" }, - { id:433, label:"com.google.android.gms.identity.intents.AddressConstants.ResultCodes", link:"reference/com/google/android/gms/identity/intents/AddressConstants.ResultCodes.html", type:"class", deprecated:"false" }, - { id:434, label:"com.google.android.gms.identity.intents.AddressConstants.Themes", link:"reference/com/google/android/gms/identity/intents/AddressConstants.Themes.html", type:"class", deprecated:"false" }, - { id:435, label:"com.google.android.gms.identity.intents.UserAddressRequest", link:"reference/com/google/android/gms/identity/intents/UserAddressRequest.html", type:"class", deprecated:"false" }, - { id:436, label:"com.google.android.gms.identity.intents.UserAddressRequest.Builder", link:"reference/com/google/android/gms/identity/intents/UserAddressRequest.Builder.html", type:"class", deprecated:"false" }, - { id:437, label:"com.google.android.gms.identity.intents.model", link:"reference/com/google/android/gms/identity/intents/model/package-summary.html", type:"package", deprecated:"false" }, - { id:438, label:"com.google.android.gms.identity.intents.model.CountrySpecification", link:"reference/com/google/android/gms/identity/intents/model/CountrySpecification.html", type:"class", deprecated:"false" }, - { id:439, label:"com.google.android.gms.identity.intents.model.UserAddress", link:"reference/com/google/android/gms/identity/intents/model/UserAddress.html", type:"class", deprecated:"false" }, - { id:440, label:"com.google.android.gms.location", link:"reference/com/google/android/gms/location/package-summary.html", type:"package", deprecated:"false" }, - { id:441, label:"com.google.android.gms.location.ActivityRecognition", link:"reference/com/google/android/gms/location/ActivityRecognition.html", type:"class", deprecated:"false" }, - { id:442, label:"com.google.android.gms.location.ActivityRecognitionApi", link:"reference/com/google/android/gms/location/ActivityRecognitionApi.html", type:"class", deprecated:"false" }, - { id:443, label:"com.google.android.gms.location.ActivityRecognitionResult", link:"reference/com/google/android/gms/location/ActivityRecognitionResult.html", type:"class", deprecated:"false" }, - { id:444, label:"com.google.android.gms.location.DetectedActivity", link:"reference/com/google/android/gms/location/DetectedActivity.html", type:"class", deprecated:"false" }, - { id:445, label:"com.google.android.gms.location.FusedLocationProviderApi", link:"reference/com/google/android/gms/location/FusedLocationProviderApi.html", type:"class", deprecated:"false" }, - { id:446, label:"com.google.android.gms.location.Geofence", link:"reference/com/google/android/gms/location/Geofence.html", type:"class", deprecated:"false" }, - { id:447, label:"com.google.android.gms.location.Geofence.Builder", link:"reference/com/google/android/gms/location/Geofence.Builder.html", type:"class", deprecated:"false" }, - { id:448, label:"com.google.android.gms.location.GeofenceStatusCodes", link:"reference/com/google/android/gms/location/GeofenceStatusCodes.html", type:"class", deprecated:"false" }, - { id:449, label:"com.google.android.gms.location.GeofencingApi", link:"reference/com/google/android/gms/location/GeofencingApi.html", type:"class", deprecated:"false" }, - { id:450, label:"com.google.android.gms.location.GeofencingEvent", link:"reference/com/google/android/gms/location/GeofencingEvent.html", type:"class", deprecated:"false" }, - { id:451, label:"com.google.android.gms.location.GeofencingRequest", link:"reference/com/google/android/gms/location/GeofencingRequest.html", type:"class", deprecated:"false" }, - { id:452, label:"com.google.android.gms.location.GeofencingRequest.Builder", link:"reference/com/google/android/gms/location/GeofencingRequest.Builder.html", type:"class", deprecated:"false" }, - { id:453, label:"com.google.android.gms.location.LocationAvailability", link:"reference/com/google/android/gms/location/LocationAvailability.html", type:"class", deprecated:"false" }, - { id:454, label:"com.google.android.gms.location.LocationCallback", link:"reference/com/google/android/gms/location/LocationCallback.html", type:"class", deprecated:"false" }, - { id:455, label:"com.google.android.gms.location.LocationListener", link:"reference/com/google/android/gms/location/LocationListener.html", type:"class", deprecated:"false" }, - { id:456, label:"com.google.android.gms.location.LocationRequest", link:"reference/com/google/android/gms/location/LocationRequest.html", type:"class", deprecated:"false" }, - { id:457, label:"com.google.android.gms.location.LocationResult", link:"reference/com/google/android/gms/location/LocationResult.html", type:"class", deprecated:"false" }, - { id:458, label:"com.google.android.gms.location.LocationServices", link:"reference/com/google/android/gms/location/LocationServices.html", type:"class", deprecated:"false" }, - { id:459, label:"com.google.android.gms.location.LocationSettingsRequest", link:"reference/com/google/android/gms/location/LocationSettingsRequest.html", type:"class", deprecated:"false" }, - { id:460, label:"com.google.android.gms.location.LocationSettingsRequest.Builder", link:"reference/com/google/android/gms/location/LocationSettingsRequest.Builder.html", type:"class", deprecated:"false" }, - { id:461, label:"com.google.android.gms.location.LocationSettingsResult", link:"reference/com/google/android/gms/location/LocationSettingsResult.html", type:"class", deprecated:"false" }, - { id:462, label:"com.google.android.gms.location.LocationSettingsStates", link:"reference/com/google/android/gms/location/LocationSettingsStates.html", type:"class", deprecated:"false" }, - { id:463, label:"com.google.android.gms.location.LocationSettingsStatusCodes", link:"reference/com/google/android/gms/location/LocationSettingsStatusCodes.html", type:"class", deprecated:"false" }, - { id:464, label:"com.google.android.gms.location.LocationStatusCodes", link:"reference/com/google/android/gms/location/LocationStatusCodes.html", type:"class", deprecated:"true" }, - { id:465, label:"com.google.android.gms.location.SettingsApi", link:"reference/com/google/android/gms/location/SettingsApi.html", type:"class", deprecated:"false" }, - { id:466, label:"com.google.android.gms.location.places", link:"reference/com/google/android/gms/location/places/package-summary.html", type:"package", deprecated:"false" }, - { id:467, label:"com.google.android.gms.location.places.AddPlaceRequest", link:"reference/com/google/android/gms/location/places/AddPlaceRequest.html", type:"class", deprecated:"false" }, - { id:468, label:"com.google.android.gms.location.places.AutocompleteFilter", link:"reference/com/google/android/gms/location/places/AutocompleteFilter.html", type:"class", deprecated:"false" }, - { id:469, label:"com.google.android.gms.location.places.AutocompletePrediction", link:"reference/com/google/android/gms/location/places/AutocompletePrediction.html", type:"class", deprecated:"false" }, - { id:470, label:"com.google.android.gms.location.places.AutocompletePrediction.Substring", link:"reference/com/google/android/gms/location/places/AutocompletePrediction.Substring.html", type:"class", deprecated:"false" }, - { id:471, label:"com.google.android.gms.location.places.AutocompletePredictionBuffer", link:"reference/com/google/android/gms/location/places/AutocompletePredictionBuffer.html", type:"class", deprecated:"false" }, - { id:472, label:"com.google.android.gms.location.places.GeoDataApi", link:"reference/com/google/android/gms/location/places/GeoDataApi.html", type:"class", deprecated:"false" }, - { id:473, label:"com.google.android.gms.location.places.Place", link:"reference/com/google/android/gms/location/places/Place.html", type:"class", deprecated:"false" }, - { id:474, label:"com.google.android.gms.location.places.PlaceBuffer", link:"reference/com/google/android/gms/location/places/PlaceBuffer.html", type:"class", deprecated:"false" }, - { id:475, label:"com.google.android.gms.location.places.PlaceDetectionApi", link:"reference/com/google/android/gms/location/places/PlaceDetectionApi.html", type:"class", deprecated:"false" }, - { id:476, label:"com.google.android.gms.location.places.PlaceFilter", link:"reference/com/google/android/gms/location/places/PlaceFilter.html", type:"class", deprecated:"false" }, - { id:477, label:"com.google.android.gms.location.places.PlaceLikelihood", link:"reference/com/google/android/gms/location/places/PlaceLikelihood.html", type:"class", deprecated:"false" }, - { id:478, label:"com.google.android.gms.location.places.PlaceLikelihoodBuffer", link:"reference/com/google/android/gms/location/places/PlaceLikelihoodBuffer.html", type:"class", deprecated:"false" }, - { id:479, label:"com.google.android.gms.location.places.PlaceReport", link:"reference/com/google/android/gms/location/places/PlaceReport.html", type:"class", deprecated:"false" }, - { id:480, label:"com.google.android.gms.location.places.PlaceTypes", link:"reference/com/google/android/gms/location/places/PlaceTypes.html", type:"class", deprecated:"false" }, - { id:481, label:"com.google.android.gms.location.places.Places", link:"reference/com/google/android/gms/location/places/Places.html", type:"class", deprecated:"false" }, - { id:482, label:"com.google.android.gms.location.places.PlacesOptions", link:"reference/com/google/android/gms/location/places/PlacesOptions.html", type:"class", deprecated:"false" }, - { id:483, label:"com.google.android.gms.location.places.PlacesOptions.Builder", link:"reference/com/google/android/gms/location/places/PlacesOptions.Builder.html", type:"class", deprecated:"false" }, - { id:484, label:"com.google.android.gms.location.places.PlacesStatusCodes", link:"reference/com/google/android/gms/location/places/PlacesStatusCodes.html", type:"class", deprecated:"false" }, - { id:485, label:"com.google.android.gms.location.places.ui", link:"reference/com/google/android/gms/location/places/ui/package-summary.html", type:"package", deprecated:"false" }, - { id:486, label:"com.google.android.gms.location.places.ui.PlacePicker", link:"reference/com/google/android/gms/location/places/ui/PlacePicker.html", type:"class", deprecated:"false" }, - { id:487, label:"com.google.android.gms.location.places.ui.PlacePicker.IntentBuilder", link:"reference/com/google/android/gms/location/places/ui/PlacePicker.IntentBuilder.html", type:"class", deprecated:"false" }, - { id:488, label:"com.google.android.gms.maps", link:"reference/com/google/android/gms/maps/package-summary.html", type:"package", deprecated:"false" }, - { id:489, label:"com.google.android.gms.maps.CameraUpdate", link:"reference/com/google/android/gms/maps/CameraUpdate.html", type:"class", deprecated:"false" }, - { id:490, label:"com.google.android.gms.maps.CameraUpdateFactory", link:"reference/com/google/android/gms/maps/CameraUpdateFactory.html", type:"class", deprecated:"false" }, - { id:491, label:"com.google.android.gms.maps.GoogleMap", link:"reference/com/google/android/gms/maps/GoogleMap.html", type:"class", deprecated:"false" }, - { id:492, label:"com.google.android.gms.maps.GoogleMap.CancelableCallback", link:"reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html", type:"class", deprecated:"false" }, - { id:493, label:"com.google.android.gms.maps.GoogleMap.InfoWindowAdapter", link:"reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html", type:"class", deprecated:"false" }, - { id:494, label:"com.google.android.gms.maps.GoogleMap.OnCameraChangeListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html", type:"class", deprecated:"false" }, - { id:495, label:"com.google.android.gms.maps.GoogleMap.OnIndoorStateChangeListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnIndoorStateChangeListener.html", type:"class", deprecated:"false" }, - { id:496, label:"com.google.android.gms.maps.GoogleMap.OnInfoWindowClickListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html", type:"class", deprecated:"false" }, - { id:497, label:"com.google.android.gms.maps.GoogleMap.OnMapClickListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html", type:"class", deprecated:"false" }, - { id:498, label:"com.google.android.gms.maps.GoogleMap.OnMapLoadedCallback", link:"reference/com/google/android/gms/maps/GoogleMap.OnMapLoadedCallback.html", type:"class", deprecated:"false" }, - { id:499, label:"com.google.android.gms.maps.GoogleMap.OnMapLongClickListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html", type:"class", deprecated:"false" }, - { id:500, label:"com.google.android.gms.maps.GoogleMap.OnMarkerClickListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html", type:"class", deprecated:"false" }, - { id:501, label:"com.google.android.gms.maps.GoogleMap.OnMarkerDragListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html", type:"class", deprecated:"false" }, - { id:502, label:"com.google.android.gms.maps.GoogleMap.OnMyLocationButtonClickListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMyLocationButtonClickListener.html", type:"class", deprecated:"false" }, - { id:503, label:"com.google.android.gms.maps.GoogleMap.OnMyLocationChangeListener", link:"reference/com/google/android/gms/maps/GoogleMap.OnMyLocationChangeListener.html", type:"class", deprecated:"true" }, - { id:504, label:"com.google.android.gms.maps.GoogleMap.SnapshotReadyCallback", link:"reference/com/google/android/gms/maps/GoogleMap.SnapshotReadyCallback.html", type:"class", deprecated:"false" }, - { id:505, label:"com.google.android.gms.maps.GoogleMapOptions", link:"reference/com/google/android/gms/maps/GoogleMapOptions.html", type:"class", deprecated:"false" }, - { id:506, label:"com.google.android.gms.maps.LocationSource", link:"reference/com/google/android/gms/maps/LocationSource.html", type:"class", deprecated:"false" }, - { id:507, label:"com.google.android.gms.maps.LocationSource.OnLocationChangedListener", link:"reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html", type:"class", deprecated:"false" }, - { id:508, label:"com.google.android.gms.maps.MapFragment", link:"reference/com/google/android/gms/maps/MapFragment.html", type:"class", deprecated:"false" }, - { id:509, label:"com.google.android.gms.maps.MapView", link:"reference/com/google/android/gms/maps/MapView.html", type:"class", deprecated:"false" }, - { id:510, label:"com.google.android.gms.maps.MapsInitializer", link:"reference/com/google/android/gms/maps/MapsInitializer.html", type:"class", deprecated:"false" }, - { id:511, label:"com.google.android.gms.maps.OnMapReadyCallback", link:"reference/com/google/android/gms/maps/OnMapReadyCallback.html", type:"class", deprecated:"false" }, - { id:512, label:"com.google.android.gms.maps.OnStreetViewPanoramaReadyCallback", link:"reference/com/google/android/gms/maps/OnStreetViewPanoramaReadyCallback.html", type:"class", deprecated:"false" }, - { id:513, label:"com.google.android.gms.maps.Projection", link:"reference/com/google/android/gms/maps/Projection.html", type:"class", deprecated:"false" }, - { id:514, label:"com.google.android.gms.maps.StreetViewPanorama", link:"reference/com/google/android/gms/maps/StreetViewPanorama.html", type:"class", deprecated:"false" }, - { id:515, label:"com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener", link:"reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaCameraChangeListener.html", type:"class", deprecated:"false" }, - { id:516, label:"com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaChangeListener", link:"reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaChangeListener.html", type:"class", deprecated:"false" }, - { id:517, label:"com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaClickListener", link:"reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaClickListener.html", type:"class", deprecated:"false" }, - { id:518, label:"com.google.android.gms.maps.StreetViewPanorama.OnStreetViewPanoramaLongClickListener", link:"reference/com/google/android/gms/maps/StreetViewPanorama.OnStreetViewPanoramaLongClickListener.html", type:"class", deprecated:"false" }, - { id:519, label:"com.google.android.gms.maps.StreetViewPanoramaFragment", link:"reference/com/google/android/gms/maps/StreetViewPanoramaFragment.html", type:"class", deprecated:"false" }, - { id:520, label:"com.google.android.gms.maps.StreetViewPanoramaOptions", link:"reference/com/google/android/gms/maps/StreetViewPanoramaOptions.html", type:"class", deprecated:"false" }, - { id:521, label:"com.google.android.gms.maps.StreetViewPanoramaView", link:"reference/com/google/android/gms/maps/StreetViewPanoramaView.html", type:"class", deprecated:"false" }, - { id:522, label:"com.google.android.gms.maps.SupportMapFragment", link:"reference/com/google/android/gms/maps/SupportMapFragment.html", type:"class", deprecated:"false" }, - { id:523, label:"com.google.android.gms.maps.SupportStreetViewPanoramaFragment", link:"reference/com/google/android/gms/maps/SupportStreetViewPanoramaFragment.html", type:"class", deprecated:"false" }, - { id:524, label:"com.google.android.gms.maps.UiSettings", link:"reference/com/google/android/gms/maps/UiSettings.html", type:"class", deprecated:"false" }, - { id:525, label:"com.google.android.gms.maps.model", link:"reference/com/google/android/gms/maps/model/package-summary.html", type:"package", deprecated:"false" }, - { id:526, label:"com.google.android.gms.maps.model.BitmapDescriptor", link:"reference/com/google/android/gms/maps/model/BitmapDescriptor.html", type:"class", deprecated:"false" }, - { id:527, label:"com.google.android.gms.maps.model.BitmapDescriptorFactory", link:"reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html", type:"class", deprecated:"false" }, - { id:528, label:"com.google.android.gms.maps.model.CameraPosition", link:"reference/com/google/android/gms/maps/model/CameraPosition.html", type:"class", deprecated:"false" }, - { id:529, label:"com.google.android.gms.maps.model.CameraPosition.Builder", link:"reference/com/google/android/gms/maps/model/CameraPosition.Builder.html", type:"class", deprecated:"false" }, - { id:530, label:"com.google.android.gms.maps.model.Circle", link:"reference/com/google/android/gms/maps/model/Circle.html", type:"class", deprecated:"false" }, - { id:531, label:"com.google.android.gms.maps.model.CircleOptions", link:"reference/com/google/android/gms/maps/model/CircleOptions.html", type:"class", deprecated:"false" }, - { id:532, label:"com.google.android.gms.maps.model.GroundOverlay", link:"reference/com/google/android/gms/maps/model/GroundOverlay.html", type:"class", deprecated:"false" }, - { id:533, label:"com.google.android.gms.maps.model.GroundOverlayOptions", link:"reference/com/google/android/gms/maps/model/GroundOverlayOptions.html", type:"class", deprecated:"false" }, - { id:534, label:"com.google.android.gms.maps.model.IndoorBuilding", link:"reference/com/google/android/gms/maps/model/IndoorBuilding.html", type:"class", deprecated:"false" }, - { id:535, label:"com.google.android.gms.maps.model.IndoorLevel", link:"reference/com/google/android/gms/maps/model/IndoorLevel.html", type:"class", deprecated:"false" }, - { id:536, label:"com.google.android.gms.maps.model.LatLng", link:"reference/com/google/android/gms/maps/model/LatLng.html", type:"class", deprecated:"false" }, - { id:537, label:"com.google.android.gms.maps.model.LatLngBounds", link:"reference/com/google/android/gms/maps/model/LatLngBounds.html", type:"class", deprecated:"false" }, - { id:538, label:"com.google.android.gms.maps.model.LatLngBounds.Builder", link:"reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html", type:"class", deprecated:"false" }, - { id:539, label:"com.google.android.gms.maps.model.Marker", link:"reference/com/google/android/gms/maps/model/Marker.html", type:"class", deprecated:"false" }, - { id:540, label:"com.google.android.gms.maps.model.MarkerOptions", link:"reference/com/google/android/gms/maps/model/MarkerOptions.html", type:"class", deprecated:"false" }, - { id:541, label:"com.google.android.gms.maps.model.Polygon", link:"reference/com/google/android/gms/maps/model/Polygon.html", type:"class", deprecated:"false" }, - { id:542, label:"com.google.android.gms.maps.model.PolygonOptions", link:"reference/com/google/android/gms/maps/model/PolygonOptions.html", type:"class", deprecated:"false" }, - { id:543, label:"com.google.android.gms.maps.model.Polyline", link:"reference/com/google/android/gms/maps/model/Polyline.html", type:"class", deprecated:"false" }, - { id:544, label:"com.google.android.gms.maps.model.PolylineOptions", link:"reference/com/google/android/gms/maps/model/PolylineOptions.html", type:"class", deprecated:"false" }, - { id:545, label:"com.google.android.gms.maps.model.RuntimeRemoteException", link:"reference/com/google/android/gms/maps/model/RuntimeRemoteException.html", type:"class", deprecated:"false" }, - { id:546, label:"com.google.android.gms.maps.model.StreetViewPanoramaCamera", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.html", type:"class", deprecated:"false" }, - { id:547, label:"com.google.android.gms.maps.model.StreetViewPanoramaCamera.Builder", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaCamera.Builder.html", type:"class", deprecated:"false" }, - { id:548, label:"com.google.android.gms.maps.model.StreetViewPanoramaLink", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaLink.html", type:"class", deprecated:"false" }, - { id:549, label:"com.google.android.gms.maps.model.StreetViewPanoramaLocation", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaLocation.html", type:"class", deprecated:"false" }, - { id:550, label:"com.google.android.gms.maps.model.StreetViewPanoramaOrientation", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.html", type:"class", deprecated:"false" }, - { id:551, label:"com.google.android.gms.maps.model.StreetViewPanoramaOrientation.Builder", link:"reference/com/google/android/gms/maps/model/StreetViewPanoramaOrientation.Builder.html", type:"class", deprecated:"false" }, - { id:552, label:"com.google.android.gms.maps.model.Tile", link:"reference/com/google/android/gms/maps/model/Tile.html", type:"class", deprecated:"false" }, - { id:553, label:"com.google.android.gms.maps.model.TileOverlay", link:"reference/com/google/android/gms/maps/model/TileOverlay.html", type:"class", deprecated:"false" }, - { id:554, label:"com.google.android.gms.maps.model.TileOverlayOptions", link:"reference/com/google/android/gms/maps/model/TileOverlayOptions.html", type:"class", deprecated:"false" }, - { id:555, label:"com.google.android.gms.maps.model.TileProvider", link:"reference/com/google/android/gms/maps/model/TileProvider.html", type:"class", deprecated:"false" }, - { id:556, label:"com.google.android.gms.maps.model.UrlTileProvider", link:"reference/com/google/android/gms/maps/model/UrlTileProvider.html", type:"class", deprecated:"false" }, - { id:557, label:"com.google.android.gms.maps.model.VisibleRegion", link:"reference/com/google/android/gms/maps/model/VisibleRegion.html", type:"class", deprecated:"false" }, - { id:558, label:"com.google.android.gms.nearby", link:"reference/com/google/android/gms/nearby/package-summary.html", type:"package", deprecated:"false" }, - { id:559, label:"com.google.android.gms.nearby.Nearby", link:"reference/com/google/android/gms/nearby/Nearby.html", type:"class", deprecated:"false" }, - { id:560, label:"com.google.android.gms.nearby.connection", link:"reference/com/google/android/gms/nearby/connection/package-summary.html", type:"package", deprecated:"false" }, - { id:561, label:"com.google.android.gms.nearby.connection.AppIdentifier", link:"reference/com/google/android/gms/nearby/connection/AppIdentifier.html", type:"class", deprecated:"false" }, - { id:562, label:"com.google.android.gms.nearby.connection.AppMetadata", link:"reference/com/google/android/gms/nearby/connection/AppMetadata.html", type:"class", deprecated:"false" }, - { id:563, label:"com.google.android.gms.nearby.connection.Connections", link:"reference/com/google/android/gms/nearby/connection/Connections.html", type:"class", deprecated:"false" }, - { id:564, label:"com.google.android.gms.nearby.connection.Connections.ConnectionRequestListener", link:"reference/com/google/android/gms/nearby/connection/Connections.ConnectionRequestListener.html", type:"class", deprecated:"false" }, - { id:565, label:"com.google.android.gms.nearby.connection.Connections.ConnectionResponseCallback", link:"reference/com/google/android/gms/nearby/connection/Connections.ConnectionResponseCallback.html", type:"class", deprecated:"false" }, - { id:566, label:"com.google.android.gms.nearby.connection.Connections.EndpointDiscoveryListener", link:"reference/com/google/android/gms/nearby/connection/Connections.EndpointDiscoveryListener.html", type:"class", deprecated:"false" }, - { id:567, label:"com.google.android.gms.nearby.connection.Connections.MessageListener", link:"reference/com/google/android/gms/nearby/connection/Connections.MessageListener.html", type:"class", deprecated:"false" }, - { id:568, label:"com.google.android.gms.nearby.connection.Connections.StartAdvertisingResult", link:"reference/com/google/android/gms/nearby/connection/Connections.StartAdvertisingResult.html", type:"class", deprecated:"false" }, - { id:569, label:"com.google.android.gms.nearby.connection.ConnectionsStatusCodes", link:"reference/com/google/android/gms/nearby/connection/ConnectionsStatusCodes.html", type:"class", deprecated:"false" }, - { id:570, label:"com.google.android.gms.panorama", link:"reference/com/google/android/gms/panorama/package-summary.html", type:"package", deprecated:"false" }, - { id:571, label:"com.google.android.gms.panorama.Panorama", link:"reference/com/google/android/gms/panorama/Panorama.html", type:"class", deprecated:"false" }, - { id:572, label:"com.google.android.gms.panorama.PanoramaApi", link:"reference/com/google/android/gms/panorama/PanoramaApi.html", type:"class", deprecated:"false" }, - { id:573, label:"com.google.android.gms.panorama.PanoramaApi.PanoramaResult", link:"reference/com/google/android/gms/panorama/PanoramaApi.PanoramaResult.html", type:"class", deprecated:"false" }, - { id:574, label:"com.google.android.gms.plus", link:"reference/com/google/android/gms/plus/package-summary.html", type:"package", deprecated:"false" }, - { id:575, label:"com.google.android.gms.plus.Account", link:"reference/com/google/android/gms/plus/Account.html", type:"class", deprecated:"false" }, - { id:576, label:"com.google.android.gms.plus.Moments", link:"reference/com/google/android/gms/plus/Moments.html", type:"class", deprecated:"false" }, - { id:577, label:"com.google.android.gms.plus.Moments.LoadMomentsResult", link:"reference/com/google/android/gms/plus/Moments.LoadMomentsResult.html", type:"class", deprecated:"false" }, - { id:578, label:"com.google.android.gms.plus.People", link:"reference/com/google/android/gms/plus/People.html", type:"class", deprecated:"false" }, - { id:579, label:"com.google.android.gms.plus.People.LoadPeopleResult", link:"reference/com/google/android/gms/plus/People.LoadPeopleResult.html", type:"class", deprecated:"false" }, - { id:580, label:"com.google.android.gms.plus.People.OrderBy", link:"reference/com/google/android/gms/plus/People.OrderBy.html", type:"class", deprecated:"false" }, - { id:581, label:"com.google.android.gms.plus.Plus", link:"reference/com/google/android/gms/plus/Plus.html", type:"class", deprecated:"false" }, - { id:582, label:"com.google.android.gms.plus.Plus.PlusOptions", link:"reference/com/google/android/gms/plus/Plus.PlusOptions.html", type:"class", deprecated:"false" }, - { id:583, label:"com.google.android.gms.plus.Plus.PlusOptions.Builder", link:"reference/com/google/android/gms/plus/Plus.PlusOptions.Builder.html", type:"class", deprecated:"false" }, - { id:584, label:"com.google.android.gms.plus.PlusOneButton", link:"reference/com/google/android/gms/plus/PlusOneButton.html", type:"class", deprecated:"false" }, - { id:585, label:"com.google.android.gms.plus.PlusOneButton.DefaultOnPlusOneClickListener", link:"reference/com/google/android/gms/plus/PlusOneButton.DefaultOnPlusOneClickListener.html", type:"class", deprecated:"false" }, - { id:586, label:"com.google.android.gms.plus.PlusOneButton.OnPlusOneClickListener", link:"reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html", type:"class", deprecated:"false" }, - { id:587, label:"com.google.android.gms.plus.PlusOneDummyView", link:"reference/com/google/android/gms/plus/PlusOneDummyView.html", type:"class", deprecated:"false" }, - { id:588, label:"com.google.android.gms.plus.PlusShare", link:"reference/com/google/android/gms/plus/PlusShare.html", type:"class", deprecated:"false" }, - { id:589, label:"com.google.android.gms.plus.PlusShare.Builder", link:"reference/com/google/android/gms/plus/PlusShare.Builder.html", type:"class", deprecated:"false" }, - { id:590, label:"com.google.android.gms.plus.model.moments", link:"reference/com/google/android/gms/plus/model/moments/package-summary.html", type:"package", deprecated:"false" }, - { id:591, label:"com.google.android.gms.plus.model.moments.ItemScope", link:"reference/com/google/android/gms/plus/model/moments/ItemScope.html", type:"class", deprecated:"false" }, - { id:592, label:"com.google.android.gms.plus.model.moments.ItemScope.Builder", link:"reference/com/google/android/gms/plus/model/moments/ItemScope.Builder.html", type:"class", deprecated:"false" }, - { id:593, label:"com.google.android.gms.plus.model.moments.Moment", link:"reference/com/google/android/gms/plus/model/moments/Moment.html", type:"class", deprecated:"false" }, - { id:594, label:"com.google.android.gms.plus.model.moments.Moment.Builder", link:"reference/com/google/android/gms/plus/model/moments/Moment.Builder.html", type:"class", deprecated:"false" }, - { id:595, label:"com.google.android.gms.plus.model.moments.MomentBuffer", link:"reference/com/google/android/gms/plus/model/moments/MomentBuffer.html", type:"class", deprecated:"false" }, - { id:596, label:"com.google.android.gms.plus.model.people", link:"reference/com/google/android/gms/plus/model/people/package-summary.html", type:"package", deprecated:"false" }, - { id:597, label:"com.google.android.gms.plus.model.people.Person", link:"reference/com/google/android/gms/plus/model/people/Person.html", type:"class", deprecated:"false" }, - { id:598, label:"com.google.android.gms.plus.model.people.Person.AgeRange", link:"reference/com/google/android/gms/plus/model/people/Person.AgeRange.html", type:"class", deprecated:"false" }, - { id:599, label:"com.google.android.gms.plus.model.people.Person.Cover", link:"reference/com/google/android/gms/plus/model/people/Person.Cover.html", type:"class", deprecated:"false" }, - { id:600, label:"com.google.android.gms.plus.model.people.Person.Cover.CoverInfo", link:"reference/com/google/android/gms/plus/model/people/Person.Cover.CoverInfo.html", type:"class", deprecated:"false" }, - { id:601, label:"com.google.android.gms.plus.model.people.Person.Cover.CoverPhoto", link:"reference/com/google/android/gms/plus/model/people/Person.Cover.CoverPhoto.html", type:"class", deprecated:"false" }, - { id:602, label:"com.google.android.gms.plus.model.people.Person.Cover.Layout", link:"reference/com/google/android/gms/plus/model/people/Person.Cover.Layout.html", type:"class", deprecated:"false" }, - { id:603, label:"com.google.android.gms.plus.model.people.Person.Gender", link:"reference/com/google/android/gms/plus/model/people/Person.Gender.html", type:"class", deprecated:"false" }, - { id:604, label:"com.google.android.gms.plus.model.people.Person.Image", link:"reference/com/google/android/gms/plus/model/people/Person.Image.html", type:"class", deprecated:"false" }, - { id:605, label:"com.google.android.gms.plus.model.people.Person.Name", link:"reference/com/google/android/gms/plus/model/people/Person.Name.html", type:"class", deprecated:"false" }, - { id:606, label:"com.google.android.gms.plus.model.people.Person.ObjectType", link:"reference/com/google/android/gms/plus/model/people/Person.ObjectType.html", type:"class", deprecated:"false" }, - { id:607, label:"com.google.android.gms.plus.model.people.Person.Organizations", link:"reference/com/google/android/gms/plus/model/people/Person.Organizations.html", type:"class", deprecated:"false" }, - { id:608, label:"com.google.android.gms.plus.model.people.Person.Organizations.Type", link:"reference/com/google/android/gms/plus/model/people/Person.Organizations.Type.html", type:"class", deprecated:"false" }, - { id:609, label:"com.google.android.gms.plus.model.people.Person.PlacesLived", link:"reference/com/google/android/gms/plus/model/people/Person.PlacesLived.html", type:"class", deprecated:"false" }, - { id:610, label:"com.google.android.gms.plus.model.people.Person.RelationshipStatus", link:"reference/com/google/android/gms/plus/model/people/Person.RelationshipStatus.html", type:"class", deprecated:"false" }, - { id:611, label:"com.google.android.gms.plus.model.people.Person.Urls", link:"reference/com/google/android/gms/plus/model/people/Person.Urls.html", type:"class", deprecated:"false" }, - { id:612, label:"com.google.android.gms.plus.model.people.Person.Urls.Type", link:"reference/com/google/android/gms/plus/model/people/Person.Urls.Type.html", type:"class", deprecated:"false" }, - { id:613, label:"com.google.android.gms.plus.model.people.PersonBuffer", link:"reference/com/google/android/gms/plus/model/people/PersonBuffer.html", type:"class", deprecated:"false" }, - { id:614, label:"com.google.android.gms.safetynet", link:"reference/com/google/android/gms/safetynet/package-summary.html", type:"package", deprecated:"false" }, - { id:615, label:"com.google.android.gms.safetynet.SafetyNet", link:"reference/com/google/android/gms/safetynet/SafetyNet.html", type:"class", deprecated:"false" }, - { id:616, label:"com.google.android.gms.safetynet.SafetyNetApi", link:"reference/com/google/android/gms/safetynet/SafetyNetApi.html", type:"class", deprecated:"false" }, - { id:617, label:"com.google.android.gms.safetynet.SafetyNetApi.AttestationResult", link:"reference/com/google/android/gms/safetynet/SafetyNetApi.AttestationResult.html", type:"class", deprecated:"false" }, - { id:618, label:"com.google.android.gms.search", link:"reference/com/google/android/gms/search/package-summary.html", type:"package", deprecated:"false" }, - { id:619, label:"com.google.android.gms.search.GoogleNowAuthState", link:"reference/com/google/android/gms/search/GoogleNowAuthState.html", type:"class", deprecated:"false" }, - { id:620, label:"com.google.android.gms.search.SearchAuth", link:"reference/com/google/android/gms/search/SearchAuth.html", type:"class", deprecated:"false" }, - { id:621, label:"com.google.android.gms.search.SearchAuth.StatusCodes", link:"reference/com/google/android/gms/search/SearchAuth.StatusCodes.html", type:"class", deprecated:"false" }, - { id:622, label:"com.google.android.gms.search.SearchAuthApi", link:"reference/com/google/android/gms/search/SearchAuthApi.html", type:"class", deprecated:"false" }, - { id:623, label:"com.google.android.gms.search.SearchAuthApi.GoogleNowAuthResult", link:"reference/com/google/android/gms/search/SearchAuthApi.GoogleNowAuthResult.html", type:"class", deprecated:"false" }, - { id:624, label:"com.google.android.gms.security", link:"reference/com/google/android/gms/security/package-summary.html", type:"package", deprecated:"false" }, - { id:625, label:"com.google.android.gms.security.ProviderInstaller", link:"reference/com/google/android/gms/security/ProviderInstaller.html", type:"class", deprecated:"false" }, - { id:626, label:"com.google.android.gms.security.ProviderInstaller.ProviderInstallListener", link:"reference/com/google/android/gms/security/ProviderInstaller.ProviderInstallListener.html", type:"class", deprecated:"false" }, - { id:627, label:"com.google.android.gms.tagmanager", link:"reference/com/google/android/gms/tagmanager/package-summary.html", type:"package", deprecated:"false" }, - { id:628, label:"com.google.android.gms.tagmanager.Container", link:"reference/com/google/android/gms/tagmanager/Container.html", type:"class", deprecated:"false" }, - { id:629, label:"com.google.android.gms.tagmanager.Container.FunctionCallMacroCallback", link:"reference/com/google/android/gms/tagmanager/Container.FunctionCallMacroCallback.html", type:"class", deprecated:"false" }, - { id:630, label:"com.google.android.gms.tagmanager.Container.FunctionCallTagCallback", link:"reference/com/google/android/gms/tagmanager/Container.FunctionCallTagCallback.html", type:"class", deprecated:"false" }, - { id:631, label:"com.google.android.gms.tagmanager.ContainerHolder", link:"reference/com/google/android/gms/tagmanager/ContainerHolder.html", type:"class", deprecated:"false" }, - { id:632, label:"com.google.android.gms.tagmanager.ContainerHolder.ContainerAvailableListener", link:"reference/com/google/android/gms/tagmanager/ContainerHolder.ContainerAvailableListener.html", type:"class", deprecated:"false" }, - { id:633, label:"com.google.android.gms.tagmanager.DataLayer", link:"reference/com/google/android/gms/tagmanager/DataLayer.html", type:"class", deprecated:"false" }, - { id:634, label:"com.google.android.gms.tagmanager.InstallReferrerReceiver", link:"reference/com/google/android/gms/tagmanager/InstallReferrerReceiver.html", type:"class", deprecated:"false" }, - { id:635, label:"com.google.android.gms.tagmanager.InstallReferrerService", link:"reference/com/google/android/gms/tagmanager/InstallReferrerService.html", type:"class", deprecated:"false" }, - { id:636, label:"com.google.android.gms.tagmanager.PreviewActivity", link:"reference/com/google/android/gms/tagmanager/PreviewActivity.html", type:"class", deprecated:"false" }, - { id:637, label:"com.google.android.gms.tagmanager.TagManager", link:"reference/com/google/android/gms/tagmanager/TagManager.html", type:"class", deprecated:"false" }, - { id:638, label:"com.google.android.gms.wallet", link:"reference/com/google/android/gms/wallet/package-summary.html", type:"package", deprecated:"false" }, - { id:639, label:"com.google.android.gms.wallet.Address", link:"reference/com/google/android/gms/wallet/Address.html", type:"class", deprecated:"true" }, - { id:640, label:"com.google.android.gms.wallet.Cart", link:"reference/com/google/android/gms/wallet/Cart.html", type:"class", deprecated:"false" }, - { id:641, label:"com.google.android.gms.wallet.Cart.Builder", link:"reference/com/google/android/gms/wallet/Cart.Builder.html", type:"class", deprecated:"false" }, - { id:642, label:"com.google.android.gms.wallet.CountrySpecification", link:"reference/com/google/android/gms/wallet/CountrySpecification.html", type:"class", deprecated:"true" }, - { id:643, label:"com.google.android.gms.wallet.EnableWalletOptimizationReceiver", link:"reference/com/google/android/gms/wallet/EnableWalletOptimizationReceiver.html", type:"class", deprecated:"false" }, - { id:644, label:"com.google.android.gms.wallet.FullWallet", link:"reference/com/google/android/gms/wallet/FullWallet.html", type:"class", deprecated:"false" }, - { id:645, label:"com.google.android.gms.wallet.FullWalletRequest", link:"reference/com/google/android/gms/wallet/FullWalletRequest.html", type:"class", deprecated:"false" }, - { id:646, label:"com.google.android.gms.wallet.FullWalletRequest.Builder", link:"reference/com/google/android/gms/wallet/FullWalletRequest.Builder.html", type:"class", deprecated:"false" }, - { id:647, label:"com.google.android.gms.wallet.GiftCardWalletObject", link:"reference/com/google/android/gms/wallet/GiftCardWalletObject.html", type:"class", deprecated:"false" }, - { id:648, label:"com.google.android.gms.wallet.InstrumentInfo", link:"reference/com/google/android/gms/wallet/InstrumentInfo.html", type:"class", deprecated:"false" }, - { id:649, label:"com.google.android.gms.wallet.LineItem", link:"reference/com/google/android/gms/wallet/LineItem.html", type:"class", deprecated:"false" }, - { id:650, label:"com.google.android.gms.wallet.LineItem.Builder", link:"reference/com/google/android/gms/wallet/LineItem.Builder.html", type:"class", deprecated:"false" }, - { id:651, label:"com.google.android.gms.wallet.LineItem.Role", link:"reference/com/google/android/gms/wallet/LineItem.Role.html", type:"class", deprecated:"false" }, - { id:652, label:"com.google.android.gms.wallet.LoyaltyWalletObject", link:"reference/com/google/android/gms/wallet/LoyaltyWalletObject.html", type:"class", deprecated:"false" }, - { id:653, label:"com.google.android.gms.wallet.MaskedWallet", link:"reference/com/google/android/gms/wallet/MaskedWallet.html", type:"class", deprecated:"false" }, - { id:654, label:"com.google.android.gms.wallet.MaskedWallet.Builder", link:"reference/com/google/android/gms/wallet/MaskedWallet.Builder.html", type:"class", deprecated:"false" }, - { id:655, label:"com.google.android.gms.wallet.MaskedWalletRequest", link:"reference/com/google/android/gms/wallet/MaskedWalletRequest.html", type:"class", deprecated:"false" }, - { id:656, label:"com.google.android.gms.wallet.MaskedWalletRequest.Builder", link:"reference/com/google/android/gms/wallet/MaskedWalletRequest.Builder.html", type:"class", deprecated:"false" }, - { id:657, label:"com.google.android.gms.wallet.NotifyTransactionStatusRequest", link:"reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.html", type:"class", deprecated:"false" }, - { id:658, label:"com.google.android.gms.wallet.NotifyTransactionStatusRequest.Builder", link:"reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Builder.html", type:"class", deprecated:"false" }, - { id:659, label:"com.google.android.gms.wallet.NotifyTransactionStatusRequest.Status", link:"reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.html", type:"class", deprecated:"false" }, - { id:660, label:"com.google.android.gms.wallet.NotifyTransactionStatusRequest.Status.Error", link:"reference/com/google/android/gms/wallet/NotifyTransactionStatusRequest.Status.Error.html", type:"class", deprecated:"false" }, - { id:661, label:"com.google.android.gms.wallet.OfferWalletObject", link:"reference/com/google/android/gms/wallet/OfferWalletObject.html", type:"class", deprecated:"false" }, - { id:662, label:"com.google.android.gms.wallet.PaymentInstrumentType", link:"reference/com/google/android/gms/wallet/PaymentInstrumentType.html", type:"class", deprecated:"false" }, - { id:663, label:"com.google.android.gms.wallet.Payments", link:"reference/com/google/android/gms/wallet/Payments.html", type:"class", deprecated:"false" }, - { id:664, label:"com.google.android.gms.wallet.ProxyCard", link:"reference/com/google/android/gms/wallet/ProxyCard.html", type:"class", deprecated:"false" }, - { id:665, label:"com.google.android.gms.wallet.Wallet", link:"reference/com/google/android/gms/wallet/Wallet.html", type:"class", deprecated:"false" }, - { id:666, label:"com.google.android.gms.wallet.Wallet.WalletOptions", link:"reference/com/google/android/gms/wallet/Wallet.WalletOptions.html", type:"class", deprecated:"false" }, - { id:667, label:"com.google.android.gms.wallet.Wallet.WalletOptions.Builder", link:"reference/com/google/android/gms/wallet/Wallet.WalletOptions.Builder.html", type:"class", deprecated:"false" }, - { id:668, label:"com.google.android.gms.wallet.WalletConstants", link:"reference/com/google/android/gms/wallet/WalletConstants.html", type:"class", deprecated:"false" }, - { id:669, label:"com.google.android.gms.wallet.fragment", link:"reference/com/google/android/gms/wallet/fragment/package-summary.html", type:"package", deprecated:"false" }, - { id:670, label:"com.google.android.gms.wallet.fragment.BuyButtonAppearance", link:"reference/com/google/android/gms/wallet/fragment/BuyButtonAppearance.html", type:"class", deprecated:"false" }, - { id:671, label:"com.google.android.gms.wallet.fragment.BuyButtonText", link:"reference/com/google/android/gms/wallet/fragment/BuyButtonText.html", type:"class", deprecated:"false" }, - { id:672, label:"com.google.android.gms.wallet.fragment.Dimension", link:"reference/com/google/android/gms/wallet/fragment/Dimension.html", type:"class", deprecated:"false" }, - { id:673, label:"com.google.android.gms.wallet.fragment.SupportWalletFragment", link:"reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.html", type:"class", deprecated:"false" }, - { id:674, label:"com.google.android.gms.wallet.fragment.SupportWalletFragment.OnStateChangedListener", link:"reference/com/google/android/gms/wallet/fragment/SupportWalletFragment.OnStateChangedListener.html", type:"class", deprecated:"false" }, - { id:675, label:"com.google.android.gms.wallet.fragment.WalletFragment", link:"reference/com/google/android/gms/wallet/fragment/WalletFragment.html", type:"class", deprecated:"false" }, - { id:676, label:"com.google.android.gms.wallet.fragment.WalletFragment.OnStateChangedListener", link:"reference/com/google/android/gms/wallet/fragment/WalletFragment.OnStateChangedListener.html", type:"class", deprecated:"false" }, - { id:677, label:"com.google.android.gms.wallet.fragment.WalletFragmentInitParams", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.html", type:"class", deprecated:"false" }, - { id:678, label:"com.google.android.gms.wallet.fragment.WalletFragmentInitParams.Builder", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentInitParams.Builder.html", type:"class", deprecated:"false" }, - { id:679, label:"com.google.android.gms.wallet.fragment.WalletFragmentMode", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentMode.html", type:"class", deprecated:"false" }, - { id:680, label:"com.google.android.gms.wallet.fragment.WalletFragmentOptions", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.html", type:"class", deprecated:"false" }, - { id:681, label:"com.google.android.gms.wallet.fragment.WalletFragmentOptions.Builder", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentOptions.Builder.html", type:"class", deprecated:"false" }, - { id:682, label:"com.google.android.gms.wallet.fragment.WalletFragmentState", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentState.html", type:"class", deprecated:"false" }, - { id:683, label:"com.google.android.gms.wallet.fragment.WalletFragmentStyle", link:"reference/com/google/android/gms/wallet/fragment/WalletFragmentStyle.html", type:"class", deprecated:"false" }, - { id:684, label:"com.google.android.gms.wallet.fragment.WalletLogoImageType", link:"reference/com/google/android/gms/wallet/fragment/WalletLogoImageType.html", type:"class", deprecated:"false" }, - { id:685, label:"com.google.android.gms.wearable", link:"reference/com/google/android/gms/wearable/package-summary.html", type:"package", deprecated:"false" }, - { id:686, label:"com.google.android.gms.wearable.Asset", link:"reference/com/google/android/gms/wearable/Asset.html", type:"class", deprecated:"false" }, - { id:687, label:"com.google.android.gms.wearable.CapabilityApi", link:"reference/com/google/android/gms/wearable/CapabilityApi.html", type:"class", deprecated:"false" }, - { id:688, label:"com.google.android.gms.wearable.CapabilityApi.AddLocalCapabilityResult", link:"reference/com/google/android/gms/wearable/CapabilityApi.AddLocalCapabilityResult.html", type:"class", deprecated:"false" }, - { id:689, label:"com.google.android.gms.wearable.CapabilityApi.CapabilityListener", link:"reference/com/google/android/gms/wearable/CapabilityApi.CapabilityListener.html", type:"class", deprecated:"false" }, - { id:690, label:"com.google.android.gms.wearable.CapabilityApi.GetAllCapabilitiesResult", link:"reference/com/google/android/gms/wearable/CapabilityApi.GetAllCapabilitiesResult.html", type:"class", deprecated:"false" }, - { id:691, label:"com.google.android.gms.wearable.CapabilityApi.GetCapabilityResult", link:"reference/com/google/android/gms/wearable/CapabilityApi.GetCapabilityResult.html", type:"class", deprecated:"false" }, - { id:692, label:"com.google.android.gms.wearable.CapabilityApi.RemoveLocalCapabilityResult", link:"reference/com/google/android/gms/wearable/CapabilityApi.RemoveLocalCapabilityResult.html", type:"class", deprecated:"false" }, - { id:693, label:"com.google.android.gms.wearable.CapabilityInfo", link:"reference/com/google/android/gms/wearable/CapabilityInfo.html", type:"class", deprecated:"false" }, - { id:694, label:"com.google.android.gms.wearable.Channel", link:"reference/com/google/android/gms/wearable/Channel.html", type:"class", deprecated:"false" }, - { id:695, label:"com.google.android.gms.wearable.Channel.GetInputStreamResult", link:"reference/com/google/android/gms/wearable/Channel.GetInputStreamResult.html", type:"class", deprecated:"false" }, - { id:696, label:"com.google.android.gms.wearable.Channel.GetOutputStreamResult", link:"reference/com/google/android/gms/wearable/Channel.GetOutputStreamResult.html", type:"class", deprecated:"false" }, - { id:697, label:"com.google.android.gms.wearable.ChannelApi", link:"reference/com/google/android/gms/wearable/ChannelApi.html", type:"class", deprecated:"false" }, - { id:698, label:"com.google.android.gms.wearable.ChannelApi.ChannelListener", link:"reference/com/google/android/gms/wearable/ChannelApi.ChannelListener.html", type:"class", deprecated:"false" }, - { id:699, label:"com.google.android.gms.wearable.ChannelApi.CloseReason", link:"reference/com/google/android/gms/wearable/ChannelApi.CloseReason.html", type:"class", deprecated:"false" }, - { id:700, label:"com.google.android.gms.wearable.ChannelApi.OpenChannelResult", link:"reference/com/google/android/gms/wearable/ChannelApi.OpenChannelResult.html", type:"class", deprecated:"false" }, - { id:701, label:"com.google.android.gms.wearable.ChannelIOException", link:"reference/com/google/android/gms/wearable/ChannelIOException.html", type:"class", deprecated:"false" }, - { id:702, label:"com.google.android.gms.wearable.DataApi", link:"reference/com/google/android/gms/wearable/DataApi.html", type:"class", deprecated:"false" }, - { id:703, label:"com.google.android.gms.wearable.DataApi.DataItemResult", link:"reference/com/google/android/gms/wearable/DataApi.DataItemResult.html", type:"class", deprecated:"false" }, - { id:704, label:"com.google.android.gms.wearable.DataApi.DataListener", link:"reference/com/google/android/gms/wearable/DataApi.DataListener.html", type:"class", deprecated:"false" }, - { id:705, label:"com.google.android.gms.wearable.DataApi.DeleteDataItemsResult", link:"reference/com/google/android/gms/wearable/DataApi.DeleteDataItemsResult.html", type:"class", deprecated:"false" }, - { id:706, label:"com.google.android.gms.wearable.DataApi.GetFdForAssetResult", link:"reference/com/google/android/gms/wearable/DataApi.GetFdForAssetResult.html", type:"class", deprecated:"false" }, - { id:707, label:"com.google.android.gms.wearable.DataEvent", link:"reference/com/google/android/gms/wearable/DataEvent.html", type:"class", deprecated:"false" }, - { id:708, label:"com.google.android.gms.wearable.DataEventBuffer", link:"reference/com/google/android/gms/wearable/DataEventBuffer.html", type:"class", deprecated:"false" }, - { id:709, label:"com.google.android.gms.wearable.DataItem", link:"reference/com/google/android/gms/wearable/DataItem.html", type:"class", deprecated:"false" }, - { id:710, label:"com.google.android.gms.wearable.DataItemAsset", link:"reference/com/google/android/gms/wearable/DataItemAsset.html", type:"class", deprecated:"false" }, - { id:711, label:"com.google.android.gms.wearable.DataItemBuffer", link:"reference/com/google/android/gms/wearable/DataItemBuffer.html", type:"class", deprecated:"false" }, - { id:712, label:"com.google.android.gms.wearable.DataMap", link:"reference/com/google/android/gms/wearable/DataMap.html", type:"class", deprecated:"false" }, - { id:713, label:"com.google.android.gms.wearable.DataMapItem", link:"reference/com/google/android/gms/wearable/DataMapItem.html", type:"class", deprecated:"false" }, - { id:714, label:"com.google.android.gms.wearable.MessageApi", link:"reference/com/google/android/gms/wearable/MessageApi.html", type:"class", deprecated:"false" }, - { id:715, label:"com.google.android.gms.wearable.MessageApi.MessageListener", link:"reference/com/google/android/gms/wearable/MessageApi.MessageListener.html", type:"class", deprecated:"false" }, - { id:716, label:"com.google.android.gms.wearable.MessageApi.SendMessageResult", link:"reference/com/google/android/gms/wearable/MessageApi.SendMessageResult.html", type:"class", deprecated:"false" }, - { id:717, label:"com.google.android.gms.wearable.MessageEvent", link:"reference/com/google/android/gms/wearable/MessageEvent.html", type:"class", deprecated:"false" }, - { id:718, label:"com.google.android.gms.wearable.Node", link:"reference/com/google/android/gms/wearable/Node.html", type:"class", deprecated:"false" }, - { id:719, label:"com.google.android.gms.wearable.NodeApi", link:"reference/com/google/android/gms/wearable/NodeApi.html", type:"class", deprecated:"false" }, - { id:720, label:"com.google.android.gms.wearable.NodeApi.GetConnectedNodesResult", link:"reference/com/google/android/gms/wearable/NodeApi.GetConnectedNodesResult.html", type:"class", deprecated:"false" }, - { id:721, label:"com.google.android.gms.wearable.NodeApi.GetLocalNodeResult", link:"reference/com/google/android/gms/wearable/NodeApi.GetLocalNodeResult.html", type:"class", deprecated:"false" }, - { id:722, label:"com.google.android.gms.wearable.NodeApi.NodeListener", link:"reference/com/google/android/gms/wearable/NodeApi.NodeListener.html", type:"class", deprecated:"false" }, - { id:723, label:"com.google.android.gms.wearable.PutDataMapRequest", link:"reference/com/google/android/gms/wearable/PutDataMapRequest.html", type:"class", deprecated:"false" }, - { id:724, label:"com.google.android.gms.wearable.PutDataRequest", link:"reference/com/google/android/gms/wearable/PutDataRequest.html", type:"class", deprecated:"false" }, - { id:725, label:"com.google.android.gms.wearable.Wearable", link:"reference/com/google/android/gms/wearable/Wearable.html", type:"class", deprecated:"false" }, - { id:726, label:"com.google.android.gms.wearable.Wearable.WearableOptions", link:"reference/com/google/android/gms/wearable/Wearable.WearableOptions.html", type:"class", deprecated:"false" }, - { id:727, label:"com.google.android.gms.wearable.Wearable.WearableOptions.Builder", link:"reference/com/google/android/gms/wearable/Wearable.WearableOptions.Builder.html", type:"class", deprecated:"false" }, - { id:728, label:"com.google.android.gms.wearable.WearableListenerService", link:"reference/com/google/android/gms/wearable/WearableListenerService.html", type:"class", deprecated:"false" }, - { id:729, label:"com.google.android.gms.wearable.WearableStatusCodes", link:"reference/com/google/android/gms/wearable/WearableStatusCodes.html", type:"class", deprecated:"false" } - - ]; -- GitLab