NewsChannel (discord4j-core (3.0.7))

java.lang.Object
- discord4j.core.object.entity.NewsChannel

All Implemented Interfaces:

DiscordObject, Channel, Entity, GuildChannel, GuildMessageChannel, MessageChannel, Categorizable, Invitable
```
public class NewsChannel
extends Object
```
A Discord news channel.

Nested Class Summary
- Nested classes/interfaces inherited from interface discord4j.core.object.entity.Channel
  Channel.Type

Constructor Summary

Constructors
Constructor and Description
`NewsChannel(ServiceMediator serviceMediator, ChannelBean data)` Constructs an `NewsChannel` with an associated ServiceMediator and Discord data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<Void>`	`addMemberOverwrite(Snowflake memberId, PermissionOverwrite overwrite, String reason)` Requests to add a permission overwrite for the given member while optionally specifying a reason.
`Mono<Void>`	`addRoleOverwrite(Snowflake roleId, PermissionOverwrite overwrite, String reason)` Requests to add a permission overwrite for the given role while optionally specifying a reason.
`Flux<Snowflake>`	`bulkDelete(Publisher<Snowflake> messageIds)` Requests to bulk delete the supplied message IDs.
`Mono<ExtendedInvite>`	`createInvite(Consumer<? super InviteCreateSpec> spec)` Requests to create an invite.
`Mono<Message>`	`createMessage(Consumer<? super MessageCreateSpec> spec)` Requests to create a message.
`Mono<Webhook>`	`createWebhook(Consumer<? super WebhookCreateSpec> spec)` Requests to create a webhook.
`Mono<Void>`	`delete(String reason)` Requests to delete this channel while optionally specifying a reason.
`Mono<NewsChannel>`	`edit(Consumer<? super NewsChannelEditSpec> spec)` Requests to edit this news channel.
`boolean`	`equals(Object obj)`
`Mono<Category>`	`getCategory()` Requests to retrieve the category for this channel, if present.
`Optional<Snowflake>`	`getCategoryId()` Gets the ID of the category for this channel, if present.
`DiscordClient`	`getClient()` Gets the DiscordClient associated to this object.
`Mono<PermissionSet>`	`getEffectivePermissions(Snowflake memberId)` Gets the permissions for the given member, taking into account permission overwrites in this channel.
`Mono<Guild>`	`getGuild()` Requests to retrieve the guild this channel is associated to.
`Snowflake`	`getGuildId()` Gets the ID of the guild this channel is associated to.
`Snowflake`	`getId()` Gets the Snowflake that uniquely identifies this entity.
`Flux<ExtendedInvite>`	`getInvites()` Requests to retrieve this channel's invites.
`Mono<Message>`	`getLastMessage()` Requests to retrieve the last message sent in this channel, if present.
`Optional<Snowflake>`	`getLastMessageId()` Gets the ID of the last message sent in this channel, if present.
`Optional<Instant>`	`getLastPinTimestamp()` Gets when the last pinned message was pinned, if present.
`Mono<Message>`	`getMessageById(Snowflake id)` Requests to retrieve the message as represented by the supplied ID.
`Flux<Message>`	`getMessagesAfter(Snowflake messageId)` Requests to retrieve all messages after the specified ID.
`Flux<Message>`	`getMessagesBefore(Snowflake messageId)` Requests to retrieve all messages before the specified ID.
`String`	`getName()` Gets the name of the channel.
`Optional<ExtendedPermissionOverwrite>`	`getOverwriteForMember(Snowflake memberId)` Gets the permission overwrite targeting the given member.
`Optional<ExtendedPermissionOverwrite>`	`getOverwriteForRole(Snowflake roleId)` Gets the permission overwrite targeting the given role.
`Set<ExtendedPermissionOverwrite>`	`getPermissionOverwrites()` Gets the permission overwrites for this channel.
`Flux<Message>`	`getPinnedMessages()` Requests to retrieve all the pinned messages for this channel.
`Mono<Integer>`	`getPosition()` Requests to retrieve the position of the channel relative to other channels in the guild.
`int`	`getRawPosition()` Gets the raw position of the channel as exposed by Discord.
`Optional<String>`	`getTopic()` Gets the channel topic, if present
`Channel.Type`	`getType()` Gets the type of channel.
`Flux<Webhook>`	`getWebhooks()` Requests to retrieve the webhooks of the channel.
`int`	`hashCode()`
`boolean`	`isNsfw()` Gets whether this channel is considered NSFW (Not Safe For Work).
`String`	`toString()`
`Mono<Void>`	`type()` Requests to trigger the typing indicator in this channel.
`Flux<Long>`	`typeUntil(Publisher<?> until)` Requests to trigger the typing indicator in this channel.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface discord4j.core.object.entity.GuildChannel
addMemberOverwrite, addRoleOverwrite

Methods inherited from interface discord4j.core.object.entity.MessageChannel
createEmbed, createMessage

Methods inherited from interface discord4j.core.object.entity.Channel
delete, delete, getMention, getType

Methods inherited from interface discord4j.core.object.entity.Entity
getId

Methods inherited from interface discord4j.core.object.DiscordObject
getClient

- Constructor Detail
  - NewsChannel
```
public NewsChannel(ServiceMediator serviceMediator,
                   ChannelBean data)
```
    Constructs an NewsChannel with an associated ServiceMediator and Discord data.
    
    Parameters:
    
    serviceMediator - The ServiceMediator associated to this object, must be non-null.
    
    data - The raw data as represented by Discord, must be non-null.
- Method Detail
  - edit
```
public Mono<NewsChannel> edit(Consumer<? super NewsChannelEditSpec> spec)
```
    Requests to edit this news channel.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" TextChannelEditSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the edited NewsChannel. If an error is received, it is emitted through the Mono.
  - toString
```
public String toString()
```
  - getGuildId
```
public Snowflake getGuildId()
```
    Description copied from interface: GuildChannel
    
    Gets the ID of the guild this channel is associated to.
    
    Specified by:
    
    getGuildId in interface GuildChannel
    
    Returns:
    
    The ID of the guild this channel is associated to.
  - getGuild
```
public Mono<Guild> getGuild()
```
    Description copied from interface: GuildChannel
    
    Requests to retrieve the guild this channel is associated to.
    
    Specified by:
    
    getGuild in interface GuildChannel
    
    Returns:
    
    A Mono where, upon successful completion, emits the guild this channel is associated to. If an error is received, it is emitted through the Mono.
  - getPermissionOverwrites
```
public Set<ExtendedPermissionOverwrite> getPermissionOverwrites()
```
    Description copied from interface: GuildChannel
    
    Gets the permission overwrites for this channel.
    
    Specified by:
    
    getPermissionOverwrites in interface GuildChannel
    
    Returns:
    
    The permission overwrites for this channel.
  - getOverwriteForMember
```
public Optional<ExtendedPermissionOverwrite> getOverwriteForMember(Snowflake memberId)
```
    Description copied from interface: GuildChannel
    
    Gets the permission overwrite targeting the given member.
    
    Specified by:
    
    getOverwriteForMember in interface GuildChannel
    
    Parameters:
    
    memberId - The ID of the member to get the overwrite for.
    
    Returns:
    
    The permission overwrite targeting the given member.
  - getOverwriteForRole
```
public Optional<ExtendedPermissionOverwrite> getOverwriteForRole(Snowflake roleId)
```
    Description copied from interface: GuildChannel
    
    Gets the permission overwrite targeting the given role.
    
    Specified by:
    
    getOverwriteForRole in interface GuildChannel
    
    Parameters:
    
    roleId - The ID of the role to get the overwrite for.
    
    Returns:
    
    The permission overwrite targeting the given role.
  - getEffectivePermissions
```
public Mono<PermissionSet> getEffectivePermissions(Snowflake memberId)
```
    Description copied from interface: GuildChannel
    
    Gets the permissions for the given member, taking into account permission overwrites in this channel.
    
    Specified by:
    
    getEffectivePermissions in interface GuildChannel
    
    Parameters:
    
    memberId - The ID of the member to get permissions for.
    
    Returns:
    
    The permissions for the given member.
  - getName
```
public String getName()
```
    Description copied from interface: GuildChannel
    
    Gets the name of the channel.
    
    Specified by:
    
    getName in interface GuildChannel
    
    Returns:
    
    The name of the channel.
  - getRawPosition
```
public int getRawPosition()
```
    Description copied from interface: GuildChannel
    
    Gets the raw position of the channel as exposed by Discord. This may or may not be accurate with relativity to other channels in the guild.
    
    Specified by:
    
    getRawPosition in interface GuildChannel
    
    Returns:
    
    The raw position of the channel.
  - getPosition
```
public Mono<Integer> getPosition()
```
    Description copied from interface: GuildChannel
    
    Requests to retrieve the position of the channel relative to other channels in the guild.
    
    Specified by:
    
    getPosition in interface GuildChannel
    
    Returns:
    
    A Mono where, upon successful completion, emits the position of the channel. If an error is received, it is emitted through the Mono.
  - addMemberOverwrite
```
public Mono<Void> addMemberOverwrite(Snowflake memberId,
                                     PermissionOverwrite overwrite,
                                     @Nullable
                                     String reason)
```
    Description copied from interface: GuildChannel
    
    Requests to add a permission overwrite for the given member while optionally specifying a reason.
    
    Specified by:
    
    addMemberOverwrite in interface GuildChannel
    
    Parameters:
    
    memberId - The ID of the member to add the overwrite for.
    
    overwrite - The overwrite to add.
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the guild has been deleted. If an error is received, it is emitted through the Mono.
  - addRoleOverwrite
```
public Mono<Void> addRoleOverwrite(Snowflake roleId,
                                   PermissionOverwrite overwrite,
                                   @Nullable
                                   String reason)
```
    Description copied from interface: GuildChannel
    
    Requests to add a permission overwrite for the given role while optionally specifying a reason.
    
    Specified by:
    
    addRoleOverwrite in interface GuildChannel
    
    Parameters:
    
    roleId - The ID of the role to add the overwrite for.
    
    overwrite - The overwrite to add.
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the guild has been deleted. If an error is received, it is emitted through the Mono.
  - getLastMessageId
```
public Optional<Snowflake> getLastMessageId()
```
    Description copied from interface: MessageChannel
    
    Gets the ID of the last message sent in this channel, if present.
    
    Specified by:
    
    getLastMessageId in interface MessageChannel
    
    Returns:
    
    The ID of the last message sent in this channel, if present.
  - getLastMessage
```
public Mono<Message> getLastMessage()
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve the last message sent in this channel, if present.
    
    Specified by:
    
    getLastMessage in interface MessageChannel
    
    Returns:
    
    A Mono where, upon successful completion, emits the last message sent in this channel, if present. If an error is received, it is emitted through the Mono.
  - getLastPinTimestamp
```
public Optional<Instant> getLastPinTimestamp()
```
    Description copied from interface: MessageChannel
    
    Gets when the last pinned message was pinned, if present.
    
    Specified by:
    
    getLastPinTimestamp in interface MessageChannel
    
    Returns:
    
    When the last pinned message was pinned, if present.
  - createMessage
```
public Mono<Message> createMessage(Consumer<? super MessageCreateSpec> spec)
```
    Description copied from interface: MessageChannel
    
    Requests to create a message.
    
    Specified by:
    
    createMessage in interface MessageChannel
    
    Parameters:
    
    spec - A Consumer that provides a "blank" MessageCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created Message. If an error is received, it is emitted through the Mono.
  - type
```
public Mono<Void> type()
```
    Description copied from interface: MessageChannel
    
    Requests to trigger the typing indicator in this channel. A single invocation of this method will trigger the indicator for 10 seconds or until the bot sends a message in this channel.
    
    Specified by:
    
    type in interface MessageChannel
    
    Returns:
    
    A Mono which completes upon successful triggering of the typing indicator in this channel. If an error is received, it is emitted through the Mono.
  - typeUntil
```
public Flux<Long> typeUntil(Publisher<?> until)
```
    Description copied from interface: MessageChannel
    Requests to trigger the typing indicator in this channel. It will be continuously triggered every 10 seconds until the given publisher emits.
    This method cannot stop the typing indicator during the 10 second duration. It simply checks every 10 seconds whether to trigger the indicator again depending on if the publisher emitted. For example, the following code will show the typing indicator for 10 seconds, not 5:
```
 
 channel.typeUntil(Mono.delay(Duration.ofSeconds(5))
 
 
```
    The only way to stop the typing indicator during the 10 second duration is to send a message in the channel. For example, the following code will show the typing indicator until the message is sent:
```
 
 channel.typeUntil(channel.createMessage("Hello"))
 
 
```
    Specified by:
    
    typeUntil in interface MessageChannel
    
    Parameters:
    
    until - The companion Publisher that signals when to stop triggering the typing indicator.
    
    Returns:
    
    A Flux which continually emits each time the typing indicator is triggered and completes when it will no longer be triggered. If an error is received, it is emitted through the Flux.
  - getMessagesBefore
```
public Flux<Message> getMessagesBefore(Snowflake messageId)
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve all messages before the specified ID.
    The returned Flux will emit items in reverse-chronological order (newest to oldest). It is recommended to limit the emitted items by invoking either Flux.takeWhile(Predicate) (to retrieve IDs within a specified range) or Flux.take(long) (to retrieve a specific amount of IDs).
    The following example will get all messages from messageId to myOtherMessageId: getMessagesBefore(messageId).takeWhile(message -> message.getId().compareTo(myOtherMessageId) >= 0)
    
    Specified by:
    
    getMessagesBefore in interface MessageChannel
    
    Parameters:
    
    messageId - The ID of the newest message to retrieve. Use Snowflake.of(Instant) to retrieve a time-based ID.
    
    Returns:
    
    A Flux that continually emits all messages before the specified ID. If an error is received, it is emitted through the Flux.
  - getMessagesAfter
```
public Flux<Message> getMessagesAfter(Snowflake messageId)
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve all messages after the specified ID.
    The returned Flux will emit items in chronological order (oldest to newest). It is recommended to limit the emitted items by invoking either Flux.takeWhile(Predicate) (to retrieve IDs within a specified range) or Flux.take(long) (to retrieve a specific amount of IDs).
    The following example will get all messages from messageId to myOtherMessageId: getMessagesAfter(messageId).takeWhile(message -> message.getId().compareTo(myOtherMessageId) <= 0)
    
    Specified by:
    
    getMessagesAfter in interface MessageChannel
    
    Parameters:
    
    messageId - The ID of the oldest message to retrieve. Use Snowflake.of(Instant) to retrieve a time-based ID.
    
    Returns:
    
    A Flux that continually emits all messages after the specified ID. If an error is received, it is emitted through the Flux.
  - getMessageById
```
public Mono<Message> getMessageById(Snowflake id)
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve the message as represented by the supplied ID.
    
    Specified by:
    
    getMessageById in interface MessageChannel
    
    Parameters:
    
    id - The ID of the message.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Message as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getPinnedMessages
```
public Flux<Message> getPinnedMessages()
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve all the pinned messages for this channel.
    
    Specified by:
    
    getPinnedMessages in interface MessageChannel
    
    Returns:
    
    A Flux that continually emits all the pinned messages for this channel. If an error is received, it is emitted through the Flux.
  - getCategoryId
```
public Optional<Snowflake> getCategoryId()
```
    Description copied from interface: Categorizable
    
    Gets the ID of the category for this channel, if present.
    
    Specified by:
    
    getCategoryId in interface Categorizable
    
    Returns:
    
    The ID of the category for this channel, if present.
  - getCategory
```
public Mono<Category> getCategory()
```
    Description copied from interface: Categorizable
    
    Requests to retrieve the category for this channel, if present.
    
    Specified by:
    
    getCategory in interface Categorizable
    
    Returns:
    
    A Mono where, upon successful completion, emits the category this channel, if present. If an error is received, it is emitted through the Mono.
  - createInvite
```
public Mono<ExtendedInvite> createInvite(Consumer<? super InviteCreateSpec> spec)
```
    Description copied from interface: Invitable
    
    Requests to create an invite.
    
    Specified by:
    
    createInvite in interface Invitable
    
    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
```
public Flux<ExtendedInvite> getInvites()
```
    Description copied from interface: Invitable
    
    Requests to retrieve this channel's invites.
    
    Specified by:
    
    getInvites in interface Invitable
    
    Returns:
    
    A Flux that continually emits this channel's invites. If an error is received, it is emitted through the Flux.
  - getTopic
```
public Optional<String> getTopic()
```
    Gets the channel topic, if present
    
    Specified by:
    
    getTopic in interface GuildMessageChannel
    
    Returns:
    
    The channel topic, if present.
  - isNsfw
```
public boolean isNsfw()
```
    Gets whether this channel is considered NSFW (Not Safe For Work).
    
    Specified by:
    
    isNsfw in interface GuildMessageChannel
    
    Returns:
    
    true if this channel is considered NSFW (Not Safe For Work), false otherwise.
  - bulkDelete
```
public Flux<Snowflake> bulkDelete(Publisher<Snowflake> messageIds)
```
    Requests to bulk delete the supplied message IDs.
    
    Specified by:
    
    bulkDelete in interface GuildMessageChannel
    
    Parameters:
    
    messageIds - A Publisher to supply the message IDs to bulk delete.
    
    Returns:
    
    A Flux that continually emits message IDs that were not bulk deleted (typically if the ID was older than 2 weeks). If an error is received, it is emitted through the Flux.
  - createWebhook
```
public Mono<Webhook> createWebhook(Consumer<? super WebhookCreateSpec> spec)
```
    Requests to create a webhook.
    
    Specified by:
    
    createWebhook in interface GuildMessageChannel
    
    Parameters:
    
    spec - A Consumer that provides a "blank" WebhookCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created Webhook. If an error is received, it is emitted through the Mono.
  - getWebhooks
```
public Flux<Webhook> getWebhooks()
```
    Requests to retrieve the webhooks of the channel.
    
    Specified by:
    
    getWebhooks in interface GuildMessageChannel
    
    Returns:
    
    A Flux that continually emits the webhooks of the channel. If an error is received, it is emitted through the Flux.
  - getClient
```
public final DiscordClient getClient()
```
    Description copied from interface: DiscordObject
    
    Gets the DiscordClient associated to this object.
    
    Specified by:
    
    getClient in interface DiscordObject
    
    Returns:
    
    The DiscordClient associated to this object.
  - getId
```
public final Snowflake getId()
```
    Description copied from interface: Entity
    
    Gets the Snowflake that uniquely identifies this entity.
    
    Specified by:
    
    getId in interface Entity
    
    Returns:
    
    The Snowflake that uniquely identifies this entity.
  - getType
```
public final Channel.Type getType()
```
    Description copied from interface: Channel
    
    Gets the type of channel.
    
    Specified by:
    
    getType in interface Channel
    
    Returns:
    
    The type of channel.
  - delete
```
public final Mono<Void> delete(@Nullable
                               String reason)
```
    Description copied from interface: Channel
    
    Requests to delete this channel while optionally specifying a reason.
    
    Specified by:
    
    delete in interface Channel
    
    Parameters:
    
    reason - The reason, if present.
    
    Returns:
    
    A Mono where, upon successful completion, emits nothing; indicating the channel has been deleted. If an error is received, it is emitted through the Mono.
  - equals
```
public final boolean equals(@Nullable
                            Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class NewsChannel

Nested Class Summary

Nested classes/interfaces inherited from interface discord4j.core.object.entity.Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface discord4j.core.object.entity.GuildChannel

Methods inherited from interface discord4j.core.object.entity.MessageChannel

Methods inherited from interface discord4j.core.object.entity.Channel

Methods inherited from interface discord4j.core.object.entity.Entity

Methods inherited from interface discord4j.core.object.DiscordObject

Constructor Detail

NewsChannel

Method Detail

edit

toString

getGuildId

getGuild

getPermissionOverwrites

getOverwriteForMember

getOverwriteForRole

getEffectivePermissions

getName

getRawPosition

getPosition

addMemberOverwrite

addRoleOverwrite

getLastMessageId

getLastMessage

getLastPinTimestamp

createMessage

type

typeUntil

getMessagesBefore

getMessagesAfter

getMessageById

getPinnedMessages

getCategoryId

getCategory

createInvite

getInvites

getTopic

isNsfw

bulkDelete

createWebhook

getWebhooks

getClient

getId

getType

delete

equals

hashCode