title: Intents

version: 1.2.0
layout: default
sdk: discovery

# Intents

Version Intents 0.0.0-unknown.0

Table of Contents

• Table of Contents
• Overview
• Types
  • Intent
  • IntentProperties
  • EntityIntent
  • PlaybackIntent
  • SearchIntent
  • SectionIntent
  • TuneIntent
  • PlayEntityIntent
  • PlayQueryIntent
  • HomeIntent
  • LaunchIntent
  • NavigationIntent

Overview

undefined

Types

Intent

A Firebolt compliant representation of a user intention.

IntentProperties

EntityIntent

A Firebolt compliant representation of a user intention to navigate an app to a specific entity page, and bring that app to the foreground if needed.

type EntityIntent = {
  action: 'entity'
  data:
    | ProgramEntity
    | MusicEntity
    | ChannelEntity
    | UntypedEntity
    | PlaylistEntity
  context: object
}

PlaybackIntent

A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed.

type PlaybackIntent = {
  action: 'playback'
  data: PlayableEntity
  context: object
}

See also:

PlayableEntity

SearchIntent

A Firebolt compliant representation of a user intention to navigate an app to it's search UI with a search term populated, and bring that app to the foreground if needed.

type SearchIntent = {
  action: 'search'
  data?: object
  context: object
}

SectionIntent

A Firebolt compliant representation of a user intention to navigate an app to a section not covered by home, entity, player, or search, and bring that app to the foreground if needed.

type SectionIntent = {
  action: 'section'
  data: object
  context: object
}

TuneIntent

A Firebolt compliant representation of a user intention to 'tune' to a traditional over-the-air broadcast, or an OTT Stream from an OTT or vMVPD App.

type TuneIntent = {
  action: 'tune'
  data: object
  context: object
}

See also:

ChannelEntity

PlayEntityIntent

A Firebolt compliant representation of a user intention to navigate an app to a the video player for a specific, playable entity, and bring that app to the foreground if needed.

type PlayEntityIntent = {
  action: 'play-entity'
  data: object
  context: object
}

See also:

PlayableEntity

PlayQueryIntent

A Firebolt compliant representation of a user intention to navigate an app to a the video player for an abstract query to be searched for and played by the app.

type PlayQueryIntent = {
  action: 'play-query'
  data: object
  context: object
}

See also:

ProgramType
MusicType

HomeIntent

A Firebolt compliant representation of a user intention to navigate an app to it's home screen, and bring that app to the foreground if needed.

type HomeIntent = {
  action: 'home'
  context: object
}

LaunchIntent

A Firebolt compliant representation of a user intention to launch an app.

type LaunchIntent = {
  action: 'launch'
  context: object
}

NavigationIntent

A Firebolt compliant representation of a user intention to navigate to a specific place in an app.

type NavigationIntent =
  | HomeIntent
  | LaunchIntent
  | EntityIntent
  | PlaybackIntent
  | SearchIntent
  | SectionIntent
  | TuneIntent
  | PlayEntityIntent
  | PlayQueryIntent

See also:

HomeIntent
LaunchIntent
EntityIntent
PlaybackIntent
SearchIntent
SectionIntent
TuneIntent
PlayEntityIntent
PlayQueryIntent