Class: GOBL::Head::Link

Inherits:
Object show all
Defined in:
lib/generated/gobl/head/link.rb

Overview

Link defines a link between this document and another resource.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Link structure

'https://gobl.org/draft-0/head/link'

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#description ⇒ String (readonly)

Description of the resource to use when presenting to users.

Returns:

  • (String) 


29
 
# File 'lib/generated/gobl/head/link.rb', line 29

property :description, String

#key ⇒ GOBL::CBC::Key (readonly)

Key is a unique identifier for the link.

Returns:



18
 
# File 'lib/generated/gobl/head/link.rb', line 18

property :key, GOBL::CBC::Key

#mime ⇒ String (readonly)

Expected MIME type of the link’s content.

Returns:

  • (String) 


34
 
# File 'lib/generated/gobl/head/link.rb', line 34

property :mime, String

#title ⇒ String (readonly)

Title of the resource to use when presenting to users.

Returns:

  • (String) 


24
 
# File 'lib/generated/gobl/head/link.rb', line 24

property :title, String

#url ⇒ String (readonly)

URL of the resource.

Returns:

  • (String) 


39
 
# File 'lib/generated/gobl/head/link.rb', line 39

property :url, String