Credential | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Represents a credential object used to access a secure ArcGIS resource.

See also

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Number\|null	Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC.	Credential
Boolean	Indicates that this credential was created to access the ArcGIS Server Administrator REST API.	Credential
Object	The Identity Manager's setOAuthRedirectionHandler returns an object that contains a `state` property.	Credential
String	The server url.	Credential
Boolean	Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol.	Credential
String	Token generated by the token service using the specified userId and password.	Credential
String	User associated with the Credential object.	Credential

Property Details

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.

expires Property expires Number |null

Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC.

See also

Date - MDN

isAdmin Property isAdmin Boolean

Indicates that this credential was created to access the ArcGIS Server Administrator REST API.

oAuthState Property oAuthState Object

The Identity Manager's setOAuthRedirectionHandler returns an object that contains a state property. This information is returned for this property.

server Property server String

The server url.

ssl Property ssl Boolean

Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol.

token Property token String

Token generated by the token service using the specified userId and password.

userId Property userId String

User associated with the Credential object.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
	Destroys the credential.	Credential
Boolean	Emits an event on the instance.	Credential
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Credential
Boolean	Returns true if a named group of handles exist.	Accessor
Object	Registers an event handler on the instance.	Credential
	Generates a new token and updates the Credential's token property with the newly acquired token.	Credential
	Removes a group of handles owned by the object.	Accessor

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.

destroy Method destroy()

Destroys the credential. When the credential is destroyed, you should remove any map layers that are using this credential. Any tokens generated via OAuth will automatically be revoked.

See also

IdentityManager.destroyCredentials

emit Method emit(type, event){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.5 Credential since 4.0, emit added at 4.5.

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener Method hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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");
}

on Method on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

refreshToken Method refreshToken()

Generates a new token and updates the Credential's token property with the newly acquired token. Tokens are typically kept valid using a timer that automatically triggers a refresh before the token expires. Use this method in cases where the timer has been delayed or stopped.

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");

Event Overview

Name	Type	Summary	Class
		Fires when a credential object is destroyed.	Credential
		Fires when the token associated with the credential is updated or changed.	Credential

Event Details

destroy Event destroy

Fires when a credential object is destroyed. After the credential is destroyed, remove any map layers that use this credential. Any tokens generated via OAuth will automatically be revoked.

See also

IdentityManager.destroyCredentials

token-change Event token-change

Fires when the token associated with the credential is updated or changed.