Class ConsoleMessageClient

Message client logging to the console. Uses color and renders markdown

Hierarchy

ConsoleMessageClient

Implements

MessageClient
SlackMessageClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConsoleMessageClient(linkedChannel: string, sender: Sender, connectionConfig: AutomationClientConnectionRequest, markedOptions?: MarkedOptions): ConsoleMessageClient

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:159
Construct a new ConsoleMessageClient, supporting actionable messages.

Parameters
- linkedChannel: string
- sender: Sender
- connectionConfig: AutomationClientConnectionRequest
  
  config to use to format URLs to call back the source SDM
- Default value markedOptions: MarkedOptions = {breaks: false,}
Returns ConsoleMessageClient

Properties

Private connectionConfig

connectionConfig: AutomationClientConnectionRequest

config to use to format URLs to call back the source SDM

Private linkedChannel

linkedChannel: string

markedOptions

markedOptions: MarkedOptions

Private sender

sender: Sender

Methods

addressChannels

addressChannels(msg: string | SlackMessage, channels: string | string[], options?: MessageOptions): Promise<any>

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:85
Parameters
- msg: string | SlackMessage
- channels: string | string[]
- Optional options: MessageOptions
Returns Promise<any>

addressUsers

addressUsers(msg: string | SlackMessage, users: string | string[], options?: MessageOptions): Promise<any>

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:130
Parameters
- msg: string | SlackMessage
- users: string | string[]
- Optional options: MessageOptions
Returns Promise<any>

dateString

dateString(): string

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:157
Returns string

Private renderAction

renderAction(channel: string, action: Action, actionKey: string): string

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:135
Parameters
- channel: string
- action: Action
- actionKey: string
Returns string

respond

respond(msg: string | SlackMessage, options?: MessageOptions): Promise<any>

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:67
Parameters
- msg: string | SlackMessage
- Optional options: MessageOptions
Returns Promise<any>

send

send(msg: any, destinations: Destination | Destination[], options?: MessageOptions): Promise<any>

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:72
Parameters
- msg: any
- destinations: Destination | Destination[]
- Optional options: MessageOptions
Returns Promise<any>

Private writeToChannel

writeToChannel(channels: string[] | string, markdown: string): Promise<any>

- Defined in lib/sdm/ui/ConsoleMessageClient.ts:151
Apply consistent formatting to mimic writing to a Slack channel

Parameters
- channels: string[] | string
- markdown: string
Returns Promise<any>

Generated using TypeDoc