DemoClient

DemoClient

DemoClient(context)

Creating a DemoClient instance.

Parameters

getArticleUpdates

getArticleUpdates(projectInfo, after, updatedAfter, top)

The method is only required if the client supports continuous import mode. The articles should be ordered either by internal ID or created date ascending. Returns articles that were updated after the specified timestamp.

Parameters

Return Value

getArticles

getArticles(projectInfo, after, top)

Returns articles from the specified project.

Parameters

Return Value

getAttachmentContent

getAttachmentContent(project, document, attachment)

Returns the content of the specified attachment. Alternatively, you can get the attachment content as an HTTP response. For this option, you will need to use the http module. See the example below and use it to replace the default method implementation.

Parameters

Return Value

Example

const getAttachmentContent = (project, issue, attachment) => {
        try {
            return new http.Connection(attachment.contentUrl).getSync();
        } catch (e) {
            console.log(`Failed to download attachment ${attachment.contentUrl} ${attachment.fileName} :( `, e.message);
        }
    };

getIssueUpdates

getIssueUpdates(projectInfo, after, updatedAfter, top)

The method is only required if the client supports continuous import mode. The issues should be ordered either by internal ID or created date ascending. Returns issues that were updated after the specified timestamp.

Parameters

Return Value

getIssues

getIssues(projectInfo, after, top)

This method is invoked during the initial issues loading phase to load issues in chunks. It's recommended that the issues are ordered by either internal ID or created date ascending. The returned issues will be imported one by one in the same order. Returns issues from the specified project.

Parameters

Return Value

getLinkTypes

getLinkTypes()

Returns all link types available in the import source.

Return Value

getProject

getProject(projectInfo)

Returns an object containing a detailed description of a project including its custom field schema. In case the method is not defined by a client, the custom field schema (types, values, cardinality) will be defined based on the values provided in the `Issue` objects.

Parameters

Return Value

getProjects

getProjects()

Returns information about all projects available in the import source.

Return Value

getServerInfo

getServerInfo()

Returns the version and the time of the server.

Return Value

getTimestampFormats

getTimestampFormats()

Returns timestamp formats (for example, `yyyy-MM-dd'T'HH:mm:ss.SSSX`) that are used by the import source. The first of the returned values will be used to format the timestamp passed into the `updateAfter` parameter in the `getIssueUpdates` function. If the list is `null` or empty, the import will behave as if the `DEFAULT_TIME_FORMATS` object was returned. The string presentations matching against the formats containing timezone (for example, `yyyy-MM-dd'T'HH:mm:ss.SSSX` or `yyyy-MM-dd'T'HH:mm:ss.SSSZ`) will be converted to timestamps in the timezone parsed from that string. Otherwise, the timezone returned by the `getUserTimeZoneId` method is used.

Return Value

getUserTimeZoneId

getUserTimeZoneId()

ID of the timezone of the user who runs the import. If `null` or empty, the import script will use the timezone of the YouTrack user.

Return Value

getUsers

getUsers(group, skip, top)

Returns users belonging to the specified group.

Parameters

Return Value

prepareToImport

prepareToImport()

A function that is invoked right before an import round is started. A client can perform any necessary initialization here.