CommandRequest


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

Fields

public static final Creator<CommandRequest> CREATOR

Inherited fields

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

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, android.media.tv.BroadcastInfoRequest.REQUEST_OPTION_ONEWAY, or android.media.tv.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