PortalGroup

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 Maps SDK 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.

sourceJSON Object

Since: ArcGIS Maps SDK for JavaScript 4.28

The JSON used to create the property values when the PortalGroup is created. Although most commonly used properties are exposed on the PortalGroup class directly, this provides access to all information returned for the portal group. This property is useful if working in an application built using an older version of the API which requires access to a portal's group properties from a more recent version.

See also

• ArcGIS REST API - Group

tags String[]

User defined tags that describe the group.

thumbnailUrl Stringreadonly

Since: ArcGIS Maps SDK 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

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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

Since: ArcGIS Maps SDK 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 Maps SDK 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.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

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.

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");