Compartilhar via


WidgetStatusHelper class

Métodos

Failure(string, boolean, boolean)

para encapsular um resultado com falha para uma operação de carregamento de widget (carregar, recarregar, openLightbox etc)

Success(string)

para encapsular um resultado bem-sucedido para uma operação de carregamento de widget (carregar, recarregar, openLightbox etc.)

Unconfigured()

para encapsular um resultado para uma operação de carregamento de widget que resulta no widget em um estado não configurado.

Detalhes do método

Failure(string, boolean, boolean)

para encapsular um resultado com falha para uma operação de carregamento de widget (carregar, recarregar, openLightbox etc)

static function Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>

Parâmetros

message

string

a ser exibida como parte da experiência de erro do widget.

isUserVisible

boolean

Indica se a mensagem deve ser exibida para o usuário ou se uma mensagem de erro genérica deve ser exibida. O padrão é true.

isRichText

boolean

Indica se a mensagem é um HTML que pode ser renderizado como uma experiência avançada. O padrão é false. Somente extensões confiáveis têm permissão para definir isso como true. Para qualquer widget de terceiros que passe esse valor como verdadeiro, ele será ignorado.

Retornos

Promise<WidgetStatus>

que encapsula o status das operações de carregamento do widget.

Success(string)

para encapsular um resultado bem-sucedido para uma operação de carregamento de widget (carregar, recarregar, openLightbox etc.)

static function Success(state?: string): Promise<WidgetStatus>

Parâmetros

state

string

Qualquer informação de estado a ser passada para o iniciador da chamada de carregamento.

Retornos

Promise<WidgetStatus>

que encapsula o status das operações de carregamento do widget.

Unconfigured()

para encapsular um resultado para uma operação de carregamento de widget que resulta no widget em um estado não configurado.

static function Unconfigured(): Promise<WidgetStatus>

Retornos

Promise<WidgetStatus>

que encapsula o status das operações de carregamento do widget.