Class ReturnElementErrorAction

ÉlémentErreurAction

Une ReturnElementErrorAction indique qu'une erreur s'est produite lors de l'appel d'un élément.

Uniquement disponible pour les modules complémentaires Google Workspace qui étendent Google Workspace Studio.

Exemple d'utilisation :

const workflowAction = AddOnsResponseService.newReturnElementErrorAction()
.setErrorActionability(
  AddOnsResponseService.ErrorActionability.NOT_ACTIONABLE
)
.setErrorRetryability(
  AddOnsResponseService.ErrorRetryability.NOT_RETRYABLE
)
// Set the user-facing error log
.setErrorLog(
  AddOnsResponseService.newWorkflowTextFormat()
    .addTextFormatElement(
      AddOnsResponseService.newTextFormatElement()
        .setText("Failed to create Google Doc.")
    )
);

Méthodes

MéthodeType renvoyéBrève description
setErrorActionability(errorActionability)ReturnElementErrorActionDéfinit l'actionnabilité de l'erreur. Une erreur doit être actionable si elle peut être résolue en reconfigurant l'étape.
setErrorLog(log)ReturnElementErrorActionDéfinit le journal des erreurs à afficher à l'utilisateur final dans le flux d'activité du workflow.
setErrorRetryability(errorRetryability)ReturnElementErrorActionDéfinit la possibilité de nouvelle tentative en cas d'erreur. Le flux se termine après la première tentative si une erreur ne peut pas faire l'objet d'une nouvelle tentative.

Documentation détaillée

setErrorActionability(errorActionability)

Définit l'actionnabilité de l'erreur. Une erreur doit être actionable si elle peut être résolue en reconfigurant l'étape. Un lien "Corriger" s'affiche pour permettre à l'utilisateur de reconfigurer l'étape.

Paramètres

NomTypeDescription
errorActionabilityErrorActionabilityExploitabilité de l'erreur.

Renvois

ReturnElementErrorAction : action d'erreur de l'élément de retour, pour le chaînage.


setErrorLog(log)

Définit le journal des erreurs à afficher à l'utilisateur final dans le flux d'activité du workflow.

Paramètres

NomTypeDescription
logWorkflowTextFormatJournal des erreurs pour l'utilisateur final.

Renvois

ReturnElementErrorAction : action d'erreur de l'élément de retour, pour le chaînage.


setErrorRetryability(errorRetryability)

Définit la possibilité de nouvelle tentative en cas d'erreur. Le flux se termine après la première tentative si une erreur ne peut pas faire l'objet d'une nouvelle tentative. Sinon, Workflow tentera d'exécuter l'étape jusqu'à cinq fois.

Paramètres

NomTypeDescription
errorRetryabilityErrorRetryabilityErrorRetryability

Renvois

ReturnElementErrorAction : action d'erreur de l'élément de retour, pour le chaînage.