ArcGIS Runtime SDK for iOS: AGSPortalGroup.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSPortalGroup.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/AGSJSONSerializable.h>
30 #import <ArcGIS/AGSPortalTypes.h>
31 
32 
33 
38 typedef NS_ENUM(NSInteger, AGSPortalGroupSortField) {
46 };
47 
48 @class AGSLoadableImage;
49 @class AGSPortal;
52 
53 @protocol AGSCancelable;
54 
66 
67 #pragma mark -
68 #pragma mark initializers
69 
70 
71 
77 -(instancetype)initWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;
78 
79 
85 +(instancetype)portalGroupWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;
86 
92 +(nullable AGSPortalGroup *)fromJSON:(id)JSONObject withPortal:(AGSPortal*)portal error:(NSError**)error;
93 
94 #pragma mark -
95 #pragma mark properties
96 
101 @property (nullable, nonatomic, weak, readonly) AGSPortal *portal;
102 
106 @property (nullable, nonatomic, copy, readonly) NSString *groupID;
107 
111 @property (nullable, nonatomic, copy, readonly) NSString *title;
112 
116 @property (nullable, nonatomic, copy, readonly) NSString *owner;
117 
121 @property (nullable, nonatomic, copy, readonly) NSString *groupDescription;
122 
126 @property (nullable, nonatomic, copy, readonly) NSString *snippet;
127 
131 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *tags;
132 
136 @property (nullable, nonatomic, strong, readonly) NSDate *created;
137 
141 @property (nullable, nonatomic, strong, readonly) NSDate *modified;
142 
149 @property (nonatomic, assign, readonly) AGSPortalAccess access;
150 
154 @property (nonatomic, assign, readonly, getter=isInvitationOnly) BOOL invitationOnly;
155 
162 @property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;
163 
167 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *users;
168 
172 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *admins;
173 
177 @property (nonatomic, assign, readonly) AGSPortalGroupSortField sortField;
178 
182 @property (nonatomic, assign, readonly) AGSPortalQuerySortOrder sortOrder;
183 
187 @property (nonatomic, assign, readonly, getter=isViewOnly) BOOL viewOnly;
188 
192 @property (nullable, nonatomic, copy, readonly) NSString *phone;
193 
194 #pragma mark -
195 #pragma mark methods
196 
202 -(id<AGSCancelable>)fetchUsersWithCompletion:(nullable void(^)(NSArray<NSString*> * __nullable users, NSArray<NSString*> * __nullable admins, NSError * __nullable error))completion;
203 
222 -(id<AGSCancelable>)findItemsWithSearchParameters:(AGSPortalGroupContentSearchParameters *)parameters
223  completion:(void(^)(AGSPortalGroupContentSearchResultSet * __nullable result, NSError * __nullable error))completion;
224 
225 @end
226 
227 
AGSPortalGroupSortField
Definition: AGSPortalGroup.h:38
@ AGSPortalGroupSortFieldTitle
Definition: AGSPortalGroup.h:40
@ AGSPortalGroupSortFieldOwner
Definition: AGSPortalGroup.h:41
@ AGSPortalGroupSortFieldModified
Definition: AGSPortalGroup.h:45
@ AGSPortalGroupSortFieldUnknown
Definition: AGSPortalGroup.h:39
@ AGSPortalGroupSortFieldNumViews
Definition: AGSPortalGroup.h:43
@ AGSPortalGroupSortFieldCreated
Definition: AGSPortalGroup.h:44
@ AGSPortalGroupSortFieldAvgRating
Definition: AGSPortalGroup.h:42
AGSPortalQuerySortOrder
Definition: AGSPortalTypes.h:281
AGSPortalAccess
Definition: AGSPortalTypes.h:269
A base class for loadables.
Definition: AGSLoadableBase.h:45
An image that is loaded asynchronously.
Definition: AGSLoadableImage.h:35
Contains search parameters suitable for finding portal items that belong to a portal group.
Definition: AGSPortalGroupContentSearchParameters.h:51
Results of a Group Content Search operation performed on a PortalGroup.
Definition: AGSPortalGroupContentSearchResultSet.h:41
Represents a group within the Portal or Organization.
Definition: AGSPortalGroup.h:65
NSString * groupDescription
Definition: AGSPortalGroup.h:121
AGSPortalQuerySortOrder sortOrder
Definition: AGSPortalGroup.h:182
NSArray< NSString * > * users
Definition: AGSPortalGroup.h:167
AGSPortal * portal
Definition: AGSPortalGroup.h:101
AGSPortalAccess access
Definition: AGSPortalGroup.h:149
BOOL invitationOnly
Definition: AGSPortalGroup.h:154
NSArray< NSString * > * tags
Definition: AGSPortalGroup.h:131
AGSPortalGroupSortField sortField
Definition: AGSPortalGroup.h:177
BOOL viewOnly
Definition: AGSPortalGroup.h:187
NSString * snippet
Definition: AGSPortalGroup.h:126
NSString * phone
Definition: AGSPortalGroup.h:192
AGSLoadableImage * thumbnail
Definition: AGSPortalGroup.h:162
NSDate * modified
Definition: AGSPortalGroup.h:141
NSString * owner
Definition: AGSPortalGroup.h:116
NSArray< NSString * > * admins
Definition: AGSPortalGroup.h:172
NSString * groupID
Definition: AGSPortalGroup.h:106
NSDate * created
Definition: AGSPortalGroup.h:136
NSString * title
Definition: AGSPortalGroup.h:111
An Object representing a Portal for ArcGIS.
Definition: AGSPortal.h:105
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A protocol to convert objects to and from JSON.
Definition: AGSJSONSerializable.h:38