Enables scripted content fragments to get user invitation information.

Properties

NameTypeDescriptionDefaultOptions
CurrentUserInvitationReturns the current contextual user invitation

Methods

Accept

Accepts an invitation for the accessing user

Usage

#set($additionalInfoResponse = $core_v2_userInvitation.Accept($invitationKey))

Parameters

NameTypeDescriptionRequiredDefaultOptions
invitationKeyGuidInvitation KeyRequired

Return Type

AdditionalInfo

Create

Creates a user invitation

Usage

#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message))

Parameters

NameTypeDescriptionRequiredDefaultOptions
emailstringEmailRequired
messagestringMessageRequired

Return Type

UserInvitation

Create

Creates a user invitation

Usage

#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message, $groupId, $groupMembershipType))

Parameters

NameTypeDescriptionRequiredDefaultOptions
emailstringEmailRequired
messagestringMessageRequired
groupIdintGroup IdRequired
groupMembershipTypestringGroup Membership TypeRequiredEffectiveMember, Manager, Member, None, Owner, PendingMember

Return Type

UserInvitation

Create

Creates multiple user invitations

Usage

#set($iListResponse = $core_v2_userInvitation.Create($emails, $message))

Parameters

NameTypeDescriptionRequiredDefaultOptions
emailsIList<string>EmailsRequired
messagestringMessageRequired

Return Type

IList<UserInvitation>

Create

Creates multiple user invitations

Usage

#set($iListResponse = $core_v2_userInvitation.Create($emails, $message, $groupId, $groupMembershipType))

Parameters

NameTypeDescriptionRequiredDefaultOptions
emailsIList<string>EmailsRequired
messagestringMessageRequired
groupIdintGroup IdRequired
groupMembershipTypestringGroup Membership TypeRequiredEffectiveMember, 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

NameTypeDescriptionRequiredDefaultOptions
invitationKeyGuidInvitation KeyRequired

Return Type

UserInvitation