dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
PortalUser Class
Represents a registered user of the Portal.
ArcGIS Maps SDK for JavaScript
public class PortalUser : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 PortalUser
Constructors
PortalUser() Constructor
Parameterless constructor for use as a Razor Component.
public PortalUser();
PortalUser(Nullable, Nullable, string, string, string, string, Nullable, string, string, IReadOnlyList, string, Nullable, string, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public PortalUser(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserAccess> access=null, System.Nullable<System.DateTime> created=null, string? culture=null, string? description=null, string? email=null, string? fullName=null, System.Nullable<System.DateTime> modified=null, string? orgId=null, string? preferredView=null, System.Collections.Generic.IReadOnlyList<string>? privileges=null, string? region=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserRole> role=null, string? roleId=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserUnits> units=null, string? username=null);
Parameters
access System.Nullable<PortalUserAccess>
Indicates the level of access of the user.
ArcGIS Maps SDK for JavaScript
created System.Nullable<System.DateTime>
The date the user was created.
ArcGIS Maps SDK for JavaScript
culture System.String
The culture information for the user.
ArcGIS Maps SDK for JavaScript
description System.String
A description of the user.
ArcGIS Maps SDK for JavaScript
email System.String
The user’s e-mail address.
ArcGIS Maps SDK for JavaScript
fullName System.String
The user’s full name.
ArcGIS Maps SDK for JavaScript
modified System.Nullable<System.DateTime>
The date the user was last modified.
ArcGIS Maps SDK for JavaScript
orgId System.String
The ID of the organization the user belongs to.
ArcGIS Maps SDK for JavaScript
preferredView System.String
The user’s preferred view for content, either web or GIS.
ArcGIS Maps SDK for JavaScript
privileges System.Collections.Generic.IReadOnlyList<System.String>
The user’s privileges based on their user type or role in their organization.
ArcGIS Maps SDK for JavaScript
region System.String
The user preferred region, used to set the featured maps on the home page,
content in the gallery, and the default extent of new maps in the Viewer.
ArcGIS Maps SDK for JavaScript
role System.Nullable<PortalUserRole>
Defines the user’s role in the organization.
ArcGIS Maps SDK for JavaScript
roleId System.String
The ID of the user’s role.
ArcGIS Maps SDK for JavaScript
units System.Nullable<PortalUserUnits>
The user’s personal units of measure setting.
ArcGIS Maps SDK for JavaScript
username System.String
The username of the user.
ArcGIS Maps SDK for JavaScript
Properties
PortalUser.Access Property
Indicates the level of access of the user.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserAccess> Access { get; set; }
Property Value
System.Nullable<PortalUserAccess>
PortalUser.Created Property
The date the user was created.
ArcGIS Maps SDK for JavaScript
public System.Nullable<System.DateTime> Created { get; set; }
Property Value
System.Nullable<System.DateTime>
PortalUser.Culture Property
The culture information for the user.
ArcGIS Maps SDK for JavaScript
public string? Culture { get; set; }
Property Value
PortalUser.Description Property
A description of the user.
ArcGIS Maps SDK for JavaScript
public string? Description { get; set; }
Property Value
PortalUser.Email Property
The user’s e-mail address.
ArcGIS Maps SDK for JavaScript
public string? Email { get; set; }
Property Value
PortalUser.FullName Property
The user’s full name.
ArcGIS Maps SDK for JavaScript
public string? FullName { get; set; }
Property Value
PortalUser.Modified Property
The date the user was last modified.
ArcGIS Maps SDK for JavaScript
public System.Nullable<System.DateTime> Modified { get; set; }
Property Value
System.Nullable<System.DateTime>
PortalUser.OrgId Property
The ID of the organization the user belongs to.
ArcGIS Maps SDK for JavaScript
public string? OrgId { get; set; }
Property Value
PortalUser.Portal Property
The portal associated with the user.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Portal? Portal { get; set; }
Property Value
PortalUser.PreferredView Property
The user’s preferred view for content, either web or GIS.
ArcGIS Maps SDK for JavaScript
public string? PreferredView { get; set; }
Property Value
PortalUser.Privileges Property
The user’s privileges based on their user type or role in their organization.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? Privileges { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
PortalUser.Region Property
The user preferred region, used to set the featured maps on the home page,
content in the gallery, and the default extent of new maps in the Viewer.
ArcGIS Maps SDK for JavaScript
public string? Region { get; set; }
Property Value
PortalUser.Role Property
Defines the user’s role in the organization.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserRole> Role { get; set; }
Property Value
System.Nullable<PortalUserRole>
PortalUser.RoleId Property
The ID of the user’s role.
ArcGIS Maps SDK for JavaScript
public string? RoleId { get; set; }
Property Value
PortalUser.SourceJSON Property
The JSON used to create the property values when the PortalUser is created.
ArcGIS Maps SDK for JavaScript
public string? SourceJSON { get; set; }
Property Value
PortalUser.ThumbnailUrl Property
The URL to the thumbnail image for the user.
ArcGIS Maps SDK for JavaScript
public string? ThumbnailUrl { get; set; }
Property Value
PortalUser.Units Property
The user’s personal units of measure setting.
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserUnits> Units { get; set; }
Property Value
System.Nullable<PortalUserUnits>
PortalUser.UserContentUrl Property
The URL for the user’s content.
ArcGIS Maps SDK for JavaScript
public string? UserContentUrl { get; set; }
Property Value
PortalUser.Username Property
The username of the user.
ArcGIS Maps SDK for JavaScript
public string? Username { get; set; }
Property Value
Methods
PortalUser.AddItem(PortalItem, string, string) Method
Adds an item to the user’s portal content.
param params.item The item to add to the user’s content.
param params.folder The portal folder in which to store the item.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> AddItem(dymaptic.GeoBlazor.Core.Components.PortalItem item, string data, string folder);
Parameters
item PortalItem
The item to add to the user’s content.
ArcGIS Maps SDK for JavaScript
data System.String
The component used to stream the data represented by the item to the client.
ArcGIS Maps SDK for JavaScript
folder System.String
The portal folder in which to store the item.
ArcGIS Maps SDK for JavaScript
Returns
System.Threading.Tasks.Task<PortalItem>
PortalUser.AddToPrivileges(string[]) Method
Asynchronously adds elements to the Privileges property.
public System.Threading.Tasks.Task AddToPrivileges(params string[] values);
Parameters
values System.String[]
The elements to add.
Returns
PortalUser.DeleteItem(PortalItem, bool) Method
Deletes an item from the user’s portal content.
param permanentDelete *Since 4.30.When the recycle bin is enabled and the item to be deleted is an item type supported by the recycle bin, this parameter determines if the item should be permanently deleted. If true, the item will be permanently deleted. Otherwise, the item will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If the item is not supported by the recycle bin, it will be permanently deleted regardless of the value of this parameter.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> DeleteItem(dymaptic.GeoBlazor.Core.Components.PortalItem item, bool permanentDelete);
Parameters
item PortalItem
The portal item to remove.
permanentDelete System.Boolean
Since 4.30. When the recycle bin is enabled and the item to be deleted is an item type supported by the recycle bin, this parameter determines if the item should be permanently deleted. If
true
```, the item will be permanently deleted. Otherwise, the item will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If the item is not supported by the recycle bin, it will be permanently deleted regardless of the value of this parameter.
#### Returns
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
<a name='dymaptic.GeoBlazor.Core.Components.PortalUser.DeleteItems(System.Collections.Generic.IReadOnlyCollection_dymaptic.GeoBlazor.Core.Components.PortalItem_,bool)'></a>
## PortalUser.DeleteItems(IReadOnlyCollection<PortalItem>, bool) Method
Deletes items from the user's portal content.
param permanentDelete **Since 4.30.*When the <a target="_blank" href="https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html#recycleBinEnabled">recycle bin is enabled</a> and the items to be deleted are item types supported by the recycle bin, this parameter determines if the items should be permanently deleted. If `true`, the items will be permanently deleted. Otherwise, the items will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If items are not supported by the recycle bin, they will be permanently deleted regardless of the value of this parameter.
<a target="_blank" href="https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#deleteItems">ArcGIS Maps SDK for JavaScript</a>
```csharp
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.DeleteItemsResult[]?> DeleteItems(System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.PortalItem> items, bool permanentDelete);
Parameters
items System.Collections.Generic.IReadOnlyCollection<PortalItem>
The portal items to remove.
permanentDelete System.Boolean
Since 4.30. When the recycle bin is enabled and the items to be deleted are item types supported by the recycle bin, this parameter determines if the items should be permanently deleted. If
true
```, the items will be permanently deleted. Otherwise, the items will be moved to the recycle bin. If the recycle bin is disabled, this parameter has no effect. If items are not supported by the recycle bin, they will be permanently deleted regardless of the value of this parameter.
#### Returns
[System.Threading.Tasks.Task<](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')[DeleteItemsResult](dymaptic.GeoBlazor.Core.Results.DeleteItemsResult.html 'dymaptic.GeoBlazor.Core.Results.DeleteItemsResult')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task`1')
<a name='dymaptic.GeoBlazor.Core.Components.PortalUser.FetchFolders()'></a>
## PortalUser.FetchFolders() Method
Fetches all of the user's folders used to organize portal content.
<a target="_blank" href="https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalUser.html#fetchFolders">ArcGIS Maps SDK for JavaScript</a>
```csharp
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalFolder[]?> FetchFolders();
Returns
System.Threading.Tasks.Task<PortalFolder[]>
PortalUser.FetchGroups() Method
Fetches all the groups that the portal user has permission to access.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.PortalGroup[]?> FetchGroups();
Returns
System.Threading.Tasks.Task<PortalGroup[]>
PortalUser.FetchItems(PortalFolder, bool, bool, double, string, OrderBy, double) Method
Retrieves all the items in either the user’s root folder or the specified folder.
param params.folder The folder to retrieve items from. When folder is not specified, the includeSubfolderItems parameter can be used to include items from subfolders.
param params.includeSubfolderItems Option to include items from subfolders along with items in the root folder. This parameter does not apply when the folder parameter is specified.
param params.sortField A comma-delimited list of fields to sort by. Allowed values are created, modified, size, and type.
param params.start The index of the first entry in the result set response. The index is 1-based.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.FetchItemsResult?> FetchItems(dymaptic.GeoBlazor.Core.Components.PortalFolder folder, bool inRecycleBin, bool includeSubfolderItems, double num, string sortField, dymaptic.GeoBlazor.Core.Enums.OrderBy sortOrder, double start);
Parameters
folder PortalFolder
The folder to retrieve items from.
ArcGIS Maps SDK for JavaScript
inRecycleBin System.Boolean
Option to retrieve items from the recycle bin instead.
ArcGIS Maps SDK for JavaScript
includeSubfolderItems System.Boolean
Option to include items from subfolders along with items in the root folder.
ArcGIS Maps SDK for JavaScript
num System.Double
The maximum number of results to be included in the result set response.
default 10
ArcGIS Maps SDK for JavaScript
sortField System.String
A comma-delimited list of fields to sort by.
default created
ArcGIS Maps SDK for JavaScript
sortOrder OrderBy
The order in which to sort the results.
default asc
ArcGIS Maps SDK for JavaScript
start System.Double
The index of the first entry in the result set response.
default 1
ArcGIS Maps SDK for JavaScript
Returns
System.Threading.Tasks.Task<FetchItemsResult>
PortalUser.FetchTags() Method
Fetches the tag objects that have been created by the portal user.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string[]?> FetchTags();
Returns
System.Threading.Tasks.Task<System.String[]>
PortalUser.GetAccess() Method
Asynchronously retrieve the current value of the Access property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserAccess>> GetAccess();
Returns
System.Threading.Tasks.Task<System.Nullable<PortalUserAccess>>
PortalUser.GetCreated() Method
Asynchronously retrieve the current value of the Created property.
public System.Threading.Tasks.Task<System.Nullable<System.DateTime>> GetCreated();
Returns
System.Threading.Tasks.Task<System.Nullable<System.DateTime>>
PortalUser.GetCulture() Method
Asynchronously retrieve the current value of the Culture property.
public System.Threading.Tasks.Task<string?> GetCulture();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetDescription() Method
Asynchronously retrieve the current value of the Description property.
public System.Threading.Tasks.Task<string?> GetDescription();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetEmail() Method
Asynchronously retrieve the current value of the Email property.
public System.Threading.Tasks.Task<string?> GetEmail();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetFullName() Method
Asynchronously retrieve the current value of the FullName property.
public System.Threading.Tasks.Task<string?> GetFullName();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetModified() Method
Asynchronously retrieve the current value of the Modified property.
public System.Threading.Tasks.Task<System.Nullable<System.DateTime>> GetModified();
Returns
System.Threading.Tasks.Task<System.Nullable<System.DateTime>>
PortalUser.GetOrgId() Method
Asynchronously retrieve the current value of the OrgId property.
public System.Threading.Tasks.Task<string?> GetOrgId();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetPreferredView() Method
Asynchronously retrieve the current value of the PreferredView property.
public System.Threading.Tasks.Task<string?> GetPreferredView();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetPrivileges() Method
Asynchronously retrieve the current value of the Privileges property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetPrivileges();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
PortalUser.GetRegion() Method
Asynchronously retrieve the current value of the Region property.
public System.Threading.Tasks.Task<string?> GetRegion();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetRole() Method
Asynchronously retrieve the current value of the Role property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserRole>> GetRole();
Returns
System.Threading.Tasks.Task<System.Nullable<PortalUserRole>>
PortalUser.GetRoleId() Method
Asynchronously retrieve the current value of the RoleId property.
public System.Threading.Tasks.Task<string?> GetRoleId();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetSourceJSON() Method
Asynchronously retrieve the current value of the SourceJSON property.
public System.Threading.Tasks.Task<string?> GetSourceJSON();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetThumbnailUrl(int) Method
Get the URL to the thumbnail image for the user.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> GetThumbnailUrl(int width);
Parameters
width System.Int32
The desired image width.
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetUnits() Method
Asynchronously retrieve the current value of the Units property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserUnits>> GetUnits();
Returns
System.Threading.Tasks.Task<System.Nullable<PortalUserUnits>>
PortalUser.GetUserContentUrl() Method
Asynchronously retrieve the current value of the UserContentUrl property.
public System.Threading.Tasks.Task<string?> GetUserContentUrl();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.GetUsername() Method
Asynchronously retrieve the current value of the Username property.
public System.Threading.Tasks.Task<string?> GetUsername();
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.QueryFavorites(PortalQueryParams) Method
Executes a query against the user’s favorite group to return an array of PortalItem
objects that match the input query.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.PortalQueryResult?> QueryFavorites(dymaptic.GeoBlazor.Core.Model.PortalQueryParams queryParams);
Parameters
queryParams PortalQueryParams
The input query parameters defined in PortalQueryParams. This object may be autocast.
Returns
System.Threading.Tasks.Task<PortalQueryResult>
PortalUser.RemoveFromPrivileges(string[]) Method
Asynchronously remove an element from the Privileges property.
public System.Threading.Tasks.Task RemoveFromPrivileges(params string[] values);
Parameters
values System.String[]
The elements to remove.
Returns
PortalUser.RestoreItem(PortalItem, PortalFolder) Method
Restores an item from the user’s recycle bin to their content.
param folder The folder to restore the item to. If not specified, the item will be restored to the root folder. If an invalid folder is specified, an error will be returned and the item will not be restored.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> RestoreItem(dymaptic.GeoBlazor.Core.Components.PortalItem item, dymaptic.GeoBlazor.Core.Components.PortalFolder folder);
Parameters
item PortalItem
The portal item to restore.
folder PortalFolder
The folder to restore the item to. If not specified, the item will be restored to the root folder.
If an invalid folder is specified, an error will be returned and the item will not be restored.
Returns
System.Threading.Tasks.Task<System.String>
PortalUser.SetAccess(Nullable) Method
Asynchronously set the value of the Access property after render.
public System.Threading.Tasks.Task SetAccess(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserAccess> value);
Parameters
value System.Nullable<PortalUserAccess>
The value to set.
Returns
PortalUser.SetCreated(Nullable) Method
Asynchronously set the value of the Created property after render.
public System.Threading.Tasks.Task SetCreated(System.Nullable<System.DateTime> value);
Parameters
value System.Nullable<System.DateTime>
The value to set.
Returns
PortalUser.SetCulture(string) Method
Asynchronously set the value of the Culture property after render.
public System.Threading.Tasks.Task SetCulture(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetDescription(string) Method
Asynchronously set the value of the Description property after render.
public System.Threading.Tasks.Task SetDescription(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetEmail(string) Method
Asynchronously set the value of the Email property after render.
public System.Threading.Tasks.Task SetEmail(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetFullName(string) Method
Asynchronously set the value of the FullName property after render.
public System.Threading.Tasks.Task SetFullName(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetModified(Nullable) Method
Asynchronously set the value of the Modified property after render.
public System.Threading.Tasks.Task SetModified(System.Nullable<System.DateTime> value);
Parameters
value System.Nullable<System.DateTime>
The value to set.
Returns
PortalUser.SetOrgId(string) Method
Asynchronously set the value of the OrgId property after render.
public System.Threading.Tasks.Task SetOrgId(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetPreferredView(string) Method
Asynchronously set the value of the PreferredView property after render.
public System.Threading.Tasks.Task SetPreferredView(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetPrivileges(IReadOnlyList) Method
Asynchronously set the value of the Privileges property after render.
public System.Threading.Tasks.Task SetPrivileges(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
PortalUser.SetRegion(string) Method
Asynchronously set the value of the Region property after render.
public System.Threading.Tasks.Task SetRegion(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetRole(Nullable) Method
Asynchronously set the value of the Role property after render.
public System.Threading.Tasks.Task SetRole(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserRole> value);
Parameters
value System.Nullable<PortalUserRole>
The value to set.
Returns
PortalUser.SetRoleId(string) Method
Asynchronously set the value of the RoleId property after render.
public System.Threading.Tasks.Task SetRoleId(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.SetUnits(Nullable) Method
Asynchronously set the value of the Units property after render.
public System.Threading.Tasks.Task SetUnits(System.Nullable<dymaptic.GeoBlazor.Core.Enums.PortalUserUnits> value);
Parameters
value System.Nullable<PortalUserUnits>
The value to set.
Returns
PortalUser.SetUsername(string) Method
Asynchronously set the value of the Username property after render.
public System.Threading.Tasks.Task SetUsername(string? value);
Parameters
value System.String
The value to set.
Returns
PortalUser.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()