Interface: ScheduleMeta
Hierarchy
↳ ScheduleMeta
Index
Properties
- cacheExpiresAt
- count
- country
- dataType
- firstPage
- fromCache
- lastPage
- nesting
- pageNumber
- pageSize
- paginated
- rpuid
- totalPages
Properties
cacheExpiresAt
• cacheExpiresAt: number | null
Inherited from BaseMeta.cacheExpiresAt
When does the cache expire?
count
• count: number
How many items are there in the overall result data set.
country
• country: string
The subsets in this data array are organised into collections by station: this is the country the station is part of
dataType
• dataType: "stations" | "onair" | "ondemand" | "schedule" | "recommendations" | "categories"
Inherited from BaseMeta.dataType
Describes the data type returned
firstPage
• firstPage: boolean
Inherited from PaginatedMeta.firstPage
For paginated data - is this the first page of available information?
fromCache
• fromCache: boolean
Inherited from BaseMeta.fromCache
Have cached values been returned?
lastPage
• lastPage: boolean
Inherited from PaginatedMeta.lastPage
For paginated data - is this the last page of available information?
nesting
• nesting: boolean
Inherited from BaseMeta.nesting
Indicates that data is nested into collections of items on a per-station basis
pageNumber
• pageNumber: number
Inherited from PaginatedMeta.pageNumber
For paginated data - the current page of results. Starts at 0
pageSize
• pageSize: number
Inherited from PaginatedMeta.pageSize
For paginated data - how many items will be returned per page of results.
paginated
• paginated: boolean
Inherited from BaseMeta.paginated
Indicates whether the results in the corresponding data field are a paginated subset of all possible results
rpuid
• rpuid: string
The subsets in this data array are organised into collections by station: an rpuid will be included for reference to indicate which station the corresponding data array relates to
totalPages
• totalPages: number
Inherited from PaginatedMeta.totalPages
For paginated data - the total number of available pages of data.