CalendarEvent (Canvas API Library 1.8.0 API)

java.lang.Object
- edu.ksu.canvas.model.BaseCanvasModel
- - edu.ksu.canvas.model.CalendarEvent

All Implemented Interfaces:

Serializable
```
public class CalendarEvent
extends BaseCanvasModel
implements Serializable
```
Class to represent Canvas calendar event. See Canvas calendar event documentation. There looks to be a strange case where an event when read includes timezone, but when written it doesn't.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CalendarEvent.ChildEvent`
`static class`	`CalendarEvent.Frequency`
`static class`	`CalendarEvent.ParticipantType`
`static class`	`CalendarEvent.WorkflowState`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

CalendarEvent()

CalendarEvent(CalendarEvent other)

Constructors
Constructor and Description
`CalendarEvent()`
`CalendarEvent(CalendarEvent other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAllContextCodes()`
`Boolean`	`getAllDay()`
`LocalDate`	`getAllDayDate()`
`String`	`getAppointmentGroupId()`
`String`	`getAppointmentGroupUrl()`
`Integer`	`getAvailableSlots()`
`List<CalendarEvent>`	`getChildEvents()`
`Integer`	`getChildEventsCount()`
`List<CalendarEvent.ChildEvent>`	`getChildEventsData()`
`String`	`getContextCode()`
`Instant`	`getCreatedAt()`
`String`	`getDescription()`
`Boolean`	`getDuplicateAppend()`
`Integer`	`getDuplicateCount()`
`CalendarEvent.Frequency`	`getDuplicateFrequency()`
`Integer`	`getDuplicateInterval()`
`String`	`getEffectiveContextCode()`
`Instant`	`getEndAt()`
`Boolean`	`getHidden()`
`String`	`getHtmlUrl()`
`Integer`	`getId()`
`String`	`getLocationAddress()`
`String`	`getLocationName()`
`String`	`getParentEventId()`
`Integer`	`getParticipantsPerAppointment()`
`CalendarEvent.ParticipantType`	`getParticipantType()`
`Boolean`	`getReservation()`
`static long`	`getSerialVersionUID()`
`Instant`	`getStartAt()`
`String`	`getTitle()`
`Instant`	`getUpdatedAt()`
`String`	`getUrl()`
`User`	`getUser()`
`CalendarEvent.WorkflowState`	`getWorkflowState()`
`int`	`hashCode()`
`void`	`setAllContextCodes(String allContextCodes)`
`void`	`setAllDay(Boolean allDay)`
`void`	`setAllDayDate(LocalDate allDayDate)`
`void`	`setAppointmentGroupId(String appointmentGroupId)`
`void`	`setAppointmentGroupUrl(String appointmentGroupUrl)`
`void`	`setAvailableSlots(Integer availableSlots)`
`void`	`setChildEvents(List<CalendarEvent> childEvents)`
`void`	`setChildEventsCount(Integer childEventsCount)`
`void`	`setChildEventsData(List<CalendarEvent.ChildEvent> childEventsData)`
`void`	`setContextCode(String contextCode)`
`void`	`setCreatedAt(Instant createdAt)`
`void`	`setDescription(String description)`
`void`	`setDuplicateAppend(Boolean duplicateAppend)`
`void`	`setDuplicateCount(Integer duplicateCount)`
`void`	`setDuplicateFrequency(CalendarEvent.Frequency duplicateFrequency)`
`void`	`setDuplicateInterval(Integer duplicateInterval)`
`void`	`setEffectiveContextCode(String effectiveContextCode)`
`void`	`setEndAt(Instant endAt)`
`void`	`setHidden(Boolean hidden)`
`void`	`setId(Integer id)`
`void`	`setLocationAddress(String locationAddress)`
`void`	`setLocationName(String locationName)`
`void`	`setParentEventId(String parentEventId)`
`void`	`setParticipantsPerAppointment(Integer participantsPerAppointment)`
`void`	`setParticipantType(CalendarEvent.ParticipantType participantType)`
`void`	`setReservation(Boolean reservation)`
`void`	`setStartAt(Instant startAt)`
`void`	`setTitle(String title)`
`void`	`setUpdatedAt(Instant updatedAt)`
`void`	`setUser(User user)`
`void`	`setWorkflowState(CalendarEvent.WorkflowState workflowState)`

Methods inherited from class edu.ksu.canvas.model.BaseCanvasModel
toJsonObject, toPostMap

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- serialVersionUID
```
public static final long serialVersionUID
```
  See Also:
  
  Constant Field Values

Constructor Detail

CalendarEvent
```
public CalendarEvent()
```

CalendarEvent

public CalendarEvent(CalendarEvent other)

Method Detail

getSerialVersionUID

public static long getSerialVersionUID()

getId
```
public Integer getId()
```

setId
```
public void setId(Integer id)
```

getTitle
```
public String getTitle()
```

setTitle
```
public void setTitle(String title)
```

getStartAt
```
public Instant getStartAt()
```

setStartAt

public void setStartAt(Instant startAt)

getEndAt
```
public Instant getEndAt()
```

setEndAt
```
public void setEndAt(Instant endAt)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getLocationName
```
public String getLocationName()
```

setLocationName

public void setLocationName(String locationName)

getLocationAddress
```
public String getLocationAddress()
```

setLocationAddress

public void setLocationAddress(String locationAddress)

getContextCode
```
public String getContextCode()
```

setContextCode

public void setContextCode(String contextCode)

getEffectiveContextCode

public String getEffectiveContextCode()

setEffectiveContextCode

public void setEffectiveContextCode(String effectiveContextCode)

getAllContextCodes
```
public String getAllContextCodes()
```

setAllContextCodes

public void setAllContextCodes(String allContextCodes)

getWorkflowState

public CalendarEvent.WorkflowState getWorkflowState()

setWorkflowState

public void setWorkflowState(CalendarEvent.WorkflowState workflowState)

getHidden
```
public Boolean getHidden()
```

setHidden

public void setHidden(Boolean hidden)

getParentEventId
```
public String getParentEventId()
```

setParentEventId

public void setParentEventId(String parentEventId)

getChildEventsCount
```
public Integer getChildEventsCount()
```

setChildEventsCount

public void setChildEventsCount(Integer childEventsCount)

getChildEvents

public List<CalendarEvent> getChildEvents()

setChildEvents

public void setChildEvents(List<CalendarEvent> childEvents)

getUrl
```
public String getUrl()
```

getHtmlUrl
```
public String getHtmlUrl()
```

getAllDayDate
```
public LocalDate getAllDayDate()
```

setAllDayDate

public void setAllDayDate(LocalDate allDayDate)

getAllDay
```
public Boolean getAllDay()
```

setAllDay

public void setAllDay(Boolean allDay)

getCreatedAt
```
public Instant getCreatedAt()
```

setCreatedAt

public void setCreatedAt(Instant createdAt)

getUpdatedAt
```
public Instant getUpdatedAt()
```

setUpdatedAt

public void setUpdatedAt(Instant updatedAt)

getAppointmentGroupId
```
public String getAppointmentGroupId()
```

setAppointmentGroupId

public void setAppointmentGroupId(String appointmentGroupId)

getAppointmentGroupUrl

public String getAppointmentGroupUrl()

setAppointmentGroupUrl

public void setAppointmentGroupUrl(String appointmentGroupUrl)

getReservation
```
public Boolean getReservation()
```

setReservation

public void setReservation(Boolean reservation)

getParticipantType

public CalendarEvent.ParticipantType getParticipantType()

setParticipantType

public void setParticipantType(CalendarEvent.ParticipantType participantType)

getParticipantsPerAppointment

public Integer getParticipantsPerAppointment()

setParticipantsPerAppointment

public void setParticipantsPerAppointment(Integer participantsPerAppointment)

getAvailableSlots
```
public Integer getAvailableSlots()
```

setAvailableSlots

public void setAvailableSlots(Integer availableSlots)

getUser
```
public User getUser()
```

setUser
```
public void setUser(User user)
```

getDuplicateCount
```
public Integer getDuplicateCount()
```

setDuplicateCount

public void setDuplicateCount(Integer duplicateCount)

getDuplicateInterval
```
public Integer getDuplicateInterval()
```

setDuplicateInterval

public void setDuplicateInterval(Integer duplicateInterval)

getDuplicateFrequency

public CalendarEvent.Frequency getDuplicateFrequency()

setDuplicateFrequency

public void setDuplicateFrequency(CalendarEvent.Frequency duplicateFrequency)

getDuplicateAppend
```
public Boolean getDuplicateAppend()
```

setDuplicateAppend

public void setDuplicateAppend(Boolean duplicateAppend)

getChildEventsData

public List<CalendarEvent.ChildEvent> getChildEventsData()

setChildEventsData

public void setChildEventsData(List<CalendarEvent.ChildEvent> childEventsData)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class CalendarEvent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class edu.ksu.canvas.model.BaseCanvasModel

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

Constructor Detail

CalendarEvent

CalendarEvent

Method Detail

getSerialVersionUID

getId

setId

getTitle

setTitle

getStartAt

setStartAt

getEndAt

setEndAt

getDescription

setDescription

getLocationName

setLocationName

getLocationAddress

setLocationAddress

getContextCode

setContextCode

getEffectiveContextCode

setEffectiveContextCode

getAllContextCodes

setAllContextCodes

getWorkflowState

setWorkflowState

getHidden

setHidden

getParentEventId

setParentEventId

getChildEventsCount

setChildEventsCount

getChildEvents

setChildEvents

getUrl

getHtmlUrl

getAllDayDate

setAllDayDate

getAllDay

setAllDay

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getAppointmentGroupId

setAppointmentGroupId

getAppointmentGroupUrl

setAppointmentGroupUrl

getReservation

setReservation

getParticipantType

setParticipantType

getParticipantsPerAppointment

setParticipantsPerAppointment

getAvailableSlots

setAvailableSlots

getUser

setUser

getDuplicateCount

setDuplicateCount

getDuplicateInterval

setDuplicateInterval

getDuplicateFrequency

setDuplicateFrequency

getDuplicateAppend

setDuplicateAppend

getChildEventsData

setChildEventsData

equals

hashCode