Module: Slack::Web::Api::Endpoints::SlackLists

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

Instance Method Summary collapse

Instance Method Details

#slackLists_create(options = {}) ⇒ Object

Create a List.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :name (string) —

    Name of the List.

  • :description_blocks (array) —

    A rich text description of the List.

  • :schema (array) —

    Column definition for the List.

  • :copy_from_list_id (string) —

    ID of the List to copy.

  • :include_copied_list_records (boolean) —

    Boolean indicating whether to include records when a List is copied.

  • :todo_mode (boolean) —

    Boolean indicating whether the List should be used to track todo tasks.

Raises:

  • (ArgumentError)

See Also:



26
27
28
29
 
# File 'lib/slack/web/api/endpoints/slackLists.rb', line 26

def slackLists_create(options = {})
  raise ArgumentError, 'Required arguments :name missing' if options[:name].nil?
  post('slackLists.create', options)
end

#slackLists_update(options = {}) ⇒ Object

Update a List.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :id (Object) —

    The ID of the List to update.

  • :name (string) —

    The updated name of the List.

  • :description_blocks (array) —

    A rich text description of the List.

  • :todo_mode (boolean) —

    Boolean indicating whether the List should be in todo mode.

Raises:

  • (ArgumentError)

See Also:



44
45
46
47
 
# File 'lib/slack/web/api/endpoints/slackLists.rb', line 44

def slackLists_update(options = {})
  raise ArgumentError, 'Required arguments :id missing' if options[:id].nil?
  post('slackLists.update', options)
end