From ba82722264840b8d994002d17fa5e4849783e21c Mon Sep 17 00:00:00 2001 From: abalabahaha Date: Sat, 30 Apr 2016 17:25:28 -0700 Subject: [PATCH] Document awaitResponse --- docs/docs_client.rst | 13 +++++++++++++ docs/docs_resolvables.rst | 4 ++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 47100ef74..3f8814da1 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -220,6 +220,19 @@ replyTTS(message, content, `callback`) An alias for `reply(message, content, {tts: true}, callback)` +awaitResponse(message, `prompt`, `options`, `callback`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Wait for a response from the same user in the same channel as an existing message. + +- **message** - The original Message_ +- **prompt** - a `String Resolvable`_ - a message you want to send to prompt the user +- **options** - `object` containing: + - **tts** - `Boolean`, should message be text-to-speech +- **callback** - `function` that takes the following parameters: + - **error** - error object if any occurred + - **message** - the sent Message_ + updateMessage(message, content, `options`, `callback`) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docs_resolvables.rst b/docs/docs_resolvables.rst index a412ebf29..afde286bb 100644 --- a/docs/docs_resolvables.rst +++ b/docs/docs_resolvables.rst @@ -20,7 +20,7 @@ A Channel Resolvable allows: - String of User ID File Resolvable ------------------- +--------------- A File Resolvable allows: @@ -29,7 +29,7 @@ A File Resolvable allows: - Readable stream Role Resolvable ------------------- +--------------- A Role Resolvable allows: