JSCalendar.Relation (JSCalendar v0.1.0)

Copy Markdown View Source

How one calendar object relates to another (RFC 8984 §4.1.3).

A Relation is the value of a relatedTo entry; the key is the uid it points at. relation is a set drawn from first, next, child and parent — and an empty set is meaningful, saying the objects are related in some way the sender did not name.

Summary

Types

t()

Functions

from_map(map)

Read this object from a decoded JSON map.

jscalendar_type()

The @type value RFC 8984 gives this object.

to_map(object)

Write this object back to a JSON-ready map.

Types

t()

@type t() :: %JSCalendar.Relation{extra: map(), relation: MapSet.t() | nil}

Functions

from_map(map)

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

Read this object from a decoded JSON map.

Arguments

Returns

  • {:ok, object}; or

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

jscalendar_type()

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

The @type value RFC 8984 gives this object.

Returns

  • the type name as a string.

to_map(object)

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

Write this object back to a JSON-ready map.

Arguments

  • object is a t/0.

Returns