PortalUser
esri/portal/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. View the ArcGIS Portal API REST documentation for the user for more details.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | Indicates the level of access of the user. more details | more details | PortalUser | |
Date | The date the user was created. more details | more details | PortalUser | |
String | The culture information for the user. more details | more details | PortalUser | |
String | The name of the class. more details | more details | Accessor | |
String | A description of the user. more details | more details | PortalUser | |
String | The user's e-mail address. more details | more details | PortalUser | |
String | The user's full name. more details | more details | PortalUser | |
Date | The date the user was last modified. more details | more details | PortalUser | |
String | The ID of the organization the user belongs to. more details | more details | PortalUser | |
Portal | The portal associated with the user. more details | more details | PortalUser | |
String | The user's preferred view for content, either web or GIS. more details | more details | PortalUser | |
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. more details | more details | PortalUser | |
String | Defines the user's role in the organization. more details | more details | PortalUser | |
String | The ID of the user's role. more details | more details | PortalUser | |
Object | The JSON used to create the property values when the | more details | PortalUser | |
String | The URL to the thumbnail image for the user. more details | more details | PortalUser | |
String | The user's personal units of measure setting. more details | more details | PortalUser | |
String | The URL for the user's content. more details | more details | PortalUser | |
String | The username of the user. more details | more details | PortalUser |
Property Details
- access String
Indicates the level of access of the user. If private, the user descriptive information will not be available to others nor will the username be searchable.
Possible Values:"private"|"org"|"public"
- created Date
The date the user was created.
- culture String
The culture information for the user.
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- description String
A description of the user.
- email String
The user's e-mail address.
- fullName String
The user's full name.
- modified Date
The date the user was last modified.
- orgId String
The ID of the organization the user belongs to.
- portal Portal
The portal associated with the user.
- preferredView String
The user's preferred view for content, either web or GIS.
- region 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.
- role String
Defines the user's role in the organization. See roleId for more details about when user has a custom role.
Possible Values:"org_admin"|"org_publisher"|"org_user"
- roleId String
The ID of the user's role. Only set if the user is assigned a custom role.
When present, the role will indicate the "base" role of the custom role based on the privileges the custom role contains. For example, if the custom role contains some publisher privileges, the role will be set to
org_publisher
.
- sourceJSON ObjectSince: ArcGIS API for JavaScript 4.13
The JSON used to create the property values when the
PortalUser
is created. Although most commonly used properties are exposed on thePortalUser
class directly, this provides access to all information returned for the portal user. This property is useful if working in an application built using an older version of the API which requires access to a portal's user properties from a more recent version.- See also:
- thumbnailUrl Stringreadonly
The URL to the thumbnail image for the user.
- See also:
- userContentUrl Stringreadonly
The URL for the user's content.
- username String
The username of the user.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Promise<PortalItem> | Adds an item to the user's portal content. more details | more details | PortalUser | |
Promise | Deletes an item from the user's portal content. more details | more details | PortalUser | |
Promise | Deletes items from the user's portal content. more details | more details | PortalUser | |
Promise<PortalFolder[]> | Fetches all of the user's folders used to organize portal content. more details | more details | PortalUser | |
Promise<PortalGroup[]> | Fetches all the groups that the portal user has permission to access. more details | more details | PortalUser | |
Promise<Object> | Retrieves all the items in the specified folder. more details | more details | PortalUser | |
Promise<Object[]> | Fetches the tag objects that have been created by the portal user. more details | more details | PortalUser | |
String | Get the URL to the thumbnail image for the user. more details | more details | PortalUser | |
Promise<PortalQueryResult> | Executes a query against the user's favorite group to return an array of PortalItem objects that match the input query. more details | more details | PortalUser |
Method Details
- addItem(params){Promise<PortalItem>}
Adds an item to the user's portal content.
Parameters:Specification:params ObjectSee the object specifications table below for the parameters that may be passed as properties in this object.
Specification:item PortalItemThe item to add to the user's content.
optional The component used to stream the data represented by the item to the client.
folder String|PortalFolderoptionalThe portal folder in which to store the item.
Returns:Type Description Promise<PortalItem> When resolved, returns the PortalItem to be added to the user's content.
- deleteItem(item){Promise}
Deletes an item from the user's portal content.
Parameter:item PortalItemThe portal item to remove.
Returns:Type Description Promise Resolves when the item has been deleted from the user's content.
- deleteItems(items){Promise}Since: ArcGIS API for JavaScript 4.8
Deletes items from the user's portal content.
Parameter:items PortalItem[]The portal items to remove.
Returns:Type Description Promise Resolves when the items have been deleted from the user's content.
- fetchFolders(){Promise<PortalFolder[]>}
Fetches all of the user's folders used to organize portal content.
Returns:Type Description Promise<PortalFolder[]> Resolves to an array of PortalFolder objects representing each of the user's folders in the portal. Example:// Once portal is loaded, user signed in portal.load().then(function() { portalUser.fetchFolders().then(function(folders){ folders.forEach(function(folder){ console.log(" user folder", folder.title); }); }); });
- fetchGroups(){Promise<PortalGroup[]>}
Fetches all the groups that the portal user has permission to access.
Returns:Type Description Promise<PortalGroup[]> Resolves to an array of PortalGroup objects representing each group that the user can access. Example:// Once portal is loaded, user signed in portal.load().then(function() { // fetch all the groups user can access portal.user.fetchGroups().then(function(fetchItemResult){ console.log("user's groups: ", fetchItemResult); }); });
Retrieves all the items in the specified folder.
Parameters:Specification:params ObjectoptionalSee the object specifications table below for the parameters that may be passed as properties in this object.
Specification:folder PortalFolderoptionalThe folder to retrieve items from.
num NumberoptionalDefault Value: 10The maximum number of results to be included in the result set response. The maximum value allowed is 100. The start property combined with the num property can be used to paginate the search results.
sortField StringoptionalDefault Value: createdA comma-delimited list of fields to sort by. Allowed values are
created
,modified
,size
, andtype
.sortOrder StringoptionalDefault Value: ascThe order in which to sort the results. Allowed values are
asc
for ascending order anddesc
for descending order.start NumberoptionalDefault Value: 1The index of the first entry in the result set response. The index is 1-based.
Returns:Type Description Promise<Object> Resolves to an object with the following properties: Property Type Description items PortalItem[] An array containing user's portal items. nextStart number The next entry index if the current result set doesn't contain all results. total number The total number of results. Example:// portalUser.fetchItems portal.user.fetchItems().then(function(fetchItemResult){ console.log("next start index: ", fetchItemResult.nextStart); fetchItemResult.items.forEach(function(item){ console.log("portal item title:", item.title); }); });
- Since: ArcGIS API for JavaScript 4.14
Fetches the tag objects that have been created by the portal user.
Returns:Type Description Promise<Object[]> Resolves to an array of objects with the following properties: Property Type Description tag string The name of the tag. count number The number of times the tag was used.
- getThumbnailUrl(width){String}Since: ArcGIS API for JavaScript 4.4
Get the URL to the thumbnail image for the user.
Available width sizes: 150, 300 and 600.
Parameter:width NumberoptionalThe desired image width.
Returns:Type Description String The URL to the thumbnail image.
- queryFavorites(queryParams){Promise<PortalQueryResult>}
Executes a query against the user's favorite group to return an array of PortalItem objects that match the input query.
Parameter:queryParams PortalQueryParamsoptionalThe input query parameters defined in PortalQueryParams. This object may be autocast.
Returns:Type Description Promise<PortalQueryResult> When resolved, resolves to an instance of PortalQueryResult which contains a results
array of PortalItem objects representing all the items that match the input query.