AGSPortalInfo Class Reference
Description
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.
The AGSPortalInfo's delegate is informed whenever operations performed by the AGSPortalInfo complete successfully or encounter an error.
- See also:
- AGSPortalInfoDelegate
- Since:
- 2.2
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (NSOperation *) | - fetchOrganizationThumbnail |
| (NSOperation *) | - fetchPortalThumbnail |
| (id) | - initWithJSON: |
Properties | |
| AGSPortalAccess | access |
| NSString * | basemapGalleryGroupQuery |
| BOOL | canSharePublic |
| AGSWebMapBaseMap * | defaultBasemap |
| AGSEnvelope * | defaultExtent |
| id< AGSPortalInfoDelegate > | delegate |
| NSArray * | featuredGroupsQueries |
| NSString * | featuredItemsGroupQuery |
| NSString * | homepageFeaturedContentGroupQuery |
| NSString * | organizationDescription |
| NSString * | organizationId |
| NSString * | organizationName |
| UIImage * | organizationThumbnail |
| NSString * | organizationThumbnailFileName |
| AGSPortal * | portal |
| AGSPortalMode | portalMode |
| NSString * | portalName |
| UIImage * | portalThumbnail |
| NSString * | portalThumbnailFileName |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (NSOperation*) fetchOrganizationThumbnail |
Kicks off an operation that fetches the organization thumbnail. The corresponding methods on AGSPortalInfoDelegate are invoked when the operation completes successfully or encounters an error.
- Since:
- 2.2
| - (NSOperation*) fetchPortalThumbnail |
Kicks off an operation that fetches the portal thumbnail. The corresponding methods on AGSPortalInfoDelegate are invoked when the operation completes successfully or encounters an error.
- Since:
- 2.2
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
Reimplemented in AGSWebMapFeatureCollection.
Property Documentation
- (AGSPortalAccess) access [read, assign] |
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:
- 2.2
- (NSString*) basemapGalleryGroupQuery [read, retain] |
The pre-defined query string for finding the collection of basemaps.
- Since:
- 2.2
- (BOOL) canSharePublic [read, assign] |
Indicates whether the members of the organization can share content outside of the organization.
- Since:
- 2.2
- (AGSWebMapBaseMap*) defaultBasemap [read, retain] |
The default basemap of the portal/organization.
- Since:
- 2.2
- (AGSEnvelope*) defaultExtent [read, retain] |
The default extent for the basemaps.
- Since:
- 2.2
- (id<AGSPortalInfoDelegate>) delegate [read, write, assign] |
The delegate for operations on AGSPortalInfo.
- Since:
- 2.2
- (NSArray*) featuredGroupsQueries [read, retain] |
Array of pre-defined query strings for finding featured groups.
- Since:
- 2.2
- (NSString*) featuredItemsGroupQuery [read, retain] |
The pre-defined query string for finding featured items group.
- Since:
- 2.2
- (NSString*) homepageFeaturedContentGroupQuery [read, retain] |
The pre-defined query string for finding homepage featured items group.
- Since:
- 2.2
- (NSString*) organizationDescription [read, retain] |
The description of the organization.
- Since:
- 2.2
- (NSString*) organizationId [read, retain] |
The id of the organization.
- Since:
- 2.2
- (NSString*) organizationName [read, retain] |
The name of the organization.
- Since:
- 2.2
- (UIImage*) organizationThumbnail [read, retain] |
The thumbnail image of the organization. This needs to be fetched explicitly using fetchOrganizationThumbnail.
- Since:
- 2.2
- (NSString*) organizationThumbnailFileName [read, retain] |
The name of the Organization's thumbnail file.
- Since:
- 2.2
- (AGSPortal*) portal [read, assign] |
The portal that is being referred to.
- Since:
- 2.2
- (AGSPortalMode) portalMode [read, assign] |
- Since:
- 2.2
- (NSString*) portalName [read, retain] |
The name of the portal.
- Since:
- 2.2
- (UIImage*) portalThumbnail [read, retain] |
The thumbnail image of the portal. This needs to be fetched explicitly using fetchPortalThumbnail.
- Since:
- 2.2
- (NSString*) portalThumbnailFileName [read, retain] |
The name of the Portal's thumbnail file.
- Since:
- 2.2