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 IPagingParamsRequestOptions

Options for the request, including paging parameters.

Available requestOptions

Property Type Notes
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

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.

paging IPagingParams
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

Promise<IGroup> - A Promise that will resolve with the content of the group.

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

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