{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

SpeakEasyProtocol

public final class SpeakEasyProtocol


SpeakEasyProtocol abstracts away sending commands / interpreting responses from speakeasy via bundles.

SpeakEasy allows the registration, query, removal of IBinders from the shell user to android apps.

This bypasses the Android platform's typical dependency and lifecycle management of Services and IPC. Using Service objects defined in your Android manifest is the proper way to do IPC in Android and these mechanisms should only be used in test.

The dependencies of this class should be kept to a minimum and it should remain possible to use this class outside of an apk.

Summary

Nested types

SpeakEasyProtocol.Find

Represents a Find request to SpeakEasy.

SpeakEasyProtocol.FindResult

The result of a find operation on SpeakEasy.

SpeakEasyProtocol.Publish

Represents a publish command to speakeasy.

SpeakEasyProtocol.PublishResult

Represents a publish response from speakeasy.

SpeakEasyProtocol.Remove

Indicates a request to remove a IBinder from SpeakEasy.

Constants

static final int
static final int
static final int
static final int
static final int

Public fields

final SpeakEasyProtocol.Find
final SpeakEasyProtocol.FindResult
final SpeakEasyProtocol.Publish

Set based on type.

final SpeakEasyProtocol.PublishResult
final SpeakEasyProtocol.Remove
final int

Public constructors

Public methods

static SpeakEasyProtocol
fromBundle(Bundle b)

Decodes a bundle into a SpeakEasyProtocol object.

String

Constants

FIND_RESULT_TYPE

public static final int FIND_RESULT_TYPE

FIND_TYPE

public static final int FIND_TYPE

PUBLISH_RESULT_TYPE

public static final int PUBLISH_RESULT_TYPE

PUBLISH_TYPE

public static final int PUBLISH_TYPE

REMOVE_TYPE

public static final int REMOVE_TYPE

Public fields

find

public final SpeakEasyProtocol.Find find

findResult

public final SpeakEasyProtocol.FindResult findResult

publish

public final SpeakEasyProtocol.Publish publish

Set based on type.

publishResult

public final SpeakEasyProtocol.PublishResult publishResult

remove

public final SpeakEasyProtocol.Remove remove

type

public final int type

Public constructors

SpeakEasyProtocol

public final SpeakEasyProtocol()

Public methods

fromBundle

public static SpeakEasyProtocol fromBundle(Bundle b)

Decodes a bundle into a SpeakEasyProtocol object.

Parameters
Bundle b

a Bundle (nullable)

Returns
SpeakEasyProtocol

A SpeakEasyProtocol - or null if invalid.

toString

public String toString()