CardMedia class

Definition of a media entity for a card

Constructors

CardMedia(Session)

Creates a new CardMedia, which defines a media entity for a card.

Methods

create(Session, string)

Factory method for creation of Card media entities

profile(string)

Optional profile hint to the client to differentiate multiple MediaUrl objects from each other

toMedia()

Returns the url definition for a Media entity for a card

url(string)

Url of the media

Constructor Details

CardMedia(Session)

Creates a new CardMedia, which defines a media entity for a card.

new CardMedia(session?: Session)

Parameters

session
Session

(Optional) will be used to localize any text.

Method Details

create(Session, string)

Factory method for creation of Card media entities

static function create(session: Session, url: string)

Parameters

session
Session
url

string

Returns

profile(string)

Optional profile hint to the client to differentiate multiple MediaUrl objects from each other

function profile(text: string)

Parameters

text

string

Returns

this

toMedia()

Returns the url definition for a Media entity for a card

function toMedia()

Returns

url(string)

Url of the media

function url(u: string)

Parameters

u

string

Returns

this