Object definition of OGHref

OGHref model version in pub.dev

This library provides structure of rich information link and parser from HTML documentations.

Usages

Import dependencies

  1. Add oghref_model into pubspec.yaml
    dependencies:
        oghref_model: # Latest stable version
    
  2. Import package
    import 'package:oghref_model/model.dart';
    
  3. If custom parser implementations required, please also import buffer_parser.dart
    import 'package:oghref_model/buffer_parser.dart';
    

Implementations

See example;

Limitations and restrictions

  • MetaFetch only recognize the first property name prefix in a sequence of <meta> tag in <head>. For example, given a HTML file:

    <head>
        <meta property="og:title" content="Title"/>
        <meta property="twitter:card" content="summary"/>
    </head>
    

    In this case, MetaFetch only recognize og prefix and remaining metadata will be ignored. If preferred to override the first property prefix recognization, please apply this setting in MetaFetch (in this case, Twitter Card):

    MetaFetch()..primaryPrefix = "twitter";
    
  • Unless for testing, URL response's content type must be satisified below:

    • text/html
    • application/xhtml+xml

    Otherwise, MetaFetch refuses to parse properties to MetaInfo.

  • <meta> must be hard-coded in HTML, generated by JavaScript will be ignored.

  • Flutter web uses AJAX to fetch content of website, which means it relys on cross origin enabled website. However, majority of websites omits Access-Control-Allow-Origin or only allows specific website for security reason. Therefore, the best practise is using server-side to complete retrive data process.

License

AGPL 3.0 or later (For import dedicatedly)

MIT (For import with widgets)

Libraries

buffer_parser
Offering the classes for constructing custom parser on another protocol.
model
A basic library shipped with model, defined parser and fetch only for implementation.
testing
A library uses for testing resources and should not be deployed under production.
verifiers
Additional libarary for verifying information given from OgHref.