Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

The MapGuide HTTP client

export
implements

{IMapGuideClient}

Hierarchy

  • Client

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

createRuntimeMap

createRuntimeMap_v4

  • Creates a runtime map from the specified map definition. Issues a v4.0.0 request

    memberof

    Client

    since

    0.14.8

    Parameters

    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_v4

get

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

  • Performs a generic GET request at the specified URL

    memberof

    Client

    Type parameters

    • T

      The type of the object you are expecting to receive

    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: string, args?: any): 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>

getSiteVersion

getText

  • getText(url: string): Promise<string>

  • Parameters

    • url: string

    Returns Promise<string>

getTileTemplateUrl

  • getTileTemplateUrl(resourceId: string, groupName: string, xPlaceholder: string, yPlaceholder: string, zPlaceholder: string, isXYZ: boolean): string

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

    memberof

    Client

    since

    0.14.8 added isXYZ parameter

    Parameters

    • resourceId: string
    • groupName: string
    • xPlaceholder: string
    • yPlaceholder: string
    • zPlaceholder: string
    • isXYZ: boolean

    Returns string

post

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

  • Performs a generic POST request at the specified URL

    memberof

    Client

    Type parameters

    • T

      The type of the object you are expecting to receive

    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_v4

Generated using TypeDoc