Default implementation of UgiConfigurationDelegate.
May be subclassed by applications.
Public Member Functions | |
Ugi | getUgi () |
Get the associated Ugi object. More... | |
boolean | getSendGrokkerSerialNumber () |
See whether the Grokker serial number should ever be sent to the U Grok It server (default = true) More... | |
void | setSendGrokkerSerialNumber (boolean b) |
Set whether the Grokker serial number should ever be sent to the U Grok It server. More... | |
void | waitUntilReady (final Runnable completion) |
Wait until the delegate is able to handle other calls. More... | |
void | permissionNeeded (final Runnable completion) |
Notify the user that permissions are needed (Marshmallow and beyond) and and for the permission. More... | |
void | notifyPermissionRequestFailed (final Runnable completion) |
Notify the user that the user did not grant permissions. More... | |
void | notifyAutoRotateOff (final Runnable completion) |
Notify the user that auto rotate is off. More... | |
void | showUserMessageBeforeFirstConnect (String message, final Runnable completion) |
Notify the user of a message before first connection. More... | |
void | promptAudioJackLocation () |
Prompt for changing the audio jack setting. | |
void | notifyCantSetVolume (final Runnable completion) |
Notify the user that we can't set the volume, so the user needs to. More... | |
void | cancelNotifyCantSetVolume () |
Cancel any notifyCantSetVolume() message. | |
boolean | getCheckServerForUnknownDevices () |
See whether the U Grok It server should be checked if the Android device is not recognized (default = true) More... | |
void | setCheckServerForUnknownDevices (boolean b) |
Set whether the U Grok It server should be checked if the Android device is not recognized. More... | |
boolean | getSendFirstConnectionAndAutomaticConfigurationReports () |
See whether first-connection and automatic-configuration reports should be sent to the U Grok It server (default = true) More... | |
void | setSendFirstConnectionAndAutomaticConfigurationReports (boolean b) |
Set whether first connection and automatic configuration reports should be sent. More... | |
void | autoConfigurationProgress (boolean isPluggedIn, AudioConnectionParams params, int configNum, int progressForConfig, int totalForConfig) |
Notification that automatic configuration is in progress. More... | |
void | autoConfigurationCompleted (boolean success, AudioConnectionParams params, int elapsedSeconds) |
Notification that automatic configuration has completed. More... | |
void | promptAudioReconfiguration () |
Prompt the user about audio configuration. | |
boolean | getDoAutomaticFirmwareUpdate () |
See whether automatic firmware update checks will be run (default = true) More... | |
void | setDoAutomaticFirmwareUpdate (boolean b) |
Set whether the Grokker firmware should be automatically updated via checking the U Grok It server. More... | |
void | promptForFirmwareUpdate (UgiFirmwareUpdateInfo info, final Runnable updateCompletion, final Runnable cancelCompletion, final Runnable postponeCompletion) |
A firmware update is available. More... | |
void | notifyFirmwareUpdateErrorLoadingUpdate (final Runnable completion) |
Notify the user that there was an error loading the firmware update. More... | |
void | displayFirmwareUpdateProgress (final Runnable cancelCompletion) |
Display progress notification about the firmware update. More... | |
void | updateFirmwareUpdateProgress (int amountDone, int amountTotal, boolean canCancel) |
Update the progress notification about the firmware update. More... | |
void | notifyFirmwareUpdateSuccess (int seconds, final Runnable completion) |
Notify the user the firmware update completed successfully. More... | |
void | notifyFirmwareUpdateFailure (boolean mustRetry, Ugi.FirmwareUpdateReturnValues error, final Runnable retryCompletion, final Runnable cancelCompletion) |
Notify the user that the firmware update failed. More... | |
void | abortFirmwareUpdateInteraction () |
Abort firmware update (Grokker has been disconnected) | |
void | afterFirmwareUpdate (boolean updated) |
Firmware update sequence has finished. More... | |
void | startBackgroundAction (WaitingCauses cause) |
Notification that a background action is starting. More... | |
void | finishBackgroundAction () |
Notification that a background action finished. | |
Object | showChoices (final String[] choices, int initialSelectedIndex, String title, String message, String actionButtonTitle, boolean canCancel, final UgiUiUtil.ShowChoicesCompletion actionCompletion, final UgiUiUtil.ShowChoicesConfirmationCompletion confirmationCompletion, final Runnable cancelCompletion) |
Show an alert dialog to choose from a list of choices. More... | |
Object | showOkCancel (String title, String message, String okButtonTitle, String cancelButtonTitle, final Runnable completion, final Runnable cancelCompletion) |
Show an alert dialog with ok and cancel buttons. More... | |
Object | showOk (String title, String message, String okButtonTitle, final Runnable completion) |
Show an alert dialog with an ok button. More... | |
void | hideAlert (Object alertDialog) |
Dismiss a dialog. More... | |
void | updateAlert (Object alertDialog, String message) |
Update the message in an alert dialog. More... | |
void | showWaiting (String message, final Runnable cancelCompletion) |
Show "waiting" alert dialog, call completion if cancelled. More... | |
void | showWaiting (String message) |
Show "waiting" alert dialog without cancel. More... | |
void | hideWaiting () |
Hide "waiting" alert dialog. | |
Ugi com.ugrokit.api.UgiDefaultConfigurationUi.getUgi | ( | ) |
boolean com.ugrokit.api.UgiDefaultConfigurationUi.getSendGrokkerSerialNumber | ( | ) |
See whether the Grokker serial number should ever be sent to the U Grok It server (default = true)
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.setSendGrokkerSerialNumber | ( | boolean | sendGrokkerSerialNumber | ) |
Set whether the Grokker serial number should ever be sent to the U Grok It server.
sendGrokkerSerialNumber | true to allow the Grokker serial number to be sent to the U Grok It server |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.waitUntilReady | ( | final Runnable | completion | ) |
Wait until the delegate is able to handle other calls.
completion | Block to execute when ready to handle other calls |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.permissionNeeded | ( | final Runnable | completion | ) |
Notify the user that permissions are needed (Marshmallow and beyond) and and for the permission.
completion | Block to execute when notification is complete |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyPermissionRequestFailed | ( | final Runnable | completion | ) |
Notify the user that the user did not grant permissions.
completion | Block to execute when notification is complete |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyAutoRotateOff | ( | final Runnable | completion | ) |
Notify the user that auto rotate is off.
completion | Block to execute when notification is complete |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.showUserMessageBeforeFirstConnect | ( | String | message, |
final Runnable | completion | ||
) |
Notify the user of a message before first connection.
message | The message to show |
completion | Block to execute when notification is complete |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyCantSetVolume | ( | final Runnable | completion | ) |
Notify the user that we can't set the volume, so the user needs to.
completion | Block to execute when notification is complete |
Implements com.ugrokit.api.UgiConfigurationDelegate.
boolean com.ugrokit.api.UgiDefaultConfigurationUi.getCheckServerForUnknownDevices | ( | ) |
See whether the U Grok It server should be checked if the Android device is not recognized (default = true)
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.setCheckServerForUnknownDevices | ( | boolean | checkServerForUnknownDevices | ) |
Set whether the U Grok It server should be checked if the Android device is not recognized.
checkServerForUnknownDevices | true if the server should be checked |
Implements com.ugrokit.api.UgiConfigurationDelegate.
boolean com.ugrokit.api.UgiDefaultConfigurationUi.getSendFirstConnectionAndAutomaticConfigurationReports | ( | ) |
See whether first-connection and automatic-configuration reports should be sent to the U Grok It server (default = true)
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.setSendFirstConnectionAndAutomaticConfigurationReports | ( | boolean | sendFirstConnectionAndAutomaticConfigurationReports | ) |
Set whether first connection and automatic configuration reports should be sent.
sendFirstConnectionAndAutomaticConfigurationReports | true if first connection and automatic configuration reports should be sent |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.autoConfigurationProgress | ( | boolean | isPluggedIn, |
AudioConnectionParams | params, | ||
int | configNum, | ||
int | progressForConfig, | ||
int | totalForConfig | ||
) |
Notification that automatic configuration is in progress.
isPluggedIn | true if something is plugged in (wait until this is true to display an alert) |
params | Audio parameters being tried currently |
configNum | Configuration number being tried |
progressForConfig | Step # with this configuration |
totalForConfig | Total # of steps for this configuration |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.autoConfigurationCompleted | ( | boolean | success, |
AudioConnectionParams | params, | ||
int | elapsedSeconds | ||
) |
Notification that automatic configuration has completed.
success | true if successful |
params | Audio parameters |
elapsedSeconds | Time required for automatic configuration |
Implements com.ugrokit.api.UgiConfigurationDelegate.
boolean com.ugrokit.api.UgiDefaultConfigurationUi.getDoAutomaticFirmwareUpdate | ( | ) |
See whether automatic firmware update checks will be run (default = true)
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.setDoAutomaticFirmwareUpdate | ( | boolean | doAutomaticFirmwareUpdate | ) |
Set whether the Grokker firmware should be automatically updated via checking the U Grok It server.
doAutomaticFirmwareUpdate | true if the Grokker firmware should be automatically updated |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.promptForFirmwareUpdate | ( | UgiFirmwareUpdateInfo | info, |
final Runnable | updateCompletion, | ||
final Runnable | cancelCompletion, | ||
final Runnable | postponeCompletion | ||
) |
A firmware update is available.
Prompt the user for whether to update. If the app does not want to update now, return NO call the Ugi method repromptForAutomaticFirmwareUpdateIfAvailable at some point.
info | Information about the firmware update that is available |
updateCompletion | Block to execute to do the update |
cancelCompletion | Block to execute if the user cancels |
postponeCompletion | Block to to postpone until later |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyFirmwareUpdateErrorLoadingUpdate | ( | final Runnable | completion | ) |
Notify the user that there was an error loading the firmware update.
completion | Block to execute after notification |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.displayFirmwareUpdateProgress | ( | final Runnable | cancelCompletion | ) |
Display progress notification about the firmware update.
cancelCompletion | Block to execute if the user cancels |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.updateFirmwareUpdateProgress | ( | int | amountDone, |
int | amountTotal, | ||
boolean | canCancel | ||
) |
Update the progress notification about the firmware update.
amountDone | Ammount of the firmware update that is done |
amountTotal | Ammount of the firmware update total |
canCancel | YES if the user can cancel at this point |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyFirmwareUpdateSuccess | ( | int | seconds, |
final Runnable | completion | ||
) |
Notify the user the firmware update completed successfully.
seconds | Number of seconds that the update took |
completion | Block to execute after notification |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.notifyFirmwareUpdateFailure | ( | boolean | mustRetry, |
Ugi.FirmwareUpdateReturnValues | error, | ||
final Runnable | retryCompletion, | ||
final Runnable | cancelCompletion | ||
) |
Notify the user that the firmware update failed.
mustRetry | YES of the user must retry (do not present a Cancel option) |
error | Error value |
retryCompletion | Block to execute to retry the update 9nil if the update cannot be retried) |
cancelCompletion | Block to execute if the user cancels |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.afterFirmwareUpdate | ( | boolean | updated | ) |
Firmware update sequence has finished.
updated | true if update succeeded |
Implements com.ugrokit.api.UgiConfigurationDelegate.
void com.ugrokit.api.UgiDefaultConfigurationUi.startBackgroundAction | ( | WaitingCauses | cause | ) |
Notification that a background action is starting.
Display a "waiting" alert
cause | Action that is about to start |
Implements com.ugrokit.api.UgiConfigurationDelegate.
Object com.ugrokit.api.UgiDefaultConfigurationUi.showChoices | ( | final String [] | choices, |
int | initialSelectedIndex, | ||
String | title, | ||
String | message, | ||
String | actionButtonTitle, | ||
boolean | canCancel, | ||
final UgiUiUtil.ShowChoicesCompletion | actionCompletion, | ||
final UgiUiUtil.ShowChoicesConfirmationCompletion | confirmationCompletion, | ||
final Runnable | cancelCompletion | ||
) |
Show an alert dialog to choose from a list of choices.
choices | Choices to choose from |
initialSelectedIndex | Choice to select initially |
title | Title for the alert |
message | Message for the alert |
actionButtonTitle | Text for the "ok" button, or "" for the default, or nil for no ok button |
canCancel | true if the user can cancel |
actionCompletion | Block to execute for "ok" |
confirmationCompletion | Block to execute before "ok" |
cancelCompletion | Block to execute for "cancel" |
Object com.ugrokit.api.UgiDefaultConfigurationUi.showOkCancel | ( | String | title, |
String | message, | ||
String | okButtonTitle, | ||
String | cancelButtonTitle, | ||
final Runnable | completion, | ||
final Runnable | cancelCompletion | ||
) |
Show an alert dialog with ok and cancel buttons.
title | Title for the alert |
message | Text for the body of the alert |
okButtonTitle | Text for the "ok" button, or "" for the default, or nil for no ok button |
cancelButtonTitle | Text for the "cancel" button, or "" for the default, or nil for no cancel button |
completion | Block to execute for "ok" |
cancelCompletion | Block to execute for "cancel" |
Object com.ugrokit.api.UgiDefaultConfigurationUi.showOk | ( | String | title, |
String | message, | ||
String | okButtonTitle, | ||
final Runnable | completion | ||
) |
Show an alert dialog with an ok button.
title | Title for the alert |
message | Text for the body of the alert |
okButtonTitle | Text for the "ok" button, or "" for the default, or nil for no ok button |
completion | Block to execute for "ok" |
void com.ugrokit.api.UgiDefaultConfigurationUi.hideAlert | ( | Object | alertDialog | ) |
Dismiss a dialog.
alertDialog | The alert dialog to dismiss |
void com.ugrokit.api.UgiDefaultConfigurationUi.updateAlert | ( | Object | alertDialog, |
String | message | ||
) |
Update the message in an alert dialog.
alertDialog | The alert dialog to update |
message | Text for the body of the alert dialog |
void com.ugrokit.api.UgiDefaultConfigurationUi.showWaiting | ( | String | message, |
final Runnable | cancelCompletion | ||
) |
Show "waiting" alert dialog, call completion if cancelled.
message | Text for the body of the alert dialog |
cancelCompletion | Block to execute for "cancel" (or nil if cancel is not an option) |
void com.ugrokit.api.UgiDefaultConfigurationUi.showWaiting | ( | String | message | ) |
Show "waiting" alert dialog without cancel.
message | Text for the body of the alert dialog |