IAuthenticationModule.AuthenticationType Property

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Gets the authentication type provided by this authentication module.

public:
 property System::String ^ AuthenticationType { System::String ^ get(); };

public string AuthenticationType { get; }

member this.AuthenticationType : string

Public ReadOnly Property AuthenticationType As String

Property Value

String

A string indicating the authentication type provided by this authentication module.

Examples

The following example shows how to use the AuthenticationType property. For a complete example refer to the AuthenticationManager class.

   String^ m_authenticationType;
   bool m_canPreAuthenticate;

public:

   // The CustomBasic constructor initializes the properties of the customized
   // authentication.
   CustomBasic()
   {
      m_authenticationType = "Basic";
      m_canPreAuthenticate = false;
   }


   property String^ AuthenticationType 
   {

      // Define the authentication type. This type is then used to identify this
      // custom authentication module. The default is set to Basic.
      virtual String^ get()
      {
         return m_authenticationType;
      }

   }

   property bool CanPreAuthenticate 
   {

      // Define the pre-authentication capabilities for the module. The default is set
      // to false.
      virtual bool get()
      {
         return m_canPreAuthenticate;
      }

   }

// Define the authentication type. This type is then used to identify this
// custom authentication module. The default is set to Basic.
public string AuthenticationType { get; } = "Basic";

// Define the pre-authentication capabilities for the module. The default is set
// to false.
public bool CanPreAuthenticate { get; }

Private m_authenticationType As String
Private m_canPreAuthenticate As Boolean


' The CustomBasic constructor initializes the properties of the customized 
' authentication.
Public Sub New()
  m_authenticationType = "Basic"
  m_canPreAuthenticate = False
End Sub

' Define the authentication type. This type is then used to identify this
' custom authentication module. The default is set to Basic.

Public ReadOnly Property AuthenticationType() As String _
 Implements IAuthenticationModule.AuthenticationType

  Get
    Return m_authenticationType
  End Get
End Property

' Define the pre-authentication capabilities for the module. The default is set
' to false.

Public ReadOnly Property CanPreAuthenticate() As Boolean _
 Implements IAuthenticationModule.CanPreAuthenticate


  Get
    Return m_canPreAuthenticate
  End Get
End Property

Remarks

The AuthenticationType property identifies the authentication type implemented by this authentication module. The AuthenticationType property is used by the AuthenticationManager.Register method to determine if the authentication module has been registered, and by the AuthenticationManager.Unregister method to remove a registered authentication module.