SEO. JSONLD. Permit
(SEO v0.3.0-rc.0)
View Source
A permit issued by an organization, e.g. a parking pass.
Helper for building a Schema.org Permit JSON-LD structure.
Summary
Types
A JSON-LD map ready to be nested or rendered. String-keyed, always
includes "@type" set to "Permit", plus any camelCased
field keys the caller provided (see build/1). "@context" is added
at render time by SEO.JSONLD.meta/1 on the top-level node only.
Functions
Build a Permit JSON-LD map.
Types
@type attrs() :: %{ optional(:issued_by) => SEO.JSONLD.Organization.t() | map(), optional(:issued_through) => SEO.JSONLD.Service.t() | map(), optional(:permit_audience) => SEO.JSONLD.Audience.t() | map(), optional(:valid_for) => Duration.t() | String.t(), optional(:valid_from) => DateTime.t() | NaiveDateTime.t() | String.t() | Date.t(), optional(:valid_in) => SEO.JSONLD.AdministrativeArea.t() | map(), optional(:valid_until) => Date.t() | String.t(), optional(:additional_type) => String.t() | URI.t(), optional(:alternate_name) => String.t(), optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(), optional(:disambiguating_description) => String.t(), optional(:identifier) => String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(), optional(:image) => URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(), optional(:main_entity_of_page) => SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(), optional(:name) => String.t(), optional(:owner) => SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(), optional(:potential_action) => SEO.JSONLD.Action.t() | map(), optional(:same_as) => URI.t() | String.t(), optional(:subject_of) => SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(), optional(:url) => URI.t() | String.t() } | [ issued_by: SEO.JSONLD.Organization.t() | map(), issued_through: SEO.JSONLD.Service.t() | map(), permit_audience: SEO.JSONLD.Audience.t() | map(), valid_for: Duration.t() | String.t(), valid_from: DateTime.t() | NaiveDateTime.t() | String.t() | Date.t(), valid_in: SEO.JSONLD.AdministrativeArea.t() | map(), valid_until: Date.t() | String.t(), additional_type: String.t() | URI.t(), alternate_name: String.t(), description: SEO.JSONLD.TextObject.t() | map() | String.t(), disambiguating_description: String.t(), identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(), image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(), main_entity_of_page: SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(), name: String.t(), owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(), potential_action: SEO.JSONLD.Action.t() | map(), same_as: URI.t() | String.t(), subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(), url: URI.t() | String.t() ]
A JSON-LD map ready to be nested or rendered. String-keyed, always
includes "@type" set to "Permit", plus any camelCased
field keys the caller provided (see build/1). "@context" is added
at render time by SEO.JSONLD.meta/1 on the top-level node only.
Functions
Build a Permit JSON-LD map.
Fields
:issued_by- The organization issuing the item, for example aSEO.JSONLD.Permit,SEO.JSONLD.Ticket, orSEO.JSONLD.Certification.:issued_through- The service through which the permit was granted.:permit_audience- The target audience for this permit.:valid_for- The duration of validity of a permit or similar thing.:valid_from- The date when the item becomes valid.:valid_in- The geographic area where the item is valid. Applies for example to aSEO.JSONLD.Permit, aSEO.JSONLD.Certification, or anSEO.JSONLD.EducationalOccupationalCredential.:valid_until- The date when the item is no longer valid.
Inherited properties
Additional properties are available through the inheritance chain. See each ancestor's docs for its properties: