Module: Slack::Web::Api::Endpoints::WorkflowsFeatured

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

Instance Method Summary collapse

Instance Method Details

Add featured workflows to a channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel_id (string) —

    Channel to add featured workflow in.

  • :trigger_ids (array) —

    Comma-separated array of trigger IDs to add; max 15.

Raises:

  • (ArgumentError)

See Also:



18
19
20
21
22
 
# File 'lib/slack/web/api/endpoints/workflows_featured.rb', line 18

def workflows_featured_add(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
  post('workflows.featured.add', options)
end

#workflows_featured_list(options = {}) ⇒ Object

List the featured workflows for specified channels.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel_ids (array) —

    Comma-separated array of channel IDs to list featured workflows for.

Raises:

  • (ArgumentError)

See Also:



31
32
33
34
 
# File 'lib/slack/web/api/endpoints/workflows_featured.rb', line 31

def workflows_featured_list(options = {})
  raise ArgumentError, 'Required arguments :channel_ids missing' if options[:channel_ids].nil?
  post('workflows.featured.list', options)
end

#workflows_featured_remove(options = {}) ⇒ Object

Remove featured workflows from a channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel_id (string) —

    Channel to remove featured workflow from.

  • :trigger_ids (array) —

    Comma-separated array of trigger IDs to remove; max 15.

Raises:

  • (ArgumentError)

See Also:



45
46
47
48
49
 
# File 'lib/slack/web/api/endpoints/workflows_featured.rb', line 45

def workflows_featured_remove(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
  post('workflows.featured.remove', options)
end

#workflows_featured_set(options = {}) ⇒ Object

Set featured workflows for a channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel_id (string) —

    Channel to set featured workflows in.

  • :trigger_ids (array) —

    Comma-separated array of trigger IDs that will replace any existing featured workflows in the channel; max 15.

Raises:

  • (ArgumentError)

See Also:



60
61
62
63
64
 
# File 'lib/slack/web/api/endpoints/workflows_featured.rb', line 60

def workflows_featured_set(options = {})
  raise ArgumentError, 'Required arguments :channel_id missing' if options[:channel_id].nil?
  raise ArgumentError, 'Required arguments :trigger_ids missing' if options[:trigger_ids].nil?
  post('workflows.featured.set', options)
end