Added in API level 33

CommandRequest

Kotlin |Java

public final class CommandRequest
extends BroadcastInfoRequest implements Parcelable

java.lang.Object
↳	android.media.tv.BroadcastInfoRequest
	↳	android.media.tv.CommandRequest

A request for command from broadcast signal.

Summary

Constants
`String`	`ARGUMENT_TYPE_JSON`
`String`	`ARGUMENT_TYPE_XML`

Inherited constants

From class android.media.tv.BroadcastInfoRequest

`int`	`REQUEST_OPTION_AUTO_UPDATE` Request option: auto update.
`int`	`REQUEST_OPTION_ONESHOT` Request option: one-shot With this option, only one response will be given per request.
`int`	`REQUEST_OPTION_ONEWAY` Request option: one-way With this option, no response is expected after sending the request.
`int`	`REQUEST_OPTION_REPEAT` Request option: repeat.

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<CommandRequest>`	`CREATOR`

Inherited fields

From class android.media.tv.BroadcastInfoRequest


    public
    static
    final
    Creator<BroadcastInfoRequest>

CREATOR

Public constructors
`CommandRequest(int requestId, int option, String namespace, String name, String arguments, String argumentType)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`String`	`getArgumentType()` Gets the argument type of the command.
`String`	`getArguments()` Gets the arguments of the command.
`String`	`getName()` Gets the name of the command.
`String`	`getNamespace()` Gets the namespace of the command.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          android.media.tv.BroadcastInfoRequest

`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getOption()` Gets the request option of the request.
`int`	`getRequestId()` Gets the ID of the request.
`int`	`getType()` Gets the broadcast info type.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

ARGUMENT_TYPE_JSON

Added in API level 33

public static final String ARGUMENT_TYPE_JSON

Constant Value: "json"

ARGUMENT_TYPE_XML

Added in API level 33

public static final String ARGUMENT_TYPE_XML

Constant Value: "xml"

Fields

CREATOR

Added in API level 33

public static final Creator<CommandRequest> CREATOR

Public constructors

CommandRequest

Added in API level 33

public CommandRequest (int requestId, 
                int option, 
                String namespace, 
                String name, 
                String arguments, 
                String argumentType)

Parameters
`requestId`	`int`
`option`	`int`: Value is `BroadcastInfoRequest.REQUEST_OPTION_REPEAT`, `BroadcastInfoRequest.REQUEST_OPTION_AUTO_UPDATE`, `BroadcastInfoRequest.REQUEST_OPTION_ONEWAY`, or `BroadcastInfoRequest.REQUEST_OPTION_ONESHOT`
`namespace`	`String`: This value cannot be `null`.
`name`	`String`: This value cannot be `null`.
`arguments`	`String`: This value cannot be `null`.
`argumentType`	`String`: This value cannot be `null`.

Public methods

describeContents

Added in API level 33

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getArgumentType

Added in API level 33

public String getArgumentType ()

Gets the argument type of the command. It could be either JSON or XML.

Returns
`String`	This value cannot be `null`.

getArguments

Added in API level 33

public String getArguments ()

Gets the arguments of the command. It could be serialized from some formats, such as JSON, XML, etc.

Returns
`String`	This value cannot be `null`.

getName

Added in API level 33

public String getName ()

Gets the name of the command.

Returns
`String`	This value cannot be `null`.

getNamespace

Added in API level 33

public String getNamespace ()

Gets the namespace of the command.

Returns
`String`	This value cannot be `null`.

writeToParcel

Added in API level 33

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES