Enables scripted content fragments to get user invitation information.
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | UserInvitation | Returns the current contextual user invitation |
Methods
Accept
Accepts an invitation for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_userInvitation.Accept($invitationKey))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
invitationKey | Guid | Invitation Key | Required |
Return Type
Create
Creates a user invitation
Usage
#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
string | Required | ||||
message | string | Message | Required |
Return Type
Create
Creates a user invitation
Usage
#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message, $groupId, $groupMembershipType))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
string | Required | ||||
message | string | Message | Required | ||
groupId | int | Group Id | Required | ||
groupMembershipType | string | Group Membership Type | Required | EffectiveMember, Manager, Member, None, Owner, PendingMember |
Return Type
Create
Creates multiple user invitations
Usage
#set($iListResponse = $core_v2_userInvitation.Create($emails, $message))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
emails | IList<string> | Emails | Required | ||
message | string | Message | Required |
Return Type
IList<UserInvitation>
Create
Creates multiple user invitations
Usage
#set($iListResponse = $core_v2_userInvitation.Create($emails, $message, $groupId, $groupMembershipType))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
emails | IList<string> | Emails | Required | ||
message | string | Message | Required | ||
groupId | int | Group Id | Required | ||
groupMembershipType | string | Group Membership Type | Required | EffectiveMember, Manager, Member, None, Owner, PendingMember |
Return Type
IList<UserInvitation>
Get
Gets an invitation for the accessing user
Usage
#set($userInvitationResponse = $core_v2_userInvitation.Get($invitationKey))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
invitationKey | Guid | Invitation Key | Required |