Class: Slacks::Channel

Inherits:
Object
  • Object
show all
Defined in:
lib/slacks/channel.rb

Direct Known Subclasses

GuestChannel

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(slack, attributes = {}) ⇒ Channel

Returns a new instance of Channel.



5
6
7
8
9
10
11
12
 
# File 'lib/slacks/channel.rb', line 5

def initialize(slack, attributes={})
  @slack = slack
  @id = attributes["id"]
  @name = attributes["name"]
  @type = :channel
  @type = :group if attributes["is_group"]
  @type = :direct_message if attributes["is_im"]
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



3
4
5
 
# File 'lib/slacks/channel.rb', line 3

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



3
4
5
 
# File 'lib/slacks/channel.rb', line 3

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



3
4
5
 
# File 'lib/slacks/channel.rb', line 3

def type
  @type
end

Instance Method Details

#==(other) ⇒ Object 



54
55
56
 
# File 'lib/slacks/channel.rb', line 54

def ==(other)
  self.class == other.class && self.id == other.id
end

#direct_message? ⇒ Boolean Also known as: dm?, im?

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/slacks/channel.rb', line 34

def direct_message?
  type == :direct_message
end

#guest? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/slacks/channel.rb', line 46

def guest?
  false
end

#inspect ⇒ Object 



50
51
52
 
# File 'lib/slacks/channel.rb', line 50

def inspect
  "<Slacks::Channel id=\"#{id}\" name=\"#{name}\">"
end

#private_group? ⇒ Boolean Also known as: group?, private?

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/slacks/channel.rb', line 40

def private_group?
  type == :group
end

#reply(*messages) ⇒ Object Also known as: say 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/slacks/channel.rb', line 14

def reply(*messages)
  messages.flatten!
  return unless messages.any?

  first_message = messages.shift
  message_options = {}
  message_options = messages.shift if messages.length == 1 && messages[0].is_a?(Hash)
  slack.send_message(first_message, message_options.merge(channel: id))

  messages.each do |message|
    sleep message.length / slack.typing_speed
    slack.send_message(message, channel: id)
  end
end

#to_s ⇒ Object 



58
59
60
61
62
 
# File 'lib/slacks/channel.rb', line 58

def to_s
  return name if private?
  return "@#{name}" if direct_message?
  "##{name}"
end

#typing ⇒ Object 



30
31
32
 
# File 'lib/slacks/channel.rb', line 30

def typing
  slack.typing_on(self)
end