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

SpeakEasyProtocol

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
Int
Int
Int
Int
Int

Public functions
SpeakEasyProtocol
fromBundle(b: Bundle)

Decodes a bundle into a SpeakEasyProtocol object.
String

Public properties
SpeakEasyProtocol.Find
SpeakEasyProtocol.FindResult
SpeakEasyProtocol.Publish

Set based on type.
SpeakEasyProtocol.PublishResult
SpeakEasyProtocol.Remove
Int

Constants

FIND_RESULT_TYPE

val FIND_RESULT_TYPE: Int

FIND_TYPE

val FIND_TYPE: Int

PUBLISH_RESULT_TYPE

val PUBLISH_RESULT_TYPE: Int

PUBLISH_TYPE

val PUBLISH_TYPE: Int

REMOVE_TYPE

val REMOVE_TYPE: Int

Public functions

fromBundle

fun fromBundle(b: Bundle): SpeakEasyProtocol

Decodes a bundle into a SpeakEasyProtocol object.

Parameters
b: Bundle

a Bundle (nullable)
Returns
SpeakEasyProtocol

A SpeakEasyProtocol - or null if invalid.

toString

fun toString(): String

Public properties

find

val find: SpeakEasyProtocol.Find

findResult

val findResult: SpeakEasyProtocol.FindResult

publish

val publish: SpeakEasyProtocol.Publish

Set based on type.

publishResult

val publishResult: SpeakEasyProtocol.PublishResult

remove

val remove: SpeakEasyProtocol.Remove

type

val type: Int