Class: ChatSDK::Adapter::Base

Inherits:
Object
  • Object
show all
Includes:
Capabilities
Defined in:
lib/chat_sdk/adapter/base.rb

Direct Known Subclasses

Testing::FakeAdapter

Constant Summary

Constants included from Capabilities

Capabilities::KNOWN

Instance Method Summary collapse

Methods included from Capabilities

included, #supports?

Instance Method Details

#ack_response(rack_request) ⇒ Object 



21
22
23
 
# File 'lib/chat_sdk/adapter/base.rb', line 21

def ack_response(rack_request)
  nil
end

#add_reaction(channel_id:, message_id:, emoji:) ⇒ Object

Raises:

  • (NotImplementedError) 


54
55
56
57
 
# File 'lib/chat_sdk/adapter/base.rb', line 54

def add_reaction(channel_id:, message_id:, emoji:)
  require_capability!(:reactions)
  raise NotImplementedError
end

#client ⇒ Object

Raises:

  • (NotImplementedError) 


12
13
14
 
# File 'lib/chat_sdk/adapter/base.rb', line 12

def client
  raise NotImplementedError
end

#delete_message(channel_id:, message_id:) ⇒ Object

Raises:

  • (NotImplementedError) 


39
40
41
42
 
# File 'lib/chat_sdk/adapter/base.rb', line 39

def delete_message(channel_id:, message_id:)
  require_capability!(:delete_messages)
  raise NotImplementedError
end

#edit_message(channel_id:, message_id:, message:) ⇒ Object

Raises:

  • (NotImplementedError) 


34
35
36
37
 
# File 'lib/chat_sdk/adapter/base.rb', line 34

def edit_message(channel_id:, message_id:, message:)
  require_capability!(:edit_messages)
  raise NotImplementedError
end

#fetch_messages(channel_id:, thread_id: nil, cursor: nil, limit: 50) ⇒ Object

Raises:

  • (NotImplementedError) 


69
70
71
72
 
# File 'lib/chat_sdk/adapter/base.rb', line 69

def fetch_messages(channel_id:, thread_id: nil, cursor: nil, limit: 50)
  require_capability!(:message_history)
  raise NotImplementedError
end

#mention(user_id) ⇒ Object

Raises:

  • (NotImplementedError) 


84
85
86
 
# File 'lib/chat_sdk/adapter/base.rb', line 84

def mention(user_id)
  raise NotImplementedError
end

#name ⇒ Object

Raises:

  • (NotImplementedError) 


8
9
10
 
# File 'lib/chat_sdk/adapter/base.rb', line 8

def name
  raise NotImplementedError
end

#open_dm(user_id) ⇒ Object

Raises:

  • (NotImplementedError) 


64
65
66
67
 
# File 'lib/chat_sdk/adapter/base.rb', line 64

def open_dm(user_id)
  require_capability!(:direct_messages)
  raise NotImplementedError
end

#open_modal(trigger_id:, modal:) ⇒ Object

Raises:

  • (NotImplementedError) 


74
75
76
77
 
# File 'lib/chat_sdk/adapter/base.rb', line 74

def open_modal(trigger_id:, modal:)
  require_capability!(:modals)
  raise NotImplementedError
end

#parse_events(rack_request) ⇒ Object

Raises:

  • (NotImplementedError) 


25
26
27
 
# File 'lib/chat_sdk/adapter/base.rb', line 25

def parse_events(rack_request)
  raise NotImplementedError
end

#post_ephemeral(channel_id:, user_id:, message:, thread_id: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


44
45
46
47
 
# File 'lib/chat_sdk/adapter/base.rb', line 44

def post_ephemeral(channel_id:, user_id:, message:, thread_id: nil)
  require_capability!(:ephemeral_messages)
  raise NotImplementedError
end

#post_message(channel_id:, message:, thread_id: nil) ⇒ Object

Outbound

Raises:

  • (NotImplementedError) 


30
31
32
 
# File 'lib/chat_sdk/adapter/base.rb', line 30

def post_message(channel_id:, message:, thread_id: nil)
  raise NotImplementedError
end

#remove_reaction(channel_id:, message_id:, emoji:) ⇒ Object

Raises:

  • (NotImplementedError) 


59
60
61
62
 
# File 'lib/chat_sdk/adapter/base.rb', line 59

def remove_reaction(channel_id:, message_id:, emoji:)
  require_capability!(:reactions)
  raise NotImplementedError
end

#render(postable_message) ⇒ Object 



88
89
90
 
# File 'lib/chat_sdk/adapter/base.rb', line 88

def render(postable_message)
  Cards::Renderer.new.render(postable_message.card)
end

#start_typing(channel_id:, thread_id: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


79
80
81
82
 
# File 'lib/chat_sdk/adapter/base.rb', line 79

def start_typing(channel_id:, thread_id: nil)
  require_capability!(:typing_indicator)
  raise NotImplementedError
end

#upload_file(channel_id:, io:, filename:, thread_id: nil, comment: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


49
50
51
52
 
# File 'lib/chat_sdk/adapter/base.rb', line 49

def upload_file(channel_id:, io:, filename:, thread_id: nil, comment: nil)
  require_capability!(:file_uploads)
  raise NotImplementedError
end

#verify_request!(rack_request) ⇒ Object

Inbound

Raises:

  • (NotImplementedError) 


17
18
19
 
# File 'lib/chat_sdk/adapter/base.rb', line 17

def verify_request!(rack_request)
  raise NotImplementedError
end