TaskBoard

TaskBoard classes.

TaskBoard Object

class TaskBoard

A TaskBoard is a collection of column objects, which in turn contain tasks. A task is a member of a TaskBoard iff the task is a member of one of the columns of the TaskBoard.

TaskBoard._id

The internal identifier of the TaskBoard object.

TaskBoard.group_id

The identifier of the group that “owns” the wiki. Access to the task board, its columns, and its tasks is governed by roles of the members of the group.

TaskBoard.columns

An array of Column objects.

createTaskBoard()

Create a TaskBoard.

Returns:a TaskBoard object
deleteTaskBoard(taskboard_id)
Parameters:taskboard_id (id) – task board identifier
Returns:None

Delete a task board, all of its columns, and all of its tasks. For every task that is deleted, if the user initiating the transaction is not the owner of the task, the task owner is notified of the deleted task.

Column Object

class Column
Column._id

The internal identifier of the object.

Column.taskboard_id

The internal identifier of the TaskBoard to which this is a member.

Column.tasks

An array of Task objects.

Column.title

Inherited from WikiPage.title, the short description of the column.

createColumn(taskboard_id)
Parameters:taskboard_id (id) – task board identifier
Returns:a Column object

Create a column associated with a TaskBoard.

moveColumn(column_id, taskboard_pos)
Parameters:
  • column_id (id) – column identifier
  • taskboard_pos (int) – column position

Move a column to a new position relative to other columns on its task board. Columns are not moved between boards.

modifyColumn(column_id, column_title=value)
Parameters:
  • task_id (id) – column identifier
  • column_title (str) – attribute of the column
  • value – new title of the column

Modify a column. The only attribute of the column that can be modified with this transaction is the column name.

deleteColumn(column_id)
Parameters:column_id (id) – column identifier

Delete a column and all of its tasks. For every task that is deleted, if the user initiating the transaction is not the owner of the task, the task owner is notified of the deleted task.

Task Object

class Task

Something for someone to do. Task inherits from WikiPage for the description of the task and the wiki reference attributes.

Task._id

Internal identifier of the object.

Task.taskboard_id

The identifier of the TaskBoard to which this task belongs.

Task.column_id

The identifier of the Column to which this task belongs.

Task.user_id

The identifier of the User to which this task is assigned, or None if the task is unassigned. It is unlikely that the user assigned to a task does not have a role in the group of the task board. But in the case where a user leaves a group, the users tasks are not reassigned, nor do they become unassigned.

Task.name

Inherited from WikiPage.name, the name of the task, an automatically assigned identifier.

Task.title

Inherited from WikiPage.title, the short description of the task.

Task.text

Inherited from WikiPage.text, the unformatted wiki text of the description of the task.

Task.html

Inherited from WikiPage.html, the wiki text rendered as HTML.

Task.refs

Inherited from WikiPage.refs, an array of object identifiers that the wiki description references.

createTask(taskboard_id, column_id)
Parameters:
  • taskboard_id (id) – task board identifier
  • column_id (id) – column identifier
Returns:

None

Create a task.

moveTask(task_id, column_id, column_pos)
Parameters:
  • task_id (id) – task identifier
  • column_id (id) – column identifier
  • column_pos (int) – column position
Returns:

None

Move a task to a new position relative to other tasks in the same column or in a different column. If the user initiating the transaction is not the owner of the task, the task owner is notified of the change.

assignTask(task_id, user_id)
Parameters:
  • task_id (id) – task identifier
  • user_id (id) – user identifier or None
Returns:

None

Assign a task to a user. If the user initiating the transaction is not the current owner of the task, the current owner is notified of the change. If the user initiating the transaction is not the new owner of the task, the new owner is notified of the change.

modifyTask(task_id, attr=value, ...)
Parameters:
  • task_id (id) – task identifier
  • attr (str) – attribute of the task
  • value – new value of the attribute of the task
Returns:

None

Modify a task. If the user initiating the transaction is not the owner of the task, the task owner is notified of the change.

deleteTask(task_id)
Parameters:task_id (id) – task identifier

Delete a task. If the user initiating the transaction is not the owner of the task, the task owner is notified that the task has been deleted.