WebSocketServerCustomValidationRequestedEventArgs
WebSocketServerCustomValidationRequestedEventArgs
WebSocketServerCustomValidationRequestedEventArgs
WebSocketServerCustomValidationRequestedEventArgs
Class
Definition
Provides data for a ServerCustomValidationRequested event on a WebSocket. This event occurs when a new, secure connection to a WebSocket is being made, and gives your code the opportunity to perform custom validation of the server certificates before the connection has been established.
public : sealed class WebSocketServerCustomValidationRequestedEventArgs : IWebSocketServerCustomValidationRequestedEventArgspublic sealed class WebSocketServerCustomValidationRequestedEventArgs : IWebSocketServerCustomValidationRequestedEventArgsPublic NotInheritable Class WebSocketServerCustomValidationRequestedEventArgs Implements IWebSocketServerCustomValidationRequestedEventArgs// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Instances of this object are created by the system and passed as an argument to your registered event handler.
Properties
ServerCertificate ServerCertificate ServerCertificate ServerCertificate
The certificate being offered by the server for validation.
public : Certificate ServerCertificate { get; }public Certificate ServerCertificate { get; }Public ReadOnly Property ServerCertificate As Certificate// You can use this property in JavaScript.
The server certificate.
ServerCertificateErrors ServerCertificateErrors ServerCertificateErrors ServerCertificateErrors
A list of errors encountered in validating the server certificate.
public : IVectorView<ChainValidationResult> ServerCertificateErrors { get; }public IReadOnlyList<ChainValidationResult> ServerCertificateErrors { get; }Public ReadOnly Property ServerCertificateErrors As IReadOnlyList<ChainValidationResult>// You can use this property in JavaScript.
- Value
- IVectorView<ChainValidationResult> IReadOnlyList<ChainValidationResult> IReadOnlyList<ChainValidationResult> IReadOnlyList<ChainValidationResult>
A list of enumeration values giving validation results.
ServerCertificateErrorSeverity ServerCertificateErrorSeverity ServerCertificateErrorSeverity ServerCertificateErrorSeverity
Gets the category of an error that occurred making an SSL connection with this WebSocket server.
public : SocketSslErrorSeverity ServerCertificateErrorSeverity { get; }public SocketSslErrorSeverity ServerCertificateErrorSeverity { get; }Public ReadOnly Property ServerCertificateErrorSeverity As SocketSslErrorSeverity// You can use this property in JavaScript.
A value describing the severity of errors encountered so far in validating this connection.
ServerIntermediateCertificates ServerIntermediateCertificates ServerIntermediateCertificates ServerIntermediateCertificates
Gets a list of intermediate certificates from the validation process currently being validated.
public : IVectorView<Certificate> ServerIntermediateCertificates { get; }public IReadOnlyList<Certificate> ServerIntermediateCertificates { get; }Public ReadOnly Property ServerIntermediateCertificates As IReadOnlyList<Certificate>// You can use this property in JavaScript.
- Value
- IVectorView<Certificate> IReadOnlyList<Certificate> IReadOnlyList<Certificate> IReadOnlyList<Certificate>
A list of intermediate certificates.
Methods
GetDeferral() GetDeferral() GetDeferral() GetDeferral()
Gets the Deferral object that manages the validation operation. Call this method when you begin your validation operation, and call Deferral.Complete when the operation is complete.
public : Deferral GetDeferral()public Deferral GetDeferral()Public Function GetDeferral() As Deferral// You can use this method in JavaScript.
Reject() Reject() Reject() Reject()
Rejects validation of this server. Call this method when your validation has determined that you should not connect to the server.
public : void Reject()public void Reject()Public Function Reject() As void// You can use this method in JavaScript.
Remarks
There is no explicit method that allows a connection during validation. If no event handler calls Reject, then the connection is allowed.