Documentation - Salil999/TrelloBoardReader GitHub Wiki

Documentation

There are three main components to this module: A board, lists, and cards (similar to how Trello is set up). If necessary, you can also look at Trello's official documentation.

Boards

  • get_board_name()
    • Retrieves the name of the board.
  • get_board_url()
    • Retrieves the URL of the board.
  • get_board_id()
    • Retrieves the board's unique ID. This is mostly used for differentiating among boards with similar names.
  • get_lists()
    • Retrieves the lists associated with this board. This only retrieves non-archived lists.
  • get_list_from_id(list_id)
    • Given a list id, quickly retrieves all the contents of that list.

Lists

  • get_name()
    • Retrieves the name of this list.
  • get_cards()
    • Retrieves all the cards that is in this list.
  • get_id()
    • Retrieves the list's unique ID. This is mostly used for differentiating among lists with similar names.

Cards

  • get_card_id()
    • Retrieves the card's unique ID. This is mostly used for differentiating among cards with similar names.
  • get_timestamp()
    • Retrieves the latest timestamp for the most recent activity associated with this card.
  • get_list_id()
    • Retrieves the list's ID that this card is contained in.
  • get_text()
    • Retrieves the text contained in this card.
  • get_url()
    • Retrieves the URL for this card.