Interface EventBridge

The event bridge that transports events between Android and web.

interface EventBridge {
    connect(): Promise<Required<Connection>>;
    getConnection(): null | Required<Connection>;
    isSupported(eventType: string): boolean;
    request(event: Event): Event;
    requestAsync(event: Event): Promise<Event>;
    subscribe(listener: (event: Event) => void): Unsubscribe;
    subscribe(eventType: string, listener: (payload: any) => void): Unsubscribe;
}

Index

Methods

connect getConnection isSupported request requestAsync subscribe

Methods

connect

connect(): Promise<Required<Connection>>
Returns the promise that is resolved when a connection becomes available. Usually, you don't have to call this method manually, since the connection would be established automatically as soon as the first request is sent or the first listener is subscribed.

Returns Promise<Required<Connection>>

getConnection

getConnection(): null | Required<Connection>
Returns the established connection, or null if it isn't available. Use connect to establish a connection.

Returns null | Required<Connection>

isSupported

isSupported(eventType: string): boolean
Returns true if an event of the given type is supported, or false otherwise.
Parameters
- eventType: string
  The type of event to check.
Returns boolean

request

request(event: Event): Event
Sends an event through a connection to Android and returns a response event.

The connection is automatically established when this method is called.

The error is thrown if org.racehorse.ExceptionEvent is published as a response, if the response event wasn't published synchronously, or if connection cannot be established synchronously.
Parameters
- event: Event
  The request event to send.
Returns Event
The response event.

requestAsync

requestAsync(event: Event): Promise<Event>
Sends an event through a connection to Android and returns a promise that is resolved with a response event.

The connection is automatically established when this method is called.

The returned promise is rejected if org.racehorse.ExceptionEvent is published as a response.
Parameters
- event: Event
  The request event to send.
Returns Promise<Event>
The response event.

subscribe(listener: (event: Event) => void): Unsubscribe
Subscribes a listener to all notice events pushed by Android.

The connection is automatically established when this method is called.
Parameters
- listener: (event: Event) => void
  The listener to subscribe.
Returns Unsubscribe
The callback that unsubscribes the listener.
subscribe(eventType: string, listener: (payload: any) => void): Unsubscribe
Subscribes a listener to notice events of the particular type pushed by Android.

The connection is automatically established when this method is called.
Parameters
- eventType: string
  The type of the event to subscribe to.
- listener: (payload: any) => void
  The listener to subscribe.
Returns Unsubscribe
The callback that unsubscribes the listener.