View Source

Class OEmbedProviderBase

Inheritance
object
Namespace: Umbraco.Cms.Core.Media.EmbedProviders
Assembly: Umbraco.Core.dll
Syntax
public abstract class OEmbedProviderBase : IEmbedProvider

Constructors

View Source

OEmbedProviderBase(IJsonSerializer)

Declaration
protected OEmbedProviderBase(IJsonSerializer jsonSerializer)
Parameters
Type Name Description
IJsonSerializer jsonSerializer

Properties

View Source

ApiEndpoint

The OEmbed API Endpoint

Declaration
public abstract string ApiEndpoint { get; }
Property Value
Type Description
string
View Source

RequestParams

A collection of querystring request parameters to append to the API URL

Declaration
public abstract Dictionary<string, string> RequestParams { get; }
Property Value
Type Description
Dictionary<string, string>
Examples

?key=value&key2=value2

View Source

UrlSchemeRegex

A string array of Regex patterns to match against the pasted OEmbed URL

Declaration
public abstract string[] UrlSchemeRegex { get; }
Property Value
Type Description
string[]

Methods

View Source

DownloadResponseAsync(string, CancellationToken)

Declaration
public virtual Task<string> DownloadResponseAsync(string url, CancellationToken cancellationToken)
Parameters
Type Name Description
string url
CancellationToken cancellationToken
Returns
Type Description
Task<string>
View Source

GetEmbedProviderUrl(string, int, int)

Declaration
public virtual string GetEmbedProviderUrl(string url, int maxWidth, int maxHeight)
Parameters
Type Name Description
string url
int maxWidth
int maxHeight
Returns
Type Description
string
View Source

GetEmbedProviderUrl(string, int?, int?)

Declaration
public virtual string GetEmbedProviderUrl(string url, int? maxWidth, int? maxHeight)
Parameters
Type Name Description
string url
int? maxWidth
int? maxHeight
Returns
Type Description
string
View Source

GetJsonBasedMarkupAsync(string, int?, int?, CancellationToken)

Declaration
public virtual Task<string?> GetJsonBasedMarkupAsync(string url, int? maxWidth, int? maxHeight, CancellationToken cancellationToken)
Parameters
Type Name Description
string url
int? maxWidth
int? maxHeight
CancellationToken cancellationToken
Returns
Type Description
Task<string>
View Source

GetJsonResponseAsync<T>(string, CancellationToken)

Declaration
public virtual Task<T?> GetJsonResponseAsync<T>(string url, CancellationToken cancellationToken) where T : class
Parameters
Type Name Description
string url
CancellationToken cancellationToken
Returns
Type Description
Task<T>
Type Parameters
Name Description
T
View Source

GetMarkupAsync(string, int?, int?, CancellationToken)

Declaration
public abstract Task<string?> GetMarkupAsync(string url, int? maxWidth, int? maxHeight, CancellationToken cancellationToken)
Parameters
Type Name Description
string url
int? maxWidth
int? maxHeight
CancellationToken cancellationToken
Returns
Type Description
Task<string>
View Source

GetXmlBasedMarkupAsync(string, int?, int?, CancellationToken, string)

Declaration
public virtual Task<string?> GetXmlBasedMarkupAsync(string url, int? maxWidth, int? maxHeight, CancellationToken cancellationToken, string property = "/oembed/html")
Parameters
Type Name Description
string url
int? maxWidth
int? maxHeight
CancellationToken cancellationToken
string property
Returns
Type Description
Task<string>
View Source

GetXmlProperty(XmlDocument, string)

Declaration
public virtual string GetXmlProperty(XmlDocument doc, string property)
Parameters
Type Name Description
XmlDocument doc
string property
Returns
Type Description
string
View Source

GetXmlResponseAsync(string, CancellationToken)

Declaration
public virtual Task<XmlDocument> GetXmlResponseAsync(string url, CancellationToken cancellationToken)
Parameters
Type Name Description
string url
CancellationToken cancellationToken
Returns
Type Description
Task<XmlDocument>