AGSPortalUser.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 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 <Foundation/Foundation.h>
#import <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSJSONSerializable.h>
#import <ArcGIS/AGSPortalTypes.h>
#import <ArcGIS/AGSUnitSystem.h>
#import <ArcGIS/AGSCancelable.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSPortalUserRole) {
    AGSPortalUserRoleUnknown = 0,   
    AGSPortalUserRoleUser,          
    AGSPortalUserRolePublisher,     
    AGSPortalUserRoleAdmin,         
} ;
 
@class AGSPortal;
@class AGSPortalFolder;
@class AGSPortalGroup;
@class AGSPortalItem;
@class AGSLoadableImage;
@class AGSPortalItemContentParameters;
@class AGSPortalPrivilege;
 
@interface AGSPortalUser : AGSLoadableBase <AGSJSONSerializable>
 
#pragma mark -
#pragma mark initializers
 
 
 
-(instancetype)initWithPortal:(AGSPortal*)portal username:(NSString*)username;
 
+(nullable AGSPortalUser *)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 *username;
 
@property (nullable, nonatomic, copy, readonly) NSString *fullName;
 
@property (nullable, nonatomic, copy, readonly) NSString *userDescription;
 
@property (nullable, nonatomic, copy, readonly) NSString *email;
 
@property (nullable, nonatomic, copy, readonly) NSString *organizationID;
 
@property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *tags;
 
@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalGroup*> *groups;
 
@property (nonatomic, assign, readonly) AGSPortalAccess access;
 
@property (nullable, nonatomic, strong, readonly) NSDate *created;
 
@property (nullable, nonatomic, strong, readonly) NSDate *modified;
 
@property (nonatomic, assign, readonly) AGSPortalUserRole role;
 
@property (nullable, nonatomic, copy, readonly) NSString *favoritesGroupID;
 
@property (nonatomic, assign, readonly) AGSUnitSystem units;
 
@property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;
 
@property (nullable, nonatomic, copy, readonly) NSArray<AGSPortalPrivilege*> *privileges;
 
#pragma mark -
#pragma mark methods
 
-(id<AGSCancelable>)fetchContentWithCompletion:(void(^)(NSArray<AGSPortalItem*> * __nullable items, NSArray<AGSPortalFolder*> * __nullable folders, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)fetchContentInFolder:(nullable NSString*)folderID completion:(void(^)(NSArray<AGSPortalItem*> * __nullable items, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)addToFavorites:(AGSPortalItem *)item completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)removeFromFavorites:(AGSPortalItem *)item completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)fetchFavoriteStatus:(AGSPortalItem *)item completion:(void(^)(BOOL isFavorite, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)createFolder:(NSString *)title
                       completion:(nullable void(^)(AGSPortalFolder * __nullable folder, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)deleteFolder:(AGSPortalFolder *)folder completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)deletePortalItem:(AGSPortalItem*)portalItem completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)addPortalItem:(AGSPortalItem *)portalItem
            withContentParameters:(nullable AGSPortalItemContentParameters *)contentParameters
                         toFolder:(nullable AGSPortalFolder *)folder
                       completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)movePortalItem:(AGSPortalItem *)portalItem
                           toFolder:(nullable AGSPortalFolder *)folder
                         completion:(nullable void(^)(NSError * __nullable error))completion;
 
-(id<AGSCancelable>)movePortalItems:(NSArray<AGSPortalItem*> *)portalItems
                            toFolder:(nullable AGSPortalFolder *)folder
                          completion:(nullable void(^)(NSDictionary<NSString*,NSError*> * __nullable moveErrors, NSError * __nullable error))completion;
 
@end