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
interface PanoramaClient.OnPanoramaInfoLoadedListener Callback 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.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.