Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

access

access: "public" | "private"

The access level of the organization.

Read more...

allSSL

allSSL: boolean

When true, access to the organization's Portal resources must occur over SSL.

Read more...

authMode

authMode: "auto" | "anonymous" | "immediate"

The authentication mode for handling authentication when the user attempts to access a secure resource.

Read more...

authorizedCrossOriginDomains

authorizedCrossOriginDomains: string[]

Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication.

Read more...

basemapGalleryGroupQuery

basemapGalleryGroupQuery: string

The query that defines the basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is not true.

Read more...

bingKey

bingKey: string

The Bing key to use for web maps using Bing Maps.

Read more...

canListApps

canListApps: boolean

Indicates whether an organization can list applications in the marketplace.

Read more...

canListData

canListData: boolean

Indicates whether an organization can list data services in the marketplace.

Read more...

canListPreProvisionedItems

canListPreProvisionedItems: boolean

Indicates whether an organization can list pre-provisioned items in the marketplace.

Read more...

canProvisionDirectPurchase

canProvisionDirectPurchase: boolean

Indicates whether an organization can provision direct purchases in the marketplace without customer request.

Read more...

canSearchPublic

canSearchPublic: boolean

When true, the organization's public items, groups and users are included in search queries.

Read more...

canShareBingPublic

canShareBingPublic: boolean

The Bing key can be shared to the public and is returned as part of a portal's description call (/sharing/rest/portals/<orgid>).

Read more...

canSharePublic

canSharePublic: boolean

When true, members of the organization can share resources outside the organization.

Read more...

canSignInArcGIS

canSignInArcGIS: boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in.

Read more...

canSignInIDP

canSignInIDP: boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in.

Read more...

colorSetsGroupQuery

colorSetsGroupQuery: string

The query that identifies the group containing the color sets used for rendering in the map viewer.

Read more...

commentsEnabled

commentsEnabled: boolean

Indicates whether to allow the organization to disable commenting.

Read more...

created

created: Date

Date the organization was created.

Read more...

culture

culture: string

The default locale (language and country) information.

Read more...

customBaseUrl

customBaseUrl: string

The custom base URL for the portal.

Read more...

declaredClass

declaredClass: string

defaultBasemap

defaultBasemap: Basemap

The default basemap to use for the portal.

Read more...

defaultExtent

defaultExtent: Extent

The default extent to use for the portal.

Read more...

defaultVectorBasemap

defaultVectorBasemap: Basemap

The default vector basemap to use for the portal.

Read more...

description

description: string

A description of the organization/portal.

Read more...

destroyed

destroyed: boolean

eueiEnabled

eueiEnabled: boolean

Boolean value indicating whether to opt-in to the Esri User Experience Improvement (EUEI) program.

Read more...

featuredGroups

featuredGroups: PortalFeaturedGroups[]

The featured groups for the portal.

Read more...

featuredItemsGroupQuery

featuredItemsGroupQuery: string

The query that defines the featured group.

Read more...

galleryTemplatesGroupQuery

galleryTemplatesGroupQuery: string

The query that identifies the group containing features items for the gallery.

Read more...

hasCategorySchema

hasCategorySchema: boolean

Indicates whether the organization has content categories.

Read more...

helperServices

helperServices: any

Helper services provided by the portal.

Read more...

homePageFeaturedContent

homePageFeaturedContent: string

The group that contains featured content to be displayed on the home page.

Read more...

homePageFeaturedContentCount

homePageFeaturedContentCount: number

The number of featured items that can be displayed on the home page.

Read more...

httpPort

httpPort: number

The port used by the portal for HTTP communication.

Read more...

httpsPort

httpsPort: number

The port used by the portal for HTTPS communication.

Read more...

id

id: string

The id of the organization that owns this portal.

Read more...

initialized

initialized: boolean

ipCntryCode

ipCntryCode: string

The country code of the calling IP (ArcGIS Online only).

Read more...

Readonly isOrganization

isOrganization: boolean

Indicates whether the portal is an organization.

Read more...

isPortal

isPortal: boolean

Indicates if the portal is on-premises.

Read more...

isReadOnly

isReadOnly: boolean

Indicates if the portal is in read-only mode.

Read more...

layerTemplatesGroupQuery

layerTemplatesGroupQuery: string

The query that identifies the group containing editing templates.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the portal's resources have loaded.

Read more...

maxTokenExpirationMinutes

maxTokenExpirationMinutes: number

The maximum validity in minutes of tokens issued for users of the organization.

Read more...

modified

modified: Date

Date the organization was last modified.

Read more...

name

name: string

Name of the organization.

Read more...

portalHostname

portalHostname: string

URL of the portal host.

Read more...

portalMode

portalMode: "multitenant" | "singletenant"

The portal mode.

Read more...

portalProperties

portalProperties: any

Properties specific to the organization, for example the "contact us" link.

Read more...

region

region: string

The region for the organization.

Read more...

Readonly restUrl

restUrl: string

The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online and "https://www.example.com/arcgis/sharing/rest" for your in-house portal.

Read more...

rotatorPanels

rotatorPanels: any[]

Custom HTML for the home page.

Read more...

showHomePageDescription

showHomePageDescription: boolean

Indicates whether the description of your organization displays on the home page.

Read more...

sourceJSON

sourceJSON: any

The JSON used to create the property values when the Portal is loaded.

Read more...

supportsHostedServices

supportsHostedServices: boolean

Indicates whether hosted services are supported.

Read more...

symbolSetsGroupQuery

symbolSetsGroupQuery: string

The query that defines the symbols sets.

Read more...

templatesGroupQuery

templatesGroupQuery: string

The query that defines the collection of templates that will appear in the template gallery.

Read more...

Readonly thumbnailUrl

thumbnailUrl: string

The URL to the thumbnail of the organization.

Read more...

units

units: "metric" | "english"

Sets the units of measure for the organization's users.

Read more...

url

url: string

The URL to the portal instance.

Read more...

urlKey

urlKey: string

The prefix selected by the organization's administrator to be used with the customBaseURL.

Read more...

useStandardizedQuery

useStandardizedQuery: boolean

When true, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables.

Read more...

useVectorBasemaps

useVectorBasemaps: boolean

When true, the organization has opted in to use the vector tile basemaps, and (a) vectorBasemapGalleryGroupQuery should be used instead of basemapGalleryGroupQuery, while (b) defaultVectorBasemap should be used instead of defaultBasemap.

Read more...

user

Information representing a registered user of the portal.

Read more...

vectorBasemapGalleryGroupQuery

vectorBasemapGalleryGroupQuery: string

The query that defines the vector tiles basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is true.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Portal
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Portal

cancelLoad

  • cancelLoad(): void
  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

createClosestFacilityTask

createElevationLayers

createGeometryService

createPrintTask

createRouteTask

createServiceAreaTask

destroy

  • destroy(): void
  • Returns void

fetchBasemaps

fetchCategorySchema

  • If present, fetches the organization's category schema.

    Read more...

    Parameters

    Returns Promise<any[]>

fetchFeaturedGroups

fetchRegions

  • Fetches and returns the associated regions with the portal instance.

    Read more...

    Parameters

    Returns Promise<any[]>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryGroups

queryItems

queryUsers

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Portal

  • Parameters

    Returns Portal

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc