Serialized Form

Package org.exoplatform.agenda.exception

Exception Class org.exoplatform.agenda.exception.AgendaException

class AgendaException extends Exception implements Serializable

serialVersionUID:

3558967988412136652L

Serialized Fields

agendaExceptionType

AgendaExceptionType agendaExceptionType

Exception Class org.exoplatform.agenda.exception.EventInvitationExpiredException

class EventInvitationExpiredException extends IllegalAccessException implements Serializable

serialVersionUID:

1L

Package org.exoplatform.agenda.model

Class org.exoplatform.agenda.model.CalendarPermission

class CalendarPermission extends Object implements Serializable

serialVersionUID:

-505066459639689152L

Serialized Fields

canCreate

boolean canCreate

canEdit

boolean canEdit

canInviteeEdit

boolean canInviteeEdit

canPublish

boolean canPublish

Whether the user may publish the calendar as a private link (EXO-90252): the owner of a personal calendar, a member holding the manager role of the space for a space calendar — never a super-manager who is not one.

canShare

boolean canShare

Whether the user may share the calendar with colleagues (EXO-90357): the owner of a personal calendar that is not a subscription. Never a space calendar in this version, never a sharee.

Class org.exoplatform.agenda.model.EventConference

class EventConference extends Object implements Serializable

serialVersionUID:

-1220341038848536226L

Serialized Fields

accessCode

String accessCode

description

String description

id

long id

phone

String phone

type

String type

url

String url

Class org.exoplatform.agenda.model.EventDateOption

class EventDateOption extends Object implements Serializable

serialVersionUID:

2017882533660661259L

Serialized Fields

allDay

boolean allDay

end

ZonedDateTime end

eventId

long eventId

id

long id

selected

boolean selected

start

ZonedDateTime start

voters

List<Long> voters

Class org.exoplatform.agenda.model.EventPermission

class EventPermission extends Object implements Serializable

serialVersionUID:

-505066459639689152L

Serialized Fields

attendee

boolean attendee

canEdit

boolean canEdit

canMove

boolean canMove

Whether the user may take the event out of its calendar into another one (EXO-90149): its creator, or whoever manages its calendar — never an attendee on the sole strength of "attendees can modify the event", nor a colleague editing it through a calendar share.

Class org.exoplatform.agenda.model.EventRecurrence

class EventRecurrence extends Object implements Serializable

serialVersionUID:

5053547947788569270L

Serialized Fields

byDay

List<String> byDay

byHour

List<String> byHour

byMinute

List<String> byMinute

byMonth

List<String> byMonth

byMonthDay

List<String> byMonthDay

bySecond

List<String> bySecond

bySetPos

List<String> bySetPos

byWeekNo

List<String> byWeekNo

byYearDay

List<String> byYearDay

count

int count

frequency

EventRecurrenceFrequency frequency

id

long id

interval

int interval

rrule

String rrule

type

EventRecurrenceType type

until

LocalDate until

Class org.exoplatform.agenda.model.EventReminder

class EventReminder extends EventReminderParameter implements Serializable

serialVersionUID:

-7068947528529938343L

Serialized Fields

datetime

ZonedDateTime datetime

Date and time converted to user timezone (Timestamp representation using RFC-3339). This is the computed datetime to send reminder.

eventId

long eventId

fromOccurrenceId

ZonedDateTime fromOccurrenceId

id

long id

receiverId

long receiverId

untilOccurrenceId

ZonedDateTime untilOccurrenceId

Class org.exoplatform.agenda.model.EventReminderParameter

class EventReminderParameter extends Object implements Serializable

serialVersionUID:

-2033232204026792697L

Serialized Fields

before

int before

beforePeriodType

ReminderPeriodType beforePeriodType

periodType

String periodType

A field added to be able to inject Object by kernel configuration. ( No supported enum type )

Package org.exoplatform.agenda.rest.model

Class org.exoplatform.agenda.rest.model.CalendarEntity

class CalendarEntity extends Object implements Serializable

serialVersionUID:

2689301355435962774L

Serialized Fields

acl

CalendarPermission acl

color

String color

created

String created

description

String description

id

long id

name

String name

owner

org.exoplatform.social.rest.entity.IdentityEntity owner

sharedWithMe

boolean sharedWithMe

Whether the reader sees the calendar only because its owner shared it with them (EXO-90357). Read-only for clients.

subscription

boolean subscription

Whether the calendar holds a subscribed calendar link (EXO-90278).

system

boolean system

title

String title

updated

String updated

Class org.exoplatform.agenda.rest.model.CalendarList

class CalendarList extends Object implements Serializable

serialVersionUID:

-3532407964104047773L

Serialized Fields

calendars

List<CalendarEntity> calendars

limit

int limit

offset

int offset

size

int size

Class org.exoplatform.agenda.rest.model.EventAttendeeEntity

class EventAttendeeEntity extends Object implements Serializable

serialVersionUID:

4729314827604510766L

Serialized Fields

id

long id

identity

org.exoplatform.social.rest.entity.IdentityEntity identity

response

EventAttendeeResponse response

Class org.exoplatform.agenda.rest.model.EventDateOptionEntity

class EventDateOptionEntity extends Object implements Serializable

serialVersionUID:

-8336156948034042032L

Serialized Fields

allDay

boolean allDay

end

String end

eventId

long eventId

id

long id

selected

boolean selected

start

String start

voters

List<Long> voters

Class org.exoplatform.agenda.rest.model.EventEntity

class EventEntity extends Object implements Serializable

serialVersionUID:

4802741507885433036L

Serialized Fields

acl

EventPermission acl

allDay

boolean allDay

Whether the event happens all-day or at dedicated period of a day

allowAttendeeToInvite

boolean allowAttendeeToInvite

allowAttendeeToUpdate

boolean allowAttendeeToUpdate

attendees

List<EventAttendeeEntity> attendees

availability

EventAvailability availability

calendar

CalendarEntity calendar

color

String color

CSS color HEX value of the event

conferences

List<EventConference> conferences

created

String created

creator

org.exoplatform.social.rest.entity.IdentityEntity creator

dateOptions

List<EventDateOptionEntity> dateOptions

description

String description

end

String end

End date of the event.

• It's of type datetime converted to user timezone if not "all-day" event.(Timestamp representation using RFC-3339.)
• When it's an all-day event, the returned date is of format 'yyyy-mm-dd', for example: 2020-07-20.

id

long id

location

String location

Geopgraphic location of the event, content is free text and no predefined format is used.

masked

boolean masked

Whether the event's content was withheld from the reader (EXO-90357): a private event of a calendar shared with them, rendered as busy time. The client shows the time and nothing else; the server fills no attendee, conference, reminder or date option on it.

modifier

org.exoplatform.social.rest.entity.IdentityEntity modifier

Who last changed the event (EXO-90378), when that is not its creator — a colleague the owner shared the calendar with for editing, typically. Null when nobody but the creator has touched it, so a client shows the line only when there is something to say.

occurrence

EventOccurrenceEntity occurrence

open

Boolean open

Open event flag. On read: the effective value (a stored row carries its own flag, a computed occurrence its series'), never null — except on a search result (EventSearchResultEntity), where the flag is not indexed and stays null, meaning "unknown", never "locked". On write: optional — null means "not specified", i.e. kept as stored on update and false on creation, so that a client omitting the field can neither lock nor open an event.

parameters

Map<String,String> parameters

parent

EventEntity parent

Parent event object, when :

• this is an occurrence (exceptional or ordinal) of a recurring event
• this is a duplication of an event that was modified by an attendee having Readonly ACL on event. In that case, the event is modified and duplicated in user calendar only.

recurrence

EventRecurrenceEntity recurrence

Event parent recurrence details

reminders

List<EventReminderEntity> reminders

List of reminders of currently authenticated user

remoteId

String remoteId

External Event technical identifier if imported from external Store. This can be used to identify calendar event if re-importing events from remote provider.

remoteProviderId

long remoteProviderId

Remote Calendar provider Identifier used by current user

remoteProviderName

String remoteProviderName

Remote Calendar provider name used by current user

start

String start

Start date of the event.

• It's of type datetime converted to user timezone if not "all-day" event.(Timestamp representation using RFC-3339.)
• When it's an all-day event, the returned date is of format 'yyyy-mm-dd', for example: 2020-07-20.

status

EventStatus status

summary

String summary

timeZoneId

String timeZoneId

time zone of the event

• It's the time zone of user

updated

String updated

visibility

EventVisibility visibility

Whether the event's content may be read outside eXo. Honoured by the published calendar link only; inside eXo it changes nothing.

Class org.exoplatform.agenda.rest.model.EventList

class EventList extends Object implements Serializable

serialVersionUID:

5755432994258383974L

Serialized Fields

end

String end

events

List<EventEntity> events

limit

int limit

size

long size

start

String start

Class org.exoplatform.agenda.rest.model.EventOccurrenceEntity

class EventOccurrenceEntity extends Object implements Serializable

serialVersionUID:

-6680864287258344039L

Serialized Fields

exceptional

boolean exceptional

id

String id

Class org.exoplatform.agenda.rest.model.EventRecurrenceEntity

class EventRecurrenceEntity extends Object implements Serializable

serialVersionUID:

5053547947788569270L

Serialized Fields

byDay

List<String> byDay

byHour

List<String> byHour

byMinute

List<String> byMinute

byMonth

List<String> byMonth

byMonthDay

List<String> byMonthDay

bySecond

List<String> bySecond

bySetPos

List<String> bySetPos

byWeekNo

List<String> byWeekNo

byYearDay

List<String> byYearDay

count

int count

frequency

EventRecurrenceFrequency frequency

id

long id

interval

int interval

rrule

String rrule

type

EventRecurrenceType type

until

String until

Class org.exoplatform.agenda.rest.model.EventReminderEntity

class EventReminderEntity extends Object implements Serializable

serialVersionUID:

6943741617810854720L

Serialized Fields

before

int before

beforePeriodType

String beforePeriodType

id

long id

Class org.exoplatform.agenda.rest.model.EventSearchResultEntity

class EventSearchResultEntity extends EventEntity implements Serializable

serialVersionUID:

5124367759439151153L

Serialized Fields

excerpts

List<String> excerpts