PortalInfo

@Serializable
data class PortalInfo : JsonSerializable

A class that contains information about the related Portal.

Since

200.0.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

determines who can view the organization's content as an anonymous user. If the portal access value is PortalAccess.Public, anonymous users can access the organization's content. If the value is PortalAccess.Private, only members of your organization can access the content.

Link copied to clipboard
@SerialName(value = "3DBasemapGalleryGroupQuery")
val basemap3DGalleryGroupQuery: String? = null

a query that identifies the group that contains the 3D basemaps of the portal's 3D basemap gallery. This gallery group is defined by the portal's administrator and contains the 3D basemaps that are displayed in the Scene Viewer basemap gallery. To explore the 3D basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal.findGroups. Portal.fetch3DBasemaps uses this string to return a collection of basemaps from the portal's 3D basemap gallery.

Link copied to clipboard

a query that identifies the group that contains the basemaps of the portal's basemap gallery. This gallery group is defined by the portal's administrator and contains the basemaps that are displayed in the Map Viewer basemap gallery if a user logs in with an ArcGIS Online or ArcGIS Enterprise account. This group query is intended for use when the value of PortalInfo.useVectorBasemaps is false. To explore the basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal.findGroups. Portal.fetchBasemaps uses this string to return a collection of basemaps from the portal's basemap gallery.

Link copied to clipboard
val bingKey: String? = null

the Bing App ID associated with the portal. Notes: Deprecated as of version 200.8.0. Bing Maps for Enterprise is deprecated and will be retired.

Link copied to clipboard

true if the members of the organization can search content outside of the organization, false otherwise.

Link copied to clipboard

true if the members of the organization can share the Bing key outside of the organization, false otherwise. Notes: Deprecated as of version 200.8.0. Bing Maps for Enterprise is deprecated and will be retired.

Link copied to clipboard

true if the members of the organization can share content outside of the organization, false otherwise.

Link copied to clipboard

indicates if users are allowed to view and add comments on portal items.

Link copied to clipboard
@Serializable(with = InstantMillisecondsSerializer::class)
val created: Instant? = null

the date the organization was created.

Link copied to clipboard
val culture: String? = null

locale information for the organization (language-country, for example "en-us").

Link copied to clipboard
@SerialName(value = "customBaseUrl")
val customBaseDomain: String? = null

the portion of the URL host component that identifies the portal.

Link copied to clipboard

a query that identifies the default 3D basemap. This expression can be used as the query string parameter to find the default 3D basemap of the Portal. The default 3D basemap is the 3D basemap that is used when no basemap is specified.

Link copied to clipboard
@Serializable(with = BasemapTransformingSerializer::class)
val defaultBasemap: Basemap? = null

the default basemap of the portal/organization.

Link copied to clipboard
@Serializable(with = GeometryTransformingSerializer::class)
val defaultExtent: Envelope? = null

the default extent of the organization, used when users create a web map.

Link copied to clipboard
@Serializable(with = BasemapTransformingSerializer::class)
val defaultVectorBasemap: Basemap? = null

the default vector basemap of the portal/organization

Link copied to clipboard
@SerialName(value = "devBasemapGalleryGroupQuery")
val developerBasemapGalleryGroupQuery: String? = null

a query that identifies the group that contains the developer basemaps of the portal's developer basemap gallery. This gallery group is defined by the portal's administrator and contains the developer basemaps that are displayed in the Map Viewer basemap gallery if a user logs in with an ArcGIS Location Platform account. To explore the developer basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal.findGroups. Portal.fetchDeveloperBasemaps uses this string to return a collection of basemaps from the portal's developer basemap gallery.

Link copied to clipboard

a collection of pre-defined query strings for finding featured groups.

Link copied to clipboard

a pre-defined query string for finding the featured items group.

Link copied to clipboard

various services provided by the organization.

Link copied to clipboard

the number of items to show per page for the featured content screens (max=100). Notes: Deprecated as of version 200.4.0, All legacy home pages are no longer live on ArcGIS Online and at a future release of ArcGIS Enterprise this property will no longer be supported.

Link copied to clipboard
@SerialName(value = "homePageFeaturedContent")
val homePageFeaturedContentGroupQuery: String? = null

a query string that can be used to find the group containing featured content to be displayed on the home page. Notes: Deprecated as of version 200.4.0, All legacy home pages are no longer live on ArcGIS Online and at a future release of ArcGIS Enterprise this property will no longer be supported.

Link copied to clipboard
@SerialName(value = "portalHostname")
val hostname: String? = null

the hostname of the Portal.

Link copied to clipboard
val ipCountryCode: String? = null

the country code of the calling IP.

Link copied to clipboard
@SerialName(value = "eueiEnabled")
val isEueiEnabled: Boolean = false

indicates whether the organization allows ArcGIS Online to collect usage information from its members to improve the user experience.

Link copied to clipboard
val isPortal: Boolean = false

indicates if this portal is on premise or online, true for an on premise portal.

Link copied to clipboard
val isReadOnly: Boolean = false

indicates if the portal is currently in read-only mode.

Link copied to clipboard

the query that identifies the group containing the Living Atlas layers. This expression should be used as the query string parameter to find the group.

Link copied to clipboard
@Serializable(with = InstantMillisecondsSerializer::class)
val modified: Instant? = null

the date the organization was last modified.

Link copied to clipboard
@Serializable(with = LoadableImageSerializer::class)
val organizationBanner: LoadableImage? = null

the banner image of the organization.

Link copied to clipboard
@SerialName(value = "description")
val organizationDescription: String? = null

the description of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal, this will be null.

Link copied to clipboard
@SerialName(value = "id")
val organizationId: String? = null

the ID of the organization, if the user belongs to one.

Link copied to clipboard
@SerialName(value = "name")
val organizationName: String? = null

the name of the organization. In the case of non-organizational users of ArcGIS Online or a multi-tenant portal this will be null.

Link copied to clipboard
@SerialName(value = "subdomain")
val organizationSubdomain: String? = null

the portion of the URL's host component that identifies a specific organization subscription within a portal.

Link copied to clipboard
Link copied to clipboard

indicates whether the portal is single or multi tenant.

Link copied to clipboard
val portalName: String? = null

the name of the portal.

Link copied to clipboard

the thumbnail image of the portal.

Link copied to clipboard
val readOnlyMessage: String? = null

if the portal is currently in read-only mode, this is an explanatory message that can be displayed to the user. This will be empty if isReadOnly is false.

Link copied to clipboard
@SerialName(value = "allSSL")
val requiresSSL: Boolean = false

indicates if the organization is using SSL. If true, all calls made against resources that belong to the organization will require SSL.

Link copied to clipboard

indicates whether the description of the organization displays on the home page. Notes: Deprecated as of version 200.4.0, All legacy home pages are no longer live on ArcGIS Online and at a future release of ArcGIS Enterprise this property will no longer be supported.

Link copied to clipboard

a query that identifies a group of styles. Each style contains references to symbols that can be used in the ArcGIS platform. This expression can be used as the query string parameter to find the styles group. Instead of providing your own query, you can use the helper method Portal.fetchStyles to fetch the items in the styles group.

Link copied to clipboard

information about the portal user's subscription. A null if the portal is accessed anonymously.

Link copied to clipboard
@SerialName(value = "supportsOAuth")
val supportsOauth: Boolean = false

true if the portal supports OAuth authentication, false otherwise.

Link copied to clipboard

a query that identifies the symbol sets group. This expression can be used as the query string parameter to find the symbol sets group. Instead of providing your own query, you can use the helper method Portal.fetchSymbolSets to fetch the items in the symbol sets group.

Link copied to clipboard

the thumbnail image of the organization.

Link copied to clipboard
@SerialName(value = "use3dBasemaps")
val use3DBasemaps: Boolean = false

indicates if the organization uses 3D basemaps in supported ArcGIS apps.

Link copied to clipboard
@SerialName(value = "useDefault3dBasemap")
val useDefault3DBasemap: Boolean = false

indicates if the organization uses the default 3D basemap in supported ArcGIS apps.

Link copied to clipboard

Gets a PortalUser describing the user currently signed in to this portal.

Link copied to clipboard

indicates if the organization uses the Esri vector basemaps in supported ArcGIS apps.

Link copied to clipboard

a query that identifies the group that contains the vector basemaps of the portal's vector basemap gallery. The portal's vector basemap gallery group is defined by the portal's administrator. It contains the basemaps that are displayed in the Map Viewer basemap gallery if a user logs in with an ArcGIS Online or ArcGIS Enterprise account and the PortalInfo.useVectorBasemaps value is true. Note that if the value of PortalInfo.useVectorBasemaps is false, the Map Viewer displays the basemaps in the group identified by PortalInfo.basemapGalleryGroupQuery, and it's recommended that you use that group instead. To explore the basemap gallery PortalGroup, create a PortalQueryParameters using this query string, and call Portal.findGroups. Portal.fetchVectorBasemaps uses this string to return a collection of basemaps from the portal's vector basemap gallery.

Link copied to clipboard
@SerialName(value = "currentVersion")
val version: PortalVersion? = null

the current version of the Portal.

Functions

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.