protectGroup

Function

import { protectGroup } from '@esri/arcgis-rest-groups';
//
protectGroup({
  id: groupId,
  authentication
})
  .then(response)

Protect a group to avoid accidental deletion. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IGroupIdRequestOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

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.

id string
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

Promise<{

success:
boolean
}> - A Promise that will resolve with the success/failure status of the request


Function defined in packages/arcgis-rest-groups/src/protect.ts:23