/
PrivateChannel.java
48 lines (44 loc) · 1.67 KB
/
PrivateChannel.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities;
import net.dv8tion.jda.api.requests.RestAction;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
/**
* Represents the connection used for direct messaging.
*
* @see User#openPrivateChannel()
*/
public interface PrivateChannel extends MessageChannel, IFakeable
{
/**
* The {@link net.dv8tion.jda.api.entities.User User} that this {@link net.dv8tion.jda.api.entities.PrivateChannel PrivateChannel} communicates with.
*
* @return A non-null {@link net.dv8tion.jda.api.entities.User User}.
*/
@Nonnull
User getUser();
/**
* Closes a PrivateChannel. After being closed successfully the PrivateChannel is removed from the JDA mapping.
* <br>As a note, this does not remove the history of the PrivateChannel. If the channel is reopened the history will
* still be present.
*
* @return {@link net.dv8tion.jda.api.requests.RestAction RestAction} - Type: Void
*/
@Nonnull
@CheckReturnValue
RestAction<Void> close();
}