ServerInfo

AMD: require(["esri/identity/ServerInfo"], (ServerInfo) => { /* code goes here */ });
ESM: import ServerInfo from "@arcgis/core/identity/ServerInfo.js";
Class: esri/identity/ServerInfo
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

ServerInfo

Constructor
new ServerInfo(properties)
Parameter
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

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

ServerInfo
Number

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

ServerInfo
String

The name of the class.

Accessor
Boolean

Indicates whether the server is a Portal instance.

ServerInfo
Boolean

Indicates whether the server is an ArcGIS Server instance.

ServerInfo
String

The server URL.

ServerInfo
Number

Validity of short-lived token in minutes.

ServerInfo
String

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

ServerInfo
Boolean

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

ServerInfo

Property Details

adminTokenServiceUrl

Property
adminTokenServiceUrl String

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

currentVersion

Property
currentVersion Number

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

Note: This value will be 8.4 for ArcGIS Online.

See also

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

hasPortal

Property
hasPortal Boolean

Indicates whether the server is a Portal instance.

hasServer

Property
hasServer Boolean

Indicates whether the server is an ArcGIS Server instance.

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

server

Property
server String

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
shortLivedTokenValidity Number

Validity of short-lived token in minutes.

tokenServiceUrl

Property
tokenServiceUrl String

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

webTierAuth

Property
webTierAuth Boolean

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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

ServerInfo
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

ServerInfo

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON

Method
fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Method
toJSON(){Object}

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.