Skip to content
Luis edited this page Apr 29, 2019 · 14 revisions

Welcome to the Wiki! Here, you will find all the documentation for the API! This is a project that I started a while ago, and I am very happy to release it!
Discord: https://discord.gg/RBhP6Ad


IMPORTANT INFORMATION

Versioning follows the Semantic Versioning 2.0.0 format.
So here's a few important points that you MUST be aware of before upgrading/downgrading.

  • Versions are formatted as X.Y.Z, following the semantic versioning specifications.
  • If within the same X.Y version, downgrading/upgrading to another Z is guaranteed to work with your current code.
  • If within the same X version, upgrading to another Y is guaranteed to work, however, downgrading is not.
  • If upgrading/downgrading to another X version, there is no guarantee that your current code will work.

It is strongly recommended that you always update to the latest Y version within the same X, as it may include new features, or bug fixes. If possible, you should also update to the latest X. The wiki always shows the API's latest version. For new work, you should always use the latest version available.
It is also recommended that you save a copy of the current documentation in case future reference is needed on the now old version.


Getting started

Every script in the repository is a module script.
To start, simply require() the script named "Main" like this:
local Trello = require(pathToMain)
Open auth, and place your token and key where indicated.


Constructors

Creating a new Board/List/Card

Trello.new(className, name, parent) is the constructor for every class in the API.

  • className - string - specifies what type of object to create
  • name - string - sets the initial name of the object
  • parent - object - only used to create a List or a Card, must be a Board or a List object, respectively.
    The function creates a new element in Trello, and returns the corresponding object.

Fetching a board object by name.

Trello:GetBoardByName(name)
If a board is found with the specified name, returns the board object, else, returns nil.


Docs Format

{returns} function ({arg type} {arg})

Classes

Clone this wiki locally