• 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

    Interface ILocation

    Interface ILocation. Describes an interface for a generic location.

    Namespace: VpnSDK.Interfaces
    Assembly: cs.temp.dll.dll
    Syntax
    public interface ILocation : INotifyPropertyChanged

    Properties

    AvailableProtocols

    Gets the list of VPN protocols available for this Location.

    Declaration
    List<NetworkConnectionType> AvailableProtocols { get; }
    Property Value
    Type Description
    List<NetworkConnectionType>

    City

    Gets the city of the location to connect to. This field may be empty on some location objects.

    Declaration
    string City { get; }
    Property Value
    Type Description
    System.String

    CityCode

    Gets the city code.

    Declaration
    string CityCode { get; }
    Property Value
    Type Description
    System.String

    The city code.

    Country

    Gets the country of the location to connect to.

    Declaration
    string Country { get; }
    Property Value
    Type Description
    System.String

    CountryCode

    Gets the country code.

    Declaration
    string CountryCode { get; }
    Property Value
    Type Description
    System.String

    The country code.

    Id

    Gets the identifier.

    Declaration
    string Id { get; }
    Property Value
    Type Description
    System.String

    The identifier.

    PingMs

    Gets the ping in milliseconds.

    Declaration
    ushort? PingMs { get; }
    Property Value
    Type Description
    System.Nullable<System.UInt16>

    The ping in milliseconds, else null.

    SearchName

    Gets the string used for searching.

    Declaration
    string SearchName { get; }
    Property Value
    Type Description
    System.String

    The name to be used in searches.

    Methods

    Ping()

    Pings this instance.

    Declaration
    Task<ushort?> Ping()
    Returns
    Type Description
    Task<System.Nullable<System.UInt16>>

    Task<System.Nullable<System.UInt16>>.

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