IWorkItemFormService interface

Ajoute des liens d’autres éléments de travail ou artefacts (par exemple, des commits, des liens hypertexte) à l’élément de travail. La pièce jointe n’est actuellement pas prise en charge par cette fonction.

function addWorkItemRelations(workItemRelations: WorkItemRelation[]): Promise<void>

Paramètres

Retours

Une promesse vide.

@deprecated: Utilisez enregistrer

function beginSaveWorkItem(successCallback: () => void, errorCallback: () => void): Promise<void>

Paramètres

Retours

Efface le jeu d’erreur défini par la méthode setError et débloque l’enregistrement de l’élément de travail dans le formulaire.

function clearError(): Promise<void>

Retours

Obtient les valeurs autorisées pour le champ sur l’élément de travail actif.

function getAllowedFieldValues(fieldReferenceName: string): Promise<Object[]>

Paramètres

Retours

Promesse qui retourne un tableau de valeurs autorisées.

Obtient les champs qui ont été modifiés par l’utilisateur ou par une règle d’élément de travail et qui sont dans un état sale.

function getDirtyFields(includeSystemChanges?: boolean): Promise<WorkItemField[]>

Paramètres

Retours

Promesse qui retourne un tableau de sale champs d’élément de travail.

Obtient les champs d’élément de travail actifs.

function getFields(): Promise<WorkItemField[]>

Retours

Promesse qui retourne un tableau de champ d’élément de travail.

Obtient la valeur de champ de l’élément de travail actif.

function getFieldValue(fieldReferenceName: string, returnOriginalValue?: boolean): Promise<Object>

Paramètres

Retours

Promesse qui retourne la valeur du champ d’élément de travail.

Obtient la valeur de champ de l’élément de travail actif.

function getFieldValue(fieldReferenceName: string, options?: WorkItemOptions): Promise<Object>

Paramètres

Retours

Promesse qui retourne la valeur du champ d’élément de travail.

Obtient les valeurs de champ de l’élément de travail actif.

function getFieldValues(fieldReferenceNames: string[], returnOriginalValue?: boolean): Promise<{[fieldName: string]: Object}>

Paramètres

Retours

Promesse qui retourne un dictionnaire de valeurs de champ d’élément de travail (refName aux paires valeurs).

Obtient les valeurs de champ de l’élément de travail actif.

function getFieldValues(fieldReferenceNames: string[], options?: WorkItemOptions): Promise<{[fieldName: string]: Object}>

Paramètres

Retours

Promesse qui retourne un dictionnaire de valeurs de champ d’élément de travail (refName aux paires valeurs).

Obtient l’ID de l’élément de travail actif.

function getId(): Promise<number>

Retours

Promesse qui retourne l’ID d’élément de travail actif.

Obtient la valeur du champ d’identité de l’élément de travail actif.

function getIdentityFieldValue(fieldReferenceName: string, options?: WorkItemOptions): Promise<IdentityRef>

Paramètres

Retours

Promesse qui retourne la valeur du champ d’élément de travail.

Obtient les champs qui ne sont pas valides en fonction des règles d’élément de travail. Ces champs doivent être modifiés avant que l’élément de travail puisse être enregistré.

function getInvalidFields(): Promise<WorkItemField[]>

Retours

Promesse qui retourne un tableau de champs d’élément de travail non valides.

Obtient la dernière révision de l’élément de travail actif.

function getRevision(): Promise<number>

Retours

Promesse qui retourne l’ID de révision le plus récent de l’élément de travail actif.

Retourne un tableau de liens d’élément de travail vers d’autres éléments de travail ou artefacts (par exemple, des commits, des liens hypertexte). La pièce jointe n’est actuellement pas prise en charge par cette fonction.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Retours

Promesse qui retourne un tableau de relations d’élément de travail de l’élément de travail actif.

Retourne un tableau de types de relations d’élément de travail.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Retours

Promesse qui retourne un tableau de types de relations d’élément de travail.

Retourne l’URL de l’API REST de la ressource d’élément de travail spécifiée.

function getWorkItemResourceUrl(workItemId: number): Promise<string>

Paramètres

Retours

Promesse qui retourne l’URL de ressource demandée de l’élément de travail.

Retourne true si l’élément de travail actif est disponible.

function hasActiveWorkItem(): Promise<boolean>

Retours

Une promesse qui retourne une valeur booléenne indique si l’élément de travail actif est disponible.

Retourne true si l’élément de travail actif est sale.

function isDirty(): Promise<boolean>

Retours

Une promesse qui retourne une valeur booléenne indique si l’élément de travail actif est sale.

Retourne true si l’élément de travail actif est nouveau.

function isNew(): Promise<boolean>

Retours

Une promesse qui retourne une valeur booléenne indique si l’élément de travail actif est nouveau.

Retourne true si les champs d’élément de travail actifs sont tous valides.

function isValid(): Promise<boolean>

Retours

Une promesse qui retourne une valeur booléenne indique si toutes les valeurs de champ sont valides.

Actualise l’élément de travail actif. Invite l’utilisateur si l’élément de travail est sale.

function refresh(): Promise<void>

Retours

Supprime des liens vers d’autres éléments de travail ou artefacts (par exemple, des commits, des liens hypertexte) de l’élément de travail. La pièce jointe n’est actuellement pas prise en charge par cette fonction.

function removeWorkItemRelations(workItemRelations: WorkItemRelation[]): Promise<void>

Paramètres

Retours

Une promesse vide.

Réinitialisez les modifications apportées à l’élément de travail actif. Invite l’utilisateur à confirmer.

function reset(): Promise<void>

Retours

Enregistre l’élément de travail actif.

function save(): Promise<void>

Retours

Promesse qui est résolue si l’élément de travail est correctement enregistré et rejeté en cas d’échec.

Marque l’élément de travail comme non valide et désactivez l’enregistrement de l’élément de travail dans le formulaire.

function setError(errorMessage: string): Promise<void>

Paramètres

Retours

Définit la valeur de champ de l’élément de travail actif.

function setFieldValue(fieldReferenceName: string, value: Object): Promise<boolean>

Paramètres

Retours

Une promesse qui retourne une valeur booléenne indique si la fonction s’est terminée correctement.

Définit les valeurs de champ de l’élément de travail actif.

function setFieldValues(fields: {[fieldName: string]: Object}): Promise<{[fieldName: string]: boolean}>

Paramètres

Retours

Promesse qui retourne un dictionnaire de résultats de mise à jour de la valeur de champ (refName aux paires de résultats).