WebBridge | @unlimited/smartapp-bridge

Hierarchy

WebBridge

Implements

{ disableLogs: () => void; disableRenameParams: () => void; enableLogs: () => void; enableRenameParams: () => void; log?: undefined | ((data: string | object) => void); onReceive: (callback: EventEmitterCallback) => void; sendBotEvent: (event: BridgeSendBotEventParams) => Promise<EmitterEventPayload>; sendClientEvent: (event: BridgeSendClientEventParams) => Promise<EmitterEventPayload> }

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebBridge(): WebBridge

- Defined in src/lib/platforms/web.ts:24
Returns WebBridge

Properties

Private Readonly eventEmitter

eventEmitter: ExtendedEventEmitter

isRenameParamsEnabledForBotx

isRenameParamsEnabledForBotx: boolean

logsEnabled

logsEnabled: boolean

Methods

addGlobalListener

addGlobalListener(): void

- Defined in src/lib/platforms/web.ts:33
Returns void

disableLogs

disableLogs(): void

- Defined in src/lib/platforms/web.ts:224
Disabling logs.
```
bridge
  .disableLogs()
```
Returns void

disableRenameParams

disableRenameParams(): void

- Defined in src/lib/platforms/web.ts:247
Enabling renaming event params from camelCase to snake_case and vice versa
```
bridge
   .disableRenameParams()
```
Returns void

enableLogs

enableLogs(): void

- Defined in src/lib/platforms/web.ts:199
Enabling logs.
```
bridge
  .enableLogs()
```
Returns void

enableRenameParams

enableRenameParams(): void

- Defined in src/lib/platforms/web.ts:235
Enabling renaming event params from camelCase to snake_case and vice versa
```
bridge
   .enableRenameParams()
```
Returns void

onReceive

onReceive(callback: EventEmitterCallback): void

- Defined in src/lib/platforms/web.ts:77
Set callback function to handle events without ref (notifications for example).
```
bridge.onReceive(({ type, handler, payload }) => {
  // Handle event data
  console.log('event', type, handler, payload)
})
```
Parameters
- callback: EventEmitterCallback
Returns void

sendBotEvent

sendBotEvent(__namedParameters: { files: any; guaranteed_delivery_required: undefined | false | true; method: string; params: undefined | object; timeout: undefined | number }): Promise<EmitterEventPayload>

- Defined in src/lib/platforms/web.ts:140
Send event and wait response from express client.
```
bridge
  .sendClientEvent(
    {
      method: 'get_weather',
      params: {
        city: 'Moscow',
      },
    }
  )
  .then(data => {
    // Handle response
    console.log('response', data)
  })
```
Parameters
- __namedParameters: { files: any; guaranteed_delivery_required: undefined | false | true; method: string; params: undefined | object; timeout: undefined | number }
  - files: any
  - guaranteed_delivery_required: undefined | false | true
  - method: string
  - params: undefined | object
  - timeout: undefined | number
Returns Promise<EmitterEventPayload>

sendClientEvent

sendClientEvent(__namedParameters: { method: string; params: undefined | object; timeout: undefined | number }): Promise<EmitterEventPayload>

- Defined in src/lib/platforms/web.ts:178
Send event and wait response from express client.
```
bridge
  .sendClientEvent(
    {
      method: 'get_weather',
      params: {
        city: 'Moscow',
      },
    }
  )
  .then(data => {
    // Handle response
    console.log('response', data)
  })
```
Parameters
- __namedParameters: { method: string; params: undefined | object; timeout: undefined | number }
  - method: string
  - params: undefined | object
  - timeout: undefined | number
Returns Promise<EmitterEventPayload>

Private sendEvent

sendEvent(__namedParameters: { files: any; guaranteed_delivery_required: boolean; handler: HANDLER; method: string; params: undefined | object; timeout: number }): Promise<EmitterEventPayload>

- Defined in src/lib/platforms/web.ts:81
Parameters
- __namedParameters: { files: any; guaranteed_delivery_required: boolean; handler: HANDLER; method: string; params: undefined | object; timeout: number }
  - files: any
  - guaranteed_delivery_required: boolean
  - handler: HANDLER
  - method: string
  - params: undefined | object
  - timeout: number
Returns Promise<EmitterEventPayload>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns WebBridge

Properties

Private Readonly eventEmitter

isRenameParamsEnabledForBotx

logsEnabled

Methods

addGlobalListener

Returns void

disableLogs

Returns void

disableRenameParams

Returns void

enableLogs

Returns void

enableRenameParams

Returns void

onReceive

Parameters

callback: EventEmitterCallback

Returns void

sendBotEvent

Parameters

__namedParameters: { files: any; guaranteed_delivery_required: undefined | false | true; method: string; params: undefined | object; timeout: undefined | number }

files: any

guaranteed_delivery_required: undefined | false | true

method: string

params: undefined | object

timeout: undefined | number

Returns Promise<EmitterEventPayload>

sendClientEvent

Parameters

__namedParameters: { method: string; params: undefined | object; timeout: undefined | number }

method: string

params: undefined | object

timeout: undefined | number

Returns Promise<EmitterEventPayload>

Private sendEvent

Parameters

__namedParameters: { files: any; guaranteed_delivery_required: boolean; handler: HANDLER; method: string; params: undefined | object; timeout: number }

files: any

guaranteed_delivery_required: boolean

handler: HANDLER

method: string

params: undefined | object

timeout: number

Returns Promise<EmitterEventPayload>