Skip to main content

Classes Result

Explore the various result classes designed to handle different aspects of data retrieval and display within the IPTV system.

Class Definitions​

RemoteGroupResult​

The RemoteGroupResult class serves as a response container for remote group data queries within the IPTV system. It provides the following key features:

  • Multi-language support through IMultiLanguageText interface
  • Visual customization through IImage interface for group thumbnails and artwork
  • Content organization through arrays of Channel and Group objects
  • Load more configuration via ILoadMore for efficient content navigation
class RemoteGroupResult {
  name?: string | IMultiLanguageText;
  image?: IImage;
  grid_number?: number;
  groups?: Array<Group>;
  channels?: Array<Channel>;
  sorts?: Array<ISortItem>;
  search?: ISearchConfig;
  load_more?: ILoadMore;
}

RemoteChannelResult​

The RemoteChannelResult class handles the results of queries for media content within a specific channel, focusing on delivering media content. Here's a detailed description of its attributes:

  • An array of Source objects, representing the media content within the channel
class RemoteChannelResult {
  image?: IImage;
  subtitle?: String;
  description?: String;
  sources: Array<Source>;
  keys?: Array<ISortItem>;
  tags?: Array<ISortItem>;
  comments?: Array<Comment>;
  related?: Related;
  share?: IRemoteData;
  tracking?: IRemoteData;
}

RemoteSourceResult​

The RemoteSourceResult class manages content collections for a specific source, providing:

  • An array of Content objects representing content collections in the source
class RemoteSourceResult {
  contents: Array<Content>;
}

RemoteContentResult​

The RemoteContentResult class manages the response data for streams within a specific content, providing:

  • An array of Stream objects containing stream details and streaming information
class RemoteContentResult {
  streams: Array<Stream>;
}

RemoteStreamResult​

The RemoteStreamResult class manages streaming links for a specific stream, providing:

  • An array of StreamLink objects containing stream URLs, types, and configurations for different quality levels and formats
  • An array of File objects containing file information and download URLs
class RemoteStreamResult {
  stream_links: Array<StreamLink>;
  files: Array<File>;
  tracking?: IRemoteData;
}

RemoteRelatedResult​

The RemoteRelatedResult class provides a structured response for displaying related channels based on viewer interests or content similarity:

class RemoteRelatedResult {
  channels: Array<Channel>;
}

SuggestTextSearchResult​

The SuggestTextSearchResult class returns an array of suggested search terms to assist users in refining their queries quickly and accurately.

Return: Array<string>

SearchResult​

The SearchResult class structures the response from content search queries, organizing search results effectively:

  • Multi-language support through IMultiLanguageText interface
  • An array of Channel objects representing the search results
  • An array of Group objects for hierarchical content organization
  • Sort configuration via ISortItem for customizable sorting of results
  • Load more configuration via ILoadMore for efficient content navigation
class SearchResult {
  grid_number?: number;
  groups?: Array<Group>;
  channels?: Array<Channel>;
  sorts?: Array<ISortItem>;
  load_more?: ILoadMore;
}

SortResult​

The SortResult class structures the response from sort queries, organizing sort results effectively:

  • Multi-language support through IMultiLanguageText interface
  • An array of Group objects for hierarchical content organization
  • An array of Channel objects for direct content access
  • Sort configuration via ISortItem for customizable sorting of results
  • Load more configuration via ILoadMore for efficient content navigation
class SortResult {
  grid_number?: number;
  groups?: Array<Group>;
  channels?: Array<Channel>;
  sorts?: Array<ISortItem>;
  load_more?: ILoadMore;
}

ShareResult​

The ShareResult class is designed to encapsulate the necessary details for sharing specific media content:

  • A Channel object representing the media being shared.
  • An associated Provider to give context about the content source.
class ShareResult {
  channel: Channel;
  provider?: Provider;
}

BannerResult​

The BannerResult class manages different types of banner displays within the application:

class BannerResult {
  max_banner_show?: number;
  open?: Array<IBannerItem>;
  fullscreen?: Array<IBannerItem>;
  footer?: Array<IBannerItem>;
  player?: Array<IBannerItem>;
  list?: Array<IBannerItem>;
}

LoadMoreResult​

The LoadMoreResult class structures the response for loading more content, facilitating efficient content navigation:

  • An array of Group objects for hierarchical content organization
  • An array of Channel objects for direct content access
  • Load more configuration via ILoadMore for efficient content navigation
class LoadMoreResult {
  grid_number?: number;
  groups?: Array<Group>;
  channels?: Array<Channel>;
  load_more?: ILoadMore;
}