Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalGroup.html below:

PortalGroup | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import PortalGroup from "@arcgis/core/portal/PortalGroup.js";

CDN: const PortalGroup = await $arcgis.import("@arcgis/core/portal/PortalGroup.js");

Class: @arcgis/core/portal/PortalGroup

Since: ArcGIS Maps SDK for JavaScript 4.0

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, than all members of the organization are able to find the group. For additional information, see the ArcGIS REST API documentation for Group.

See also

• ArcGIS Organization portals

• Portal

Show inherited properties Hide inherited properties

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

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

The date the group was created.

declaredClass

Inherited

Property declaredClass Stringreadonly

Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

A detailed description of the group.

The unique id for the group.

isInvitationOnly Property isInvitationOnly Boolean

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

The date the group was last modified.

The username of the group's owner.

The portal associated with the group.

A short summary that describes the group.

sourceJSON Property sourceJSON Object

Since: ArcGIS Maps SDK for JavaScript 4.28 PortalGroup since 4.0, sourceJSON added at 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.

User defined tags that describe the group.

Since: ArcGIS Maps SDK for JavaScript 4.4 PortalGroup since 4.0, thumbnailUrl added at 4.4.

The URL to the thumbnail used for the group.

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.

Show inherited methods Hide inherited methods

addHandles

Inherited

Method addHandles(handleOrHandles, groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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

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 Method fetchCategorySchema(options){Promise<Object[]>}

Since: ArcGIS Maps SDK for JavaScript 4.8 PortalGroup since 4.0, fetchCategorySchema added at 4.8.

If present, fetches the group's category schema.

Parameters

optional

An object with the following properties.

Specification

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 Method fetchMembers(options){Promise<Members>}

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

optional

An object with the following properties.

Specification

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<Members> Resolves to an object with the members of 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);
     });
   });
});

Since: ArcGIS Maps SDK for JavaScript 4.4 PortalGroup since 4.0, getThumbnailUrl added at 4.4.

Get the URL to the thumbnail image for the group.

Available width sizes: 150, 300 and 600.

Parameter

optional

The desired image width.

Returns

hasHandles

Inherited

Method hasHandles(groupKey){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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");
}

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

Parameters

optional

The input query parameters defined in PortalQueryParams.

optional

An object with the following properties.

Specification

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

removeHandles

Inherited

Method removeHandles(groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");

Members Type Definition Members

Members returned in the result of fetchMembers().

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4