api / org.gradle.api.plugins.announce / AnnouncePluginExtension

AnnouncePluginExtension

open class AnnouncePluginExtension

The extension used by the AnnouncePlugin.

Constructors

<init>

AnnouncePluginExtension(project: ProjectInternal)

Functions

announce

open fun announce(msg: String, type: String): Unit

Sends an announcement of the given type.

getAnnouncerFactory

open fun getAnnouncerFactory(): AnnouncerFactory

getLocal

open fun getLocal(): Announcer

Returns an Announcer that sends announcements to the local desktop, if a notification mechanism is available.

getPassword

open fun getPassword(): String

The password to use for announcements.

getUsername

open fun getUsername(): String

The username to use for announcements.

setAnnouncerFactory

open fun setAnnouncerFactory(announcerFactory: AnnouncerFactory): Unit

setLocal

open fun setLocal(localAnnouncer: Announcer): Unit

Sets the Announcer that should be used to send announcements to the local desktop.

setPassword

open fun setPassword(password: String): Unit

setUsername

open fun setUsername(username: String): Unit

Extension Properties

ext

val AnnouncePluginExtension.ext: ExtraPropertiesExtension

Retrieves the ext extension.

Extension Functions

ext

fun AnnouncePluginExtension.ext(configure: ExtraPropertiesExtension.() -> Unit): Unit

Configures the ext extension.