Class Client

The MapGuide HTTP client

export
implements: {IMapGuideClient}

Hierarchy

Client

Implements

IMapGuideClient

Index

Constructors

constructor

Methods

Constructors

constructor

new Client(agentUri: string, kind: ClientKind): Client

Parameters
- agentUri: string
- kind: ClientKind
Returns Client

Methods

createRuntimeMap

createRuntimeMap(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Creates a runtime map from the specified map definition

memberof

Client

Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

createSession

createSession(username: string, password: string): Promise<string>

Creates a new MapGuide session

memberof

Client

Parameters
- username: string
- password: string
Returns Promise<string>

describeRuntimeMap

describeRuntimeMap(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Describes a runtime map

memberof

Client

Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

get

get<T>(url: string): Promise<T>

Performs a generic GET request at the specified URL

template

T The type of the object you are expecting to receive

memberof

Client

Type parameters
- T
Parameters
- url: string
  
  The url to make the request to
Returns Promise<T>

A promise for the value of the requested type

getResource

getResource<T>(resourceId: ResourceIdentifier, args?: any): Promise<T>

Retrieves the requested resource

template

T

memberof

Client

Type parameters
- T: ResourceBase
Parameters
- resourceId: ResourceIdentifier
- Optional args: any
Returns Promise<T>

getServerSessionTimeout

getServerSessionTimeout(session: string): Promise<number>

Gets the server session timeout for the given session id

memberof

Client

Parameters
- session: string
Returns Promise<number>

getText

getText(url: string): Promise<string>

Parameters
- url: string
Returns Promise<string>

getTileTemplateUrl

getTileTemplateUrl(resourceId: string, groupName: string, xPlaceholder: string, yPlaceholder: string, zPlaceholder: string): string

Gets the tile template URL used by the viewer to send tile requests

memberof

Client

Parameters
- resourceId: string
- groupName: string
- xPlaceholder: string
- yPlaceholder: string
- zPlaceholder: string
Returns string

post

post<T>(url: string, data: any): Promise<T>

Performs a generic POST request at the specified URL

template

T The type of the object you are expecting to receive

memberof

Client

Type parameters
- T
Parameters
- url: string
  
  The url to make the request to
- data: any
  
  The POST form data
Returns Promise<T>

A promise for the value of the requested type

queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Performs a map selection query on the current map

memberof

Client

Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

queryMapFeatures_v4

queryMapFeatures_v4(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Performs a map selection query on the current map. Only applicable for use in MapGuide Open Source 4.0 and higher

memberof

Client

Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

Generated using TypeDoc