PortalUser

class PortalUser : JsonSerializable, Loadable

Represents a registered user of a portal.

Since

200.0.0

Constructors

Link copied to clipboard
fun PortalUser(portal: Portal, username: String)

Constructs a PortalUser with the given Portal and user name.

Types

Link copied to clipboard
object Companion

Functions

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

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

Link copied to clipboard
suspend fun addToFavorites(portalItem: PortalItem): Result<Unit>

Adds the item to the favorites group.

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

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

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

Link copied to clipboard
suspend fun deletePortalItem(portalItem: PortalItem): Result<Unit>

Deletes the specified item from the portal.

Link copied to clipboard
suspend fun fetchContent(): Result<PortalUserContent>

Fetches content from this user's root folder.

Link copied to clipboard
suspend fun fetchContentInFolder(folderId: String): Result<List<PortalItem>>

Fetches content from a specific folder belonging to this user.

Link copied to clipboard
suspend fun fetchFavoritesStatus(portalItem: PortalItem): Result<Boolean>

Fetches the favorite status for the portal item.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

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

Moves the specified item to the specified folder.

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

Moves the specified items to the specified folder.

Link copied to clipboard
suspend fun removeFromFavorites(portalItem: PortalItem): Result<Unit>

Removes the portal item from the favorites group.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.

Properties

Link copied to clipboard
val access: PortalAccess?

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

Link copied to clipboard
val creationDate: Instant?

The date this user was created.

Link copied to clipboard
val description: String

The description of this user.

Link copied to clipboard
val email: String

The email address of this user.

Link copied to clipboard
val favoritesGroupId: String

The ID of the favorites group for this user.

Link copied to clipboard
val fullName: String

The full name of this user.

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

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard
val modificationDate: Instant?

The date on which this user was last modified.

Link copied to clipboard
val organizationId: String

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

Link copied to clipboard
val portal: Portal

the Portal in which this user exists

Link copied to clipboard
val privileges: List<PortalPrivilege>

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

Link copied to clipboard
val role: PortalUserRole?

The role in the organization of this user.

Link copied to clipboard
val tags: List<String>

A list of the tags associated with this user.

Link copied to clipboard
val thumbnail: LoadableImage?

The thumbnail for this user.

Link copied to clipboard
val units: UnitSystem?

The preferred units of measurement for this user.

Link copied to clipboard
open override val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by this API.

Link copied to clipboard
open override val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through this API.

Link copied to clipboard
val username: String

the username of the PortalUser