AGSPortal Class Reference
Description
AGSPortal is an object that represents a view for a user (anonymous or not) into an organization or portal. www.ArcGIS.com is an example of a portal. A portal may contain sandboxed areas that are accessible only to an organization that owns them.
AGSPortal is the main class and the entry point into the API to work with portals and organizations. It implements all the operations to interface with the backend REST API. It has a delegate AGSPortalDelegate that is informed when each operation completes successfully or encounters an error.
Concepts:
- Portals allow users and organizations to publish and share content over the web.
- A Portal has Users (
AGSPortalUser), Groups (AGSPortalGroup) and Content (AGSPortalItem).
- A Portal may have users who are unaffiliated with an organization or users who are part of an organization.
- Users sign in to the portal and create and share content which is organized into Items. The system supports different types of items including web maps, map services (that can be used as layers in web maps), applications (that are built around web maps) and data files (that can be uploaded and downloaded).
- Users can choose to keep content Private or to share it with other users via Groups or make content Public and accessible to everyone.
- Users can create and join Groups. Users can share items with Groups. This makes the items visible to and accessible by the other members of the Group.
- A Portal may contain multiple Organizations.
- A user of the Portal (and of the REST API) sees the view off the Portal that applies to their organization. This view includes users, groups and items that belong to the organization and have been shared with them. This view may also include users, groups and items that are external to the organization and have been shared with the user.
- An organization has users in different roles including administrators, publishers and information workers.
- Administrators can add users to their organizations and have access to all content within the organization.
- All users can create web maps based on mashing up services that they have access to and can register services running on external servers.
- Publishers within an organization can in addition create hosted services based on data files that they upload.
- See also:
- AGSPortalDelegate
- Conceptual Doc: Working With Portals
- Sample: Portal Sample
- Since:
- 2.2
Public Member Functions | |
| (NSOperation *) | - findGroupsWithQueryParams: |
| (NSOperation *) | - findItemsWithQueryParams: |
| (id) | - initWithURL:credential: |
| (void) | - resubmitWithURL:credential: |
Properties | |
| AGSCredential * | credential |
| id< AGSPortalDelegate > | delegate |
| AGSPortalInfo * | portalInfo |
| NSURL * | URL |
| AGSPortalUser * | user |
Member Function Documentation
| - (NSOperation*) findGroupsWithQueryParams: | (AGSPortalQueryParams *) | queryParams |
Kicks off an operation that finds groups with query. Corresponding methods on the AGSPortalDelegate are invoked when the operation completes successfully or if an error is encountered.
- Parameters:
-
queryParams The query parameters to find groups.
- Since:
- 2.2
| - (NSOperation*) findItemsWithQueryParams: | (AGSPortalQueryParams *) | queryParams |
Kicks off an operation that finds items with query. Corresponding methods on the AGSPortalDelegate are invoked when the operation completes successfully or if an error is encountered.
- Parameters:
-
queryParams The query parameters to find items.
- Since:
- 2.2
| - (id) initWithURL: | (NSURL *) | url | ||
| credential: | (AGSCredential *) | cred | ||
Instantiates the AGSPortal and initiates a connection to the portal. It will fetch the portal properties and user properties asynchronously and invoke the loaded/failed methods on AGSPortalDelegate. It is recommended you assign a delegate to ensure that the portal loaded properly.
- Parameters:
-
url The url for the portal. Eg, www.arcgis.com cred The credential of the user. Can be Nil if anonymous access is desired.
- Since:
- 2.2
| - (void) resubmitWithURL: | (NSURL *) | url | ||
| credential: | (AGSCredential *) | cred | ||
If the portal fails to load, you can resubmit it with a different URL and/or credential. This method will do nothing if the portal is already loaded.
- Parameters:
-
url The url for the portal. cred The credential of the user. Can be Nil if anonymous access is desired.
- Since:
- 2.2
Property Documentation
- (AGSCredential*) credential [read, copy] |
The credential of the user for authenticated access. Can be nil, in which case it requests for anonymous access to the portal.
- Since:
- 2.2
Reimplemented from <AGSSecuredResource>.
- (id<AGSPortalDelegate>) delegate [read, write, assign] |
The delegate for the portal operations.
- Since:
- 2.2
- (AGSPortalInfo*) portalInfo [read, retain] |
Returned upon successful initialization of the portal. Contains details of the portal/organization as seen by the current user, anonymous or logged in.
- Since:
- 2.2
- (NSURL*) URL [read, retain] |
The URL of the portal.
- Since:
- 2.2
- (AGSPortalUser*) user [read, retain] |
Represents the registered user of the portal/organization and is returned upon successful initialization of the portal with a credential.
- Since:
- 2.2