public class

PortalUser

extends Object
java.lang.Object
   ↳ com.esri.core.portal.PortalUser

Class Overview

This class represents a registered user on a Portal.

Summary

Public Methods
boolean equals(Object obj)
PortalUserContent fetchContent()
Fetches the user's content.
void fetchContent(PortalListener<PortalUserContent> portalListener)
This method is deprecated. please use fetchContent() instead.
void fetchContentInFolder(String folderId, PortalListener<PortalUserContent> portalListener)
This method is deprecated. please use fetchContentInFolder(String) instead.
PortalUserContent fetchContentInFolder(String folderId)
Fetches the user's content that is in a specific folder.
void fetchThumbnail(PortalListener<byte[]> portalListener)
This method is deprecated. please use fetchThumbnail() instead.
byte[] fetchThumbnail()
Fetches the user's thumbnail.
static PortalUser fromJson(JsonParser parser, Portal portal)
From json.
PortalAccess getAccess()
Returns the access level of this user.
long getCreated()
Returns the creation date of the user's profile.
String getEmail()
Return the email address of the user.
String getFullName()
Return the user's full name.
List<PortalGroup> getGroups()
Returns all the groups that the user belongs to.
long getModified()
Returns the last date the user was modified.
String getOrganizationId()
Returns the id of the organization, if the user belongs to one.
Portal getPortal()
Returns the portal that contains this user.
PortalUserRole getRole()
Gets the role of the Portal user.
List<String> getTags()
Returns a list of search tags associated with this user.
String getThumbnailFileName()
Returns the filename of the thumbnail of this user.
String getUsername()
Returns the user name.
int hashCode()
static PortalUser newInstance(Portal portal, String username)
Initializes a portal user with a portal and a username.
static void newInstance(Portal portal, String username, PortalListener<PortalUser> portalListener)
This method is deprecated. please use newInstance(Portal, String) instead.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean equals (Object obj)

public PortalUserContent fetchContent ()

Fetches the user's content.

Returns
  • the portal user content
Throws
Exception If unable to complete the request.

public void fetchContent (PortalListener<PortalUserContent> portalListener)

This method is deprecated.
please use fetchContent() instead.

Fetches the user's content.

Parameters
portalListener - in the callback the content published by the user is returned

public void fetchContentInFolder (String folderId, PortalListener<PortalUserContent> portalListener)

This method is deprecated.
please use fetchContentInFolder(String) instead.

Fetches the user's content that is in a specific folder.

Parameters
folderId - id of the folder for which content must be fetched
portalListener - in the callback the folder content published by the user is returned

public PortalUserContent fetchContentInFolder (String folderId)

Fetches the user's content that is in a specific folder.

Parameters
folderId - id of the folder for which content must be fetched, or null if not sure.
Returns
  • the portal user content
Throws
Exception If unable to complete the request.

public void fetchThumbnail (PortalListener<byte[]> portalListener)

This method is deprecated.
please use fetchThumbnail() instead.

Fetches the user's thumbnail.

Parameters
portalListener - the callback returns the thumbnail associated with the portal

public byte[] fetchThumbnail ()

Fetches the user's thumbnail.

Returns
  • the byte[]
Throws
Exception if unable to complet the request.

public static PortalUser fromJson (JsonParser parser, Portal portal)

From json.

Parameters
parser the parser
portal the portal
Returns
  • the portal user
Throws
Exception the exception

public PortalAccess getAccess ()

Returns the access level of this user.

Returns
  • The access level of this user

public long getCreated ()

Returns the creation date of the user's profile.

Returns
  • The creation date of the user's profile

public String getEmail ()

Return the email address of the user.

Returns
  • The email address of the user

public String getFullName ()

Return the user's full name.

Returns
  • The user's full name

public List<PortalGroup> getGroups ()

Returns all the groups that the user belongs to.

Returns
  • All the groups that the user belongs to

public long getModified ()

Returns the last date the user was modified.

Returns
  • The last date the user was modified

public String getOrganizationId ()

Returns the id of the organization, if the user belongs to one.

Returns
  • The id of the organization, if the user belongs to one

public Portal getPortal ()

Returns the portal that contains this user.

Returns
  • The portal that contains this user

public PortalUserRole getRole ()

Gets the role of the Portal user.

Returns
  • Returns the role.

public List<String> getTags ()

Returns a list of search tags associated with this user.

Returns
  • A list of search tags associated with this user

public String getThumbnailFileName ()

Returns the filename of the thumbnail of this user.

Returns
  • The filename of the thumbnail of this user

public String getUsername ()

Returns the user name.

Returns
  • The user name

public int hashCode ()

public static PortalUser newInstance (Portal portal, String username)

Initializes a portal user with a portal and a username.

Parameters
portal - portal for which the user is a member
username - username as in the portal
Returns
  • the portal user
Throws
Exception If unable to complete the request.

public static void newInstance (Portal portal, String username, PortalListener<PortalUser> portalListener)

This method is deprecated.
please use newInstance(Portal, String) instead.

Initializes a portal user with a portal and a username.

Parameters
portal - portal for which the user is a member
username - username as in the portal
portalListener - callback listener that returns a portal

public String toString ()