• Guides & Articles
  • API Documentation

    Show / Hide Table of Contents
    • VpnSDK.Public
      • OpenVpnConfiguration
      • OpenVpnConnectionConfigurationBuilder
      • PositionInfoEventArgs
      • RasConfiguration
      • RasConnectionConfigurationBuilder
      • SDKBuilder
    • VpnSDK.Public.Enums
      • AuthenticationStatus
      • ConnectionStatus
      • NetworkConnectionType
      • NetworkProtocolType
      • OpenVpnCipherType
      • PositionInfoStatus
      • RefreshLocationListStatus
    • VpnSDK.Public.Exceptions
      • VpnSDKAPIException
      • VpnSDKAuthenticationException
      • VpnSDKBaseException
      • VpnSDKConnectionAlreadyEstablishedException
      • VpnSDKConnectionException
      • VpnSDKConnectionTerminatedException
      • VpnSDKCoreException
      • VpnSDKEmptyAvailableVpnProtocolsException
      • VpnSDKFetchLocationsException
      • VpnSDKInvalidConfigurationException
      • VpnSDKNotAuthorizedException
      • VpnSDKNullLocationException
      • VpnSDKOAuthException
      • VpnSDKUnsupportedProtocolException
      • VpnSDKVPNAuthenticationException
    • VpnSDK.Public.Extensions
      • ExceptionExtensions
      • LoadLevel
      • RegionLoadChecker
    • VpnSDK.Public.Helpers
      • VpnProtocolDiagnostics
    • VpnSDK.Public.Interfaces
      • IBestAvailable
      • IConnectionConfiguration
      • ILocation
      • IOpenVpnConnectionConfiguration
      • IRasConnectionConfiguration
      • IRegion
      • ISDK
      • IServer
      • IUser
    • VpnSDK.Public.Messages
      • RefreshLocationListMessage

    Class SDKBuilder

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

    Inheritance
    Object
    VpnSDK.Public.SDKBuilderBase<ISDK, SDKBuilder>
    SDKBuilder
    Namespace: VpnSDK.Public
    Assembly: VpnSDK.dll
    Syntax
    public class SDKBuilder : SDKBuilderBase<ISDK, SDKBuilder>

    Methods

    Create()

    Creates an ISDK based off the parameters chained before the call.

    Declaration
    public override ISDK Create()
    Returns
    Type Description
    ISDK

    An instance of ISDK.

    Overrides
    VpnSDK.Public.SDKBuilderBase<VpnSDK.Public.Interfaces.ISDK, VpnSDK.Public.SDKBuilder>.Create()

    Validate()

    Validates the configuration before creating the SDK instance. The validation done depends on the type of client.

    Declaration
    public override void Validate()
    Overrides
    VpnSDK.Public.SDKBuilderBase<VpnSDK.Public.Interfaces.ISDK, VpnSDK.Public.SDKBuilder>.Validate()
    Exceptions
    Type Condition
    VpnSDKInvalidConfigurationException

    Either the API Key, application name or authentication token were not set.

    VpnSDKEmptyAvailableVpnProtocolsException

    No VPN protocols were configured.

    Back to top Pre-release documentation. These do not represent the final product and are subject to change.