Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9dc36157 authored by Chirag Shah's avatar Chirag Shah
Browse files

Add support for schema.org actions in the assist data bundle. 

Allow developers to include schema.org metadata to represent an action
a user is performing on the screen.

This will allow applications to report content a user is viewing (ViewAction),
music the user is listening to (ListenAction), etc.

Design: http://go/appindexingapi:bundle

Change-Id: I34544880ac877ffe44671139585304f0498a64eb
parent 27e3514e

api/current.txt

+42 −0
Original line number Diff line number Diff line
@@ -3965,6 +3965,48 @@ package android.app { 
    field public java.lang.String serviceDetails;

  }













  public final class AssistAction {













    method public static void updateAssistData(android.os.Bundle, android.os.Bundle);













    field public static final java.lang.String ASSIST_ACTION_KEY = "android:assist_action";













    field public static final java.lang.String KEY_ACTION_OBJECT = "object";













    field public static final java.lang.String KEY_ACTION_STATUS = "actionStatus";













    field public static final java.lang.String KEY_DESCRIPTION = "description";













    field public static final java.lang.String KEY_ID = "@id";













    field public static final java.lang.String KEY_NAME = "name";













    field public static final java.lang.String KEY_TYPE = "@type";













    field public static final java.lang.String KEY_URL = "url";













    field public static final java.lang.String STATUS_TYPE_ACTIVE = "ActiveActionStatus";













    field public static final java.lang.String STATUS_TYPE_COMPLETED = "CompletedActionStatus";













    field public static final java.lang.String TYPE_ADD_ACTION = "AddAction";













    field public static final java.lang.String TYPE_BOOKMARK_ACTION = "BookmarkAction";













    field public static final java.lang.String TYPE_LIKE_ACTION = "LikeAction";













    field public static final java.lang.String TYPE_LISTEN_ACTION = "ListenAction";













    field public static final java.lang.String TYPE_VIEW_ACTION = "ViewAction";













    field public static final java.lang.String TYPE_WANT_ACTION = "WantAction";













    field public static final java.lang.String TYPE_WATCH_ACTION = "WatchAction";













  }

























  public static final class AssistAction.ActionBuilder {













    ctor public AssistAction.ActionBuilder();













    method public android.os.Bundle build();













    method public android.app.AssistAction.ActionBuilder set(java.lang.String, java.lang.String);













    method public android.app.AssistAction.ActionBuilder set(java.lang.String, android.os.Bundle);













    method public android.app.AssistAction.ActionBuilder setObject(android.os.Bundle);













    method public android.app.AssistAction.ActionBuilder setType(java.lang.String);













  }

























  public static final class AssistAction.ThingBuilder {













    ctor public AssistAction.ThingBuilder();













    method public android.os.Bundle build();













    method public android.app.AssistAction.ThingBuilder set(java.lang.String, java.lang.String);













    method public android.app.AssistAction.ThingBuilder set(java.lang.String, android.os.Bundle);













    method public android.app.AssistAction.ThingBuilder setDescription(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setId(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setName(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setType(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setUrl(android.net.Uri);













  }



























  public class AssistContent implements android.os.Parcelable {















    ctor public AssistContent();















    method public int describeContents();

























api/system-current.txt



+42
−0




























Original line number
Diff line number
Diff line








@@ -4054,6 +4054,48 @@ package android.app {













    field public java.lang.String serviceDetails;















  }



























  public final class AssistAction {













    method public static void updateAssistData(android.os.Bundle, android.os.Bundle);













    field public static final java.lang.String ASSIST_ACTION_KEY = "android:assist_action";













    field public static final java.lang.String KEY_ACTION_OBJECT = "object";













    field public static final java.lang.String KEY_ACTION_STATUS = "actionStatus";













    field public static final java.lang.String KEY_DESCRIPTION = "description";













    field public static final java.lang.String KEY_ID = "@id";













    field public static final java.lang.String KEY_NAME = "name";













    field public static final java.lang.String KEY_TYPE = "@type";













    field public static final java.lang.String KEY_URL = "url";













    field public static final java.lang.String STATUS_TYPE_ACTIVE = "ActiveActionStatus";













    field public static final java.lang.String STATUS_TYPE_COMPLETED = "CompletedActionStatus";













    field public static final java.lang.String TYPE_ADD_ACTION = "AddAction";













    field public static final java.lang.String TYPE_BOOKMARK_ACTION = "BookmarkAction";













    field public static final java.lang.String TYPE_LIKE_ACTION = "LikeAction";













    field public static final java.lang.String TYPE_LISTEN_ACTION = "ListenAction";













    field public static final java.lang.String TYPE_VIEW_ACTION = "ViewAction";













    field public static final java.lang.String TYPE_WANT_ACTION = "WantAction";













    field public static final java.lang.String TYPE_WATCH_ACTION = "WatchAction";













  }

























  public static final class AssistAction.ActionBuilder {













    ctor public AssistAction.ActionBuilder();













    method public android.os.Bundle build();













    method public android.app.AssistAction.ActionBuilder set(java.lang.String, java.lang.String);













    method public android.app.AssistAction.ActionBuilder set(java.lang.String, android.os.Bundle);













    method public android.app.AssistAction.ActionBuilder setObject(android.os.Bundle);













    method public android.app.AssistAction.ActionBuilder setType(java.lang.String);













  }

























  public static final class AssistAction.ThingBuilder {













    ctor public AssistAction.ThingBuilder();













    method public android.os.Bundle build();













    method public android.app.AssistAction.ThingBuilder set(java.lang.String, java.lang.String);













    method public android.app.AssistAction.ThingBuilder set(java.lang.String, android.os.Bundle);













    method public android.app.AssistAction.ThingBuilder setDescription(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setId(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setName(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setType(java.lang.String);













    method public android.app.AssistAction.ThingBuilder setUrl(android.net.Uri);













  }



























  public class AssistContent implements android.os.Parcelable {















    ctor public AssistContent();















    method public int describeContents();

























core/java/android/app/AssistAction.java
0 → 100644



+277
−0




























Original line number
Diff line number
Diff line













/*













 * Copyright (C) 2015 The Android Open Source Project













 *













 * Licensed under the Apache License, Version 2.0 (the "License");













 * you may not use this file except in compliance with the License.













 * You may obtain a copy of the License at













 *













 *      http://www.apache.org/licenses/LICENSE-2.0













 *













 * Unless required by applicable law or agreed to in writing, software













 * distributed under the License is distributed on an "AS IS" BASIS,













 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.













 * See the License for the specific language governing permissions and













 * limitations under the License.













 */



























package android.app;



























import android.annotation.NonNull;













import android.annotation.Nullable;













import android.net.Uri;













import android.os.Bundle;













import android.text.TextUtils;



























import com.android.internal.util.Preconditions;



























/**













 * Helper class for building a {@link Bundle} representing an action being performed by the user,













 * to be included in the Bundle generated by {@link Activity#onProvideAssistData}.













 *













 * @see Activity#onProvideAssistData













 */













public final class AssistAction {



























    /**













     * Key name for the Bundle containing the schema.org representation of













     * an action performed, and should be stored in the Bundle generated by













     * {@link Activity#onProvideAssistData}.













     */













    public static final String ASSIST_ACTION_KEY = "android:assist_action";



























    /** Bundle key to specify the schema.org ID of the content. */













    public static final String KEY_ID = "@id";



























    /** Bundle key to specify the schema.org type of the content. */













    public static final String KEY_TYPE = "@type";



























    /** Bundle key to specify the name of the content. */













    public static final String KEY_NAME = "name";



























    /** Bundle key to specify the description of the content. */













    public static final String KEY_DESCRIPTION = "description";



























    /** Bundle key to specify the URL of the content. */













    public static final String KEY_URL = "url";



























    /** Bundle key to specify the object of an action. */













    public static final String KEY_ACTION_OBJECT = "object";



























    /** Bundle key to specify the action's status. */













    public static final String KEY_ACTION_STATUS = "actionStatus";



























    /** The act of editing by adding an object to a collection. */













    public static final String TYPE_ADD_ACTION = "AddAction";



























    /** The act of bookmarking an object. */













    public static final String TYPE_BOOKMARK_ACTION = "BookmarkAction";



























    /** The act of liking an object. */













    public static final String TYPE_LIKE_ACTION = "LikeAction";



























    /** The act of consuming audio content. */













    public static final String TYPE_LISTEN_ACTION = "ListenAction";



























    /** The act of consuming static visual content. */













    public static final String TYPE_VIEW_ACTION = "ViewAction";



























    /** The act of expressing a desire about the object. */













    public static final String TYPE_WANT_ACTION = "WantAction";



























    /** The act of watching an object. */













    public static final String TYPE_WATCH_ACTION = "WatchAction";



























    /** The status of an active action. */













    public static final String STATUS_TYPE_ACTIVE = "ActiveActionStatus";



























    /** The status of a completed action. */













    public static final String STATUS_TYPE_COMPLETED = "CompletedActionStatus";



























    private AssistAction() {













    }



























    /**













     * Update the Bundle passed into {@link Activity#onProvideAssistData} with the action Bundle,













     * built with {@link ActionBuilder}.













     *













     * @param assistDataBundle The Bundle provided to {@link Activity#onProvideAssistData}.













     * @param actionBundle The Bundle representing an schema.org action.













     */













    public static void updateAssistData(Bundle assistDataBundle, Bundle actionBundle) {













        Preconditions.checkNotNull(assistDataBundle);













        Preconditions.checkNotNull(actionBundle);



























        Preconditions.checkNotNull(actionBundle.getString(KEY_TYPE),













                "The '@type' property is required in the provided actionBundle");













        assistDataBundle.putParcelable(ASSIST_ACTION_KEY, actionBundle);













    }



























    /**













     * Builds a {@link Bundle} representing a schema.org entity.













     */













    public static final class ThingBuilder {













        private final Bundle mBundle;



























        public ThingBuilder() {













            mBundle = new Bundle();













        }



























        /**













         * Sets the name of the content.













         *













         * @param name The name of the content.













         */













        public ThingBuilder setName(@Nullable String name) {













            set(KEY_NAME, name);













            return this;













        }



























        /**













         * Sets the app URI of the content.













         *













         * @param uri The app URI of the content.













         */













        public ThingBuilder setUrl(@Nullable Uri uri) {













            if (uri != null) {













                set(KEY_URL, uri.toString());













            }













            return this;













        }



























        /**













         * Sets the ID of the content.













         *













         * @param id Set the ID of the content.













         */













        public ThingBuilder setId(@Nullable String id) {













            set(KEY_ID, id);













            return this;













        }



























        /**













        * Sets the schema.org type of the content.













        *













        * @param type The schema.org type.













        */













        public ThingBuilder setType(@Nullable String type) {













            set(KEY_TYPE, type);













            return this;













        }



























        /**













         * Sets the optional description of the content.













         *













         * @param description The description of the content.













         */













        public ThingBuilder setDescription(@Nullable String description) {













            set(KEY_DESCRIPTION, description);













            return this;













        }



























        /**













         * Sets a property of the content.













         *













         * @param key The schema.org property. Must not be null.













         * @param value The value of the schema.org property.













         *              If null, the value will be ignored.













         */













        public ThingBuilder set(@NonNull String key, @Nullable String value) {













            if (value != null) {













                mBundle.putString(key, value);













            }













            return this;













        }



























        /**













         * Sets a property of the content.













         *













         * @param key The schema.org property. Must not be null.













         * @param value The value of the schema.org property represented as a bundle.













         *              If null, the value will be ignored.













         */













        public ThingBuilder set(@NonNull String key, @Nullable Bundle value) {













            if (value != null) {













                mBundle.putParcelable(key, value);













            }













            return this;













        }



























        /**













         * Build the {@link Bundle} object representing the schema.org entity.













         */













        public Bundle build() {













            return mBundle;













        }













    }



























    /**













     * Builds a {@link Bundle} representing a schema.org action.













     */













    public static final class ActionBuilder {













        private final Bundle mBundle;



























        public ActionBuilder() {













            mBundle = new Bundle();













        }



























        /**













         * Sets the schema.org type of the action.













         *













         * @param type The schema.org type.













         */













        public ActionBuilder setType(@Nullable String type) {













            set(KEY_TYPE, type);













            return this;













        }



























        /**













         * Sets the schema.org object of the action.













         *













         * @param object The schema.org object of the action.













         */













        public ActionBuilder setObject(@Nullable Bundle object) {













            set(KEY_ACTION_OBJECT, object);













            return this;













        }



























        /**













         * Sets a property of the action.













         *













         * @param key The schema.org property. Must not be null.













         * @param value The value of the schema.org property.













         *              If null, the value will be ignored.













         */













        public ActionBuilder set(@NonNull String key, @Nullable String value) {













            if (value != null) {













                mBundle.putString(key, value);













            }













            return this;













        }



























        /**













         * Sets a property of the action.













         *













         * @param key The schema.org property. Must not be null.













         * @param value The value of the schema.org property represented as a bundle.













         *              If null, the value will be ignored.













         */













        public ActionBuilder set(@NonNull String key, @Nullable Bundle value) {













            if (value != null) {













                mBundle.putParcelable(key, value);













            }













            return this;













        }



























        /**













         * Build the {@link Bundle} object representing the schema.org action.













         */













        public Bundle build() {













            if (TextUtils.isEmpty(mBundle.getString(KEY_TYPE, null))) {













                // Defaults to the base action type http://schema.org/Action.













                setType("Action");













            }



























            return mBundle;













        }













    }













}
























core/java/android/app/AssistContent.java



+1
−1




























Original line number
Diff line number
Diff line








@@ -51,7 +51,7 @@ public class AssistContent implements Parcelable {













    /**















     * Sets the Intent associated with the content, describing the current top-level context of















     * the activity.  If this contains a reference to a piece of data related to the activity,













     * be sure to set {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} so the accessibilty













     * be sure to set {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} so the accessibility















     * service can access it.















     */















    public void setIntent(Intent intent) {