AGSPortalInfo.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <ArcGIS/AGSObject.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSPortalTypes.h>



typedef NS_ENUM(NSInteger, AGSPortalMode) {
    AGSPortalModeSingleTenant = 0,  
    AGSPortalModeMultiTenant,       
};

@class AGSPortal;
@class AGSEnvelope;
@class AGSLoadableImage;
@class AGSBasemap;
@class AGSPortalHelperServices;
@class AGSLicenseInfo;
@class AGSSubscriptionInfo;

@interface AGSPortalInfo : AGSObject <AGSJSONSerializable>

#pragma mark -
#pragma mark initializers



+(nullable AGSPortalInfo *)fromJSON:(id)JSONObject withPortal:(AGSPortal*)portal error:(NSError**)error;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, weak, readonly) AGSPortal *portal;

@property (nullable, nonatomic, copy, readonly) NSString *organizationID;

@property (nullable, nonatomic, copy, readonly) NSString *organizationName;

@property (nullable, nonatomic, copy, readonly) NSString *organizationDescription;

@property (nullable, nonatomic, copy, readonly) NSString *portalName;

@property (nullable, nonatomic, copy, readonly) NSString *featuredItemsGroupQuery;

@property (nonatomic, assign, readonly) BOOL canSharePublic;

@property (nonatomic, assign, readonly) BOOL canShareBingPublic;

@property (nonatomic, assign, readonly) BOOL canSearchPublic;

@property (nullable, nonatomic, copy, readonly) NSString *basemapGalleryGroupQuery;

@property (nullable, nonatomic, copy, readonly) NSString *vectorBasemapGalleryGroupQuery;

@property (nullable, nonatomic, strong, readonly) AGSEnvelope *defaultExtent;

@property (nullable, nonatomic, strong, readonly) AGSBasemap *defaultBasemap;

@property (nullable, nonatomic, strong, readonly) AGSBasemap *defaultVectorBasemap;

@property (nullable, nonatomic, copy, readonly) NSString *homePageFeaturedContentGroupQuery;

@property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *featuredGroupsQueries;

@property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;

@property (nullable, nonatomic, strong, readonly) AGSLoadableImage *organizationBanner;

@property (nonatomic, assign, readonly) AGSPortalAccess access;

@property (nonatomic, assign, readonly) AGSPortalMode portalMode;

@property (nullable, nonatomic, copy, readonly) NSString *customBaseDomain;

@property (nullable, nonatomic, copy, readonly) NSString *organizationSubdomain;

@property (nonatomic, strong, readonly) AGSPortalHelperServices *helperServices;

@property (nonatomic, assign, readonly) BOOL supportsOAuth;

@property (nullable, nonatomic, copy, readonly) NSString *bingKey;

@property (nonatomic, assign, readonly) BOOL commentsEnabled;

@property (nullable, nonatomic, strong, readonly) AGSLicenseInfo *licenseInfo ;;

@property (nonatomic, assign, readonly) BOOL allSSL;

@property (nullable, nonatomic, strong, readonly) NSDate *created;

@property (nullable, nonatomic, strong, readonly) NSLocale *locale;

@property (nonatomic, assign, readonly) NSInteger homePageFeaturedContentCount;

@property (nullable, nonatomic, copy, readonly) NSString *IPCountryCode;

@property (nonatomic, assign, readonly) BOOL isPortal;

@property (nullable, nonatomic, strong, readonly) NSDate *modified;

@property (nonatomic, assign, readonly) BOOL showHomePageDescription;

@property (nonatomic, assign, readonly) BOOL useVectorBasemaps;

@property (nullable, nonatomic, strong, readonly) AGSLoadableImage *portalThumbnail;

@property (nullable, nonatomic, copy, readonly) NSString *livingAtlasGroupQuery;

@property (nonatomic, assign, readonly, getter=isReadOnly) BOOL readOnly;

@property (nullable, nonatomic, copy, readonly) NSString *readOnlyMessage;

@property (nullable, nonatomic, strong, readonly) AGSSubscriptionInfo *subscriptionInfo;

#pragma mark -
#pragma mark methods

@end