arcgis-maps-kotlin/com.arcgismaps.portal/Portal

Portal

class Portal : Loadable

An object that represents a portal.

See also

PortalItem.portal

Constructors

fun Portal(url: String, connection: Portal.Connection = Connection.Anonymous)

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

Types

object Companion

sealed class Connection

The connection type used while loading the Portal.

Properties

val connection: Portal.Connection

Indicates the type of connection when loading the Portal.

var locale: Locale?

val portalInfo: PortalInfo?

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

val url: String

val user: PortalUser?

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

val version: PortalVersion?

The version of this Portal.

Inherited properties

open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

suspend fun fetchBasemaps(): Result<List<Basemap>>

Fetch a list of Basemap as specified by PortalInfo.basemapGalleryGroupQuery

fetchDeveloperBasemaps

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.

fetchFeaturedGroups

suspend fun fetchFeaturedGroups(): Result<List<PortalGroup>>

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

fetchFeaturedItems

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

fetchHomePageFeaturedContent

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

fetchLicenseInfo

suspend fun fetchLicenseInfo(): Result<LicenseInfo>

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

suspend fun fetchStyles(): Result<List<PortalItem>>

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

fetchSymbolSets

suspend fun fetchSymbolSets(): Result<List<PortalItem>>

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

fetchVectorBasemaps

suspend fun fetchVectorBasemaps(): Result<List<Basemap>>

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

suspend fun findGroups(queryParameters: PortalQueryParameters): Result<PortalQueryResultSet<PortalGroup>>

Finds portal groups that match the given query parameters.

suspend fun findItems(queryParameters: PortalQueryParameters): Result<PortalQueryResultSet<PortalItem>>

Finds portal items that match the given query parameters.

Inherited functions

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.