How can we help?

Overview

The Event object is the central entity in Localist Events. It represents a complete event including all its metadata, configuration, and relationships. When displaying event lists or calendars, developers work with EventInstance objects—single occurrences of recurring events. This article documents the Event object and all related types: EventInstance, Speaker, Tag, TagList, Photo, PhotoAlbum, Review, Attendee, Activity, Invitation, Experience, and Plan.

The Event Object

The Event object is the largest and most important template variable. It includes eleven major sections of attributes.

Core

Liquid example:

{{ event.name }} - {{ event.status }}

Dates

Liquid example:

Starts: {{ event.starts_at | date: "%B %d, %Y at %I:%M %p" }}
{% if event.has_instances %}
  This event occurs {{ event.future_instances.size }} times
{% endif %}

Content

Liquid example:

<img src="{{ event.photo.featured }}" alt="{{ event.photo.caption }}" />
<p>{{ event.description_html }}</p>

Location

Liquid example:

{% if event.has_location? %}
  {{ event.location }}
  <a href="https://maps.google.com/?q={{ event.latitude }},{{ event.longitude }}">View on Map</a>
{% endif %}

Types/Tags

Liquid example:

{% for tag in event.types.event_types %}
  <span class="tag">{{ tag.name }}</span>
{% endfor %}

Experience/Stream

Liquid example:

{% if event.has_stream? %}
  <a href="{{ event.stream_url }}">Join Virtual Event</a>
{% endif %}

Ticketing

Liquid example:

{% if event.free %}
  <span class="badge">FREE</span>
{% elsif event.has_tickets %}
  Starting at {{ event.ticket_price }}
{% endif %}

Status

Liquid example:

{% if event.is_rejected %}
  <p class="error">Rejected: {{ event.rejection_reason }}</p>
{% endif %}

Associations

Liquid example:

Organized by: <a href="{{ event.user.url }}">{{ event.user.visible_name }}</a>

Attendance

Feedback

Conference

URLs

Recent Activity

The EventInstance Object

An EventInstance represents a single occurrence (date/time) of an event. EventInstance shares most variables with the Event object. The key difference is that instance-specific times (starts_at, ends_at) come from the instance, while descriptive attributes (name, description, etc.) are delegated to the parent Event.

Common Attributes

Liquid example:

{% for instance in event.future_instances %}
  <div class="event-instance">
    {{ instance.name }}
    {{ instance.starts_at | date: "%b %d" }} at {{ instance.start_time }}
  </div>
{% endfor %}

The Speaker Object

Speakers are typically used in conference events and structured presentations.

Profile

Social Links

Liquid example:

{% for speaker in event.speakers %}
  <div class="speaker">
    <h3>{{ speaker.name }}</h3>
    <p>{{ speaker.title }} at {{ speaker.organization }}</p>
    {% if speaker.has_social_links? %}
      <a href="{{ speaker.twitter_url }}">Twitter</a>
    {% endif %}
  </div>
{% endfor %}

Tags and Tag Lists

Tag Object

A Tag represents a single type or classification label.

TagList Object

A TagList is a dynamic collection of Tags grouped by context. Use it to access tags organized by their classification categories.

Liquid example:

{% for context in event.types.context_names %}
  <h4>{{ context }}</h4>
  {% for tag in event.types[context] %}
    <span class="tag">{{ tag.name }}</span>
  {% endfor %}
{% endfor %}

The Photo and PhotoAlbum Objects

Photo Object

Photos can be associated with events, users, or albums. The Photo object provides multiple image URL variants for different use cases.

Image URLs

Metadata

Associations

Liquid example:

<img src="{{ event.photo.featured }}" 
     srcset="{{ event.photo.big }} 800w, {{ event.photo.medium }} 400w"
     alt="{{ event.photo.caption }}" />

PhotoAlbum Object

A PhotoAlbum groups related photos together.

Liquid example:

{% for album in all_albums %}
  <h3>{{ album.title }}</h3>
{% endfor %}

The Review Object

Reviews are user feedback on events, typically including ratings and comments.

Properties

Display

Liquid example:

{% for review in event.recent_activity_reviews %}
  {% if review.approved %}
    <div class="review">
      <p>{{ review.user.visible_name }} gave {{ review.rating }} stars</p>
      <p>{{ review.review }}</p>
    </div>
  {% endif %}
{% endfor %}

The Attendee Object

The Attendee object is a union type, meaning it can represent different kinds of attendees (UserEvent, PrivateAttendee, ExtraAttendee). Only common attributes are documented here.

Common Attributes

Registered Attendee Only

These attributes are only available for attendees with user accounts:

Liquid example:

{% for attendee in event.attendees %}
  <li>
    {% if attendee.can_link? %}
      <a href="{{ attendee.user.url }}">{{ attendee.visible_name }}</a>
    {% else %}
      {{ attendee.visible_name }}
    {% endif %}
  </li>
{% endfor %}

The Activity Object

Activity is a union type representing user-generated content (Comment, Photo, Review). Only common attributes are documented.

Common Attributes

Comment Only

Photo Only

Review Only

Liquid example:

{% for activity in event.recent_activity %}
  {% if activity.type == "Review" %}
    <div class="review">{{ activity.review }} ({{ activity.rating }} stars)</div>
  {% elsif activity.type == "Comment" %}
    <div class="comment">{{ activity.comment }}</div>
  {% elsif activity.type == "Photo" %}
    <img src="{{ activity.original }}" alt="{{ activity.caption }}" />
  {% endif %}
{% endfor %}

The Invitation Object

Invitations represent event invitations sent to users.

Properties

Status

Actions

Liquid example:

{% if event.invitation %}
  {% if event.invitation.accepted %}
    <p>You have accepted this invitation</p>
  {% else %}
    <a href="{{ event.invitation.accept_url }}">Accept Invitation</a>
  {% endif %}
{% endif %}

The Experience Object

Experience represents the mode(s) in which an event is offered (in-person, virtual, hybrid, etc.).

Details

Liquid example:

{% if event.experience.has_stream? and event.experience.has_location? %}
  <span class="badge">Hybrid Event</span>
{% elsif event.experience.has_stream? %}
  <span class="badge">Virtual Event</span>
{% endif %}

The Plan Object

Plan is a union type representing different kinds of user event plans (UserEvent, Plan, WatchedEvent, SpeakingEvent). Only common attributes are documented.

Common Attributes

Liquid example:

{% for plan in user.future_events %}
  <li>
    <a href="{{ plan.url }}">{{ plan.name }}</a>
    {{ plan.starts_at | date: "%b %d" }}
  </li>
{% endfor %}

Related Articles

This article is part of an 8-part series on Localist developer theming:

1. Introduction to Localist Developer Theming
2. Site Configuration and Global Objects
3. Events, Instances, and Related Objects
4. Places, Groups, Departments, and Channels
5. Custom Liquid Tags Reference
6. Custom Liquid Filters Reference
7. Template Variable Reference
8. Forms and User Management