Portal

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

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

Companion

object Companion

Connection

sealed class Connection

The connection type used while loading the Portal.

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

fetchBasemaps

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.

fetchStyles

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.

findGroups

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

Finds portal groups that match the given query parameters.

findItems

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

Finds portal items that match the given query parameters.

load

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

Loads the metadata for the object.

retryLoad

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

Loads or retries loading metadata for the object.

toJson

open override fun toJson(): String

Convert an object to JSON string.

connection

val connection: Portal.Connection

Indicates the type of connection when loading the Portal.

culture

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".

loadStatus