Class: RubyCord::Guild::Invite
- Inherits:
-
DiscordModel
- Object
- DiscordModel
- RubyCord::Guild::Invite
- Defined in:
- lib/rubycord/guild/invite.rb
Instance Attribute Summary collapse
-
#approximate_member_count ⇒ Integer
readonly
The approximate number of members of invite.
-
#approximate_presence_count ⇒ Integer
readonly
The approximate number of online users of invite.
-
#channel ⇒ RubyCord::Channel?
readonly
Channel of the invite.
-
#code ⇒ String
readonly
The code of invite.
- #created_at ⇒ Time? readonly
- #expires_at ⇒ Time? readonly
-
#guild ⇒ RubyCord::Guild?
readonly
Guild of the invite.
- #max_age ⇒ Integer? readonly
- #max_uses ⇒ Integer? readonly
-
#remain_uses ⇒ Integer
readonly
Number of remaining uses of invite.
-
#target_type ⇒ :voice, ...
readonly
The type of invite.
-
#target_user ⇒ User
readonly
The user of invite.
-
#temporary? ⇒ Boolean
readonly
Whether the invite is temporary.
-
#url ⇒ String
readonly
Full url of invite.
- #uses ⇒ Integer? readonly
Instance Method Summary collapse
-
#delete(reason: nil) ⇒ Async::Task<void>
Delete the invite.
Methods inherited from DiscordModel
Instance Attribute Details
#approximate_member_count ⇒ Integer (readonly)
Returns The approximate number of members of invite.
23 24 25 |
# File 'lib/rubycord/guild/invite.rb', line 23 def approximate_member_count @approximate_member_count end |
#approximate_presence_count ⇒ Integer (readonly)
Returns The approximate number of online users of invite.
20 21 22 |
# File 'lib/rubycord/guild/invite.rb', line 20 def approximate_presence_count @approximate_presence_count end |
#channel ⇒ RubyCord::Channel? (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
Channel of the invite.
|
# File 'lib/rubycord/guild/invite.rb', line 47
|
#code ⇒ String (readonly)
Returns The code of invite.
11 12 13 |
# File 'lib/rubycord/guild/invite.rb', line 11 def code @code end |
#created_at ⇒ Time? (readonly)
45 46 47 |
# File 'lib/rubycord/guild/invite.rb', line 45 def created_at @created_at end |
#expires_at ⇒ Time? (readonly)
29 30 31 |
# File 'lib/rubycord/guild/invite.rb', line 29 def expires_at @expires_at end |
#guild ⇒ RubyCord::Guild? (readonly)
This method returns an object from client cache. it will return nil
if the object is not in cache.
Guild of the invite.
|
# File 'lib/rubycord/guild/invite.rb', line 47
|
#max_age ⇒ Integer? (readonly)
41 42 43 |
# File 'lib/rubycord/guild/invite.rb', line 41 def max_age @max_age end |
#max_uses ⇒ Integer? (readonly)
37 38 39 |
# File 'lib/rubycord/guild/invite.rb', line 37 def max_uses @max_uses end |
#remain_uses ⇒ Integer (readonly)
Number of remaining uses of invite.
|
# File 'lib/rubycord/guild/invite.rb', line 47
|
#target_type ⇒ :voice, ... (readonly)
Returns The type of invite.
14 15 16 |
# File 'lib/rubycord/guild/invite.rb', line 14 def target_type @target_type end |
#target_user ⇒ User (readonly)
Returns The user of invite.
17 18 19 |
# File 'lib/rubycord/guild/invite.rb', line 17 def target_user @target_user end |
#temporary? ⇒ Boolean (readonly)
Whether the invite is temporary.
|
# File 'lib/rubycord/guild/invite.rb', line 47
|
#url ⇒ String (readonly)
Full url of invite.
|
# File 'lib/rubycord/guild/invite.rb', line 47
|
#uses ⇒ Integer? (readonly)
33 34 35 |
# File 'lib/rubycord/guild/invite.rb', line 33 def uses @uses end |
Instance Method Details
#delete(reason: nil) ⇒ Async::Task<void>
Delete the invite.
113 114 115 116 117 118 119 120 121 |
# File 'lib/rubycord/guild/invite.rb', line 113 def delete(reason: nil) Async do @client.http.request( RubyCord::Internal::Route.new("/invites/#{@code}", "//invites/:code", :delete), {}, audit_log_reason: reason ) end end |