RemotePreference

A RemotePreference is a view into preference logic which lives in another process. The primary use case for this is at the platform level where many applications may be contributing their preferences into the Settings app. A RemotePreference appears as a PreferenceScreen and redirects to the real application when clicked. The remote application can send events back to the preference when data changes and the view needs to be updated. See RemotePreferenceUpdater for a base class to use on the application side which implements the listeners and protocol. The interprocess communication is realized using BroadcastReceivers. When the application wants to update the RemotePreference with new data, it sends an ACTION_REFRESH_PREFERENCE with a particular Uri. The RemotePreference listens while attached, and performs an ordered broadcast with ACTION_UPDATE_PREFERENCE back to the application, which is then returned to the preference after being filled with new data. The external activity should include the META_REMOTE_RECEIVER and (optionally) the META_REMOTE_KEY strings in it's metadata. META_REMOTE_RECEIVER must contain the class name of the RemotePreferenceUpdater which we should request updates from. META_REMOTE_KEY must contain the key used by the preference which should match on both sides.

Constants
String	ACTION_REFRESH_PREFERENCE
String	ACTION_UPDATE_PREFERENCE
String	EXTRA_ENABLED
String	EXTRA_KEY
String	EXTRA_SUMMARY
String	META_REMOTE_KEY
String	META_REMOTE_RECEIVER

Fields
protected final Context	mContext

Public Constructors
	RemotePreference(Context context, AttributeSet attrs, int defStyle, int defStyleRes)
	RemotePreference(Context context, AttributeSet attrs, int defStyle)
	RemotePreference(Context context, AttributeSet attrs)

Public Methods
Intent	getReceiverIntent()
void	onAttached()
void	onDetached()
void	onRemoteUpdated(Bundle bundle)

Protected Methods
String	getRemoteKey(Bundle metaData)

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyle`	`int`
`defStyleRes`	`int`

Parameters
`context`	`Context`
`attrs`	`AttributeSet`
`defStyle`	`int`

Parameters
`context`	`Context`
`attrs`	`AttributeSet`

Returns
`Intent`

Parameters
`bundle`	`Bundle`

Parameters
`metaData`	`Bundle`

Returns
`String`

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	lineageos.preference.SelfRemovingPreference
		↳	lineageos.preference.RemotePreference

Interfaces

Classes

Class Overview

Summary

Constants

public static final String ACTION_REFRESH_PREFERENCE

public static final String ACTION_UPDATE_PREFERENCE

public static final String EXTRA_ENABLED

public static final String EXTRA_KEY

public static final String EXTRA_SUMMARY

public static final String META_REMOTE_KEY

public static final String META_REMOTE_RECEIVER

Fields

protected final Context mContext

Public Constructors

public RemotePreference (Context context, AttributeSet attrs, int defStyle, int defStyleRes)

public RemotePreference (Context context, AttributeSet attrs, int defStyle)

public RemotePreference (Context context, AttributeSet attrs)

Public Methods

public Intent getReceiverIntent ()

public void onAttached ()

public void onDetached ()

public void onRemoteUpdated (Bundle bundle)

Protected Methods

protected String getRemoteKey (Bundle metaData)