### Navigation

- index
- modules |
- next |
- previous |
- Gate One Documentation »
- Developer Documentation »

# The Notice Plugin

notice.py - A plugin for Gate One that adds an escape sequence handler that will tell the client browser to display a message whenever said escape sequence is encountered. Any terminal program can emit the following escape sequence to display a message in the browser:

    \x1b]_;notice|<the message>\x07

Very straightforward and also very powerful.

## Hooks

This Python plugin file implements the following hooks:

    hooks = {
        'Escape': notice_esc_seq_handler,
    }

## Docstrings

`notice.``notice_esc_seq_handler`(message, tws)

  Handles text passed from the special optional escape sequance handler to display a message to the connected client (browser).

  See also

  `gateone.TerminalWebSocket.esc_opt_handler` and `terminal.Terminal._opt_handler()`

### Navigation

- index
- modules |
- next |
- previous |
- Gate One Documentation »
- Developer Documentation »