View Source SmeeView.Aspects.DiscoUI (SmeeView v0.2.0)

This aspect contains a bundle of related Metadata UI ("mdui:") aspects from entity metadata.

Since displaynames, descriptions, URLs, etc are often used together this Aspect exists to make gathering them all a little simpler.

You can extract and process each of the different types of aspects using their own View modules:

Summary

Functions

Returns list of description aspects (from <mdui:Description> elements)

Returns list of displaynames aspects (from <mdui:Displayname> elements)

Is this aspect relevant to the IdP role?

Returns a list of Information URLs (from <mdui:InformationURL> elements)

Returns list of keyword aspects (from <mdui:Keywords> elements)

Returns list of logo aspects (from <mdui:Logo> elements)

Returns the first Organizations (there is probably just one) for use if MDUI information is missing

Returns a list of Organizations (probably just one) for use if MDUI information is missing

Returns a list of Privacy URLs (from <mdui:PrivacyStatementURL> elements)

Returns the associated role for this aspect: :sp, :idp or :all

Is this aspect relevant to the SP role?

Types

@type t() :: %SmeeView.Aspects.DiscoUI{
  descriptions: list(),
  displaynames: list(),
  information_urls: list(),
  keywords: list(),
  logos: list(),
  organizations: list(),
  privacy_urls: list()
}

Functions

@spec descriptions(aspect :: t()) :: list()

Returns list of description aspects (from <mdui:Description> elements)

DiscoUI.descriptions(aspect)
# => [%Description{}, %Description{}]
@spec displaynames(aspect :: t()) :: list()

Returns list of displaynames aspects (from <mdui:Displayname> elements)

DiscoUI.displaynames(aspect)
# => [%Displayname{}, %Displayname{}]
@spec idp?(aspect :: t()) :: boolean()

Is this aspect relevant to the IdP role?

Will return true if the aspect has been derived from an IdP role, or is applicable to all roles.

DiscoUI.idp?(aspect)
# => true
Link to this function

information_urls(aspect)

View Source
@spec information_urls(aspect :: t()) :: list()

Returns a list of Information URLs (from <mdui:InformationURL> elements)

DiscoUI.information_urls(aspect)
# => [%InformationURL{}, %InformationURL{}]
@spec keywords(aspect :: t()) :: list()

Returns list of keyword aspects (from <mdui:Keywords> elements)

DiscoUI.keywords(aspect)
# => [%Keywords{}]
@spec logos(aspect :: t()) :: list()

Returns list of logo aspects (from <mdui:Logo> elements)

DiscoUI.logos(aspect)
# => [%Logo{}, %Logo{}, %Logo{}]
@spec organization(aspect :: t()) :: struct() | nil

Returns the first Organizations (there is probably just one) for use if MDUI information is missing

DiscoUI.organization(aspect)
# => %Organization{}
@spec organizations(aspect :: t()) :: list()

Returns a list of Organizations (probably just one) for use if MDUI information is missing

DiscoUI.organizations(aspect)
# => [%Organization{}]
@spec privacy_urls(aspect :: t()) :: list()

Returns a list of Privacy URLs (from <mdui:PrivacyStatementURL> elements)

DiscoUI.privacy_urls(aspect)
# => [%PrivacyURL{}, %PrivacyURL{}]
@spec role(aspect :: t()) :: atom()

Returns the associated role for this aspect: :sp, :idp or :all

The role type is useful when handling a mixed list of aspects that may be specific to certain roles of an entity.

DiscoUI.role(aspect)
# => :idp
@spec sp?(aspect :: t()) :: boolean()

Is this aspect relevant to the SP role?

Will return true if the aspect has been derived from an SP role, or is applicable to all roles.

DiscoUI.sp?(aspect)
# => false