Control Class

Definition

Namespace:: Android.Service.Controls

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.

Represents a physical object that can be represented by a ControlTemplate and whose properties may be modified through a ControlAction.

[Android.Runtime.Register("android/service/controls/Control", ApiSince=30, DoNotGenerateAcw=true)]
public sealed class Control : Java.Lang.Object, Android.OS.IParcelable, IDisposable

[<Android.Runtime.Register("android/service/controls/Control", ApiSince=30, DoNotGenerateAcw=true)>]
type Control = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

JavaObject

Object
Control

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

Represents a physical object that can be represented by a ControlTemplate and whose properties may be modified through a ControlAction.

The information is provided by a ControlsProviderService and represents static information (not current status) about the device.

Each control needs a unique (per provider) identifier that is persistent across reboots of the system.

Each 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 ControlsProviderService and will be used to display the control as well as group them for management.

Each object will have an associated DeviceTypes. This will determine the icons and colors used to display it.

An Intent linking to the provider Activity that expands on this Control and allows for further actions should be provided.

Java documentation for android.service.controls.Control.

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
StatusDisabled	Obsolete. The `Control` is currently disabled.
StatusError	Obsolete. Used to indicate that there was a temporary error while loading the device state.
StatusNotFound	Obsolete. The device corresponding to the `Control` cannot be found or was removed.
StatusOk	Obsolete. Used to indicate that the state of the device was successfully retrieved.
StatusUnknown	Obsolete. Reserved for use with the `StatelessBuilder`, and while loading.

Properties

Name	Description
AppIntent	Gets the pending intent that opens an activity for this control.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
ControlId	Gets the persistent identifier of this control.
ControlTemplate	Gets the template that defines this control's primary interaction.
Creator	Gets the creator that reads controls from a parcel.
CustomColor	Optional color to be shown with the `Control`.
CustomIcon	Optional icon to be shown with the `Control`.
DeviceType	Gets the device type used to select the default icon and color.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsAuthRequired	Gets whether the device must be unlocked before interaction with this control.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers	Gets the JNI metadata used to access members of this Java binding.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
Status	Gets the result of the attempt to retrieve the current device state.
StatusText	Gets the current-state text as a string.
StatusTextFormatted	Gets the current-state text as a Java character sequence.
Structure	Gets the optional top-level location group for this control.
StructureFormatted	Optional top-level group to help define the `Control`'s location, visible to the user.
Subtitle	Gets the additional text shown below the control title as a string.
SubtitleFormatted	Gets the text shown below the control title as a Java character sequence.
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)
Title	Gets the name shown to the user as a string.
TitleFormatted	Gets the name shown to the user as a Java character sequence.
Zone	Gets the optional location group within a structure.
ZoneFormatted	Optional group name to help define the `Control`'s location within a structure, visible to the user.

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()	Removes this instance from the runtime's Java object lookup.

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