AGSPortalUser Class Reference
Description
AGSPortalUser represents a registered user of a portal or organization. A Portal may have users who are unaffiliated with an organization or users who are part of an organization. Users sign in to the portal and create and share content which is organized into Items (AGSPortalItem). Users can create and join Groups (AGSPortalGroup) and share items with Groups. This makes the items visible and accessible to other members of the Group. Users could be in different roles including administrators, publishers and information workers. Administrators can add users to their organizations and have access to all content within the organization. All users can create web maps based on mashing up services that they have access to and can register services running on external servers. Publishers within an organization can in addition create hosted services based on data files that they upload.
- See also:
- AGSPortalUserDelegate
- Since:
- 2.2
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (NSOperation *) | - fetchContent |
| (NSOperation *) | - fetchContentInFolder: |
| (NSOperation *) | - fetchThumbnail |
| (id) | - initWithJSON: |
| (id) | - initWithPortal:username: |
Properties | |
| AGSPortalAccess | access |
| NSDate * | created |
| id< AGSPortalUserDelegate > | delegate |
| NSString * | |
| NSString * | fullName |
| NSArray * | groups |
| NSDate * | modified |
| NSString * | organizationId |
| AGSPortal * | portal |
| NSArray * | tags |
| UIImage * | thumbnail |
| NSString * | thumbnailFileName |
| NSString * | userDescription |
| NSString * | username |
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*) fetchContent |
Kicks off an operation that fetches the user's content at the root level (meaning, not under any folder).The corresponding methods on AGSPortalUserDelegate are invoked when the operation completes successfully or encounters an error.
- Since:
- 2.2
| - (NSOperation*) fetchContentInFolder: | (NSString *) | folderId |
Kicks off an operation that fetches the user's content within the specified folder. The corresponding methods on AGSPortalUserDelegate are invoked when the operation completes successfully or encounters an error.
- Parameters:
-
folderId The the id of the folder to fetch the content from.
- Since:
- 2.2
| - (NSOperation*) fetchThumbnail |
Kicks off an operation to fetch a thumbnail image for the user. The corresponding methods on AGSPortalUserDelegate 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.
| - (id) initWithPortal: | (AGSPortal *) | portal | ||
| username: | (NSString *) | username | ||
Initializes a portal user with a portal and a username.
- Parameters:
-
portal The portal that the user belongs to. username The username of the user.
- Since:
- 2.2
Property Documentation
- (AGSPortalAccess) access [read, assign] |
Determines if other users can search for this user's name to find content and groups owned by this user and to invite this user to join their groups. Can be @ AGSPortalAccessPrivate, AGSPortalAccessOrganization, or AGSPortalAccessPublic.
AGSPortalAccessPrivate implies the user is hidden and others cannot search for the user or view his/her information. AGSPortalAccessOrganization implies only members of the organization can search for or view the user's information. AGSPortalAccessPublic implies anyone can search for or access the user's information.
- Since:
- 2.2
- (NSDate*) created [read, retain] |
The date on which the user account was created.
- Since:
- 2.2
- (id<AGSPortalUserDelegate>) delegate [read, write, assign] |
The delegate for the portal user operations.
- Since:
- 2.2
- (NSString*) email [read, retain] |
Email of the user
- Since:
- 2.2
- (NSString*) fullName [read, retain] |
Full name of the user.
- Since:
- 2.2
- (NSArray*) groups [read, retain] |
Groups that the user is a member of.
- Since:
- 2.2
- (NSDate*) modified [read, retain] |
The date on which the user account was modified.
- Since:
- 2.2
- (NSString*) organizationId [read, retain] |
The id of the organization if the user belongs to an organization.
- Since:
- 2.2
- (AGSPortal*) portal [read, assign] |
The portal that the user belongs to.
- Since:
- 2.2
- (NSArray*) tags [read, retain] |
Words or short phrases that describe the user.
- Since:
- 2.2
- (UIImage*) thumbnail [read, retain] |
The thumbnail image for the user. This needs to be fetched explicitly using fetchThumbnail.
- Since:
- 2.2
- (NSString*) thumbnailFileName [read, retain] |
The file name of the thumbnail image of the user.
- Since:
- 2.2
- (NSString*) userDescription [read, retain] |
Description of the user, if exists.
- Since:
- 2.2
- (NSString*) username [read, retain] |
Username of the user.
- Since:
- 2.2