Packages
Version 14.22.0@esri/hub-common
Common TypeScript types and utility functions for @esri/hub.js.
npm install:
npm install @esri/hub-common @esri/arcgis-rest-auth@^2.14.0 || 3 @esri/arcgis-rest-feature-layer@^3.2.0 @esri/arcgis-rest-portal@^2.18.0 || 3 @esri/arcgis-rest-request@^2.14.0 || 3 @esri/arcgis-rest-service-admin@^3.6.0 @esri/arcgis-rest-types@^2.15.0 || 3
Module Import:
import {
_prepareUploadRequests,
_waitForItemReady,
addAssociation,
addContextToSlug,
addDays,
addDomain,
addGroupMembers,
addPermissionPolicy,
addSiteDomains,
addSolutionResourceUrlToAssets,
addUsersToGroup,
aggregateMetrics,
aggregateValues,
apiRequest,
applyCatalogStructureMigration,
applyDefaultCollectionMigration,
applyInitiativeMigrations,
applyPermissionMigration,
applyPropertiesToItems,
applyVersion,
arrayToObject,
asyncForEach,
authenticateRequest,
autoAddUsers,
base64ToUnicode,
batch,
bBoxToExtent,
bboxToString,
buildDraft,
buildExistingExportsPortalQuery,
cacheBustUrl,
camelize,
canEditEvent,
canEditItem,
canEditSite,
canEditSiteContent,
capitalize,
checkAll,
checkAny,
checkAssertion,
checkAssertions,
checkAuthentication,
checkAvailability,
checkEdit,
checkEntityFeature,
checkEntityPolicy,
checkEnvironment,
checkForStaleVersion,
checkLicense,
checkNot,
checkOwner,
checkParents,
checkPermission,
checkPrivileges,
checkServiceStatus,
chunkArray,
clearMemoizedCache,
clearSession,
cloneObject,
combineQueries,
completeOAuth2,
compose,
composeContent,
computeLinks,
computeLinks,
computeLinks,
computeProps,
configureBaseResources,
constructSlug,
convertCatalogToLegacyFormat,
convertFeaturesToLegacyCapabilities,
convertGroupToHubGroup,
convertHubGroupToGroup,
convertItemToSite,
convertModelToPage,
convertModelToSite,
convertSolutionTemplateResourcesToAssets,
convertToWellKnownLocale,
convertUrlsToAnchorTags,
createExtent,
createHubGroup,
createId,
createItemFromFile,
createItemFromUrl,
createItemFromUrlOrFile,
createModel,
createOperationPipeline,
createSite,
createVersion,
dasherize,
datasetToContent,
datasetToItem,
deepContains,
deepFind,
deepFindById,
deepGetPropValues,
deepSet,
deepStringReplace,
deleteGroupThumbnail,
deleteItemThumbnail,
deleteProp,
deleteSite,
deleteVersion,
deriveLocationFromItemExtent,
detectDataTypeFromExtension,
detectDataTypeFromHeader,
doesItemExistWithTitle,
domainExists,
domainExistsPortal,
dotifyString,
editorToContent,
editorToProject,
emailOrgUsers,
enrichContentSearchResult,
enrichEntity,
enrichGroupSearchResult,
enrichPageSearchResult,
enrichSiteSearchResult,
enrichUserSearchResult,
ensureProp,
ensureUniqueDomainName,
ensureUniqueString,
expandQuery,
explainDatePredicate,
explainFilter,
explainMatchOptionPredicate,
explainPredicate,
explainPropPredicate,
explainQueryResult,
extend,
extentToBBox,
extentToPolygon,
failSafe,
failSafeUpdate,
fetchAcceptedProjects,
fetchAllPages,
fetchAndUploadResource,
fetchAndUploadThumbnail,
fetchCatalog,
fetchContent,
fetchGroupEnrichments,
fetchHubContent,
fetchHubEntity,
fetchHubGroup,
fetchHubTranslation,
fetchImageAsBlob,
fetchMaxNumUserGroupsLimit,
fetchModelFromItem,
fetchModelResources,
fetchOrg,
fetchOrgLimits,
fetchPendingProjects,
fetchSiteModel,
fetchUserEnrichments,
filterBy,
findBy,
findItemsBySlug,
flattenArray,
formatFilterBlock,
formatOgcAggregationsResponse,
formatOgcItemsResponse,
formatPredicate,
generateRandomString,
getAcceptedProjectsQuery,
getAssociatedInitiativesQuery,
getBasePropertyMap,
getCampaignUrl,
getCardModelUrlFromEntity,
getCardModelUrlFromResult,
getCategory,
getCategoryItems,
getChannelAccess,
getChannelGroupIds,
getChannelOrgIds,
getChannelUsersQuery,
getContentEditUrl,
getContentIdentifier,
getContentTypeIcon,
getContentTypeLabel,
getCulture,
getDiscussionsApiDefinition,
getDomainsForSite,
getEditorConfig,
getEntityEditorSchemas,
getEntityMetrics,
getEnvironmentFromPortalUrl,
getExtentCenter,
getExtentObject,
getFamily,
getFamilyTypes,
getFeaturedContentCatalogs,
getFeaturedImageUrl,
getFeatureLayerItem,
getFeatureServiceItem,
getFeatureServiceTitle,
getFileName,
getFilterQueryParam,
getGroupHomeUrl,
getGroupPredicate,
getGroupThumbnailUrl,
getHubApiFromPortalUrl,
getHubApiUrl,
getHubApiUrlFromPortal,
getHubLocaleAssetUrl,
getHubProduct,
getHubUrlFromPortal,
getIncludeListFromItemType,
getInputFeatureServiceModel,
getItemApiUrl,
getItemAssets,
getItemBySlug,
getItemDataUrl,
getItemHomeUrl,
getItemHubId,
getItemIdentifier,
getItemLayerId,
getItemOrgId,
getItemThumbnailUrl,
getLayerIdFromUrl,
getLocationExtent,
getLocationOptions,
getModel,
getModelBySlug,
getModelFromOptions,
getNextOgcCallback,
getOgcAggregationQueryParams,
getOrgDefaultTheme,
getOrgExtentAsBBox,
getPendingProjectsQuery,
getPermissionPolicy,
getPolicyResponseCode,
getPortalApiUrl,
getPortalBaseFromOrgUrl,
getPortalUrl,
getPortalUrls,
getProp,
getPropertyMap,
getProps,
getProxyUrl,
getPublisherInfo,
getQQueryParam,
getQueryString,
getRelativeWorkspaceUrl,
getResultSiteRelativeLink,
getScopeGroupPredicate,
getServiceTypeFromUrl,
getSession,
getSharableGroupsComboBoxItems,
getShortenedCategories,
getSiteById,
getSourceFeatureServiceModelFromFieldworker,
getStakeholderModel,
getStructuredLicense,
getSubscriptionType,
getSurveyModels,
getTagItems,
getTargetEntityFromAssociationType,
getTopLevelPredicate,
getTypeByIdsQuery,
getTypeCategories,
getTypeFromAssociationType,
getTypeFromEntity,
getTypes,
getUniqueDomainName,
getUniqueDomainNamePortal,
getUniqueItemTitle,
getUniqueSlug,
getUserHomeUrl,
getUserThumbnailUrl,
getVersion,
getWellKnownCatalog,
getWellknownCollection,
getWellknownCollections,
getWithDefault,
hasBasePriv,
hasServiceCapability,
hubApiRequest,
hubSearch,
includes,
incrementString,
initiativeResultToCardModel,
initiativeToCardModel,
interpolate,
interpolateItemId,
inviteUsers,
isBBox,
isDiscussable,
isDomainForLegacySite,
isDomainUsedElsewhere,
isDownloadable,
isFeatureLayer,
isFeatureService,
isFeatureService,
isFieldworkerView,
isGuid,
isHostedFeatureServiceEntity,
isHostedFeatureServiceItem,
isHubService,
isMapOrFeatureServerUrl,
isNil,
isOrgChannel,
isPermission,
isPrivateChannel,
isPublicChannel,
isSafeRedirectUrl,
isService,
isServicesDirectoryDisabled,
isSiteType,
isSlug,
isUpdateGroup,
isUrl,
isValidDomain,
isValidEntityType,
isValidExtent,
isWellKnownTypeFilter,
itemToContent,
itemToSearchResult,
keywordSlugToUriSlug,
last,
listAssociations,
lookupDomain,
mapBy,
mapEntityToStore,
mapStoreToEntity,
maybeAdd,
maybePush,
memoize,
mergeObjects,
migrateLegacyCapabilitiesToFeatures,
migrateToCollectionKey,
modelToHubEditableContent,
normalizeItemType,
normalizeSolutionTemplateItem,
objectToArray,
objectToJsonBlob,
ogcApiRequest,
ogcItemToSearchResult,
orgExtent,
parseDatasetId,
parseInclude,
pickProps,
pingFeatureService,
pingUrl,
portalSearchGroupMembers,
portalSearchItems,
portalSearchItemsAsItems,
processEntityFeatures,
processRevertableTasks,
projectResultToCardModel,
projectToCardModel,
propifyString,
reflectCollectionsToSearchCategories,
removeAssociation,
removeContextFromSlug,
removeDomain,
removeDomainByHostname,
removeDomainsBySiteId,
removeEmptyProps,
removePermissionPolicy,
removeResource,
replaceItemId,
request,
resolveDynamicValue,
resolveDynamicValues,
resolveItemQueryValues,
resolveMetric,
resolvePortalValues,
resolveReferences,
resolveServiceQueryValues,
runRevertableTask,
saveSession,
searchChannels,
searchOgcAggregations,
searchOgcItems,
searchVersions,
serializeModel,
serializeQueryForPortal,
serializeSpatialReference,
setContentType,
setDiscussableKeyword,
setGroupThumbnail,
setItemThumbnail,
setProp,
setSlugKeyword,
setStatusKeyword,
shareItemToGroups,
shouldHaveDataUrl,
slugify,
stringToBlob,
stripProtocol,
subsetSchema,
titleize,
toggleServiceCapability,
unicodeToBase64,
unique,
uniqueBy,
unprotectModel,
unshareItemFromGroups,
updateDomain,
updateHubEntity,
updateModel,
updateSite,
updateVersion,
updateVersionMetadata,
upgradeCatalogSchema,
upgradeProtocol,
upgradeSiteSchema,
uploadImageResource,
uploadResourcesFromUrl,
upsertModelResources,
upsertResource,
uriSlugToKeywordSlug,
userResultToCardModel,
validateUrl,
without,
withoutByProp,
ArcGISContext,
ArcGISContextManager,
Catalog,
Collection,
EntityEditor,
Hub,
HubContent,
HubDiscussion,
HubError,
HubGroup,
HubInitiative,
HubItemEntity,
HubPage,
HubProject,
HubSite,
Logger,
OperationError,
OperationStack,
RemoteServerError,
RemoteServerError,
} from "@esri/hub-common";
- _prepareUploadRequests
- _waitForItemReady
- addAssociation
- addContextToSlug
- addDays
- addDomain
- addGroupMembers
- addPermissionPolicy
- addSiteDomains
- addSolutionResourceUrlToAssets
- addUsersToGroup
- aggregateMetrics
- aggregateValues
- apiRequest
- applyCatalogStructureMigration
- applyDefaultCollectionMigration
- applyInitiativeMigrations
- applyPermissionMigration
- applyPropertiesToItems
- applyVersion
- arrayToObject
- asyncForEach
- authenticateRequest
- autoAddUsers
- base64ToUnicode
- batch
- bBoxToExtent
- bboxToString
- buildDraft
- buildExistingExportsPortalQuery
- cacheBustUrl
- camelize
- canEditEvent
- canEditItem
- canEditSite
- canEditSiteContent
- capitalize
- checkAll
- checkAny
- checkAssertion
- checkAssertions
- checkAuthentication
- checkAvailability
- checkEdit
- checkEntityFeature
- checkEntityPolicy
- checkEnvironment
- checkForStaleVersion
- checkLicense
- checkNot
- checkOwner
- checkParents
- checkPermission
- checkPrivileges
- checkServiceStatus
- chunkArray
- clearMemoizedCache
- clearSession
- cloneObject
- combineQueries
- completeOAuth2
- compose
- composeContent
- computeLinks
- computeLinks
- computeLinks
- computeProps
- configureBaseResources
- constructSlug
- convertCatalogToLegacyFormat
- convertFeaturesToLegacyCapabilities
- convertGroupToHubGroup
- convertHubGroupToGroup
- convertItemToSite
- convertModelToPage
- convertModelToSite
- convertSolutionTemplateResourcesToAssets
- convertToWellKnownLocale
- convertUrlsToAnchorTags
- createExtent
- createHubGroup
- createId
- createItemFromFile
- createItemFromUrl
- createItemFromUrlOrFile
- createModel
- createOperationPipeline
- createSite
- createVersion
- dasherize
- datasetToContent
- datasetToItem
- deepContains
- deepFind
- deepFindById
- deepGetPropValues
- deepSet
- deepStringReplace
- deleteGroupThumbnail
- deleteItemThumbnail
- deleteProp
- deleteSite
- deleteVersion
- deriveLocationFromItemExtent
- detectDataTypeFromExtension
- detectDataTypeFromHeader
- doesItemExistWithTitle
- domainExists
- domainExistsPortal
- dotifyString
- editorToContent
- editorToProject
- emailOrgUsers
- enrichContentSearchResult
- enrichEntity
- enrichGroupSearchResult
- enrichPageSearchResult
- enrichSiteSearchResult
- enrichUserSearchResult
- ensureProp
- ensureUniqueDomainName
- ensureUniqueString
- expandQuery
- explainDatePredicate
- explainFilter
- explainMatchOptionPredicate
- explainPredicate
- explainPropPredicate
- explainQueryResult
- extend
- extentToBBox
- extentToPolygon
- failSafe
- failSafeUpdate
- fetchAcceptedProjects
- fetchAllPages
- fetchAndUploadResource
- fetchAndUploadThumbnail
- fetchCatalog
- fetchContent
- fetchGroupEnrichments
- fetchHubContent
- fetchHubEntity
- fetchHubGroup
- fetchHubTranslation
- fetchImageAsBlob
- fetchMaxNumUserGroupsLimit
- fetchModelFromItem
- fetchModelResources
- fetchOrg
- fetchOrgLimits
- fetchPendingProjects
- fetchSiteModel
- fetchUserEnrichments
- filterBy
- findBy
- findItemsBySlug
- flattenArray
- formatFilterBlock
- formatOgcAggregationsResponse
- formatOgcItemsResponse
- formatPredicate
- generateRandomString
- getAcceptedProjectsQuery
- getAssociatedInitiativesQuery
- getBasePropertyMap
- getCampaignUrl
- getCardModelUrlFromEntity
- getCardModelUrlFromResult
- getCategory
- getCategoryItems
- getChannelAccess
- getChannelGroupIds
- getChannelOrgIds
- getChannelUsersQuery
- getContentEditUrl
- getContentIdentifier
- getContentTypeIcon
- getContentTypeLabel
- getCulture
- getDiscussionsApiDefinition
- getDomainsForSite
- getEditorConfig
- getEntityEditorSchemas
- getEntityMetrics
- getEnvironmentFromPortalUrl
- getExtentCenter
- getExtentObject
- getFamily
- getFamilyTypes
- getFeaturedContentCatalogs
- getFeaturedImageUrl
- getFeatureLayerItem
- getFeatureServiceItem
- getFeatureServiceTitle
- getFileName
- getFilterQueryParam
- getGroupHomeUrl
- getGroupPredicate
- getGroupThumbnailUrl
- getHubApiFromPortalUrl
- getHubApiUrl
- getHubApiUrlFromPortal
- getHubLocaleAssetUrl
- getHubProduct
- getHubUrlFromPortal
- getIncludeListFromItemType
- getInputFeatureServiceModel
- getItemApiUrl
- getItemAssets
- getItemBySlug
- getItemDataUrl
- getItemHomeUrl
- getItemHubId
- getItemIdentifier
- getItemLayerId
- getItemOrgId
- getItemThumbnailUrl
- getLayerIdFromUrl
- getLocationExtent
- getLocationOptions
- getModel
- getModelBySlug
- getModelFromOptions
- getNextOgcCallback
- getOgcAggregationQueryParams
- getOrgDefaultTheme
- getOrgExtentAsBBox
- getPendingProjectsQuery
- getPermissionPolicy
- getPolicyResponseCode
- getPortalApiUrl
- getPortalBaseFromOrgUrl
- getPortalUrl
- getPortalUrls
- getProp
- getPropertyMap
- getProps
- getProxyUrl
- getPublisherInfo
- getQQueryParam
- getQueryString
- getRelativeWorkspaceUrl
- getResultSiteRelativeLink
- getScopeGroupPredicate
- getServiceTypeFromUrl
- getSession
- getSharableGroupsComboBoxItems
- getShortenedCategories
- getSiteById
- getSourceFeatureServiceModelFromFieldworker
- getStakeholderModel
- getStructuredLicense
- getSubscriptionType
- getSurveyModels
- getTagItems
- getTargetEntityFromAssociationType
- getTopLevelPredicate
- getTypeByIdsQuery
- getTypeCategories
- getTypeFromAssociationType
- getTypeFromEntity
- getTypes
- getUniqueDomainName
- getUniqueDomainNamePortal
- getUniqueItemTitle
- getUniqueSlug
- getUserHomeUrl
- getUserThumbnailUrl
- getVersion
- getWellKnownCatalog
- getWellknownCollection
- getWellknownCollections
- getWithDefault
- hasBasePriv
- hasServiceCapability
- hubApiRequest
- hubSearch
- includes
- incrementString
- initiativeResultToCardModel
- initiativeToCardModel
- interpolate
- interpolateItemId
- inviteUsers
- isBBox
- isDiscussable
- isDomainForLegacySite
- isDomainUsedElsewhere
- isDownloadable
- isFeatureLayer
- isFeatureService
- isFeatureService
- isFieldworkerView
- isGuid
- isHostedFeatureServiceEntity
- isHostedFeatureServiceItem
- isHubService
- isMapOrFeatureServerUrl
- isNil
- isOrgChannel
- isPermission
- isPrivateChannel
- isPublicChannel
- isSafeRedirectUrl
- isService
- isServicesDirectoryDisabled
- isSiteType
- isSlug
- isUpdateGroup
- isUrl
- isValidDomain
- isValidEntityType
- isValidExtent
- isWellKnownTypeFilter
- itemToContent
- itemToSearchResult
- keywordSlugToUriSlug
- last
- listAssociations
- lookupDomain
- mapBy
- mapEntityToStore
- mapStoreToEntity
- maybeAdd
- maybePush
- memoize
- mergeObjects
- migrateLegacyCapabilitiesToFeatures
- migrateToCollectionKey
- modelToHubEditableContent
- normalizeItemType
- normalizeSolutionTemplateItem
- objectToArray
- objectToJsonBlob
- ogcApiRequest
- ogcItemToSearchResult
- orgExtent
- parseDatasetId
- parseInclude
- pickProps
- pingFeatureService
- pingUrl
- portalSearchGroupMembers
- portalSearchItems
- portalSearchItemsAsItems
- processEntityFeatures
- processRevertableTasks
- projectResultToCardModel
- projectToCardModel
- propifyString
- reflectCollectionsToSearchCategories
- removeAssociation
- removeContextFromSlug
- removeDomain
- removeDomainByHostname
- removeDomainsBySiteId
- removeEmptyProps
- removePermissionPolicy
- removeResource
- replaceItemId
- request
- resolveDynamicValue
- resolveDynamicValues
- resolveItemQueryValues
- resolveMetric
- resolvePortalValues
- resolveReferences
- resolveServiceQueryValues
- runRevertableTask
- saveSession
- searchChannels
- searchOgcAggregations
- searchOgcItems
- searchVersions
- serializeModel
- serializeQueryForPortal
- serializeSpatialReference
- setContentType
- setDiscussableKeyword
- setGroupThumbnail
- setItemThumbnail
- setProp
- setSlugKeyword
- setStatusKeyword
- shareItemToGroups
- shouldHaveDataUrl
- slugify
- stringToBlob
- stripProtocol
- subsetSchema
- titleize
- toggleServiceCapability
- unicodeToBase64
- unique
- uniqueBy
- unprotectModel
- unshareItemFromGroups
- updateDomain
- updateHubEntity
- updateModel
- updateSite
- updateVersion
- updateVersionMetadata
- upgradeCatalogSchema
- upgradeProtocol
- upgradeSiteSchema
- uploadImageResource
- uploadResourcesFromUrl
- upsertModelResources
- upsertResource
- uriSlugToKeywordSlug
- userResultToCardModel
- validateUrl
- without
- withoutByProp
- ArcGISContext
- ArcGISContextManager
- Catalog
- Collection
- EntityEditor
- Hub
- HubContent
- HubDiscussion
- HubError
- HubGroup
- HubInitiative
- HubItemEntity
- HubPage
- HubProject
- HubSite
- Logger
- OperationError
- OperationStack
- RemoteServerError
- RemoteServerError
- addCreateItemTypes
- categories
- collections
- DEFAULT_DISCUSSION
- DEFAULT_GROUP
- DEFAULT_INITIATIVE
- DEFAULT_PAGE
- DEFAULT_PROJECT
- DEFAULT_SITE
- DEFAULT_THEME
- ENTITY_ACCESS_SCHEMA
- ENTITY_CATEGORIES_SCHEMA
- ENTITY_FEATURED_CONTENT_SCHEMA
- ENTITY_IMAGE_SCHEMA
- ENTITY_IS_DISCUSSABLE_SCHEMA
- ENTITY_LOCATION_SCHEMA
- ENTITY_NAME_SCHEMA
- ENTITY_SUMMARY_SCHEMA
- ENTITY_TAGS_SCHEMA
- ENTITY_TIMELINE_SCHEMA
- EntityResourceMap
- GLOBAL_EXTENT
- HUB_CDN_URLMAP
- InitiativeDefaultFeatures
- PORTAL_EXPORT_TYPES
- ProjectDefaultFeatures
- SEARCH_APIS
- SiteDefaultFeatures
- WellKnownItemPredicates
- CANNOT_DISCUSS
- capabilityToFeatureMap
- ContentDefaultFeatures
- ContentEditorTypes
- ContentSchema
- DEFAULT_DISCUSSION_MODEL
- DEFAULT_GROUP_MODEL
- DEFAULT_INITIATIVE_MODEL
- DEFAULT_PAGE_MODEL
- DEFAULT_PROJECT_MODEL
- DEFAULT_SITE_MODEL
- DiscussionEditorTypes
- DiscussionSchema
- ENTERPRISE_PAGE_ITEM_TYPE
- ENTERPRISE_SITE_ITEM_TYPE
- GroupEditorTypes
- GroupSchema
- HUB_DISCUSSION_ITEM_TYPE
- HUB_ENTITY_TYPES
- HUB_GROUP_TYPE
- HUB_INITIATIVE_ITEM_TYPE
- HUB_LOCALES
- HUB_PAGE_ITEM_TYPE
- HUB_PROJECT_ITEM_TYPE
- HUB_SITE_ITEM_TYPE
- HUB_SITE_ITEM_TYPE
- HubItemEntitySchema
- HubPermissionsPolicies
- INITIATIVE_SCHEMA_VERSION
- InitiativeEditorTypes
- InitiativeSchema
- itemPropsNotInTemplates
- PAGE_TYPE_KEYWORD
- PageDefaultFeatures
- PageEditorTypes
- PageSchema
- PageVersionIncludeList
- PlatformPermissionPolicies
- PlatformPermissions
- PREDICATE_COPY_PROPS
- PREDICATE_DATE_PROPS
- PREDICATE_NON_MATCH_OPTIONS_PROPS
- ProjectEditorTypes
- ProjectSchema
- REQUIRED_PRIVS
- SITE_SCHEMA_VERSION
- SiteEditorTypes
- SitePermissions
- SiteSchema
- SiteVersionIncludeList
- STANDARD_LICENSES
- validEditorTypes
- VERSION_RESOURCE_NAME
- VERSION_RESOURCE_PROPERTIES
- WGS84_WKID
- AclCategory
- AclSubCategory
- ChannelFilter
- ChannelRelation
- ChannelSort
- CommonSort
- DatePrecision
- DiscussionSettingType
- DiscussionSource
- DiscussionType
- FileExtension
- ItemType
- Level
- PostReaction
- PostRelation
- PostSort
- PostStatus
- PostType
- PROJECT_STATUSES
- PublisherSource
- ReactionRelation
- Role
- SearchCategories
- ServiceCapabilities
- SharingAccess
- SortOrder
- TIMELINE_STAGE_STATUSES
- UpdateFrequency
- AccessControl
- AccessLevel
- AssertionType
- AssociationType
- BBox
- CardModelTarget
- CollaborationType
- ConfigurableEntity
- ContentEditorType
- CountByValue
- DatasetResource
- DiscussionEditorType
- DynamicAggregation
- DynamicValue
- DynamicValueDefinition
- DynamicValueResult
- DynamicValues
- DynamicValueType
- EditorType
- Enrichments
- EntityOrOptions
- EntityToCardModelFn
- EntityType
- GenericAsyncFunc
- GenericResult
- GeographyProvenance
- GroupEditorType
- GroupEnrichment
- GroupSortField
- HubAvailability
- HubEntity
- HubEntityEditor
- HubEntityType
- HubEnvironment
- HubFamily
- HubLicense
- HubProduct
- HubService
- HubServiceStatus
- IBatch
- IBatchTransform
- IHubContentEditor
- IHubDiscussionEditor
- IHubGroupEditor
- IHubInitiativeEditor
- IHubItemEntityEditor
- IHubLocationType
- IHubPageEditor
- IHubProjectEditor
- IHubSiteEditor
- IItemAndIServerEnrichments
- IItemTemplate
- InitiativeEditorType
- IRevertableTaskResult
- ItemOrServerEnrichment
- LegacyCapability
- LegacySearchCategory
- MatchCondition
- MaybeTranslate
- MembershipAccess
- MemberType
- MetricSource
- NamedApis
- OrgLimitType
- PageEditorType
- Permission
- PermissionCheckFunction
- PipelineFn
- PlatformPrivilege
- PlatformSortOrder
- PolicyResponse
- ProjectEditorType
- ResultToCardModelFn
- SearchableType
- SearchFunction
- ServiceAggregation
- SettableAccessLevel
- SiteEditorType
- SortOption
- SystemStatus
- Translatable
- UserEnrichment
- Visibility
- WellKnownCatalog
- WellKnownCollection
- IAccessResponse
- IActionLink
- IAddGroupMembersResult
- IAddMemberContext
- IAddOrInviteMemberResponse
- IAllowedFileTypes
- IApiDefinition
- IArcGISContext
- IArcGISContextManagerOptions
- IArcGISContextOptions
- IAssociationInfo
- IBadgeConfig
- ICapabilityToFeatureMap
- ICardActionLink
- ICatalogInfo
- ICatalogScope
- IChangeEventDetail
- IChannel
- IChannelAclPermission
- IChannelAclPermissionDefinition
- IChannelAclPermissionUpdateDefinition
- IChannelMetadata
- IChannelNotificationOptOut
- IComposeContentOptions
- IConfigurationSchema
- IConfigurationValues
- IConsolidatedResult
- IContainsOptions
- IContainsResponse
- IConvertToCardModelOpts
- ICreateChannel
- ICreateChannelNotificationOptOutParams
- ICreateChannelParams
- ICreateChannelPermissions
- ICreateChannelPost
- ICreateChannelSettings
- ICreateDiscussionSetting
- ICreateDiscussionSettingParams
- ICreatePost
- ICreatePostParams
- ICreateReaction
- ICreateReactionOptions
- ICreateReplyParams
- ICreateVersionOptions
- IDatasetEnrichments
- IDateRange
- IDeepCatalogInfo
- IDiscussionParams
- IDiscussionSetting
- IDiscussionsMentionMeta
- IDiscussionsRequestOptions
- IDiscussionsUser
- IDomainEntry
- IDraft
- IDynamicItemQueryDefinition
- IDynamicPortalSelfDefinition
- IDynamicServiceQueryDefinition
- IEditorConfig
- IEmail
- IEnrichmentErrorInfo
- IEntityEditorContext
- IEntityInfo
- IEntityPermissionPolicy
- IEntityResource
- IEventModel
- IExpression
- IFeatureFlags
- IFetchChannel
- IFetchChannelNotificationOptOutParams
- IFetchChannelParams
- IFetchContentOptions
- IFetchDiscussionSettingParams
- IFetchPost
- IFetchPostParams
- IFileType
- IFilter
- IFilterExplanation
- IGeometryProperties
- IGetGroupSharingDetailsResults
- IGetSurveyModelsResponse
- IGetWellKnownCatalogOptions
- IGroupAndEnrichments
- IGroupEnrichments
- IGroupMembershipSummary
- IHubAdditionalResource
- IHubAggregation
- IHubCardViewModel
- IHubCatalog
- IHubCollection
- IHubContent
- IHubContentEnrichments
- IHubDiscussion
- IHubEditableContent
- IHubEntityBase
- IHubEntityLinks
- IHubEvent
- IHubExtent
- IHubGeography
- IHubGroup
- IHubImage
- IHubImageOptions
- IHubInitiative
- IHubItemEntity
- IHubLayout
- IHubLocation
- IHubLocationOption
- IHubOptions
- IHubPage
- IHubProject
- IHubRequestOptions
- IHubRequestOptionsPortalSelf
- IHubSearchOptions
- IHubSearchResponse
- IHubSearchResult
- IHubSite
- IHubSiteTheme
- IHubStage
- IHubStageLink
- IHubTeam
- IHubTimeline
- IHubTrustedOrgsRelationship
- IHubTrustedOrgsResponse
- IHubUserRequestOptions
- IInfoConfig
- IInitiativeItem
- IInitiativeModel
- IInitiativeModelTemplate
- IItemAndEnrichments
- IItemEnrichments
- IItemQueryMetricSource
- IItemResource
- IItemResource
- ILegacyCapabilityFeatureFlags
- ILink
- IMatchOptions
- IMatchReason
- IMessage
- IMetadataPaths
- IMetric
- IMetricAttributes
- IMetricFeature
- IModel
- IModelTemplate
- IOgcAggregationsResponse
- IOgcItem
- IOgcItemQueryParams
- IOgcItemsResponse
- IOperation
- IOrgLimit
- IPagedResponse
- IPermissionAccessResponse
- IPermissionPolicy
- IPipeable
- IPlatformSharing
- IPolicyAssertion
- IPolicyCheck
- IPolygonProperties
- IPost
- IPostOptions
- IPredicate
- IPredicateExplanation
- IPropertyMap
- IQuery
- IQueryExplanation
- IQueryExplanationDetails
- IQueryParams
- IReaction
- IReference
- IRelativeDate
- IRemoveChannelActivityParams
- IRemoveChannelActivityResult
- IRemoveChannelNotificationOptOutParams
- IRemoveChannelNotificationOptOutResult
- IRemoveChannelParams
- IRemoveChannelResponse
- IRemoveDiscussionSettingParams
- IRemoveDiscussionSettingResponse
- IRemovePostParams
- IRemovePostResponse
- IRemoveReactionOptions
- IRemoveReactionResponse
- IResolvedMetric
- IRevertableTaskFailed
- IRevertableTaskSuccess
- ISearchChannels
- ISearchChannelsParams
- ISearchPosts
- ISearchPostsParams
- ISearchResponse
- ISearchResponseHash
- ISerializedOperationStack
- IServerEnrichments
- IServiceQuery
- IServiceQueryMetricSource
- IServiceQueryOptions
- ISettings
- ISimpleResult
- ISolutionTemplate
- ISortOption
- IStaticValueDefinition
- IStaticValueMetricSource
- IStructuredLicense
- ITemplateAsset
- IThumbnailOptions
- IUpdateChannel
- IUpdateChannelParams
- IUpdateChannelPermissions
- IUpdateDiscussionSetting
- IUpdateDiscussionSettingParams
- IUpdatePageOptions
- IUpdatePost
- IUpdatePostParams
- IUpdatePostStatus
- IUpdatePostStatusParams
- IUpdateSiteOptions
- IUserAndEnrichments
- IUserEnrichments
- IValidationResult
- IVersion
- IVersionMetadata
- IWellKnownApis
- IWithAssociationBehavior
- IWithAssociations
- IWithAuthor
- IWithBannerImage
- IWithBannerImageStore
- IWithCardBehavior
- IWithCatalog
- IWithCatalogBehavior
- IWithDiscussions
- IWithDiscussionsBehavior
- IWithEditor
- IWithEditorBehavior
- IWithFeaturedImageBehavior
- IWithFiltering
- IWithFollowers
- IWithFollowersBehavior
- IWithLayout
- IWithLayoutStore
- IWithMetrics
- IWithMetricsBehavior
- IWithPermissionBehavior
- IWithPermissions
- IWithSharingBehavior
- IWithSlug
- IWithSorting
- IWithStoreBehavior
- IWithThumbnailBehavior
- IWithTimeQueries
- IWithTimestamps
- IWithVersioningBehavior
- IWithViewSettings
Version 26.0.1
@esri/hub-discussions
Module to interact with ArcGIS Hub Discussions API in Node.js and modern browsers.
npm install:
npm install @esri/hub-discussions @esri/arcgis-rest-auth@^2.14.0 || 3 @esri/arcgis-rest-request@^2.14.0 || 3 @esri/hub-common@^14.0.0
Module Import:
import {
apiRequest,
authenticateRequest,
canCreateChannel,
canCreateReaction,
canDeletePost,
canModifyChannel,
canModifyPost,
canModifyPostStatus,
canPostToChannel,
canReadChannel,
canReadFromChannel,
createChannel,
createChannelNotificationOptOut,
createDiscussionSetting,
createPost,
createReaction,
createReply,
fetchChannel,
fetchChannelNotifcationOptOut,
fetchDiscussionSetting,
fetchPost,
isOrgAdmin,
parseDiscussionURI,
parseMentionedUsers,
reduceByGroupMembership,
removeChannel,
removeChannelActivity,
removeChannelNotificationOptOut,
removeDiscussionSetting,
removePost,
removeReaction,
request,
searchPosts,
updateChannel,
updateDiscussionSetting,
updatePost,
updatePostStatus,
ChannelPermission,
RemoteServerError,
} from "@esri/hub-discussions";
- apiRequest
- authenticateRequest
- canCreateChannel
- canCreateReaction
- canDeletePost
- canModifyChannel
- canModifyPost
- canModifyPostStatus
- canPostToChannel
- canReadChannel
- canReadFromChannel
- createChannel
- createChannelNotificationOptOut
- createDiscussionSetting
- createPost
- createReaction
- createReply
- fetchChannel
- fetchChannelNotifcationOptOut
- fetchDiscussionSetting
- fetchPost
- isOrgAdmin
- parseDiscussionURI
- parseMentionedUsers
- reduceByGroupMembership
- removeChannel
- removeChannelActivity
- removeChannelNotificationOptOut
- removeDiscussionSetting
- removePost
- removeReaction
- request
- searchPosts
- updateChannel
- updateDiscussionSetting
- updatePost
- updatePostStatus
- ChannelPermission
- RemoteServerError
- MENTION_ATTRIBUTE
Version 14.1.0
@esri/hub-downloads
Service for Hub downloads
npm install:
npm install @esri/hub-downloads @esri/arcgis-rest-auth@^3.1.0 @esri/arcgis-rest-feature-layer@^3.1.0 @esri/arcgis-rest-portal@^3.7.0 @esri/arcgis-rest-request@^3.1.0 @esri/hub-common@^14.0.0
Module Import:
import {
pollDownloadMetadata,
requestDatasetExport,
requestDownloadMetadata,
} from "@esri/hub-downloads";
- pollDownloadMetadata
- requestDatasetExport
- requestDownloadMetadata
- DownloadFormats
- DownloadStatus
- DownloadFormat
- DownloadStatuses
- DownloadTarget
- IDatasetExportRequestParams
- IDatasetExportResult
- IDownloadMetadataRequestParams
- IDownloadMetadataResults
- IPollDownloadMetadataRequestParams
- IPoller
Version 14.0.0
@esri/hub-events
Module to interact with ArcGIS Hub Events in Node.js and modern browsers.
npm install:
npm install @esri/hub-events @esri/arcgis-rest-auth@^2.13.0 || 3 @esri/arcgis-rest-feature-layer@^2.13.0 || 3 @esri/arcgis-rest-portal@^2.15.0 || 3 @esri/arcgis-rest-request@^2.13.0 || 3 @esri/arcgis-rest-types@^2.13.0 || 3 @esri/hub-common@^14.0.0
Module Import:
import {
addUsersToEvent,
getEventFeatureServiceUrl,
getEventQueryFromType,
getEventServiceItem,
getEventServiceUrl,
registerForEvent,
searchEvents,
unregisterForEvent,
} from "@esri/hub-events";
- addUsersToEvent
- getEventFeatureServiceUrl
- getEventQueryFromType
- getEventServiceItem
- getEventServiceUrl
- registerForEvent
- searchEvents
- unregisterForEvent
- IEventRegisterOptions
- IEventResourceObject
Version 14.0.0
@esri/hub-search
Module to search for ArcGIS items and format them for display in ArcGIS Hub.
npm install:
npm install @esri/hub-search @esri/arcgis-rest-auth@^2.13.0 || 3 @esri/arcgis-rest-feature-layer@^2.13.0 || 3 @esri/arcgis-rest-portal@^2.6.1 || 3 @esri/arcgis-rest-request@^2.13.0 || 3 @esri/arcgis-rest-types@^2.13.0 || 3 @esri/hub-common@^14.0.0
Module Import:
import {
agoSearch,
flattenCategories,
kMerge,
mergeAggregations,
mergePages,
serialize,
BinaryHeap,
InvalidPaginationInputError,
} from "@esri/hub-search";
- agoSearch
- flattenCategories
- kMerge
- mergeAggregations
- mergePages
- serialize
- BinaryHeap
- InvalidPaginationInputError
- SortDirection
- IAggregation
- IAggregationResult
- IDateRange
- IHubResult
- IHubResults
- ISearchParams
- ISearchRequest
Version 14.0.1
@esri/hub-sites
Module to interact with ArcGIS Hub Sites in Node.js and modern browsers.
npm install:
npm install @esri/hub-sites @esri/arcgis-rest-auth@^2.13.0 || 3 @esri/arcgis-rest-portal@^2.19.0 || 3 @esri/arcgis-rest-request@^2.13.0 || 3 @esri/hub-common@^14.0.0 @esri/hub-initiatives@^14.0.0 @esri/hub-teams@^14.0.0
Module Import:
import {
_getSharingEligibleModels,
applyDraft,
convertCard,
convertLayoutToTemplate,
convertPageToTemplate,
convertRow,
convertSection,
convertSiteToTemplate,
createPage,
createPageModelFromTemplate,
createSite,
createSiteModelFromTemplate,
deleteDraft,
ensureOptionalGroupsTemplating,
ensurePageHasSiteEntry,
ensureRequiredPageProperties,
ensureRequiredSiteProperties,
extractAssets,
fetchAndApplyDraft,
fetchDraft,
getCardDependencies,
getDataForSiteItem,
getDomain,
getDomains,
getDraftDate,
getLayoutDependencies,
getMembers,
getPageDependencies,
getPageEditUrl,
getPageItemType,
getPortalSiteHostname,
getPortalSiteUrl,
getRowDependencies,
getSectionDependencies,
getSiteDependencies,
getSiteEditUrl,
getSiteItemType,
hasUnpublishedChanges,
interpolateSite,
isPage,
isSite,
linkSiteAndPage,
markPublished,
markUnpublished,
removePage,
removeSite,
removeSiteFromPage,
removeUnusedResources,
saveDraft,
savePublishedStatus,
shareItemsToSiteGroups,
siteSecondPass,
unlinkPagesFromSite,
unlinkSiteAndPage,
updateAppRedirectUris,
updatePage,
updateSite,
updateSiteApplicationUris,
upgradeDraftSchema,
} from "@esri/hub-sites";
- _getSharingEligibleModels
- applyDraft
- convertCard
- convertLayoutToTemplate
- convertPageToTemplate
- convertRow
- convertSection
- convertSiteToTemplate
- createPage
- createPageModelFromTemplate
- createSite
- createSiteModelFromTemplate
- deleteDraft
- ensureOptionalGroupsTemplating
- ensurePageHasSiteEntry
- ensureRequiredPageProperties
- ensureRequiredSiteProperties
- extractAssets
- fetchAndApplyDraft
- fetchDraft
- getCardDependencies
- getDataForSiteItem
- getDomain
- getDomains
- getDraftDate
- getLayoutDependencies
- getMembers
- getPageDependencies
- getPageEditUrl
- getPageItemType
- getPortalSiteHostname
- getPortalSiteUrl
- getRowDependencies
- getSectionDependencies
- getSiteDependencies
- getSiteEditUrl
- getSiteItemType
- hasUnpublishedChanges
- interpolateSite
- isPage
- isSite
- linkSiteAndPage
- markPublished
- markUnpublished
- removePage
- removeSite
- removeSiteFromPage
- removeUnusedResources
- saveDraft
- savePublishedStatus
- shareItemsToSiteGroups
- siteSecondPass
- unlinkPagesFromSite
- unlinkSiteAndPage
- updateAppRedirectUris
- updatePage
- updateSite
- updateSiteApplicationUris
- upgradeDraftSchema
- DRAFT_RESOURCE_REGEX
- PAGE_DRAFT_INCLUDE_LIST
- PAGE_TEMPLATE_KEYWORD
- PAGE_TYPE_KEYWORD
- SITE_DRAFT_INCLUDE_LIST
- SITE_UI_VERSION
- UNPUBLISHED_CHANGES_KW
- ICard
- IEntry
- ILayout
- IRow
- ISection
- ISettings
- ITemplatizedCard
- ITemplatizedLayout
- ITemplatizedRow
- ITemplatizedSection
Version 14.0.0
@esri/hub-surveys
Module to interact with ArcGIS Hub Surveys in Node.js and modern browsers.
npm install:
npm install @esri/hub-surveys @esri/arcgis-rest-auth@^2.13.0 || 3 @esri/arcgis-rest-feature-layer@^2.13.0 || 3 @esri/arcgis-rest-portal@^2.13.0 || 3 @esri/arcgis-rest-request@^2.13.0 || 3 @esri/arcgis-rest-types@^2.13.0 || 3 @esri/hub-common@^14.0.0
Module Import:
import {
getDetailedSurveyStatus,
getGroupSharingDetails,
getSurveyStatus,
getSurveyStatusFromSchedule,
isDraft,
isPublished,
migrateFormPropertiesSettings,
setAccess,
setAccessRevertable,
shareWithGroup,
shareWithGroupRevertable,
shouldDisplayResults,
unshareWithGroup,
unshareWithGroupRevertable,
} from "@esri/hub-surveys";
- getDetailedSurveyStatus
- getGroupSharingDetails
- getSurveyStatus
- getSurveyStatusFromSchedule
- isDraft
- isPublished
- migrateFormPropertiesSettings
- setAccess
- setAccessRevertable
- shareWithGroup
- shareWithGroupRevertable
- shouldDisplayResults
- unshareWithGroup
- unshareWithGroupRevertable
- ISurveyStatus
- IFormItem
- IFormItemProperties
- IStakeholderItem
- ISurveyFormJson
- ISurveySchedule
Version 14.0.0
@esri/hub-teams
Module to interact with ArcGIS Hub Teams in Node.js and modern browsers.
npm install:
npm install @esri/hub-teams @esri/arcgis-rest-auth@^2.13.0 || 3 @esri/arcgis-rest-portal@^2.15.0 || 3 @esri/arcgis-rest-request@^2.13.0 || 3 @esri/arcgis-rest-types@^2.13.0 || 3 @esri/hub-common@^14.0.0
Module Import:
import {
addOrInviteUsersToTeam,
addOrInviteUsersToTeams,
addUsersToTeam,
applyPrivPropValuesToTemplate,
canEditTeam,
canUserCreateTeam,
canUserCreateTeamInProduct,
createHubTeam,
createHubTeams,
doesGroupExist,
getAllowedGroupAccess,
getOrgGroupLimit,
getTeamById,
getTeamMembers,
getTeamPropertiesMapForProduct,
getTeamsAvailableInProduct,
getTeamsForProduct,
getTeamStatus,
getTeamTemplate,
getTeamTypesAvailableInProduct,
getUniqueGroupTitle,
getUserCreatableTeams,
hasAllPrivileges,
removeInvalidPrivs,
removeTeam,
removeTeamFromItems,
removeUsersFromTeam,
removeUsersFromTeams,
searchTeamContent,
searchTeamMembers,
teamsToAddUsersTo,
updateTeam,
updateUserMembership,
} from "@esri/hub-teams";
- addOrInviteUsersToTeam
- addOrInviteUsersToTeams
- addUsersToTeam
- applyPrivPropValuesToTemplate
- canEditTeam
- canUserCreateTeam
- canUserCreateTeamInProduct
- createHubTeam
- createHubTeams
- doesGroupExist
- getAllowedGroupAccess
- getOrgGroupLimit
- getTeamById
- getTeamMembers
- getTeamPropertiesMapForProduct
- getTeamsAvailableInProduct
- getTeamsForProduct
- getTeamStatus
- getTeamTemplate
- getTeamTypesAvailableInProduct
- getUniqueGroupTitle
- getUserCreatableTeams
- hasAllPrivileges
- removeInvalidPrivs
- removeTeam
- removeTeamFromItems
- removeUsersFromTeam
- removeUsersFromTeams
- searchTeamContent
- searchTeamMembers
- teamsToAddUsersTo
- updateTeam
- updateUserMembership
- GROUP_ACCESS_PRIVS
- limitsHash
- TYPEMAP
- TEAMTYPES
- WELLKNOWNTEAMS
- AGOAccess
- HubProduct
- HubTeamType
- IAddOrInviteContext
- IAddOrInviteEmail
- IAddOrInviteResponse
- IAddOrInviteToTeamResult
- IGroupTemplate
- IPrivPropValues
- ITeamsStatus
- ITeamStatus
- IUserOrgRelationship
- IUserWithOrgType