Class Client

Class for requesting and parsing a WMS servers capabilities

Inheritance

object

Client

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Mapsui.Providers.Wms

Assembly: Mapsui.dll

Syntax

[Serializable]
public class Client

Constructors

| Edit this page View Source

Client(XmlDocument, Func<string, Task<Stream>>?, string?)

Declaration

public Client(XmlDocument capabilitiesXmlDocument, Func<string, Task<Stream>>? getStreamAsync = null, string? userAgent = null)

Parameters

Type	Name	Description
XmlDocument	capabilitiesXmlDocument
Func<string, Task<Stream>>	getStreamAsync
string	userAgent

Properties

| Edit this page View Source

ExceptionFormats

Gets a list of available exception mime type formats

Declaration

public string[]? ExceptionFormats { get; }

Property Value

Type	Description
string[]

| Edit this page View Source

GetFeatureInfoOutputFormats

Gets a list of available feature info mime type formats

Declaration

public Collection<string>? GetFeatureInfoOutputFormats { get; }

Property Value

Type	Description
Collection<string>

| Edit this page View Source

GetFeatureInfoRequests

Gets the available GetMap request methods and Online Resource URI

Declaration

public Client.WmsOnlineResource[]? GetFeatureInfoRequests { get; }

Property Value

Type	Description
WmsOnlineResource[]

| Edit this page View Source

GetMapOutputFormats

Gets a list of available image mime type formats

Declaration

public Collection<string>? GetMapOutputFormats { get; }

Property Value

Type	Description
Collection<string>

| Edit this page View Source

GetMapRequests

Gets the available GetMap request methods and Online Resource URI

Declaration

public Client.WmsOnlineResource[]? GetMapRequests { get; }

Property Value

Type	Description
WmsOnlineResource[]

| Edit this page View Source

Layer

Gets the hierarchical layer structure

Declaration

public Client.WmsServerLayer Layer { get; }

Property Value

Type	Description
Client.WmsServerLayer

| Edit this page View Source

ServiceDescription

Gets the service description

Declaration

public Capabilities.WmsServiceDescription ServiceDescription { get; }

Property Value

Type	Description
Capabilities.WmsServiceDescription

| Edit this page View Source

VendorSpecificCapabilities

Exposes the capabilities' VendorSpecificCapabilities as XmlNode object. External modules could use this to parse the vendor specific capabilities for their specific purpose.

Declaration

public XmlNode? VendorSpecificCapabilities { get; }

Property Value

Type	Description
XmlNode

| Edit this page View Source

WmsVersion

Gets the version of the WMS server (ex. "1.3.0")

Declaration

public string WmsVersion { get; }

Property Value

Type	Description
string

Methods

| Edit this page View Source

CreateAsync(string, string?, Func<string, Task<Stream>>?, IUrlPersistentCache?, string?)

Initializes WMS server and parses the Capabilities request

Declaration

public static Task<Client> CreateAsync(string url, string? wmsVersion = null, Func<string, Task<Stream>>? getStreamAsync = null, IUrlPersistentCache? persistentCache = null, string? userAgent = null)

Parameters

Type	Name	Description
string	url	URL of wms server
string	wmsVersion	WMS version number, null to get the default from service
Func<string, Task<Stream>>	getStreamAsync	Download method, leave null for default
IUrlPersistentCache	persistentCache	persistent Cache
string	userAgent	user Agent

Returns

Type	Description
Task<Client>