fm:MediaExternalIds


MediaExternalIds

The mediaexternalids component lists the external ids and their respective external id providers for any media item.

External ID Provider values are constants and their values are:

  • 0: Any provider other than the 7 constants listed below. Constant: EXTERNAL_ID_OTHER
  • 1: BRIGHTCOVE. Constant: EXTERNAL_ID_BRIGHTCOVE
  • 2: YOUTUBE. Constant: EXTERNAL_ID_YOUTUBE
  • 3: INSTAGRAM. Constant: EXTERNAL_ID_INSTAGRAM
  • 4: TWITTER. Constant: EXTERNAL_ID_TWITTER
  • 5: CHARLIEROSE. Constant: EXTERNAL_ID_CHARLIEROSE
  • 6: SWEARNET. Constant: EXTERNAL_ID_SWEARNET
  • 7: OOYALA. Constant: EXTERNAL_ID_OOYALA

Example 1

In order to use the media attributes (such as id, title,thumbUrl, approvedcomments) in the templates, you must pass them in the "fields" reference for the MediaList component.

<fm:MediaExternalIds mid="5358749"> <fm:Loop> mid: {$$mid}, external_id: {$$external_id}, external_id_provider {$$external_id_provider}, created {$$created} <br /> </fm:Loop> <fm:NoResults> No ExternalIds were found fore this media! </fm:NoResults> </fm:MediaExternalIds>

Example 2

In order to use the media attributes (such as id, title,thumbUrl, approvedcomments) in the templates, you must pass them in the "fields" reference for the MediaList component.

<fm:MediaExternalIds mid="5260207"> totalCount: {$$totalCount} <BR> <fm:Loop> mid: {$$mid}, $media.instagram.externalid: {$$media.instagram.externalid} <br /> </fm:Loop> <fm:NoResults> No ExternalIds were found fore this media! </fm:NoResults> </fm:MediaExternalIds>

Supported attributes

NameRequiredDefaultDescription
midRequiredN/AThe id of the media.

Template variables

NameDescription
external_idThe external id for an external id provider.
external_id_providerThe external id provider for the external id.
Possible valuse are:
  • 1 (Brightcove)
  • 2 (Youtube)
  • 3 (Instagram)
  • 4 (Twitter)
  • 5 (Charlie Rose)
  • 6 (Swearnet)
  • 7 (Ooyala)
  • 0 (any external id that does not have one of the previous references as a provider)
createdThe date/time the external id record was created or updated.
midThe id of the media.
mediaAn array of the media's external ids: Example of how to read: {$media.instagram.externalid} will display the media's externalid from Instagram, if it exists for this media.
totalItemsThe total number of external ids for the media
primary_external_idStates whether the external id is the primary one for the media: possible values are 1 (true) or 0 (false).

See also