arcgis-maps-kotlin/com.arcgismaps.portal

Package-level declarations

Types

@Serializable

data class ElevationServiceInfo(val id: String, val layerType: String, val url: String)

Represents a Limited Error Raster Compression (LERC) elevation service that is provided by the portal. Objects of this class are provided by PortalHelperServices.defaultElevationServices.

LoadableImage

class LoadableImage : Loadable

An object that represents a loadable image. A loadable image implements the loadable pattern (Loadable) and allows getting the underlying image (through LoadableImage.getImage()) once the image is loaded. For LocalItem thumbnail, the image is read from JSON and is automatically loaded. For PortalItem thumbnail, the loadable image is initialized with the thumbnail URI and needs to be loaded before calling LoadableImage.getImage().

Portal

class Portal : Loadable

The entry point into the ArcGIS portal services hosted by ArcGIS Online and ArcGIS Enterprise. ArcGIS portals are geospatial content management systems from ESRI that customers can use to securely store, manage, and access different types of content. There are two types of portals:

PortalAccess

@Serializable(with = PortalAccessSerializer::class)

sealed class PortalAccess : UnknownStringEncodable

Indicates the level of access to this portal object: private, shared, organization, or public.

PortalFolder

@Serializable

data class PortalFolder(val folderId: String, val username: String, val title: String, val creationDate: Instant? = null)

Represents a folder of content within the portal or organization. A user's content in a portal can be organized into folders.

PortalGroup

data class PortalGroup : Loadable, JsonSerializable

Represents a group within a portal.

PortalGroupContentSearchParameters

class PortalGroupContentSearchParameters

Contains search parameters suitable for finding portal items that belong to a portal group. You can create an instance using one of the factory methods that are designed for particular types of searches, or you can use one of the constructors and specify a custom query string. A number of properties are also available to customize various aspects of the search.

PortalGroupContentSearchResultSet

data class PortalGroupContentSearchResultSet(val searchParameters: PortalGroupContentSearchParameters, val nextSearchParameters: PortalGroupContentSearchParameters? = null, val totalResults: Int = 0, val results: List<PortalItem> = listOf())

Represents the results of a Group Content Search operation performed on a PortalGroup.

PortalGroupSortField

@Serializable(with = PortalGroupSortFieldSerializer::class)

sealed class PortalGroupSortField : UnknownStringEncodable

Signifies the field by which items in a portal group are sorted.

PortalGroupUsers

@Serializable

data class PortalGroupUsers(val admins: List<String> = listOf(), val users: List<String> = listOf())

Holds the administrators and users for a portal group.

PortalHelperServices

@Serializable

data class PortalHelperServices : JsonSerializable

PortalInfo

@Serializable

data class PortalInfo : JsonSerializable

A class that contains information about the related Portal.

PortalItemComment

@Serializable

data class PortalItemComment(val comment: String, val owner: String, val created: Instant, val commentId: String)

Holds the content of a comment on a portal item.

PortalItemContentParameters

sealed class PortalItemContentParameters

Specifies the content for a new portal item to be added.

PortalItemGroups

@Serializable

data class PortalItemGroups

Represents the groups a portal item belongs to.

PortalItemMoveError

@Serializable

data class PortalItemMoveError(val code: Int, val message: String, var itemId: String = "")

An error that happens when moving a portal item.

PortalItemRelationship

@Serializable(with = PortalItemRelationshipSerializer::class)

sealed class PortalItemRelationship : StringEncodable

An enumeration of PortalItem relationship types.

PortalItemRelationshipDirection

@Serializable(with = PortalItemRelationshipDirectionSerializer::class)

sealed class PortalItemRelationshipDirection : StringEncodable

An enumeration of PortalItem relationship directions.

PortalItemType

@Serializable(with = PortalItemTypeSerializer::class)

sealed class PortalItemType : UnknownStringEncodable

An enumeration of various types of portal items.

PortalLoginType

@Serializable(with = PortalLoginTypeSerializer::class)

sealed class PortalLoginType : UnknownStringEncodable

Signifies the login type for a portal.

PortalMode

@Serializable(with = PortalModeSerializer::class)

sealed class PortalMode : StringEncodable

Signifies the tenancy mode of a portal.

PortalPrivilege

@Serializable(with = PortalPrivilegeSerializer::class)

class PortalPrivilege(val realm: PortalPrivilegeRealm, val role: PortalPrivilegeRole, val type: PortalPrivilegeType, val subtype: PortalPrivilegeSubtype = PortalPrivilegeSubtype.None)

A portal user privilege. A privilege permits the user to perform specific operations on the portal.

PortalPrivilegeRealm

@Serializable(with = PortalPrivilegeRealmSerializer::class)

sealed class PortalPrivilegeRealm : UnknownStringEncodable

Signifies the realm a privilege belongs to. Helps to organize privileges into categories for aspects relating to a portal.

PortalPrivilegeRole

@Serializable(with = PortalPrivilegeRoleSerializer::class)

sealed class PortalPrivilegeRole : UnknownStringEncodable

Signifies the user role a privilege belongs to.

PortalPrivilegeSubtype

@Serializable(with = PortalPrivilegeSubtypeSerializer::class)

sealed class PortalPrivilegeSubtype : UnknownStringEncodable

An enumeration of the fine-grained operation subtypes a portal privilege can permit.

PortalPrivilegeType

@Serializable(with = PortalPrivilegeTypeSerializer::class)

sealed class PortalPrivilegeType : UnknownStringEncodable

An enumeration of the types of operation a portal privilege can permit.

PortalQueryParameters

class PortalQueryParameters(query: String = "", var boundingBox: Envelope? = null, var limit: Int = 10)

Defines a query to find contents or groups contained in a portal.

PortalQueryResultSet

data class PortalQueryResultSet<T>

Represents the results of queries performed on a Portal.

PortalQuerySortOrder

@Serializable(with = PortalQuerySortOrderSerializer::class)

sealed class PortalQuerySortOrder : StringEncodable

Signifies the sort order, indicating whether results are returned in ascending or descending order.

PortalUser

class PortalUser : JsonSerializable, Loadable

Represents a registered user of a portal.

PortalUserContent

@Serializable

data class PortalUserContent(val username: String, val currentFolder: PortalFolder? = null, val items: List<PortalItem> = listOf(), val folders: List<PortalFolder> = listOf())

Represents user content in a folder. This can include portal items and subfolders.

PortalUserRole

@Serializable(with = PortalUserRoleSerializer::class)

sealed class PortalUserRole : UnknownStringEncodable

Signifies the role in the organization of a portal user.

PortalVersion

@Serializable(with = PortalVersionTransformingSerializer::class)

data class PortalVersion(val major: Int, val minor: Int, val patch: Int = 0)

A three part version number with a major version, a minor version, and a patch version.

SubscriptionInfo

@Serializable

data class SubscriptionInfo(val expiryDate: Instant, val state: SubscriptionState = SubscriptionState.Unknown(""))

SubscriptionState

@Serializable(with = SubscriptionStateSerializer::class)

sealed class SubscriptionState : UnknownStringEncodable

State of the user's subscription.