AGSPortal.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/AGSLoadableBase.h>
#import <ArcGIS/AGSRemoteResource.h>



typedef NS_ENUM(NSInteger, AGSPortalLoginType) {
    AGSPortalLoginTypeOAuth = 0,
    AGSPortalLoginTypeClientCertificate,
    AGSPortalLoginTypeUsernamePassword,
    AGSPortalLoginTypeUnknown
} ;

@class AGSPortalFolder;
@class AGSPortalItem;
@class AGSPortalQueryParameters;
@class AGSPortalUser;
@class AGSPortalGroup;
@class AGSPortalInfo;
@class AGSPortalQueryResultSet;
@class AGSBasemap;
@class AGSLicenseInfo;

@protocol AGSCancelable;

@interface AGSPortal : AGSLoadableBase <AGSRemoteResource>

#pragma mark -
#pragma mark initializers



-(instancetype)initWithURL:(NSURL *)url loginRequired:(BOOL)loginRequired;

+(instancetype)portalWithURL:(NSURL*)URL loginRequired:(BOOL)loginRequired;

+(instancetype)ArcGISOnlineWithLoginRequired:(BOOL)loginRequired;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readonly) AGSPortalInfo *portalInfo;

@property (nullable, nonatomic, strong, readonly) AGSPortalUser *user;

@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *featuredGroups;

@property (nonatomic, assign, readonly, getter=isLoginRequired) BOOL loginRequired;

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

#pragma mark -
#pragma mark methods

-(id<AGSCancelable>)findItemsWithQueryParameters:(AGSPortalQueryParameters*)queryParameters
                                      completion:(void(^)(AGSPortalQueryResultSet * __nullable resultSet, NSError * __nullable error))completion;

-(id<AGSCancelable>)findGroupsWithQueryParameters:(AGSPortalQueryParameters*)queryParameters
                                       completion:(void(^)(AGSPortalQueryResultSet * __nullable resultSet, NSError * __nullable error))completion;


-(id<AGSCancelable>)fetchBasemapsWithCompletion:(nullable void(^)(NSArray<AGSBasemap*> * __nullable basemaps, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchVectorBasemapsWithCompletion:(void(^)(NSArray<AGSBasemap*> * __nullable vectorBasemaps, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchFeaturedGroupsWithCompletion:(nullable void(^)(NSArray<AGSPortalGroup*> * __nullable featuredGroups, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchFeaturedItemsWithCompletion:(nullable void(^)(NSArray<AGSPortalItem*> * __nullable featuredItems, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchHomePageFeaturedContentWithCompletion:(nullable void(^)(NSArray<AGSPortalItem*> * __nullable featuredItems, NSError * __nullable error))completion;

-(void)logout ;

+(id<AGSCancelable>)loginTypeForURL:(NSURL*)url completion:(void(^)(AGSPortalLoginType loginType, NSError * __nullable error))completion;

-(id<AGSCancelable>)fetchLicenseInfoWithCompletion:(void(^)(AGSLicenseInfo * __nullable licenseInfo, NSError * __nullable error))completion;

@end