AGSPortalGroup Class Reference
Description
An Instance of this class resource represents a group within the Portal or Organization. The owner is automatically an administrator and is returned in the list of admins. Adminstrators can invite, add to or remove members from a group as well as update or delete the group. The administrator for an organization may also reassign the group to another member of the organization. Group members may leave the group. Authenticated users may apply to join a group.
- See also:
- AGSPortalGroupDelegate
- Since:
- 2.2
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (NSOperation *) | - fetchThumbnail |
| (NSOperation *) | - fetchUsers |
| (id) | - initWithJSON: |
Properties | |
| AGSPortalAccess | access |
| NSArray * | admins |
| NSDate * | created |
| id< AGSPortalGroupDelegate > | delegate |
| NSString * | groupDescription |
| NSString * | groupId |
| BOOL | isInvitationOnly |
| NSDate * | modified |
| NSString * | owner |
| AGSPortal * | portal |
| NSString * | snippet |
| NSArray * | tags |
| UIImage * | thumbnail |
| NSString * | thumbnailFileName |
| NSString * | title |
| NSArray * | users |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (NSOperation*) fetchThumbnail |
Kicks off an operation to fetch a thumbnail image for the group. The corresponding methods on AGSPortalGroupDelegate are invoked when the operation completes successfully or encounters an error.
- Since:
- 2.2
| - (NSOperation*) fetchUsers |
Fetches the users and admins of the group. When completed, the admins and users properties will have requested information. The corresponding methods on AGSPortalGroupDelegate are invoked when the operation completes successfully or encounters an error.
- Since:
- 2.2
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
Reimplemented in AGSWebMapFeatureCollection.
Property Documentation
- (AGSPortalAccess) access [read, assign] |
Determines who can access the group's conent. Can be either AGSPortalAccessPrivate, AGSPortalAccessOrganization, or AGSPortalAccessPublic.
AGSPortalAccessPrivate implies only members of the group have access. AGSPortalAccessOrganization implies all members of the organization have access regardless of whether they are members of the group. AGSPortalAccessPublic implies everyone has access.
- Since:
- 2.2
- (NSArray*) admins [read, retain] |
Array of strings representing admin users of the group. These need to be fetched explicitly using fetchUsers
- Since:
- 2.2
- (NSDate*) created [read, retain] |
The date on which the group was created.
- Since:
- 2.2
- (id<AGSPortalGroupDelegate>) delegate [read, write, assign] |
The delegate for the portal group operations.
- Since:
- 2.2
- (NSString*) groupDescription [read, retain] |
The description of the group, if exists.
- Since:
- 2.2
- (NSString*) groupId [read, retain] |
Id of the group.
- Since:
- 2.2
- (BOOL) isInvitationOnly [read, assign] |
If YES, this group will not accept join requests. Else, this group does not require an invitation to join. Only group owners and admins can invite users to the group.
- Since:
- 2.2
- (NSDate*) modified [read, retain] |
The date on which the group was modified.
- Since:
- 2.2
- (NSString*) owner [read, retain] |
The user who created the group.
- Since:
- 2.2
- (AGSPortal*) portal [read, retain] |
The portal that the group belongs to.
- Since:
- 2.2
- (NSString*) snippet [read, retain] |
Snippet or summary of the group with a character limit of 250 characters.
- Since:
- 2.2
- (NSArray*) tags [read, retain] |
Words or short phrases that describe the group.
- Since:
- 2.2
- (UIImage*) thumbnail [read, retain] |
The thumbnail image file. This needs to be fetched explicitly using fetchThumbnail
- Since:
- 2.2
- (NSString*) thumbnailFileName [read, retain] |
The name of the thumbnail image of the group.
- Since:
- 2.2
- (NSString*) title [read, retain] |
The group title.
- Since:
- 2.2
- (NSArray*) users [read, retain] |
Array of strings representing users of the group. These need to be fetched explicitly using fetchUsers
- Since:
- 2.2