SmeeView.Aspects.Domain (SmeeView v0.1.0) View Source

Represents and processes <mdui:DomainHint> elements in entity metadata as Aspect structs.

The functions in this module are intended to be applied to individual Aspect structs - for extracting and processing collections of these records please use the matching View module.

Link to this section Summary

Functions

Returns the domain as a string

Is this aspect relevant to the IdP role?

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

Is this aspect relevant to the SP role?

Returns the domain as a string

Link to this section Types

Specs

t() :: %SmeeView.Aspects.Domain{domain: binary()}

Link to this section Functions

Specs

domain(aspect :: t()) :: binary() | nil

Returns the domain as a string

Domain.domain(aspect)
# => "unseen.edu"

Specs

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.

Domain.idp?(aspect)
# => true

Specs

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.

Domain.role(aspect)
# => :idp

Specs

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.

Domain.sp?(aspect)
# => false

Specs

text(aspect :: t()) :: binary() | nil

Returns the domain as a string

Domain.text8(aspect)
# => "unseen.edu"