Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IosBridge

Hierarchy

  • IosBridge

Implements

Index

Constructors

constructor

  • Returns IosBridge

Properties

Private Readonly eventEmitter

eventEmitter: ExtendedEventEmitter

Private Readonly hasCommunicationObject

hasCommunicationObject: boolean

isRenameParamsEnabledForBotx

isRenameParamsEnabledForBotx: boolean

logsEnabled

logsEnabled: boolean

Methods

disableLogs

  • disableLogs(): void
  • Disabling logs.

    bridge
      .disableLogs()
    

    Returns void

disableRenameParams

  • disableRenameParams(): void
  • Enabling renaming event params from camelCase to snake_case and vice versa

    bridge
       .disableRenameParams()
    

    Returns void

enableLogs

  • enableLogs(): void
  • Enabling logs.

    bridge
      .enableLogs()
    

    Returns void

enableRenameParams

  • enableRenameParams(): void
  • Enabling renaming event params from camelCase to snake_case and vice versa

    bridge
       .enableRenameParams()
    

    Returns void

log

  • log(data: string | object): void
  • Parameters

    • data: string | object

    Returns void

onReceive

  • Set callback function to handle events without ref (notifications for example).

    bridge.onRecieve(({ type, handler, payload }) => {
      // Handle event data
      console.log('event', type, handler, payload)
    })
    

    Parameters

    Returns void

sendBotEvent

  • sendBotEvent(__namedParameters: { files: any; guaranteed_delivery_required: undefined | false | true; method: string; params: undefined | object; timeout: number }): Promise<EmitterEventPayload>
  • Send event and wait response from express client.

    bridge
      .sendBotEvent(
        {
          method: 'get_weather',
          params: {
            city: 'Moscow',
          },
          files: []
        }
      )
      .then(data => {
        // Handle response
        console.log('response', data)
      })
    

    Parameters

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

    Returns Promise<EmitterEventPayload>

sendClientEvent

  • sendClientEvent(__namedParameters: { method: string; params: undefined | object; timeout: number }): Promise<EmitterEventPayload>
  • Send event and wait response from express client.

    bridge
      .sendClientEvent(
        {
          type: 'get_weather',
          handler: 'express',
          payload: {
            city: 'Moscow',
          },
        }
      )
      .then(data => {
        // Handle response
        console.log('response', data)
      })
    

    Parameters

    • __namedParameters: { method: string; params: undefined | object; timeout: number }
      • method: string
      • params: undefined | object
      • timeout: 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>
  • 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>

Generated using TypeDoc