Skip to main content

Function: getOEmbedUrl()

getOEmbedUrl(client, props): URL

Gets the URL for the oEmbed endpoint.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ url: string; format: "json" | "xml"; maxwidth?: number; maxheight?: number; } = getOEmbedQuerySchema

Query parameters (url, format, maxwidth, maxheight)

query.url​

string = ...

query.format​

"json" | "xml" = ...

query.maxwidth?​

number = ...

query.maxheight?​

number = ...

Returns​

URL

URL object for the oEmbed endpoint

Example​

const oembedUrl = getOEmbedUrl(client, {
  query: { url: 'https://example.com/org/my-org', format: 'json' }
});