PublicAPI.Portal.CalendarEvent.CreateReminder ELMA API Documentation
Create a reminder for a calendar event
 
 
Syntax

public Reminder CreateReminder(
	User user,
	CalendarEvent calendarEvent,
	TimeSpan remindToDate
)

Parameters

user
Type: User
Reminder author. Object. Access path: PublicAPI.Portal.Security.User
calendarEvent
Type: CalendarEvent
Calendar Event. Object. Access path: PublicAPI.Portal.CalendarEvent
remindToDate
Type: System TimeSpan
Remind to (period of time)

Return Value

Type: Reminder
Reminder
Examples

//load user by ID 
var user = PublicAPI.Portal.Security.User.Load(3);
//load calendar event by ID 
var calendarEvent = PublicAPI.Portal.CalendarEvent.Load(3);
//event reminder for a certain period of time 
var remindToDate = TimeSpan.FromDays(2);

//create a reminder 
var newReminder = PublicAPI.Portal.Event.CreateReminder(myUser, myClndrEvent, remindToDate);

// newReminder - created calendar event
See Also