Portal

class Portal : JsonSerializable, Loadable

An object that represents a portal.

See also

Constructors

Link copied to clipboard
fun Portal(url: String, connection: Portal.Connection = Connection.Anonymous)

Creates a portal object. Use this constructor to create a portal from an URL.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
sealed class Connection

The connection type used while loading the Portal.

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
suspend fun fetchBasemaps(): Result<List<Basemap>>

Fetch a list of Basemap as specified by PortalInfo.basemapGalleryGroupQuery

Link copied to clipboard
suspend fun fetchDeveloperBasemaps(): Result<List<Basemap>>

Executes a portal query to fetch the developer basemaps for this portal. A Portal instance may contain a set of associated basemaps, called developer basemaps, which are accessible and metered via API keys. These are equivalent to basemaps constructed via a com.arcgismaps.mapping.BasemapStyle.

Link copied to clipboard
suspend fun fetchFeaturedGroups(): Result<List<PortalGroup>>

Executes a portal query to fetch the featured groups for the organization.

Link copied to clipboard
suspend fun fetchFeaturedItems(): Result<List<PortalItem>>

Executes a request to fetch the featured items for this Portal. The items will have a LoadStatus of LoadStatus.Loaded

Link copied to clipboard
suspend fun fetchHomePageFeaturedContent(): Result<List<PortalItem>>

Executes a request to fetch the homepage featured item content for this Portal. The items will have a LoadStatus of LoadStatus.Loaded

Link copied to clipboard
suspend fun fetchLicenseInfo(): Result<LicenseInfo>

Executes a portal query that gets the current user's LicenseInfo including the entitlements and extensions.

Link copied to clipboard
suspend fun fetchStyles(): Result<List<PortalItem>>

Executes a portal query with the PortalInfo.stylesGroupQuery query string.

Link copied to clipboard
suspend fun fetchSymbolSets(): Result<List<PortalItem>>

Executes a portal query with the PortalInfo.symbolSetsGroupQuery query string.

Link copied to clipboard
suspend fun fetchVectorBasemaps(): Result<List<Basemap>>

Executes a portal query with the PortalInfo.vectorBasemapGalleryGroupQuery query string.

Link copied to clipboard
suspend fun findGroups(queryParameters: PortalQueryParameters): Result<PortalQueryResultSet<PortalGroup>>

Finds portal groups that match the given query parameters.

Link copied to clipboard
suspend fun findItems(queryParameters: PortalQueryParameters): Result<PortalQueryResultSet<PortalItem>>

Finds portal items that match the given query parameters.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

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

Convert an object to JSON string.

Properties

Link copied to clipboard
val connection: Portal.Connection

Indicates the type of connection when loading the Portal.

Link copied to clipboard
var culture: String?

A code that specifies the culture-specific formatting to use when accessing Portal content. The culture code provides localized content when viewing featured groups or items, adding or updating an item, adding a comment or rating to an item, and so on. If not explicitly set, the culture used by the device/machine is used. If the culture is not supported by the portal or set to null, the culture specified in the portal/organization settings is used. The format for culture code is based on a language code and a country code separated by a dash. Example: "en-US".

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard
val portalInfo: PortalInfo?

The PortalInfo object for this portal, or null if the portal is not loaded yet.

Link copied to clipboard
open override val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by this API.

Link copied to clipboard
open override val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through this API.

Link copied to clipboard
val url: String
Link copied to clipboard
val user: PortalUser?

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

Link copied to clipboard
val version: PortalVersion?

The version of this Portal.