ArcGIS Runtime SDK for iOS: AGSPortalInfo.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPortalInfo.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/AGSObject.h>
29 #import <ArcGIS/AGSJSONSerializable.h>
30 #import <ArcGIS/AGSPortalTypes.h>
31 
32 
33 
38 typedef NS_ENUM(NSInteger, AGSPortalMode) {
41 };
42 
43 @class AGSPortal;
44 @class AGSEnvelope;
45 @class AGSLoadableImage;
46 @class AGSBasemap;
48 @class AGSLicenseInfo;
49 @class AGSSubscriptionInfo;
50 
62 
63 #pragma mark -
64 #pragma mark initializers
65 
66 
67 
73 +(nullable AGSPortalInfo *)fromJSON:(id)JSONObject withPortal:(AGSPortal*)portal error:(NSError**)error;
74 
75 #pragma mark -
76 #pragma mark properties
77 
82 @property (nullable, nonatomic, weak, readonly) AGSPortal *portal;
83 
87 @property (nullable, nonatomic, copy, readonly) NSString *organizationID;
88 
92 @property (nullable, nonatomic, copy, readonly) NSString *organizationName;
93 
97 @property (nullable, nonatomic, copy, readonly) NSString *organizationDescription;
98 
102 @property (nullable, nonatomic, copy, readonly) NSString *portalName;
103 
107 @property (nullable, nonatomic, copy, readonly) NSString *featuredItemsGroupQuery;
108 
112 @property (nonatomic, assign, readonly) BOOL canSharePublic;
113 
117 @property (nonatomic, assign, readonly) BOOL canShareBingPublic;
118 
122 @property (nonatomic, assign, readonly) BOOL canSearchPublic;
123 
127 @property (nullable, nonatomic, copy, readonly) NSString *basemapGalleryGroupQuery;
128 
132 @property (nullable, nonatomic, copy, readonly) NSString *vectorBasemapGalleryGroupQuery;
133 
137 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *defaultExtent;
138 
142 @property (nullable, nonatomic, strong, readonly) AGSBasemap *defaultBasemap;
143 
147 @property (nullable, nonatomic, strong, readonly) AGSBasemap *defaultVectorBasemap;
148 
152 @property (nullable, nonatomic, copy, readonly) NSString *homePageFeaturedContentGroupQuery;
153 
157 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *featuredGroupsQueries;
158 
165 @property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;
166 
173 @property (nullable, nonatomic, strong, readonly) AGSLoadableImage *organizationBanner;
174 
181 @property (nonatomic, assign, readonly) AGSPortalAccess access;
182 
188 @property (nonatomic, assign, readonly) AGSPortalMode portalMode;
189 
195 @property (nullable, nonatomic, copy, readonly) NSString *customBaseDomain;
196 
202 @property (nullable, nonatomic, copy, readonly) NSString *organizationSubdomain;
203 
207 @property (nonatomic, strong, readonly) AGSPortalHelperServices *helperServices;
208 
212 @property (nonatomic, assign, readonly) BOOL supportsOAuth;
213 
217 @property (nullable, nonatomic, copy, readonly) NSString *bingKey;
218 
222 @property (nonatomic, assign, readonly) BOOL commentsEnabled;
223 
231 @property (nullable, nonatomic, strong, readonly) AGSLicenseInfo *licenseInfo ;;
232 
236 @property (nonatomic, assign, readonly) BOOL allSSL;
237 
241 @property (nullable, nonatomic, strong, readonly) NSDate *created;
242 
246 @property (nullable, nonatomic, strong, readonly) NSLocale *locale;
247 
251 @property (nonatomic, assign, readonly) NSInteger homePageFeaturedContentCount;
252 
256 @property (nullable, nonatomic, copy, readonly) NSString *IPCountryCode;
257 
261 @property (nonatomic, assign, readonly) BOOL isPortal;
262 
266 @property (nullable, nonatomic, strong, readonly) NSDate *modified;
267 
271 @property (nonatomic, assign, readonly) BOOL showHomePageDescription;
272 
276 @property (nonatomic, assign, readonly) BOOL useVectorBasemaps;
277 
284 @property (nullable, nonatomic, strong, readonly) AGSLoadableImage *portalThumbnail;
285 
289 @property (nullable, nonatomic, copy, readonly) NSString *livingAtlasGroupQuery;
290 
295 @property (nonatomic, assign, readonly, getter=isReadOnly) BOOL readOnly;
296 
302 @property (nullable, nonatomic, copy, readonly) NSString *readOnlyMessage;
303 
308 @property (nullable, nonatomic, strong, readonly) AGSSubscriptionInfo *subscriptionInfo;
309 
310 #pragma mark -
311 #pragma mark methods
312 
313 @end
314 
315 
AGSPortalMode
Definition: AGSPortalInfo.h:38
@ AGSPortalModeMultiTenant
Definition: AGSPortalInfo.h:40
@ AGSPortalModeSingleTenant
Definition: AGSPortalInfo.h:39
AGSPortalAccess
Definition: AGSPortalTypes.h:269
A basemap for a map or a scene.
Definition: AGSBasemap.h:135
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A class that contains information pertaining to a licensed named user.
Definition: AGSLicenseInfo.h:41
An image that is loaded asynchronously.
Definition: AGSLoadableImage.h:35
Definition: AGSObject.h:28
Services provided by an organization's portal.
Definition: AGSPortalHelperServices.h:40
An Object representing a Portal for ArcGIS.
Definition: AGSPortal.h:105
Information about a portal or organization.
Definition: AGSPortalInfo.h:61
BOOL supportsOAuth
Definition: AGSPortalInfo.h:212
BOOL useVectorBasemaps
Definition: AGSPortalInfo.h:276
NSDate * modified
Definition: AGSPortalInfo.h:266
NSString * bingKey
Definition: AGSPortalInfo.h:217
BOOL allSSL
Definition: AGSPortalInfo.h:231
AGSBasemap * defaultVectorBasemap
Definition: AGSPortalInfo.h:147
NSString * readOnlyMessage
Definition: AGSPortalInfo.h:302
AGSPortal * portal
Definition: AGSPortalInfo.h:82
BOOL canSearchPublic
Definition: AGSPortalInfo.h:122
NSString * customBaseDomain
Definition: AGSPortalInfo.h:195
NSDate * created
Definition: AGSPortalInfo.h:241
BOOL isPortal
Definition: AGSPortalInfo.h:261
AGSLoadableImage * thumbnail
Definition: AGSPortalInfo.h:165
NSString * livingAtlasGroupQuery
Definition: AGSPortalInfo.h:289
NSString * organizationDescription
Definition: AGSPortalInfo.h:97
NSString * portalName
Definition: AGSPortalInfo.h:102
AGSEnvelope * defaultExtent
Definition: AGSPortalInfo.h:137
NSString * IPCountryCode
Definition: AGSPortalInfo.h:256
NSInteger homePageFeaturedContentCount
Definition: AGSPortalInfo.h:251
BOOL commentsEnabled
Definition: AGSPortalInfo.h:222
NSString * organizationID
Definition: AGSPortalInfo.h:87
NSString * vectorBasemapGalleryGroupQuery
Definition: AGSPortalInfo.h:132
NSString * organizationName
Definition: AGSPortalInfo.h:92
NSLocale * locale
Definition: AGSPortalInfo.h:246
AGSPortalMode portalMode
Definition: AGSPortalInfo.h:188
AGSSubscriptionInfo * subscriptionInfo
Definition: AGSPortalInfo.h:308
BOOL readOnly
Definition: AGSPortalInfo.h:295
AGSLoadableImage * portalThumbnail
Definition: AGSPortalInfo.h:284
AGSBasemap * defaultBasemap
Definition: AGSPortalInfo.h:142
NSString * basemapGalleryGroupQuery
Definition: AGSPortalInfo.h:127
NSString * organizationSubdomain
Definition: AGSPortalInfo.h:202
AGSPortalHelperServices * helperServices
Definition: AGSPortalInfo.h:207
AGSLoadableImage * organizationBanner
Definition: AGSPortalInfo.h:173
BOOL canSharePublic
Definition: AGSPortalInfo.h:112
NSArray< NSString * > * featuredGroupsQueries
Definition: AGSPortalInfo.h:157
AGSLicenseInfo * licenseInfo
Definition: AGSPortalInfo.h:231
AGSPortalAccess access
Definition: AGSPortalInfo.h:181
NSString * homePageFeaturedContentGroupQuery
Definition: AGSPortalInfo.h:152
BOOL showHomePageDescription
Definition: AGSPortalInfo.h:271
BOOL canShareBingPublic
Definition: AGSPortalInfo.h:117
NSString * featuredItemsGroupQuery
Definition: AGSPortalInfo.h:107
Information about the user's subscription.
Definition: AGSSubscriptionInfo.h:51
A protocol to convert objects to and from JSON.
Definition: AGSJSONSerializable.h:38