UserInvitations In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:05:39 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:05:39

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 In-Process API Event Argument|UserInvitationAfterAcceptEventArgs]] e);

Events.AfterCreate

Handler

void UserInvitationAfterCreateEventHandler([[UserInvitationAfterCreateEventArgs In-Process API Event Argument|UserInvitationAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void UserInvitationAfterDeleteEventHandler([[UserInvitationAfterDeleteEventArgs In-Process API Event Argument|UserInvitationAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void UserInvitationAfterUpdateEventHandler([[UserInvitationAfterUpdateEventArgs In-Process API Event Argument|UserInvitationAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void UserInvitationBeforeCreateEventHandler([[UserInvitationBeforeCreateEventArgs In-Process API Event Argument|UserInvitationBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void UserInvitationBeforeDeleteEventHandler([[UserInvitationBeforeDeleteEventArgs In-Process API Event Argument|UserInvitationBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void UserInvitationBeforeUpdateEventHandler([[UserInvitationBeforeUpdateEventArgs In-Process API Event Argument|UserInvitationBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	User Invitations data type identifier

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

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

UserInvitation Create(string email, string message);

Create a User invitation

Parameters

Name	Type	Description	Required	Default	Options
email	`string`	Email of the recipient	Required
message	`string`	Invitation message	Required

Return Type

[[UserInvitation In-Process API Supplementary Type|UserInvitation]]

UserInvitation Create(string email, string message, int groupId, string groupMembershipType);

Create a User invitation for a group

Parameters

Name	Type	Description	Required
email	`string`	Email of the recipient	Required
message	`string`	Invitation message	Required
groupId	`int`	Group Id	Required
groupMembershipType	`string`	Group membership type	Required

Return Type

[[UserInvitation In-Process API Supplementary Type|UserInvitation]]

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 In-Process API Supplementary Type|UserInvitation]]>

IList<UserInvitation> Create(string[] emails, string message, int groupId, string groupMembershipType);

Parameters

Name	Type	Description	Required
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 In-Process API Supplementary Type|UserInvitation]]>

UserInvitation Get(Guid invitationKey);

Gets an invitation for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
invitationKey	`Guid`	Invitation key	Required

Return Type

[[UserInvitation In-Process API Supplementary Type|UserInvitation]]