Ngx meta.opengraph

OpenGraph interface

Open Graph module metadata values that can be set

Signature:

export interface OpenGraph

Properties

Property	Modifiers	Type	Description
[description?](./ngx-meta.opengraph.description.md)	`readonly`	string \\| null	_(Optional)_ Optional metadata. A one to two sentence description of your object. Can be set with [GlobalMetadata.description](./ngx-meta.globalmetadata.description.md) - [Property specs](https://ogp.me/#:~:text=og%3Adescription)
[image?](./ngx-meta.opengraph.image.md)	`readonly`	[OpenGraphImage](./ngx-meta.opengraphimage.md) \\| null	_(Optional)_ Basic metadata. An image which should represent your object within the graph. Can be partially set with [GlobalMetadata.image](./ngx-meta.globalmetadata.image.md)
[locale?](./ngx-meta.opengraph.locale.md)	`readonly`	string \\| null	_(Optional)_ Optional metadata. The locale these tags are marked up in. Of the format `language_TERRITORY`. If missing, assumed to be `en_US` as per Open Graph specs Can be set with [GlobalMetadata.locale](./ngx-meta.globalmetadata.locale.md) - [Property specs](https://ogp.me/#:~:text=og%3Alocale)
[profile?](./ngx-meta.opengraph.profile.md)	`readonly`	[OpenGraphProfile](./ngx-meta.opengraphprofile.md)	_(Optional)_ Open Graph profile metadata for this page Requires Open Graph Profile module / provider to work - [Open Graph profile type](./ngx-meta.opengraphprofile.md) - [Open Graph profile specs](https://ogp.me/#type_profile)
[siteName?](./ngx-meta.opengraph.sitename.md)	`readonly`	string \\| null	_(Optional)_ Optional metadata. If your object is part of a larger website, the name which should be displayed for the overall site. e.g., "IMDb". Can be set with [GlobalMetadata.applicationName](./ngx-meta.globalmetadata.applicationname.md) - [Property specs](https://ogp.me/#:~:text=og%3Asite_name)
[title?](./ngx-meta.opengraph.title.md)	`readonly`	string \\| null	_(Optional)_ Basic metadata. The title of your object as it should appear within the graph, e.g., "The Rock". Can be set with [GlobalMetadata.title](./ngx-meta.globalmetadata.title.md) - [Property specs](https://ogp.me/#:~:text=og%3Atitle)
[type?](./ngx-meta.opengraph.type.md)	`readonly`	[OpenGraphType](./ngx-meta.opengraphtype.md) \\| null	_(Optional)_ Basic metadata. The type of your object, e.g., "`video.movie`". Depending on the type you specify, other properties may also be required. See [OpenGraphType](./ngx-meta.opengraphtype.md) for a list of `const`s you can use to specify the type, so you don't have to write them yourself. - [Property specs](https://ogp.me/#:~:text=og%3Atypes) - [Available object types in spec](https://ogp.me/#types)
[url?](./ngx-meta.opengraph.url.md)	`readonly`	URL \\| string \\| null	_(Optional)_ Basic metadata. The canonical URL of your object that will be used as its permanent ID in the graph, e.g., "https://www.imdb.com/title/tt0117500/". Can be set with [GlobalMetadata.canonicalUrl](./ngx-meta.globalmetadata.canonicalurl.md) - [Property specs](https://ogp.me/#:~:text=og%3Aurl)