Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 2.49 KB

README.md

File metadata and controls

110 lines (72 loc) · 2.49 KB

Chatex

Cliente de Elixir para el GoogleChat API.

Instalación

Primero, agrega Flowex a su tus dependencias en mix.exs:

def deps do
  [
    {:chatex, "~> 1.0.0"}
  ]
end

Configurar variables de entorno.

El archivo .env.dist contiene un listado actualizado de las variables de entorno necesarias para el proyecto, se debe copiar ese archivo a uno nuevo llamado .env

También necesitarás crear un archivo llamando google_credentials.json dentro de la carpeta secrets.

Preguntar al equipo por los valores de las variables de entorno.

Exporta las variables

export $(cat .env | xargs)

Como contribuir.

Pasos para contribuir en el proyecto:

  • Hacer un fork del repositorio a nuestra cuenta privada de Github.
  • Clonar nuestro fork en nuestra máquina de trabajo.
  • Crear un remote llamado upstream que apunte hacia el repo de Resuelve.
git remote add upstream [email protected]:resuelve/chatex.git

Instalar dependencias

mix deps.get

Uso

Chatex.Service.Spaces

Lista los espacios en los cuales se agregado al bot. (📘)

list(pageSize \\ 100, acc \\ [], pageToken \\ "")

Lista un atributo de los espacios.

list_attribute(attribute \\ "displayName", pageSize \\ 100)

Chatex.Service.Spaces.Members

Lista los miembros de un canal. (📘)

list(room, pageSize \\ 100, acc \\ [], pageToken \\ nil)

Lista los miembros de un canal excluyendo usuarios anonimos.

list_active(room, pageSize \\ 100)

Lista un atributo de los miembros activos del canal.

list_attribute(room, attribute \\ "displayName", pageSize \\ 100)

Obtiene el atributo de un miembro aleatorio.

random(room, attribute \\ "name", pageSize \\ 100)

Chatex.Service.Spaces.Messages

Crea un mensaje. (📘)

create(room, message)

Actualiza un mensaje. (📘)

update(room, update_mask, message)

Elimina un mensaje. (📘)

delete(room, message)