TwurpleAuthenticationGetting dataExamplesFAQMigration

HelixExtension

A Twitch Extension.

Overview

Properties

allowedConfigUrls

Type: string[]

The extension's allowed configuration URLs.

allowedPanelUrls

Type: string[]

The extension's allowed panel URLs.

authorName

Type: string

The name of the extension's author.

bitsEnabled

Type: boolean

Whether bits are enabled for the extension.

componentAspectHeight

Type: number | null

The aspect height of the extension's component view.

If the extension does not have a component view, this is null.

componentAspectRatioX

Type: number | null

The horizontal aspect ratio of the extension's component view.

If the extension does not have a component view, this is null.

componentAspectRatioY

Type: number | null

The vertical aspect ratio of the extension's component view.

If the extension does not have a component view, this is null.

componentAspectWidth

Type: number | null

The aspect width of the extension's component view.

If the extension does not have a component view, this is null.

componentAutoScales

Value: false | true | null

Whether the extension's component view should automatically scale.

If the extension does not have a component view, this is null.

componentCanLinkExternalContent

Value: false | true | null

Whether the extension can link to external content from its component view.

If the extension does not have a component view, this is null.

componentScalePixels

Type: number | null

The base width of the extension's component view to use for scaling.

If the extension does not have a component view, this is null.

componentSize

Type: number | null

The size of the extension's component view.

If the extension does not have a component view, this is null.

componentTargetHeight

Type: number | null

The target height of the extension's component view.

If the extension does not have a component view, this is null.

componentViewerUrl

Type: string | null

The URL shown to the viewer when the extension is shown as a video component.

If the extension does not have a component view, this is null.

componentZoom

Value: false | true | null

Whether zooming is enabled for the extension's component view.

If the extension does not have a component view, this is null.

componentZoomPixels

Type: number | null

The zoom pixels of the extension's component view.

If the extension does not have a component view, this is null.

configCanLinkExternalContent

Value: false | true | null

Whether the extension can link to external content from its config view.

If the extension does not have a config view, this is null.

configurationLocation

Type: HelixExtensionConfigurationLocation

The location of the extension's configuration.

configViewerUrl

Type: string | null

The URL shown to the viewer when the extension's configuration page is shown.

If the extension does not have a config view, this is null.

description

Type: string

The extension's description.

hasChatSupport

Type: boolean

Whether the extension has support for sending chat messages.

iconUrl

Type: string

The URL of the extension's default sized icon.

id

Type: string

The extension's ID.

installable

Type: boolean

Whether the extension can be installed.

mobileViewerUrl

Type: string | null

The URL shown when a viewer opens the extension on a mobile device.

If the extension does not have a mobile view, this is null.

name

Type: string

The extension's name.

overlayCanLinkExternalContent

Value: false | true | null

Whether the extension can link to external content from its overlay view.

If the extension does not have a overlay view, this is null.

overlayViewerUrl

Type: string | null

The URL shown to the viewer when the extension is shown as a video overlay.

If the extension does not have a overlay view, this is null.

panelCanLinkExternalContent

Value: false | true | null

Whether the extension can link to external content from its panel view.

If the extension does not have a panel view, this is null.

panelHeight

Type: number | null

The height of the extension panel.

If the extension does not have a panel view, this is null.

panelViewerUrl

Type: string | null

The URL shown to the viewer when the extension is shown as a panel.

If the extension does not have a panel view, this is null.

privacyPolicyUrl

Type: string

The URL of the extension's privacy policy.

screenshotUrls

Type: string[]

The URLs of the extension's screenshots.

state

Type: HelixExtensionState

The extension's activity state.

subscriptionsSupportLevel

Type: HelixExtensionSubscriptionsSupportLevel

The extension's level of support for subscriptions.

summary

Type: string

The extension's feature summary.

supportEmail

Type: string

The extension's support email address.

tosUrl

Type: string

The URL of the extension's terms of service.

version

Type: string

The extension's version.

viewerSummery

Type: string

The extension's feature summary for viewers.

Methods

getIconUrl(size)

Gets the URL of the extension's icon in the given size.

ParameterTypeRequiredDefaultDescription
size
HelixExtensionIconSize

The size of an extension icon.

Aliased type: "100x100" | "24x24" | "300x200"

none

The size of the icon.

Return type: string