inviteGroupUsers

inviteGroupUsers

inviteGroupUsers(optionsIInviteGroupUsersOptions): Promise<IInviteGroupUsersResult>

Invites users to join a group. Operation success will be indicated by a flag on the return object. If there are any errors, they will be placed in an errors array on the return object.

Use dark colors for code blocksCopy
                    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
const authentication: IAuthenticationManager; // Typically passed into to the function

const options: IInviteGroupUsersOptions = {
 id: 'group_id',
 users: ['ed', 'edd', 'eddy'],
 role: 'group-member',
 expiration: 20160,
 authentication
}

const result = await inviteGroupUsers(options);

const if_success_result_looks_like = {
 success: true
}

const if_failure_result_looks_like = {
 success: false,
 errors: [ArcGISRequestError]
}
Parameters
ParameterType
options
IInviteGroupUsersOptions
Returns 
Promise<IInviteGroupUsersResult>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.