• Articles
  • API Documentation
Search Results for

    Show / Hide Table of Contents
    • VpnSDK
      • AccountMetadataException
      • APIException
      • ApiTimeoutException
      • AuthenticationException
      • BaseSDKException
      • ConnectionAlreadyEstablishedException
      • ConnectionConfigurationBuilderBase
      • ConnectionException
      • ConnectionTerminatedException
      • CoreException
      • DataTransferEventArgs
      • DnsConfigurationException
      • DoubleHopException
      • DoubleHopNotAvailableException
      • EmptyAvailableVpnProtocolsException
      • EndpointsUnreachableException
      • FetchLocationsException
      • HTTPException
      • InvalidAccountException
      • InvalidConfigurationException
      • InvalidDoubleHopConfigurationException
      • InvalidServerException
      • NotAuthorizedException
      • NotElevatedException
      • NullLocationException
      • OAuthException
      • OpenVpnConnectionConfigurationBuilder
      • RasConnectionConfigurationBuilder
      • ReconnectOnPowerEventException
      • SDKBuilder<T>
      • SDKChangeEventHandler<T>
      • SDKEventHandler
      • SDKEventHandler<T>
      • SDKOperationEventHandler
      • SDKOperationEventHandler<T>
      • ServerListException
      • TapAdapterException
      • UnknownErrorException
      • UnsupportedProtocolException
      • VPNAuthenticationException
      • VpnException
      • VpnHostServiceException
      • VpnHostServiceFileNotFoundException
      • WFPException
      • WireGuardAPIException
      • WireGuardConnectionConfigurationBuilder
    • VpnSDK.Common.Dns
      • DnsResolutionResult
      • IDnsRequestResolver
    • VpnSDK.Common.Enums
      • SplitTunnelMode
    • VpnSDK.Common.Settings
      • SplitTunnelApp
      • SplitTunnelDomain
    • VpnSDK.DTO
      • ApiHttpError
      • ApiProxyError
      • ConnectionError
      • ISDKError
      • NetworkGeolocation
      • OpenVpnConfiguration
      • RasConfiguration
      • WireguardConfiguration
    • VpnSDK.Enums
      • AccountStatus
      • AuthenticationStatus
      • ConnectionStatus
      • DnsFilteringMode
      • DriverInstallResult
      • DriverUninstallResult
      • ErrorType
      • LoadLevel
      • NetworkConnectionType
      • NetworkProtocolType
      • OpenVpnCipherType
      • OpenVpnLogLevel
      • OperationStatus
      • RefreshLocationListStatus
    • VpnSDK.Extensions
      • ExceptionExtensions
      • LocationExtensions
      • RegionLoadChecker
    • VpnSDK.Helpers
      • BatchPingUtility
      • VersionHelper
      • VpnProtocolDiagnostics
    • VpnSDK.Interfaces
      • IBestAvailable
      • IConnectionConfiguration
      • IConnectionInfo
      • IDoubleHopConfiguration
      • ILocation
      • IOpenVpnConnectionConfiguration
      • IRasConnectionConfiguration
      • IRegion
      • ISDK
      • IUser
      • IWireGuardConnectionConfiguration

    Namespace VpnSDK

    Classes

    AccountMetadataException

    Exception AccountMetadataException. Fires when the account metadata is incorrect..

    APIException

    Exception VpnSDKOAuthException. Fired when an authentication request fails due to API issues.

    ApiTimeoutException

    Represents an exception that is thrown when an operation times out in the VPN SDK.

    AuthenticationException

    Exception AuthenticationException. Fired when an authentication request fails due to invalid credentials or Bad Request.

    BaseSDKException

    Class VpnSDKBaseException. Used as a base class for all SDK exceptions.

    ConnectionAlreadyEstablishedException

    Exception ConnectionAlreadyEstablishedException. Fires when a VPN connection request is called when a connection is already established.

    ConnectionConfigurationBuilderBase

    Base class for building connection configurations, including support for double hop settings.

    ConnectionException

    Exception ConnectionException. Fires when a VPN connection has failed.

    ConnectionTerminatedException

    Exception ConnectionTerminatedException. Fires when a VPN connection is terminated by an external source.

    CoreException

    DataTransferEventArgs

    Holds the VPN network data transfer information.

    DnsConfigurationException

    Represents an exception thrown when there is a DNS configuration issue.

    DoubleHopException

    Represents an exception thrown when there is a double hop related error.

    DoubleHopNotAvailableException

    Represents an exception thrown when double hop is not available.

    EmptyAvailableVpnProtocolsException

    Exception EmptyAvailableVpnProtocolsException. Fires when SDK construction has detected that no VPN protocols are available on the machine due to OS configuration issues or misconfiguration of the SDK.

    EndpointsUnreachableException

    Exception thrown when all API endpoints are unreachable.

    FetchLocationsException

    Exception FetchLocationsException. Fires when location fetching has failed.

    HTTPException

    Exception HTTPException. Fired as a base exception for any HTTP/S issue such as server failures, reach-ability problems and API request rejections.

    InvalidAccountException

    Represents an exception thrown when an invalid account is encountered.

    InvalidConfigurationException

    Exception InvalidConfigurationException. Fires when SDK configuration is invalid due to missing parameters or an unconfigured VPN protocol is requested.

    InvalidDoubleHopConfigurationException

    Represents an exception thrown when there is an invalid double hop configuration error.

    InvalidServerException

    Represents an exception thrown when an invalid server error occurs.

    NotAuthorizedException

    Exception NotAuthorizedException. Fired when API requests are fired before authenticating a user.

    NotElevatedException

    Exception NotElevatedException. Fires when the running process is not elevated.

    NullLocationException

    Exception NullLocationException. Fires when a null location is provided to an SDK method.

    OAuthException

    Exception OAuthException. Fired when SDK is unable to refresh the access token.

    OpenVpnConnectionConfigurationBuilder

    Class OpenVpnConnectionConfigurationBuilder. Builder for an OpenVPN IConnectionConfiguration object.

    RasConnectionConfigurationBuilder

    Class RasConnectionConfigurationBuilder. Builder for a RAS-based IConnectionConfiguration object.

    ReconnectOnPowerEventException

    Exception ReconnectOnPowerEventException. Fires when failed to reconnect on power event.

    SDKBuilder<T>

    Class SDKBuilder. Used to build an instance of a ISDK.

    ServerListException

    Exception ServerListException. Fired when the app is unable to load servers.

    TapAdapterException

    Exception TapAdapterException. Fired when an OpenVPN TAP adapter is not installed or not working correctly.

    UnknownErrorException

    UnknownErrorException. Fires when an unknown related error occurs.

    UnsupportedProtocolException

    Exception UnsupportedProtocolException. Fired when a connection request is using an invalid or unconfigured protocol.

    VPNAuthenticationException

    Exception VPNAuthenticationException. Fired when an authentication request fails due to API issues.

    VpnException

    Exception VpnException. Fired when any VPN connection error occurs.

    VpnHostServiceException

    Exception VpnHostServiceException. Fired when there's an issue with VpnHostService startup.

    VpnHostServiceFileNotFoundException

    Exception VpnHostServiceFileNotFoundException. Fired when VpnHostService.exe file is not found.

    WFPException

    Exception WFPException. Fired when any network filtering errors occur.

    WireGuardAPIException

    Exception WireGuardAPIException. Fired when getting WG configuration fails due to API issues.

    WireGuardConnectionConfigurationBuilder

    Class WireGuardConnectionConfigurationBuilder. Builder for an IConnectionConfiguration object.

    Delegates

    SDKChangeEventHandler<T>

    Delegate SDKChangeEventHandler. Used when state has changed from previous to current.

    SDKEventHandler

    Delegate SDKEventHandler.

    SDKEventHandler<T>

    Delegate SDKEventHandler.

    SDKOperationEventHandler

    Delegate SDKOperationEventHandler. Represents the current state of an operation.

    SDKOperationEventHandler<T>

    Delegate SDKOperationEventHandler. Represents the current state of an operation.

    In This Article
    Back to top VpnSDK v2 Documentation - © 2023 WLVPN