-
-
Notifications
You must be signed in to change notification settings - Fork 748
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #880 from william-monroy/docs/idle
docs: (鉁忥笍) added documentation for idle feature
- Loading branch information
Showing
3 changed files
with
51 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import Navigation from '../../../components/widgets/Navigation' | ||
|
||
# idle | ||
|
||
Esta funcionalidad te permite dada una cantidad de tiempo de inactividad en el chat, ejecutar una acci贸n. | ||
|
||
## Ejemplo | ||
|
||
En el siguiente ejemplo, si el usuario no responde en 2 segundos, se ejecutar谩 la acci贸n de cancelar el flujo. | ||
|
||
```js | ||
const { addKeyword } = require('@bot-whatsapp/bot') | ||
|
||
const flujoFinal = addKeyword(EVENTS.ACTION).addAnswer('Se cancel贸 por inactividad') | ||
|
||
const flujoPrincipal = addKeyword(['hola']) | ||
.addAnswer( | ||
'Debes de responder antes de que transcurran 2 segundos', | ||
{ capture: true, idle: 2000 }, // idle: 2000 = 2 segundos | ||
async (ctx, { gotoFlow, inRef }) => { | ||
if (ctx?.idleFallBack) { | ||
return gotoFlow(flujoFinal) | ||
} | ||
} | ||
) | ||
.addAnswer('gracias!') | ||
|
||
``` | ||
## API | ||
### Propiedades | ||
- **idle** - Tiempo de inactividad en milisegundos | ||
- **idleFallBack** - Si se ejecut贸 la acci贸n por inactividad | ||
--- | ||
<Navigation | ||
pages={[ | ||
{ name: 'Instalaci贸n', link: '/docs/install' }, | ||
{ name: 'Conceptos', link: '/docs/essential' }, | ||
]} | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters