addOrInviteUsersToGroups

Function

addOrInviteUsersToGroups adds/invites N users to N groups Initial entry point function for add/invite members flow when dealing with multiple groups. Responses from each group are then consolidated into the final returned object.

addOrInviteUsersToGroups(groupIds: string[], users: IUserWithOrgType[], primaryRO: IAuthenticationManager, canAutoAddUser: boolean, addUserAsGroupAdmin: boolean, email: IAddOrInviteEmail) : Promise<{
errors:
ArcGISRequestError[]
notAdded:
string[]
notEmailed:
string[]
notInvited:
string[]
responses:
IAddOrInviteToGroupResult[]
}>

Parameters

Parameter	Type	Default	Notes
groupIds Required	string[]		array of groups we are adding users to
users Required	IUserWithOrgType[]		array of users to add to those groups
primaryRO Required	IAuthenticationManager		primary requestOptions
canAutoAddUser Optional	boolean	false
addUserAsGroupAdmin Optional	boolean	false
email Optional	IAddOrInviteEmail

Returns

{Promise<{ notAdded: string[]; notInvited: string[]; notEmailed: string[]; errors: ArcGISRequestError[]; responses: IAddOrInviteToGroupResult[]; }>} Results object

Promise<{
errors:
ArcGISRequestError[]
notAdded:
string[]
notEmailed:
string[]
notInvited:
string[]
responses:
IAddOrInviteToGroupResult[]
}>

Function defined in common/src/groups/addOrInviteUsersToGroups.ts:33