AppFunctionMetadata

PROPERTY_ENABLED_BY_DEFAULT

public static final String PROPERTY_ENABLED_BY_DEFAULT

Property name for the XML tag that defines the default value of AppFunctionState.isEnabled, before calling AppFunctionManager.setAppFunctionEnabled.

Constant Value: "enabledByDefault"

PROPERTY_FUNCTION_ID

public static final String PROPERTY_FUNCTION_ID

Property name for the XML tag that defines the value of AppFunctionName.getFunctionIdentifier returned by getName().

Constant Value: "id"

PROPERTY_SCHEMA_CATEGORY

public static final String PROPERTY_SCHEMA_CATEGORY

Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getCategory returned by getSchemaMetadata().

Constant Value: "schemaCategory"

PROPERTY_SCHEMA_NAME

public static final String PROPERTY_SCHEMA_NAME

Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getName returned by getSchemaMetadata().

Constant Value: "schemaName"

PROPERTY_SCHEMA_VERSION

public static final String PROPERTY_SCHEMA_VERSION

Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getVersion returned by getSchemaMetadata().

Constant Value: "schemaVersion"

PROPERTY_SCOPE

public static final String PROPERTY_SCOPE

Property name for the XML tag that defines the value of getScope().

This property is should not be used for XML assets referenced by an AppFunctionService declaration in the manifest, which are always SCOPE_GLOBAL.

Constant Value: "scope"

PROPERTY_VALUE_SCOPE_ACTIVITY

public static final String PROPERTY_VALUE_SCOPE_ACTIVITY

Property value for PROPERTY_SCOPE in the XML representing SCOPE_ACTIVITY.

Constant Value: "activity"

PROPERTY_VALUE_SCOPE_GLOBAL

public static final String PROPERTY_VALUE_SCOPE_GLOBAL

Property value for PROPERTY_SCOPE in the XML representing SCOPE_GLOBAL.

Constant Value: "global"

SCOPE_ACTIVITY

public static final int SCOPE_ACTIVITY

A value returned from getScope() that indicates it is an activity-scoped app function.

Multiple app function implementations with the same AppFunctionName can exist simultaneously, each registered from a different Activity instance, which is identified by an AppFunctionActivityId.

Functions with this scope must be registered using AppFunctionManager.registerAppFunction, and must be called from an Activity context. Calling it from any other context will result in an IllegalStateException.

To execute an activity-scoped function, the caller of AppFunctionManager.executeAppFunction must use ERROR(ExecuteAppFunctionRequest.setActivityId/android.app.appfunctions.ExecuteAppFunctionRequest#setActivityId ExecuteAppFunctionRequest.setActivityId), otherwise AppFunctionException.ERROR_FUNCTION_NOT_FOUND will be returned.

To discover the specific activities where an activity-scoped function is currently registered, see AppFunctionManager.getAppFunctionStates and AppFunctionManager.getAppFunctionActivityStates.

The function remains registered until it is explicitly unregistered or the activity is destroyed.

IMPORTANT: Functions provided with AppFunctionManager.registerAppFunction called from an Activity context should prefer SCOPE_ACTIVITY. Only use SCOPE_GLOBAL for such functions if you are absolutely sure there can be only one instance of that activity.

Constant Value: 1 (0x00000001)

SCOPE_GLOBAL

public static final int SCOPE_GLOBAL

A value returned from getScope() that indicates it is a globally-scoped app function.

There can be at most one app function implementation with the same AppFunctionName available with this scope. This is useful for functions that are tied to a singleton component, such as a foreground service.

When using AppFunctionManager.registerAppFunction, the function remains registered until it is explicitly unregistered or the calling context is destroyed.

To execute a globally-scoped function, the caller of AppFunctionManager.executeAppFunction must not use ERROR(ExecuteAppFunctionRequest.setActivityId/android.app.appfunctions.ExecuteAppFunctionRequest#setActivityId ExecuteAppFunctionRequest.setActivityId) (or set it to null), otherwise AppFunctionException.ERROR_FUNCTION_NOT_FOUND will be returned.

This is always the scope for AppFunctionService-based functions.

IMPORTANT: Functions provided with AppFunctionManager.registerAppFunction called from an Activity context should prefer SCOPE_ACTIVITY. Only use SCOPE_GLOBAL for such functions if you are absolutely sure there can be only one instance of that activity.

Constant Value: 0 (0x00000000)

CREATOR

public static final Creator<AppFunctionMetadata> CREATOR

describeContents

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getMetadataDocument

public GenericDocument getMetadataDocument ()

Returns the app function's metadata as a GenericDocument.

Client-defined properties can be retrieved using the GenericDocument property getters.

Properties that are not defined in this class (see PROPERTY_* constants) are not guaranteed to be available or consistent across devices and versions.

getName

public AppFunctionName getName ()

Returns the qualified name of the app function.

The AppFunctionName is composed of the app's package name and the function's identifier.

This is defined by the PROPERTY_FUNCTION_ID tag in the XML.

getPackageMetadata

public AppFunctionPackageMetadata getPackageMetadata ()

Returns the AppFunctionPackageMetadata of the enclosing package.

getSchemaMetadata

public AppFunctionSchemaMetadata getSchemaMetadata ()

Returns the identifying metadata for a pre-defined schema which this app function implements.

getScope

public int getScope ()

Returns the scope of the app function.

The scope determines the function's lifecycle and uniqueness rules. Depending on the scope, there could be at most one or multiple functions registered in the system with the same AppFunctionName.

See values below for more details on each scope.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.