Authorization Event

Fired when the client presents its credentials to the server.

Syntax

• C#
• VB.NET

public event OnAuthorizationHandler OnAuthorization;

public delegate void OnAuthorizationHandler(object sender, QbconnectorAuthorizationEventArgs e);

public class QbconnectorAuthorizationEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int UserIndex { get; }
  public string User { get; }
  public string Password { get; }
  public bool Accept { get; set; }
}

Public Event OnAuthorization As OnAuthorizationHandler

Public Delegate Sub OnAuthorizationHandler(sender As Object, e As QbconnectorAuthorizationEventArgs)

Public Class QbconnectorAuthorizationEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property UserIndex As Integer
  Public ReadOnly Property User As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
End Class

Remarks

This is where the server can decide whether to continue or not, based on the supplied User and Password.

To accept or reject a connection set Accept to True of False.

The Accept parameter defaults to True if User is found in the AuthorizedUsers collection and Password matches, and False otherwise. The UserIndex parameter indicates the index at which the authorized user was found in the collection.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.