Changes to API adding new templates and actions (2d212127) · Commits · e / os / android_frameworks_base

core/java/android/service/controls/Control.java

+120 −56

Original line number	Diff line number	Diff line
		@@ -20,10 +20,11 @@ import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.app.PendingIntent;
		import android.content.Intent;
		import android.content.res.ColorStateList;
		import android.graphics.drawable.Icon;
		import android.os.Parcel;
		import android.os.Parcelable;
		import android.service.controls.actions.ControlAction;
		import android.service.controls.templates.ControlTemplate;
		import android.util.Log;

		import com.android.internal.util.Preconditions;

		@@ -37,64 +38,90 @@ import com.android.internal.util.Preconditions;
		* Each control needs a unique (per provider) identifier that is persistent across reboots of the
		* system.
		* <p>
		* Each {@link Control} will have a name and an icon. The name is usually set up by the user in the
		* {@link ControlProvider} while the icon is usually decided by the {@link ControlProvider} based
		* on the type of device.
		* Each {@link Control} will have a name, a subtitle and will optionally belong to a structure
		* and zone. Some of these values are defined by the user and/or the {@link ControlProviderService}
		* and will be used to display the control as well as group them for management.
		* <p>
		* Each object will have an associated {@link DeviceTypes.DeviceType}. This will determine the icons and colors
		* used to display it.
		* <p>
		* The {@link ControlTemplate.TemplateType} provided will be used as a hint when displaying this in
		* non-interactive situations (for example when there's no state to display). This template is not
		* the one that will be shown with the current state and provide interactions. That template is set
		* using {@link ControlState}.
		* <p>
		* An {@link Intent} linking to the provider Activity that expands this {@link Control} should be
		* provided.
		* An {@link Intent} linking to the provider Activity that expands on this {@link Control} and
		* allows for further actions should be provided.
		* @hide
		*/
		public class Control implements Parcelable {
		private static final String TAG = "Control";

		;

		private final @NonNull String mControlId;
		private final @NonNull Icon mIcon;
		private final @DeviceTypes.DeviceType
		int mDeviceType;
		private final @NonNull CharSequence mTitle;
		private final @Nullable ColorStateList mTintColor;
		private final @NonNull CharSequence mSubtitle;
		private final @Nullable CharSequence mStructure;
		private final @Nullable CharSequence mZone;
		private final @NonNull PendingIntent mAppIntent;
		private final @ControlTemplate.TemplateType int mPrimaryType;

		/**
		* @param controlId the unique persistent identifier for this object.
		* @param icon an icon to display identifying the control.
		* @param deviceType the type of device for this control. This will determine icons and colors.
		* @param title the user facing name of this control (e.g. "Bedroom thermostat").
		* @param tintColor the color to tint parts of the element UI. If {@code null} is passed, the
		* system accent color will be used.
		* @param subtitle a user facing subtitle with extra information about this control
		* @param structure a user facing name for the structure containing the device associated with
		* this control.
		* @param zone
		* @param appIntent a {@link PendingIntent} linking to a page to interact with the
		* corresponding device.
		* @param primaryType the primary template for this type.
		*/
		public Control(@NonNull String controlId,
		@NonNull Icon icon,
		@DeviceTypes.DeviceType int deviceType,
		@NonNull CharSequence title,
		@Nullable ColorStateList tintColor,
		@NonNull CharSequence subtitle,
		@Nullable CharSequence structure,
		@Nullable CharSequence zone,
		@NonNull PendingIntent appIntent,
		int primaryType) {
		Preconditions.checkNotNull(controlId);
		Preconditions.checkNotNull(icon);
		Preconditions.checkNotNull(title);
		Preconditions.checkNotNull(subtitle);
		Preconditions.checkNotNull(appIntent);
		mControlId = controlId;
		mIcon = icon;
		if (!DeviceTypes.validDeviceType(deviceType)) {
		Log.e(TAG, "Invalid device type:" + deviceType);
		mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		} else {
		mDeviceType = deviceType;
		}
		mTitle = title;
		mTintColor = tintColor;
		mSubtitle = subtitle;
		mStructure = structure;
		mZone = zone;
		mAppIntent = appIntent;
		mPrimaryType = primaryType;
		}

		public Control(Parcel in) {
		mControlId = in.readString();
		mIcon = Icon.CREATOR.createFromParcel(in);
		mDeviceType = in.readInt();
		mTitle = in.readCharSequence();
		if (in.readByte() == 1) {
		mTintColor = ColorStateList.CREATOR.createFromParcel(in);
		mSubtitle = in.readCharSequence();
		if (in.readByte() == (byte) 1) {
		mStructure = in.readCharSequence();
		} else {
		mTintColor = null;
		mStructure = null;
		}
		if (in.readByte() == (byte) 1) {
		mZone = in.readCharSequence();
		} else {
		mZone = null;
		}
		mAppIntent = PendingIntent.CREATOR.createFromParcel(in);
		mPrimaryType = in.readInt();
		@@ -105,9 +132,9 @@ public class Control implements Parcelable {
		return mControlId;
		}

		@NonNull
		public Icon getIcon() {
		return mIcon;
		@DeviceTypes.DeviceType
		public int getDeviceType() {
		return mDeviceType;
		}

		@NonNull
		@@ -115,9 +142,19 @@ public class Control implements Parcelable {
		return mTitle;
		}

		@NonNull
		public CharSequence getSubtitle() {
		return mSubtitle;
		}

		@Nullable
		public CharSequence getStructure() {
		return mStructure;
		}

		@Nullable
		public ColorStateList getTint() {
		return mTintColor;
		public CharSequence getZone() {
		return mZone;
		}

		@NonNull
		@@ -125,7 +162,7 @@ public class Control implements Parcelable {
		return mAppIntent;
		}

		@ControlTemplate.TemplateType
		@android.service.controls.templates.ControlTemplate.TemplateType
		public int getPrimaryType() {
		return mPrimaryType;
		}
		@@ -138,11 +175,18 @@ public class Control implements Parcelable {
		@Override
		public void writeToParcel(Parcel dest, int flags) {
		dest.writeString(mControlId);
		mIcon.writeToParcel(dest, flags);
		dest.writeInt(mDeviceType);
		dest.writeCharSequence(mTitle);
		if (mTintColor != null) {
		dest.writeCharSequence(mSubtitle);
		if (mStructure != null) {
		dest.writeByte((byte) 1);
		dest.writeCharSequence(mStructure);
		} else {
		dest.writeByte((byte) 0);
		}
		if (mZone != null) {
		dest.writeByte((byte) 1);
		mTintColor.writeToParcel(dest, flags);
		dest.writeCharSequence(mZone);
		} else {
		dest.writeByte((byte) 0);
		}
		@@ -168,31 +212,33 @@ public class Control implements Parcelable {
		* This class facilitates the creation of {@link Control}. It provides the following
		* defaults for non-optional parameters:
		* <ul>
		* <li> Device type: {@link DeviceTypes#TYPE_UNKNOWN}
		* <li> Title: {@code ""}
		* <li> Subtitle: {@code ""}
		* <li> Primary template: {@link ControlTemplate#TYPE_NONE}
		* </ul>
		*/
		public static class Builder {
		private String mControlId;
		private Icon mIcon;
		private CharSequence mTitle = "";
		private ColorStateList mTintColor;
		private @Nullable PendingIntent mAppIntent;
		private static final String TAG = "Control.Builder";
		private @NonNull String mControlId;
		private @DeviceTypes.DeviceType
		int mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		private @NonNull CharSequence mTitle = "";
		private @NonNull CharSequence mSubtitle = "";
		private @Nullable CharSequence mStructure;
		private @Nullable CharSequence mZone;
		private @NonNull PendingIntent mAppIntent;
		private @ControlTemplate.TemplateType int mPrimaryType = ControlTemplate.TYPE_NONE;

		/**
		* @param controlId the identifier for the {@link Control}.
		* @param icon the icon for the {@link Control}.
		* @param appIntent the pending intent linking to the device Activity.
		*/
		public Builder(@NonNull String controlId,
		@NonNull Icon icon,
		@NonNull PendingIntent appIntent) {
		Preconditions.checkNotNull(controlId);
		Preconditions.checkNotNull(icon);
		Preconditions.checkNotNull(appIntent);
		mControlId = controlId;
		mIcon = icon;
		mAppIntent = appIntent;
		}

		@@ -203,9 +249,11 @@ public class Control implements Parcelable {
		public Builder(@NonNull Control control) {
		Preconditions.checkNotNull(control);
		mControlId = control.mControlId;
		mIcon = control.mIcon;
		mDeviceType = control.mDeviceType;
		mTitle = control.mTitle;
		mTintColor = control.mTintColor;
		mSubtitle = control.mSubtitle;
		mStructure = control.mStructure;
		mZone = control.mZone;
		mAppIntent = control.mAppIntent;
		mPrimaryType = control.mPrimaryType;
		}
		@@ -214,20 +262,21 @@ public class Control implements Parcelable {
		* @param controlId the identifier for the {@link Control}.
		* @return {@code this}
		*/
		@NonNull
		public Builder setControlId(@NonNull String controlId) {
		Preconditions.checkNotNull(controlId);
		mControlId = controlId;
		return this;
		}

		/**
		* @param icon the icon for the {@link Control}
		* @return {@code this}
		*/
		@NonNull
		public Builder setIcon(@NonNull Icon icon) {
		Preconditions.checkNotNull(icon);
		mIcon = icon;
		public Builder setDeviceType(@DeviceTypes.DeviceType int deviceType) {
		if (!DeviceTypes.validDeviceType(deviceType)) {
		Log.e(TAG, "Invalid device type:" + deviceType);
		mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		} else {
		mDeviceType = deviceType;
		}
		return this;
		}

		@@ -242,14 +291,22 @@ public class Control implements Parcelable {
		return this;
		}

		/**
		* @param tint colors for tinting parts of the {@link Control} UI. Passing {@code null} will
		* default to using the current color accent.
		* @return {@code this}
		*/
		@NonNull
		public Builder setTint(@Nullable ColorStateList tint) {
		mTintColor = tint;
		public Builder setSubtitle(@NonNull CharSequence subtitle) {
		Preconditions.checkNotNull(subtitle);
		mSubtitle = subtitle;
		return this;
		}

		@NonNull
		public Builder setStructure(@Nullable CharSequence structure) {
		mStructure = structure;
		return this;
		}

		@NonNull
		public Builder setZone(@Nullable CharSequence zone) {
		mZone = zone;
		return this;
		}

		@@ -280,7 +337,14 @@ public class Control implements Parcelable {
		*/
		@NonNull
		public Control build() {
		return new Control(mControlId, mIcon, mTitle, mTintColor, mAppIntent, mPrimaryType);
		return new Control(mControlId,
		mDeviceType,
		mTitle,
		mSubtitle,
		mStructure,
		mZone,
		mAppIntent,
		mPrimaryType);
		}
		}
		}

core/java/android/service/controls/ControlState.java

+58 −114

Original line number	Diff line number	Diff line
		@@ -20,10 +20,10 @@ import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.app.PendingIntent;
		import android.content.res.ColorStateList;
		import android.graphics.drawable.Icon;
		import android.os.Parcel;
		import android.os.Parcelable;
		import android.service.controls.templates.ControlTemplate;
		import android.util.Log;

		import com.android.internal.util.Preconditions;

		@@ -36,13 +36,15 @@ import java.lang.annotation.RetentionPolicy;
		* Collects information to render the current state of a {@link Control} as well as possible action
		* that can be performed on it.
		* <p>
		* Additionally, this object is used to modify elements from the {@link Control} such as icons,
		* colors, names and intents. This information will last until it is again modified by a
		* Additionally, this object is used to modify elements from the {@link Control} such as device
		* type, and intents. This information will last until it is again modified by a
		* {@link ControlState}.
		* @hide
		*/
		public final class ControlState implements Parcelable {

		private static final String TAG = "ControlState";

		/**
		* @hide
		*/
		@@ -76,81 +78,60 @@ public final class ControlState implements Parcelable {
		public static final int STATUS_DISABLED = 3;

		private final @NonNull String mControlId;
		private final @DeviceTypes.DeviceType int mDeviceType;
		private final @Status int mStatus;
		private final @NonNull ControlTemplate mControlTemplate;
		private final @NonNull CharSequence mStatusText;
		private final @Nullable CharSequence mTitle;
		private final @Nullable PendingIntent mAppIntent;
		private final @Nullable Icon mIcon;
		private final @Nullable ColorStateList mTint;

		/**
		* @param controlId the identifier of the {@link Control} this object refers to.
		* @param status the current status of the {@link Control}.
		* @param deviceType the {@link DeviceTypes.DeviceType} to replace the one set in the
		* {@link Control} or set in the last {@link ControlState}. In order to keep
		* the current device type for this {@link Control}, the old value must be
		* passed.
		* @param controlTemplate the template to be used to render the {@link Control}. This can be
		* of a different
		* {@link android.service.controls.ControlTemplate.TemplateType} than the
		* of a different {@link ControlTemplate.TemplateType} than the
		* one defined in {@link Control#getPrimaryType}
		* @param statusText the user facing text describing the current status.
		* @param title the title to replace the one set in the {@link Control} or set in the
		* last {@link ControlState}. Pass {@code null} to use the last value set for this
		* {@link Control}
		* @param appIntent the {@link PendingIntent} to replace the one set in the {@link Control} or
		* set in the last {@link ControlState}. Pass {@code null} to use the last
		* value set for this {@link Control}.
		* @param icon the icon to replace the one set in the {@link Control} or set in the last
		* {@link ControlState}. Pass {@code null} to use the last value set for this
		* {@link Control}.
		* @param tint the colors to replace those set in the {@link Control} or set in the last
		* {@link ControlState}. Pass {@code null} to use the last value set for this
		* {@link Control}.
		*/
		public ControlState(@NonNull String controlId,
		int status,
		@DeviceTypes.DeviceType int deviceType,
		@Status int status,
		@NonNull ControlTemplate controlTemplate,
		@NonNull CharSequence statusText,
		@Nullable CharSequence title,
		@Nullable PendingIntent appIntent,
		@Nullable Icon icon,
		@Nullable ColorStateList tint) {
		@Nullable PendingIntent appIntent) {
		Preconditions.checkNotNull(controlId);
		Preconditions.checkNotNull(controlTemplate);
		Preconditions.checkNotNull(statusText);
		mControlId = controlId;
		if (!DeviceTypes.validDeviceType(deviceType)) {
		Log.e(TAG, "Invalid device type:" + deviceType);
		mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		} else {
		mDeviceType = deviceType;
		}
		mStatus = status;
		mControlTemplate = controlTemplate;
		mStatusText = statusText;
		mTitle = title;
		mAppIntent = appIntent;
		mIcon = icon;
		mTint = tint;
		}

		ControlState(Parcel in) {
		mControlId = in.readString();
		mDeviceType = in.readInt();
		mStatus = in.readInt();
		mControlTemplate = ControlTemplate.CREATOR.createFromParcel(in);
		mStatusText = in.readCharSequence();
		if (in.readByte() == 1) {
		mTitle = in.readCharSequence();
		} else {
		mTitle = null;
		}
		if (in.readByte() == 1) {
		mAppIntent = PendingIntent.CREATOR.createFromParcel(in);
		} else {
		mAppIntent = null;
		}
		if (in.readByte() == 1) {
		mIcon = Icon.CREATOR.createFromParcel(in);
		} else {
		mIcon = null;
		}
		if (in.readByte() == 1) {
		mTint = ColorStateList.CREATOR.createFromParcel(in);
		} else {
		mTint = null;
		}
		}

		@Override
		@@ -163,9 +144,9 @@ public final class ControlState implements Parcelable {
		return mControlId;
		}

		@Nullable
		public CharSequence getTitle() {
		return mTitle;
		@DeviceTypes.DeviceType
		public int getDeviceType() {
		return mDeviceType;
		}

		@Nullable
		@@ -183,51 +164,24 @@ public final class ControlState implements Parcelable {
		return mControlTemplate;
		}

		@Nullable
		public Icon getIcon() {
		return mIcon;
		}

		@NonNull
		public CharSequence getStatusText() {
		return mStatusText;
		}

		@Nullable
		public ColorStateList getTint() {
		return mTint;
		}

		@Override
		public void writeToParcel(Parcel dest, int flags) {
		dest.writeString(mControlId);
		dest.writeInt(mDeviceType);
		dest.writeInt(mStatus);
		mControlTemplate.writeToParcel(dest, flags);
		dest.writeCharSequence(mStatusText);
		if (mTitle != null) {
		dest.writeByte((byte) 1);
		dest.writeCharSequence(mTitle);
		} else {
		dest.writeByte((byte) 0);
		}
		if (mAppIntent != null) {
		dest.writeByte((byte) 1);
		mAppIntent.writeToParcel(dest, flags);
		} else {
		dest.writeByte((byte) 0);
		}
		if (mIcon != null) {
		dest.writeByte((byte) 1);
		mIcon.writeToParcel(dest, flags);
		} else {
		dest.writeByte((byte) 0);
		}
		if (mTint != null) {
		dest.writeByte((byte) 1);
		mTint.writeToParcel(dest, flags);
		} else {
		dest.writeByte((byte) 0);
		}
		}

		public static final Creator<ControlState> CREATOR = new Creator<ControlState>() {
		@@ -248,20 +202,22 @@ public final class ControlState implements Parcelable {
		* This class facilitates the creation of {@link ControlState}. It provides the following
		* defaults for non-optional parameters:
		* <ul>
		* <li> Device type: {@link DeviceTypes#TYPE_UNKNOWN}
		* <li> Status: {@link ControlState#STATUS_OK}
		* <li> Control template: {@link ControlTemplate#NO_TEMPLATE}
		* <li> Status text: {@code ""}
		* </ul>
		*/
		public static class Builder {
		private static final String TAG = "ControlState.Builder";

		private @NonNull String mControlId;
		private @DeviceTypes.DeviceType
		int mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		private @Status int mStatus = STATUS_OK;
		private @NonNull ControlTemplate mControlTemplate = ControlTemplate.NO_TEMPLATE;
		private @NonNull CharSequence mStatusText = "";
		private @Nullable CharSequence mTitle;
		private @Nullable PendingIntent mAppIntent;
		private @Nullable Icon mIcon;
		private @Nullable ColorStateList mTint;

		/**
		* @param controlId the identifier of the {@link Control} that the resulting
		@@ -279,13 +235,11 @@ public final class ControlState implements Parcelable {
		public Builder(@NonNull ControlState controlState) {
		Preconditions.checkNotNull(controlState);
		mControlId = controlState.mControlId;
		mDeviceType = controlState.mDeviceType;
		mStatus = controlState.mStatus;
		mControlTemplate = controlState.mControlTemplate;
		mStatusText = controlState.mStatusText;
		mTitle = controlState.mTitle;
		mAppIntent = controlState.mAppIntent;
		mIcon = controlState.mIcon;
		mTint = controlState.mTint;
		}


		@@ -299,6 +253,21 @@ public final class ControlState implements Parcelable {
		return this;
		}

		/**
		* @param deviceType the device type of the {@link Control}.
		* @return {@code this}
		*/
		@NonNull
		public Builder setDeviceType(@DeviceTypes.DeviceType int deviceType) {
		if (!DeviceTypes.validDeviceType(deviceType)) {
		Log.e(TAG, "Invalid device type:" + deviceType);
		mDeviceType = DeviceTypes.TYPE_UNKNOWN;
		} else {
		mDeviceType = deviceType;
		}
		return this;
		}

		/**
		* @param status the current status of the {@link Control}
		* @return {@code this}
		@@ -331,18 +300,6 @@ public final class ControlState implements Parcelable {
		return this;
		}

		/**
		* @param title the title to replace the one defined in the corresponding {@link Control} or
		* set by the last {@link ControlState}. Pass {@code null} to keep the last
		* value.
		* @return {@code this}
		*/
		@NonNull
		public Builder setTitle(@Nullable CharSequence title) {
		mTitle = title;
		return this;
		}

		/**
		* @param appIntent the Pending Intent to replace the one defined in the corresponding
		* {@link Control} or set by the last {@link ControlState}. Pass
		@@ -356,35 +313,22 @@ public final class ControlState implements Parcelable {
		}

		/**
		* @param icon the title to replace the one defined in the corresponding {@link Control} or
		* set by the last {@link ControlState}. Pass {@code null} to keep the last
		* value.
		* @return {@code this}
		*/
		@NonNull
		public Builder setIcon(@Nullable Icon icon) {
		mIcon = icon;
		return this;
		}

		/**
		* @param tint the title to replace the one defined in the corresponding {@link Control} or
		* set by the last {@link ControlState}. Pass {@code null} to keep the last
		* value.
		* @return {@code this}
		* @return a new {@link ControlState}
		*/
		@NonNull
		public Builder setTint(@Nullable ColorStateList tint) {
		mTint = tint;
		return this;
		public ControlState build() {
		return new ControlState(mControlId, mDeviceType, mStatus, mControlTemplate, mStatusText,
		mAppIntent);
		}

		/**
		* @return a new {@link ControlState}
		* Creates a new {@link ControlState.Builder} for the given {@link Control}.
		*
		* This will set the corresponding identifier as well as the device type.
		* @param control the {@link Control} to create a state for.
		* @return a {@link ControlState.Builder} for a {@link Control}
		*/
		public ControlState build() {
		return new ControlState(mControlId, mStatus, mControlTemplate, mStatusText,
		mTitle, mAppIntent, mIcon, mTint);
		public static Builder createForControl(Control control) {
		return new Builder(control.getControlId()).setDeviceType(control.getDeviceType());
		}
		}
		}

core/java/android/service/controls/ControlsProviderService.java

+1 −0

Original line number	Diff line number	Diff line
		@@ -25,6 +25,7 @@ import android.os.Handler;
		import android.os.IBinder;
		import android.os.Looper;
		import android.os.Message;
		import android.service.controls.actions.ControlAction;

		import java.util.List;

core/java/android/service/controls/DeviceTypes.java

0 → 100644

+173 −0

File added.

Preview size limit exceeded, changes collapsed.

core/java/android/service/controls/IControlsProvider.aidl

+1 −1

Original line number	Diff line number	Diff line
		@@ -16,7 +16,7 @@

		package android.service.controls;

		import android.service.controls.ControlAction;
		import android.service.controls.actions.ControlAction;

		/** @hide */
		oneway interface IControlsProvider {