Class: Discordrb::AllowedMentions

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/allowed_mentions.rb

Overview

Builder class for allowed_mentions when sending messages.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parse: nil, users: nil, roles: nil, replied_user: nil) ⇒ AllowedMentions

Returns a new instance of AllowedMentions.

Parameters:

  • parse (Array<"users", "roles", "everyone">) (defaults to: nil) —

    Mention types that can be inferred from the message. users and roles allow for all mentions of the respective type to ping. everyone allows usage of @everyone and @here

  • users (Array<User, String, Integer>) (defaults to: nil) —

    Users or user IDs that can be pinged. Cannot be used in conjunction with "users" in parse

  • roles (Array<Role, String, Integer>) (defaults to: nil) —

    Roles or role IDs that can be pinged. Cannot be used in conjunction with "roles" in parse

  • replied_user (true, false, nil) (defaults to: nil) —

    For replies, whether to mention the author of the message being replied to. Defaults to no mention



26
27
28
29
30
31
 
# File 'lib/discordrb/allowed_mentions.rb', line 26

def initialize(parse: nil, users: nil, roles: nil, replied_user: nil)
  @parse = parse
  @users = users
  @roles = roles
  @replied_user = replied_user
end

Instance Attribute Details

#parse ⇒ Array<"users", "roles", "everyone">?

Returns:



9
10
11
 
# File 'lib/discordrb/allowed_mentions.rb', line 9

def parse
  @parse
end

#replied_user ⇒ true, ... Also known as: replied_user?

Returns:

  • (true, false, nil) 


18
19
20
 
# File 'lib/discordrb/allowed_mentions.rb', line 18

def replied_user
  @replied_user
end

#roles ⇒ Array<String, Integer>?

Returns:



15
16
17
 
# File 'lib/discordrb/allowed_mentions.rb', line 15

def roles
  @roles
end

#users ⇒ Array<String, Integer>?

Returns:



12
13
14
 
# File 'lib/discordrb/allowed_mentions.rb', line 12

def users
  @users
end