docs/dev.inmo.tgbotapi.types.rich/RichBlockAudio

RichBlockAudio

@Serializable

data class RichBlockAudio(val audio: AudioFile, val caption: RichBlockCaption? = null) : RichBlockMedia(source)

A block with a music file.

See also

Constructors

constructor(audio: AudioFile, caption: RichBlockCaption? = null)

Types

object Companion

Properties

@SerialName(value = "audio")

val audio: AudioFile

@SerialName(value = "caption")

open override val caption: RichBlockCaption?

open override val html: String

Rich HTML style source of this single RichBlock.

open override val markdown: String

Rich Markdown style source of this single RichBlock.

open override val media: TelegramMediaFile

val RichBlock.subBlocks: List<RichBlock>

The nested RichBlocks directly contained by this block, or an empty list for leaf blocks. Container blocks (RichBlockList via its RichBlockListItem.blocks, RichBlockBlockQuotation, RichBlockCollage, RichBlockSlideshow and RichBlockDetails) expose their children here.

@EncodeDefault

@SerialName(value = "type")

open override val type: String

Functions

ifRichBlockAnchor

inline fun <T> RichBlock.ifRichBlockAnchor(block: (RichBlockAnchor) -> T): T?

ifRichBlockAnimation

inline fun <T> RichBlock.ifRichBlockAnimation(block: (RichBlockAnimation) -> T): T?

ifRichBlockAudio

inline fun <T> RichBlock.ifRichBlockAudio(block: (RichBlockAudio) -> T): T?

ifRichBlockBlockQuotation

inline fun <T> RichBlock.ifRichBlockBlockQuotation(block: (RichBlockBlockQuotation) -> T): T?

ifRichBlockCollage

inline fun <T> RichBlock.ifRichBlockCollage(block: (RichBlockCollage) -> T): T?

ifRichBlockDetails

inline fun <T> RichBlock.ifRichBlockDetails(block: (RichBlockDetails) -> T): T?

ifRichBlockDivider

inline fun <T> RichBlock.ifRichBlockDivider(block: (RichBlockDivider) -> T): T?

ifRichBlockFooter

inline fun <T> RichBlock.ifRichBlockFooter(block: (RichBlockFooter) -> T): T?

ifRichBlockList

inline fun <T> RichBlock.ifRichBlockList(block: (RichBlockList) -> T): T?

inline fun <T> RichBlock.ifRichBlockMap(block: (RichBlockMap) -> T): T?

ifRichBlockMathematicalExpression

inline fun <T> RichBlock.ifRichBlockMathematicalExpression(block: (RichBlockMathematicalExpression) -> T): T?

ifRichBlockMedia

inline fun <T> RichBlock.ifRichBlockMedia(block: (RichBlockMedia) -> T): T?

ifRichBlockParagraph

inline fun <T> RichBlock.ifRichBlockParagraph(block: (RichBlockParagraph) -> T): T?

ifRichBlockPhoto

inline fun <T> RichBlock.ifRichBlockPhoto(block: (RichBlockPhoto) -> T): T?

ifRichBlockPreformatted

inline fun <T> RichBlock.ifRichBlockPreformatted(block: (RichBlockPreformatted) -> T): T?

ifRichBlockPullQuotation

inline fun <T> RichBlock.ifRichBlockPullQuotation(block: (RichBlockPullQuotation) -> T): T?

ifRichBlockSectionHeading

inline fun <T> RichBlock.ifRichBlockSectionHeading(block: (RichBlockSectionHeading) -> T): T?

ifRichBlockSlideshow

inline fun <T> RichBlock.ifRichBlockSlideshow(block: (RichBlockSlideshow) -> T): T?

ifRichBlockTable

inline fun <T> RichBlock.ifRichBlockTable(block: (RichBlockTable) -> T): T?

ifRichBlockThinking

inline fun <T> RichBlock.ifRichBlockThinking(block: (RichBlockThinking) -> T): T?

ifRichBlockVideo

inline fun <T> RichBlock.ifRichBlockVideo(block: (RichBlockVideo) -> T): T?

ifRichBlockVoiceNote

inline fun <T> RichBlock.ifRichBlockVoiceNote(block: (RichBlockVoiceNote) -> T): T?

richBlockAnchorOrNull

inline fun RichBlock.richBlockAnchorOrNull(): RichBlockAnchor?

richBlockAnchorOrThrow

inline fun RichBlock.richBlockAnchorOrThrow(): RichBlockAnchor

richBlockAnimationOrNull

inline fun RichBlock.richBlockAnimationOrNull(): RichBlockAnimation?

richBlockAnimationOrThrow

inline fun RichBlock.richBlockAnimationOrThrow(): RichBlockAnimation

richBlockAudioOrNull

inline fun RichBlock.richBlockAudioOrNull(): RichBlockAudio?

richBlockAudioOrThrow

inline fun RichBlock.richBlockAudioOrThrow(): RichBlockAudio

richBlockBlockQuotationOrNull

inline fun RichBlock.richBlockBlockQuotationOrNull(): RichBlockBlockQuotation?

richBlockBlockQuotationOrThrow

inline fun RichBlock.richBlockBlockQuotationOrThrow(): RichBlockBlockQuotation

richBlockCollageOrNull

inline fun RichBlock.richBlockCollageOrNull(): RichBlockCollage?

richBlockCollageOrThrow

inline fun RichBlock.richBlockCollageOrThrow(): RichBlockCollage

richBlockDetailsOrNull

inline fun RichBlock.richBlockDetailsOrNull(): RichBlockDetails?

richBlockDetailsOrThrow

inline fun RichBlock.richBlockDetailsOrThrow(): RichBlockDetails

richBlockDividerOrNull

inline fun RichBlock.richBlockDividerOrNull(): RichBlockDivider?

richBlockDividerOrThrow

inline fun RichBlock.richBlockDividerOrThrow(): RichBlockDivider

richBlockFooterOrNull

inline fun RichBlock.richBlockFooterOrNull(): RichBlockFooter?

richBlockFooterOrThrow

inline fun RichBlock.richBlockFooterOrThrow(): RichBlockFooter

richBlockListOrNull

inline fun RichBlock.richBlockListOrNull(): RichBlockList?

richBlockListOrThrow

inline fun RichBlock.richBlockListOrThrow(): RichBlockList

richBlockMapOrNull

inline fun RichBlock.richBlockMapOrNull(): RichBlockMap?

richBlockMapOrThrow

inline fun RichBlock.richBlockMapOrThrow(): RichBlockMap

richBlockMathematicalExpressionOrNull

inline fun RichBlock.richBlockMathematicalExpressionOrNull(): RichBlockMathematicalExpression?

richBlockMathematicalExpressionOrThrow

inline fun RichBlock.richBlockMathematicalExpressionOrThrow(): RichBlockMathematicalExpression

richBlockMediaOrNull

inline fun RichBlock.richBlockMediaOrNull(): RichBlockMedia?

richBlockMediaOrThrow

inline fun RichBlock.richBlockMediaOrThrow(): RichBlockMedia

richBlockParagraphOrNull

inline fun RichBlock.richBlockParagraphOrNull(): RichBlockParagraph?

richBlockParagraphOrThrow

inline fun RichBlock.richBlockParagraphOrThrow(): RichBlockParagraph

richBlockPhotoOrNull

inline fun RichBlock.richBlockPhotoOrNull(): RichBlockPhoto?

richBlockPhotoOrThrow

inline fun RichBlock.richBlockPhotoOrThrow(): RichBlockPhoto

richBlockPreformattedOrNull

inline fun RichBlock.richBlockPreformattedOrNull(): RichBlockPreformatted?

richBlockPreformattedOrThrow

inline fun RichBlock.richBlockPreformattedOrThrow(): RichBlockPreformatted

richBlockPullQuotationOrNull

inline fun RichBlock.richBlockPullQuotationOrNull(): RichBlockPullQuotation?

richBlockPullQuotationOrThrow

inline fun RichBlock.richBlockPullQuotationOrThrow(): RichBlockPullQuotation

richBlockSectionHeadingOrNull

inline fun RichBlock.richBlockSectionHeadingOrNull(): RichBlockSectionHeading?

richBlockSectionHeadingOrThrow

inline fun RichBlock.richBlockSectionHeadingOrThrow(): RichBlockSectionHeading

richBlockSlideshowOrNull

inline fun RichBlock.richBlockSlideshowOrNull(): RichBlockSlideshow?

richBlockSlideshowOrThrow

inline fun RichBlock.richBlockSlideshowOrThrow(): RichBlockSlideshow

richBlockTableOrNull

inline fun RichBlock.richBlockTableOrNull(): RichBlockTable?

richBlockTableOrThrow

inline fun RichBlock.richBlockTableOrThrow(): RichBlockTable

richBlockThinkingOrNull

inline fun RichBlock.richBlockThinkingOrNull(): RichBlockThinking?

richBlockThinkingOrThrow

inline fun RichBlock.richBlockThinkingOrThrow(): RichBlockThinking

richBlockVideoOrNull

inline fun RichBlock.richBlockVideoOrNull(): RichBlockVideo?

richBlockVideoOrThrow

inline fun RichBlock.richBlockVideoOrThrow(): RichBlockVideo

richBlockVoiceNoteOrNull

inline fun RichBlock.richBlockVoiceNoteOrNull(): RichBlockVoiceNote?

richBlockVoiceNoteOrThrow

inline fun RichBlock.richBlockVoiceNoteOrThrow(): RichBlockVoiceNote

fun RichBlock.search(block: RichBlock.() -> Boolean): RichBlock?

Walks this RichBlock and all of its subBlocks recursively (depth-first, this block first) and returns the first block for which block returns true, or null if none matches.