Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RegistrationAdapter

Interface that a handler must implement to handle registration commands

Hierarchy

  • RegistrationAdapter

Index

Methods

Methods

active

  • Callback that is called when the handler becomes active

    Parameters

    • close: function

      a callback function that allows to close the handler

        • (): void
        • Returns void

    • cid: ConversationId

      the conversation ID

    Returns void

close

  • close(err?: any): void
  • A callback that is called when the handler is closed

    Parameters

    • Optional err: any

      an error if one occurred

    Returns void

respond

  • respond(response: any): boolean
  • Callback that is called when a response is received

    Parameters

    • response: any

      the response

    Returns boolean

    should return true if the handler closed normally