Type

SupportedURLs

Links that go to Apple News, other Apple apps, and external sites.

Declaration

string SupportedURLs

Discussion

You can define the following Apple domain links for the URL property in Text components:

  • A link to an Apple News article. A valid link should begin with https://apple.news/. To link within the document, use an anchor link starting with #, followed by the component identifier to which you want to link. To link to a component in another article, you must include an Apple News URL with the # and component identifier after it; for example, https://apple.news/A5vHgPPmQSvuIxPjeXLTdGQ#TextComponent-1.

  • A canonical link element that is associated with an Apple News article by its canonicalURL in Metadata.

  • A link to the iTunes Store, the App Store, Apple Books, Apple Music, or Apple Podcasts created using Link Maker.

  • A link to a ticker symbol in the Stocks app, using the URL format stocks://?symbol=ticker symbol; for example, stocks://?symbol=AAPL.

You can define the following external links for the URL property in Text components:

  • A universal link. See Universal Links for Developers.

  • A link to an external site.

  • A link to an email address, using mailto:

  • A link to a hosted calendar, using webcal://</value>.

See Also

Links

object LinkAddition

The addition object for defining links in text components that don’t use HTML or Markdown formatting.

object ComponentLink

The component addition object for making a component interactive and opening a link to another location in News.

object Addition

Properties shared by all addition types.

object ComponentAddition

Properties shared by all types of component additions.

type SupportedInternalURLs

Links that go to Apple News and other Apple apps.