inviteUsers

Function

Attempts to invite users to a group

  • inviteUsers(id: string, users: IUser[], authentication: IAuthenticationManager, expiration: number, role: "group_member" | "group_admin") : Promise<IInviteGroupUsersResult>

Parameters

Parameter Type Default Notes
id Required string

ID of the group the users will be invited to

users Required IUser[]
authentication Required IAuthenticationManager
expiration Optional number 20160

How long the invite will be active (in minutes)

role Optional "group_member" | "group_admin" "group_member"

What role should they be added as. Defaults to group member

Returns

Result of the transaction (null if no users are passed in)

Promise<IInviteGroupUsersResult>
Property Type Notes

Function defined in packages/common/src/groups/add-users-workflow/workflow-sections/invite-users.ts:21