discord4j.core.object.trait

Interface Invitable

All Known Subinterfaces:

GuildMessageChannel

All Known Implementing Classes:

NewsChannel, TextChannel, VoiceChannel

public interface Invitable

A trait for objects that can handle invites.

Method Summary

Modifier and Type	Method and Description
Mono<ExtendedInvite>	createInvite(Consumer<? super InviteCreateSpec> spec) Requests to create an invite.
Flux<ExtendedInvite>	getInvites() Requests to retrieve this channel's invites.

Method Detail

createInvite

Mono<ExtendedInvite> createInvite(Consumer<? super InviteCreateSpec> spec)

Requests to create an invite.

Parameters:

spec - A Consumer that provides a "blank" InviteCreateSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits the created ExtendedInvite. If an error is received, it is emitted through the Mono.

getInvites

Flux<ExtendedInvite> getInvites()

Requests to retrieve this channel's invites.

Returns:

A Flux that continually emits this channel's invites. If an error is received, it is emitted through the Flux.