Work with User's invitations
This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUserInvitations>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterAccept
Handler
void UserInvitationAfterAcceptEventHandler(UserInvitationAfterAcceptEventArgs e);
Events.AfterCreate
Handler
void UserInvitationAfterCreateEventHandler(UserInvitationAfterCreateEventArgs e);
Events.AfterDelete
Handler
void UserInvitationAfterDeleteEventHandler(UserInvitationAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void UserInvitationAfterUpdateEventHandler(UserInvitationAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void UserInvitationBeforeCreateEventHandler(UserInvitationBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void UserInvitationBeforeDeleteEventHandler(UserInvitationBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void UserInvitationBeforeUpdateEventHandler(UserInvitationBeforeUpdateEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| DataTypeId Obsolete | Guid | Migrate usage to scripted email or scripted plugins. |
Methods
AdditionalInfo Accept(Guid invitationKey);
Accepts an invitation for the accessing user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| invitationKey | Guid | Invitation key | Required |
Return Type
UserInvitation Create(string email, string message);
Create a User invitation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
string | Email of the recipient | Required | |||
| message | string | Invitation message | Required |
Return Type
UserInvitation Create(string email, string message, int groupId, string groupMembershipType);
Create a User invitation for a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
string | Email of the recipient | Required | |||
| message | string | Invitation message | Required | ||
| groupId | int | Group Id | Required | ||
| groupMembershipType | string | Group membership type | Required |
Return Type
IList<UserInvitation> Create(string[] emails, string message);
Create a multiple User invitation
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| emails | string[] | Emails of the recipients | Required | ||
| message | string | Invitation message | Required |
Return Type
IList<UserInvitation>
IList<UserInvitation> Create(string[] emails, string message, int groupId, string groupMembershipType);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| emails | string[] | Emails of the recipients | Required | ||
| message | string | Invitation message | Required | ||
| groupId | int | Group Id | Required | ||
| groupMembershipType | string | Group membership type | Required |
Return Type
IList<UserInvitation>
UserInvitation Get(Guid invitationKey);
Gets an invitation for the accessing user
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| invitationKey | Guid | Invitation key | Required |