OEmbed (nmote-oembed 0.9 API)

All Known Implementing Classes:

AmChartsEmbed, AnimotoEmbed, BasicOEmbed, CollegeHumorEmbed, CoubEmbed, DeviantArtEmbed, DotSubEmbed, EmbedlyEmbed, FunnyOrDieEmbed, GeoGraphEmbed, GettyImagesEmbed, HuluEmbed, InstagramEmbed, MixCloudEmbed, MobyPictureEmbed, NfbCanadaEmbed, NoembedEmbed, SapoVideosEmbed, SlideShareEmbed, ViddlerEmbed, VideoJugEmbed, VimeoEmbed, WebPageAndLicenseEmbed
```
public interface OEmbed
```
OEmbed instance. Returned by OEmbedProvider from passed resource URL.

Author:

vnesek

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface OEmbed.Type
Standard oEmbed types.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`OEmbed.Type` Standard oEmbed types.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAuthorName()` The name of the author/owner of the resource.
`String`	`getAuthorUrl()` A URL for the author/owner of the resource.
`Long`	`getCacheAge()` The suggested cache lifetime for this resource, in seconds.
`String`	`getDescription()` Description
`Integer`	`getHeight()` The height in pixels of the image specified in the url parameter.
`String`	`getHtml()` The HTML required to embed a video player.
`String`	`getProviderName()` The name of the resource provider.
`String`	`getProviderUrl()` The url of the resource provider.
`Integer`	`getThumbnailHeight()` The height of the optional thumbnail.
`String`	`getThumbnailUrl()` A URL to a thumbnail image representing the resource.
`Integer`	`getThumbnailWidth()` The width of the optional thumbnail.
`String`	`getTitle()` A text title describing the resource.
`String`	`getType()` The resource type.
`String`	`getUrl()` The source URL of the image.
`String`	`getVersion()` The oEmbed version number.
`Integer`	`getWidth()` The width in pixels of the image specified in the url parameter.
`boolean`	`hasDescription()` Returns true if oEmbed has description.
`boolean`	`hasHtml()` Returns true if oEmbed has html.
`boolean`	`hasThumbnail()` Returns true if oEmbed has thumbnail.
`boolean`	`hasTitle()` Returns true if oEmbed has title.

- Method Detail
  - getAuthorName
```
String getAuthorName()
```
    The name of the author/owner of the resource.
    
    Returns:
    
    author name
  - getAuthorUrl
```
String getAuthorUrl()
```
    A URL for the author/owner of the resource.
    
    Returns:
    
    author url
  - getCacheAge
```
Long getCacheAge()
```
    The suggested cache lifetime for this resource, in seconds. Consumers may choose to ignore this value.
    
    Returns:
    
    cache age in seconds
  - getDescription
```
String getDescription()
```
    Description
    
    Returns:
    
    description
  - getHeight
```
Integer getHeight()
```
    The height in pixels of the image specified in the url parameter.
    
    Returns:
    
    height in px
  - getHtml
```
String getHtml()
```
    The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities.
    
    Returns:
    
    HTML content
  - getProviderName
```
String getProviderName()
```
    The name of the resource provider.
    
    Returns:
    
    provider name
  - getProviderUrl
```
String getProviderUrl()
```
    The url of the resource provider.
    
    Returns:
    
    provider url
  - getThumbnailHeight
```
Integer getThumbnailHeight()
```
    The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present.
    
    Returns:
    
    height in px
  - getThumbnailUrl
```
String getThumbnailUrl()
```
    A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present.
    
    Returns:
    
    url
  - getThumbnailWidth
```
Integer getThumbnailWidth()
```
    The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present.
    
    Returns:
    
    width in px
  - getTitle
```
String getTitle()
```
    A text title describing the resource.
    
    Returns:
    
    title
  - getType
```
String getType()
```
    The resource type. Valid values, along with value-specific parameters are described below.
    
    Returns:
    
    type
  - getUrl
```
String getUrl()
```
    The source URL of the image. Consumers should be able to insert this URL into an <img> element. Only HTTP and HTTPS URLs are valid.
    
    Returns:
    
    url
  - getVersion
```
String getVersion()
```
    The oEmbed version number. This must be 1.0.
    
    Returns:
    
    version
  - getWidth
```
Integer getWidth()
```
    The width in pixels of the image specified in the url parameter.
    
    Returns:
    
    width in px
  - hasDescription
```
boolean hasDescription()
```
    Returns true if oEmbed has description.
    
    Returns:
    
    true if oEmbed has description
  - hasHtml
```
boolean hasHtml()
```
    Returns true if oEmbed has html.
    
    Returns:
    
    true if oEmbed has html
  - hasThumbnail
```
boolean hasThumbnail()
```
    Returns true if oEmbed has thumbnail.
    
    Returns:
    
    true if oEmbed has thumbnail
  - hasTitle
```
boolean hasTitle()
```
    Returns true if oEmbed has title.
    
    Returns:
    
    true if oEmbed has title

Interface OEmbed

Nested Class Summary

Method Summary

Method Detail

getAuthorName

getAuthorUrl

getCacheAge

getDescription

getHeight

getHtml

getProviderName

getProviderUrl

getThumbnailHeight

getThumbnailUrl

getThumbnailWidth

getTitle

getType

getUrl

getVersion

getWidth

hasDescription

hasHtml

hasThumbnail

hasTitle