Credential

Property Overview

Property Details

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

expires Number

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

See also:

• Date - MDN

isAdmin Boolean

Indicates that this credential was created to access the ArcGIS REST Admin service.

oAuthState Object

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

server String

The server url.

ssl Boolean

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

token String

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

userId String

User associated with the Credential object.

Method Overview

Method Details

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(type, event){Boolean}

Since: ArcGIS API for JavaScript 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(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.

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()

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.

Event Overview

Event Details

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

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