Property Overview

Property Details

access String

The access privileges on the group which determines who can see and access the group.

Possible Values:"private"|"org"|"public"

created Date

The date the group was created.

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

description String

A detailed description of the group.

id String

The unique id for the group.

isInvitationOnly Boolean

If set to true, then users will not be able to apply to join the group.

Default Value:false

modified Date

The date the group was last modified.

owner String

The username of the group's owner.

portal Portal

The portal associated with the group.

snippet String

A short summary that describes the group.

tags String[]

User defined tags that describe the group.

thumbnailUrl Stringreadonly

Since: ArcGIS API for JavaScript 4.4

The URL to the thumbnail used for the group.

See also:

• getThumbnailUrl()

title String

The title of the group. This is the name that is displayed to users. It is also used to refer to the group. Every group must have a title and it must be unique.

url Stringreadonly

The URL to the group.

Method Overview

Method Details

fetchCategorySchema(options){Promise<Object[]>}

Since: ArcGIS API for JavaScript 4.8

If present, fetches the group's category schema.

Parameters:

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<Object[]>	Resolves to an array of objects containing the following properties: Property Type Description title string The title of the category schema. categories object[] An array of objects containing a title and an optional array of subcategories.

Example:

// Fetch featured group members
portal.fetchFeaturedGroups().then(function(groups){
  groups.forEach(function(group){
    // Fetch group category schema
    group.fetchCategorySchema().then(function(schemas){
      schemas.forEach(function(schema){
        console.log("schema: ", schema);
      })
    });
  });
});

fetchMembers(options){Promise<Object>}

Fetches the current members of the group. This method is only available to members or administrators of the group. View the ArcGIS REST API documentation for the Group Users for more details.

Parameters:

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<Object>	Resolves to an object with the following properties: Property Type Description admins String[] An array containing the user names for each administrator of the group. owner String The user name of the owner of the group. users String[] An array containing the user names for each user in the group.

Example:

// Fetch featured group members
portal.fetchFeaturedGroups().then(function(groups){
   groups.forEach(function(group){
     group.fetchMembers().then(function(members){
       console.log("member", members);
     });
   });
});

getThumbnailUrl(width){String}

Since: ArcGIS API for JavaScript 4.4

Get the URL to the thumbnail image for the group.

Available width sizes: 150, 300 and 600.

Parameter:

width Number optional The desired image width.

Returns:

Type	Description
String	The URL to the thumbnail image.

queryItems(queryParams, options){Promise<PortalQueryResult>}

Executes a query against the group to return an array of PortalItem objects that match the input query.

Parameters:

queryParams PortalQueryParams autocast optional Autocasts from Object The input query parameters defined in PortalQueryParams.

options Object optional An object with the following properties. Specification: signal AbortSignal optional Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:

Type	Description
Promise<PortalQueryResult>	When resolved, resolves to an instance of PortalQueryResult which contains a results array of PortalItem objects representing all the items that match the input query.