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

PortalUser

class PortalUser : JsonSerializable, Loadable

Represents a registered user of a portal.

Since

200.0.0

Constructors

constructor(portal: Portal, username: String)

Constructs a PortalUser with the given Portal and user name.

Types

object Companion

Properties

val access: PortalAccess?

The access level of this user, which determines who can access the user descriptive information.

assignedCredits

val assignedCredits: Double?

The number of credits allocated to the user.

availableCredits

val availableCredits: Double?

The number of credits available to the user.

val categories: List<String>

The member categories that the user is assigned to.

val creationDate: Instant?

The date this user was created.

val description: String

The description of this user.

val email: String

The email address of this user.

favoritesGroupId

val favoritesGroupId: String

The ID of the favorites group for this user.

val firstName: String

The first name of this user.

val fullName: String

The full name of this user.

val groups: List<PortalGroup>

A list of the groups this user belongs to. The resultant PortalGroup objects are fully populated and have a load status of com.arcgismaps.LoadStatus.Loaded. An empty list is returned if this PortalUser is not yet loaded.

val lastName: String

The last name of this user.

modificationDate

val modificationDate: Instant?

The date on which this user was last modified.

val organizationId: String

The ID of the organization to which the user belongs, empty if none.

val portal: Portal

the Portal in which this user exists

val privileges: List<PortalPrivilege>

A list of PortalPrivileges defining the fine-grained privileges possessed by this user.

val role: PortalUserRole?

The role in the organization of this user.

val tags: List<String>

A list of the tags associated with this user.

val thumbnail: LoadableImage?

The thumbnail for this user.

val units: UnitSystem?

The preferred units of measurement for this user.

userDefinedName

@ArcGISMapsApiExperimental

val userDefinedName: String?

The user defined name or null if not specified.

val userId: String?

The ID of this user or null if not specified.

val username: String

the username of the PortalUser

Inherited properties

open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

suspend fun addPortalItem(portalItem: PortalItem, contentParameters: PortalItemContentParameters, portalFolder: PortalFolder? = null): Result<Unit>

Adds the specified item to the portal in the given folder.

suspend fun addToFavorites(portalItem: PortalItem): Result<Unit>

Adds the item to the favorites group.

suspend fun createFolder(title: String): Result<PortalFolder>

Creates a new folder with the given title in the user's root folder. Nested folders are not supported and two folders that belong to the same user cannot have the same title.

suspend fun deleteFolder(folder: PortalFolder): Result<Unit>

Deletes the specified folder from the portal. The folder must belong to this user. Deleting a folder deletes all the items that it contains. The user's root folder is not deletable.

deletePortalItem

suspend fun deletePortalItem(portalItem: PortalItem): Result<Unit>

Deletes the specified item from the portal.

suspend fun fetchContent(): Result<PortalUserContent>

Fetches content from this user's root folder.

fetchContentInFolder

suspend fun fetchContentInFolder(folderId: String): Result<List<PortalItem>>

Fetches content from a specific folder belonging to this user.

fetchFavoritesStatus

suspend fun fetchFavoritesStatus(portalItem: PortalItem): Result<Boolean>

Fetches the favorite status for the portal item.

suspend fun movePortalItem(portalItem: PortalItem, toFolder: PortalFolder? = null): Result<Unit>

Moves the specified item to the specified folder.

movePortalItems

suspend fun movePortalItems(portalItems: Iterable<PortalItem>, toFolder: PortalFolder? = null): Result<List<PortalItemMoveError>>

Moves the specified items to the specified folder.

removeFromFavorites

suspend fun removeFromFavorites(portalItem: PortalItem): Result<Unit>

Removes the portal item from the favorites group.

open override fun toJson(): String

Convert an object to JSON string.

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.