Interface IProjectNeeds

interface IProjectNeeds {
    createItemInProject(project, parentFolderId, item): Promise<string>;
    createTodo(project, users, type, text, itemId, fieldId, atDate): Promise<string>;
    deleteItemInProject(project, itemId, force?): Promise<string>;
    deleteJobForProject(project, jobId, reason): Promise<string>;
    downloadJobResult(project, jobId, fileno, mode?, format?, disposition?, options?): Promise<ArrayBuffer>;
    executeInProject(project, payload): Promise<FolderAnswer>;
    getFullTreeFromProject(projectName): Promise<FancyFolder[]>;
    getItemFromProject(project, id): Promise<IItemGet>;
    getJobStatus(project, jobId, options?): Promise<JobsStatusWithUrl>;
    getProjectAudit(project, startAt?, maxResults?, deleteOnly?, tech?, auditIdMin?, auditIdMax?, noReport?, noImport?, include?, resolveRef?, itemRef?): Promise<TrimAuditList>;
    getProjectSettings(project): Promise<GetProjectSettingAck>;
    getProjectTodos(project, itemRef?, includeDone?, includeAllUsers?, includeFuture?): Promise<GetTodosAck>;
    getUrlInfo(): [string, string];
    moveItemsInProject(project, folderId, itemIds): Promise<string>;
    parseRefForProject(project, itemRef): IItemIdParts;
    postJobProgressForProject(project, jobId, progress, status?): Promise<string>;
    postProjectReport(project, item, format): Promise<CreateReportJobAck>;
    putProjectSetting(project, key, value): Promise<string>;
    runHookInProject(project, itemId, hookName, body): Promise<string>;
    searchIdsInProject(project, term): Promise<string[]>;
    searchItemsInProject(project, term, options?): Promise<ISearchResult[]>;
    setFieldsInProject(project, projectItemConfig, itemId, data): Promise<IItemGet>;
    updateItemInProject(project, item, currentVersion?): Promise<string>;
    uploadFileToProject(project, url): Promise<AddFileAck>;
    uploadLocalFileToProject(project, axiosLib, file, progress): Promise<AddFileAck>;
}

Implemented by

Methods

createItemInProject createTodo deleteItemInProject deleteJobForProject downloadJobResult executeInProject getFullTreeFromProject getItemFromProject getJobStatus getProjectAudit getProjectSettings getProjectTodos getUrlInfo moveItemsInProject parseRefForProject postJobProgressForProject postProjectReport putProjectSetting runHookInProject searchIdsInProject searchItemsInProject setFieldsInProject updateItemInProject uploadFileToProject uploadLocalFileToProject

Methods

createItemInProject

createTodo

  • createTodo(project, users, type, text, itemId, fieldId, atDate): Promise<string>

  • Parameters

    • project: string
    • users: string[]
    • type: string
    • text: string
    • itemId: string
    • fieldId: null | number
    • atDate: Date

    Returns Promise<string>

deleteItemInProject

  • deleteItemInProject(project, itemId, force?): Promise<string>

  • Parameters

    • project: string
    • itemId: string
    • Optional force: boolean

    Returns Promise<string>

deleteJobForProject

  • deleteJobForProject(project, jobId, reason): Promise<string>

  • Parameters

    • project: string
    • jobId: number
    • reason: string

    Returns Promise<string>

downloadJobResult

  • downloadJobResult(project, jobId, fileno, mode?, format?, disposition?, options?): Promise<ArrayBuffer>

  • Parameters

    • project: string
    • jobId: number
    • fileno: number
    • Optional mode: string
    • Optional format: string
    • Optional disposition: string
    • Optional options: unknown

    Returns Promise<ArrayBuffer>

executeInProject

getFullTreeFromProject

getItemFromProject

getJobStatus

getProjectAudit

  • getProjectAudit(project, startAt?, maxResults?, deleteOnly?, tech?, auditIdMin?, auditIdMax?, noReport?, noImport?, include?, resolveRef?, itemRef?): Promise<TrimAuditList>

  • Parameters

    • project: string
    • Optional startAt: number
    • Optional maxResults: number
    • Optional deleteOnly: boolean
    • Optional tech: boolean
    • Optional auditIdMin: number
    • Optional auditIdMax: number
    • Optional noReport: boolean
    • Optional noImport: boolean
    • Optional include: string
    • Optional resolveRef: boolean
    • Optional itemRef: string

    Returns Promise<TrimAuditList>

getProjectSettings

  • getProjectSettings(project): Promise<GetProjectSettingAck>

  • Parameters

    • project: string

    Returns Promise<GetProjectSettingAck>

getProjectTodos

  • getProjectTodos(project, itemRef?, includeDone?, includeAllUsers?, includeFuture?): Promise<GetTodosAck>

  • Parameters

    • project: string
    • Optional itemRef: string
    • Optional includeDone: boolean
    • Optional includeAllUsers: boolean
    • Optional includeFuture: boolean

    Returns Promise<GetTodosAck>

getUrlInfo

  • getUrlInfo(): [string, string]

  • Returns the base URL of the server, and the REST api endpoint.

    Returns [string, string]

    a tuple with [baseUrl, baseRestUrl]

moveItemsInProject

  • moveItemsInProject(project, folderId, itemIds): Promise<string>

  • Parameters

    • project: string
    • folderId: string
    • itemIds: string[]

    Returns Promise<string>

parseRefForProject

postJobProgressForProject

  • postJobProgressForProject(project, jobId, progress, status?): Promise<string>

  • Parameters

    • project: string
    • jobId: number
    • progress: number
    • Optional status: string

    Returns Promise<string>

postProjectReport

putProjectSetting

  • putProjectSetting(project, key, value): Promise<string>

  • Parameters

    • project: string
    • key: string
    • value: string

    Returns Promise<string>

runHookInProject

  • runHookInProject(project, itemId, hookName, body): Promise<string>

  • Parameters

    • project: string
    • itemId: string
    • hookName: string
    • body: string

    Returns Promise<string>

searchIdsInProject

  • searchIdsInProject(project, term): Promise<string[]>

  • Parameters

    • project: string
    • term: string

    Returns Promise<string[]>

searchItemsInProject

setFieldsInProject

updateItemInProject

  • updateItemInProject(project, item, currentVersion?): Promise<string>

  • Parameters

    • project: string
    • item: IItemPut
    • Optional currentVersion: number

    Returns Promise<string>

uploadFileToProject

uploadLocalFileToProject

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc