OpenGraph-Net 3.2.0

OpenGraphNet

A simple .net assembly to use to parse Open Graph information from either a URL or an HTML snippet. You can read more about the Open Graph protocol @ http://ogp.me.

Usage

These are the basic operations of the OpenGraphNet parser.

Parsing from a URL

Synchronosly parse a url:

OpenGraph graph = OpenGraph.ParseUrl("https://open.spotify.com/user/er811nzvdw2cy2qgkrlei9sqe/playlist/2lzTTRqhYS6AkHPIvdX9u3?si=KcZxfwiIR7OBPCzj20utaQ");

Use async/await to parse a url:

OpenGraph graph = await OpenGraph.ParseUrlAsync("https://open.spotify.com/user/er811nzvdw2cy2qgkrlei9sqe/playlist/2lzTTRqhYS6AkHPIvdX9u3?si=KcZxfwiIR7OBPCzj20utaQ");

Acessing Values

Accessing Metadata

Each metadata element is is stored as an array. Additionally, each element's properties are also stored as an array.

<meta property="og:image" content="http://example.com/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:locale" content="en">
<meta property="og:locale:alternate" content="en_US">
<meta property="og:locale:alternate" content="en_GB">

You would access the values from the sample HTML above as:

• graph.Metadata["og:image"].First().Value // "http://example.com/img1.png".
• graph.Metadata["og:image"].First().Properties["width"].Value() // "30".
• graph.Metadata["og:image"][1].Value // "http://example.com/img2.png".
• graph.Metadata["og:image"][1].Properties["width"].Value() // "30".
• graph.Metadata["og:locale"].Value() // "en"
• graph.Metadata["og:locale"].First().Properties["alternate"][0].Value // "en_US"
• graph.Metadata["og:locale"].First().Properties["alternate"][1].Value // "en_GB"

Basic Metadata

The four required Open Graph properties for all pages are available as direct properties on the OpenGraph object.

• graph.Type is a shortcut for graph.Metadata["og:type"].Value()
• graph.Title is a shortcut for graph.Metadata["og:title"].Value()
• graph.Image is a shortcut for graph.Metadata["og:image"].Value() Note: since there can be multiple images, this helper returns the URI of the first image. If you want to access images or child properties like og:image:width then you should instead use the graph.Metadata dictionary.
• graph.Url is a shortcut for graph.Metadata["og:url"].Value()

Misc

The original url used to generate the OpenGraph data is available from the OriginalUrl property graph.OriginalUrl.

Creating OpenGraph Data

To create OpenGraph data in memory use the following code:

var graph = OpenGraph.MakeGraph(
    title: "My Title", 
    type: "website", 
    image: "http://example.com/img/img1.png", 
    url: "http://example.com/home", 
    description: "My Description", 
    siteName: "Example.com");
graph.AddMetadata("og", "image", "http://example.com/img/img2.png");
graph.Metadata["og:image"][0].AddProperty("width", "30");
graph.Metadata["og:image"][1].AddProperty("width", "60");
System.Console.Write(graph.ToString());

The previous System.Console.Write(graph.ToString()); will produce the following HTML (formatting added for legibility):

<meta property="og:title" content="My Title">
<meta property="og:type" content="website">
<meta property="og:image" content="http://example.com/img/img1.png">
<meta property="og:image:width" content="30">
<meta property="og:image" content="http://example.com/img/img2.png">
<meta property="og:image:width" content="60">
<meta property="og:url" content="http://example.com/home">
<meta property="og:description" content="My Description">
<meta property="og:site_name" content="Example.com">