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

the access level of this portal or organization.

Link copied to clipboard

a query string to find the group containing web maps for display in a gallery of basemaps. This query is intended for use when useVectorBasemaps is false.

Link copied to clipboard
val bingKey: String? = null

the Bing key to use for web maps that use Bing Maps.

Link copied to clipboard

indicates if members of the organization can search outside of the organization. When true, public items, groups and users are included in search queries. When false, no items outside of the organization are included. However, public items which are part of the organization are included.

Link copied to clipboard

indicates if the Bing key can be shared to the public. If the portal is accessed anonymously, this property will always be false.

Link copied to clipboard

indicates if members of the organization can share resources outside of the organization.

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 custom base URL for this portal. This is the portion of the host component of the URL that identifies a specific organization subscription within the portal.

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 containing developer basemaps. This expression can be used as the query string parameter to find the group that contains the developer basemaps of the Portal. Developer basemaps are basemaps that are accessible and metered via API keys. @see Portal.fetchDeveloperBasemaps

Link copied to clipboard

a list of query strings that can be used to find the featured groups for the organization. Each string specifies the title and owner of a group and sometimes also the ID of the group.

Link copied to clipboard

a query string that can be used to find the group containing featured items.

Link copied to clipboard

information about helper services that are provided by the Portal.

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

identifies whether the Portal is multitenant or singletenant.

Link copied to clipboard
val portalName: String? = null

the name of the organization/portal. The character limit is 250.

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

indicates whether OAuth is supported.

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

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

Link copied to clipboard

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

Link copied to clipboard

a query string that can be used to find the group.

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

the current version of the Portal. containing web maps for display in a gallery of vector basemaps. This query is intended for use when useVectorBasemaps is true.

Functions

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

Convert an object to JSON string.