PrivateChannel (discord4j-core (3.1.0.RC4))

java.lang.Object
- discord4j.core.object.entity.channel.PrivateChannel

All Implemented Interfaces:

DiscordObject, Channel, MessageChannel, Entity
```
public final class PrivateChannel
extends Object
```
A Discord private channel (also known as a DM channel).

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

Constructor Summary

Constructors
Constructor and Description
`PrivateChannel(GatewayDiscordClient gateway, discord4j.discordjson.json.ChannelData data)` Constructs an `PrivateChannel` with an associated ServiceMediator and Discord data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<Message>`	`createMessage(Consumer<? super MessageCreateSpec> spec)` Requests to create a message.
`Mono<Void>`	`delete(String reason)` Requests to delete this channel while optionally specifying a reason.
`boolean`	`equals(Object obj)`
`GatewayDiscordClient`	`getClient()` Returns the `GatewayDiscordClient` that created this object.
`Snowflake`	`getId()` Gets the Snowflake that uniquely identifies this entity.
`Mono<Message>`	`getLastMessage()` Requests to retrieve the last message sent in this channel, if present.
`Mono<Message>`	`getLastMessage(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the last message sent in this channel, if present, using the given retrieval strategy.
`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.
`Mono<Message>`	`getMessageById(Snowflake id, EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the message as represented by the supplied ID, using the given retrieval strategy.
`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.
`Flux<Message>`	`getPinnedMessages()` Requests to retrieve all the pinned messages for this channel.
`Set<Snowflake>`	`getRecipientIds()` Gets the IDs of the recipients for this private channel.
`Flux<User>`	`getRecipients()` Requests to retrieve the recipients for this private channel.
`Flux<User>`	`getRecipients(EntityRetrievalStrategy retrievalStrategy)` Requests to retrieve the recipients for this private channel, using the given retrieval strategy.
`RestChannel`	`getRestChannel()` Return a `RestChannel` handle to execute REST API operations on this entity.
`Channel.Type`	`getType()` Gets the type of channel.
`int`	`hashCode()`
`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.channel.MessageChannel
createEmbed, createMessage

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

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

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

- Constructor Detail
  - PrivateChannel
```
public PrivateChannel(GatewayDiscordClient gateway,
                      discord4j.discordjson.json.ChannelData data)
```
    Constructs an PrivateChannel with an associated ServiceMediator and Discord data.
    
    Parameters:
    
    gateway - The GatewayDiscordClient associated to this object, must be non-null.
    
    data - The raw data as represented by Discord, must be non-null.
- Method Detail
  - getRecipientIds
```
public Set<Snowflake> getRecipientIds()
```
    Gets the IDs of the recipients for this private channel.
    
    Returns:
    
    The IDs of the recipients for this private channel.
  - getRecipients
```
public Flux<User> getRecipients()
```
    Requests to retrieve the recipients for this private channel.
    
    Returns:
    
    A Flux that continually emits the recipients for this private channel. If an error is received, it is emitted through the Flux.
  - getRecipients
```
public Flux<User> getRecipients(EntityRetrievalStrategy retrievalStrategy)
```
    Requests to retrieve the recipients for this private channel, using the given retrieval strategy.
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the recipients
    
    Returns:
    
    A Flux that continually emits the recipients for this private channel. If an error is received, it is emitted through the Flux.
  - toString
```
public String toString()
```
  - getLastMessageId
```
public final 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 final 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.
  - getLastMessage
```
public Mono<Message> getLastMessage(EntityRetrievalStrategy retrievalStrategy)
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve the last message sent in this channel, if present, using the given retrieval strategy.
    
    Specified by:
    
    getLastMessage in interface MessageChannel
    
    Parameters:
    
    retrievalStrategy - the strategy to use to get the last message
    
    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 final 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 final 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 final 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 final 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 final 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 final 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 final 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.
  - getMessageById
```
public Mono<Message> getMessageById(Snowflake id,
                                    EntityRetrievalStrategy retrievalStrategy)
```
    Description copied from interface: MessageChannel
    
    Requests to retrieve the message as represented by the supplied ID, using the given retrieval strategy.
    
    Specified by:
    
    getMessageById in interface MessageChannel
    
    Parameters:
    
    id - The ID of the message.
    
    retrievalStrategy - the strategy to use to get 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 final 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.
  - getClient
```
public final GatewayDiscordClient getClient()
```
    Description copied from interface: DiscordObject
    
    Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.
    
    Specified by:
    
    getClient in interface DiscordObject
    
    Returns:
    
    The GatewayDiscordClient 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.
  - getRestChannel
```
public RestChannel getRestChannel()
```
    Description copied from interface: Channel
    
    Return a RestChannel handle to execute REST API operations on this entity.
    
    Specified by:
    
    getRestChannel in interface Channel
  - 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 PrivateChannel

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface discord4j.core.object.DiscordObject

Constructor Detail

PrivateChannel

Method Detail

getRecipientIds

getRecipients

getRecipients

toString

getLastMessageId

getLastMessage

getLastMessage

getLastPinTimestamp

createMessage

type

typeUntil

getMessagesBefore

getMessagesAfter

getMessageById

getMessageById

getPinnedMessages

getClient

getId

getRestChannel

getType

delete

equals

hashCode