ArcGIS Runtime SDK for iOS
100.15
|
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.
Instance Methods | |
(nullable id) | - toJSON: |
Class Methods | |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
(nullable AGSPortalInfo *) | + fromJSON:withPortal:error: |
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
+ (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.
JSONObject | Representing the JSON content of the info. |
portal | The portal to which the info belongs to. |
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
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.
|
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
.
|
readnonatomiccopy |
The pre-defined query string for finding the collection of basemaps.
|
readnonatomiccopy |
The Bing App ID associated with the portal.
|
readnonatomicassign |
Indicates whether the members of the organization can search content outside of the organization.
|
readnonatomicassign |
Indicates whether the members of the organization can share Bing content outside of the organization.
|
readnonatomicassign |
Indicates whether the members of the organization can share content outside of the organization.
|
readnonatomicassign |
Indicates whether or not comments are enabled for the portal.
|
readnonatomicstrong |
The date the organization was created.
|
readnonatomiccopy |
The portion of the URL's host component that identifies the portal For example, http://<organizationSubdomain>.<customBaseDomain>/
organizationSubdomain
|
readnonatomicstrong |
The default basemap of the portal/organization.
|
readnonatomicstrong |
The default extent for the basemaps.
|
readnonatomicstrong |
The default vector basemap of the portal/organization.
|
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.
|
readnonatomiccopy |
Array of pre-defined query strings for finding featured groups.
|
readnonatomiccopy |
The pre-defined query string for finding featured items group.
|
readnonatomicstrong |
Various services provided by the organization.
|
readnonatomicassign |
The number of featured items that can be displayed on the home page. The max is 100
.
|
readnonatomiccopy |
The pre-defined query string for finding homepage featured items group.
|
readnonatomiccopy |
The country code of the calling IP.
|
readnonatomicassign |
Indicates if the portal is on-premises.
|
readnonatomicstrong |
License information for the named-user currently logged into the portal. Only applicable if the portal connection wasn't established anonymously.
AGSPortal::user
for details about the user logged into the portal. + setLicenseInfo:error: (AGSArcGISRuntimeEnvironment)
to license the application for deployment using a named-user. fetchLicenseInfoWithCompletion: (AGSPortal)
.
|
readnonatomiccopy |
The query that identifies the group containing content for the living atlas.
|
readnonatomicstrong |
The item's language and country information.
|
readnonatomicstrong |
The date the organization was last modified.
|
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)
.
|
readnonatomiccopy |
The description of the organization.
|
readnonatomiccopy |
The id of the organization.
|
readnonatomiccopy |
The name of the organization.
|
readnonatomiccopy |
The portion of the URL's host component that identifies a specific organization subscription within a portal. For example, http://<organizationSubdomain>.<customBaseDomain>/.
customBaseDomain
|
readnonatomicweak |
The portal that is being referred to. Needs to be optional because it's a weak reference.
|
readnonatomicassign |
Indicates whether the portal is single or multi tenant. A multi tenant portal supports organization subscriptions, but a single tenant does not.
|
readnonatomiccopy |
The name of the portal.
|
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)
.
|
readnonatomicassign |
Indicates whether the portal is currently in read-only mode.
AGSPortalInfo::readOnlyMessage
|
readnonatomiccopy |
If the portal is currently in read-only mode, this is an explanatory message that can be displayed to the user.
nil
if AGSPortalInfo::isReadOnly
is NO
.
|
readnonatomicassign |
Indicates if the description of your organization displays on the home page.
|
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.
AGSPortal::findGroupsWithQueryParams:completion:
, AGSPortalQueryParameters
|
readnonatomicstrong |
Information about the portal user's subscription.
nil
if the portal is accessed anonymously.
|
readnonatomicassign |
Indicates whether or not this portal supports OAuth authentication.
|
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.
AGSPortal::findGroupsWithQueryParams:completion:
, AGSPortalQueryParameters
|
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)
.
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.
|
readnonatomicassign |
Indicates whether the organization uses the Esri vector basemaps.
|
readnonatomiccopy |
The pre-defined query string for finding the collection of vector basemaps.