Validator.ValidateObjectAsync Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Sobrecargas
| Nome | Descrição |
|---|---|
| ValidateObjectAsync(Object, ValidationContext, CancellationToken) |
Lança assíncronamente um ValidationException se o dado |
| ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken) |
Lança assíncronamente um ValidationException se a instância do objeto dada não for válida. |
ValidateObjectAsync(Object, ValidationContext, CancellationToken)
- Origem:
- Validator.cs
Lança assíncronamente um ValidationException se o dado instance não for válido.
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")]
public static System.Threading.Tasks.Task ValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")>]
static member ValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function ValidateObjectAsync (instance As Object, validationContext As ValidationContext, Optional cancellationToken As CancellationToken = Nothing) As TaskParâmetros
- instance
- Object
A instância do objeto a testar. Não pode ser null.
- validationContext
- ValidationContext
Descreve o objeto a ser validado e fornece serviços e contexto para os validadores.
- cancellationToken
- CancellationToken
A CancellationToken para observar enquanto se espera que a tarefa seja concluída.
Devoluções
A Task representa a operação de validação assíncrona.
- Atributos
Exceções
Quando instance é null.
Quando validationContext é null.
Quando instance não corresponde ao ObjectInstance .validationContext
Quando instance for considerado inválido.
A operação de validação foi cancelada.
Observações
Este método verifica os RequiredAttribute atributos nas propriedades do objeto. Se a validação de propriedades for bem-sucedida, o método avalia os ValidationAttribute atributos associados ao tipo do objeto.
Esta sobrecarga não avalia outros atributos de validação ao nível da propriedade. Para avaliar esses atributos, chame-se à sobrecarga que aceita validateAllProperties com esse conjunto de argumentos para true.
A validação decorre em três etapas: validação de propriedades, validação de atributos ao nível do tipo e validação ao nível do objeto. Cada fase só decorre se as fases anteriores forem bem-sucedidas. A validação ao nível do objeto prefere invocar ValidateAsync(ValidationContext, CancellationToken) quando implementada, como Validate(ValidationContext) recurso para objetos que implementam apenas a interface síncrona. Não invoca ambos.
Aplica-se a
ValidateObjectAsync(Object, ValidationContext, Boolean, CancellationToken)
- Origem:
- Validator.cs
Lança assíncronamente um ValidationException se a instância do objeto dada não for válida.
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")]
public static System.Threading.Tasks.Task ValidateObjectAsync(object instance, System.ComponentModel.DataAnnotations.ValidationContext validationContext, bool validateAllProperties, System.Threading.CancellationToken cancellationToken = default);[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Constructing a ValidationContext without a display name is not trim-safe because it uses reflection to discover the type of the instance being validated in order to resolve the DisplayNameAttribute when a display name is not provided.")>]
static member ValidateObjectAsync : obj * System.ComponentModel.DataAnnotations.ValidationContext * bool * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function ValidateObjectAsync (instance As Object, validationContext As ValidationContext, validateAllProperties As Boolean, Optional cancellationToken As CancellationToken = Nothing) As TaskParâmetros
- instance
- Object
A instância do objeto a testar. Não pode ser null.
- validationContext
- ValidationContext
Descreve o objeto a ser validado e fornece serviços e contexto para os validadores.
- validateAllProperties
- Boolean
Se true, também valida todas as instancepropriedades de .
- cancellationToken
- CancellationToken
A CancellationToken para observar enquanto se espera que a tarefa seja concluída.
Devoluções
A Task representa a operação de validação assíncrona.
- Atributos
Exceções
Quando instance é null.
Quando validationContext é null.
Quando instance não corresponde ao ObjectInstance .validationContext
Quando instance for considerado inválido.
A operação de validação foi cancelada.
Observações
Este método verifica os RequiredAttribute atributos nas propriedades do objeto mesmo quando validateAllProperties é false. Se a validação de propriedades for bem-sucedida, o método avalia os ValidationAttribute atributos associados ao tipo do objeto.
Se validateAllProperties for true, o método também avalia outros atributos de validação sobre as propriedades imediatas do objeto. Este processo não valida recursivamente os valores das propriedades.
A validação decorre em três etapas: validação de propriedades, validação de atributos ao nível do tipo e validação ao nível do objeto. Cada fase só decorre se as fases anteriores forem bem-sucedidas. A validação ao nível do objeto prefere invocar ValidateAsync(ValidationContext, CancellationToken) quando implementada, como Validate(ValidationContext) recurso para objetos que implementam apenas a interface síncrona. Não invoca ambos.
