# `JSCalendar.Group`
[🔗](https://github.com/elixir-tempo/jscalendar/blob/v0.1.0/lib/jscalendar/event.ex#L155)

A collection of events and tasks
([RFC 8984 §5.3](https://www.rfc-editor.org/rfc/rfc8984.html#section-5.3)).

`entries` is mandatory and mixed — events and tasks together — and
RFC 8984 requires that entries of a type the reader does not
recognise are **ignored** rather than treated as an error. Those are
kept in `unknown_entries` instead of discarded, so a group can be
read, changed and written back without quietly losing the members
this implementation did not understand.

# `t`

```elixir
@type t() :: %JSCalendar.Group{
  alerts: term(),
  categories: term(),
  color: term(),
  created: term(),
  description: term(),
  description_content_type: term(),
  entries: [JSCalendar.Event.t() | JSCalendar.Task.t()] | nil,
  excluded: term(),
  excluded_recurrence_rules: term(),
  extra: map(),
  free_busy_status: term(),
  keywords: term(),
  links: term(),
  locale: term(),
  localizations: term(),
  locations: term(),
  method: term(),
  participants: term(),
  priority: term(),
  privacy: term(),
  prod_id: term(),
  recurrence_id: term(),
  recurrence_id_time_zone: term(),
  recurrence_overrides: term(),
  recurrence_rules: term(),
  related_to: term(),
  reply_to: term(),
  request_status: term(),
  sent_by: term(),
  sequence: term(),
  show_without_time: term(),
  source: JSCalendar.Link.t() | nil,
  time_zone: term(),
  time_zones: term(),
  title: String.t(),
  uid: String.t() | nil,
  updated: term(),
  use_default_alerts: term(),
  virtual_locations: term()
}
```

A group of calendar objects.

# `from_map`

```elixir
@spec from_map(map()) :: {:ok, struct()} | {:error, term()}
```

Read this object from a decoded JSON map.

### Arguments

* `map` is a map with string keys, as `:json.decode/1` returns.

### Returns

* `{:ok, object}`; or

* `{:error, reason}` when a property does not match its declared
  type.

# `jscalendar_type`

```elixir
@spec jscalendar_type() :: String.t()
```

The `@type` value RFC 8984 gives this object.

### Returns

* the type name as a string.

# `to_map`

```elixir
@spec to_map(struct()) :: map()
```

Write this object back to a JSON-ready map.

### Arguments

* `object` is a `t:t/0`.

### Returns

* a map with string keys, ready for `:json.encode/1`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*