ChannelTrait.PageTokenStruct
class ChannelTrait.PageTokenStruct : ClusterStruct
The pagination structure.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
PageTokenStruct(Creates the PageTokenStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OptionalValue<String> |
The cursor that pinpoints the start of the upcoming data page. |
OptionalValue<String> |
The cursor that pinpoints the end of the upcoming data page. |
OptionalValue<UShort> |
The maximum number of entries that should be retrieved from the program guide in a single response. |
Public constructors
PageTokenStruct
PageTokenStruct(
limit: OptionalValue<UShort> = OptionalValue.absent(),
after: OptionalValue<String> = OptionalValue.absent(),
before: OptionalValue<String> = OptionalValue.absent()
)
Creates the PageTokenStruct class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
after
val after: OptionalValue<String>
The cursor that pinpoints the start of the upcoming data page.
before
val before: OptionalValue<String>
The cursor that pinpoints the end of the upcoming data page.
limit
val limit: OptionalValue<UShort>
The maximum number of entries that should be retrieved from the program guide in a single response.