edu.ucdavis.cstars.client.arcgis

Class PortalUser

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.arcgis.PortalUser

public class PortalUser
extends com.google.gwt.core.client.JavaScriptObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalUser.Access
static class	PortalUser.Role

Method Summary

Methods

Modifier and Type	Method and Description
PortalUser.Access	getAccess() The access level for the user: private, org or public.
com.google.gwt.core.client.JsDate	getCreated() The date the user was created.
java.lang.String	getCulture() The default culture for the user.
java.lang.String	getDescription() Description of the user.
java.lang.String	getEmail() The user's email address.
Deferred	getFolders(PortalFoldersCallback callback) Find folders for the portal user.
java.lang.String	getFullname() The user's full name.
Deferred	getGroupInvitations(PortalGroupInvitationsCallback callback) Provides access to the group invitations for the portal user.
Deferred	getGroups(PortalGroupsCallback callback) Find all the groups that the portal user has permissions to access.
Deferred	getItems(java.lang.String folderId, PortalItemsCallback callback) Retrieve all the items in the specified folder.
com.google.gwt.core.client.JsDate	getModified() The date the user was modified.
java.lang.String	getOrgId() The id of the organization the user belongs to.
Portal	getPortal() The portal.
java.lang.String	getPreferredView() The user's preferred view for content, either Web or GIS.
java.lang.String	getRegion() 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.
PortalUser.Role	getRole() The user's role in the organization.
com.google.gwt.core.client.JsArrayString	getTags() User-defined tags that describe the user.
java.lang.String	getThumbnailUrl() The url to the thumbnail image for the user.
java.lang.String	getUsername() The username for the user.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAccess

public final PortalUser.Access getAccess()

The 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.

Returns:

Access

getCreated

public final com.google.gwt.core.client.JsDate getCreated()

The date the user was created.

Returns:

JsDate

getCulture

public final java.lang.String getCulture()

The default culture for the user.

Returns:

String

getDescription

public final java.lang.String getDescription()

Description of the user.

Returns:

String

getEmail

public final java.lang.String getEmail()

The user's email address. Available only if the user is signed-in.

Returns:

String

getFullname

public final java.lang.String getFullname()

The user's full name.

Returns:

String

getModified

public final com.google.gwt.core.client.JsDate getModified()

The date the user was modified.

Returns:

JsDate

getOrgId

public final java.lang.String getOrgId()

The id of the organization the user belongs to.

Returns:

String

getPortal

public final Portal getPortal()

The portal.

Returns:

Portal

getPreferredView

public final java.lang.String getPreferredView()

The user's preferred view for content, either Web or GIS. Available only if the user is signed-in.

Returns:

String

getRegion

public final java.lang.String getRegion()

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.

Returns:

String

getRole

public final PortalUser.Role getRole()

The user's role in the organization.

Returns:

Role

getTags

public final com.google.gwt.core.client.JsArrayString getTags()

User-defined tags that describe the user.

Returns:

JsArrayString

getThumbnailUrl

public final java.lang.String getThumbnailUrl()

The url to the thumbnail image for the user.

Returns:

String

getUsername

public final java.lang.String getUsername()

The username for the user.

Returns:

String

getFolders

public final Deferred getFolders(PortalFoldersCallback callback)

Find folders for the portal user. Returns a deferred that when resolved provides access to an array of PortalFolder objects.

Parameters:

callback - - Function to be called when server responds.

Returns:

Deferred

getGroupInvitations

public final Deferred getGroupInvitations(PortalGroupInvitationsCallback callback)

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.

Parameters:

callback - - Function to be called when server responds.

Returns:

Deferred

getGroups

public final Deferred getGroups(PortalGroupsCallback callback)

Find 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.

Parameters:

callback - - Function to be called when server responds.

Returns:

Deferred

getItems

public final Deferred getItems(java.lang.String folderId,
                PortalItemsCallback callback)

Retrieve all the items in the specified folder. Returns a deferred that when resolved provides access to an array of PortalItem objects.

Parameters:

folderId - - The id of the folder that contains the items to retrieve.

callback - - Function to be called when server responds.

Returns:

Deferred