Class: Discordrb::Invite

Inherits:

Object

• Object
• Discordrb::Invite

Defined in:

lib/discordrb/data.rb

Overview

A Discord invite to a channel

Instance Attribute Summary

• #channel ⇒ InviteChannel readonly

  The channel this invite references.

• #code ⇒ String readonly

  This invite's code.

• #created_at ⇒ Time^? readonly

  When this invite was created, or nil if it's unknown.

• #inviter ⇒ User^? (also: #user) readonly

  The user that made this invite.

• #max_age ⇒ Integer^? readonly

  The invites max age before it expires, or nil if it's unknown.

• #member_count ⇒ Integer^? (also: #user_count) readonly

  The amount of members in the server.

• #online_member_count ⇒ Integer^? (also: #online_user_count) readonly

  The amount of online members in the server.

• #revoked ⇒ true, false (also: #revoked?) readonly

  Whether this invite is still valid.

• #server ⇒ InviteServer readonly

  The server this invite references.

• #temporary ⇒ true, false (also: #temporary?) readonly

  Whether or not this invite grants temporary membership.

• #uses ⇒ Integer (also: #max_uses) readonly

  The amount of uses left on this invite.

Instance Method Summary

• #==(other) ⇒ Object

  Code based comparison.

• #delete(reason = nil) ⇒ Object (also: #revoke)

  Deletes this invite.

• #inspect ⇒ Object

  The inspect method is overwritten to give more useful output.

• #url ⇒ Object

  Creates an invite URL.

Instance Attribute Details

#channel ⇒ InviteChannel (readonly)

Returns the channel this invite references.

Returns:

• (InviteChannel) —

  the channel this invite references.

# File 'lib/discordrb/data.rb', line 1122

def channel
  @channel
end

#code ⇒ String (readonly)

Returns this invite's code.

Returns:

• (String) —

  this invite's code

# File 'lib/discordrb/data.rb', line 1144

def code
  @code
end

#created_at ⇒ Time^? (readonly)

Returns when this invite was created, or nil if it's unknown.

Returns:

• (Time, nil) —

  when this invite was created, or nil if it's unknown

# File 'lib/discordrb/data.rb', line 1158

def created_at
  @created_at
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.

Returns:

• (User, nil) —

  the user that made this invite. May also be nil if the user can't be determined.

# File 'lib/discordrb/data.rb', line 1132

def inviter
  @inviter
end

#max_age ⇒ Integer^? (readonly)

Returns the invites max age before it expires, or nil if it's unknown. If the max age is 0, the invite will never expire unless it's deleted.

Returns:

• (Integer, nil) —

  the invites max age before it expires, or nil if it's unknown. If the max age is 0, the invite will never expire unless it's deleted.

# File 'lib/discordrb/data.rb', line 1155

def max_age
  @max_age
end

#member_count ⇒ Integer^? (readonly) Also known as: user_count

Returns the amount of members in the server. Will be nil if it has not been resolved.

Returns:

• (Integer, nil) —

  the amount of members in the server. Will be nil if it has not been resolved.

# File 'lib/discordrb/data.rb', line 1147

def member_count
  @member_count
end

#online_member_count ⇒ Integer^? (readonly) Also known as: online_user_count

Returns the amount of online members in the server. Will be nil if it has not been resolved.

Returns:

• (Integer, nil) —

  the amount of online members in the server. Will be nil if it has not been resolved.

# File 'lib/discordrb/data.rb', line 1151

def online_member_count
  @online_member_count
end

#revoked ⇒ true, false (readonly) Also known as: revoked?

Returns whether this invite is still valid.

Returns:

• (true, false) —

  whether this invite is still valid.

# File 'lib/discordrb/data.rb', line 1140

def revoked
  @revoked
end

#server ⇒ InviteServer (readonly)

Returns the server this invite references.

Returns:

• (InviteServer) —

  the server this invite references.

# File 'lib/discordrb/data.rb', line 1125

def server
  @server
end

#temporary ⇒ true, false (readonly) Also known as: temporary?

Returns whether or not this invite grants temporary membership. If someone joins a server with this invite, they will be removed from the server when they go offline unless they've received a role.

Returns:

• (true, false) —

  whether or not this invite grants temporary membership. If someone joins a server with this invite, they will be removed from the server when they go offline unless they've received a role.

# File 'lib/discordrb/data.rb', line 1136

def temporary
  @temporary
end

#uses ⇒ Integer (readonly) Also known as: max_uses

Returns the amount of uses left on this invite.

Returns:

• (Integer) —

  the amount of uses left on this invite.

# File 'lib/discordrb/data.rb', line 1128

def uses
  @uses
end

Instance Method Details

#==(other) ⇒ Object

Code based comparison

# File 'lib/discordrb/data.rb', line 1179

def ==(other)
  other.respond_to?(:code) ? (@code == other.code) : (@code == other)
end

#delete(reason = nil) ⇒ Object Also known as: revoke

Deletes this invite

Parameters:

• reason (String) (defaults to: nil) —

  The reason the invite is being deleted.

# File 'lib/discordrb/data.rb', line 1185

def delete(reason = nil)
  API::Invite.delete(@bot.token, @code, reason)
end

#inspect ⇒ Object

The inspect method is overwritten to give more useful output

# File 'lib/discordrb/data.rb', line 1192

def inspect
  "<Invite code=#{@code} channel=#{@channel} uses=#{@uses} temporary=#{@temporary} revoked=#{@revoked} created_at=#{@created_at} max_age=#{@max_age}>"
end

#url ⇒ Object

Creates an invite URL.

# File 'lib/discordrb/data.rb', line 1197

def url
  "https://discord.gg/#{@code}"
end