Module: Slack::Web::Api::Endpoints::Views

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/views.rb

Instance Method Summary collapse

Instance Method Details

#views_open(options = {}) ⇒ Object

Open a view for a user.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :view (view as string) —

    A view payload. This must be a JSON-encoded string.

  • :trigger_id (string) —

    Exchange a trigger to post to the user.

  • :interactivity_pointer (string) —

    Exchange an interactivity pointer to post to the user.

Raises:

  • (ArgumentError)

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/slack/web/api/endpoints/views.rb', line 20

def views_open(options = {})
  raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
  raise ArgumentError, 'One of :trigger_id, :interactivity_pointer is required' unless options[:trigger_id].nil? ^ options[:interactivity_pointer].nil?
  if options.key?(:view)
    view = options[:view]
    view = JSON.dump(view) unless view.is_a?(String)
    options = options.merge(view: view)
  end
  post('views.open', options)
end

#views_publish(options = {}) ⇒ Object

Publish a static view for a User.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :user_id (string) —

    id of the user you want publish a view to.

  • :view (view as string) —

    A view payload. This must be a JSON-encoded string.

  • :hash (string) —

    A string that represents view state to protect against possible race conditions.

Raises:

  • (ArgumentError)

See Also:



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/slack/web/api/endpoints/views.rb', line 42

def views_publish(options = {})
  raise ArgumentError, 'Required arguments :user_id missing' if options[:user_id].nil?
  raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
  if options.key?(:view)
    view = options[:view]
    view = JSON.dump(view) unless view.is_a?(String)
    options = options.merge(view: view)
  end
  post('views.publish', options)
end

#views_push(options = {}) ⇒ Object

Push a view onto the stack of a root view.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :view (view as string) —

    A view payload. This must be a JSON-encoded string.

  • :trigger_id (string) —

    Exchange a trigger to post to the user.

  • :interactivity_pointer (string) —

    Exchange an interactivity pointer to post to the user.

Raises:

  • (ArgumentError)

See Also:



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/slack/web/api/endpoints/views.rb', line 64

def views_push(options = {})
  raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
  raise ArgumentError, 'One of :trigger_id, :interactivity_pointer is required' unless options[:trigger_id].nil? ^ options[:interactivity_pointer].nil?
  if options.key?(:view)
    view = options[:view]
    view = JSON.dump(view) unless view.is_a?(String)
    options = options.merge(view: view)
  end
  post('views.push', options)
end

#views_update(options = {}) ⇒ Object

Update an existing view.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :view (view as string) —

    A view object. This must be a JSON-encoded string.

  • :external_id (string) —

    A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.

  • :view_id (string) —

    A unique identifier of the view to be updated. Either view_id or external_id is required.

  • :hash (string) —

    A string that represents view state to protect against possible race conditions.

Raises:

  • (ArgumentError)

See Also:



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/slack/web/api/endpoints/views.rb', line 88

def views_update(options = {})
  raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
  raise ArgumentError, 'One of :external_id, :view_id is required' unless options[:external_id].nil? ^ options[:view_id].nil?
  if options.key?(:view)
    view = options[:view]
    view = JSON.dump(view) unless view.is_a?(String)
    options = options.merge(view: view)
  end
  post('views.update', options)
end