|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.core.portal.PortalInfo
public class PortalInfo
Class used to hold some information about the Portal such as default basemap, featured groups, etc. If the user is not logged in this call will return some defaults. If the user is logged in, the account information returned will be specific to the user's account.
Nested Class Summary | |
---|---|
static class |
PortalInfo.GeocodeServiceInfo
|
static class |
PortalInfo.HelperServices
|
Method Summary | |
---|---|
byte[] |
fetchOrganizationThumbnail()
Starts a process that fetches the organization thumbnail from the portal. |
void |
fetchOrganizationThumbnail(PortalListener<byte[]> portalListener)
Deprecated. please use fetchOrganizationThumbnail() instead. |
byte[] |
fetchPortalThumbnail()
Fetches the portal thumbnail from the portal. |
void |
fetchPortalThumbnail(PortalListener<byte[]> portalListener)
Deprecated. please use fetchPortalThumbnail() instead. |
static PortalInfo |
fromJson(org.codehaus.jackson.JsonParser parser,
Portal portal)
Creates a PortalInfo from the Json Parser. |
PortalAccess |
getAccess()
Returns the access level of the Portal or Organization. |
String |
getBasemapGalleryGroupQuery()
Returns the query used to determine which group should drive the gallery of basemaps displayed in the client application for the specified culture. |
String |
getCustomBaseURL()
Gets the custom base url for the portal. |
BaseMap |
getDefaultBaseMap()
Returns the default basemap to be used by the client application for the specified culture when creating new maps (if applicable). |
MapGeometry |
getDefaultExtent()
Returns the default extent to be used by the client application for the specified culture when creating new maps (if applicable). |
List<String> |
getFeaturedGroupsQueries()
Returns an array of featured groups to possibly display on the group page or to feature for an organization. |
String |
getFeaturedItemsGroupQuery()
Returns the query used to determine which group should drive the gallery of featured items displayed in the client application for the specified culture. |
PortalInfo.HelperServices |
getHelperServices()
Gets the helper services information. |
String |
getHomepageFeaturedContentGroupQuery()
Returns the pre-defined query string for finding homepage featured items group on the portal. |
String |
getIpCountryCode()
Gets the ip country code. |
String |
getOrganizationDescription()
Returns the description of the organization. |
String |
getOrganizationId()
Returns the id of the organization, if the user belongs to one. |
String |
getOrganizationName()
Returns the name of the organization. |
String |
getOrganizationThumbnailFileName()
Returns the filename for the organization's thumbnail. |
Portal |
getPortal()
Returns the Portal from which this PortalInfo was generated. |
PortalMode |
getPortalMode()
Indicates whether the portal is single or multi tenant mode of the Portal. |
String |
getPortalName()
Returns the name of the Portal. |
String |
getPortalThumbnailFileName()
Returns the filename for the portal's thumbnail. |
String |
getUrlKey()
Gets the urlKey of the PortalInfo. |
boolean |
isCanSearchPublic()
Includes or excludes public items, groups, and users in search queries. |
boolean |
isCanSharePublic()
Allows or disallows an organization to share groups or items publicly. false denotes that content can not be shared with everyone. true is the default. |
boolean |
isShowHomePageDescription()
Returns whether or not the organization's description should be shown. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
@Deprecated public void fetchOrganizationThumbnail(PortalListener<byte[]> portalListener)
fetchOrganizationThumbnail()
instead.
portalListener
- - fetches the thumbnail associated with an organization as a byte array.public byte[] fetchOrganizationThumbnail() throws Exception
Exception
- if unable to complete the request.@Deprecated public void fetchPortalThumbnail(PortalListener<byte[]> portalListener)
fetchPortalThumbnail()
instead.
portalListener
- fetches the thumbnail associated with a portal as a byte array.public byte[] fetchPortalThumbnail() throws Exception
Exception
- if unable to complete the request.public static PortalInfo fromJson(org.codehaus.jackson.JsonParser parser, Portal portal) throws Exception
parser
- the json to parse the PortalInfo out.portal
- the Portal which contains the PortalInfo.
Exception
- if unable to complete the request.public Portal getPortal()
public String getBasemapGalleryGroupQuery()
public String getHomepageFeaturedContentGroupQuery()
public BaseMap getDefaultBaseMap()
public MapGeometry getDefaultExtent()
public String getOrganizationDescription()
public List<String> getFeaturedGroupsQueries()
public String getFeaturedItemsGroupQuery()
public String getOrganizationId()
public String getOrganizationName()
public String getPortalName()
public PortalInfo.HelperServices getHelperServices()
public String getPortalThumbnailFileName()
public boolean isShowHomePageDescription()
public String getOrganizationThumbnailFileName()
public PortalAccess getAccess()
public PortalMode getPortalMode()
public String getUrlKey()
public String getCustomBaseURL()
public boolean isCanSearchPublic()
public boolean isCanSharePublic()
public String getIpCountryCode()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |