This class contains information about an ArcGIS Server and its token endpoint.
- See also
Constructors
-
new ServerInfo(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The token service URL used to generate tokens for ArcGIS Server Admin resources. more details | ServerInfo | |
Number | Version of the ArcGIS Server or Portal deployed on the server. more details | ServerInfo | |
String | The name of the class. more details | Accessor | |
Boolean | Indicates whether the server is a Portal instance. more details | ServerInfo | |
Boolean | Indicates whether the server is an ArcGIS Server instance. more details | ServerInfo | |
String | The server URL. more details | ServerInfo | |
Number | Validity of short-lived token in minutes. more details | ServerInfo | |
String | The token service URL used to generate tokens for the secured resources on the server. more details | ServerInfo | |
Boolean | Indicates whether the server is configured to work with web tier authentication. more details | ServerInfo |
Property Details
-
adminTokenServiceUrl String
-
The token service URL used to generate tokens for ArcGIS Server Admin resources.
-
currentVersion Number
-
Version of the ArcGIS Server or Portal deployed on the server.
Note: This value will be
8.4
for ArcGIS Online.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
hasPortal Boolean
-
hasServer Boolean
-
Indicates whether the server is an ArcGIS Server instance.
- See also
Example// Register the serverInfo with the IdentityManager esriId.registerServers([{ hasServer: true, server: "https://<server domain>/arcgis", tokenServiceUrl: "https://<server domain>/arcgis/tokens/" }]);
-
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 Number
-
Validity of short-lived token in minutes.
-
tokenServiceUrl String
-
The token service URL used to generate tokens for the secured resources on the server.
-
webTierAuth Boolean
-
Indicates whether the server is configured to work with web tier authentication.
- See also
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ServerInfo | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | ServerInfo |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.