Skip to main content

SearchResult

An individual search result.

type SearchResult {
  contentType: ContentType!
  displayPassportIcon: Boolean!
  id: UUID!
  imageTransformTemplate: String
  longDescription: String!
  overlayText: String
  overlayTextBackground: HexColorCode
  overlayTextColor: HexColorCode
  parent: SearchResultParent
  queryString: String
  releasedAt: DateTime
  searchSubtitles: [String!]!
  shortDescription: String!
  slug: String!
  stationId: UUID!
  title: String!
}

Fields​

SearchResult.contentType ● ContentType! non-null enum references​

SearchResult.displayPassportIcon ● Boolean! non-null scalar references​

SearchResult.id ● UUID! non-null scalar references​

SearchResult.imageTransformTemplate ● String scalar references​

RFC 6570 compliant image URL template for a 16x9 image representing the result.

See ImageWithProfile.transformTemplate

SearchResult.longDescription ● String! non-null scalar references​

SearchResult.overlayText ● String scalar references​

Suggested text to place "overlaying" result image, for example.

SearchResult.overlayTextBackground ● HexColorCode scalar references​

Background color as a hex color code to use behind overlayText string.

SearchResult.overlayTextColor ● HexColorCode scalar references​

Text color as a hex color code to use for overlayText string.

SearchResult.parent ● SearchResultParent object references​

Search result parent information, if a parent exists.

SearchResult.queryString ● String scalar references​

API consumers should use this exact set of parameters for a request associated with this element.

SearchResult.releasedAt ● DateTime scalar references​

SearchResult.searchSubtitles ● [String!]! non-null scalar references​

Result subtitle metadata.

The array may be empty if there is no subtitle data.

Subtitle items are generally meant to be presented as a text with separators adjacent to the result title.

SearchResult.shortDescription ● String! non-null scalar references​

SearchResult.slug ● String! non-null scalar references​

SearchResult.stationId ● UUID! non-null scalar references​

SearchResult.title ● String! non-null scalar references​

Member Of​

SearchResults object