Project encapsulates the functionality to create, query, and modify cards and columns.
Create a Project.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id | string | the id of the project | ||
auth | Requestable.auth | <optional> | information required to authenticate to Github | |
apiBase | string | <optional> | https://api.github.com | the base Github API URL |
Create a new card
| Name | Type | Description |
|---|---|---|
colId | string | the column id |
options | Object | the description of the card |
cb | Requestable.callback | will receive the newly created card |
Create a new column
| Name | Type | Description |
|---|---|---|
options | Object | the description of the column |
cb | Requestable.callback | will receive the newly created column |
Delete a project
| Name | Type | Description |
|---|---|---|
cb | Requestable.callback | will receive true if the operation is successful |
Delete a card
| Name | Type | Description |
|---|---|---|
cardId | string | the card to be deleted |
cb | Requestable.callback | will receive true if the operation is successful |
Delete a column
| Name | Type | Description |
|---|---|---|
colId | string | the column to be deleted |
cb | Requestable.callback | will receive true if the operation is successful |
Get information about a project
| Name | Type | Description |
|---|---|---|
cb | Requestable.callback | will receive the project information |
Get information about a card
| Name | Type | Description |
|---|---|---|
cardId | string | the id of the card |
cb | Requestable.callback | will receive the card information |
Get information about a column
| Name | Type | Description |
|---|---|---|
colId | string | the id of the column |
cb | Requestable.callback | will receive the column information |
Get information about all cards of a column
| Name | Type | Attributes | Description |
|---|---|---|---|
colId | string | the id of the column | |
cb | Requestable.callback | <optional> | will receive the list of cards |
Get information about all cards of a project
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of cards |
Get information about all columns of a project
| Name | Type | Attributes | Description |
|---|---|---|---|
cb | Requestable.callback | <optional> | will receive the list of columns |
Move a card
| Name | Type | Description |
|---|---|---|
cardId | string | the card to be moved |
position | string | can be one of top, bottom, or after: |
colId | string | the id value of a column in the same project. |
cb | Requestable.callback | will receive true if the operation is successful |
Move a column
| Name | Type | Description |
|---|---|---|
colId | string | the column to be moved |
position | string | can be one of first, last, or after: |
cb | Requestable.callback | will receive true if the operation is successful |
Edit a project
| Name | Type | Description |
|---|---|---|
options | Object | the description of the project |
cb | Requestable.callback | will receive the modified project |
Edit a card
| Name | Type | Description |
|---|---|---|
cardId | string | the card id |
options | Object | the description of the card |
cb | Requestable.callback | will receive the modified card |
Edit a column
| Name | Type | Description |
|---|---|---|
colId | string | the column id |
options | Object | the description of the column |
cb | Requestable.callback | will receive the modified column |