ArcGIS Runtime SDK for iOS: AGSPortal.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPortal.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSRemoteResource.h>
30 
31 
32 
37 typedef NS_ENUM(NSInteger, AGSPortalLoginType) {
42 } ;
43 
44 @class AGSPortalFolder;
45 @class AGSPortalItem;
47 @class AGSPortalUser;
48 @class AGSPortalGroup;
49 @class AGSPortalInfo;
51 @class AGSBasemap;
52 @class AGSLicenseInfo;
53 
54 @protocol AGSCancelable;
55 
106 
107 #pragma mark -
108 #pragma mark initializers
109 
110 
111 
125 -(instancetype)initWithURL:(NSURL *)url loginRequired:(BOOL)loginRequired;
126 
141 +(instancetype)portalWithURL:(NSURL*)URL loginRequired:(BOOL)loginRequired;
142 
155 +(instancetype)ArcGISOnlineWithLoginRequired:(BOOL)loginRequired;
156 
157 #pragma mark -
158 #pragma mark properties
159 
164 @property (nullable, nonatomic, strong, readonly) AGSPortalInfo *portalInfo;
165 
169 @property (nullable, nonatomic, strong, readonly) AGSPortalUser *user;
170 
176 @property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *featuredGroups;
177 
184 @property (nonatomic, assign, readonly, getter=isLoginRequired) BOOL loginRequired;
185 
194 @property (nullable, nonatomic, strong, readwrite) NSLocale *locale;
195 
196 #pragma mark -
197 #pragma mark methods
198 
210 -(id<AGSCancelable>)findItemsWithQueryParameters:(AGSPortalQueryParameters*)queryParameters
211  completion:(void(^)(AGSPortalQueryResultSet * __nullable resultSet, NSError * __nullable error))completion;
212 
221 -(id<AGSCancelable>)findGroupsWithQueryParameters:(AGSPortalQueryParameters*)queryParameters
222  completion:(void(^)(AGSPortalQueryResultSet * __nullable resultSet, NSError * __nullable error))completion;
223 
224 
232 -(id<AGSCancelable>)fetchBasemapsWithCompletion:(nullable void(^)(NSArray<AGSBasemap*> * __nullable basemaps, NSError * __nullable error))completion;
233 
241 -(id<AGSCancelable>)fetchVectorBasemapsWithCompletion:(void(^)(NSArray<AGSBasemap*> * __nullable vectorBasemaps, NSError * __nullable error))completion;
242 
250 -(id<AGSCancelable>)fetchFeaturedGroupsWithCompletion:(nullable void(^)(NSArray<AGSPortalGroup*> * __nullable featuredGroups, NSError * __nullable error))completion;
251 
259 -(id<AGSCancelable>)fetchFeaturedItemsWithCompletion:(nullable void(^)(NSArray<AGSPortalItem*> * __nullable featuredItems, NSError * __nullable error))completion;
260 
268 -(id<AGSCancelable>)fetchHomePageFeaturedContentWithCompletion:(nullable void(^)(NSArray<AGSPortalItem*> * __nullable featuredItems, NSError * __nullable error))completion;
269 
275 -(void)logout ;
276 
283 +(id<AGSCancelable>)loginTypeForURL:(NSURL*)url completion:(void(^)(AGSPortalLoginType loginType, NSError * __nullable error))completion;
284 
294 -(id<AGSCancelable>)fetchLicenseInfoWithCompletion:(void(^)(AGSLicenseInfo * __nullable licenseInfo, NSError * __nullable error))completion;
295 
296 @end
297 
298 
AGSPortalLoginType
Definition: AGSPortal.h:37
@ AGSPortalLoginTypeUsernamePassword
Definition: AGSPortal.h:40
@ AGSPortalLoginTypeUnknown
Definition: AGSPortal.h:41
@ AGSPortalLoginTypeOAuth
Definition: AGSPortal.h:38
@ AGSPortalLoginTypeClientCertificate
Definition: AGSPortal.h:39
A basemap for a map or a scene.
Definition: AGSBasemap.h:135
A class that contains information pertaining to a licensed named user.
Definition: AGSLicenseInfo.h:41
A base class for loadables.
Definition: AGSLoadableBase.h:45
Represents a folder of content within the Portal or Organization.
Definition: AGSPortalFolder.h:38
Represents a group within the Portal or Organization.
Definition: AGSPortalGroup.h:65
An Object representing a Portal for ArcGIS.
Definition: AGSPortal.h:105
AGSPortalInfo * portalInfo
Definition: AGSPortal.h:164
NSArray< AGSPortalGroup * > * featuredGroups
Definition: AGSPortal.h:176
BOOL loginRequired
Definition: AGSPortal.h:184
NSLocale * locale
Definition: AGSPortal.h:194
AGSPortalUser * user
Definition: AGSPortal.h:169
void logout()
Information about a portal or organization.
Definition: AGSPortalInfo.h:61
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
Defines a query on a portal.
Definition: AGSPortalQueryParameters.h:40
Results of a query on a portal.
Definition: AGSPortalQueryResultSet.h:39
An object representing a registered user of the portal or organization.
Definition: AGSPortalUser.h:67
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A protocol adopted by classes that access remote network resources that have the potential to be secu...
Definition: AGSRemoteResource.h:40