Portal

java.lang.Object
- com.google.gwt.core.client.JavaScriptObject
- - edu.ucdavis.cstars.client.arcgis.Portal

```
public class Portal
extends com.google.gwt.core.client.JavaScriptObject
```
Class added v2.8 The Portal class is part of the Portal API which provides a way to build applications that work with content from ArcGIS Online or an ArcGIS Portal. ArcGIS Portal is software technology from Esri that customers can deploy either on premise or in the cloud. ArcGIS Online is Esri's Software as a Service offering that represents GIS as a Service and is implemented using the same technology as ArcGIS Portal. The Portal API allows application developers to work with users, groups and content hosted within ArcGIS Online or within an ArcGIS Portal. The API allows developers to build web, mobile, and desktop applications that support sharing and collaboration using web maps. Organizational developers can also use the API to build custom applications for their users. The Portal class provides a view of the portal as seen by the current user, anonymous or logged in. Includes information such as the name, logo, featured items and supported protocols (http vs https) for this portal. If the user is not logged in this call will return the default view of the portal. If the user is logged in, the view of the portal returned will be specific to the organization that the user belongs to. The default view of the portal is dependent on the culture of the user which is obtained from the users profile.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Portal.Access

static class Portal.DefaultBasemap

static class Portal.FeaturedGroup

Nested Classes
Modifier and Type	Class and Description
`static class`	`Portal.Access`
`static class`	`Portal.DefaultBasemap`
`static class`	`Portal.FeaturedGroup`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allSSL()` When true, access to the Portal resources must occur over SSL.
`static boolean`	`assertLoaded()` Check that the esri.arcgis.Portal has been loaded
`boolean`	`canSearchPublic()` When true, public items, groups and users are included in search queries.
`boolean`	`canSharePublic()` When true, members of the organization can share resources outside the organization.
`static Portal`	`create(java.lang.String url)` Creates a new Portal object.
`Portal.Access`	`getAccess()` The access level of the organization.
`java.lang.String`	`getBasemapGalleryGroupQuery()` The query that defines the basemaps that are displayed in the Basemap Gallery.
`com.google.gwt.core.client.JsDate`	`getCreated()` Date the organization was created.
`java.lang.String`	`getCulture()` The default locale (language and country) information.
`Portal.DefaultBasemap`	`getDefaultBasemap()` The default basemap the portal displays in the map viewer.
`Extent`	`getDefaultExtent()` The default extent for the map the portal displays in the map viewer.
`java.lang.String`	`getDescription()` A description of the organization / portal.
`com.google.gwt.core.client.JsArray<Portal.FeaturedGroup>`	`getFeaturedGroups()` The featured groups for the portal.
`java.lang.String`	`getFeaturedItemsGroupQuery()` The query that defines the featured group.
`java.lang.String`	`getId()` The id of the organization that owns this portal.
`java.lang.String`	`getLayerTemplatesGroupQuery()` The query that defines the collection of editable layer templates.
`com.google.gwt.core.client.JsDate`	`getModified()` Date the organization was last modified.
`java.lang.String`	`getName()` The Name of the organization / portal.
`java.lang.String`	`getPortalMode()` Denotes multitenant or singletenant.
`java.lang.String`	`getPortalName()` The name of the portal i.e.
`java.lang.String`	`getSymbolSetsGroupQuery()` The query that defines the symbols sets used by the map viewer.
`java.lang.String`	`getTemplatesGroupQuery()` The query that defines the collection of templates that will appear in the template gallery.
`java.lang.String`	`getThumbnailUrl()` The url to the thumbnail of the organization.
`java.lang.String`	`getUrl()` The portal url.
`boolean`	`isOrganization()` Indicates if the portal is an organization.
`Deferred`	`queryGroups(PortalQueryParams queryParams, PortalQueryGroupsCallback callback)` Execute a query against the Portal to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalGroup objects for all the groups that match the input query.
`Deferred`	`queryItem(PortalQueryParams queryParams, PortalQueryItemsCallback callback)` Execute a query against the Portal to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalItem objects that match the input query.

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
  - create
```
public static Portal create(java.lang.String url)
```
    Creates a new Portal object.
    
    Parameters:
    url - - The url to the ArcGIS.com site or in-house portal.
    
    Returns:
    Portal
  - assertLoaded
```
public static boolean assertLoaded()
```
    Check that the esri.arcgis.Portal has been loaded
    
    Returns:
    boolean
  - getAccess
```
public final Portal.Access getAccess()
```
    The access level of the organization. When public, anonymous users can access the organization. When private access is restricted to only members of the organization.
    
    Returns:
    Access
  - allSSL
```
public final boolean allSSL()
```
    When true, access to the Portal resources must occur over SSL.
    
    Returns:
    boolean
  - getBasemapGalleryGroupQuery
```
public final java.lang.String getBasemapGalleryGroupQuery()
```
    The query that defines the basemaps that are displayed in the Basemap Gallery.
    
    Returns:
    String
  - canSearchPublic
```
public final boolean canSearchPublic()
```
    When true, public items, groups and users are included in search queries. When false, no public items outside of the organization are included. However, public items which are part of the organization are included.
    
    Returns:
    boolean
  - canSharePublic
```
public final boolean canSharePublic()
```
    When true, members of the organization can share resources outside the organization.
    
    Returns:
    boolean
  - getCreated
```
public final com.google.gwt.core.client.JsDate getCreated()
```
    Date the organization was created.
    
    Returns:
    JsDate
  - getCulture
```
public final java.lang.String getCulture()
```
    The default locale (language and country) information.
    
    Returns:
    String
  - getDefaultBasemap
```
public final Portal.DefaultBasemap getDefaultBasemap()
```
    The default basemap the portal displays in the map viewer. Returns an object that provides the url and title to the default basemap service.
    
    Returns:
    DefaultBasemap
  - getDefaultExtent
```
public final Extent getDefaultExtent()
```
    The default extent for the map the portal displays in the map viewer. The extent will be in the default basemap's spatial reference.
    
    Returns:
    Extent
  - getDescription
```
public final java.lang.String getDescription()
```
    A description of the organization / portal.
    
    Returns:
    String
  - getFeaturedGroups
```
public final com.google.gwt.core.client.JsArray<Portal.FeaturedGroup> getFeaturedGroups()
```
    The featured groups for the portal. Returns an array of objects that provide access to the owner and title for each featured group.
    
    Returns:
    JsArray
  - getFeaturedItemsGroupQuery
```
public final java.lang.String getFeaturedItemsGroupQuery()
```
    The query that defines the featured group. If null, then the most viewed items in the organization will be the featured items.
    
    Returns:
    String
  - getId
```
public final java.lang.String getId()
```
    The id of the organization that owns this portal. If null then this is the default portal for anonymous and non organizational users.
    
    Returns:
    String
  - isOrganization
```
public final boolean isOrganization()
```
    Indicates if the portal is an organization.
    
    Returns:
    boolean
  - getLayerTemplatesGroupQuery
```
public final java.lang.String getLayerTemplatesGroupQuery()
```
    The query that defines the collection of editable layer templates.
    
    Returns:
    String
  - getModified
```
public final com.google.gwt.core.client.JsDate getModified()
```
    Date the organization was last modified.
    
    Returns:
    JsDate
  - getName
```
public final java.lang.String getName()
```
    The Name of the organization / portal.
    
    Returns:
    String
  - getPortalMode
```
public final java.lang.String getPortalMode()
```
    Denotes multitenant or singletenant.
    
    Returns:
    String
  - getPortalName
```
public final java.lang.String getPortalName()
```
    The name of the portal i.e. ArcGIS Online.
    
    Returns:
    String
  - getSymbolSetsGroupQuery
```
public final java.lang.String getSymbolSetsGroupQuery()
```
    The query that defines the symbols sets used by the map viewer.
    
    Returns:
    String
  - getTemplatesGroupQuery
```
public final java.lang.String getTemplatesGroupQuery()
```
    The query that defines the collection of templates that will appear in the template gallery.
    
    Returns:
    String
  - getThumbnailUrl
```
public final java.lang.String getThumbnailUrl()
```
    The url to the thumbnail of the organization.
    
    Returns:
    String
  - getUrl
```
public final java.lang.String getUrl()
```
    The portal url.
    
    Returns:
    String
  - queryGroups
```
public final Deferred queryGroups(PortalQueryParams queryParams,
                   PortalQueryGroupsCallback callback)
```
    Execute a query against the Portal to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalGroup objects for all the groups that match the input query.
    
    Parameters:
    queryParams - - The input query parameters.
    callback - - function to fire when query is complete
    
    Returns:
    Deferred
  - queryItem
```
public final Deferred queryItem(PortalQueryParams queryParams,
                 PortalQueryItemsCallback callback)
```
    Execute a query against the Portal to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalItem objects that match the input query.
    
    Parameters:
    queryParams - - The input query parameters.
    callback - - fundtion to fire when the query is complete
    
    Returns:
    Deferred

Class Portal

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

create

assertLoaded

getAccess

allSSL

getBasemapGalleryGroupQuery

canSearchPublic

canSharePublic

getCreated

getCulture

getDefaultBasemap

getDefaultExtent

getDescription

getFeaturedGroups

getFeaturedItemsGroupQuery

getId

isOrganization

getLayerTemplatesGroupQuery

getModified

getName

getPortalMode

getPortalName

getSymbolSetsGroupQuery

getTemplatesGroupQuery

getThumbnailUrl

getUrl

queryGroups

queryItem