Acción: Cancelar programado¶

Con esta acción puedes detener una tarea programada antes de que se ejecute, ya sea que haya sido configurada con Saltar a acción o Ejecutar botón.

¿Qué puedes hacer con esta acción?¶

Cancelar tareas programadas: Cancela tareas programadas que ya no son necesarias o que se configuraron por error.

¿Cómo configurar la acción?¶

1. Crear la acción¶

Ve al editor del bot pulsando 🛠 Editar.
Selecciona el botón o comando donde deseas agregar esta acción, o crea uno nuevo.
Pulsa en Acciones 🌟 → 🎯 Nueva acción → ⭕️ Cancelar programado.
Pulsa en Configurar 🛠 para configurarla.

2. Configurar las opciones¶

➡️ `ID de la tarea programada`¶

Introduce el cancel_id de la tarea que deseas cancelar, este es generado por acciones como Saltar a acción o Ejecutar botón al programar la ejecución de una tarea, y se obtiene de la siguiente forma:

#IDAcciónProgramada.cancel_id#

Reemplaza IDAcciónProgramada por el ID de la acción que programó la tarea (Saltar a acción o Ejecutar botón).

3. Activar la acción¶

Pulsa ✅ Activar para activar esta acción y que quede funcional.

¿Qué devuelve esta acción a través de su ID?¶

Usa #IDAcción.status# para verificar si la tarea fue cancelada:
- ok: La tarea fue cancelada con éxito.
- failed: No fue posible cancelar la tarea (por ejemplo, si ya se ejecutó).

Reemplaza IDAcción por el ID de esta acción (Cancelar programado).

Ejemplo práctico: Detener un recordatorio¶

Trabajaremos con el comando /recordatorio que creamos en el ejemplo práctico de la acción Saltar a acción, el cual crea un recordatorio para notificarte algo minutos en el futuro. Si no lo has creado, créalo antes de continuar.

Una vez creado, crearemos otro comando /cancelar_recordatorio para cancelarlo si cambias de opinión.

Ejemplo de uso:

El usuario envía:
```
/recordatorio "Llamar al doctor" 15
```
El bot programa el recordatorio para dentro de 15 minutos.
Luego, el usuario envía:
```
/cancelar_recordatorio "el_ID_de_cancelación"
```
El bot cancela el recordatorio antes de que sea enviado.

1. Modifica el comando `/recordatorio`¶

Haremos unas modificaciones en el comando /recordatorio para hacer que le muestre el ID de cancelación al usuario:

Ve al editor de tu bot pulsando 🛠 Editar.
Selecciona el comando /recordatorio enviándolo al bot.
Pulsa en Acciones 🌟 para entrar al menú de acciones del comando.
Localiza la tercera acción agregada, debe ser de tipo Enviar mensaje, es la que tiene guardado el siguiente mensaje:
```
✅ Tu recordatorio fue programado y lo recibirás en {#IDAcciónRecParam.param2#} minutos.
```
Reemplaza el mensaje por:
```
✅ Tu recordatorio fue programado y lo recibirás en {#IDAcciónRecParam.param2#} minutos.

🆔 ID para cancelar: <code>{#IDAcciónSaltarAAccion.cancel_id#}</code>
```
Nota 1: Reemplaza IDAcciónRecParam por el ID de la acción de Recibir parámetros (acción 1).

Nota 2: Reemplaza IDAcciónSaltarAAccion por el ID de la acción de Saltar a acción (acción 2)

Nota 3: Hemos usado HTML para formatear el ID de cancelación, de esta forma el usuario podrá copiar el ID tocando sobre él. Mira las etiquetas HTML aquí.

2. Crea el comando `/cancelar_recordatorio`¶

Sal del menú de acciones pulsando en ↙️ Salir ↘️.
Crea un nuevo comando pulsando en ✳️ Nuevo botón | comando y nómbralo /cancelar_recordatorio.
Pulsa en Acciones 🌟 para entrar al menú de acciones del comando.

3. Configurar las acciones¶

a) Acción 1: Recibir parámetros¶

Pulsa en 🎯 Nueva acción → 🖥 Recibir parámetros.
Esta acción no requiere configuración, simplemente actívala pulsando en ✅ Activar.
Copia el ID de esta acción, lo necesitarás en un momento.

b) Acción 2: Cancelar programado¶

Pulsa en 🎯 Nueva acción → ⭕️ Cancelar programado.
Pulsa en Configurar 🛠 → 🆔 ID de la tarea programada 🆔 e ingresa:
```
#IDAcciónRecParam.param1#
```
Reemplaza IDAcciónRecParam por el ID de la acción de Recibir parámetros que copiaste antes (acción 1).
Regresa al menú de acciones y activa esta acción pulsando en ✅ Activar.

c) Acción 3: Enviar mensaje¶

Pulsa en 🎯 Nueva acción → ✉️ Enviar mensaje.
Pulsa en Configurar 🛠 → 💬 Establecer mensaje 💬 e ingresa el mensaje que informará al usuario sobre el estado de la cancelación:
```
✅ Tu recordatorio ha sido cancelado.
```
- Si deseas mostrar un mensaje u otro según el estado de la cancelación, usa esta expresión:
```
{condition(#IDAcciónCancelarProg.status# == "ok", "✅ Tu recordatorio ha sido cancelado.", "⚠️ No se pudo cancelar el recordatorio.")}
```
  Nota 1: Reemplaza IDAcciónCancelarProg por el ID de la acción de Cancelar programado (acción 2).
  
  Nota 2: Hemos usado la función condition() para mostrar un mensaje u otro según una condición, puedes ver todas las funciones aquí.
Regresa al menú de acciones y activa esta acción pulsando en ✅ Activar.

Resultado final¶

El usuario envía el comando:

/recordatorio "Comprar regalo" 30

El bot responde:

✅ Tu recordatorio fue programado y lo recibirás en 30 minutos.

🆔 ID para cancelar: daf50311-4dc5-41c0-985c-733a063f13b6

Antes de que transcurran los 30 minutos, el usuario envía:

/cancelar_recordatorio "daf50311-4dc5-41c0-985c-733a063f13b6"