Author: Christopher Hiller
Overview: Library providing FogBugz API functionality.
This is still in development as the API has not fully been built out yet, but I hope to get everything in place eventually.
npm install fogbugz
Create a fogbugz.conf.json
in your app's root directory. It should look like this:
{
"host": "zzz.fogbugz.com",
"username": "zzz@yyy.com",
"password": "Password1"
}
var fogbugz = require('fogbugz');
fogbugz.logon()
.then(function() {
return fogbugz.getBug('12345');
})
.then(function(bug) {
console.log(bug.title);
});
Forgets the stored token.
Manually sets a login token if you have one by some other means.
Parameters
token: string, FogBugz API logon token
See Also
Assuming you are logged in and have a cached token, this will log you out.
Returns
Function|promise|Q.promise, Promise
Logs you into FogBugz based on contents of fogbugz.conf.json
.
Returns
Function|promise|Q.promise, Promise
Retrieves a list of Filters as an array. Each item in the array is of type Filter. Example:
[{"name": "My Cases", "type": "builtin", "id": "ez",
"url": "https://zzz.fogbugz.com/default.asp?pgx=LF&ixFilter=ez"}),
{"name": "Inbox", "type": "builtin", "id": "inbox",
"url": "https://zzz.fogbugz.com/default.asp?pgx=LF&ixFilter=inbox"}]
Returns
Function|promise|Q.promise, Promise
See Also
Sets the current Filter. Allows to call fogbugz.search() with an empty string as the 'query' paramenter to list all cases in the current filter.
Parameters
filter: Filter|string, Filter object or string ID
See Also
class fogbugz.Filter fogbugz.search
Performs a search against FogBugz's cases. Promise resolves to a Case
object or an array of Case
objects.
Parameters
query: string, Query stirng
[cols]: array, Fields to pull
[max]: number, Number of cases to get at once
Returns
Function|promise|Q.promise, Promise
Gets a bug by ID
Parameters
id: string|number, ID of bug
[cols]: number, Cols to pull; defaults to everything
Filter pseudoclass
Parameters
obj: Object, Object representing Filter
Methods
Sets the current filter to be this Filter
Case pseudoclass. Stores original case data from server in its _raw
property.
Parameters
obj: Object, Object representing Case