Class OnmsServer

Hierarchy

OnmsServer

Index

Constructors

constructor

Properties

Accessors

host

Methods

Constructors

constructor

new OnmsServer(name?: string, url?: string, auth?: OnmsAuthConfig | string, password?: string): OnmsServer

- Defined in api/OnmsServer.ts:28
Construct a new OnmsServer object representing a remote server.

constructor

Parameters
- Optional name: string
- Optional url: string
- Optional auth: OnmsAuthConfig | string
- Optional password: string
Returns OnmsServer

Properties

auth

auth: OnmsAuthConfig

The authorization configuration associated with the server

id

id: string

A unique identifier for this server

metadata

metadata: ServerMetadata

The capabilities of the server

name

name: string

A name associated with this server (undefined is allowed)

url

url: string

The base URL to the server

Accessors

host

get host(): any

- Defined in api/OnmsServer.ts:76
Return the hostname portion of the URL associated with this server.

Returns any

Methods

clone

clone(): OnmsServer

- Defined in api/OnmsServer.ts:66
Create a new OnmsServer object from this existing one.

Returns OnmsServer

resolveURL

resolveURL(forFragment?: string): any

- Defined in api/OnmsServer.ts:50
Given a relative URL fragment, construct a URL for that fragment on the server.

Parameters
- Optional forFragment: string
  
  the URL fragment to append to the server URL
Returns any

a complete URL

toString

toString(): string

- Defined in api/OnmsServer.ts:84
a pretty string representation of this server

Returns string

Generated using TypeDoc