Métodos

Los siguientes métodos te permiten acceder a funciones que cambiarán el comportamiento o ayudantes para ciertas acciones.

getServices

Con este método puedes obtener el listado de servicios asociados a tu cuenta.

const services = await calendar.getServices();

{
    "total": 1,
    "limit": 10,
    "skip": 0,
    "data": [
        {
            "automatic": true,
            "title": "Reunión demo",
            "description": "Reunión demo",
            "id": "61202d32a13b4cf9004eaab1"
        }
    ],
    "cached": true
}

change

Con este método puedes cambiar la entidad con la cual buscarás fechas según mes y día, además de definir si al agendar se realiza con un servicio general o con un usuario específico. Los valores aceptados son:

• service (por defecto)

• user

calendar
  .change('user')
  .getDays('639a438084d5a0b0690d5cb5');

getDays

Con este método puedes obtener el listado de días disponibles en base al ID de un servicio y un mes en específico.

1. serviceId: Corresponde al ID del servicio

2. ISODate: Corresponde al mes en formato ISO-8601 en horario UTC, por defecto hoy.

3. timezone: Corresponde a la zona horario del usuario (opcional)

getHours

Con este método puedes obtener el listado de horas disponibles en base al ID de un servicio y un día en específico.

1. serviceId: Corresponde al ID del servicio

2. ISODate: Corresponde al mes en formato ISO-8601 en horario UTC, por defecto hoy.

3. timezone: Corresponde a la zona horario del usuario (opcional)

create

Con este método puedes crear una cita entregando 2 argumentos obligatorios.

1. entityId: Id del serivicio o agente

2. data: Datos del agendamiento como Object siendo:

Por lo que deberás:

En caso que falle deberás escuchar el evento error, donde podrás obtener el motivo del error.

cancel

Con este método puedes cancelar una cita. Este método requiere el uso de un token, por defecto se detecta automáticamente en la URL.

Los parámetros presente en la URL son:

1. v-schedule-action: corresponde a la acción a realizar

2. v-schedule-auth: corresponde al token de autorización enviado por email

reschedule

Con este método puedes reagendar una cita previamente agendada. Recibe un argumento obligatorio data que corresponde a un Object.

getInfo

Con este método puedes obtener la información de la cita solo 5 minutos antes de la hora agendada.

connect

Este método te permite generar la conexión necesaria para unirse a la videollamada. Exige el uso del token de acceso enviado en el email de confirmación o recordatorio.

join

Con este método podrás unirte a la videollamada.

addEventListener

Con este método podrás añadir oyentes de eventos con un callback. Donde el primer argumento corresponde al nombre del evento y el segundo el callback donde retorna un solo argumento como evento.

Este evento corresponde a un CustomEvent donde la información relevante está en la key detail.

calendarLink

Con este método puedes generar enlaces para los servicios de calendario más populares de esta manera tus usuarios podrán añadir la cita con un clic.

El método recibe dos argumentos:

• type: nombre del servicio puede ser google, outlook, office365, yahoo o ics.

• payload: formato para generar el enlace

title

Valor por defecto que utilizamos en el título inyectando variables.

description

Valor por defecto que utilizamos en la descripción inyectando variables.

start

Corresponde a la fecha de inicio que se entrega como UTC llamada startAt.

end

Corresponde a la fecha de término que se entrega como UTC llamada endAt.

duration

Corresponde a un array con dos índices, el primero es la duración que se obtiene de la respuesta como duration y el segundo la unidad de tiempo, que por defecto debe ser minutes, ya que duration está en minutos.

url

Corresponde al enlace de acceso a la reunión. Lo obtienes de la respuesta como joinUrl.

busy

Corresponde al estado del usuario cuando inicie la reunión en su calendario. Se sugiere utilizar true.

location

Corresponde a la ubicación de la reunión, que en este caso se utiliza para rellenar con el enlace de acceso. Algunos clientes de calendario detectan este campo como enlace de videollamada. Obtiene este valor de la respuesta como joinUrl.

guests

Corresponde al listado Array de invitados a la reunión. Puedes obtener el valor de la respuesta como email.