ensureMembership

Function
  • ensureMembership(currentUser: IUser, ownerUser: IUser, shouldPromote: boolean, errorMessage: string, requestOptions: IGroupSharingOptions) : IEnsureMembershipResult

Parameters

Parameter Type Default Notes
currentUser Required IUser
ownerUser Required IUser
shouldPromote Required boolean
errorMessage Required string
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
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

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.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

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 authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

IEnsureMembershipResult
Property Type Notes

Function defined in packages/arcgis-rest-portal/src/sharing/share-item-with-group.ts:226