PublishingInfo

AMD: require(["esri/layers/support/PublishingInfo"], (PublishingInfo) => { /* code goes here */ });
ESM: import PublishingInfo from "@arcgis/core/layers/support/PublishingInfo";
Class: esri/layers/support/PublishingInfo
Inheritance: PublishingInfo Accessor
Since: ArcGIS API for JavaScript 4.25

FeatureLayer's publishing status while the layer is being published to the portal. This stops when the status has been determined or when the layer is destroyed. This is valid only for ArcGIS Online hosted feature services. The layer is automatically refreshed when the layer is done publishing.

See also

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 name of the class.

more details
Accessor
String

Layer's publishing status while the layer is being published to the portal.

more details
PublishingInfo
Boolean

Indicates if the layer's status is still being updated.

more details
PublishingInfo

Property Details

declaredClass Stringreadonly inherited

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

status Stringreadonly

Layer's publishing status while the layer is being published to the portal. The layer is automatically refreshed when the status goes from publishing to unavailable or published.

Possible Values

Value Description
unknown The layer's publishing status is unknown at this point.
unavailable The layer doesn't provide publishing information.
publishing The publishing is in progress.
published The layer is published and ready for consumption.

Possible Values:"unknown"|"unavailable"|"publishing"|"published"

Default Value:"unknown"
updating Booleanreadonly

Indicates if the layer's status is still being updated.

Default Value:false

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.

more details
Accessor
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

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited

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

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

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