Package-level declarations

Types

Link copied to clipboard
@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.

Link copied to clipboard

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().

Link copied to clipboard

An object that represents a portal.

Link copied to clipboard
@Serializable(with = PortalAccessSerializer::class)
sealed class PortalAccess : UnknownStringEncodable

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

Link copied to clipboard
@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.

Link copied to clipboard

Represents a group within a portal.

Link copied to clipboard

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.

Link copied to clipboard
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.

Link copied to clipboard
@Serializable(with = PortalGroupSortFieldSerializer::class)
sealed class PortalGroupSortField : UnknownStringEncodable

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

Link copied to clipboard
@Serializable
data class PortalGroupUsers(val admins: List<String> = listOf(), val users: List<String> = listOf())

Holds the administrators and users for a portal group.

Link copied to clipboard
@Serializable
data class PortalHelperServices : JsonSerializable
Link copied to clipboard
@Serializable
data class PortalInfo : JsonSerializable

A class that contains information about the related Portal.

Link copied to clipboard
@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.

Link copied to clipboard

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

Link copied to clipboard
@Serializable
data class PortalItemGroups

Represents the groups a portal item belongs to.

Link copied to clipboard
@Serializable
data class PortalItemMoveError(val code: Int, val message: String, var itemId: String = "")

An error that happens when moving a portal item.

Link copied to clipboard
@Serializable(with = PortalItemRelationshipSerializer::class)
sealed class PortalItemRelationship : StringEncodable

An enumeration of PortalItem relationship types.

Link copied to clipboard
@Serializable(with = PortalItemRelationshipDirectionSerializer::class)
sealed class PortalItemRelationshipDirection : StringEncodable

An enumeration of PortalItem relationship directions.

Link copied to clipboard
@Serializable(with = PortalItemTypeSerializer::class)
sealed class PortalItemType : UnknownStringEncodable

An enumeration of various types of portal items.

Link copied to clipboard
@Serializable(with = PortalLoginTypeSerializer::class)
sealed class PortalLoginType : UnknownStringEncodable

Signifies the login type for a portal.

Link copied to clipboard
@Serializable(with = PortalModeSerializer::class)
sealed class PortalMode : StringEncodable

Signifies the tenancy mode of a portal.

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable(with = PortalPrivilegeRoleSerializer::class)
sealed class PortalPrivilegeRole : UnknownStringEncodable

Signifies the user role a privilege belongs to.

Link copied to clipboard
@Serializable(with = PortalPrivilegeSubtypeSerializer::class)
sealed class PortalPrivilegeSubtype : UnknownStringEncodable

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

Link copied to clipboard
@Serializable(with = PortalPrivilegeTypeSerializer::class)
sealed class PortalPrivilegeType : UnknownStringEncodable

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

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

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

Link copied to clipboard

Represents the results of queries performed on a Portal.

Link copied to clipboard
@Serializable(with = PortalQuerySortOrderSerializer::class)
sealed class PortalQuerySortOrder : StringEncodable

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

Link copied to clipboard

Represents a registered user of a portal.

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable(with = PortalUserRoleSerializer::class)
sealed class PortalUserRole : UnknownStringEncodable

Signifies the role in the organization of a portal user.

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable
data class SubscriptionInfo(val expiryDate: Instant, val state: SubscriptionState = SubscriptionState.Unknown(""))
Link copied to clipboard
@Serializable(with = SubscriptionStateSerializer::class)
sealed class SubscriptionState : UnknownStringEncodable

State of the user's subscription.