Table of Contents

Class EventAggregate

Namespace
InSite.Domain.Events
Assembly
Shift.Sdk.dll
public class EventAggregate : AggregateRoot
Inheritance
EventAggregate
Inherited Members
Extension Methods

Constructors

EventAggregate() 

public EventAggregate()

Properties

Data 

public EventState Data { get; }

Property Value

EventState

Methods

AddEventAchievement(Guid) 

public void AddEventAchievement(Guid achievement)

Parameters

achievement Guid

AddEventAssessment(Guid) 

public void AddEventAssessment(Guid form)

Parameters

form Guid

AddEventAttendee(Guid, string, bool) 

public void AddEventAttendee(Guid contact, string role, bool validate)

Parameters

contact Guid
role string
validate bool

AddLearnerRegistrationGroup(Guid?) 

public void AddLearnerRegistrationGroup(Guid? learnerRegistrationGroup)

Parameters

learnerRegistrationGroup Guid?

AddSeat(Guid, string, string, bool, bool, int?, string) 

public void AddSeat(Guid seat, string configuration, string content, bool isAvailable, bool isTaxable, int? orderSequence, string title)

Parameters

seat Guid
configuration string
content string
isAvailable bool
isTaxable bool
orderSequence int?
title string

AdjustCandidateCapacity(int?, int?, ToggleType) 

public void AdjustCandidateCapacity(int? min, int? max, ToggleType waitlist)

Parameters

min int?
max int?
waitlist ToggleType

AdjustInvigilatorCapacity(int?, int?) 

public void AdjustInvigilatorCapacity(int? min, int? max)

Parameters

min int?
max int?
public void AllowEventRegistrationWithLink()

CancelEvent(string, bool) 

public void CancelEvent(string reason, bool cancelRegistration)

Parameters

reason string
cancelRegistration bool

CancelEventTimer(Guid) 

public void CancelEventTimer(Guid timer)

Parameters

timer Guid

ChangeAppointmentType(string) 

public void ChangeAppointmentType(string appointmentType)

Parameters

appointmentType string

ChangeDistribution(string, DateTimeOffset?, DateTimeOffset?, DateTimeOffset?, DateTimeOffset?) 

public void ChangeDistribution(string process, DateTimeOffset? ordered, DateTimeOffset? expected, DateTimeOffset? shipped, DateTimeOffset? started)

Parameters

process string
ordered DateTimeOffset?
expected DateTimeOffset?
shipped DateTimeOffset?
started DateTimeOffset?

ChangeEventAchievement(Guid?) 

public void ChangeEventAchievement(Guid? achievement)

Parameters

achievement Guid?

ChangeEventCalendarColor(string) 

public void ChangeEventCalendarColor(string calendarColor)

Parameters

calendarColor string

ChangeEventCreditHours(decimal?) 

public void ChangeEventCreditHours(decimal? credit)

Parameters

credit decimal?

ChangeEventDuration(int?, string) 

public void ChangeEventDuration(int? duration, string unit)

Parameters

duration int?
unit string

ChangeEventFormat(string) 

public void ChangeEventFormat(string format)

Parameters

format string

ChangeEventVenue(Guid?, Guid?, string) 

public void ChangeEventVenue(Guid? office, Guid? location, string room)

Parameters

office Guid?
location Guid?
room string

ChangeExamType(string) 

public void ChangeExamType(string type)

Parameters

type string

ChangeRequestStatus(string) 

public void ChangeRequestStatus(string status)

Parameters

status string

ChangeScheduleStatus(string) 

public void ChangeScheduleStatus(string status)

Parameters

status string

CompleteEvent() 

public void CompleteEvent()

CompleteEventPublication(string, string) 

public void CompleteEventPublication(string status, string errors)

Parameters

status string
errors string

ConfigureIntegration(bool, bool) 

public void ConfigureIntegration(bool withholdGrades, bool withholdDistribution)

Parameters

withholdGrades bool
withholdDistribution bool

ConnectEventMessage(EventMessageType, Guid?) 

public void ConnectEventMessage(EventMessageType messageType, Guid? messageId)

Parameters

messageType EventMessageType
messageId Guid?

CreateState()

Every aggregate must override this method to create the object that holds its current state.

public override AggregateState CreateState()

Returns

AggregateState

DeleteEvent() 

public void DeleteEvent()

DeleteSeat(Guid) 

public void DeleteSeat(Guid seat)

Parameters

seat Guid

DescribeAppointment(MultilingualString, MultilingualString) 

public void DescribeAppointment(MultilingualString title, MultilingualString description)

Parameters

title MultilingualString
description MultilingualString

DescribeEvent(MultilingualString, MultilingualString, MultilingualString, MultilingualString, EventInstruction[], MultilingualString) 

public void DescribeEvent(MultilingualString title, MultilingualString summary, MultilingualString description, MultilingualString materialsForParticipation, EventInstruction[] instructions, MultilingualString classLink)

Parameters

title MultilingualString
summary MultilingualString
description MultilingualString
materialsForParticipation MultilingualString
instructions EventInstruction[]
classLink MultilingualString

ElapseEventTimer(Guid) 

public void ElapseEventTimer(Guid timer)

Parameters

timer Guid

EnableEventBillingCode(bool) 

public void EnableEventBillingCode(bool enabled)

Parameters

enabled bool

ImportExamAttempts(bool) 

public void ImportExamAttempts(bool allowDuplicates)

Parameters

allowDuplicates bool

LockEventRegistration() 

public void LockEventRegistration()

ModifyAllowMultipleRegistrations(bool) 

public void ModifyAllowMultipleRegistrations(bool value)

Parameters

value bool

ModifyEventMessagePeriod(int?) 

public void ModifyEventMessagePeriod(int? sendReminderBeforeDays)

Parameters

sendReminderBeforeDays int?

ModifyMandatorySurvey(Guid?) 

public void ModifyMandatorySurvey(Guid? surveyForm)

Parameters

surveyForm Guid?

ModifyPersonCodeIsRequired(bool) 

public void ModifyPersonCodeIsRequired(bool value)

Parameters

value bool

ModifyRegistrationField(RegistrationField) 

public void ModifyRegistrationField(RegistrationField field)

Parameters

field RegistrationField

OrderDistribution(string, string, string) 

public void OrderDistribution(string code, string status, string errors)

Parameters

code string
status string
errors string

PostComment(Guid, Guid, string) 

public void PostComment(Guid comment, Guid author, string text)

Parameters

comment Guid
author Guid
text string

PublishEvent(DateTimeOffset?, DateTimeOffset?) 

public void PublishEvent(DateTimeOffset? registrationStart, DateTimeOffset? registrationDeadline)

Parameters

registrationStart DateTimeOffset?
registrationDeadline DateTimeOffset?

PublishEventScores(Guid[], bool) 

public void PublishEventScores(Guid[] registrations, bool alertMessageEnabled)

Parameters

registrations Guid[]
alertMessageEnabled bool

RecodeEvent(string, string) 

public void RecodeEvent(string classCode, string billingCode)

Parameters

classCode string
billingCode string

RemoveComment(Guid) 

public void RemoveComment(Guid comment)

Parameters

comment Guid

RemoveEventAssessment(Guid) 

public void RemoveEventAssessment(Guid form)

Parameters

form Guid

RemoveEventAttendee(Guid) 

public void RemoveEventAttendee(Guid contact)

Parameters

contact Guid

RenumberEvent(int) 

public void RenumberEvent(int number)

Parameters

number int

RescheduleEvent(DateTimeOffset, DateTimeOffset) 

public void RescheduleEvent(DateTimeOffset startTime, DateTimeOffset endTime)

Parameters

startTime DateTimeOffset
endTime DateTimeOffset

RetitleEvent(string) 

public void RetitleEvent(string title)

Parameters

title string

ReturnDistribution() 

public void ReturnDistribution()

ReturnExamMaterial(string, DateTimeOffset?, string) 

public void ReturnExamMaterial(string code, DateTimeOffset? received, string condition)

Parameters

code string
received DateTimeOffset?
condition string

ReviseComment(Guid, Guid, string) 

public void ReviseComment(Guid comment, Guid author, string text)

Parameters

comment Guid
author Guid
text string

ReviseSeat(Guid, string, string, bool, bool, int?, string) 

public void ReviseSeat(Guid seat, string configuration, string content, bool isAvailable, bool isTaxable, int? orderSequence, string title)

Parameters

seat Guid
configuration string
content string
isAvailable bool
isTaxable bool
orderSequence int?
title string

ScheduleAppointment(Guid, string, string, string, DateTimeOffset, DateTimeOffset) 

public void ScheduleAppointment(Guid organization, string title, string appointmentType, string description, DateTimeOffset start, DateTimeOffset end)

Parameters

organization Guid
title string
appointmentType string
description string
start DateTimeOffset
end DateTimeOffset

ScheduleClass(Guid, string, string, int, DateTimeOffset, DateTimeOffset, int, string, decimal?) 

public void ScheduleClass(Guid organization, string title, string status, int number, DateTimeOffset start, DateTimeOffset end, int duration, string durationUnit, decimal? credit)

Parameters

organization Guid
title string
status string
number int
start DateTimeOffset
end DateTimeOffset
duration int
durationUnit string
credit decimal?

ScheduleExam(Guid, string, string, string, string, string, string, string, int, int, DateTimeOffset, Guid, string, int?) 

public void ScheduleExam(Guid organization, string type, string format, string title, string status, string billingCode, string classCode, string source, int duration, int number, DateTimeOffset start, Guid venueIdentifier, string venueRoom, int? capacityMaximum)

Parameters

organization Guid
type string
format string
title string
status string
billingCode string
classCode string
source string
duration int
number int
start DateTimeOffset
venueIdentifier Guid
venueRoom string
capacityMaximum int?

SendEventMessage(EventMessageType, Guid, Guid[]) 

public void SendEventMessage(EventMessageType messageType, Guid messageId, Guid[] recipients)

Parameters

messageType EventMessageType
messageId Guid
recipients Guid[]

ShipDistribution() 

public void ShipDistribution()

StartEventPublication() 

public void StartEventPublication()

StartEventTimer(Guid, DateTimeOffset, string) 

public void StartEventTimer(Guid timer, DateTimeOffset at, string description)

Parameters

timer Guid
at DateTimeOffset
description string

TrackDistribution(string, string, string) 

public void TrackDistribution(string job, string status, string errors)

Parameters

job string
status string
errors string

TriggerEventNotification(string) 

public void TriggerEventNotification(string name)

Parameters

name string

UnlockEventRegistration() 

public void UnlockEventRegistration()

UnpublishEvent() 

public void UnpublishEvent()

ValidateEventScores(Guid[]) 

public void ValidateEventScores(Guid[] registrations)

Parameters

registrations Guid[]