Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: PortalUser
[ AMD Module Require | Legacy Module Require ]
require(["esri/arcgis/Portal"], function(arcgisPortal) { /* code goes here */ });
Description
(Added at v2.8)
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'. View the ArcGIS Portal API REST documentation for the user for more details.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| access | String | The access level for the user: private, org or public. |
| created | Date | The date the user was created. |
| culture | String | The default culture for the user. |
| description | String | Description of the user. |
String | The user's email address. | |
| fullName | String | The user's full name. |
| modified | Date | The date the user was modified. |
| orgId | String | The id of the organization the user belongs to. |
| portal | Portal | The portal. |
| preferredView | String | The user's preferred view for content, either Web or GIS. |
| region | String | The user's preferred region, used to set the featured maps on the portal home page, content in the gallery and the default extent for new maps in the Viewer. |
| role | String | The user's role in the organization: administrator (org_admin), publisher (org_publisher), or user (org_user). |
| tags | String[] | User-defined tags that describe the user. |
| thumbnailUrl | String | The url to the thumbnail image for the user. |
| userContentUrl | String | The URL for the user content. |
| username | String | The username for the user. |
Methods
| Name | Return type | Summary |
|---|---|---|
| getFolders() | Deferred | Find folders for the portal user. |
| getGroupInvitations() | Deferred | Provides access to the group invitations for the portal user. |
| getGroups() | Deferred | Find all the groups that the portal user has permissions to access. |
| getItem(itemId) | Deferred | Get the portal item along with folder info for the input item id. |
| getItems(folderId?) | Deferred | Retrieve all the items in the specified folder. |
| getNotifications() | Deferred | Get information about any notifications for the portal user. |
| getTags() | Deferred | Access the tag objects that have been created by the portal user. |
| getThumbnailUrl(width?) | String | Get the URL to the thumbnail image for the portal user. |
Property Details
<String
StringThe access level for the user: private, org or public. If private, the users descriptive information will not be available and the user name will not be searchable. Available only if the user is signed-in.
Known values:
private | org | public<Date
DateThe date the user was created.
<String
StringThe default culture for the user.
<String
StringDescription of the user.
<String
StringThe user's email address. Available only if the user is signed-in.
<String
StringThe user's full name.
<Date
DateThe date the user was modified.
<String
StringThe id of the organization the user belongs to.
<Portal
PortalThe portal.
<String
StringThe user's preferred view for content, either Web or GIS. Available only if the user is signed-in.
<String
StringThe user's preferred region, used to set the featured maps on the portal home page, content in the gallery and the default extent for new maps in the Viewer.
<String
StringThe user's role in the organization: administrator (org_admin), publisher (org_publisher), or user (org_user).
<String[]
String[]User-defined tags that describe the user.
<String
StringThe url to the thumbnail image for the user.
<String
StringThe URL for the user content. (Added at v3.2)
<String
StringThe username for the user.
Method Details
Find folders for the portal user. Returns a deferred that when resolved provides access to an array of PortalFolder objects.
Return type:
DeferredSample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
portalUser.getFolders().then(function(folders){
array.forEach(folders,function(folder){
if(folder.title === 'javascript'){
folderid = folder.id;
}
});
});
...
});
Provides access to the group invitations for the portal user. Returns a deferred that when resolved provides access to the results as json. View the REST API documentation for details on the result format.
Return type:
DeferredFind all the groups that the portal user has permissions to access. Returns a deferred that when resolved provides access to an array of PortalGroup objects.
Return type:
DeferredSample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
portalUser.getGroups().then(function(groups){
array.forEach(groups,function(group){
var description = group.description;
});
});
...
});
Get the portal item along with folder info for the input item id. (Added at v3.4)
Return type:
DeferredParameters:
< |
Required | The id of the item. |
Sample:
require(["esri/arcgis/Portal"],function(
arcgisPortal
){
function getItems(){
loggedInUser.getItem("1084880a33cc4669a1afe8c298d46871").then(function(results){
//do something with the info here.
});
}
....
});
Retrieve all the items in the specified folder. Returns a deferred that when resolved provides access to an array of PortalItem objects.
Return type:
DeferredParameters:
< |
Optional | The id of the folder that contains the items to retrieve. |
Sample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
function loadItems(id){
portalUser.getItems(id).then(function(items){
array.forEach(items,function(item){
console.log(item);
});
});
};
...
});
Get information about any notifications for the portal user. Returns a deferred that when resolved provides access to the results as json. View the REST API documentation for details on the result format.
Return type:
DeferredSample:
portalUser.getNotifications().then(function(notifications){
var notificationTarget = notifications[0].target;
});
Access the tag objects that have been created by the portal user. Returns a deferred that when resolved provides access to an array of tag objects used by the user. Each tag object contains a
tag property with the name of the tag along with a count that reports the number of times the tag was used.Return type:
DeferredSample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
portalUser.getTags().then(function(tagItems){
array.forEach(tagItems,function(tagItem){
console.log(tagItem.tag);
});
});
...
});