Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RemoteSessionLogger

Logs session activity to a remote endpoint using debug events. The remote debugger is automatically used when the emulator connects to your bot. Non-emulator channels can stream their activity to the emulator by saving the address of the emulator session to session.privateConversationData["BotBuilder.Data.DebugSession"].

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates an instance of the remote session logger.

    Parameters

    • connector: IConnector

      Connector used to communicate with the remote endpoint.

    • address: IAddress

      Address to deliver debug events to.

    • relatesTo: IAddress

      Address of the conversation the debug events are for.

    Returns RemoteSessionLogger

Properties

isEnabled

isEnabled: boolean

If true the logger is enabled and will log the sessions activity.

Methods

dump

  • dump(name: string, value: any): void
  • Logs the state of a variable to the output.

    Parameters

    • name: string

      Name of the variable being logged.

    • value: any

      Variables current state.

    Returns void

error

  • Logs an error to the output.

    Parameters

    • dialogStack: IDialogState[]

      (Optional) dialog stack for the session. This is used to provide context for where the event occured.

    • err: Error

      Error object to log. The errors message plus stack trace will be logged.

    Returns void

flush

  • flush(callback: function): void
  • Flushes any buffered entries to the output.

    Parameters

    • callback: function

      Function to call when the operation is completed.

        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

log

  • log(dialogStack: IDialogState[], msg: string, ...args: any[]): void
  • Logs an informational level message to the output.

    Parameters

    • dialogStack: IDialogState[]

      (Optional) dialog stack for the session. This is used to provide context for where the event occured.

    • msg: string

      Message to log.

    • Rest ...args: any[]

      (Optional) arguments to log with the message.

    Returns void

warn

  • warn(dialogStack: IDialogState[], msg: string, ...args: any[]): void
  • Logs a warning to the output.

    Parameters

    • dialogStack: IDialogState[]

      (Optional) dialog stack for the session. This is used to provide context for where the event occured.

    • msg: string

      Message to log.

    • Rest ...args: any[]

      (Optional) arguments to log with the message.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method