getUserMembership

Function

Get the User Membership for a particular group. Use this if all you have is the groupId. If you have the group object, check the userMembership.memberType property instead of calling this method.

Parameters

Parameter Type Default Notes
requestOptions Required IGroupSharingOptions

Available requestOptions

Property Type Notes
groupId string

Group identifier

authentication Inherited UserSession

A session representing a logged in user.

id Inherited string

Unique identifier for the item.

confirmItemControl Optional boolean
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.

owner Optional Inherited string

Item owner, if different from the authenticated user.

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 resolves with "owner" | "admin" | "member" | "nonmember"

Promise<GroupMembership>
Property Type Notes

Function defined in packages/arcgis-rest-portal/src/sharing/helpers.ts:65