com.idevicesinc.sweetblue.utils

Class BleSetupHelper.BluetoothEnablerImpl

java.lang.Object

com.idevicesinc.sweetblue.utils.BleSetupHelper.BluetoothEnablerImpl

Enclosing class:

BleSetupHelper

public static class BleSetupHelper.BluetoothEnablerImpl
extends java.lang.Object

This class implements all of the enabler logic that can be overridden to alter the look or the messaging of the enabler. Additionally, if you want to use the enabler to request custom permissions, you must provide your own subclass of the implementation that implements checkIsCustomPermissionRequired(java.lang.Object), checkIsCustomPermissionEnabled(java.lang.Object) and requestCustomPermission(java.lang.Object). See each individual method for more information

Field Summary

Fields

Modifier and Type	Field and Description
protected BleSetupHelper	mEnabler

Constructor Summary

Constructors

Constructor and Description
BluetoothEnablerImpl()

Method Summary

Modifier and Type	Method and Description
boolean	checkIsCustomPermissionEnabled(java.lang.Object metadata) This method is used by the enabler to determine if a given custom permission enabled.
boolean	checkIsCustomPermissionRequired(java.lang.Object metadata) This method is used by the enabler to determine if a given custom permission is required.
java.lang.String	getString(BleSetupHelper.DefaultString ds) This method is used by the enabler to obtain strings that will be shown to the user.
protected void	onCustomPermissionRequestComplete() This method is only used if you are implementing custom permissions in a subclass.
void	requestCustomPermission(java.lang.Object metadata) This method implements the actual logic required to request a permission from the user.
void	showDialog(BleSetupHelper.PermissionInstance pi, java.lang.String message, java.lang.String button1Text, java.lang.String button2Text, android.content.DialogInterface.OnClickListener clickListener, android.content.DialogInterface.OnDismissListener dismissListener) This method is responsible for creating and showing a dialog to the user.
void	showToast(BleSetupHelper.PermissionInstance pi, java.lang.String message) This method is responsible for showing a toast to the user.

Methods inherited from class java.lang.Object

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

Field Detail

mEnabler

protected BleSetupHelper mEnabler

Constructor Detail

BluetoothEnablerImpl

public BluetoothEnablerImpl()

Method Detail

getString

public java.lang.String getString(BleSetupHelper.DefaultString ds)

This method is used by the enabler to obtain strings that will be shown to the user. If you override it in a subclass, you can alter the strings used by the enabler. See BleSetupHelper.DefaultString for possible enum values

Parameters:

ds - - enum value for the string being requested

Returns:

the value for the requested string

checkIsCustomPermissionRequired

public boolean checkIsCustomPermissionRequired(java.lang.Object metadata)

This method is used by the enabler to determine if a given custom permission is required. You must implement this in a subclass if you are using custom permissions.

Parameters:

metadata - - the metadata associated with the custom permission being checked

Returns:

if this permission needs to be enabled

checkIsCustomPermissionEnabled

public boolean checkIsCustomPermissionEnabled(java.lang.Object metadata)

This method is used by the enabler to determine if a given custom permission enabled. You must implement this in a subclass if you are using custom permissions. Any custom permissions that are both required and not enabled will be requested.

Parameters:

metadata - - the metadata associated with the custom permission being checked

Returns:

if this permission is enabled

requestCustomPermission

public void requestCustomPermission(java.lang.Object metadata)

This method implements the actual logic required to request a permission from the user. You must implement this in a subclass if you are using custom permissions. The enabler will call this method and provide the metadata associated with the permission in question. When you are done requesting the permission, you MUST call requestCustomPermission(Object) afterward, regardless of the outcome.

Parameters:

metadata - - the metadata associated with the custom permission being checked

onCustomPermissionRequestComplete

protected final void onCustomPermissionRequestComplete()

This method is only used if you are implementing custom permissions in a subclass. If not, you can safely ignore it. This method must be called once and only once after a custom permission has been requested from the user via the requestCustomPermission(Object) method.

showDialog

public void showDialog(BleSetupHelper.PermissionInstance pi,
                       java.lang.String message,
                       java.lang.String button1Text,
                       java.lang.String button2Text,
                       android.content.DialogInterface.OnClickListener clickListener,
                       android.content.DialogInterface.OnDismissListener dismissListener)

This method is responsible for creating and showing a dialog to the user. If you want to customize the appearance of the dialogs, or if you want to show some other type of UI instead of a dialog, you can subclass this method. You MUST call either the clickListener or the dismissListener when you are done (but not both). If the clickListener is called, the enabler will treat this as the user agreeing to grant the permission, and will continue with the next step. If the dismissListener is called, the permission will be rejected.

Parameters:

pi - - the permission instance this dialog is associated with

message - - the message the dialog should display

button1Text - - the text for the first button on the dialog (neutral, or positive in 2 button dialog)

button2Text - - the text for the negative button on the dialog, or null if there is only one button

clickListener - - the listener that must be called if the positive button is clicked, or if the user agrees to allowing the permission in a custom UI

dismissListener - - the listener that must be called if the user declines to allow the permission, or if the dialog is dismissed in any other way

showToast

public void showToast(BleSetupHelper.PermissionInstance pi,
                      java.lang.String message)

This method is responsible for showing a toast to the user. If you want to customize the appearance of the toasts, or if you want to show some other type of UI instead, you can subclass this method. Toasts are normally used when we must open the system settings panel, so that we can show the user a message ontop of the settings

Parameters:

pi - - the permission instance this toast is associated with

message - - the message the toast should display