ArcGIS Runtime SDK for iOS: AGSPortalInfo Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSPortalInfo Class Reference

Description

Information about a portal or organization.

If the accessing user is a member of an organization, the details pertain to that organization. If the accessing user is not a member of an organization then then the details pertain to the Portal instead. Information includes the name and logo for the portal/ organization, query information for the featured groups and content, and other customizable aspects of the Portal for an organization.

Since
100
Inheritance diagram for AGSPortalInfo:
AGSObject <AGSJSONSerializable>

Instance Methods

(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 
(nullable AGSPortalInfo *) + fromJSON:withPortal:error:
 

Properties

AGSPortalAccess access
 
BOOL allSSL
 
NSString * basemapGalleryGroupQuery
 
NSString * bingKey
 
BOOL canSearchPublic
 
BOOL canShareBingPublic
 
BOOL canSharePublic
 
BOOL commentsEnabled
 
NSDate * created
 
NSString * customBaseDomain
 
AGSBasemapdefaultBasemap
 
AGSEnvelopedefaultExtent
 
AGSBasemapdefaultVectorBasemap
 
NSString * developerBasemapGalleryGroupQuery
 
NSArray< NSString * > * featuredGroupsQueries
 
NSString * featuredItemsGroupQuery
 
AGSPortalHelperServiceshelperServices
 
NSInteger homePageFeaturedContentCount
 
NSString * homePageFeaturedContentGroupQuery
 
NSString * IPCountryCode
 
BOOL isPortal
 
AGSLicenseInfolicenseInfo
 
NSString * livingAtlasGroupQuery
 
NSLocale * locale
 
NSDate * modified
 
AGSLoadableImageorganizationBanner
 
NSString * organizationDescription
 
NSString * organizationID
 
NSString * organizationName
 
NSString * organizationSubdomain
 
AGSPortalportal
 
AGSPortalMode portalMode
 
NSString * portalName
 
AGSLoadableImageportalThumbnail
 
BOOL readOnly
 
NSString * readOnlyMessage
 
BOOL showHomePageDescription
 
NSString * stylesGroupQuery
 
AGSSubscriptionInfosubscriptionInfo
 
BOOL supportsOAuth
 
NSString * symbolSetsGroupQuery
 
AGSLoadableImagethumbnail
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
BOOL useVectorBasemaps
 
NSString * vectorBasemapGalleryGroupQuery
 

Method Documentation

◆ fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject
error: (NSError **)  error 
staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

◆ fromJSON:withPortal:error:

+ (nullable AGSPortalInfo *) fromJSON: (id)  JSONObject
withPortal: (AGSPortal *)  portal
error: (NSError **)  error 

Creates a portal info with JSON content to represent the info for the portal.

Parameters
JSONObjectRepresenting the JSON content of the info.
portalThe portal to which the info belongs to.
Since
100

◆ toJSON:

- (nullable id) toJSON: (NSError **)  error
requiredinherited

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ access

- (AGSPortalAccess) access
readnonatomicassign

Determines who can view the organization's content. Can be either AGSPortalAccessPublic or AGSPortalAccessPrivate.

AGSPortalAccessPublic implies even anonymous users can access the content. AGSPortalAccessPrivate restricts access to only members of the organization.

Since
100

◆ allSSL

- (BOOL) allSSL
readnonatomicassign

Indicates if the organization is using HTTPS. If YES, all calls made against resources that belong to the organization will require HTTPS. The default is NO.

Since
100

◆ basemapGalleryGroupQuery

- (NSString*) basemapGalleryGroupQuery
readnonatomiccopy

The pre-defined query string for finding the collection of basemaps.

Since
100

◆ bingKey

- (NSString*) bingKey
readnonatomiccopy

The Bing App ID associated with the portal.

Since
100

◆ canSearchPublic

- (BOOL) canSearchPublic
readnonatomicassign

Indicates whether the members of the organization can search content outside of the organization.

Since
100

◆ canShareBingPublic

- (BOOL) canShareBingPublic
readnonatomicassign

Indicates whether the members of the organization can share Bing content outside of the organization.

Since
100

◆ canSharePublic

- (BOOL) canSharePublic
readnonatomicassign

Indicates whether the members of the organization can share content outside of the organization.

Since
100

◆ commentsEnabled

- (BOOL) commentsEnabled
readnonatomicassign

Indicates whether or not comments are enabled for the portal.

Since
100

◆ created

- (NSDate*) created
readnonatomicstrong

The date the organization was created.

Since
100

◆ customBaseDomain

- (NSString*) customBaseDomain
readnonatomiccopy

The portion of the URL's host component that identifies the portal For example, http://&lt;organizationSubdomain&gt;.&lt;customBaseDomain&gt;/

Since
100
See also
organizationSubdomain

◆ defaultBasemap

- (AGSBasemap*) defaultBasemap
readnonatomicstrong

The default basemap of the portal/organization.

Since
100

◆ defaultExtent

- (AGSEnvelope*) defaultExtent
readnonatomicstrong

The default extent for the basemaps.

Since
100

◆ defaultVectorBasemap

- (AGSBasemap*) defaultVectorBasemap
readnonatomicstrong

The default vector basemap of the portal/organization.

Since
100.6

◆ developerBasemapGalleryGroupQuery

- (NSString*) developerBasemapGalleryGroupQuery
readnonatomiccopy

A query that identifies the group containing developer basemaps.

This expression can be used as the query string parameter to find the group that contains the developer basemaps of the AGSPortal. Developer basemaps are accessible and metered via API keys.

See also
- fetchDeveloperBasemapsWithCompletion: (AGSPortal)
Since
100.12

◆ featuredGroupsQueries

- (NSArray<NSString*>*) featuredGroupsQueries
readnonatomiccopy

Array of pre-defined query strings for finding featured groups.

Since
100

◆ featuredItemsGroupQuery

- (NSString*) featuredItemsGroupQuery
readnonatomiccopy

The pre-defined query string for finding featured items group.

Since
100

◆ helperServices

- (AGSPortalHelperServices*) helperServices
readnonatomicstrong

Various services provided by the organization.

Since
100

◆ homePageFeaturedContentCount

- (NSInteger) homePageFeaturedContentCount
readnonatomicassign

The number of featured items that can be displayed on the home page. The max is 100.

Since
100

◆ homePageFeaturedContentGroupQuery

- (NSString*) homePageFeaturedContentGroupQuery
readnonatomiccopy

The pre-defined query string for finding homepage featured items group.

Since
100

◆ IPCountryCode

- (NSString*) IPCountryCode
readnonatomiccopy

The country code of the calling IP.

Since
100

◆ isPortal

- (BOOL) isPortal
readnonatomicassign

Indicates if the portal is on-premises.

Since
100

◆ licenseInfo

- (AGSLicenseInfo*) licenseInfo
readnonatomicstrong

License information for the named-user currently logged into the portal. Only applicable if the portal connection wasn't established anonymously.

See also
AGSPortal::user for details about the user logged into the portal.
+ setLicenseInfo:error: (AGSArcGISRuntimeEnvironment) to license the application for deployment using a named-user.
Since
100
Deprecated:
100.7 This property has been replaced by fetchLicenseInfoWithCompletion: (AGSPortal).

◆ livingAtlasGroupQuery

- (NSString*) livingAtlasGroupQuery
readnonatomiccopy

The query that identifies the group containing content for the living atlas.

Since
100.7

◆ locale

- (NSLocale*) locale
readnonatomicstrong

The item's language and country information.

Since
100

◆ modified

- (NSDate*) modified
readnonatomicstrong

The date the organization was last modified.

Since
100

◆ organizationBanner

- (AGSLoadableImage*) organizationBanner
readnonatomicstrong

The banner image of the organization.

If it is nil, there is no banner. Otherwise, the image needs to be loaded asynchronously by calling loadWithCompletion: (AGSLoadable-p).

Since
100

◆ organizationDescription

- (NSString*) organizationDescription
readnonatomiccopy

The description of the organization.

Since
100

◆ organizationID

- (NSString*) organizationID
readnonatomiccopy

The id of the organization.

Since
100

◆ organizationName

- (NSString*) organizationName
readnonatomiccopy

The name of the organization.

Since
100

◆ organizationSubdomain

- (NSString*) organizationSubdomain
readnonatomiccopy

The portion of the URL's host component that identifies a specific organization subscription within a portal. For example, http://&lt;organizationSubdomain&gt;.&lt;customBaseDomain&gt;/.

Since
100
See also
customBaseDomain

◆ portal

- (AGSPortal*) portal
readnonatomicweak

The portal that is being referred to. Needs to be optional because it's a weak reference.

Since
100

◆ portalMode

- (AGSPortalMode) portalMode
readnonatomicassign

Indicates whether the portal is single or multi tenant. A multi tenant portal supports organization subscriptions, but a single tenant does not.

Since
100

◆ portalName

- (NSString*) portalName
readnonatomiccopy

The name of the portal.

Since
100

◆ portalThumbnail

- (AGSLoadableImage*) portalThumbnail
readnonatomicstrong

The thumbnail image of the portal.

If it is nil, there is no thumbnail. Otherwise, the image needs to be loaded asynchronously by calling loadWithCompletion: (AGSLoadable-p).

Since
100

◆ readOnly

- (BOOL) readOnly
readnonatomicassign

Indicates whether the portal is currently in read-only mode.

See also
AGSPortalInfo::readOnlyMessage
Since
100.9

◆ readOnlyMessage

- (NSString*) readOnlyMessage
readnonatomiccopy

If the portal is currently in read-only mode, this is an explanatory message that can be displayed to the user.

Remarks
This will be nil if AGSPortalInfo::isReadOnly is NO.
Since
100.9

◆ showHomePageDescription

- (BOOL) showHomePageDescription
readnonatomicassign

Indicates if the description of your organization displays on the home page.

Since
100

◆ stylesGroupQuery

- (NSString*) stylesGroupQuery
readnonatomiccopy

A query that identifies a group of styles. Each style contains references to symbols that can be used in the ArcGIS platform.

This expression can be used as the query string parameter to find the styles group. Instead of providing your own query, you can use the helper method fetchStylesWithCompletion: (AGSPortal) to fetch the items in the styles group.

See also
AGSPortal::findGroupsWithQueryParams:completion:, AGSPortalQueryParameters
Since
100.12

◆ subscriptionInfo

- (AGSSubscriptionInfo*) subscriptionInfo
readnonatomicstrong

Information about the portal user's subscription.

Remarks
nil if the portal is accessed anonymously.
Since
100.9

◆ supportsOAuth

- (BOOL) supportsOAuth
readnonatomicassign

Indicates whether or not this portal supports OAuth authentication.

Since
100

◆ symbolSetsGroupQuery

- (NSString*) symbolSetsGroupQuery
readnonatomiccopy

A query that identifies the symbol sets group.

This expression can be used as the query string parameter to find the symbol sets group. Instead of providing your own query, you can use the helper method fetchSymbolSetsWithCompletion: (AGSPortal) to fetch the items in the symbol sets group.

See also
AGSPortal::findGroupsWithQueryParams:completion:, AGSPortalQueryParameters
Since
100.12

◆ thumbnail

- (AGSLoadableImage*) thumbnail
readnonatomicstrong

The organization's thumbnail image.

If it is nil, there is no thumbnail. Otherwise, the image needs to be loaded asynchronously by calling loadWithCompletion: (AGSLoadable-p).

Since
100

◆ unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON
readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns
NSDictionary containing the unknown JSON.
Since
100

◆ unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON
readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns
NSDictionary containing the unsupported JSON.
Since
100

◆ useVectorBasemaps

- (BOOL) useVectorBasemaps
readnonatomicassign

Indicates whether the organization uses the Esri vector basemaps.

Since
100.6

◆ vectorBasemapGalleryGroupQuery

- (NSString*) vectorBasemapGalleryGroupQuery
readnonatomiccopy

The pre-defined query string for finding the collection of vector basemaps.

Since
100.6