ArcGIS Runtime SDK for iOS: AGSPortalGroup.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSPortalGroup.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 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 #import <ArcGIS/AGSCancelable.h>
32 
33 
34 
39 typedef NS_ENUM(NSInteger, AGSPortalGroupSortField) {
47 };
48 
49 @class AGSLoadableImage;
50 @class AGSPortal;
53 
65 
66 #pragma mark -
67 #pragma mark initializers
68 
69 
70 
76 -(instancetype)initWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;
77 
78 
84 +(instancetype)portalGroupWithPortal:(AGSPortal*)portal groupID:(NSString*)groupID;
85 
91 +(nullable AGSPortalGroup *)fromJSON:(id)JSONObject withPortal:(AGSPortal*)portal error:(NSError**)error;
92 
93 #pragma mark -
94 #pragma mark properties
95 
100 @property (nullable, nonatomic, weak, readonly) AGSPortal *portal;
101 
105 @property (nullable, nonatomic, copy, readonly) NSString *groupID;
106 
110 @property (nullable, nonatomic, copy, readonly) NSString *title;
111 
115 @property (nullable, nonatomic, copy, readonly) NSString *owner;
116 
120 @property (nullable, nonatomic, copy, readonly) NSString *groupDescription;
121 
125 @property (nullable, nonatomic, copy, readonly) NSString *snippet;
126 
130 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *tags;
131 
135 @property (nullable, nonatomic, strong, readonly) NSDate *created;
136 
140 @property (nullable, nonatomic, strong, readonly) NSDate *modified;
141 
148 @property (nonatomic, assign, readonly) AGSPortalAccess access;
149 
153 @property (nonatomic, assign, readonly, getter=isInvitationOnly) BOOL invitationOnly;
154 
161 @property (nullable, nonatomic, strong, readonly) AGSLoadableImage *thumbnail;
162 
166 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *users;
167 
171 @property (nullable, nonatomic, copy, readonly) NSArray<NSString*> *admins;
172 
176 @property (nonatomic, assign, readonly) AGSPortalGroupSortField sortField;
177 
181 @property (nonatomic, assign, readonly) AGSPortalQuerySortOrder sortOrder;
182 
186 @property (nonatomic, assign, readonly, getter=isViewOnly) BOOL viewOnly;
187 
191 @property (nullable, nonatomic, copy, readonly) NSString *phone;
192 
193 #pragma mark -
194 #pragma mark methods
195 
201 -(id<AGSCancelable>)fetchUsersWithCompletion:(nullable void(^)(NSArray<NSString*> * __nullable users, NSArray<NSString*> * __nullable admins, NSError * __nullable error))completion;
202 
221 -(id<AGSCancelable>)findItemsWithSearchParameters:(AGSPortalGroupContentSearchParameters *)parameters
222  completion:(void(^)(AGSPortalGroupContentSearchResultSet * __nullable result, NSError * __nullable error))completion;
223 
224 @end
225 
226 
AGSPortalGroupSortField
Definition: AGSPortalGroup.h:39
@ AGSPortalGroupSortFieldTitle
Definition: AGSPortalGroup.h:41
@ AGSPortalGroupSortFieldOwner
Definition: AGSPortalGroup.h:42
@ AGSPortalGroupSortFieldModified
Definition: AGSPortalGroup.h:46
@ AGSPortalGroupSortFieldUnknown
Definition: AGSPortalGroup.h:40
@ AGSPortalGroupSortFieldNumViews
Definition: AGSPortalGroup.h:44
@ AGSPortalGroupSortFieldCreated
Definition: AGSPortalGroup.h:45
@ AGSPortalGroupSortFieldAvgRating
Definition: AGSPortalGroup.h:43
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:64
NSString * groupDescription
Definition: AGSPortalGroup.h:120
AGSPortalQuerySortOrder sortOrder
Definition: AGSPortalGroup.h:181
NSArray< NSString * > * users
Definition: AGSPortalGroup.h:166
AGSPortal * portal
Definition: AGSPortalGroup.h:100
AGSPortalAccess access
Definition: AGSPortalGroup.h:148
BOOL invitationOnly
Definition: AGSPortalGroup.h:153
NSArray< NSString * > * tags
Definition: AGSPortalGroup.h:130
AGSPortalGroupSortField sortField
Definition: AGSPortalGroup.h:176
BOOL viewOnly
Definition: AGSPortalGroup.h:186
NSString * snippet
Definition: AGSPortalGroup.h:125
NSString * phone
Definition: AGSPortalGroup.h:191
AGSLoadableImage * thumbnail
Definition: AGSPortalGroup.h:161
NSDate * modified
Definition: AGSPortalGroup.h:140
NSString * owner
Definition: AGSPortalGroup.h:115
NSArray< NSString * > * admins
Definition: AGSPortalGroup.h:171
NSString * groupID
Definition: AGSPortalGroup.h:105
NSDate * created
Definition: AGSPortalGroup.h:135
NSString * title
Definition: AGSPortalGroup.h:110
An object representing a portal for ArcGIS.
Definition: AGSPortal.h:98
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