Class: OnyxCord::Events::InviteCreateEvent

Inherits:

Event

• Object
• Event
• OnyxCord::Events::InviteCreateEvent

Defined in:

lib/onyxcord/events/invite/create.rb

Overview

Raised when an invite is created.

Instance Attribute Summary

• #channel ⇒ Channel readonly

  The channel the invite was created for.

• #code ⇒ String readonly

  The code for the created invite.

• #created_at ⇒ Time readonly

  The time the invite was created at.

• #invite ⇒ Invite readonly

  The invite that was created.

• #inviter ⇒ User readonly

  The user that created the invite.

• #max_age ⇒ Integer readonly

  The maximum age of the created invite.

• #max_uses ⇒ Integer readonly

  The maximum number of uses before the invite expires.

• #server ⇒ Server^? readonly

  The server the invite was created for.

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

  Whether or not this invite grants temporary membership.

Attributes inherited from Event

#bot

Instance Attribute Details

#channel ⇒ Channel (readonly)

Returns The channel the invite was created for.

Returns:

• (Channel) —

  The channel the invite was created for.

# File 'lib/onyxcord/events/invite/create.rb', line 15

def channel
  @channel
end

#code ⇒ String (readonly)

Returns The code for the created invite.

Returns:

• (String) —

  The code for the created invite.

See Also:

• Invite#code

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite

#created_at ⇒ Time (readonly)

Returns The time the invite was created at.

Returns:

• (Time) —

  The time the invite was created at.

See Also:

• Invite#created_at

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite

#invite ⇒ Invite (readonly)

Returns The invite that was created.

Returns:

• (Invite) —

  The invite that was created.

# File 'lib/onyxcord/events/invite/create.rb', line 9

def invite
  @invite
end

#inviter ⇒ User (readonly)

Returns The user that created the invite.

Returns:

• (User) —

  The user that created the invite.

See Also:

• Invite#inviter

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite

#max_age ⇒ Integer (readonly)

Returns The maximum age of the created invite.

Returns:

• (Integer) —

  The maximum age of the created invite.

See Also:

• Invite#max_age

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite

#max_uses ⇒ Integer (readonly)

Returns The maximum number of uses before the invite expires.

Returns:

• (Integer) —

  The maximum number of uses before the invite expires.

See Also:

• Invite#max_uses

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite

#server ⇒ Server^? (readonly)

Returns The server the invite was created for.

Returns:

• (Server, nil) —

  The server the invite was created for.

# File 'lib/onyxcord/events/invite/create.rb', line 12

def server
  @server
end

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

Returns Whether or not this invite grants temporary membership.

Returns:

• (true, false) —

  Whether or not this invite grants temporary membership.

See Also:

• Invite#temporary

# File 'lib/onyxcord/events/invite/create.rb', line 35

delegate :code, :created_at, :max_age, :max_uses, :temporary, :inviter, to: :invite