From 0b7b68ee585bb4f4d694239b36aab6d79b1693ad Mon Sep 17 00:00:00 2001 From: Raud0 <44434930+Raud0@users.noreply.github.com> Date: Tue, 8 Dec 2020 13:45:46 +0200 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c762186..83de5ef 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ Xatkit Facebook Messenger Platform ===== -[![Wiki Badge](https://img.shields.io/badge/doc-wiki-blue)](https://github.com/xatkit-bot-platform/xatkit-facebook-messenger-platform/wiki)[![Build Status](https://travis-ci.com/xatkit-bot-platform/xatkit-facebook-messenger-platform.svg?branch=master)](https://travis-ci.com/xatkit-bot-platform/xatkit-facebook-messenger-platform) +[![Wiki Badge](https://img.shields.io/badge/doc-wiki-blue)](https://github.com/xatkit-bot-platform/xatkit-facebook-messenger-platform/wiki) +[![Build Status](https://travis-ci.com/xatkit-bot-platform/xatkit-facebook-messenger-platform.svg?branch=master)](https://travis-ci.com/xatkit-bot-platform/xatkit-facebook-messenger-platform) Receive and send messages to [Facebook Messenger](https://www.messenger.com/). This connector utilizes the [Messenger Platform API](https://developers.facebook.com/docs/messenger-platform). @@ -14,13 +15,13 @@ This connector utilizes the [Messenger Platform API](https://developers.facebook ## MessengerIntentProvider Events -| Event | Context | Parameters | Description | -| ----- | ------- | ---------- | ----------- | -| Message_Delivered | ? | - `mids`: The id of the delivered message | Event sent when a message is delivered. **Note**: this event is only created when the `xatkit.messenger.handle_deliveries` is set to `true`. | -| Message_Read | ? | - `watermark`: The number of messages delivered | Event sent when the user sees a message. **Note**: this event is only created when the `xatkit.messenger.handle_read` is set to `true`. | -| Message_React | ? | - `mid`: The id of the message reacted to
- `emoji`: The Unicode character of the emoji
- `reaction`: The natural language interpretation of the emoji | Event sent when the user reacts to a message. **Note**: this event is only created when the `xatkit.messenger.handle_reactions` is set to `true`. | -| Message_Unreact | ? | - `mid`: The id of the message the reaction was removed from | Event sent when a reaction is removed from a message. **Note**: this event is only created when the `xatkit.messenger.handle_reactions` is set to `true`. | -| Message_Postback | ? | - `title`: The displayed text of a postback button
- `payload`: The payload of a postback button
- `xatkit.messenger.postback.referral.ref`: The refferal ref attribute
- `xatkit.messenger.postback.referral.source` The referral origin
- `xatkit.messenger.postback.referral.type`: The refferal type | Event sent when the user click on a postback button in a button template. | +| Event | Parameters | Description | +| ----- | ---------- | ----------- | +| Message_Delivered | - `mids`: The id of the delivered message | Event sent when a message is delivered. **Note**: this event is only created when the `xatkit.messenger.handle_deliveries` is set to `true`. | +| Message_Read | - `watermark`: The number of messages delivered | Event sent when the user sees a message. **Note**: this event is only created when the `xatkit.messenger.handle_read` is set to `true`. | +| Message_React | - `mid`: The id of the message reacted to
- `emoji`: The Unicode character of the emoji
- `reaction`: The natural language interpretation of the emoji | Event sent when the user reacts to a message. **Note**: this event is only created when the `xatkit.messenger.handle_reactions` is set to `true`. | +| Message_Unreact | - `mid`: The id of the message the reaction was removed from | Event sent when a reaction is removed from a message. **Note**: this event is only created when the `xatkit.messenger.handle_reactions` is set to `true`. | +| Message_Postback | - `title`: The displayed text of a postback button
- `payload`: The payload of a postback button
- `xatkit.messenger.postback.referral.ref`: The refferal ref attribute
- `xatkit.messenger.postback.referral.source` The referral origin
- `xatkit.messenger.postback.referral.type`: The refferal type | Event sent when the user click on a postback button in a button template. | ## Actions