Class: Discordrb::Invite
- Inherits:
-
Object
- Object
- Discordrb::Invite
- Defined in:
- lib/discordrb/data.rb
Overview
A Discord invite to a channel
Instance Attribute Summary collapse
-
#channel ⇒ Channel
readonly
The channel this invite references.
-
#code ⇒ String
readonly
This invite's code.
-
#inviter ⇒ User?
(also: #user)
readonly
The user that made this invite.
-
#revoked ⇒ true, false
(also: #revoked?)
readonly
Whether this invite is still valid.
-
#server ⇒ Server
readonly
The server this invite references.
-
#temporary ⇒ true, false
(also: #temporary?)
readonly
Whether or not this invite is temporary.
-
#uses ⇒ Integer
(also: #max_uses)
readonly
The amount of uses left on this invite.
-
#xkcd ⇒ true, false
(also: #xkcd?)
readonly
Whether this invite is in xkcd format (i. e. "Human readable" in the invite settings).
Instance Method Summary collapse
-
#==(other) ⇒ Object
Code based comparison.
-
#delete ⇒ Object
(also: #revoke)
Deletes this invite.
Instance Attribute Details
#channel ⇒ Channel (readonly)
Returns the channel this invite references.
410 411 412 |
# File 'lib/discordrb/data.rb', line 410 def channel @channel end |
#code ⇒ String (readonly)
Returns this invite's code.
431 432 433 |
# File 'lib/discordrb/data.rb', line 431 def code @code end |
#inviter ⇒ User? (readonly) Also known as: user
Returns the user that made this invite. May also be nil if the user can't be determined.
419 420 421 |
# File 'lib/discordrb/data.rb', line 419 def inviter @inviter end |
#revoked ⇒ true, false (readonly) Also known as: revoked?
Returns whether this invite is still valid.
425 426 427 |
# File 'lib/discordrb/data.rb', line 425 def revoked @revoked end |
#server ⇒ Server (readonly)
Returns the server this invite references.
413 414 415 |
# File 'lib/discordrb/data.rb', line 413 def server @server end |
#temporary ⇒ true, false (readonly) Also known as: temporary?
Returns whether or not this invite is temporary.
422 423 424 |
# File 'lib/discordrb/data.rb', line 422 def temporary @temporary end |
#uses ⇒ Integer (readonly) Also known as: max_uses
Returns the amount of uses left on this invite.
416 417 418 |
# File 'lib/discordrb/data.rb', line 416 def uses @uses end |
#xkcd ⇒ true, false (readonly) Also known as: xkcd?
Returns whether this invite is in xkcd format (i. e. "Human readable" in the invite settings).
428 429 430 |
# File 'lib/discordrb/data.rb', line 428 def xkcd @xkcd end |
Instance Method Details
#==(other) ⇒ Object
Code based comparison
456 457 458 |
# File 'lib/discordrb/data.rb', line 456 def ==(other) other.respond_to?(:code) ? (@code == other.code) : (@code == other) end |
#delete ⇒ Object Also known as: revoke
Deletes this invite
461 462 463 |
# File 'lib/discordrb/data.rb', line 461 def delete API.delete_invite(@bot.token, @code) end |