getGroupContent

Function

Returns the content of a Group. Since the group may contain 1000s of items the requestParams allow for paging.

Parameters

Parameter Type Default Notes
id Required string

Group Id

requestOptions Optional IGetGroupContentOptions

Options for the request, including paging parameters.

Available requestOptions

Property Type Notes
paging IPagingParams
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that will resolve with the content of the group.

Promise<IGroup>
Property Type Notes
autoJoin boolean
created number
id string
isFav boolean
isInvitationOnly boolean
isViewOnly boolean
modified number
owner string
protected boolean
tags string[] | string
access Inherited "private" | "org" | "public"
title Inherited string
hasCategorySchema Optional boolean
isOpenData Optional boolean
userMembership Optional {
applications:
number
memberType:
GroupMembership
username:
string
}
description Optional Inherited string
phone Optional Inherited string
snippet Optional Inherited string
sortField Optional Inherited "title" | "owner" | "avgrating" | "numviews" | "created" | "modified"
sortOrder Optional Inherited "asc" | "desc"
thumbnail Optional Inherited string

Function defined in packages/arcgis-rest-portal/src/groups/get.ts:60