Private categoriesPrivate contextPrivate namePrivate serverFiles uploaded to the server with uploadFile() or uploadLocalFile() are retrieved with a special Url that depends on the Project. This method computes the url correctly.
an AddFileAck object with information about the uploaded file
a Url pointing to the file on the server
Create an ItemsFieldMask for use with search functions.
Optional options: IFieldMaskOptionsA IFieldMaskOptions object. If not specified, then appropriate defaults are chosen.
an initialized ItemsFieldMask object which can be further customized.
Used to populate the rather complex ExecuteParam type. We need a mapping from clone source field ids to the output category field ids.
A populated ExecuteParam suitable for use with the execute method.
Delete an Item from the project. If the Item is a folder with children, then parameter {force} must be true.
A valid item
Optional force: booleanA promise with the string "Ok" on success.
Error if the item is a non-empty folder and force was not specified as true.
Run a server execute command with the given payload
a valid ExecuteParam object
A FolderAnswer object
Export a DOC to an external file.
Can be one of "pdf", "html", "docx", or "odt"
The DOC id
Optional progressReporter: ((jobId, jobDetails) => void)an optional callback with status updates
a pointer to the location on the server where the file can be downloaded
Retrieve all changes in a project
Optional startAt: number(optional) start the audit after N records
Optional maxResults: number(optional) retrieve N results per page
Optional deleteOnly: boolean(optional) if true, only returns actions of type delete
Optional tech: boolean(optional) if true, returns the underneath changes
Optional auditIdMin: number(optional) sets a minimum ID for audits as returned by GET calendar
Optional auditIdMax: number(optional) sets a maximum ID for audits
Optional noReport: boolean(optional) if true, avoid reports in the output
Optional noImport: boolean(optional) if true, avoid imports in the output
Optional include: string(optional) a comma-seperated list of actions to include (delete,undelete,add,edit,...)
Optional resolveRef: boolean(optional) if true, resolve item IDs into refs
Optional itemRef: string(optional) restrict the audit to only those mentioning this item
a TrimAuditList structure
Get the root TreeFolder for a Project.
A valid TreeFolder.
Get the TODOs for a project.
Optional itemRef: stringif specified, returns all todos linked to an item, regardless of user
Optional includeDone: booleanif true, includes done todos
Optional includeAllUsers: booleanif true, includes all todos for all users.
Optional includeFuture: booleanfalse by default. If true, includes future todos.
Information on the todos.
Returns information about an item from an id in a given project.
A valid item id in the project
The itemId decomposed into parts
For implementors of server-side hooks and other services that use the Job API.
the jobId on which you are reporting progress
Progress (0 to 100, 200 to indicate error)
Optional status: stringoptional status string like "Done" or "Error"
string result
Perform a search and return items that are initialized according to the provided mask settings. This allows you to efficiently gather data from the server with only the fields you need brought down.
the search term
by default empty string
return results in tree order (by default false)
Optional mask: ItemsFieldMaskan optional mask
an array of filled-in Item objects.
Execute a more complex search, where the fields in the results can be limited.
Optional options: IProjectSearchOptionsreturns an array of ISearchResult objects.
set a field of an item in the database
Use: await project.setField("PROC-83", "plain english", "x");
itemId the id of the item like "REQ-1"
name of the field
value of the field
Promise to the updated item
Error in case of invalid itemId or fieldName
sets multiple fields in the database
Use: await api.setFields("PROC-83", [{fieldName:"plain english",value:"x"}] )
itemId itemId the id of the item like "REQ-1"
array of fieldName and value tupels
the updated item
Error in case of invalid id or fields
Private sleepUpload a file given by the url into the project.
an AddFileAck structure.
Upload a file to the server in Node. Not suitable for call in a web browser, as the necessary libraries (and access to the file system) are not available.
A pointer to your local Axios library
Passed through to an Axios request. A fs.ReadStream object is appropriate.
a callback to be notified of upload progress.
a IFileUploadResult object.
Some server operations that return files as URLs are long-running jobs. With a jobId, you can wait on their result while also getting progress updates.
Optional progressReporter: ((jobId, jobDetails) => void)an optional callback to be notified of the job's progress.
an array of JobFileWithUrl structures
Generated using TypeDoc
The Project class offers methods to manipulate a Matrix Project on a Matrix Instance. It is not meant to be created by the end user, rather the openProject() method is used on a StandaloneMatrixSDK object which represents the Matrix Instance.