Skip to content

Latest commit

 

History

History
457 lines (324 loc) · 11.4 KB

events.rst

File metadata and controls

457 lines (324 loc) · 11.4 KB

Events

ls.joyous.models

Get Events API

getAllEventsByDay

getAllEventsByWeek

getAllUpcomingEvents

getAllPastEvents

getGroupUpcomingEvents

getEventFromUid

getAllEvents

EventsOnDay

EventsOnDay

date

holiday

days_events

The events that start on this day

rtype

list of the namedtuple ThisEvent (title, page, url)

continuing_events

The events that are still continuing on this day

rtype

list of the namedtuple ThisEvent (title, page, url)

all_events

preview

weekday

EventCategory

EventCategory

EventCategory

code

A short 4 character code for the category.

name

The category name.

EventBase

EventBase

EventBase

uid

A unique identifier for the event, used for iCal import/export.

category

What type of event is this?

image

A banner image for the event.

time_from

The time the event starts (optional).

time_to

The time the event finishes (optional).

tz

The time zone for the event. No, sorry, you can't set different time zones for time_from and time_to.

group_page

A page chosen to link a group of events together.

details

Free text for whatever else you want to say about the event.

location

Where the event will occur. If wagtailgmaps is installed MapFieldPanel will be used, but this is not a requirement.

website

A website location for the event.

group

_current_datetime_from

_future_datetime_from

_past_datetime_from

_first_datetime_from

status

status_text

at

_removeContentPanels

isAuthorized

get_context

_getLocalWhen

_getFromTime

_getFromDt

_getToDt

SimpleEventPage

SimpleEventPage

SimpleEventPage

date

The date that the event occurs on.

when

_getFromTime

_getFromDt

_getToDt

MultidayEventPage

MultidayEventPage

MultidayEventPage

date_from

The date the event starts.

date_to

The date the event finishes.

when

_getFromTime

_getFromDt

_getToDt

RecurringEventPage

RecurringEventPage

RecurringEventPage

repeat

The recurrence rule of when the event occurs.

num_days

The number of days an occurrence lasts for.

next_date

_current_datetime_from

_future_datetime_from

prev_date

_past_datetime_from

_first_datetime_from

status

status_text

when

_getFromTime

_futureExceptions

_nextOn

_occursOn

_getMyFirstDatetimeFrom

_getMyFirstDatetimeTo

_getMyNextDate

MultidayRecurringEventPage

MultidayRecurringEventPage

MultidayRecurringEventPage

EventExceptionBase

EventExceptionBase

EventExceptionBase

overrides

The recurring event that we are updating. overrides is also the parent (the published version of parent), but the parent is not set until the child is saved and added.

num_days

Shortcut for overrides.num_days.

time_from

Shortcut for overrides.time_from.

time_to

Shortcut for overrides.time_to.

tz

Shortcut for overrides.tz.

group

Shortcut for overrides.group.

category

Shortcut for overrides.category.

image

Shortcut for overrides.image.

location

Shortcut for overrides.location.

website

Shortcut for overrides.website.

at

overrides_repeat

get_context

isAuthorized

_copyFieldsFromParent

DateExceptionBase

DateExceptionBase

DateExceptionBase

except_date

For this date.

local_title

when

full_clean

_getLocalWhen

_getFromTime

_getFromDt

_getToDt

_copyFieldsFromParent

ExtraInfoPage

ExtraInfoPage

ExtraInfoPage

extra_title

A more specific title for this occurrence (optional).

extra_information

Information just for this date.

details

Shortcut for overrides.details.

status

status_text

_current_datetime_from

_future_datetime_from

_past_datetime_from

CancellationBase

CancellationBase

CancellationBase

cancellation_title

Show in place of cancelled event (Leave empty to show nothing).

cancellation_details

Why was the event cancelled?

status

status_text

CancellationPage

CancellationPage

CancellationPage

_current_datetime_from

_future_datetime_from

_past_datetime_from

getCancellationUrl

cancellation_url

RescheduleEventBase

RescheduleEventBase

RescheduleEventBase

num_days

The number of days an occurrence lasts for.

tz

Shortcut for overrides.tz.

group

Shortcut for overrides.group.

uid

Shortcut for overrides.uid.

get_context

PostponementPage

PostponementPage

PostponementPage

postponement_title

The title for the postponed event.

date

The date that the event was postponed to.

status

when

postponed_from_when

what

postponed_from

postponed_to

at

serveCancellation

_getFromTime

_getFromDt

_getToDt

_copyFieldsFromParent

RescheduleMultidayEventPage

RescheduleMultidayEventPage

RescheduleMultidayEventPage

ClosedForHolidaysPage

ClosedForHolidaysPage

ClosedForHolidaysPage

all_holidays

Closed for all holidays?

closed_for

Or, closed for these holidays

local_title

when

closed

_current_datetime_from

_future_datetime_from

_past_datetime_from

_closed_for_dates

can_create_at

_getMyDates

_getFromTime

_cacheClosedSet

_closedOn

ExtCancellationPage

ExtCancellationPage

ExtCancellationPage

cancelled_from_date

Cancelled from this date

cancelled_to_date

Cancelled to this date (Leave empty for "until further notice")

local_title

until_when

when

_current_datetime_from

_future_datetime_from

_past_datetime_from

full_clean

_getMyDates

_getMyRawDates

_getFromTime

_closedOn