org.coursera.android.shift

Class ShiftManager

java.lang.Object

org.coursera.android.shift.ShiftManager

public class ShiftManager
extends java.lang.Object

ShiftManager the singleton that the client will use in order to use Shift. Handles the creation of a ShiftLauncherView createShiftView(), the registration of ShiftActions registerAction(ShiftAction), and subscribing to changes in ShiftValues. In order to use ShiftManager, you must first call initialize(Context, ShiftVisibilityClient) or initialize(Context, ShiftVisibilityClient, Class) before calling getInstance()

Method Summary

Methods

Modifier and Type	Method and Description
ShiftLauncherView	createShiftView() Returns a new ShiftLauncherView.
ShiftLauncherView	createShiftViewAndShowFloatingIcon(FragmentActivity activity) Returns a new ShiftLauncherView and automatically calls ShiftLauncherView.showFloatingIcon(FragmentActivity) for you
static ShiftManager	getInstance() Returns an instance of ShiftManager.
ShiftVisibilityClient	getVisibilityClient() Returns the ShiftVisibilityClient that was set in initialize(Context, ShiftVisibilityClient) or setVisibilityClient(ShiftVisibilityClient)
static void	initialize(android.content.Context context, ShiftVisibilityClient shiftVisibilityClient) Initializes ShiftManager.
static void	initialize(android.content.Context context, ShiftVisibilityClient shiftVisibilityClient, java.lang.Class launcherClass) Initializes ShiftManager Use this if you want the ability to restart your application when ShiftValues are updated Must call either this method or initialize(Context, ShiftVisibilityClient, Class) before calling getInstance()
void	registerAction(ShiftAction action) Registers an action that can be run in Shift
void	setLauncherClassForRestart(java.lang.Class launcherClass) Provides the client applications Launcher class to Shift so that ShiftValue can be registered using subscribeShiftValueForRestart(ShiftValue).
void	setVisibilityClient(ShiftVisibilityClient visibilityClient) Sets the visiblity client that determines whether or not a user can see Shift
void	subscribeShiftValueForRestart(ShiftValue shiftValue) Registers a ShiftValue to trigger the app to restart.
void	subscribeToUpdatesForAllShiftValues(ShiftValueListener listener) Registers your Activity to call shiftValuesUpdated when any ShiftValue has been modified
void	subscribeToUpdatesForShiftValue(ShiftValueListener listener, ShiftValue value) Registers your ShiftValueListener to call shiftValuesUpdated when the given ShiftValue has been modified
void	subscribeToUpdatesForShiftValues(ShiftValueListener listener, ShiftValue[] values) Registers your Activity to call ShiftValueListener.onShiftValuesUpdated(ShiftValue) when the given ShiftValue have been modified
void	unsubscribeToUpdatesForAllShiftValues(ShiftValueListener listener) Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForAllShiftValues(ShiftValueListener) in your Activity's onCreate Your Activity will no longer receive updates when a ShiftValue has been updated
void	unsubscribeToUpdatesForShiftValue(ShiftValueListener listener, ShiftValue value) Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForShiftValue(ShiftValueListener, ShiftValue) in your Activity's onCreate.
void	unsubscribeToUpdatesForShiftValues(ShiftValueListener listener, ShiftValue[] values) Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForShiftValues(ShiftValueListener, ShiftValue[]) in your Activity's onCreate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ShiftManager getInstance()

Returns an instance of ShiftManager. You must call initialize(Context, ShiftVisibilityClient) or initialize(Context, ShiftVisibilityClient, Class) before calling this method

Returns:

initialize

public static void initialize(android.content.Context context,
              ShiftVisibilityClient shiftVisibilityClient)

Initializes ShiftManager. Must call either this method or initialize(Context, ShiftVisibilityClient, Class) before calling getInstance()

Parameters:

context -

shiftVisibilityClient - Determines whether or not a user can view the ShiftLauncherView

initialize

public static void initialize(android.content.Context context,
              ShiftVisibilityClient shiftVisibilityClient,
              java.lang.Class launcherClass)

Initializes ShiftManager Use this if you want the ability to restart your application when ShiftValues are updated Must call either this method or initialize(Context, ShiftVisibilityClient, Class) before calling getInstance()

Parameters:

context -

shiftVisibilityClient - Determines whether or not a user can view the ShiftLauncherView

launcherClass - Your Applications LAUNCHER android.app.Activity class.

createShiftView

public ShiftLauncherView createShiftView()

Returns a new ShiftLauncherView. Client can then call ShiftLauncherView.showFloatingIcon(FragmentActivity) to make the floating icon appear, or they can hook up their own button to show the ShiftMenu using ShiftLauncherView.showShiftMenu(FragmentActivity)

Returns:

createShiftViewAndShowFloatingIcon

public ShiftLauncherView createShiftViewAndShowFloatingIcon(FragmentActivity activity)

Returns a new ShiftLauncherView and automatically calls ShiftLauncherView.showFloatingIcon(FragmentActivity) for you

Parameters:

activity -

Returns:

getVisibilityClient

public ShiftVisibilityClient getVisibilityClient()

Returns the ShiftVisibilityClient that was set in initialize(Context, ShiftVisibilityClient) or setVisibilityClient(ShiftVisibilityClient)

Returns:

setVisibilityClient

public void setVisibilityClient(ShiftVisibilityClient visibilityClient)

Sets the visiblity client that determines whether or not a user can see Shift

setLauncherClassForRestart

public void setLauncherClassForRestart(java.lang.Class launcherClass)

Provides the client applications Launcher class to Shift so that ShiftValue can be registered using subscribeShiftValueForRestart(ShiftValue).

subscribeShiftValueForRestart

public void subscribeShiftValueForRestart(ShiftValue shiftValue)

Registers a ShiftValue to trigger the app to restart. Must first set launcher class for restart using setLauncherClassForRestart(Class) before calling this.

subscribeToUpdatesForAllShiftValues

public void subscribeToUpdatesForAllShiftValues(ShiftValueListener listener)

Registers your Activity to call shiftValuesUpdated when any ShiftValue has been modified

subscribeToUpdatesForShiftValue

public void subscribeToUpdatesForShiftValue(ShiftValueListener listener,
                                   ShiftValue value)

Registers your ShiftValueListener to call shiftValuesUpdated when the given ShiftValue has been modified

subscribeToUpdatesForShiftValues

public void subscribeToUpdatesForShiftValues(ShiftValueListener listener,
                                    ShiftValue[] values)

Registers your Activity to call ShiftValueListener.onShiftValuesUpdated(ShiftValue) when the given ShiftValue have been modified

unsubscribeToUpdatesForAllShiftValues

public void unsubscribeToUpdatesForAllShiftValues(ShiftValueListener listener)

Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForAllShiftValues(ShiftValueListener) in your Activity's onCreate Your Activity will no longer receive updates when a ShiftValue has been updated

unsubscribeToUpdatesForShiftValue

public void unsubscribeToUpdatesForShiftValue(ShiftValueListener listener,
                                     ShiftValue value)

Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForShiftValue(ShiftValueListener, ShiftValue) in your Activity's onCreate. Your Activity will no longer receive updates when the given ShiftValue has been updated

unsubscribeToUpdatesForShiftValues

public void unsubscribeToUpdatesForShiftValues(ShiftValueListener listener,
                                      ShiftValue[] values)

Must be called on your Activity's onDestroy if you previously called subscribeToUpdatesForShiftValues(ShiftValueListener, ShiftValue[]) in your Activity's onCreate. Your Activity will no longer receive updates when the given ShiftValue have been updated

registerAction

public void registerAction(ShiftAction action)

Registers an action that can be run in Shift