@esri/hub.js
Guides
API Reference
GitHub
Menu
@esri/hub.js
Packages
common
v15.14.0
_getPortalSettings
_prepareUploadRequests
_waitForItemReady
addContextToSlug
addDays
addDefaultItemSearchPredicates
addDomain
addDynamicSlugValidation
addGroupMembers
addHistoryEntry
addPermissionPolicy
addSiteDomains
addSolutionResourceUrlToAssets
addUsersToGroup
aggregateMetrics
aggregateValues
allCoordinatesPossiblyWGS84
apiRequest
applyCatalogStructureMigration
applyDefaultCollectionMigration
applyHubSettingsMigrations
applyInitiativeMigrations
applyPermissionMigration
applyPropertiesToItems
applySiteSettingsMigrations
applyVersion
arrayToObject
asyncForEach
authenticateRequest
authenticateRequest
authenticateRequest
authenticateRequest
autoAddUsers
base64ToUnicode
batch
bBoxToExtent
bboxToString
breakAssociation
buildCatalog
buildDefaultEventEntity
buildDefaultEventRecord
buildDraft
buildEventAssociations
buildExistingExportsPortalQuery
buildReferencedContentSchema
buildSchema
buildWhereClause
cacheBustUrl
camelize
canEditEvent
canEditItem
canEditSite
canEditSiteContent
canUseCreateReplica
canUseHubDownloadApi
canUseHubDownloadSystem
capitalize
catalogContains
catalogToLegacy
channelToSearchResult
checkAll
checkAny
checkAssertion
checkAssertions
checkAuthentication
checkAvailability
checkDelete
checkEdit
checkEntityFeature
checkEntityPolicy
checkEnvironment
checkForStaleVersion
checkLicense
checkNot
checkOwner
checkParents
checkPermission
checkPrivileges
checkServiceStatus
chunkArray
clearMemoizedCache
cloneObject
combineQueries
completeOAuth2
compose
composeContent
composeHubContent
computeItemProps
computeLinks
computeLinks
computeLinks
computeLinks
computeLinks
computeLinks
computeLinks
computeLinks
computeProps
computeProps
configureBaseResources
constructSlug
convertCatalogToLegacyFormat
convertFeaturesToLegacyCapabilities
convertGroupToHubGroup
convertHubGroupToGroup
convertItemToSite
convertModelToPage
convertModelToSite
convertSolutionTemplateResourcesToAssets
convertToWellKnownLocale
convertUrlsToAnchorTags
convertUserToHubUser
createEvent
createEvent
createExtent
createHubGroup
createId
createItemFromFile
createItemFromUrl
createItemFromUrlOrFile
createModel
createNotificationSpec
createOperationPipeline
createRegistration
createRegistration
createSetting
createSite
createSubscription
createSubscription
createUser
createUser
createVersion
customClient
customClient
customClient
dasherize
datasetToContent
datasetToItem
decodeForm
deepCatalogContains
deepContains
deepDeletePropByValue
deepEqual
deepFilter
deepFind
deepFindById
deepGetPropValues
deepSet
deepStringReplace
deleteEvent
deleteEvent
deleteGroupThumbnail
deleteHubEvent
deleteItemThumbnail
deleteNotificationSpec
deleteProp
deleteRegistration
deleteRegistration
deleteSchedule
deleteSite
deleteSubscription
deleteUser
deleteUser
deleteVersion
deriveLocationFromItem
detectDataTypeFromExtension
detectDataTypeFromHeader
discussionsApiRequest
doesItemExistWithTitle
doesResourceExist
domainExists
domainExistsPortal
dotifyString
editorToContent
editorToEntity
editorToInitiative
editorToMetric
editorToProject
editorToTemplate
emailOrgUsers
enrichContentSearchResult
enrichEntity
enrichGroupSearchResult
enrichInitiativeTemplateSearchResult
enrichPageSearchResult
enrichSiteSearchResult
enrichUserSearchResult
ensureProp
ensureUniqueDomainName
ensureUniqueEntitySlug
ensureUniqueString
eventAttendeeToSearchResult
eventToSearchResult
expandPortalQuery
expandPredicates
expandQuery
explainDatePredicate
explainFilter
explainMatchOptionPredicate
explainPredicate
explainPropPredicate
explainQueryResult
extend
extentToBBox
extentToPolygon
failSafe
failSafeUpdate
fetchAllPages
fetchAndUploadResource
fetchAndUploadThumbnail
fetchCategoryItems
fetchContent
fetchDownloadFile
fetchEntityCatalog
fetchGroupEnrichments
fetchHubContent
fetchHubEntity
fetchHubGroup
fetchHubTranslation
fetchHubUser
fetchImageAsBlob
fetchInitiativeTemplate
fetchItem
fetchItemJobRecords
fetchMaxNumUserGroupsLimit
fetchModelFromItem
fetchModelResources
fetchOrg
fetchOrgLimits
fetchSetting
fetchSiteModel
fetchUserEnrichments
fetchUserHubSettings
fetchUserSiteSettings
filterBy
findBy
findItemsBySlug
flattenArray
followEntity
forceUpdateContent
formatFilterBlock
formatOgcAggregationsResponse
formatOgcItemsResponse
formatPredicate
generateRandomString
GeoJSONPolygonToBBox
getAddContentConfig
getAssociatedEntitiesQuery
getAssociationHierarchy
getAssociationStats
getAuthedImageUrl
getAvailableToRequestAssociationCatalogs
getAvailableToRequestEntitiesQuery
getBasePropertyMap
getCampaignUrl
getCardEditorSchemas
getCardModelUrlFromEntity
getCardModelUrlFromResult
getCardType
getCatalogGroups
getCategory
getCdnAssetUrl
getChannelAccess
getChannelGroupIds
getChannelOrgIds
getChannelUsersQuery
getContentEditUrl
getContentIdentifier
getContentTypeIcon
getContentTypeLabel
getCulture
getDatePickerDate
getDefaultCreateableTypes
getDefaultEntitySettings
getDefaultTemplates
getDeployedTemplateType
getDiscussionsApiDefinition
getDomainsForSite
getDownloadConfiguration
getDownloadFormats
getEditorConfig
getEditorSchemas
getEditorSlug
getEntityFollowersGroupId
getEntityGroups
getEntityMetrics
getEntityThumbnailUrl
getEntityTypeFromHubEntityType
getEnvironmentFromPortalUrl
getEvent
getEvent
getEventGroups
getEvents
getEvents
getEventSlug
getEventThumbnail
getExtentCenter
getExtentObject
getFamily
getFamilyTypes
getFeaturedContentCatalogs
getFeatureLayerItem
getFeatureServiceItem
getFeatureServiceTitle
getFeedConfiguration
getFeedTemplate
getFileName
getFilterQueryParam
getFormInfoJson
getFormJson
getGroupHomeUrl
getGroupPredicate
getGroupThumbnailUrl
getHubApiFromPortalUrl
getHubApiUrl
getHubApiUrlFromPortal
getHubApiUrlRoot
getHubDownloadApiFormats
getHubEntityTypeFromPath
getHubLocaleAssetUrl
getHubProduct
getHubTypeFromItemType
getHubUrlFromPortal
getIdsFromAssociationGroups
getIdsFromKeywords
getIncludeListFromItemType
getIncludesAndReferencesQuery
getIncludesDoesNotReferenceQuery
getInputFeatureServiceModel
getItemApiUrl
getItemAssets
getItemBySlug
getItemDataUrl
getItemHomeUrl
getItemHubId
getItemIdentifier
getItemLayerId
getItemOrgId
getItemThumbnailUrl
getKilobyteSizeOfQuery
getLayerIdFromUrl
getLocationExtent
getLocationFromEvent
getLocationOptions
getMapQuestion
getModel
getModelBySlug
getModelFromOptions
getNextOgcCallback
getNotificationSpec
getNotificationSpecs
getObjectSize
getOgcAggregationQueryParams
getOptionalPredicateStringsByKey
getOrgDefaultTheme
getOrgExtentAsBBox
getOrgThumbnailUrl
getPathForHubEntityType
getPendingEntitiesQuery
getPendingProjectsQuery
getPermissionPolicy
getPolicyResponseCode
getPortalApiUrl
getPortalBaseFromOrgUrl
getPortalSignInSettings
getPortalUrl
getPortalUrls
getPostCSVFileName
getPredicateValues
getPredicateValuesByKey
getProp
getPropertyMap
getProps
getProxyUrl
getPublisherInfo
getQQueryParam
getQueryString
getRecommendedTemplatesCatalog
getReferencedEntityIds
getReferencesDoesNotIncludeQuery
getRegistration
getRegistration
getRegistrations
getRegistrations
getRelativeWorkspaceUrl
getRequestingEntitiesQuery
getResultSiteRelativeLink
getS123EditUrl
getS123ShareUrl
getSchedule
getSchedulerApiUrl
getScopeGroupPredicate
getServiceStatus
getServiceTypeFromUrl
getSharableGroupsComboBoxItems
getShortenedCategories
getSiteById
getSiteSchema
getSlugMaxLength
getSlugSchemaElement
getSourceFeatureServiceModelFromFieldworker
getStakeholderModel
getStructuredLicense
getSubscription
getSubscription
getSubscriptions
getSubscriptions
getSubscriptionType
getSurveyModels
getTagItems
getTimePickerTime
getTopLevelPredicate
getTypeCategories
getTypeFromEntity
getTypes
getTypesFromEntityType
getUniqueDomainName
getUniqueDomainNamePortal
getUniqueItemTitle
getUniqueSlug
getUser
getUser
getUserGroupsByMembership
getUserGroupsFromQuery
getUserHomeUrl
getUsers
getUserThumbnailUrl
getVersion
getWellKnownAssociationsCatalog
getWellKnownCatalog
getWellknownCollection
getWellknownCollections
getWellKnownGroup
getWithDefault
getWorkflowForType
guessTimeZone
hasBasePriv
hasMapQuestion
hasServiceCapability
hubApiRequest
hubSearch
hubSearchEvents
includes
incrementString
initiativeResultToCardModel
initiativeTemplateResultToCardModel
initiativeTemplateToCardModel
initiativeToCardModel
interpolate
interpolateItemId
inviteUsers
isAGOFeatureServiceUrl
isAssociationSupported
isBBox
isComboboxItemSelected
isCuid
isDiscussable
isDomainForLegacySite
isDomainUsedElsewhere
isDownloadable
isDownloadSchedulingAvailable
isDraft
isFeatureLayer
isFeatureService
isFeatureService
isFieldworkerView
isFindable
isGuid
isHostedFeatureServiceMainEntity
isHostedFeatureServiceMainItem
isHubService
isMapOrFeatureServerUrl
isMapQuestion
isNil
isNilOrEmptyString
isOpenDataGroup
isOrgChannel
isPageQuestion
isPermission
isPrivateChannel
isPublicChannel
isSafeRedirectUrl
isSecureProxyServiceUrl
isService
isServicesDirectoryDisabled
isSiteType
isSlug
isSurvey123Connect
isUpdateGroup
isUrl
isUserFollowing
isValidDomain
isValidEntityType
isValidExtent
isWellKnownTypeFilter
itemToContent
itemToSearchResult
keywordSlugToUriSlug
last
lookupDomain
mapBy
mapEntityToStore
mapStoreToEntity
maybeAdd
maybePush
maybeUpdateSchedule
memoize
mergeObjects
metricToEditor
migrateLegacyCapabilitiesToFeatures
migrateToCollectionKey
modelToHubEditableContent
normalizeItemType
normalizeSolutionTemplateItem
notify
notify
objectToArray
objectToJsonBlob
ogcApiRequest
ogcItemToDiscussionPostResult
ogcItemToSearchResult
orgExtent
parseContainmentPath
parseDatasetId
parseIdentifier
parseInclude
pathToCatalogInfo
pickProps
pingFeatureService
pingUrl
poll
portalSearchGroupMembers
portalSearchItems
portalSearchItemsAsItems
previewFeed
processActionLink
processActionLinks
processAttendeeFilters
processAttendeeOptions
processEntityFeatures
processFilters
processOptions
processRevertableTasks
projectResultToCardModel
projectToCardModel
propifyString
reflectCollectionsToSearchCategories
reharvestSiteCatalog
removeAssociationKeyword
removeContextFromSlug
removeDomain
removeDomainByHostname
removeDomainsBySiteId
removeEmptyProps
removeHistoryEntry
removePermissionPolicy
removeResource
removeSetting
replaceItemId
requestAssociation
resolveDynamicValue
resolveDynamicValues
resolveItemQueryValues
resolveMetric
resolvePortalValues
resolveReferences
resolveServiceQueryValues
runRevertableTask
searchCatalogs
searchChannels
searchEntityCatalogs
searchOgcAggregations
searchOgcItems
searchVersions
serializeModel
serializeQueryForPortal
serializeSpatialReference
setAssociationKeyword
setContentType
setDiscussableKeyword
setDisplayMapKeyword
setEntityAccess
setEntityAssociationGroup
setEntityStatusKeyword
setFeedConfiguration
setFeedTemplate
setGroupThumbnail
setItemThumbnail
setMetricAndDisplay
setProp
setSchedule
setSlugKeyword
shareEntityWithGroups
shareEventWithGroups
shareItemToGroups
shouldDisplayMap
shouldHaveDataUrl
slugify
stringToBlob
stripProtocol
subscribe
subscribe
subsetSchema
templateResultToCardModel
templateToCardModel
titleize
toggleServiceCapability
truncateSlug
unfollowEntity
unicodeToBase64
unique
uniqueBy
unprotectModel
unshareEntityWithGroups
unshareEventWithGroups
unshareItemFromGroups
updateCommunityOrgSettings
updateDomain
updateEvent
updateEvent
updateHubEntity
updateModel
updateNotificationSpec
updatePortalOrgSettings
updateRegistration
updateRegistration
updateSetting
updateSite
updateSubscription
updateSubscription
updateUser
updateUser
updateUserHubSettings
updateUserSiteSettings
updateVersion
updateVersionMetadata
upgradeCatalogSchema
upgradeProtocol
upgradeSiteSchema
uploadImageResource
uploadResourcesFromUrl
upsertModelResources
upsertResource
uriSlugToKeywordSlug
userResultToCardModel
validateUrl
wait
without
withoutByProp
ArcGISContext
ArcGISContextManager
ArcgisHubDownloadError
Catalog
Collection
EntityEditor
Hub
HubContent
HubDiscussion
HubError
HubEvent
HubGroup
HubInitiative
HubInitiativeTemplate
HubItemEntity
HubPage
HubProject
HubSite
HubSurvey
HubTemplate
HubUser
Logger
OperationError
OperationStack
RemoteServerError
RemoteServerError
addCreateItemTypes
CatalogAppearanceSchema
CatalogSchema
categories
CollectionAppearanceSchema
collections
CollectionSchema
DEFAULT_DISCUSSION
DEFAULT_GROUP
DEFAULT_INITIATIVE
DEFAULT_INITIATIVE_TEMPLATE
DEFAULT_PAGE
DEFAULT_PROJECT
DEFAULT_SITE
DEFAULT_SURVEY
DEFAULT_TEMPLATE
DEFAULT_THEME
ENTITY_ACCESS_SCHEMA
ENTITY_CATEGORIES_SCHEMA
ENTITY_FEATURED_CONTENT_SCHEMA
ENTITY_IMAGE_SCHEMA
ENTITY_IS_DISCUSSABLE_SCHEMA
ENTITY_LOCATION_SCHEMA
ENTITY_MAP_SCHEMA
ENTITY_NAME_SCHEMA
ENTITY_SUMMARY_SCHEMA
ENTITY_TAGS_SCHEMA
ENTITY_TIMELINE_SCHEMA
EntityResourceMap
EventGalleryCardSchema
FilterSchema
FIXED_IN_PERSON_ATTENDANCE_VALIDATIONS
FIXED_ONLINE_ATTENDANCE_VALIDATIONS
FollowSchema
GalleryDisplayConfigSchema
GLOBAL_EXTENT
HUB_CDN_URLMAP
IF_SOURCE_TITLE_THEN_SOURCE_LINK
IF_STATIC_THEN_REQUIRE_VALUE
IF_STATIC_THEN_URL_FORMAT
InitiativeAssociationHierarchies
InitiativeDefaultFeatures
InitiativeTemplateSchema
MetricSchema
pathMap
PORTAL_EXPORT_TYPES
PredicateSchema
PRIVACY_CONFIG_SCHEMA
ProjectAssociationHierarchies
ProjectDefaultFeatures
QuerySchema
SEARCH_APIS
SHOW_FOR_DYNAMIC_RULE_ENTITY
SHOW_FOR_SHARING_RULE_ENTITY
SHOW_FOR_STATIC_AND_DATE_RULE_ENTITY
SHOW_FOR_STATIC_AND_NUMBER_RULE_ENTITY
SHOW_FOR_STATIC_AND_STRING_RULE_ENTITY
SHOW_FOR_STATIC_RULE_ENTITY
SITE_ENTITY_NAME_SCHEMA
SiteDefaultFeatures
SLUG_SCHEMA
TemplateSchema
TIME_VALIDATIONS_WHEN_NOT_ALL_DAY
URL_VALIDATIONS_WHEN_ONLINE_OR_HYBRID
UserSchema
VALUE_TYPE_MAPPING
WellKnownItemPredicates
ALPHA_ORGS
ASSOCIATION_REFERENCE_LIMIT
CANNOT_DISCUSS
capabilityToFeatureMap
ContentDefaultFeatures
ContentEditorTypes
ContentSchema
CREATE_REPLICA_FORMATS
DEFAULT_DISCUSSION_MODEL
DEFAULT_GROUP_MODEL
DEFAULT_INITIATIVE_MODEL
DEFAULT_INITIATIVE_TEMPLATE_MODEL
DEFAULT_PAGE_MODEL
DEFAULT_PROJECT_MODEL
DEFAULT_SITE_MODEL
DEFAULT_TEMPLATE_MODEL
DEFAULT_USER
DiscussionEditorTypes
DiscussionSchema
ENTERPRISE_PAGE_ITEM_TYPE
ENTERPRISE_SITE_ITEM_TYPE
EventEditorTypes
EXPORT_IMAGE_FORMATS
GroupEditorTypes
GroupSchema
HUB_DISCUSSION_ITEM_TYPE
HUB_ENTITY_TYPES
HUB_FGDB_JOB_FORMATS
HUB_GROUP_TYPE
HUB_INITIATIVE_ITEM_TYPE
HUB_INITIATIVE_TEMPLATE_ITEM_TYPE
HUB_LOCALES
HUB_PAGE_ITEM_TYPE
HUB_PAGING_JOB_FORMATS
HUB_PROJECT_ITEM_TYPE
HUB_SITE_ITEM_TYPE
HUB_SITE_ITEM_TYPE
HUB_TEMPLATE_ITEM_TYPE
HubItemEntitySchema
HubPermissionsPolicies
INITIATIVE_SCHEMA_VERSION
InitiativeEditorTypes
InitiativeSchema
InitiativeTemplateDefaultFeatures
InitiativeTemplateEditorTypes
itemPropsNotInTemplates
MAP_SURVEY_TYPEKEYWORD
MAX_ENTITY_METRICS_ALLOWED
MAX_FEATURED_METRICS_ALLOWED
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
SiteVersionIncludeList
STANDARD_LICENSES
SurveyEditorTypes
SurveySchema
targetEntities
TemplateDefaultFeatures
TemplateEditorTypes
TYPEKEYWORD_SLUG_PREFIX
USER_HUB_SETTINGS_APP
USER_HUB_SETTINGS_KEY
USER_SITE_SETTINGS_APP
USER_SITE_SETTINGS_KEY
UserEditorTypes
validCardEditorTypes
validEditorTypes
validEntityEditorTypes
validEventGalleryCardEditorTypes
validFollowCardEditorTypes
validStatCardEditorTypes
VERSION_RESOURCE_NAME
VERSION_RESOURCE_PROPERTIES
WGS84_WKID
AclCategory
AclSubCategory
ALIGNMENTS
Cadence
Cadence
CARD_TITLE_TAGS
ChannelFilter
ChannelRelation
ChannelSort
CommonSort
CORNERS
DatePrecision
DeliveryMethod
DeliveryMethod
DiscussionSource
DiscussionType
DownloadOperationStatus
DROP_SHADOWS
EmbedKind
EntitySettingType
EntityType
EventAccess
EventAssociationEntityType
EventAttendanceType
EventLocationType
EventSort
EventSortOrder
EventStatus
ExpressionRelationships
FileExtension
FilterOperation
HubEntityHero
HubEntityStatus
HubEventAttendanceType
HubEventCapacityType
ICONS
ItemType
JobRecordStatus
JobRecordType
LAYOUTS
Level
MetricVisibility
PostReaction
PostRelation
PostSort
PostStatus
PostType
PublisherSource
ReactionRelation
RegistrationRole
RegistrationSort
RegistrationStatus
Role
SCALE
SearchCategories
SearchPostsFormat
ServiceCapabilities
ServiceDownloadFormat
SharingAccess
SortOrder
SortOrder
SOURCE
SubscriptionAction
SubscriptionAction
SubscriptionEntityType
SubscriptionEntityType
SystemNotificationSpecNames
SystemNotificationSpecNames
TIMELINE_STAGE_STATUSES
UNIT_POSITIONS
UpdateFrequency
VISUAL_INTEREST
WellKnownCollection
AccessControl
AccessLevel
AddContentWorkflow
AddContentWorkflowConfig
AssertionType
Awaited
Awaited
Awaited
BBox
Cadence
CardEditorOptions
CardEditorType
CardModelTarget
CatalogType
CollaborationType
ContentEditorType
ContentWorkflow
CountByValue
CreateEventResult
CreateNotificationSpecResult
CreateRegistrationResult
CreateReplicaFormat
CreateSubscriptionResult
CreateUserResult
DatasetResource
DeleteEventResult
DeleteNotificationSpecResult
DeleteRegistrationResult
DeleteSubscriptionResult
DeleteUserResult
DiscussionEditorType
DownloadCacheStatus
DownloadFlowType
downloadProgressCallback
DynamicAggregation
DynamicValue
DynamicValueDefinition
DynamicValueResult
DynamicValues
DynamicValueType
EditableContentEnrichment
EditorOptions
EditorType
Enrichments
EntityEditorOptions
EntityEditorType
EntityOrOptions
EntityToCardModelFn
EntityType
EventEditorType
EventGalleryCardEditorType
ExportImageFormat
FeedFormat
FollowCardEditorType
GenericAsyncFunc
GenericResult
GeographyProvenance
GetEventResult
GetEventsParams
GetEventsResult
GetNotificationSpecResult
GetNotificationSpecsResult
GetRegistrationResult
GetRegistrationsParams
GetRegistrationsResult
GetSubscriptionResult
GetSubscriptionsParams
GetSubscriptionsResult
GetUserResult
GetUsersResult
GroupEditorType
GroupEnrichment
GroupSortField
HubActionLink
HubAvailability
HubCapability
HubEmbed
HubEntity
HubEntityEditor
HubEntityType
HubEnvironment
HubFamily
HubFgdbJobFormat
HubLicense
HubPagingJobFormat
HubProduct
HubService
HubServiceStatus
IBatch
IBatchTransform
ICreateCatalogCollectionQueryProperties
ICreateEventCapabilities
ICreateEventLocationGeometriesItem
ICreateEventLocationProperty
ICreateSubscriptionCatalog
ICreateSubscriptionMetadata
IEditorModuleType
IEventCapabilities
IEventLocationGeometriesItem
IEventLocationSpatialReference
IExtendedProps
IFetchDownloadFileResponse
IHubContentEditor
IHubContentStatus
IHubDiscussionEditor
IHubEditableContentEnrichments
IHubEventEditor
IHubGroupEditor
IHubInitiativeEditor
IHubInitiativeTemplateEditor
IHubItemEntityEditor
IHubLocationType
IHubPageEditor
IHubProjectEditor
IHubSiteEditor
IHubSurveyEditor
IHubTemplateEditor
IItemAndIServerEnrichments
IItemTemplate
InitiativeEditorType
InitiativeTemplateEditorType
IRevertableTaskResult
ISubscribeCatalog
ISubscribeMetadata
ISubscriptionCatalog
ISubscriptionCatalog
ISubscriptionMetadata
ISubscriptionMetadata
ItemOrServerEnrichment
IUpdateEventCapabilities
IUpdateEventLocation
IUpdateEventOnlineMeeting
IUpdateSubscriptionCatalog
Kilobyte
LegacyCapability
LegacyExportItemFormat
LegacySearchCategory
MatchCondition
MaybeTranslate
MembershipAccess
MemberType
MetricSource
NamedApis
NotifyResult
OrgLimitType
PageEditorType
Permission
PermissionCheckFunction
PipelineFn
PlatformPrivilege
PlatformSortOrder
PolicyResponse
ProjectEditorType
ResultToCardModelFn
ScheduleMode
SchedulerOptionType
SearchableType
SearchFunction
ServiceAggregation
SettableAccessLevel
SiteEditorType
SortOption
StatCardEditorType
SubscribeResult
SurveyEditorType
SystemStatus
TemplateEditorType
Translatable
UpdateEventResult
UpdateNotificationSpecResult
UpdateRegistrationResult
UpdateSubscriptionResult
UpdateUserResult
UserEditorType
UserEnrichment
UserResourceApp
Visibility
WellKnownAssociationCatalog
WellKnownCatalog
WellKnownCollection
IAccessResponse
IActionLink
IAddContentCreateWorkflowConfig
IAddContentExistingWorkflowConfig
IAddContentUploadWorkflowConfig
IAddContentWorkflowConfig
IAddGroupMembersResult
IAddMemberContext
IAddOrInviteMemberResponse
IAllowedFileTypes
IApiDefinition
IArcGISContext
IArcGISContextManagerOptions
IArcGISContextOptions
IAssociationStats
IAsyncConfigurationSchema
IBadgeConfig
IBaseExtendedProps
ICapabilityConfig
ICapabilityToFeatureMap
ICardActionLink
ICardEditorModuleType
ICatalogInfo
ICatalogScope
ICatalogSearchResponse
IChangeEventDetail
IChannel
IChannelAclPermission
IChannelAclPermissionDefinition
IChannelAclPermissionUpdateDefinition
IChannelMetadata
IChannelNotificationOptOut
IComposeContentOptions
IConfigurationSchema
IConfigurationValues
IConsolidatedResult
IContainsOptions
IContainsResponse
IContentConfig
IContentExtendedProps
IConvertToCardModelOpts
ICreateCatalog
ICreateCatalogCollection
ICreateCatalogCollectionQuery
ICreateCatalogCollectionQueryFilter
ICreateCatalogCollectionQueryFilterPredicate
ICreateCatalogIntegrity
ICreateCatalogScope
ICreateChannel
ICreateChannelNotificationOptOutParams
ICreateChannelParams
ICreateChannelPermissions
ICreateChannelPost
ICreateChannelSettings
ICreateEvent
ICreateEventAssociation
ICreateEventLocation
ICreateEventMetadata
ICreateEventParams
ICreateLocationSpatialReference
ICreateNotificationSpec
ICreateOnlineMeeting
ICreatePost
ICreatePostParams
ICreateReaction
ICreateReactionOptions
ICreateRegistration
ICreateRegistrationParams
ICreateReplyParams
ICreateSetting
ICreateSettingParams
ICreateSubscription
ICreateSubscriptionParams
ICreateTelemetryReportMetadata
ICreateUser
ICreateUserParams
ICreateVersionOptions
ICustomParams
ICustomParams
ICustomParams
IDatasetEnrichments
IDateRange
IDeepCatalogInfo
IDeleteEventParams
IDeleteRegistrationParams
IDeleteUserParams
IDiscussionParams
IDiscussionsConfig
IDiscussionsMentionMeta
IDiscussionsRequestOptions
IDiscussionsSettings
IDiscussionsUser
IDomainEntry
IDownloadFormat
IDownloadFormatConfiguration
IDownloadFormatConfigurationDisplay
IDraft
IDynamicDownloadFormat
IDynamicItemQueryDefinition
IDynamicMetricValues
IDynamicPortalSelfDefinition
IDynamicServiceQueryDefinition
IEditorConfig
IEmail
IEnrichmentErrorInfo
IEntityDownloadConfiguration
IEntityEditorContext
IEntityEditorModuleType
IEntityInfo
IEntityPermissionPolicy
IEntityResource
IEntitySetting
IEntitySettings
IEvent
IEventAssociation
IEventGalleryCardEditorOptions
IEventLocation
IEventModel
IEventPermission
IEventRegistrationCount
IEventsConfig
IEventsRequestOptions
IExportPostsParams
IExpression
IFeatureFlags
IFeedsConfiguration
IFetchChannel
IFetchChannelNotificationOptOutParams
IFetchChannelParams
IFetchContentOptions
IFetchDownloadFileBlobResponse
IFetchDownloadFileOptions
IFetchDownloadFileUrlResponse
IFetchDownloadFormatsOptions
IFetchItemOptions
IFetchPost
IFetchPostParams
IFetchSettingParams
IFileType
IFilter
IFilterExplanation
IFollowCardEditorOptions
IGalleryDisplayConfig
IGeometryProperties
IGetEventParams
IGetEventsParams
IGetFeedTemplateOptions
IGetGroupSharingDetailsResults
IGetRegistrationParams
IGetRegistrationsParams
IGetServiceStatusOptions
IGetSubscriptionParams
IGetSubscriptionsParams
IGetSurveyModelsResponse
IGetUserParams
IGetWellKnownCatalogOptions
IGroupAndEnrichments
IGroupEnrichments
IGroupMembershipSummary
IGroupsByMembership
IHubActionLinkSection
IHubAdditionalResource
IHubAggregation
IHubAssociationHierarchy
IHubAssociationRules
IHubBaseContentStatus
IHubCardViewModel
IHubCatalog
IHubCollection
IHubContent
IHubContentActionLink
IHubContentEnrichments
IHubCreateEventRegistration
IHubDiscussion
IHubDownloadJobRecord
IHubEditableContent
IHubEmbed
IHubEmbedApp
IHubEmbedExternal
IHubEmbedMap
IHubEmbedSurvey
IHubEntityBase
IHubEntityLinks
IHubEvent
IHubExtent
IHubExternalActionLink
IHubGeography
IHubGroup
IHubHistory
IHubHistoryEntry
IHubImage
IHubImageOptions
IHubInitiative
IHubInitiativeTemplate
IHubItemEntity
IHubJobRecord
IHubJobRecordRequestOptions
IHubLayout
IHubLocation
IHubLocationOption
IHubMapSettings
IHubOptions
IHubOtherContentStatus
IHubPage
IHubProject
IHubRequestOptions
IHubRequestOptionsPortalSelf
IHubSchedule
IHubScheduleResponse
IHubSearchOptions
IHubSearchResponse
IHubSearchResult
IHubServiceBackedContentStatus
IHubSite
IHubSiteTheme
IHubSiteUrlInfo
IHubStage
IHubStageLink
IHubSurvey
IHubTeam
IHubTemplate
IHubTimeline
IHubTrustedOrgsRelationship
IHubTrustedOrgsResponse
IHubUser
IHubUserOrgSettings
IHubUserRequestOptions
IHubWellKnownActionLink
IInfoConfig
IInitiativeItem
IInitiativeModel
IInitiativeModelTemplate
IInitiativesConfig
IItemAndEnrichments
IItemEnrichments
IItemQueryMetricSource
IItemResource
IItemResource
ILegacyCapabilityFeatureFlags
ILink
ILocationSpatialReference
IMatchOptions
IMatchReason
IMessage
IMetadataPaths
IMetric
IMetricAttributes
IMetricDisplayConfig
IMetricEditorValues
IMetricFeature
IModel
IModelTemplate
INewslettersRequestOptions
INewslettersSchedulerRequestOptions
INotificationSpec
INotificationSpec
INotify
INotifyParams
IObjectSize
IOgcAggregationsResponse
IOgcItem
IOgcItemQueryParams
IOgcItemsResponse
IOnlineMeeting
IOperation
IOrgLimit
IOrvalParams
IOrvalParams
IOrvalParams
IPagedEventResponse
IPagedRegistrationResponse
IPagedResponse
IPagesConfig
IPagingOptions
IParsedIdentifier
IParsedPath
IPermissionAccessResponse
IPermissionPolicy
IPipeable
IPlatformSharing
IPolicyAssertion
IPolicyCheck
IPolygonProperties
IPost
IPostOptions
IPredicate
IPredicateExplanation
IPreviewFeedOptions
IProjectsConfig
IPropertyMap
IQuery
IQueryExplanation
IQueryExplanationDetails
IQueryParams
IReaction
IReference
IRegistration
IRegistrationPermission
IRelativeDate
IRemoveChannelActivityParams
IRemoveChannelActivityResult
IRemoveChannelNotificationOptOutParams
IRemoveChannelNotificationOptOutResult
IRemoveChannelParams
IRemoveChannelResponse
IRemovePostParams
IRemovePostResponse
IRemoveReactionOptions
IRemoveReactionResponse
IRemoveSettingParams
IRemoveSettingResponse
IResolvedMetric
IRevertableTaskFailed
IRevertableTaskSuccess
IS123FormJSON
IS123Question
ISchedulerOption
ISearchChannels
ISearchChannelsParams
ISearchPosts
ISearchPostsParams
ISearchResponse
ISearchResponseHash
ISerializedOperationStack
IServerEnrichments
IServiceExtendedProps
IServiceQuery
IServiceQueryMetricSource
IServiceQueryOptions
ISetFeedTemplateOptions
ISimpleResult
ISolutionTemplate
ISortOption
ISortOptions
IStatCardEditorOptions
IStaticDownloadFormat
IStaticValueDefinition
IStaticValueMetricSource
IStructuredLicense
ISubscribe
ISubscribeParams
ISubscription
ISubscription
ITemplateAsset
IThumbnailOptions
ITypeWorkflow
ITypeWorkflowDefinition
IUpdateChannel
IUpdateChannelParams
IUpdateChannelPermissions
IUpdateEvent
IUpdateEventParams
IUpdateNotificationSpec
IUpdatePageOptions
IUpdatePost
IUpdatePostParams
IUpdatePostStatus
IUpdatePostStatusParams
IUpdateRegistration
IUpdateRegistrationParams
IUpdateSetting
IUpdateSettingParams
IUpdateSiteOptions
IUpdateSubscription
IUpdateSubscriptionParams
IUpdateUser
IUpdateUserParams
IUser
IUser
IUser
IUserAndEnrichments
IUserEnrichments
IUserHubSettings
IUserResourceConfig
IUserResourceToken
IUserSiteSettings
IVersion
IVersionMetadata
IWellKnownApis
IWithAssociations
IWithAuthor
IWithBannerImage
IWithBannerImageStore
IWithCardBehavior
IWithCatalog
IWithCatalogBehavior
IWithContent
IWithDiscussions
IWithDiscussionsBehavior
IWithEditor
IWithEditorBehavior
IWithEntitySettings
IWithEvents
IWithFeaturedImageBehavior
IWithFiltering
IWithFollowers
IWithFollowersBehavior
IWithInitiatives
IWithLayout
IWithLayoutStore
IWithMetrics
IWithMetricsBehavior
IWithPages
IWithPermissionBehavior
IWithPermissions
IWithProjects
IWithSharingBehavior
IWithSlug
IWithSorting
IWithStatus
IWithStoreBehavior
IWithThumbnailBehavior
IWithTimeQueries
IWithTimestamps
IWithVersioningBehavior
IWithViewSettings
discussions
v29.3.0
canCreateChannel
canCreateReaction
canDeleteChannel
canDeletePost
canEditChannel
canEditPost
canEditPostStatus
canModifyChannel
canModifyPost
canModifyPostStatus
canPostToChannel
canReadChannel
canReadFromChannel
createChannel
createChannelNotificationOptOut
createPost
createReaction
createReply
dtoToChannel
exportPosts
fetchChannel
fetchChannelNotifcationOptOut
fetchPost
isOrgAdmin
isOrgAdminInOrg
isUserInOrg
parseDiscussionURI
parseMentionedUsers
reduceByGroupMembership
removeChannel
removeChannelActivity
removeChannelNotificationOptOut
removePost
removeReaction
searchPosts
updateChannel
updatePost
updatePostStatus
userHasPrivilege
userHasPrivileges
MENTION_ATTRIBUTE
downloads
v15.0.0
pollDownloadMetadata
requestDatasetExport
requestDownloadMetadata
DownloadFormats
DownloadStatus
DownloadFormat
DownloadStatuses
DownloadTarget
IDatasetExportRequestParams
IDatasetExportResult
IDownloadMetadataRequestParams
IDownloadMetadataResults
IPollDownloadMetadataRequestParams
IPoller
events
v15.0.0
addUsersToEvent
getEventFeatureServiceUrl
getEventQueryFromType
getEventServiceItem
getEventServiceUrl
registerForEvent
searchEvents
unregisterForEvent
IEventRegisterOptions
IEventResourceObject
search
v15.0.0
agoSearch
flattenCategories
kMerge
mergeAggregations
mergePages
serialize
BinaryHeap
InvalidPaginationInputError
SortDirection
IAggregation
IAggregationResult
IDateRange
IHubResult
IHubResults
ISearchParams
ISearchRequest
sites
v16.0.0
_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
surveys
v15.0.0
getDetailedSurveyStatus
getGroupSharingDetails
getSurveyStatus
getSurveyStatusFromSchedule
isPublished
migrateFormPropertiesSettings
setAccess
setAccessRevertable
shareWithGroup
shareWithGroupRevertable
shouldDisplayResults
unshareWithGroup
unshareWithGroupRevertable
ISurveyStatus
IFormItem
IFormItemProperties
IStakeholderItem
ISurveyFormJson
ISurveySchedule
teams
v15.0.0
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
IModel
Interface
Generic Model, used with all items that have a json
/data
payload
Properties
Property
Type
Notes
item
IItem
data
Optional
[key:
string
]:
any
resources
Optional
[key:
string
]:
any
Index Signatures
Key Type
Value Type
Notes
string
any
Generic Model, used with all items that have a json
/data
payload
Interface defined in
common/src/types.ts:23