Utilidades

Al integrar los SDK, el primer paso consiste en definir los datos de la cuenta y del usuario.

Usa las siguientes funciones para obtener los datos correspondientes.

Datos de la cuenta

• Puedes obtener el ID de la cuenta con

kf.account._id;

Datos del usuario

• Puedes acceder a los datos del usuario autenticado con Name, Email y _id, que devuelven el nombre, el correo electrónico y el ID del usuario actual.

const { Name, Email, _id } = kf.user;

Datos de los roles

• Obtener los roles de aplicación asignados Esta propiedad muestra todos los roles asignados al usuario actual en una aplicación.

Sintaxis

kf.user.AppRoles;

Ejemplo

console.log(kf.user.AppRoles);

Valor devuelto

Esta propiedad devuelve un array con los roles asignados al usuario actual. Cada rol tiene un ID y un nombre.

Ejemplo

[
  {
  "_id": "Ro9mhLyuEFn4",
  "Name": "Admin"
  },
  "_id": "Ro9mhI8Yy1_O",
  "Name": "Employee"
  },
  {
  "_id": "Ro9mhI8Y89df",
  "Name": "Test user"
  }
]

Nota

Usa esta propiedad para devolver el primer rol de la lista de roles asignados a un usuario console.log(kf.user.AppRoles[0])

Ejemplo

  {
  "_id": "Ro9mhLyuEFn4",
  "Name": "Admin"
  }

API en el SDK

En los SDK de Kissflow, puedes hacer llamadas tanto a API internas como externas.

Para las API internas, consulta la documentación de la API de Kissflow.

• Puedes usar el método kf.api para llamar a las API internas.
• kf.api incluye tokens de encabezado predeterminados, lo que garantiza llamadas a la API seguras y autenticadas.

Parámetros

url (String)

URL del recurso que se obtiene con la llamada a la API REST.

config (Object)

Un objeto que contiene la configuración personalizada que quieras aplicar a la solicitud. Las opciones posibles son

• 1. method

  El método de la solicitud, por ejemplo “GET”, “POST”, “DELETE”, etc. El predeterminado es “GET”

• 2. body

  Carga útil que se envía a una API como objeto.

  Nota: una solicitud con el método GET no puede tener cuerpo.

Sintaxis

kf.api(url, config).then((res) => {...})
// or
let resp = await kf.api(url, config)

Ejemplo

Supongamos una API de envío de un formulario de proceso.

let payload = {
  fieldId1: "John Jacobs",
  fieldId2: “HR”
};
const options = { method: "POST", body: JSON.stringify(payload) };
kf.api(
  `/process/2/${kf.account._id}/process_id/instance_id/activity_instance_id/submit`,
  options
)
  .then((response) => console.log(response))
  .catch((err) => console.log(" An error has occurred.", err));

Métodos del cliente

Mostrar un aviso

Muestra al cliente el mensaje de aviso (toast) configurado.

kf.client.showInfo(message);

Mostrar una confirmación

Muestra al cliente el cuadro de diálogo de confirmación y devuelve su respuesta como salida.

kf.client.showConfirm({ title, content }).then((action) => {
  if (action === "OK") {
    // user clicked ok button
  } else {
    // user clicked cancel button or clicked outside the popup
  }
});

Ejemplo

Para configurar un cuadro de diálogo de confirmación en cada envío de formulario

kf.client
  .showConfirm({
    title: "Submit form",
    content: "Are you sure you want to submit the form",
    okText: "Continue",
    cancelText: "Cancel",
  })
  .then(function (result) {
    if (result === "OK") {
      //code block to be executed if the user confirmed
    } else {
      //code block to be executed if the user cancelled
    }
  });

Redirigir a una URL

Redirige al cliente a una URL concreta de la aplicación de Kissflow o a una URL externa.

kf.client.redirect(url);

Ejemplo

Para redirigir a un cliente a un formulario de comentarios después de que envíe sus datos, puedes agregar la URL de redirección a la sintaxis anterior.