common

1.0

common/dev.brahmkshatriya.echo.common/LyricsExtension

LyricsExtension

data class LyricsExtension(val metadata: Metadata, val instance: Injectable<LyricsClient>) : Extension<LyricsClient>

A data class representing a Lyrics Extension. Lyrics Extension supports the following types of clients:

LyricsClient - Mandatory, For lyrics support
LyricsSearchClient - For searching lyrics using user query
LoginClient - For login support

The extension can also implement the following providers:

MetadataProvider - To get metadata of the extension
MessageFlowProvider - To send messages in the app
MusicExtensionsProvider - To get installed music extensions
LyricsExtensionsProvider - To get installed lyrics extensions
TrackerExtensionsProvider - To get installed tracker extensions
MiscExtensionsProvider - To get installed misc extensions
GlobalSettingsProvider - To get global settings of the app
NetworkConnectionProvider - To get network connection status

Parameters

metadata

The metadata of the extension

instance

An injectable instance of the LyricsClient client

Constructors

LyricsExtension

constructor(metadata: Metadata, instance: Injectable<LyricsClient>)

Properties

The id of the extension

open override val instance: Injectable<LyricsClient>

val isEnabled: Boolean

Whether the extension is enabled

open override val metadata: Metadata

val name: String

The name of the extension

val type: ExtensionType

The type of the extension

val version: String

The version of the extension