From fc2f037e216e517ec4b87b0663277a3fc40c1d74 Mon Sep 17 00:00:00 2001 From: Niklas Halle Date: Fri, 18 Sep 2020 16:23:04 +0200 Subject: fix stuff, start encoding, add doku for attachment sending --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 22f8a05..ea08283 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,23 @@ No extra content. The text should be printed underlined. No extra content. +##### `attachment` +The text is the caption of an attached file. +Extra content: an `attachment`-object. (TODO: extend to array of attachments) + ##### `command` -The text should be formated in a way to underlying platform of the bridge would recognize it (e.g. prefix with '/'). +The text should be formatted in a way to underlying platform of the bridge would recognize it (e.g. prefix with '/'). Extra content: the description of the command. ##### `link` The text should be formatted as a link. Extra content: the alt text for the uri - the uri should be the text itself, so that clients ignoring this annotation still show the real uri. + +#### `attachment` +The `attachment` object: + +| Field | Type | Description | +|-------|------|-------------| +| `type` | string | MIME type of the attachment (e.g. "png", "gif", etc) | +| `name` | string | The name of the file (including the file ending) | +| `content` | string | Base64 encoded file contents | \ No newline at end of file -- cgit v1.2.3-54-g00ecf