Show / Hide Table of Contents

Class PortalUser

Represents a registered user of the portal. Personal details of the user, such as email and groups, are returned only to the user or the administrator of the user's organization. A user is not visible to any other users (except their organization's administrator) if their access setting is set to 'private'.

Inheritance
Object
PortalUser
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Esri.ArcGISRuntime.Portal
Assembly: Esri.ArcGISRuntime.dll
Syntax
[DataContract]
public sealed class PortalUser

Properties

Name Description
Access

Gets the access level for the user : private, organization or public. If Private , the users descriptive information will not be available and the user name will not be searchable. If Organization, only members of the organization can search for the user and the user's content.

Created

Gets the date and time the user was created.

Culture

Gets the default culture for the user.

Email

Gets the email of the user.

FavoritesGroupId

Gets the user's favorites group that is created automatically for each user.

FullName

Gets the full name of the user.

Groups

Gets the collection of groups the user belongs to.

Modified

Gets the date and time the user was last modified.

OrganizationId

Gets the id of the organization the user belongs to.

Portal

Gets the ArcGIS portal.

Privileges

Gets the fine-grained portal privileges possessed by this user.

Role

Gets the user's role in the organization : administrator, publisher or user.

Tags

Gets the words or short phrases that describe the user.

ThumbnailUri

Gets the URI of the thumbnail image used for the user.

UnitSystem

Gets the user defined unit system for measurement.

UserDescription

Gets the description or profile of the user.

UserName

Gets the name of the user.

Methods

Name Description
AddPortalItemAsync(PortalItem)

Adds an item without content asynchronously. This operation is available only to authenticated users.

AddPortalItemAsync(PortalItem, PortalItemContentParameters)

Adds an item with content asynchronously. This operation is available only to authenticated users.

AddPortalItemAsync(PortalItem, PortalItemContentParameters, PortalFolder)

Adds an item with or without content asynchronously. This operation is available only to authenticated users.

AddPortalItemAsync(PortalItem, PortalItemContentParameters, PortalFolder, CancellationToken)

Adds an item with or without content asynchronously. This operation is available only to authenticated users.

AddToFavoritesAsync(PortalItem)

Adds the given item to the user's favorites group.

AddToFavoritesAsync(PortalItem, CancellationToken)

Adds the given item to the user's favorites group.

CreateAsync(ArcGISPortal, String)

Initializes a new instance of the PortalUser class from the specified username.

CreateAsync(ArcGISPortal, String, CancellationToken)

Initializes a new instance of the PortalUser class from the specified username.

CreateFolderAsync(String)

Creates a new folder with the given title in this user's root folder (nested folders are not supported).

CreateFolderAsync(String, CancellationToken)

Creates a new folder with the given title in this user's root folder (nested folders are not supported).

DeleteFolderAsync(PortalFolder)

Deletes the specified folder from the portal. The folder must belong to this user. Deleting a folder also deletes all items that it contains.

DeleteFolderAsync(PortalFolder, CancellationToken)

Deletes the specified folder from the portal. The folder must belong to this user. Deleting a folder also deletes all items that it contains.

DeletePortalItemAsync(PortalItem)

Deletes a specified portal item asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

DeletePortalItemAsync(PortalItem, CancellationToken)

Deletes a specified portal item asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

GetContentAsync()

Gets the folders and items that are stored at the user's root folder.

GetContentAsync(String)

Gets portal items stored in the specified folder belonging to this user.

GetContentAsync(String, CancellationToken)

Gets portal items stored in the specified folder belonging to this user.

GetContentAsync(CancellationToken)

Gets the folders and items that are stored at the user's root folder.

GetFavoritesStatusAsync(PortalItem)

Determines whether the given item is in the user's favorites group.

GetFavoritesStatusAsync(PortalItem, CancellationToken)

Determines whether the given item is in the user's favorites group.

GetThumbnailDataAsync()

Get the thumbnail image data for this portal user.

GetThumbnailDataAsync(CancellationToken)

Get the thumbnail image data for this portal user.

MovePortalItemAsync(PortalItem, PortalFolder)

Moves the given portal item to the specified folder asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

MovePortalItemAsync(PortalItem, PortalFolder, CancellationToken)

Moves the given portal item to the specified folder asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

MovePortalItemsAsync(IEnumerable<PortalItem>, PortalFolder)

Moves the given portal items to the specified folder asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

MovePortalItemsAsync(IEnumerable<PortalItem>, PortalFolder, CancellationToken)

Moves the given portal items to the specified folder asynchronously. Available to the item's owner and the administrator of the organization to which the owner belongs.

RemoveFromFavoritesAsync(PortalItem)

Removes the given item from the user's favorites group.

RemoveFromFavoritesAsync(PortalItem, CancellationToken)

Removes the given item from the user's favorites group.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 Android200
.NET 6.0 iOS200
.NET Framework100.0 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.0 - 100.15
iOS100.0 - 100.15
UWP100.0 - 200.0
In This Article
Back to top Copyright © 2022 Esri.