View Source

Class OEmbedProviderBase

Inheritance
System.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

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

RequestParams

Declaration
public abstract Dictionary<string, string> RequestParams { get; }
Property Value
Type Description
Umbraco.Cms.Core.Dictionary<System.String, System.String>
View Source

UrlSchemeRegex

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

Methods

View Source

DownloadResponseAsync(String, CancellationToken)

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

GeOEmbedDataAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Declaration
public virtual Task<string> GeOEmbedDataAsync(string url, int? maxWidth, int? maxHeight, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String url
System.Nullable<System.Int32> maxWidth
System.Nullable<System.Int32> maxHeight
CancellationToken cancellationToken
Returns
Type Description
Task<System.String>
View Source

GetEmbedProviderUrl(String, Int32, Int32)

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

GetEmbedProviderUrl(String, Nullable<Int32>, Nullable<Int32>)

Declaration
public virtual string GetEmbedProviderUrl(string url, int? maxWidth, int? maxHeight)
Parameters
Type Name Description
System.String url
System.Nullable<System.Int32> maxWidth
System.Nullable<System.Int32> maxHeight
Returns
Type Description
System.String
View Source

GetJsonBasedMarkupAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

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

GetJsonResponseAsync<T>(String, CancellationToken)

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

GetMarkup(String, Int32, Int32)

Declaration
public abstract string GetMarkup(string url, int maxWidth = 0, int maxHeight = 0)
Parameters
Type Name Description
System.String url
System.Int32 maxWidth
System.Int32 maxHeight
Returns
Type Description
System.String
View Source

GetMarkupAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

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

GetXmlBasedMarkupAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken, String)

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

GetXmlProperty(XmlDocument, String)

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

GetXmlResponseAsync(String, CancellationToken)

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