ServerInfo | References | ArcGIS Maps SDK for JavaScript

import ServerInfo from "@arcgis/core/identity/ServerInfo.js";

Inheritance:: ServerInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

This class contains information about an ArcGIS Server and its token endpoint.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ServerInfoProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`adminTokenServiceUrl`	`string \| null \| undefined`
`currentVersion`	`number \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`hasPortal`	`boolean \| null \| undefined`
`hasServer`	`boolean \| null \| undefined`
`server`	`string \| null \| undefined`
`shortLivedTokenValidity`	`number \| null \| undefined`
`tokenServiceUrl`	`string \| null \| undefined`
`webTierAuth`	`boolean \| null \| undefined`

adminTokenServiceUrl

Property

Type: string | null | undefined

The token service URL used to generate tokens for ArcGIS Server Admin resources.

currentVersion

Property

Type: number | null | undefined

Version of the ArcGIS Server or Portal deployed on the server.

Note: This value will be 8.4 for ArcGIS Online.

See also

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

hasPortal

Property

Type: boolean | null | undefined

Indicates whether the server is a Portal instance.

See also

hasServer

Property

Type: boolean | null | undefined

Indicates whether the server is an ArcGIS Server instance.

See also

IdentityManagerBase.registerServers()

Example

// Register the serverInfo with the IdentityManager
esriId.registerServers([{
  hasServer: true,
  server: "https://<server domain>/arcgis",
  tokenServiceUrl: "https://<server domain>/arcgis/tokens/"
}]);

server

Property

Type: string | null | undefined

The server URL. This value includes the path to the web adapter for Servers (e.g. https://sampleserver6.arcgisonline.com/arcgis) and Portals (e.g. https://portal.esri.com/gis).

shortLivedTokenValidity

Property

Type: number | null | undefined

Validity of short-lived token in minutes.

tokenServiceUrl

Property

Type: string | null | undefined

The token service URL used to generate tokens for the secured resources on the server.

webTierAuth

Property

Type: boolean | null | undefined

Indicates whether the server is configured to work with web tier authentication.

See also

ArcGIS Server authentication tier

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.