From 3c4b4f7c3143701e2e2e1f33c3d4d08701b040d8 Mon Sep 17 00:00:00 2001 From: Robert Ly Date: Fri, 30 Nov 2012 04:02:04 -0800 Subject: [PATCH] docs: gms and gcm javadocs Change-Id: I93fe06983e42cb21d05d020e84cafe31792a9c8e --- docs/html/gcm_navtree_data.js | 9 + docs/html/gms_navtree_data.js | 24 + .../android/gcm/GCMBaseIntentService.html | 5614 +++++++ .../android/gcm/GCMBroadcastReceiver.html | 1546 ++ .../com/google/android/gcm/GCMConstants.html | 2053 +++ .../com/google/android/gcm/GCMRegistrar.html | 1750 +++ .../google/android/gcm/package-summary.html | 664 + .../google/android/gcm/server/Constants.html | 2448 +++ .../gcm/server/InvalidRequestException.html | 1516 ++ .../android/gcm/server/Message.Builder.html | 1424 ++ .../google/android/gcm/server/Message.html | 1432 ++ .../android/gcm/server/MulticastResult.html | 1426 ++ .../android/gcm/server/Result.Builder.html | 1271 ++ .../com/google/android/gcm/server/Result.html | 1278 ++ .../com/google/android/gcm/server/Sender.html | 2142 +++ .../android/gcm/server/package-summary.html | 685 + .../com/google/android/gms/R.attr.html | 1728 +++ .../reference/com/google/android/gms/R.html | 1133 ++ .../com/google/android/gms/R.id.html | 1249 ++ .../com/google/android/gms/R.string.html | 1561 ++ .../com/google/android/gms/R.styleable.html | 1951 +++ .../android/gms/auth/GoogleAuthException.html | 1406 ++ .../android/gms/auth/GoogleAuthUtil.html | 2015 +++ ...oglePlayServicesAvailabilityException.html | 1431 ++ .../auth/UserRecoverableAuthException.html | 1459 ++ .../UserRecoverableNotifiedException.html | 1358 ++ .../android/gms/auth/package-summary.html | 684 + .../android/gms/common/AccountPicker.html | 1156 ++ .../android/gms/common/ConnectionResult.html | 1947 +++ ...layServicesClient.ConnectionCallbacks.html | 891 ++ ...icesClient.OnConnectionFailedListener.html | 845 ++ .../gms/common/GooglePlayServicesClient.html | 1430 ++ ...oglePlayServicesNotAvailableException.html | 1392 ++ .../gms/common/GooglePlayServicesUtil.html | 1683 +++ .../com/google/android/gms/common/Scopes.html | 1078 ++ .../android/gms/common/package-summary.html | 702 + .../google/android/gms/maps/CameraUpdate.html | 1023 ++ .../android/gms/maps/CameraUpdateFactory.html | 1793 +++ .../maps/GoogleMap.CancelableCallback.html | 875 ++ .../gms/maps/GoogleMap.InfoWindowAdapter.html | 924 ++ .../GoogleMap.OnCameraChangeListener.html | 840 ++ .../GoogleMap.OnInfoWindowClickListener.html | 836 + .../maps/GoogleMap.OnMapClickListener.html | 841 ++ .../GoogleMap.OnMapLongClickListener.html | 841 ++ .../maps/GoogleMap.OnMarkerClickListener.html | 843 ++ .../maps/GoogleMap.OnMarkerDragListener.html | 954 ++ .../google/android/gms/maps/GoogleMap.html | 3334 ++++ .../android/gms/maps/GoogleMapOptions.html | 2479 +++ ...ationSource.OnLocationChangedListener.html | 836 + .../android/gms/maps/LocationSource.html | 941 ++ .../google/android/gms/maps/MapFragment.html | 3184 ++++ .../com/google/android/gms/maps/MapView.html | 12545 ++++++++++++++++ .../android/gms/maps/MapsInitializer.html | 1106 ++ .../google/android/gms/maps/Projection.html | 1215 ++ .../android/gms/maps/SupportMapFragment.html | 3041 ++++ .../google/android/gms/maps/UiSettings.html | 1903 +++ .../gms/maps/model/BitmapDescriptor.html | 1026 ++ .../maps/model/BitmapDescriptorFactory.html | 1841 +++ .../maps/model/CameraPosition.Builder.html | 1402 ++ .../gms/maps/model/CameraPosition.html | 2002 +++ .../android/gms/maps/model/GroundOverlay.html | 2174 +++ .../gms/maps/model/GroundOverlayOptions.html | 2699 ++++ .../google/android/gms/maps/model/LatLng.html | 1667 ++ .../gms/maps/model/LatLngBounds.Builder.html | 1219 ++ .../android/gms/maps/model/LatLngBounds.html | 1877 +++ .../google/android/gms/maps/model/Marker.html | 1915 +++ .../android/gms/maps/model/MarkerOptions.html | 2261 +++ .../android/gms/maps/model/Polygon.html | 2140 +++ .../gms/maps/model/PolygonOptions.html | 2376 +++ .../android/gms/maps/model/Polyline.html | 1988 +++ .../gms/maps/model/PolylineOptions.html | 2160 +++ .../maps/model/RuntimeRemoteException.html | 1357 ++ .../google/android/gms/maps/model/Tile.html | 1568 ++ .../android/gms/maps/model/TileOverlay.html | 1547 ++ .../gms/maps/model/TileOverlayOptions.html | 1755 +++ .../android/gms/maps/model/TileProvider.html | 968 ++ .../gms/maps/model/UrlTileProvider.html | 1373 ++ .../android/gms/maps/model/VisibleRegion.html | 1822 +++ .../gms/maps/model/package-summary.html | 754 + .../android/gms/maps/package-summary.html | 741 + .../google/android/gms/package-summary.html | 666 + ...maClient.OnPanoramaInfoLoadedListener.html | 842 ++ .../android/gms/panorama/PanoramaClient.html | 2027 +++ .../android/gms/panorama/package-summary.html | 661 + .../android/gms/plus/GooglePlusUtil.html | 1413 ++ .../google/android/gms/plus/PlusClient.html | 2208 +++ .../PlusOneButton.OnPlusOneClickListener.html | 839 ++ .../android/gms/plus/PlusOneButton.html | 12421 +++++++++++++++ .../android/gms/plus/PlusShare.Builder.html | 1617 ++ .../google/android/gms/plus/PlusShare.html | 1414 ++ .../android/gms/plus/PlusSignInButton.html | 9870 ++++++++++++ .../android/gms/plus/package-summary.html | 688 + docs/html/reference/gcm-packages.html | 628 + docs/html/reference/gms-packages.html | 663 + 94 files changed, 169324 insertions(+) create mode 100644 docs/html/gcm_navtree_data.js create mode 100644 docs/html/gms_navtree_data.js create mode 100644 docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html create mode 100644 docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html create mode 100644 docs/html/reference/com/google/android/gcm/GCMConstants.html create mode 100644 docs/html/reference/com/google/android/gcm/GCMRegistrar.html create mode 100644 docs/html/reference/com/google/android/gcm/package-summary.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Constants.html create mode 100644 docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Message.Builder.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Message.html create mode 100644 docs/html/reference/com/google/android/gcm/server/MulticastResult.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Result.Builder.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Result.html create mode 100644 docs/html/reference/com/google/android/gcm/server/Sender.html create mode 100644 docs/html/reference/com/google/android/gcm/server/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/R.attr.html create mode 100644 docs/html/reference/com/google/android/gms/R.html create mode 100644 docs/html/reference/com/google/android/gms/R.id.html create mode 100644 docs/html/reference/com/google/android/gms/R.string.html create mode 100644 docs/html/reference/com/google/android/gms/R.styleable.html create mode 100644 docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html create mode 100644 docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html create mode 100644 docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html create mode 100644 docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html create mode 100644 docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html create mode 100644 docs/html/reference/com/google/android/gms/auth/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/common/AccountPicker.html create mode 100644 docs/html/reference/com/google/android/gms/common/ConnectionResult.html create mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html create mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html create mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.html create mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html create mode 100644 docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html create mode 100644 docs/html/reference/com/google/android/gms/common/Scopes.html create mode 100644 docs/html/reference/com/google/android/gms/common/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/maps/CameraUpdate.html create mode 100644 docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMap.html create mode 100644 docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html create mode 100644 docs/html/reference/com/google/android/gms/maps/LocationSource.html create mode 100644 docs/html/reference/com/google/android/gms/maps/MapFragment.html create mode 100644 docs/html/reference/com/google/android/gms/maps/MapView.html create mode 100644 docs/html/reference/com/google/android/gms/maps/MapsInitializer.html create mode 100644 docs/html/reference/com/google/android/gms/maps/Projection.html create mode 100644 docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html create mode 100644 docs/html/reference/com/google/android/gms/maps/UiSettings.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLng.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/Marker.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/Polygon.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/Polyline.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/Tile.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/TileProvider.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html create mode 100644 docs/html/reference/com/google/android/gms/maps/model/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/maps/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/panorama/PanoramaClient.OnPanoramaInfoLoadedListener.html create mode 100644 docs/html/reference/com/google/android/gms/panorama/PanoramaClient.html create mode 100644 docs/html/reference/com/google/android/gms/panorama/package-summary.html create mode 100644 docs/html/reference/com/google/android/gms/plus/GooglePlusUtil.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusClient.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusOneButton.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusShare.html create mode 100644 docs/html/reference/com/google/android/gms/plus/PlusSignInButton.html create mode 100644 docs/html/reference/com/google/android/gms/plus/package-summary.html create mode 100644 docs/html/reference/gcm-packages.html create mode 100644 docs/html/reference/gms-packages.html diff --git a/docs/html/gcm_navtree_data.js b/docs/html/gcm_navtree_data.js new file mode 100644 index 000000000000..d3af043a36ea --- /dev/null +++ b/docs/html/gcm_navtree_data.js @@ -0,0 +1,9 @@ +var GCM_NAVTREE_DATA = +[ [ "com.google.android.gcm", "reference/com/google/android/gcm/package-summary.html", [ [ "Classes", null, [ [ "GCMBaseIntentService", "reference/com/google/android/gcm/GCMBaseIntentService.html", null, null ], [ "GCMBroadcastReceiver", "reference/com/google/android/gcm/GCMBroadcastReceiver.html", null, null ], [ "GCMConstants", "reference/com/google/android/gcm/GCMConstants.html", null, null ], [ "GCMRegistrar", "reference/com/google/android/gcm/GCMRegistrar.html", null, null ] ] +, null ] ] +, null ], [ "com.google.android.gcm.server", "reference/com/google/android/gcm/server/package-summary.html", [ [ "Classes", null, [ [ "Constants", "reference/com/google/android/gcm/server/Constants.html", null, null ], [ "Message", "reference/com/google/android/gcm/server/Message.html", [ [ "Builder", "reference/com/google/android/gcm/server/Message.Builder.html", null, null ] ], null ], [ "MulticastResult", "reference/com/google/android/gcm/server/MulticastResult.html", null, null ], [ "Result", "reference/com/google/android/gcm/server/Result.html", [ [ "Builder", "reference/com/google/android/gcm/server/Result.Builder.html", null, null ] ], null ], [ "Sender", "reference/com/google/android/gcm/server/Sender.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "InvalidRequestException", "reference/com/google/android/gcm/server/InvalidRequestException.html", null, null ] ] +, null ] ] +, null ] ] + +; diff --git a/docs/html/gms_navtree_data.js b/docs/html/gms_navtree_data.js new file mode 100644 index 000000000000..26bb8ea3a9f6 --- /dev/null +++ b/docs/html/gms_navtree_data.js @@ -0,0 +1,24 @@ +var GMS_NAVTREE_DATA = +[ [ "com.google.android.gms", "reference/com/google/android/gms/package-summary.html", [ [ "Classes", null, [ [ "R", "reference/com/google/android/gms/R.html", [ [ "attr", "reference/com/google/android/gms/R.attr.html", null, null ], [ "id", "reference/com/google/android/gms/R.id.html", null, null ], [ "string", "reference/com/google/android/gms/R.string.html", null, null ], [ "styleable", "reference/com/google/android/gms/R.styleable.html", null, null ] ], null ] ] +, null ] ] +, null ], [ "com.google.android.gms.auth", "reference/com/google/android/gms/auth/package-summary.html", [ [ "Classes", null, [ [ "GoogleAuthUtil", "reference/com/google/android/gms/auth/GoogleAuthUtil.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "GoogleAuthException", "reference/com/google/android/gms/auth/GoogleAuthException.html", null, null ], [ "GooglePlayServicesAvailabilityException", "reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html", null, null ], [ "UserRecoverableAuthException", "reference/com/google/android/gms/auth/UserRecoverableAuthException.html", null, null ], [ "UserRecoverableNotifiedException", "reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html", null, null ] ] +, null ] ] +, null ], [ "com.google.android.gms.common", "reference/com/google/android/gms/common/package-summary.html", [ [ "Interfaces", null, [ [ "GooglePlayServicesClient", "reference/com/google/android/gms/common/GooglePlayServicesClient.html", [ [ "ConnectionCallbacks", "reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html", null, null ], [ "OnConnectionFailedListener", "reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html", null, null ] ], null ] ] +, null ], [ "Classes", null, [ [ "AccountPicker", "reference/com/google/android/gms/common/AccountPicker.html", null, null ], [ "ConnectionResult", "reference/com/google/android/gms/common/ConnectionResult.html", null, null ], [ "GooglePlayServicesUtil", "reference/com/google/android/gms/common/GooglePlayServicesUtil.html", null, null ], [ "Scopes", "reference/com/google/android/gms/common/Scopes.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "GooglePlayServicesNotAvailableException", "reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html", null, null ] ] +, null ] ] +, null ], [ "com.google.android.gms.maps", "reference/com/google/android/gms/maps/package-summary.html", [ [ "Interfaces", null, [ [ "LocationSource", "reference/com/google/android/gms/maps/LocationSource.html", [ [ "OnLocationChangedListener", "reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html", null, null ] ], null ] ] +, null ], [ "Classes", null, [ [ "CameraUpdate", "reference/com/google/android/gms/maps/CameraUpdate.html", null, null ], [ "CameraUpdateFactory", "reference/com/google/android/gms/maps/CameraUpdateFactory.html", null, null ], [ "GoogleMap", "reference/com/google/android/gms/maps/GoogleMap.html", [ [ "CancelableCallback", "reference/com/google/android/gms/maps/CancelableCallback.html", null, null ], [ "InfoWindowAdapter", "reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html", null, null ], [ "OnCameraChangeListener", "reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html", null, null ], [ "OnInfoWindowClickListener", "reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html", null, null ], [ "OnMapClickListener", "reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html", null, null ], [ "OnMapLongClickListener", "reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html", null, null ], [ "OnMarkerClickListener", "reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html", null, null ], [ "OnMarkerDragListener", "reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html", null, null ] ], null ], [ "GoogleMapOptions", "reference/com/google/android/gms/maps/GoogleMapOptions.html", null, null ], [ "MapFragment", "reference/com/google/android/gms/maps/MapFragment.html", null, null ], [ "MapsInitializer", "reference/com/google/android/gms/maps/MapsInitializer.html", null, null ], [ "MapView", "reference/com/google/android/gms/maps/MapView.html", null, null ], [ "Projection", "reference/com/google/android/gms/maps/Projection.html", null, null ], [ "SupportMapFragment", "reference/com/google/android/gms/maps/SupportMapFragment.html", null, null ], [ "UiSettings", "reference/com/google/android/gms/maps/UiSettings.html", null, null ] ] +, null ] ] +, null ], [ "com.google.android.gms.maps.model", "reference/com/google/android/gms/maps/model/package-summary.html", [ [ "Interfaces", null, [ [ "TileProvider", "reference/com/google/android/gms/maps/model/TileProvider.html", null, null ] ] +, null ], [ "Classes", null, [ [ "BitmapDescriptor", "reference/com/google/android/gms/maps/model/BitmapDescriptor.html", null, null ], [ "BitmapDescriptorFactory", "reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html", null, null ], [ "CameraPosition", "reference/com/google/android/gms/maps/model/CameraPosition.html", [ [ "Builder", "reference/com/google/android/gms/maps/model/CameraPosition.Builder.html", null, null ]], null ], [ "GroundOverlay", "reference/com/google/android/gms/maps/model/GroundOverlay.html", null, null ], [ "GroundOverlayOptions", "reference/com/google/android/gms/maps/model/GroundOverlayOptions.html", null, null ], [ "LatLng", "reference/com/google/android/gms/maps/model/LatLng.html", null, null ], [ "LatLngBounds", "reference/com/google/android/gms/maps/model/LatLngBounds.html", [ [ "Builder", "reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html", null, null ] ], null ], [ "Marker", "reference/com/google/android/gms/maps/model/Marker.html", null, null ], [ "MarkerOptions", "reference/com/google/android/gms/maps/model/MarkerOptions.html", null, null ], [ "Polygon", "reference/com/google/android/gms/maps/model/Polygon.html", null, null ], [ "PolygonOptions", "reference/com/google/android/gms/maps/model/PolygonOptions.html", null, null ], [ "Polyline", "reference/com/google/android/gms/maps/model/Polyline.html", null, null ], [ "PolylineOptions", "reference/com/google/android/gms/maps/model/PolylineOptions.html", null, null ], [ "Tile", "reference/com/google/android/gms/maps/model/Tile.html", null, null ], [ "TileOverlay", "reference/com/google/android/gms/maps/model/TileOverlay.html", null, null ], [ "TileOverlayOptions", "reference/com/google/android/gms/maps/model/TileOverlayOptions.html", null, null ], [ "UrlTileProvider", "reference/com/google/android/gms/maps/model/UrlTileProvider.html", null, null ], [ "VisibleRegion", "reference/com/google/android/gms/maps/model/VisibleRegion.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "RuntimeRemoteException", "reference/com/google/android/gms/maps/model/RuntimeRemoteException.html", null, null ] ] +, null ] ] +, null ], [ "com.google.android.gms.panorama", "reference/com/google/android/gms/panorama/package-summary.html", [ [ "Classes", null, [ [ "PanoramaClient", "reference/com/google/android/gms/panorama/PanoramaClient.html", [ [ "OnPanoramaInfoLoadedListener", "reference/com/google/android/gms/panorama/PanoramaClient.OnPanoramaInfoLoadedListener.html", null, null ] ], null ] ] +, null ] ] +, null ], [ "com.google.android.gms.plus", "reference/com/google/android/gms/plus/package-summary.html", [ [ "Classes", null, [ [ "GooglePlusUtil", "reference/com/google/android/gms/plus/GooglePlusUtil.html", null, null ], [ "PlusClient", "reference/com/google/android/gms/plus/PlusClient.html", null, null ], [ "PlusOneButton", "reference/com/google/android/gms/plus/PlusOneButton.html", [ [ "OnPlusOneClickListener", "reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html", null, null ] ], null ], [ "PlusShare", "reference/com/google/android/gms/plus/PlusShare.html", [ [ "Builder", "reference/com/google/android/gms/plus/PlusShare.Builder.html", null, null ] ], null ], [ "PlusSignInButton", "reference/com/google/android/gms/plus/PlusSignInButton.html", null, null ] ] +, null ] ] +, null ] ] + +; diff --git a/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html new file mode 100644 index 000000000000..27348d193617 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/GCMBaseIntentService.html @@ -0,0 +1,5614 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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
+ + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..7da9181b86a9 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/GCMBroadcastReceiver.html @@ -0,0 +1,1546 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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
+ + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..70c06a3b9890 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/GCMConstants.html @@ -0,0 +1,2053 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GCMConstants | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + final + + class +

GCMConstants

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

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 {@value #INTENT_TO_GCM_REGISTRATION} to get the + application info.
StringEXTRA_ERRORExtra used on {@value #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate + an error when the registration fails.
StringEXTRA_FROMExtra used on {@value #INTENT_FROM_GCM_MESSAGE} to indicate which + sender (Google API project id) sent the message.
StringEXTRA_REGISTRATION_IDExtra used on {@value #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate + the registration id when the registration succeeds.
StringEXTRA_SENDERExtra used on {@value #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 {@value #INTENT_FROM_GCM_MESSAGE} intent.
StringEXTRA_TOTAL_DELETEDNumber of messages deleted by the server because the device was idle.
StringEXTRA_UNREGISTEREDExtra used on {@value #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 {@value #INTENT_TO_GCM_REGISTRATION} to get the + application info. +

+ + +
+ Constant Value: + + + "app" + + +
+ +
+
+ + + + + +
+

+ + public + static + final + String + + EXTRA_ERROR +

+
+ + + + +
+
+ +

Extra used on {@value #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 {@value #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 {@value #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 {@value #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 {@value #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 + {@value #VALUE_DELETED_MESSAGES} +

+ + +
+ Constant Value: + + + "total_deleted" + + +
+ +
+
+ + + + + +
+

+ + public + static + final + String + + EXTRA_UNREGISTERED +

+
+ + + + +
+
+ +

Extra used on {@value #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 new file mode 100644 index 000000000000..f300ace9b040 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/GCMRegistrar.html @@ -0,0 +1,1750 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GCMRegistrar | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + final + + class +

GCMRegistrar

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

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 + {@value com.google.android.gcm.GCMConstants#PERMISSION_GCM_INTENTS} + permission. +
  4. The BroadcastReceiver(s) handles the 2 GCM intents + ({@value com.google.android.gcm.GCMConstants#INTENT_FROM_GCM_MESSAGE} + and + {@value 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 new file mode 100644 index 000000000000..0f454f9b1ef8 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/package-summary.html @@ -0,0 +1,664 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gcm | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gcm

+
+ +
+ +
+ + + + + + + + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + +
GCMBaseIntentServiceSkeleton for application-specific IntentServices responsible for + handling communication from Google Cloud Messaging service. 
GCMBroadcastReceiverBroadcastReceiver that receives GCM messages and delivers them to + an application-specific GCMBaseIntentService subclass. 
GCMConstantsConstants used by the GCM library. 
GCMRegistrarUtilities for device registration. 
+
+ + + + + + + + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gcm/server/Constants.html b/docs/html/reference/com/google/android/gcm/server/Constants.html new file mode 100644 index 000000000000..9cebefa93fdb --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Constants.html @@ -0,0 +1,2448 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..793d92cd2ba9 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/InvalidRequestException.html @@ -0,0 +1,1516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..737ab79f3d26 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Message.Builder.html @@ -0,0 +1,1424 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..edab9702f919 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Message.html @@ -0,0 +1,1432 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.html b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html new file mode 100644 index 000000000000..efd5c787236c --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/MulticastResult.html @@ -0,0 +1,1426 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +MulticastResult | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + + + + + + + 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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 new file mode 100644 index 000000000000..79f458166e81 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Result.Builder.html @@ -0,0 +1,1271 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..8289a10dde99 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Result.html @@ -0,0 +1,1278 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..94b9428d57a0 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/Sender.html @@ -0,0 +1,2142 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..67f82c061949 --- /dev/null +++ b/docs/html/reference/com/google/android/gcm/server/package-summary.html @@ -0,0 +1,685 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gcm.server | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gcm.server

+
+ +
+ +
+ + + + + + + + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ConstantsConstants used on GCM service communication. 
MessageGCM message. 
Message.Builder 
MulticastResultResult of a GCM multicast message request . 
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 new file mode 100644 index 000000000000..8a4e0b70ca43 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/R.attr.html @@ -0,0 +1,1728 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + + 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 + + intmapType

Must be one of the following constant values.

+ public + static + + intuiCompass

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 + + 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 + + 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 + + mapType +

+
+ + + + +
+
+ +

Must be one of the following constant values.

+ ++++ + + + + +
ConstantValueDescription
none0
normal1
satellite2
terrain3
+

+ + +
+
+ + + + + +
+

+ + 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 + + 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 + + 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.html b/docs/html/reference/com/google/android/gms/R.html new file mode 100644 index 000000000000..f93ba59ed559 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/R.html @@ -0,0 +1,1133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.id 
+ + + + + classR.string 
+ + + + + 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 new file mode 100644 index 000000000000..86311b68b0fe --- /dev/null +++ b/docs/html/reference/com/google/android/gms/R.id.html @@ -0,0 +1,1249 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + + intnone
+ public + static + + intnormal
+ public + static + + intsatellite
+ public + static + + intterrain
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + R.id() + +
+ + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + + int + + none +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + normal +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + satellite +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + terrain +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + R.id + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/R.string.html b/docs/html/reference/com/google/android/gms/R.string.html new file mode 100644 index 000000000000..46e469073a82 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/R.string.html @@ -0,0 +1,1561 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + + intcommon_google_play_services_enable_buttonButton in confirmation dialog to enable Google Play services.
+ public + static + + intcommon_google_play_services_enable_textMessage in confirmation dialog informing user they need to enable + Google Play services in application settings [CHAR LIMIT=NONE] +
+ public + static + + intcommon_google_play_services_enable_titleTitle of confirmation dialog informing user they need to enable + Google Play services in application settings [CHAR LIMIT=40] +
+ public + static + + intcommon_google_play_services_install_buttonButton in confirmation dialog for installing Google Play services [CHAR LIMIT=30] +
+ public + static + + intcommon_google_play_services_install_text_phone(For phones) Message in confirmation dialog informing user that + they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE] +
+ public + static + + intcommon_google_play_services_install_text_tablet(For tablets) Message in confirmation dialog informing user that + they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE] +
+ public + static + + intcommon_google_play_services_install_titleTitle of confirmation dialog informing user that they need to install + Google Play services (from Play Store) [CHAR LIMIT=40] +
+ public + static + + intcommon_google_play_services_unknown_issueMessage in confirmation dialog informing user there is an unknow issue in Google Player + services [CHAR LIMIT=NONE] +
+ public + static + + intcommon_google_play_services_update_buttonButton in confirmation dialog for updating Google Play services [CHAR LIMIT=20] +
+ public + static + + intcommon_google_play_services_update_textMessage in confirmation dialog informing user that they need to update + Google Play services (from Play Store) [CHAR LIMIT=NONE] +
+ public + static + + intcommon_google_play_services_update_titleTitle of confirmation dialog informing user that they need to update + Google Play services (from Play Store) [CHAR LIMIT=40] +
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + R.string() + +
+ + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + + int + + common_google_play_services_enable_button +

+
+ + + + +
+
+ +

Button in confirmation dialog to enable Google Play services. Clicking it + will direct user to application settings of Google Play services where they + can enable it [CHAR LIMIT=30] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_enable_text +

+
+ + + + +
+
+ +

Message in confirmation dialog informing user they need to enable + Google Play services in application settings [CHAR LIMIT=NONE] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_enable_title +

+
+ + + + +
+
+ +

Title of confirmation dialog informing user they need to enable + Google Play services in application settings [CHAR LIMIT=40] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_install_button +

+
+ + + + +
+
+ +

Button in confirmation dialog for installing Google Play services [CHAR LIMIT=30] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_install_text_phone +

+
+ + + + +
+
+ +

(For phones) Message in confirmation dialog informing user that + they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_install_text_tablet +

+
+ + + + +
+
+ +

(For tablets) Message in confirmation dialog informing user that + they need to install Google Play services (from Play Store) [CHAR LIMIT=NONE] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_install_title +

+
+ + + + +
+
+ +

Title of confirmation dialog informing user that they need to install + Google Play services (from Play Store) [CHAR LIMIT=40] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_unknown_issue +

+
+ + + + +
+
+ +

Message in confirmation dialog informing user there is an unknow issue in Google Player + services [CHAR LIMIT=NONE] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_update_button +

+
+ + + + +
+
+ +

Button in confirmation dialog for updating Google Play services [CHAR LIMIT=20] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_update_text +

+
+ + + + +
+
+ +

Message in confirmation dialog informing user that they need to update + Google Play services (from Play Store) [CHAR LIMIT=NONE] +

+ + +
+
+ + + + + +
+

+ + public + static + + int + + common_google_play_services_update_title +

+
+ + + + +
+
+ +

Title of confirmation dialog informing user that they need to update + Google Play services (from Play Store) [CHAR LIMIT=40] +

+ + +
+
+ + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + R.string + () +

+
+
+ + + +
+
+ +

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

R.styleable

+ + + + + extends Object
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gms.R.styleable
+ + + + + + + +
+ + + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intMapAttrs_cameraBearing

This symbol is the offset where the cameraBearing + attribute's value can be found in the MapAttrs array.

intMapAttrs_cameraTargetLat

This symbol is the offset where the cameraTargetLat + attribute's value can be found in the MapAttrs array.

intMapAttrs_cameraTargetLng

This symbol is the offset where the cameraTargetLng + attribute's value can be found in the MapAttrs array.

intMapAttrs_cameraTilt

This symbol is the offset where the cameraTilt + attribute's value can be found in the MapAttrs array.

intMapAttrs_cameraZoom

This symbol is the offset where the cameraZoom + attribute's value can be found in the MapAttrs array.

intMapAttrs_mapType

This symbol is the offset where the mapType + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiCompass

This symbol is the offset where the uiCompass + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiRotateGestures

This symbol is the offset where the uiRotateGestures + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiScrollGestures

This symbol is the offset where the uiScrollGestures + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiTiltGestures

This symbol is the offset where the uiTiltGestures + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiZoomControls

This symbol is the offset where the uiZoomControls + attribute's value can be found in the MapAttrs array.

intMapAttrs_uiZoomGestures

This symbol is the offset where the uiZoomGestures + attribute's value can be found in the MapAttrs array.

intMapAttrs_useViewLifecycle

This symbol is the offset where the useViewLifecycle + attribute's value can be found in the MapAttrs array.

intMapAttrs_zOrderOnTop

This symbol is the offset where the zOrderOnTop + attribute's value can be found in the MapAttrs array.

+ + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + int[]MapAttrsAttributes that can be used with a MapAttrs.
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + R.styleable() + +
+ + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 1 + (0x00000001) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 2 + (0x00000002) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 3 + (0x00000003) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 4 + (0x00000004) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 5 + (0x00000005) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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

+ + +
+ Constant Value: + + + 0 + (0x00000000) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 6 + (0x00000006) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 7 + (0x00000007) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 8 + (0x00000008) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 9 + (0x00000009) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 10 + (0x0000000a) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 11 + (0x0000000b) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 12 + (0x0000000c) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + 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.

+ + +
+ Constant Value: + + + 13 + (0x0000000d) + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + 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:mapType
com.google.android.gms:uiCompass
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 Constructors

+ + + + + +
+

+ + public + + + + + + + R.styleable + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html b/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html new file mode 100644 index 000000000000..d65cf3e4f094 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/GoogleAuthException.html @@ -0,0 +1,1406 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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(String err) + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Throwable + +
+ + +
+
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + GoogleAuthException + (String err) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html b/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html new file mode 100644 index 000000000000..9e80b88048ae --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/GoogleAuthUtil.html @@ -0,0 +1,2015 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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, String, String)(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
StringGOOGLE_ACCOUNT_TYPE
StringKEY_HANDLE_NOTIFICATION
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + static + + String + + getToken(Context context, String accountName, String scope) + +
Authenticates the user and returns a valid Google authentication token, + or throws an exception if there was an error getting a token.
+ +
+ + + + static + + String + + getToken(Context context, String accountName, 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, String accountName, 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, String accountName, 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 + + String + + getTokenWithNotification(Context context, String accountName, 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 + + void + + invalidateToken(Context context, String token) + +
Invalidates the specified token with respect to the Context.
+ +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + GOOGLE_ACCOUNT_TYPE +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "com.google" + + +
+ +
+
+ + + + + +
+

+ + public + static + final + String + + KEY_HANDLE_NOTIFICATION +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "handle_notification" + + +
+ +
+
+ + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + static + + + + String + + getToken + (Context context, String accountName, String scope) +

+
+
+ + + +
+
+ +

Authenticates the user and returns a valid Google authentication token, + or throws an exception if there was an error getting a token. +

+ The exception thrown depends upon the underlying error and support for + recovery. 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 from programmatically. Some + may be fatal errors stemming from implementation errors while others may + require user intervention. UserRecoverableAuthExceptions are + GoogleAuthExceptions that provide Intents which can be used to + initiate any user intervention required to fix the underlying error. For + example, a UserRecoverableAuthExceptions intent might lead to a request + for a user's consent or present the user with a device policy manager + download screen. GooglePlayServicesAvailabilityExceptions are + UserRecoverableAuthExceptions along with a connection status code which + allows clients to create a localized Dialog using + getErrorDialog(int, android.app.Activity, int). + Finally, this method is blocking and shouldn't be called in the main + event thread. If so an IllegalStateException will be thrown. +

+ Which exceptions should be handled and how depends on the context of the + code. For example in the case of an Activity where + the user is actively engaged: + + 

+ String token;
+ try {
+     token = GoogleAuthUtil.getToken(context, accountName, scope);
+ } catch (GooglePlayServicesAvailabilityException playEx) {
+     Dialog dialog = GooglePlayServicesUtil.getErrorDialog(
+         playEx.getConnectionStatusCode(),
+         Activity.this,
+         AUTH_REQUEST_CODE);
+     // Use the dialog to present to the user.
+ } catch (UserRecoverableAutException recoverableException) {
+     Intent recoveryIntent = recoverableException.getIntent();
+     // Use the intent in a custom dialog or just startActivityForResult.
+ } catch (GoogleAuthException authEx) {
+     // This is likely unrecoverable.
+     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMesssage(), authEx);
+ } catch (IOException ioEx) {
+     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
+     doExponentialBackoff();
+ }
+
+ + On the other hand, explicitly handling a + GooglePlayServicesAvailabilityException in the absence of a UI + thread may not be worthwhile. Instead a Notification + may be preferable. + + 
+ String token;
+ try {
+     token = GoogleAuthUtil.getToken(context, accountName, scope);
+ } catch (UserRecoverableAuthException recoverableException) {
+     Intent recoveryIntent = recoverableException.getIntent();
+     // Use the intent to create a Notification.
+ } 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.
+
+
+
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.
IllegalArgumentException + if the method is invoked in the main + event thread. +
+
+ +
+
+ + + + +
+

+ + public + static + + + + String + + getToken + (Context context, String accountName, 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. +

+ The exception thrown depends upon the underlying error and support for + recovery. 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 from programmatically. Some + may be fatal errors stemming from implementation errors while others may + require user intervention. UserRecoverableAuthExceptions are + GoogleAuthExceptions that provide Intents which can be used to + initiate any user intervention required to fix the underlying error. For + example, a UserRecoverableAuthExceptions intent might lead to a request + for a user's consent or present the user with a device policy manager + download screen. GooglePlayServicesAvailabilityExceptions are + UserRecoverableAuthExceptions along with a connection status code which + allows clients to create a localized Dialog using + getErrorDialog(int, android.app.Activity, int). + Finally, this method is blocking and shouldn't be called in the main + event thread. If so an IllegalStateException will be thrown. +

+ Which exceptions should be handled and how depends on the context of the + code. For example in the case of an Activity where + the user is actively engaged: + + 

+ String token;
+ 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 (UserRecoverableAutException recoverableException) {
+     Intent recoveryIntent = recoverableException.getIntent();
+     // Use the intent in a custom dialog or just startActivityForResult.
+ } catch (GoogleAuthException authEx) {
+     // This is likely unrecoverable.
+     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMesssage(), authEx);
+ } catch (IOException ioEx) {
+     Log.i(TAG, "transient error encountered: " + ioEx.getMessage());
+     doExponentialBackoff();
+ }
+
+ + On the other hand, explicitly handling a + GooglePlayServicesAvailabilityException in the absence of a UI + thread may not be worthwhile. Instead a Notification + may be preferable. + + 
+ String token;
+ try {
+     token = GoogleAuthUtil.getToken(context, accountName, scope, bundle);
+ } catch (UserRecoverableAutException recoverableException) {
+     Intent recoveryIntent = recoverableException.getIntent();
+     // Use the intent to create a Notification.
+ } catch (GoogleAuthException authEx) {
+     // This is likely unrecoverable.
+     Log.e(TAG, "Unrecoverable authentication exception: " + authEx.getMesssage(), 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.
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.
IllegalArgumentException + if the method is invoked in the main + event thread. +
+
+ +
+
+ + + + +
+

+ + public + static + + + + String + + getTokenWithNotification + (Context context, String accountName, 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.getToken(context, accountName, scope, callback, bundle);
+ } 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.getMesssage(), 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.
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.
IllegalArgumentException + if the method is invoked in the main + event thread. +
+
+ +
+
+ + + + +
+

+ + public + static + + + + String + + getTokenWithNotification + (Context context, String accountName, 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.getToken(context, accountName, scope, callback, bundle);
+ } 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.getMesssage(), 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.
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.
IllegalArgumentException + 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) +

+
+
+ + + +
+
+ +

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.getToken(
+         context, accountName, scope, authority, syncBundle, bundle);
+ } 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.getMesssage(), 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.
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.
IllegalArgumentException + if the method is invoked in the main + event thread. +
+
+ +
+
+ + + + +
+

+ + public + static + + + + void + + invalidateToken + (Context context, String token) +

+
+
+ + + +
+
+ +

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 new file mode 100644 index 000000000000..3851a27ca374 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/GooglePlayServicesAvailabilityException.html @@ -0,0 +1,1431 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..8d13e6cf1df3 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/UserRecoverableAuthException.html @@ -0,0 +1,1459 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..21beabea1f33 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/UserRecoverableNotifiedException.html @@ -0,0 +1,1358 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..77b3d348f5c6 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/auth/package-summary.html @@ -0,0 +1,684 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.auth | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.auth

+
+ +
+ +
+ + +
+ Contains classes for authenticating Google accounts. + +
+ + + + + + + + + +

Classes

+
+ + + + + + +
GoogleAuthUtilGoogleAuthUtil provides static utility methods to acquire and invalidate + authentication tokens. 
+
+ + + + + + + +

Exceptions

+
+ + + + + + + + + + + + + + + + + + +
GoogleAuthExceptionGoogleAuthExceptions signal Google authentication errors. 
GooglePlayServicesAvailabilityExceptionGooglePlayServicesAvailabilityExceptions are special instances of + UserRecoverableAuthExceptions which are thrown when the expected Google Play services app + is not available for some reason. 
UserRecoverableAuthExceptionUserRecoverableAuthExceptions signal Google authentication errors that can be recovered with user + action, such as a user login. 
UserRecoverableNotifiedExceptionUserRecoverableNotifiedException 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/common/AccountPicker.html b/docs/html/reference/com/google/android/gms/common/AccountPicker.html new file mode 100644 index 000000000000..dd3a4fe2481f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/AccountPicker.html @@ -0,0 +1,1156 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 use 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 new file mode 100644 index 000000000000..f24a61643d0f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/ConnectionResult.html @@ -0,0 +1,1947 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +ConnectionResult | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + | Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + final + + class +

ConnectionResult

+ + + + + extends Object
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
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 GooglePlayServicesClient.OnConnectionFailedListener. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intDEVELOPER_ERRORThe application is misconfigured.
intINTERNAL_ERRORAn internal error occurred.
intINVALID_ACCOUNTThe client attempted to connect to the service with an invalid account name + specified.
intNETWORK_ERRORA network error occurred.
intRESOLUTION_REQUIREDCompleting the connection requires some form of resolution.
intSERVICE_DISABLEDThe installed version of Google Play services has been disabled on this device.
intSERVICE_INVALIDThe version of the Google Play services installed on this device is not authentic.
intSERVICE_MISSINGGoogle Play services is missing on this device.
intSERVICE_VERSION_UPDATE_REQUIREDThe installed version of Google Play services is out of date.
intSIGN_IN_REQUIREDThe client attempted to connect to the service but the user is not + signed in.
intSUCCESSThe connection was successful.
+ + + + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + ConnectionResult(int statusCode, PendingIntent pendingIntent) + +
Creates a connection result.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + 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.
+ +
+ + + + + + 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.
+ +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + 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 + + INVALID_ACCOUNT +

+
+ + + + +
+
+ +

The client attempted to connect to the service with an invalid account name + specified. +

+ + +
+ Constant Value: + + + 5 + (0x00000005) + + +
+ +
+
+ + + + + +
+

+ + 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_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 connection was successful. +

+ + +
+ Constant Value: + + + 0 + (0x00000000) + + +
+ +
+
+ + + + + + + + + + + +

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 + + 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 + + + + + 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. +
+
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html new file mode 100644 index 000000000000..add4e3dee52f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.ConnectionCallbacks.html @@ -0,0 +1,891 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GooglePlayServicesClient.ConnectionCallbacks | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + +
+ +
+
+ + + + +
+
+ + + + +
+ public + static + + + interface +

GooglePlayServicesClient.ConnectionCallbacks

+ + + + + + + + +
+ +
+ +
+ + + + + + + + + +
com.google.android.gms.common.GooglePlayServicesClient.ConnectionCallbacks
+ + + + + + + +
+ + +

Class Overview

+

Provides callbacks that are called when the client is + connected or disconnected from the service. Most applications + implement onConnected() to + start making requests. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ abstract + + + + + void + + onConnected() + +
After calling connect(), this method will be + invoked asynchronously when the connect request has successfully + completed.
+ +
+ abstract + + + + + void + + onDisconnected() + +
Called when the client is disconnected.
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + abstract + + void + + onConnected + () +

+
+
+ + + +
+
+ +

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. +

+ +
+
+ + + + +
+

+ + public + + + abstract + + void + + onDisconnected + () +

+
+
+ + + +
+
+ +

Called when the client is disconnected. 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. Applications should disable UI components that require + the service, and wait for a call to onConnected() to + re-enable them. +

+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html new file mode 100644 index 000000000000..01f4ffbdf547 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.OnConnectionFailedListener.html @@ -0,0 +1,845 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GooglePlayServicesClient.OnConnectionFailedListener | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + +
+ +
+
+ + + + +
+
+ + + + +
+ public + static + + + interface +

GooglePlayServicesClient.OnConnectionFailedListener

+ + + + + + + + +
+ +
+ +
+ + + + + + + + + +
com.google.android.gms.common.GooglePlayServicesClient.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/GooglePlayServicesClient.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.html new file mode 100644 index 000000000000..09001f72b0d8 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesClient.html @@ -0,0 +1,1430 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GooglePlayServicesClient | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + +
+ +Summary: + + Nested Classes + + + + + + + + + + + + + | Methods + + + + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + + + interface +

GooglePlayServicesClient

+ + + + + + + + +
+ +
+ +
+ + + + + + + + + +
com.google.android.gms.common.GooglePlayServicesClient
+ + + + + + +
+ + Known Indirect Subclasses + +
+ + +
+
+ + +
+ + +

Class Overview

+

+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Nested Classes
+ + + + + interfaceGooglePlayServicesClient.ConnectionCallbacksProvides callbacks that are called when the client is + connected or disconnected from the service. 
+ + + + + interfaceGooglePlayServicesClient.OnConnectionFailedListenerProvides callbacks for scenarios that result in a failed attempt to + connect the client to the service. 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ abstract + + + + + void + + connect() + +
Connects the client to Google Play services.
+ +
+ abstract + + + + + void + + disconnect() + +
Closes the connection to Google Play services.
+ +
+ abstract + + + + + boolean + + isConnected() + +
Checks if the client is currently connected to the service, so that + requests to other methods will succeed.
+ +
+ abstract + + + + + boolean + + isConnectionCallbacksRegistered(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Returns true if the specified listener is currently registered to + receive connection events.
+ +
+ abstract + + + + + boolean + + isConnectionFailedListenerRegistered(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Returns true if the specified listener is currently registered to + receive connection failed events.
+ +
+ abstract + + + + + void + + registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Registers a listener to receive connection events from this GooglePlayServicesClient.
+ +
+ abstract + + + + + void + + registerConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Registers a listener to receive connection failed events from this + GooglePlayServicesClient.
+ +
+ abstract + + + + + void + + unregisterConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Removes a connection listener from this GooglePlayServicesClient.
+ +
+ abstract + + + + + void + + unregisterConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Removes a connection failed listener from the GooglePlayServicesClient.
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + 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() + is called. On a failure, + onConnectionFailed(ConnectionResult) + is called. +

+ +
+
+ + + + +
+

+ + public + + + abstract + + void + + disconnect + () +

+
+
+ + + +
+
+ +

Closes the connection to Google Play services. No calls can be made on this object + after calling this method.

+
+
See Also
+ +
+ +
+
+ + + + +
+

+ + 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 + + isConnectionCallbacksRegistered + (GooglePlayServicesClient.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 + (GooglePlayServicesClient.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 + + registerConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection events from this GooglePlayServicesClient. + If we are already connected, the listener's onConnected() 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() 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 + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection failed events from this + GooglePlayServicesClient. Unlike registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks), if we are 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 + + unregisterConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Removes a connection listener from this GooglePlayServicesClient. 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 + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Removes a connection failed listener from the GooglePlayServicesClient. + 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/GooglePlayServicesNotAvailableException.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html new file mode 100644 index 000000000000..09463d69d527 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesNotAvailableException.html @@ -0,0 +1,1392 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + interrorCodeThe 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/GooglePlayServicesUtil.html b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html new file mode 100644 index 000000000000..07393251d3ec --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/GooglePlayServicesUtil.html @@ -0,0 +1,1683 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GooglePlayServicesUtil | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + + + | 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 + PlusClient or + GoogleAuthUtil connect to the service. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringGOOGLE_PLAY_SERVICES_PACKAGEPackage name for Google Play services.
intGOOGLE_PLAY_SERVICES_VERSION_CODEMinimum Google Play services package version (declared in AndroidManifest.xml + android:versionCode) in order to be compatible with this client version.
StringGOOGLE_PLAY_STORE_PACKAGEPackage name for Google Play services.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + static + + Dialog + + getErrorDialog(int errorCode, Activity activity, int requestCode, DialogInterface.OnCancelListener cancelListener) + +
Returns a dialog to address the provided errorCode.
+ +
+ + + + static + + Dialog + + getErrorDialog(int errorCode, Activity activity, int requestCode) + +
Returns a dialog to address the provided errorCode.
+ +
+ + + + static + + PendingIntent + + getErrorPendingIntent(int errorCode, Context context, int requestCode) + +
Returns a PendingIntent to address the provided errorCode.
+ +
+ + + + static + + 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.
+ +
+ + + + 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) + +
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.
+ +
+ + + + static + + boolean + + isUserRecoverableError(int errorCode) + +
Determines whether an error is user-recoverable.
+ +
+ + + + + + + + + + + + + + + +
+ [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 +

+
+ + + + +
+
+ +

Minimum Google Play services package version (declared in AndroidManifest.xml + android:versionCode) in order to be compatible with this client version. +

+ + +
+ Constant Value: + + + 2010000 + (0x001eab90) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + String + + GOOGLE_PLAY_STORE_PACKAGE +

+
+ + + + +
+
+ +

Package name for Google Play services. +

+ + +
+ Constant Value: + + + "com.android.vending" + + +
+ +
+
+ + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + static + + + + Dialog + + getErrorDialog + (int errorCode, Activity activity, 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
+ + + + + + + + + + + + + +
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 + + + + Dialog + + getErrorDialog + (int errorCode, Activity activity, 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
+ + + + + + + + + + +
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 + + + + PendingIntent + + getErrorPendingIntent + (int errorCode, Context context, int requestCode) +

+
+
+ + + +
+
+ +

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 + + 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 + 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) +

+
+
+ + + +
+
+ +

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) +

+
+
+ + + +
+
+ +

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
+ +
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/common/Scopes.html b/docs/html/reference/com/google/android/gms/common/Scopes.html new file mode 100644 index 000000000000..97ef9bc1bb89 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/Scopes.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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
StringPLUS_PROFILEOAuth 2.0 scope for accessing the user's Google+ profile data.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + PLUS_PROFILE +

+
+ + + + +
+
+ +

OAuth 2.0 scope for accessing the user's Google+ profile data.

+ + +
+ Constant Value: + + + "https://www.googleapis.com/auth/plus.me" + + +
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + 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 new file mode 100644 index 000000000000..44de3c2ebd62 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/common/package-summary.html @@ -0,0 +1,702 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.common | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.common

+
+ +
+ +
+ + +
+ Contains utility classes for Google Play services. + +
+ + + + + + +

Interfaces

+
+ + + + + + + + + + + + + + +
GooglePlayServicesClient + 
GooglePlayServicesClient.ConnectionCallbacksProvides callbacks that are called when the client is + connected or disconnected from the service. 
GooglePlayServicesClient.OnConnectionFailedListenerProvides callbacks for scenarios that result in a failed attempt to + connect the client to the service. 
+
+ + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + +
AccountPickerCommon account picker similar to the standard framework account picker introduced in ICS: + newChooseAccountIntent. 
ConnectionResultContains all possible error codes for when a client fails to connect to Google Play services. 
GooglePlayServicesUtilUtility class for verifying that the Google Play services APK is available and + up-to-date on this device. 
ScopesOAuth 2.0 scopes for use with Google Play services. 
+
+ + + + + + + +

Exceptions

+
+ + + + + + +
GooglePlayServicesNotAvailableExceptionIndicates Google Play services is not available. 
+
+ + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html b/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html new file mode 100644 index 000000000000..27c5ed7999a0 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/CameraUpdate.html @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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());
+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..a67c0ef90397 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/CameraUpdateFactory.html @@ -0,0 +1,1793 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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: +

+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..c5d575ed8c81 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.CancelableCallback.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..ffd4210e673f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.InfoWindowAdapter.html @@ -0,0 +1,924 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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. + To replace just the info-window contents, inside the default info-window frame (the callout + bubble), leave the default implementation of getInfoWindow(Marker) in place and override + getInfoContents(Marker) instead. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..429bcac24c5f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnCameraChangeListener.html @@ -0,0 +1,840 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.OnInfoWindowClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html new file mode 100644 index 000000000000..44d2f4ebe922 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnInfoWindowClickListener.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..6f591e6fe966 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapClickListener.html @@ -0,0 +1,841 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.OnMapLongClickListener.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html new file mode 100644 index 000000000000..9049b28dc7a3 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMapLongClickListener.html @@ -0,0 +1,841 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..0084b13e1364 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerClickListener.html @@ -0,0 +1,843 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..f3c0fe7fa0a7 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.OnMarkerDragListener.html @@ -0,0 +1,954 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.html b/docs/html/reference/com/google/android/gms/maps/GoogleMap.html new file mode 100644 index 000000000000..f167d2f9d2a4 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMap.html @@ -0,0 +1,3334 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Nested Classes
+ + + + + interfaceGoogleMap.CancelableCallbackA callback interface for reporting when a task is complete or cancelled. 
+ + + + + interfaceGoogleMap.InfoWindowAdapterProvides views for customized rendering of info-windows. 
+ + + + + interfaceGoogleMap.OnCameraChangeListenerDefines signatures for methods that are called when the camera changes position. 
+ + + + + interfaceGoogleMap.OnInfoWindowClickListenerCallback interface for click/tap events on a marker's info window. 
+ + + + + interfaceGoogleMap.OnMapClickListenerCallback interface for when the user taps on the map. 
+ + + + + interfaceGoogleMap.OnMapLongClickListenerCallback interface for when the user long presses on the map. 
+ + + + + interfaceGoogleMap.OnMarkerClickListenerDefines signatures for methods that are called when a marker is clicked or tapped. 
+ + + + + interfaceGoogleMap.OnMarkerDragListenerCallback interface for drag events on markers. 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intMAP_TYPE_HYBRIDSatellite maps with a transparent layer of major streets.
intMAP_TYPE_NONENo base map tiles.
intMAP_TYPE_NORMALBasic maps.
intMAP_TYPE_SATELLITESatellite maps with no labels.
intMAP_TYPE_TERRAINTerrain maps.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + 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, overlays, and polylines from the map.
+ +
+ + + final + + + CameraPosition + + getCameraPosition() + +
Gets the current position of the camera.
+ +
+ + + 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() + +
Returns the currently displayed user location, or null if there is no location data + available.
+ +
+ + + 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 + + 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 + + + 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 + + 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.
+ +
+ + + 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 + + setTrafficEnabled(boolean enabled) + +
Toggles the traffic layer on or off.
+ +
+ + + 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 + + + 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.
+
+ +
+
+ + + + +
+

+ + 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, overlays, and polylines 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 + + 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 + () +

+
+
+ + + +
+
+ +

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 + + 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 + + + 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 + + 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 + + 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 + + setTrafficEnabled + (boolean enabled) +

+
+
+ + + +
+
+ +

Toggles the traffic layer on or off.

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..955237108254 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/GoogleMapOptions.html @@ -0,0 +1,2479 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GoogleMapOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + GoogleMapOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
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 +
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + CameraPosition + + getCamera() + +
+ + + + + + Boolean + + getCompassEnabled() + +
+ + + + + + int + + getMapType() + +
+ + + + + + Boolean + + getRotateGesturesEnabled() + +
+ + + + + + Boolean + + getScrollGesturesEnabled() + +
+ + + + + + Boolean + + getTiltGesturesEnabled() + +
+ + + + + + Boolean + + getUseViewLifecycleInFragment() + +
+ + + + + + Boolean + + getZOrderOnTop() + +
+ + + + + + Boolean + + getZoomControlsEnabled() + +
+ + + + + + Boolean + + getZoomGesturesEnabled() + +
+ + + + + + 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) + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + GoogleMapOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + CameraPosition + + getCamera + () +

+
+
+ + + +
+
+ +

+
+
Returns
+
  • the camera option, or null if unspecified.
+
+ +
+
+ + + + +
+

+ + public + + + + + Boolean + + getCompassEnabled + () +

+
+
+ + + +
+
+ +

+
+
Returns
+
  • the compassEnabled 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 + + 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) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..d02b4e68e102 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/LocationSource.OnLocationChangedListener.html @@ -0,0 +1,836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..bb13ed1d377c --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/LocationSource.html @@ -0,0 +1,941 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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.OnLocationChangedListenerHandles 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 new file mode 100644 index 000000000000..6dafa9717fd8 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/MapFragment.html @@ -0,0 +1,3184 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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. + +

+ + A GoogleMap can only be acquired using getMap() when the underlying maps + system is loaded and the underlying view in the fragment exists. This class + automatically initializes the maps system and the view; however you cannot be guaranteed + when it will be ready because this depends on the availability of the Google Play + services APK. If a GoogleMap is not available, getMap() will return + null. +

+ 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. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.content.ComponentCallbacks2 +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + MapFragment() + +
Creates a map fragment.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + GoogleMap + + getMap() + +
Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.
+ +
+ + + + static + + MapFragment + + newInstance() + +
Creates a map fragment, using default options.
+ +
+ + + + static + + MapFragment + + newInstance(GoogleMapOptions options) + +
Creates a map fragment with the given options.
+ +
+ + + + + + 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.ComponentCallbacks + +
+ + +
+
+ +From interface + + android.content.ComponentCallbacks2 + +
+ + +
+
+ +From interface + + android.view.View.OnCreateContextMenuListener + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

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 + + + + + GoogleMap + + getMap + () +

+
+
+ + + +
+
+ +

Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.

+
+
Returns
+ +
+ +
+
+ + + + +
+

+ + 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 + + 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 new file mode 100644 index 000000000000..6a04dd4fca19 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/MapView.html @@ -0,0 +1,12545 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 can only be acquired using getMap() when the underlying maps + system is loaded and the underlying view in the fragment exists. The MapView + automatically initializes the maps system and the view; however you cannot be guaranteed + when it will be ready because this depends on the availability of the Google Play + services APK. If a GoogleMap is not available, getMap() will return + null. +

+ 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. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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
+ + + + + + GoogleMap + + getMap() + +
Gets the underlying GoogleMap that is tied to this view.
+ +
+ + + final + + + void + + onCreate(Bundle savedInstanceState) + +
+ + + final + + + void + + onDestroy() + +
+ + + final + + + void + + onLowMemory() + +
+ + + final + + + void + + onPause() + +
+ + + final + + + void + + onResume() + +
+ + + final + + + void + + onSaveInstanceState(Bundle outState) + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [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.graphics.drawable.Drawable.Callback + +
+ + +
+
+ +From interface + + android.view.KeyEvent.Callback + +
+ + +
+
+ +From interface + + android.view.ViewManager + +
+ + +
+
+ +From interface + + android.view.ViewParent + +
+ + +
+
+ +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 + + + + + GoogleMap + + getMap + () +

+
+
+ + + +
+
+ +

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 + + final + + + void + + onCreate + (Bundle savedInstanceState) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + final + + + void + + onDestroy + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + final + + + void + + onLowMemory + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + final + + + void + + onPause + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + final + + + void + + onResume + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + final + + + void + + onSaveInstanceState + (Bundle outState) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html b/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html new file mode 100644 index 000000000000..5ad1dcf62203 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/MapsInitializer.html @@ -0,0 +1,1106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + + void + + 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 + + + + void + + 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.
+
+
+
Throws
+ + + + +
GooglePlayServicesNotAvailableException + if Google Play services is not available. +
+
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/maps/Projection.html b/docs/html/reference/com/google/android/gms/maps/Projection.html new file mode 100644 index 000000000000..e6c3dea42b90 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/Projection.html @@ -0,0 +1,1215 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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/SupportMapFragment.html b/docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html new file mode 100644 index 000000000000..591b9beef38d --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/SupportMapFragment.html @@ -0,0 +1,3041 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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. + +

+ + A GoogleMap can only be acquired using getMap() when the underlying maps + system is loaded and the underlying view in the fragment exists. This class + automatically initializes the maps system and the view; however you cannot be guaranteed + when it will be ready because this depends on the availability of the Google Play + services APK. If a GoogleMap is not available, getMap() will return + null. +

+ 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. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + SupportMapFragment() + +
Creates a map fragment.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + GoogleMap + + getMap() + +
Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.
+ +
+ + + + static + + SupportMapFragment + + newInstance() + +
Creates a map fragment, using default options.
+ +
+ + + + static + + SupportMapFragment + + newInstance(GoogleMapOptions options) + +
Creates a map fragment with the given options.
+ +
+ + + + + + 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 + + + + + GoogleMap + + getMap + () +

+
+
+ + + +
+
+ +

Gets the underlying GoogleMap that is tied to the view wrapped by this fragment.

+
+
Returns
+ +
+ +
+
+ + + + +
+

+ + 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 + + 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 new file mode 100644 index 000000000000..43a27f11a5b4 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/UiSettings.html @@ -0,0 +1,1903 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 + + 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 + + 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 + + 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 + + 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 new file mode 100644 index 000000000000..cc98b79bb4c2 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptor.html @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..dd1f4779bedb --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/BitmapDescriptorFactory.html @@ -0,0 +1,1841 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 path) + +
Creates a BitmapDescriptor using the path to an image file.
+ +
+ + + + 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 path) +

+
+
+ + + +
+
+ +

Creates a BitmapDescriptor using the path to an image file.

+
+
Parameters
+ + + + +
path + The path to the image file.
+
+
+
Returns
+
  • the BitmapDescriptor that was loaded from the asset 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 new file mode 100644 index 000000000000..95415ecdb97f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.Builder.html @@ -0,0 +1,1402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..c1f32c36f2ee --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/CameraPosition.html @@ -0,0 +1,2002 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +CameraPosition | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + Nested Classes + + + + + + + | Constants + + + + | 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. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Nested Classes
+ + + + + classCameraPosition.BuilderBuilds camera position. 
+ + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + CameraPositionCreatorCREATOR
+ public + + final + floatbearingDirection that the camera is pointing in, in degrees clockwise from north.
+ public + + final + LatLngtargetThe location that the camera is pointing at.
+ public + + final + floattiltThe angle, in degrees, of the camera angle from the nadir (directly facing the Earth).
+ public + + final + floatzoomZoom 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 +
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + CameraPositionCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + 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 degress inclusive + 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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/GroundOverlay.html b/docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html new file mode 100644 index 000000000000..26bb97e4645c --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/GroundOverlay.html @@ -0,0 +1,2174 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 an 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 cannot change the image used in the ground overlay once + it has been added to the map. 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 + + 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. +

+ When a map is restored from a Bundle, ground overlays that were on that + map are also restored. However, those ground overlays will then be represented by different + GroundOverlay objects. A ground overlay's id can be used to retrieve the new + incarnation of a GroundOverlay object after such restoration.

+
+
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 + + 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 new file mode 100644 index 000000000000..a1b6576516f1 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html @@ -0,0 +1,2699 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GroundOverlayOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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_DIMENSIONFlag for when no dimension is specified for the height.
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + GroundOverlayOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
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.
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + GroundOverlayOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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/LatLng.html b/docs/html/reference/com/google/android/gms/maps/model/LatLng.html new file mode 100644 index 000000000000..7035813f10b1 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/LatLng.html @@ -0,0 +1,1667 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LatLng | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | 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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + LatLngCreatorCREATOR
+ public + + final + doublelatitudeLatitude, in degrees.
+ public + + final + doublelongitudeLongitude, in degrees.
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + LatLng(double latitude, double longitude) + +
Constructs a LatLng with the given latitude and longitude, measured in degrees.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + LatLngCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..fdfdfb37e68b --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.Builder.html @@ -0,0 +1,1219 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 wrap around the world) 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 new file mode 100644 index 000000000000..970a9c464376 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/LatLngBounds.html @@ -0,0 +1,1877 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LatLngBounds | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + Nested Classes + + + + + + + | Constants + + + + | 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.BuilderThis is a builder that is able to create a minimum bound based on a set of LatLng points. 
+ + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + LatLngBoundsCreatorCREATOR
+ public + + final + LatLngnortheastNortheast corner of the bound.
+ public + + final + LatLngsouthwestSouthwest 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.
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + boolean + + equals(Object o) + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + LatLngBoundsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + public + + + + + boolean + + equals + (Object o) +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 wrap around the world) 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 new file mode 100644 index 000000000000..f63384937e7e --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/Marker.html @@ -0,0 +1,1915 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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: +

+
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). You can't change the icon once \ you've + created the marker. +
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 true.
+
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.
+
+

Example

+ + 
 GoogleMap map = ... // get a map.
+ // Add a marker at San Francisco.
+ Marker marker = map.add(new MarkerOptions()
+     .position(new LatLng(37.7750, 122.4183))
+     .title("San Francisco")
+     .snippet("Population: 776733"));
+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + boolean + + equals(Object other) + +
+ + + + + + String + + getId() + +
Gets this marker's id.
+ +
+ + + + + + LatLng + + getPosition() + +
Returns the position 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 + + isInfoWindowShown() + +
Returns whether the info window is currently shown above this marker.
+ +
+ + + + + + boolean + + isVisible() + +
+ + + + + + void + + remove() + +
Removes this marker from the map.
+ +
+ + + + + + void + + setDraggable(boolean draggable) + +
Sets the draggability of the marker.
+ +
+ + + + + + void + + setPosition(LatLng latlng) + +
Sets the position of the marker.
+ +
+ + + + + + 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 + + + + + String + + getId + () +

+
+
+ + + +
+
+ +

Gets this marker's id. +

+ When a map is restored from a Bundle, markers that were on that map are + also restored. However, those markers will then be represented by different Marker + objects. A marker's id can be used to retrieve the new incarnation of a Marker object after + such restoration.

+
+
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 + + + + + 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 + + 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 + + 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 + + setPosition + (LatLng latlng) +

+
+
+ + + +
+
+ +

Sets the 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 new file mode 100644 index 000000000000..a1d0c85ee753 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/MarkerOptions.html @@ -0,0 +1,2261 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +MarkerOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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.

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + MarkerOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + MarkerOptions() + +
Creates a new set of marker options.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + MarkerOptions + + anchor(float u, float v) + +
Specifies the anchor to be at a particular point in the marker image.
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + MarkerOptions + + draggable(boolean draggable) + +
Sets the draggability for the marker.
+ +
+ + + + + + 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.
+ +
+ + + + + + LatLng + + getPosition() + +
Returns the position 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.
+ +
+ + + + + + boolean + + isDraggable() + +
Gets the draggability 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 + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + MarkerOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + MarkerOptions + () +

+
+
+ + + +
+
+ +

Creates a new set of marker options. +

+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 + + + + + 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 + + + + + LatLng + + getPosition + () +

+
+
+ + + +
+
+ +

Returns the position set for this MarkerOptions object.

+
+
Returns
+
  • A LatLng object specifying the marker's current 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 + + + + + boolean + + isDraggable + () +

+
+
+ + + +
+
+ +

Gets the draggability setting for this MarkerOptions object.

+
+
Returns
+
  • true if the marker is draggable; otherwise, returns false. +
+
+ +
+
+ + + + +
+

+ + 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 + + 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 new file mode 100644 index 000000000000..0c4ee870f664 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/Polygon.html @@ -0,0 +1,2140 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 counterclockwise order. It is not + necessary for the start and end points to coincide; if they do not, they polygon will be + automatically closed. Line segments are drawn between consecutive points in the shorter of the + two directions (east or west) and so it is possible for the polygon to span the 180 meridian. +
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, 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));
+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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. +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..f7b43863e06b --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/PolygonOptions.html @@ -0,0 +1,2376 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PolygonOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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.

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + PolygonOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
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.
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + PolygonOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

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. The vertices must be added in + counterclockwise order.

+
+
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. The vertices must be added in + counterclockwise order.

+
+
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. The vertices must be added in + counterclockwise order.

+
+
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. The vertices of the hole must be in counterclockwise + order.

+
+
Returns
+ +
+ +
+
+ + + + +
+

+ + public + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..ed711928236e --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/Polyline.html @@ -0,0 +1,1988 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 polyline is drawn with respect to other overlays, including + 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 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));
+

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

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. +

+ When a map is restored from a Bundle, polylines that were on that map are + also restored. However, those polylines will then be represented by different + Polyline objects. A polyline's id can be used to retrieve the new incarnation of a + Polyline object after such restoration.

+
+
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 new file mode 100644 index 000000000000..6af9373183bd --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/PolylineOptions.html @@ -0,0 +1,2160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PolylineOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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.

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + PolylineOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
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.
+ +
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + PolylineOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..88efd771e4dc --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/RuntimeRemoteException.html @@ -0,0 +1,1357 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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/Tile.html b/docs/html/reference/com/google/android/gms/maps/model/Tile.html new file mode 100644 index 000000000000..ac7b59a1dfda --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/Tile.html @@ -0,0 +1,1568 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Tile | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | 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

+

Defines options for a polyline.

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + TileCreatorCREATOR
+ public + + final + byte[]dataA byte array containing the image data.
+ public + + final + intheightThe width of the image encoded by data in pixels.
+ public + + final + intwidthThe width of the image encoded by data in pixels.
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + Tile(int width, int height, byte[] data) + +
Constructs a Tile.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + int + + describeContents() + +
+ + + + + + void + + writeToParcel(Parcel out, int flags) + +
+ + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ +From interface + + android.os.Parcelable + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + TileCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + 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 width 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..e8f110b32e4a --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/TileOverlay.html @@ -0,0 +1,1547 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 and Polylines, 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) + +
+ + + + + + 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 + + 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 + + + + + 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 + + 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 new file mode 100644 index 000000000000..9fbde12b4254 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/TileOverlayOptions.html @@ -0,0 +1,1755 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +TileOverlayOptions | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + | Fields + + + + + | 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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + TileOverlayOptionsCreatorCREATOR
+ + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + TileOverlayOptions() + +
Creates a new set of tile overlay options.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + TileOverlayOptionsCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + TileOverlayOptions + () +

+
+
+ + + +
+
+ +

Creates a new set of tile overlay options.

+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..a0145fd1a514 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/TileProvider.html @@ -0,0 +1,968 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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_TILEStub 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 new file mode 100644 index 000000000000..21f58838b1cd --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/UrlTileProvider.html @@ -0,0 +1,1373 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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 new file mode 100644 index 000000000000..d9dad1b789bc --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/VisibleRegion.html @@ -0,0 +1,1822 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +VisibleRegion | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | 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

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringNULL
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From interface +android.os.Parcelable +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields
+ public + static + final + VisibleRegionCreatorCREATOR
+ public + + final + LatLngfarLeftLatLng object that defines the far left corner of the camera.
+ public + + final + LatLngfarRightLatLng object that defines the far right corner of the camera.
+ public + + final + LatLngBoundslatLngBoundsThe smallest bounding box that includes the visible region defined in this class.
+ public + + final + LatLngnearLeftLatLng object that defines the bottom left corner of the camera.
+ public + + final + LatLngnearRightLatLng 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
+ + + + + + int + + describeContents() + +
+ + + + + + 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 + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + NULL +

+
+ + + + +
+
+ +

+ + +
+ Constant Value: + + + "SAFE_PARCELABLE_NULL_STRING" + + +
+ +
+
+ + + + + + + + +

Fields

+ + + + + + +
+

+ + public + static + final + VisibleRegionCreator + + CREATOR +

+
+ + + + +
+
+ +

+ + +
+
+ + + + + +
+

+ + 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 + + + + + int + + describeContents + () +

+
+
+ + + +
+
+ +

+ +
+
+ + + + +
+

+ + 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 new file mode 100644 index 000000000000..780df404bcd8 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/model/package-summary.html @@ -0,0 +1,754 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.maps.model | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.maps.model

+
+ +
+ +
+ + +
+ Contains the Google Maps Android API model classes. + +
+ + + + + + +

Interfaces

+
+ + + + + + +
TileProviderAn interface for a class that provides the tile images for a TileOverlay. 
+
+ + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BitmapDescriptorDefines an image. 
BitmapDescriptorFactoryUsed to create a definition of an image, used for marker icons and ground overlays. 
CameraPositionAn immutable class that aggregates all camera position parameters. 
CameraPosition.BuilderBuilds camera position. 
GroundOverlayA ground overlay is an image that is fixed to a map. 
GroundOverlayOptionsDefines options for a ground overlay. 
LatLngAn immutable class representing a pair of latitude and longitude coordinates, stored as degrees. 
LatLngBoundsAn immutable class representing a latitude/longitude aligned rectangle. 
LatLngBounds.BuilderThis is a builder that is able to create a minimum bound based on a set of LatLng points. 
MarkerAn icon placed at a particular point on the map's surface. 
MarkerOptionsDefines MarkerOptions for a marker. 
PolygonA polygon on the earth's surface. 
PolygonOptionsDefines options for a polygon. 
PolylineA polyline is a list of points, where line segments are drawn between consecutive points. 
PolylineOptionsDefines options for a polyline. 
TileDefines options for a polyline. 
TileOverlayA Tile Overlay is a set of images which are displayed on top of the base map tiles. 
TileOverlayOptionsDefines options for a TileOverlay. 
UrlTileProviderA partial implementation of TileProvider that only requires a URL that points to an image + to be provided. 
VisibleRegionContains the four points defining the four-sided polygon that is visible in a map's camera. 
+
+ + + + + + + +

Exceptions

+
+ + + + + + +
RuntimeRemoteExceptionA 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 new file mode 100644 index 000000000000..9a648d95b48f --- /dev/null +++ b/docs/html/reference/com/google/android/gms/maps/package-summary.html @@ -0,0 +1,741 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.maps | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.maps

+
+ +
+ +
+ + +
+ Contains the Google Maps Android API classes. + +
+ + + + + + +

Interfaces

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GoogleMap.CancelableCallbackA callback interface for reporting when a task is complete or cancelled. 
GoogleMap.InfoWindowAdapterProvides views for customized rendering of info-windows. 
GoogleMap.OnCameraChangeListenerDefines signatures for methods that are called when the camera changes position. 
GoogleMap.OnInfoWindowClickListenerCallback interface for click/tap events on a marker's info window. 
GoogleMap.OnMapClickListenerCallback interface for when the user taps on the map. 
GoogleMap.OnMapLongClickListenerCallback interface for when the user long presses on the map. 
GoogleMap.OnMarkerClickListenerDefines signatures for methods that are called when a marker is clicked or tapped. 
GoogleMap.OnMarkerDragListenerCallback interface for drag events on markers. 
LocationSourceDefines an interface for providing location data, typically to a GoogleMap object. 
LocationSource.OnLocationChangedListenerHandles a location update. 
+
+ + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CameraUpdateDefines a camera move. 
CameraUpdateFactoryA class containing methods for creating CameraUpdate objects that change a map's camera. 
GoogleMapThis is the main class of the Google Maps Android API and is the entry point for all methods + related to the map. 
GoogleMapOptionsDefines configuration GoogleMapOptions for a GoogleMap. 
MapFragmentA Map component in an app. 
MapsInitializerUse this class to initialize the Google Maps Android API if features need to be used before + obtaining a map. 
MapViewA View which displays a map (with data obtained from the Google Maps service). 
ProjectionA projection is used to translate between on screen location and geographic coordinates on the + surface of the Earth (LatLng). 
SupportMapFragmentA Map component in an app. 
UiSettingsSettings for the user interface of a GoogleMap. 
+
+ + + + + + + + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/package-summary.html b/docs/html/reference/com/google/android/gms/package-summary.html new file mode 100644 index 000000000000..0a307d1c8f6a --- /dev/null +++ b/docs/html/reference/com/google/android/gms/package-summary.html @@ -0,0 +1,666 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms

+
+ +
+ +
+ + + + + + + + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + + + + + +
R 
R.attr 
R.id 
R.string 
R.styleable 
+
+ + + + + + + + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/panorama/PanoramaClient.OnPanoramaInfoLoadedListener.html b/docs/html/reference/com/google/android/gms/panorama/PanoramaClient.OnPanoramaInfoLoadedListener.html new file mode 100644 index 000000000000..1f7027141446 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/panorama/PanoramaClient.OnPanoramaInfoLoadedListener.html @@ -0,0 +1,842 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PanoramaClient.OnPanoramaInfoLoadedListener | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + +
+ +
+
+ + + + +
+
+ + + + +
+ public + static + + + interface +

PanoramaClient.OnPanoramaInfoLoadedListener

+ + + + + + + + +
+ +
+ +
+ + + + + + + + + +
com.google.android.gms.panorama.PanoramaClient.OnPanoramaInfoLoadedListener
+ + + + + + + +
+ + +

Class Overview

+

Callback interface for loading panorama info. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ abstract + + + + + void + + onPanoramaInfoLoaded(ConnectionResult result, Intent viewerIntent) + +
Called on the main thread when panorama info is loaded.
+ +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + abstract + + void + + onPanoramaInfoLoaded + (ConnectionResult result, Intent viewerIntent) +

+
+
+ + + +
+
+ +

Called on the main thread when panorama info is loaded.

+
+
Parameters
+ + + + + + + +
result + result of the operation. isSuccess() will return true if the request + succeeded.
viewerIntent + 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/PanoramaClient.html b/docs/html/reference/com/google/android/gms/panorama/PanoramaClient.html new file mode 100644 index 000000000000..4ebe6b920e6d --- /dev/null +++ b/docs/html/reference/com/google/android/gms/panorama/PanoramaClient.html @@ -0,0 +1,2027 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PanoramaClient | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + +
+ +Summary: + + Nested Classes + + + + + + + + + + + | Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + + + class +

PanoramaClient

+ + + + + extends Object
+ + + + + + + implements + + GooglePlayServicesClient + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gms.panorama.PanoramaClient
+ + + + + + + +
+ + +

Class Overview

+

The main entry point for panorama integration. + + Use the PanoramaClient after the asynchronous connect() method + has been called and your listener's + onConnected() + method is called. +

+ When your app is done using PanoramaClient, call disconnect(), + even if the async result from connect() has not yet been + delivered. +

+ You should instantiate this 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
+ + + + + interfacePanoramaClient.OnPanoramaInfoLoadedListenerCallback interface for loading panorama info. 
+ + + + + + + + + + +
Public Constructors
+ + + + + + + + PanoramaClient(Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener) + +
Creates a panorama client.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + void + + connect() + +
Connects the client to Google Play services.
+ +
+ + + + + + void + + disconnect() + +
Closes the connection to Google Play services.
+ +
+ + + + + + boolean + + isConnected() + +
Checks if the client is currently connected to the service, so that + requests to other methods will succeed.
+ +
+ + + + + + boolean + + isConnectionCallbacksRegistered(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Returns true if the specified listener is currently registered to + receive connection events.
+ +
+ + + + + + boolean + + isConnectionFailedListenerRegistered(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Returns true if the specified listener is currently registered to + receive connection failed events.
+ +
+ + + + + + void + + loadPanoramaInfo(PanoramaClient.OnPanoramaInfoLoadedListener listener, Uri uri) + +
Loads information about a panorama.
+ +
+ + + + + + void + + loadPanoramaInfoAndGrantAccess(PanoramaClient.OnPanoramaInfoLoadedListener listener, Uri uri) + +
Loads information about a panorama from a content provider.
+ +
+ + + + + + void + + registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Registers a listener to receive connection events from this GooglePlayServicesClient.
+ +
+ + + + + + void + + registerConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Registers a listener to receive connection failed events from this + GooglePlayServicesClient.
+ +
+ + + + + + void + + unregisterConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Removes a connection listener from this GooglePlayServicesClient.
+ +
+ + + + + + void + + unregisterConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Removes a connection failed listener from the GooglePlayServicesClient.
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ +From interface + + com.google.android.gms.common.GooglePlayServicesClient + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + PanoramaClient + (Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener) +

+
+
+ + + +
+
+ +

Creates a panorama client.

+
+
Parameters
+ + + + + + + + + + +
context + The context to use for the connection.
connectionCallbacks + The callbacks invoked when the client is connected.
connectionFailedListener + The listener which will be notified if + the connection attempt fails. +
+
+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + 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() + is called. On a failure, + onConnectionFailed(ConnectionResult) + is called. +

+ +
+
+ + + + +
+

+ + public + + + + + void + + disconnect + () +

+
+
+ + + +
+
+ +

Closes the connection to Google Play services. No calls can be made on this object + after calling this method.

+ +
+
+ + + + +
+

+ + public + + + + + 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 + + + + + boolean + + isConnectionCallbacksRegistered + (GooglePlayServicesClient.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.
+
+ +
+
+ + + + +
+

+ + public + + + + + boolean + + isConnectionFailedListenerRegistered + (GooglePlayServicesClient.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.
+
+ +
+
+ + + + +
+

+ + public + + + + + void + + loadPanoramaInfo + (PanoramaClient.OnPanoramaInfoLoadedListener listener, Uri uri) +

+
+
+ + + +
+
+ +

Loads information about a panorama.

+
+
Parameters
+ + + + + + + +
listener + the listener that is called, on the main thread, when the load completes
uri + the URI of the panorama to load info about. May be a file:, content:, + or android_resource: scheme. +
+
+ +
+
+ + + + +
+

+ + public + + + + + void + + loadPanoramaInfoAndGrantAccess + (PanoramaClient.OnPanoramaInfoLoadedListener listener, 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
+ + + + + + + +
listener + the listener that is called, on the main thread, when the load completes
uri + the URI of the panorama to load info about. May only be a content: scheme. +
+
+ +
+
+ + + + +
+

+ + public + + + + + void + + registerConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection events from this GooglePlayServicesClient. + If we are already connected, the listener's onConnected() 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() 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 + + + + + void + + registerConnectionFailedListener + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection failed events from this + GooglePlayServicesClient. Unlike registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks), if we are 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 + + + + + void + + unregisterConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Removes a connection listener from this GooglePlayServicesClient. 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 + + + + + void + + unregisterConnectionFailedListener + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Removes a connection failed listener from the GooglePlayServicesClient. + 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/panorama/package-summary.html b/docs/html/reference/com/google/android/gms/panorama/package-summary.html new file mode 100644 index 000000000000..81c510b034b7 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/panorama/package-summary.html @@ -0,0 +1,661 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.panorama | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.panorama

+
+ +
+ +
+ + + + + + + +

Interfaces

+
+ + + + + + +
PanoramaClient.OnPanoramaInfoLoadedListenerCallback interface for loading panorama info. 
+
+ + + + +

Classes

+
+ + + + + + +
PanoramaClientThe main entry point for panorama integration. 
+
+ + + + + + + + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/plus/GooglePlusUtil.html b/docs/html/reference/com/google/android/gms/plus/GooglePlusUtil.html new file mode 100644 index 000000000000..35e22002e6e9 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/GooglePlusUtil.html @@ -0,0 +1,1413 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +GooglePlusUtil | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + + + class +

GooglePlusUtil

+ + + + + extends Object
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gms.plus.GooglePlusUtil
+ + + + + + + +
+ + +

Class Overview

+

Utility class for verifying that the Google+ app is available and + up-to-date on this device. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intAPP_DISABLEDStatus code indicating the Google+ app is installed, but disabled.
intAPP_MISSINGStatus code indicating the Google+ app is not installed.
intAPP_UPDATE_REQUIREDStatus code indicating the Google+ app is installed, but is older than the + version required.
StringGOOGLE_PLUS_PACKAGEThe package name of the Google+ Android app.
intSUCCESSStatus code indicating the Google+ app is installed and up-to-date.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + static + + int + + checkGooglePlusApp(Context context) + +
Checks if the version of the Google+ app installed on this device is up-to-date.
+ +
+ + + + static + + Dialog + + getErrorDialog(int errorCode, Activity activity, int requestCode) + +
Returns a dialog to address the provided errorCode.
+ +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + int + + APP_DISABLED +

+
+ + + + +
+
+ +

Status code indicating the Google+ app is installed, but disabled. +

+ + +
+ Constant Value: + + + 3 + (0x00000003) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + int + + APP_MISSING +

+
+ + + + +
+
+ +

Status code indicating the Google+ app is not installed. +

+ + +
+ Constant Value: + + + 1 + (0x00000001) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + int + + APP_UPDATE_REQUIRED +

+
+ + + + +
+
+ +

Status code indicating the Google+ app is installed, but is older than the + version required. +

+ + +
+ Constant Value: + + + 2 + (0x00000002) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + String + + GOOGLE_PLUS_PACKAGE +

+
+ + + + +
+
+ +

The package name of the Google+ Android app. +

+ + +
+ Constant Value: + + + "com.google.android.apps.plus" + + +
+ +
+
+ + + + + +
+

+ + public + static + final + int + + SUCCESS +

+
+ + + + +
+
+ +

Status code indicating the Google+ app is installed and up-to-date. +

+ + +
+ Constant Value: + + + 0 + (0x00000000) + + +
+ +
+
+ + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + static + + + + int + + checkGooglePlusApp + (Context context) +

+
+
+ + + +
+
+ +

Checks if the version of the Google+ app installed on this device is up-to-date.

+
+
Parameters
+ + + + +
context + The context.
+
+
+
Returns
+ +
+ +
+
+ + + + +
+

+ + public + static + + + + Dialog + + getErrorDialog + (int errorCode, Activity activity, int requestCode) +

+
+
+ + + +
+
+ +

Returns a dialog to address the provided errorCode. Upon confirmation, the user is directed + to either the Google Play Store or the System App Settings screen to resolve the error.

+
+
Parameters
+ + + + + + + + + + +
errorCode + error code returned by checkGooglePlusApp(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(Intent, int). +
+
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/com/google/android/gms/plus/PlusClient.html b/docs/html/reference/com/google/android/gms/plus/PlusClient.html new file mode 100644 index 000000000000..6eda1bda0f60 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusClient.html @@ -0,0 +1,2208 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PlusClient | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + + + + | Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + + + class +

PlusClient

+ + + + + extends Object
+ + + + + + + implements + + GooglePlayServicesClient + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳com.google.android.gms.plus.PlusClient
+ + + + + + + +
+ + +

Class Overview

+

The main entry point for Google+ integration. + + Use the PlusClient after the asynchronous connect() method + has been called and your listener's + onConnected() method is called. +

+ When your app is done using PlusClient, call disconnect(), + even if the async result from connect() has not yet been + delivered. +

+ You should instantiate this object in your Activity's + onCreate(Bundle) method and then call connect() in + onStart() and disconnect() in + onStop(), regardless of the state. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
StringDEFAULT_ACCOUNTSpecify <> as the account name to indicate that the default account + on the device should be used.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + PlusClient(Context context, String accountName, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener, String... scopes) + +
Creates a Google+ client to connect to Google Play services.
+ +
+ + + + + + + + PlusClient(Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener, String... scopes) + +
Creates a Google+ client to connect to Google Play services.
+ +
+ + + + + + + + PlusClient(Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener) + +
Creates a Google+ client to connect to Google Play services with a + DEFAULT_ACCOUNT and without OAuth 2.0 scopes.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + void + + clearDefaultAccount() + +
Clears the default account for this PlusClient instance.
+ +
+ + + + + + void + + connect() + +
Connects the client to Google Play services.
+ +
+ + + + + + void + + disconnect() + +
Closes the connection to Google Play services.
+ +
+ + + + + + String + + getAccountName() + +
Gets the account name resolved by Google Play services.
+ +
+ + + + + + boolean + + isConnected() + +
Checks if the client is currently connected to the service, so that + requests to other methods will succeed.
+ +
+ + + + + + boolean + + isConnectionCallbacksRegistered(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Returns true if the specified listener is currently registered to + receive connection events.
+ +
+ + + + + + boolean + + isConnectionFailedListenerRegistered(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Returns true if the specified listener is currently registered to + receive connection failed events.
+ +
+ + + + + + void + + registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Registers a listener to receive connection events from this GooglePlayServicesClient.
+ +
+ + + + + + void + + registerConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Registers a listener to receive connection failed events from this + GooglePlayServicesClient.
+ +
+ + + + + + void + + unregisterConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks listener) + +
Removes a connection listener from this GooglePlayServicesClient.
+ +
+ + + + + + void + + unregisterConnectionFailedListener(GooglePlayServicesClient.OnConnectionFailedListener listener) + +
Removes a connection failed listener from the GooglePlayServicesClient.
+ +
+ + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ +From interface + + com.google.android.gms.common.GooglePlayServicesClient + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + String + + DEFAULT_ACCOUNT +

+
+ + + + +
+
+ +

Specify <> as the account name to indicate that the default account + on the device should be used. +

+ + +
+ Constant Value: + + + "<>" + + +
+ +
+
+ + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + PlusClient + (Context context, String accountName, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener, String... scopes) +

+
+
+ + + +
+
+ +

Creates a Google+ client to connect to Google Play services.

+
+
Parameters
+ + + + + + + + + + + + + + + + +
context + The context to use for the connection.
accountName + The name of the account to use.
connectionCallbacks + The callbacks invoked when the client is connected.
connectionFailedListener + The listener which will be notified if + the connection attempt fails.
scopes + The OAuth 2.0 scopes that your application is requesting access to (see + Scopes for details). +
+
+ +
+
+ + + + +
+

+ + public + + + + + + + PlusClient + (Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener, String... scopes) +

+
+
+ + + +
+
+ +

Creates a Google+ client to connect to Google Play services.

+
+
Parameters
+ + + + + + + + + + + + + +
context + The context to use for the connection.
connectionCallbacks + The callbacks invoked when the client is connected.
connectionFailedListener + The listener which will be notified if + the connection attempt fails.
scopes + The OAuth 2.0 scopes that your application is requesting access to (see + Scopes for details). +
+
+ +
+
+ + + + +
+

+ + public + + + + + + + PlusClient + (Context context, GooglePlayServicesClient.ConnectionCallbacks connectionCallbacks, GooglePlayServicesClient.OnConnectionFailedListener connectionFailedListener) +

+
+
+ + + +
+
+ +

Creates a Google+ client to connect to Google Play services with a + DEFAULT_ACCOUNT and without OAuth 2.0 scopes.

+
+
Parameters
+ + + + + + + + + + +
context + The context to use for the connection.
connectionCallbacks + The callbacks invoked when the client is connected.
connectionFailedListener + The listener which will be notified if + the connection attempt fails. +
+
+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + void + + clearDefaultAccount + () +

+
+
+ + + +
+
+ +

Clears the default account for this PlusClient instance. Use this method to allow + the user to choose a different account the next time connect() is called. +

+ This operation doesn't affect existing connected instances of PlusClient. This + client and any others will continue to use the same account. You should call + disconnect() and connect() if you want + to reset the account. +

+ +
+
+ + + + +
+

+ + public + + + + + 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() + is called. On a failure, + onConnectionFailed(ConnectionResult) + is called. +

+ +
+
+ + + + +
+

+ + public + + + + + void + + disconnect + () +

+
+
+ + + +
+
+ +

Closes the connection to Google Play services. No calls can be made on this object + after calling this method.

+ +
+
+ + + + +
+

+ + public + + + + + String + + getAccountName + () +

+
+
+ + + +
+
+ +

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.

+
+
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 + + + + + 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 + + + + + boolean + + isConnectionCallbacksRegistered + (GooglePlayServicesClient.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.
+
+ +
+
+ + + + +
+

+ + public + + + + + boolean + + isConnectionFailedListenerRegistered + (GooglePlayServicesClient.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.
+
+ +
+
+ + + + +
+

+ + public + + + + + void + + registerConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection events from this GooglePlayServicesClient. + If we are already connected, the listener's onConnected() 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() 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 + + + + + void + + registerConnectionFailedListener + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Registers a listener to receive connection failed events from this + GooglePlayServicesClient. Unlike registerConnectionCallbacks(GooglePlayServicesClient.ConnectionCallbacks), if we are 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 + + + + + void + + unregisterConnectionCallbacks + (GooglePlayServicesClient.ConnectionCallbacks listener) +

+
+
+ + + +
+
+ +

Removes a connection listener from this GooglePlayServicesClient. 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 + + + + + void + + unregisterConnectionFailedListener + (GooglePlayServicesClient.OnConnectionFailedListener listener) +

+
+
+ + + +
+
+ +

Removes a connection failed listener from the GooglePlayServicesClient. + 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/plus/PlusOneButton.OnPlusOneClickListener.html b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html new file mode 100644 index 000000000000..5b5c60a4310a --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.OnPlusOneClickListener.html @@ -0,0 +1,839 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PlusOneButton.OnPlusOneClickListener | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + +
+ +
+
+ + + + +
+
+ + + + +
+ public + static + + + interface +

PlusOneButton.OnPlusOneClickListener

+ + + + + + + + +
+ +
+ +
+ + + + + + + + + +
com.google.android.gms.plus.PlusOneButton.OnPlusOneClickListener
+ + + + + + + +
+ + +

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 new file mode 100644 index 000000000000..64f57d335eed --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusOneButton.html @@ -0,0 +1,12421 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PlusOneButton | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + Nested Classes + + + + + + + | Constants + + + + | Inherited Constants + + + + + | Inherited Fields + + + + | Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + final + + class +

PlusOneButton

+ + + + + + + + + + + + + extends ViewGroup
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳android.view.View
    ↳android.view.ViewGroup
     ↳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
+ + + + + interfacePlusOneButton.OnPlusOneClickListenerA listener for +1 button clicks. 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intANNOTATION_BUBBLEDisplay the number of users who have +1'd the URL in a graphic next to the button (default).
intANNOTATION_INLINEDisplay profile pictures of connected users who have +1'd the URL and a count of users who + have +1'd the URL.
intANNOTATION_NONEDo not render any additional annotations.
intSIZE_MEDIUMThe medium button size.
intSIZE_SMALLThe small button size.
intSIZE_STANDARDThe standard button size.
intSIZE_TALLThe 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(PlusClient plusClient, String url, PlusOneButton.OnPlusOneClickListener plusOneClickListener) + +
Updates the +1 button with a client and URL.
+ +
+ + + + + + void + + initialize(PlusClient plusClient, String url, int activityRequestCode) + +
Updates the +1 button with a PlusClient and 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.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + android.view.ViewGroup + +
+ + +
+
+ +From class + + android.view.View + +
+ + +
+
+ +From class + + java.lang.Object + +
+ + +
+
+ +From interface + + android.graphics.drawable.Drawable.Callback + +
+ + +
+
+ +From interface + + android.view.KeyEvent.Callback + +
+ + +
+
+ +From interface + + android.view.ViewManager + +
+ + +
+
+ +From interface + + android.view.ViewParent + +
+ + +
+
+ +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 + + 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 + (PlusClient plusClient, 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
+ + + + + + + + + + +
plusClient + The PlusClient.
url + The URL to be +1'd.
plusOneClickListener + A listener for +1 clicks. +
+
+ +
+
+ + + + +
+

+ + public + + + + + void + + initialize + (PlusClient plusClient, String url, int activityRequestCode) +

+
+
+ + + +
+
+ +

Updates the +1 button with a PlusClient and 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(PlusClient, String, OnPlusOneClickListener) otherwise.

+
+
Parameters
+ + + + + + + + + + +
plusClient + The PlusClient.
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. +
+
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + 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 new file mode 100644 index 000000000000..232a9f8ae248 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusShare.Builder.html @@ -0,0 +1,1617 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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() + +
Create a new Builder for launching a sharing action.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + PlusShare.Builder + + addStream(Uri streamUri) + +
Add a stream URI to the data that should be shared.
+ +
+ + + + static + + PlusShare.Builder + + from(Activity launchingActivity) + +
Create a new Builder for launching a sharing action from launchingActivity.
+ +
+ + + + + + Intent + + getIntent() + +
Retrieve the Intent as configured so far by the Builder.
+ +
+ + + + + + PlusShare.Builder + + setContent(Uri deepLinkUri) + +
Include a deep-link URI to a resource to share on Google+
+ +
+ + + + + + PlusShare.Builder + + setContent(String deepLinkId, String title, String description, Uri thumbnailUri) + +
Include a deep-link identifier to a resource to share on Google+
+ +
+ + + + + + PlusShare.Builder + + setStream(Uri streamUri) + +
Set a stream URI to the data that should be shared.
+ +
+ + + + + + PlusShare.Builder + + setText(CharSequence text) + +
Set the literal text data 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 + () +

+
+
+ + + +
+
+ +

Create a new Builder for launching a sharing action. +

+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + 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 + static + + + + PlusShare.Builder + + from + (Activity launchingActivity) +

+
+
+ + + +
+
+ +

Create a new Builder for launching a sharing action from launchingActivity.

+
+
Parameters
+ + + + +
launchingActivity + Activity that the share will be launched from
+
+
+
Returns
+
  • a new Builder instance +
+
+ +
+
+ + + + +
+

+ + public + + + + + Intent + + getIntent + () +

+
+
+ + + +
+
+ +

Retrieve the Intent as configured so far by the Builder. + This method will include the package

+
+
Returns
+
  • The current Intent being configured by this builder +
+
+ +
+
+ + + + +
+

+ + public + + + + + PlusShare.Builder + + setContent + (Uri deepLinkUri) +

+
+
+ + + +
+
+ +

Include a deep-link URI to a resource to share on Google+

+
+
Parameters
+ + + + +
deepLinkUri + The deep-link URI to a resource to share on Google+.
+
+
+
Returns
+
  • This Builder for method chaining.
+
+
+
See Also
+ +
+ +
+
+ + + + +
+

+ + public + + + + + PlusShare.Builder + + setContent + (String deepLinkId, String title, String description, Uri thumbnailUri) +

+
+
+ + + +
+
+ +

Include a deep-link identifier to a resource to share on Google+

+
+
Parameters
+ + + + + + + + + + + + + +
deepLinkId + The deep-link identifier to a resource to share on Google+. + This parameter is required.
title + The title of the resource. This parameter is required.
description + The description of a resource. This parameter is required.
thumbnailUri + The thumbnailUri for a resource. This parameter is optional.
+
+
+
Returns
+
  • This Builder for method chaining.
+
+
+
See Also
+ +
+ +
+
+ + + + +
+

+ + 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 the literal text data 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 new file mode 100644 index 000000000000..ea64301c8d7d --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusShare.html @@ -0,0 +1,1414 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PlusShare | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + +
+ +Summary: + + Nested Classes + + + + + + + | Constants + + + + + + + + + | 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_CONTENT_DEEP_LINK_IDUsed as a string extra field in ACTION_SEND intents to + specify a resource to be shared on Google+.
StringEXTRA_CONTENT_DEEP_LINK_METADATAUsed as a bundle extra field in ACTION_SEND intents to + describe a resource to be shared on Google+.
StringKEY_CONTENT_DEEP_LINK_METADATA_DESCRIPTIONBundle key used for the String description of the resource shared on Google+.
StringKEY_CONTENT_DEEP_LINK_METADATA_THUMBNAIL_URLBundle key used for the String thumbnail URL of the resource shared on Google+.
StringKEY_CONTENT_DEEP_LINK_METADATA_TITLEBundle key used for the String title of the resource shared on Google+.
StringPARAM_CONTENT_DEEP_LINK_IDThe query parameter containing the deep-link ID.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + static + + String + + getDeepLinkId(Intent intent) + +
Get the incoming deep link.
+ +
+ + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + java.lang.Object + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + 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 + + 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" + + +
+ +
+
+ + + + + + + + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + 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/PlusSignInButton.html b/docs/html/reference/com/google/android/gms/plus/PlusSignInButton.html new file mode 100644 index 000000000000..a34ec5db3cc6 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/PlusSignInButton.html @@ -0,0 +1,9870 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +PlusSignInButton | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Summary: + + + + + + Constants + + + + | Inherited Constants + + + + + | Inherited Fields + + + + | Ctors + + + + + | Methods + + + + + | Inherited Methods + +| [Expand All] + +
+
+ + + + +
+
+ + + + +
+ public + + final + + class +

PlusSignInButton

+ + + + + + + + + + + + + extends ImageView
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
java.lang.Object
   ↳android.view.View
    ↳android.widget.ImageView
     ↳com.google.android.gms.plus.PlusSignInButton
+ + + + + + + +
+ + +

Class Overview

+

The Google+ sign-in button to authenticate the user. +

+ + + + + +
+ + + + + + + + + + + + + + + + +
+ + +

Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants
intBUTTON_SIZE_STANDARDThe standard size of the Google+ sign-in button.
intBUTTON_SIZE_WIDEThe wide size of the Google+ sign-in button.
+ + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Constants
+ + From class +android.view.View +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Fields
+ + From class +android.view.View +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + +
Public Constructors
+ + + + + + + + PlusSignInButton(Context context) + +
Creates a Google+ sign-in button with standard size.
+ +
+ + + + + + + + PlusSignInButton(Context context, AttributeSet attrs) + +
Creates a Google+ sign-in button with standard size.
+ +
+ + + + + + + + + + + + + + + + + + +
Public Methods
+ + + + + + void + + setSize(int buttonSize) + +
Sets the button size to standard or wide.
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [Expand] +
Inherited Methods
+ +From class + + android.widget.ImageView + +
+ + +
+
+ +From class + + android.view.View + +
+ + +
+
+ +From class + + java.lang.Object + +
+ + +
+
+ +From interface + + android.graphics.drawable.Drawable.Callback + +
+ + +
+
+ +From interface + + android.view.KeyEvent.Callback + +
+ + +
+
+ +From interface + + android.view.accessibility.AccessibilityEventSource + +
+ + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + +

Constants

+ + + + + + +
+

+ + public + static + final + int + + BUTTON_SIZE_STANDARD +

+
+ + + + +
+
+ +

The standard size of the Google+ sign-in button. +

+ + +
+ Constant Value: + + + 0 + (0x00000000) + + +
+ +
+
+ + + + + +
+

+ + public + static + final + int + + BUTTON_SIZE_WIDE +

+
+ + + + +
+
+ +

The wide size of the Google+ sign-in button. +

+ + +
+ Constant Value: + + + 1 + (0x00000001) + + +
+ +
+
+ + + + + + + + + + + +

Public Constructors

+ + + + + +
+

+ + public + + + + + + + PlusSignInButton + (Context context) +

+
+
+ + + +
+
+ +

Creates a Google+ sign-in button with standard size.

+
+
Parameters
+ + + + +
context + The context. +
+
+ +
+
+ + + + +
+

+ + public + + + + + + + PlusSignInButton + (Context context, AttributeSet attrs) +

+
+
+ + + +
+
+ +

Creates a Google+ sign-in button with standard size.

+
+
Parameters
+ + + + + + + +
context + The context.
attrs + The attributes of the XML tag that is inflating the view. +
+
+ +
+
+ + + + + + + + + + + + + +

Public Methods

+ + + + + +
+

+ + public + + + + + void + + setSize + (int buttonSize) +

+
+
+ + + +
+
+ +

Sets the button size to standard or wide.

+
+
Parameters
+ + + + +
buttonSize + The button size. See BUTTON_SIZE_STANDARD and + BUTTON_SIZE_WIDE. +
+
+ +
+
+ + + + + + + + + + + + + +
+ +
+ +
+ + + + + + + + + + + + + + + + + + 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 new file mode 100644 index 000000000000..0b3e29d03525 --- /dev/null +++ b/docs/html/reference/com/google/android/gms/plus/package-summary.html @@ -0,0 +1,688 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +com.google.android.gms.plus | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+
+ + + + +
+
+ +
+ package +

com.google.android.gms.plus

+
+ +
+ +
+ + +
+ Contains the Google+ platform for Android. + +
+ + + + + + +

Interfaces

+
+ + + + + + +
PlusOneButton.OnPlusOneClickListenerA listener for +1 button clicks. 
+
+ + + + +

Classes

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
GooglePlusUtilUtility class for verifying that the Google+ app is available and + up-to-date on this device. 
PlusClientThe main entry point for Google+ integration. 
PlusOneButtonThe +1 button to recommend a URL on Google+. 
PlusShareUtility class for including resources in posts shared on Google+ through + an ACTION_SEND intent. 
PlusShare.Builder 
PlusSignInButtonThe Google+ sign-in button to authenticate the user. 
+
+ + + + + + + + + + + + + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/gcm-packages.html b/docs/html/reference/gcm-packages.html new file mode 100644 index 000000000000..c281153404ad --- /dev/null +++ b/docs/html/reference/gcm-packages.html @@ -0,0 +1,628 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Package Index | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+

Package Index

+
+ +
+ +
+

+
+ + + + + + + + + + + + + + + + +
+ com.google.android.gcm
+ com.google.android.gcm.server
+ + +
+
+ +
+ + + + + + + + + + + + + + + + + + diff --git a/docs/html/reference/gms-packages.html b/docs/html/reference/gms-packages.html new file mode 100644 index 000000000000..4ae9e5bef228 --- /dev/null +++ b/docs/html/reference/gms-packages.html @@ -0,0 +1,663 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Package Index | Android Developers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ +
+

Package Index

+
+ +
+ +
+

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ com.google.android.gms
+ com.google.android.gms.authContains classes for authenticating Google accounts.
+ com.google.android.gms.commonContains utility classes for Google Play services.
+ 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.panorama
+ com.google.android.gms.plusContains the Google+ platform for Android.
+ + +
+
+ +
+ + + + + + + + + + + + + + + + + + -- GitLab