Portal

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.

Properties

Link copied to clipboard

Indicates the type of connection when loading the Portal.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
val url: String
Link copied to clipboard

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

Link copied to clipboard

The version of this Portal.

Inherited properties

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

The load status.

Functions

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

Fetch a list of Basemap as specified by PortalInfo.basemapGalleryGroupQuery

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Finds portal groups that match the given query parameters.

Link copied to clipboard

Finds portal items that match the given query parameters.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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.