SmeeFeds.Federation (SmeeFeds v0.1.0) View Source
Federation provides structs that represents federated metadata publishers, and some simple tools to manage the information in them.
Link to this section Summary
Functions
Returns the default aggregate metadata details for the federation, or nil if none has been defined.
Gets the general contact information for the federation as a URL.
Returns the countries associated with the federation as Countries
structs.
Returns the default MDQ service for the federation, or nil if none has been defined.
Creates a new Federation struct. The only requirement is a unique ID, passed as the first parameter.
Returns the policy URL for the federation (if known) or nil
Lists all sources for the federation (it does not return their keys/labels)
Returns the homepage URL for the federation, or nil.
Link to this section Types
Specs
Link to this section Functions
Specs
aggregate(federation :: t()) :: Smee.Source.t() | nil
Returns the default aggregate metadata details for the federation, or nil if none has been defined.
Specs
Gets the general contact information for the federation as a URL.
Specs
Returns the countries associated with the federation as Countries
structs.
See Countries documentation for more information.
Specs
mdq(federation :: t()) :: Smee.Source.t() | nil
Returns the default MDQ service for the federation, or nil if none has been defined.
Creates a new Federation struct. The only requirement is a unique ID, passed as the first parameter.
Other information can be passed as an option:
contact
: general contact address for the federation, as a URL.name
: The full, official name of the federationurl
: The URL of the federation's homepageuri
: The publisher URI of the federationcountries
: A list of 2-letter country codes for countries the federation officially provides services for.policy
: URL for the federation's metadata policy documentationsources
: Map of atom IDs andSmee.Source
structs. Usedefault:
for the default aggregate, andmdq:
for the default MDQ service.
SmeeFeds comes with a list of built-in federations - use SmeeFeds.federations/0
to view them.
Specs
Returns the policy URL for the federation (if known) or nil
Specs
sources(federation :: t()) :: [Smee.Source.t()]
Lists all sources for the federation (it does not return their keys/labels)
If no sources have been defined it will return an empty list.
Specs
Returns the homepage URL for the federation, or nil.