Search
Preparing search index...
The search index is not available
yuuko
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
yuuko
Eris
GroupChannel
Class GroupChannel
Hierarchy
PrivateChannel
GroupChannel
Index
Constructors
constructor
Properties
client
created
At
icon
iconURL
id
last
MessageID
mention
messages
name
ownerID
recipient
recipients
type
Methods
add
Message
Reaction
add
Recipient
create
Message
delete
Message
dynamic
IconURL
edit
edit
Message
get
Message
get
Message
Reaction
get
Messages
get
Pins
inspect
leave
pin
Message
remove
Message
Reaction
remove
Recipient
ring
send
Typing
sync
Call
toJSON
to
String
unpin
Message
unsend
Message
from
get
Created
At
Constructors
constructor
new
Group
Channel
(
data
:
BaseData
)
:
GroupChannel
Parameters
data:
BaseData
Returns
GroupChannel
Properties
client
client
:
Client
created
At
created
At
:
number
icon
icon
:
null
|
string
iconURL
iconURL
:
null
|
string
id
id
:
string
last
MessageID
last
MessageID
:
string
mention
mention
:
string
messages
messages
:
Collection
<
Message
<
GroupChannel
>
>
name
name
:
string
ownerID
ownerID
:
string
recipient
recipient
:
User
recipients
recipients
:
Collection
<
User
>
type
type
:
3
Methods
add
Message
Reaction
add
Message
Reaction
(
messageID
:
string
, reaction
:
string
)
:
Promise
<
void
>
add
Message
Reaction
(
messageID
:
string
, reaction
:
string
, userID
:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
reaction:
string
Returns
Promise
<
void
>
deprecated
Parameters
messageID:
string
reaction:
string
userID:
string
Returns
Promise
<
void
>
add
Recipient
add
Recipient
(
userID
:
string
)
:
Promise
<
void
>
Parameters
userID:
string
Returns
Promise
<
void
>
create
Message
create
Message
(
content
:
MessageContent
, file
?:
MessageFile
|
MessageFile
[]
)
:
Promise
<
Message
<
PrivateChannel
>
>
Parameters
content:
MessageContent
Optional
file:
MessageFile
|
MessageFile
[]
Returns
Promise
<
Message
<
PrivateChannel
>
>
delete
Message
delete
Message
(
messageID
:
string
, reason
?:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
Optional
reason:
string
Returns
Promise
<
void
>
dynamic
IconURL
dynamic
IconURL
(
format
?:
ImageFormat
, size
?:
number
)
:
string
Parameters
Optional
format:
ImageFormat
Optional
size:
number
Returns
string
edit
edit
(
options
:
{
icon
?:
string
;
name
?:
string
;
ownerID
?:
string
}
)
:
Promise
<
GroupChannel
>
Parameters
options:
{
icon
?:
string
;
name
?:
string
;
ownerID
?:
string
}
Optional
icon
?:
string
Optional
name
?:
string
Optional
ownerID
?:
string
Returns
Promise
<
GroupChannel
>
edit
Message
edit
Message
(
messageID
:
string
, content
:
MessageContent
)
:
Promise
<
Message
<
PrivateChannel
>
>
Parameters
messageID:
string
content:
MessageContent
Returns
Promise
<
Message
<
PrivateChannel
>
>
get
Message
get
Message
(
messageID
:
string
)
:
Promise
<
Message
<
PrivateChannel
>
>
Parameters
messageID:
string
Returns
Promise
<
Message
<
PrivateChannel
>
>
get
Message
Reaction
get
Message
Reaction
(
messageID
:
string
, reaction
:
string
, options
?:
GetMessageReactionOptions
)
:
Promise
<
User
[]
>
get
Message
Reaction
(
messageID
:
string
, reaction
:
string
, limit
?:
number
, before
?:
string
, after
?:
string
)
:
Promise
<
User
[]
>
Parameters
messageID:
string
reaction:
string
Optional
options:
GetMessageReactionOptions
Returns
Promise
<
User
[]
>
deprecated
Parameters
messageID:
string
reaction:
string
Optional
limit:
number
Optional
before:
string
Optional
after:
string
Returns
Promise
<
User
[]
>
get
Messages
get
Messages
(
options
?:
GetMessagesOptions
)
:
Promise
<
Message
<
PrivateChannel
>
[]
>
get
Messages
(
limit
?:
number
, before
?:
string
, after
?:
string
, around
?:
string
)
:
Promise
<
Message
<
PrivateChannel
>
[]
>
Parameters
Optional
options:
GetMessagesOptions
Returns
Promise
<
Message
<
PrivateChannel
>
[]
>
deprecated
Parameters
Optional
limit:
number
Optional
before:
string
Optional
after:
string
Optional
around:
string
Returns
Promise
<
Message
<
PrivateChannel
>
[]
>
get
Pins
get
Pins
(
)
:
Promise
<
Message
<
PrivateChannel
>
[]
>
Returns
Promise
<
Message
<
PrivateChannel
>
[]
>
inspect
inspect
(
)
:
GroupChannel
Returns
GroupChannel
leave
leave
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
pin
Message
pin
Message
(
messageID
:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
Returns
Promise
<
void
>
remove
Message
Reaction
remove
Message
Reaction
(
messageID
:
string
, reaction
:
string
)
:
Promise
<
void
>
remove
Message
Reaction
(
messageID
:
string
, reaction
:
string
, userID
:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
reaction:
string
Returns
Promise
<
void
>
deprecated
Parameters
messageID:
string
reaction:
string
userID:
string
Returns
Promise
<
void
>
remove
Recipient
remove
Recipient
(
userID
:
string
)
:
Promise
<
void
>
Parameters
userID:
string
Returns
Promise
<
void
>
ring
ring
(
recipient
:
string
[]
)
:
void
Parameters
recipient:
string
[]
Returns
void
send
Typing
send
Typing
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
sync
Call
sync
Call
(
)
:
void
Returns
void
toJSON
toJSON
(
props
?:
string
[]
)
:
JSONCache
Parameters
Optional
props:
string
[]
Returns
JSONCache
to
String
to
String
(
)
:
string
Returns
string
unpin
Message
unpin
Message
(
messageID
:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
Returns
Promise
<
void
>
unsend
Message
unsend
Message
(
messageID
:
string
)
:
Promise
<
void
>
Parameters
messageID:
string
Returns
Promise
<
void
>
Static
from
from
(
data
:
BaseData
, client
:
Client
)
:
AnyChannel
Parameters
data:
BaseData
client:
Client
Returns
AnyChannel
Static
get
Created
At
get
Created
At
(
id
:
string
)
:
number
Parameters
id:
string
Returns
number
Exports
Externals
Eris
Group
Channel
constructor
client
created
At
icon
iconURL
id
last
MessageID
mention
messages
name
ownerID
recipient
recipients
type
add
Message
Reaction
add
Recipient
create
Message
delete
Message
dynamic
IconURL
edit
edit
Message
get
Message
get
Message
Reaction
get
Messages
get
Pins
inspect
leave
pin
Message
remove
Message
Reaction
remove
Recipient
ring
send
Typing
sync
Call
toJSON
to
String
unpin
Message
unsend
Message
from
get
Created
At
Generated using
TypeDoc