ChannelTrait.ChannelPagingStruct

class ChannelTrait.ChannelPagingStruct : ClusterStruct


The paging structure that includes the previous and next pagination tokens.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

Creates the ChannelPagingStruct 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<ChannelTrait.PageTokenStruct?>

The token to retrieve the next page.

OptionalValue<ChannelTrait.PageTokenStruct?>

The token to retrieve the preceding page.

Public constructors

ChannelPagingStruct

ChannelPagingStruct(
    previousToken: OptionalValue<ChannelTrait.PageTokenStruct?> = OptionalValue.absent(),
    nextToken: OptionalValue<ChannelTrait.PageTokenStruct?> = OptionalValue.absent()
)

Creates the ChannelPagingStruct 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

nextToken

val nextTokenOptionalValue<ChannelTrait.PageTokenStruct?>

The token to retrieve the next page.

previousToken

val previousTokenOptionalValue<ChannelTrait.PageTokenStruct?>

The token to retrieve the preceding page.