AppFunctionMetadata Class

Definition

Namespace:: Android.App.AppFunctions

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains an app function's metadata, essential for its invocation and discovery, retrieved using AppFunctionManager#searchAppFunctions.

[Android.Runtime.Register("android/app/appfunctions/AppFunctionMetadata", ApiSince=37, DoNotGenerateAcw=true)]
public sealed class AppFunctionMetadata : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/app/appfunctions/AppFunctionMetadata", ApiSince=37, DoNotGenerateAcw=true)>]
type AppFunctionMetadata = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

JavaObject

Object
AppFunctionMetadata

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

Contains an app function's metadata, essential for its invocation and discovery, retrieved using AppFunctionManager.searchAppFunctions.

This metadata is defined in an XML asset file and does not change at runtime. The XML file is referenced from the app's AndroidManifest.xml. How it's referenced depends on whether the app function is implemented using AppFunctionService or AppFunctionManager.registerAppFunction.

The XML schema consists of a root <appfunctions> element that can contain one or more <appfunction> elements. The XML tags used within the <appfunction> element directly correspond to the property names defined by the PROPERTY_* constants in this class. All properties in the XML (including unknown properties) are made available through the getMetadataDocument() method.

<appfunctions>
<appfunction>
<id>createNote</id>
<enabledByDefault>true</enabledByDefault>
<scope>global</scope>
        ...
</appfunction>
</appfunctions>

See AppFunctionManager.getAppFunctionStates for details on retrieving the runtime state of the app functions.

Android reference for android.app.appfunctions.AppFunctionMetadata.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Fields

Name	Description
PropertyEnabledByDefault	Property name for the XML tag that defines the default value of AppFunctionState.isEnabled, before calling AppFunctionManager.setAppFunctionEnabled.
PropertyFunctionId	Property name for the XML tag that defines the value of AppFunctionName.getFunctionIdentifier returned by getName().
PropertySchemaCategory	Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getCategory returned by getSchemaMetadata().
PropertySchemaName	Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getName returned by getSchemaMetadata().
PropertySchemaVersion	Property name for the XML tag that defines the value of AppFunctionSchemaMetadata.getVersion returned by getSchemaMetadata().
PropertyScope	Property name for the XML tag that defines the value of getScope().
PropertyValueScopeActivity	Property value for PROPERTY_SCOPE in the XML representing SCOPE_ACTIVITY.
PropertyValueScopeGlobal	Property value for PROPERTY_SCOPE in the XML representing SCOPE_GLOBAL.
ScopeActivity	Obsolete. A value returned from `#getScope` that indicates it is an activity-scoped app function.
ScopeGlobal	Obsolete. A value returned from `#getScope` that indicates it is a globally-scoped app function.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Creator
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers
MetadataDocument	Returns the app function's metadata as a GenericDocument.
Name	Returns the qualified name of the app function.
PackageMetadata	Returns the AppFunctionPackageMetadata of the enclosing package.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
SchemaMetadata	Returns the identifying metadata for a pre-defined schema which this app function implements.
Scope	Returns the scope of the app function.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
DescribeContents()	Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	(Inherited from JavaObject)
Equals(Object)	(Inherited from JavaObject)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Obsolete. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)	Flatten this object in to a Parcel.

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	(Inherited from JavaObject)
IJavaPeerable.Finalized()	(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from JavaObject)
IJavaPeerable.UnregisterFromRuntime()

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to