Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: PortalGroup
[ AMD Module Require | Legacy Module Require ]
require(["esri/arcgis/Portal"], function(arcgisPortal) { /* code goes here */ });
Description
(Added at v2.8)
The group resource represents a group within the Portal. A group resource represents a group (e.g., "San Bernardino Fires"). The visibility of the group to other users is determined by the access property. If the group is private no one except the administrators and the members of the group will be able to see it. If the group is shared with an organization, then all members of the organization will be able to find the group. View the ArcGIS Portal API REST documentation for the Group for more details.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| access | String | The access privileges on the group which determines who can see and access the group. |
| created | Date | The date the group was created. |
| description | String | A detailed description of the group. |
| id | String | The id for the group. |
| isInvitationOnly | Boolean | If this is set to true, then users will not be able to apply to join the group. |
| isViewOnly | Boolean | Denotes a view only group where members are not able to share items. |
| modified | Date | The date the group was last modified. |
| owner | String | The username of the group's owner. |
| portal | Portal | The portal for the group. |
| snippet | String | A short summary that describes the group. |
| tags | String[] | User defined tags that describe the group. |
| thumbnailUrl | String | The url to the thumbnail used for the group. |
| title | String | The title for the group. |
| url | String | The url to the group. |
Methods
| Name | Return type | Summary |
|---|---|---|
| getMembers() | Deferred | Get the current members for the group. |
| getThumbnailUrl(width?) | String | Get the URL to the thumbnail image for the portal group. |
| queryItems(queryParams?) | Deferred | Execute a query against the group to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalItem objects that match the input query. |
Property Details
<String
StringThe access privileges on the group which determines who can see and access the group. Can be: private, org, or public.
<Date
DateThe date the group was created.
<String
StringA detailed description of the group.
<String
StringThe id for the group.
<Boolean
BooleanIf this is set to true, then users will not be able to apply to join the group.
Known values:
true | false<Boolean
BooleanDenotes a view only group where members are not able to share items. (Added at v3.4)
Known values:
true | falseDefault value:
false<Date
DateThe date the group was last modified.
<String
StringThe username of the group's owner.
<Portal
PortalThe portal for the group.
<String
StringA short summary that describes the group.
<String[]
String[]User defined tags that describe the group.
<String
StringThe url to the thumbnail used for the group.
<String
StringThe title for the group. This is the name that is displayed to users and by which they refer to the group. Every group must have a title and it must be unique for a user.
<String
StringThe url to the group.
Method Details
Get the current members for the group. Returns a deferred that when resolved provides access to a the
Object listed below in the Object Specifications table. Provides access to list the users, owner and administrator of a group. Only available to members or administrators of the group. View the ArcGIS Portal API REST documentation for the Group Users for more details.Return type:
DeferredObject Specifications:
<
Object>< |
Required | An array containing the user names for each administrator of the group. |
< |
Required | The user name of the owner of the group. |
< |
Required | An array containing the user names for each user in the group. |
Sample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
portalGroup.getMembers().then(function(members){
array.forEach(members.admins,function(admin){
console.log(admin);
});
});
...
});
Get the URL to the thumbnail image for the portal group.
Available width sizes: 150, 300 and 600. (Added at v3.21)
Available width sizes: 150, 300 and 600. (Added at v3.21)
Return type:
StringParameters:
< |
Optional | The desired image width. |
Execute a query against the group to return a deferred that when resolved returns PortalQueryResult that contain a results array of PortalItem objects that match the input query.
Return type:
DeferredParameters:
< |
Optional | The input query parameters. |
Object Specifications:
<
queryParams>< |
Required | The maximum number of results to be included in the result set response. The Default value is 10 and the maximum allowed value is 100. The start parameter combined with the num parameter can be used to paginate the search results. Note that the actual number of returned results may be less than num if the number of results remaining after start is less than num. |
< |
Required | The query string used for a search. View the ArcGIS REST API Search Reference for details on constructing a valid query. |
< |
Required | A comma separated list of field(s) to sort by. Valid fields are: title, created, type, owner, avgRating, numRatings, numComments and numViews. |
< |
Required | The number of the first entry in the result set response. The index number is 1-based. The start parameter, along with the num parameter can be used to paginate the search results. |