Search
Preparing search index...
The search index is not available
cath
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
cath
GiveawaysClient
Class GiveawaysClient
Hierarchy
GiveawaysClient
Index
Constructors
constructor
Properties
Giveaway
Messages
Mongoose
ConnectionURI
client
inviteschema
schema
Methods
check
Roles
choose
create
edit
Buttons
end
end
By
Button
get
Buttons
get
By
Message
giveaway
Embed
goto
Giveaway
replace
Placeholders
reroll
start
start
Timer
Constructors
constructor
new
Giveaways
Client
(
options
:
GiveawaysClientOptions
)
:
GiveawaysClient
name
GiveawaysClient
kind
constructor
Parameters
options:
GiveawaysClientOptions
Returns
GiveawaysClient
Properties
Giveaway
Messages
Giveaway
Messages
:
DefaultGiveawayMessages
Mongoose
ConnectionURI
Mongoose
ConnectionURI
:
string
client
client
:
Client
<
boolean
>
inviteschema
inviteschema
:
Model
<
InviteSchema
,
{}
,
{}
>
= ...
schema
schema
:
Model
<
GiveawaySchema
,
{}
,
{}
>
= ...
Methods
Private
check
Roles
check
Roles
(
userID
:
string
, roleIDs
:
string
[]
, message
:
Message
<
boolean
>
)
:
Boolean
Parameters
userID:
string
roleIDs:
string
[]
message:
Message
<
boolean
>
Returns
Boolean
Private
choose
choose
(
winners
:
number
, msgid
:
string
, message
:
Message
<
boolean
>
)
:
Promise
<
any
[]
>
Parameters
winners:
number
msgid:
string
message:
Message
<
boolean
>
Returns
Promise
<
any
[]
>
create
create
(
client
:
Client
<
boolean
>
, __namedParameters
:
Object
)
:
Promise
<
void
>
Parameters
client:
Client
<
boolean
>
__namedParameters:
Object
Returns
Promise
<
void
>
Private
edit
Buttons
edit
Buttons
(
client
:
Client
<
boolean
>
, data
:
GiveawaySchema
)
:
Promise
<
void
>
Parameters
client:
Client
<
boolean
>
data:
GiveawaySchema
Returns
Promise
<
void
>
end
end
(
message
:
Message
<
boolean
>
, data
:
any
, giveawaymsg
:
Message
<
boolean
>
)
:
Promise
<
"NO_WINNERS"
|
"ENDED"
>
Parameters
message:
Message
<
boolean
>
data:
any
giveawaymsg:
Message
<
boolean
>
Returns
Promise
<
"NO_WINNERS"
|
"ENDED"
>
Private
end
By
Button
end
By
Button
(
client
:
Client
<
boolean
>
, Message
:
string
, button
:
ButtonInteraction
<
CacheType
>
)
:
Promise
<
void
>
Parameters
client:
Client
<
boolean
>
Message:
string
button:
ButtonInteraction
<
CacheType
>
Returns
Promise
<
void
>
Private
get
Buttons
get
Buttons
(
host
:
string
)
:
MessageButton
[]
Parameters
host:
string
Returns
MessageButton
[]
get
By
Message
get
By
Message
(
Message
:
string
)
:
Promise
<
GiveawaySchema
&
Document
<
any
,
any
,
GiveawaySchema
>
>
Parameters
Message:
string
Returns
Promise
<
GiveawaySchema
&
Document
<
any
,
any
,
GiveawaySchema
>
>
Private
giveaway
Embed
giveaway
Embed
(
client
:
Client
<
boolean
>
, status
:
string
, __namedParameters
:
Object
)
:
Promise
<
MessageEmbed
>
Parameters
client:
Client
<
boolean
>
status:
string
__namedParameters:
Object
Returns
Promise
<
MessageEmbed
>
Private
goto
Giveaway
goto
Giveaway
(
data
:
any
)
:
MessageButton
Parameters
data:
any
Returns
MessageButton
Private
replace
Placeholders
replace
Placeholders
(
string
:
string
, data
:
GiveawaySchema
, msg
:
Message
<
boolean
>
, winners
?:
any
[]
)
:
string
Parameters
string:
string
data:
GiveawaySchema
msg:
Message
<
boolean
>
winners:
any
[]
= []
Returns
string
reroll
reroll
(
client
:
Client
<
boolean
>
, Message
:
string
, message
:
Message
<
boolean
>
)
:
Promise
<
any
[]
>
Parameters
client:
Client
<
boolean
>
Message:
string
message:
Message
<
boolean
>
Returns
Promise
<
any
[]
>
start
start
(
client
:
Client
<
boolean
>
)
:
Promise
<
void
>
Parameters
client:
Client
<
boolean
>
Returns
Promise
<
void
>
Private
start
Timer
start
Timer
(
message
:
Message
<
boolean
>
, data
:
any
, instant
?:
boolean
)
:
Promise
<
void
>
Parameters
message:
Message
<
boolean
>
data:
any
instant:
boolean
= false
Returns
Promise
<
void
>
Exports
Giveaways
Client
constructor
Giveaway
Messages
Mongoose
ConnectionURI
client
inviteschema
schema
check
Roles
choose
create
edit
Buttons
end
end
By
Button
get
Buttons
get
By
Message
giveaway
Embed
goto
Giveaway
replace
Placeholders
reroll
start
start
Timer
Generated using
TypeDoc
GiveawaysClient
constructor