Class: JSON::LD::API::RemoteDocument

Inherits:
Object
  • Object
show all
Defined in:
vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb

Overview

A RemoteDocument is returned from a documentLoader.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, documentUrl: nil, contentType: nil, contextUrl: nil, profile: nil, **options) ⇒ RemoteDocument

Returns a new instance of RemoteDocument.

Parameters:

  • document (RDF::Util::File::RemoteDocument)
  • documentUrl (String) (defaults to: nil) —

    The final URL of the loaded document. This is important to handle HTTP redirects properly.

  • contentType (String) (defaults to: nil) —

    The Content-Type of the loaded document, exclusive of any optional parameters.

  • contextUrl (String) (defaults to: nil) —

    The URL of a remote context as specified by an HTTP Link header with rel=http://www.w3.org/ns/json-ld#context

  • profile (String) (defaults to: nil) —

    The value of any profile parameter retrieved as part of the original contentType.

  • options (Hash) —

    a customizable set of options

Options Hash (**options):



925
926
927
928
929
930
931
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 925

def initialize(document, documentUrl: nil, contentType: nil, contextUrl: nil, profile: nil, **options)
  @document = document
  @documentUrl = documentUrl || options[:base_uri]
  @contentType = contentType || options[:content_type]
  @contextUrl = contextUrl
  @profile = profile
end

Instance Attribute Details

#contentType ⇒ String (readonly)

The Content-Type of the loaded document, exclusive of any optional parameters.

Returns:



901
902
903
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 901

def contentType
  @contentType
end

#contextUrl ⇒ String

Returns The URL of a remote context as specified by an HTTP Link header with rel=http://www.w3.org/ns/json-ld#context.

Returns:

  • (String) —

    The URL of a remote context as specified by an HTTP Link header with rel=http://www.w3.org/ns/json-ld#context



905
906
907
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 905

def contextUrl
  @contextUrl
end

#document ⇒ Array<Hash>, Hash

The parsed retrieved document.

Returns:



909
910
911
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 909

def document
  @document
end

#documentUrl ⇒ String

The final URL of the loaded document. This is important to handle HTTP redirects properly.

Returns:



897
898
899
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 897

def documentUrl
  @documentUrl
end

#profile ⇒ String

The value of any profile parameter retrieved as part of the original contentType.

Returns:



913
914
915
 
# File 'vendor/bundler/ruby/3.2.0/bundler/gems/json-ld-cb5ef847d963/lib/json/ld/api.rb', line 913

def profile
  @profile
end