Class InterApplicationBus

A messaging bus that allows for pub/sub messaging between different applications.

Namespace

Hierarchy

Base
- InterApplicationBus

Index

Constructors

Properties

Channel events on removeAllListeners wire

Accessors

Methods

publish send subscribe unsubscribe

Constructors

constructor

new InterApplicationBus(wire: Transport<EntityType>): InterApplicationBus
Parameters
- wire: Transport<EntityType>
Returns InterApplicationBus

Overrides Base.constructor

Properties

Channel

Channel: Channel

events

events: {
subscriberAdded: string;
subscriberRemoved: string;
} = ...

Type declaration

subscriberAdded: string
subscriberRemoved: string

on

on: any

removeAllListeners

removeAllListeners: any

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from Base.me

Methods

publish

publish(topic: string, message: any): Promise<void>
Publishes a message to all applications running on OpenFin Runtime that are subscribed to the specified topic.

Returns

Tutorial
InterApplicationBus.publish
Parameters
- topic: string
  
  The topic on which the message is sent
- message: any
  
  The message to be published. Can be either a primitive data type (string, number, or boolean) or composite data type (object, array) that is composed of other primitive or composite data types
Returns Promise<void>

send

send(destination: {
name?: string;
uuid: string;
}, topic: string, message: any): Promise<void>
Sends a message to a specific application on a specific topic.

Returns

Tutorial
InterApplicationBus.send
Parameters
- destination: {
  name?: string;
  uuid: string;
  }
  
  The identity of the application to which the message is sent
  - Optional name?: string
  - uuid: string
- topic: string
  
  The topic on which the message is sent
- message: any
  
  The message to be sent. Can be either a primitive data type (string, number, or boolean) or composite data type (object, array) that is composed of other primitive or composite data types
Returns Promise<void>

subscribe

subscribe(source: {
name?: string;
uuid: string;
}, topic: string, listener: any): Promise<void>
Subscribes to messages from the specified application on the specified topic.

Returns

Tutorial
InterApplicationBus.subscribe
Parameters
- source: {
  name?: string;
  uuid: string;
  }
  
  This object is described in the Identity in the typedef
  - Optional name?: string
  - uuid: string
- topic: string
  
  The topic on which the message is sent
- listener: any
  
  A function that is called when a message has been received. It is passed the message, uuid and name of the sending application. The message can be either a primitive data type (string, number, or boolean) or composite data type (object, array) that is composed of other primitive or composite data types
Returns Promise<void>

unsubscribe

unsubscribe(source: {
name?: string;
uuid: string;
}, topic: string, listener: any): Promise<void>
Unsubscribes to messages from the specified application on the specified topic.

Returns

Tutorial
InterApplicationBus.unsubscribe
Parameters
- source: {
  name?: string;
  uuid: string;
  }
  
  This object is described in the Identity in the typedef
  - Optional name?: string
  - uuid: string
- topic: string
  
  The topic on which the message is sent
- listener: any
  
  A callback previously registered with subscribe()
Returns Promise<void>

Generated using TypeDoc