Constructor
new Project(id, authopt, apiBaseopt)
Create a Project.
- Source:
Parameters:
| 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 |
Methods
createProjectCard(colId, options, cb) → {Promise}
Create a new card
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
colId |
string
|
the column id |
options |
Object
|
the description of the card |
cb |
Requestable.callback
|
will receive the newly created card |
Returns:
- Type:
-
Promise
- the promise for the http request
createProjectColumn(options, cb) → {Promise}
Create a new column
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object
|
the description of the column |
cb |
Requestable.callback
|
will receive the newly created column |
Returns:
- Type:
-
Promise
- the promise for the http request
deleteProject(cb) → {Promise}
Delete a project
Parameters:
| Name | Type | Description |
|---|---|---|
cb |
Requestable.callback
|
will receive true if the operation is successful |
Returns:
- Type:
-
Promise
- the promise for the http request
deleteProjectCard(cardId, cb) → {Promise}
Delete a card
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
cardId |
string
|
the card to be deleted |
cb |
Requestable.callback
|
will receive true if the operation is successful |
Returns:
- Type:
-
Promise
- the promise for the http request
deleteProjectColumn(colId, cb) → {Promise}
Delete a column
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
colId |
string
|
the column to be deleted |
cb |
Requestable.callback
|
will receive true if the operation is successful |
Returns:
- Type:
-
Promise
- the promise for the http request
getProject(cb) → {Promise}
Get information about a project
Parameters:
| Name | Type | Description |
|---|---|---|
cb |
Requestable.callback
|
will receive the project information |
Returns:
- Type:
-
Promise
- the promise for the http request
getProjectCard(cardId, cb) → {Promise}
Get information about a card
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
cardId |
string
|
the id of the card |
cb |
Requestable.callback
|
will receive the card information |
Returns:
- Type:
-
Promise
- the promise for the http request
getProjectColumn(colId, cb) → {Promise}
Get information about a column
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
colId |
string
|
the id of the column |
cb |
Requestable.callback
|
will receive the column information |
Returns:
- Type:
-
Promise
- the promise for the http request
listColumnCards(colId, cbopt) → {Promise}
Get information about all cards of a column
- Source:
- See:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
colId |
string
|
the id of the column |
|
cb |
Requestable.callback
|
<optional> |
will receive the list of cards |
Returns:
- Type:
-
Promise
- the promise for the http request
listProjectCards(cbopt) → {Promise}
Get information about all cards of a project
- Source:
- See:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
cb |
Requestable.callback
|
<optional> |
will receive the list of cards |
Returns:
- Type:
-
Promise
- the promise for the http request
listProjectColumns(cbopt) → {Promise}
Get information about all columns of a project
- Source:
- See:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
cb |
Requestable.callback
|
<optional> |
will receive the list of columns |
Returns:
- Type:
-
Promise
- the promise for the http request
moveProjectCard(cardId, position, colId, cb) → {Promise}
Move a card
- Source:
- See:
Parameters:
| 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 |
Returns:
- Type:
-
Promise
- the promise for the http request
moveProjectColumn(colId, position, cb) → {Promise}
Move a column
- Source:
- See:
Parameters:
| 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 |
Returns:
- Type:
-
Promise
- the promise for the http request
updateProject(options, cb) → {Promise}
Edit a project
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object
|
the description of the project |
cb |
Requestable.callback
|
will receive the modified project |
Returns:
- Type:
-
Promise
- the promise for the http request
updateProjectCard(cardId, options, cb) → {Promise}
Edit a card
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
cardId |
string
|
the card id |
options |
Object
|
the description of the card |
cb |
Requestable.callback
|
will receive the modified card |
Returns:
- Type:
-
Promise
- the promise for the http request
updateProjectColumn(colId, options, cb) → {Promise}
Edit a column
- Source:
- See:
Parameters:
| Name | Type | Description |
|---|---|---|
colId |
string
|
the column id |
options |
Object
|
the description of the column |
cb |
Requestable.callback
|
will receive the modified column |
Returns:
- Type:
-
Promise
- the promise for the http request