Module: Slack::Web::Api::Endpoints::FunctionsDistributionsPermissions

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

Instance Method Summary collapse

Instance Method Details

#functions_distributions_permissions_add(options = {}) ⇒ Object

Grant users access to a custom slack function if its permission_type is set to named_entities

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :function_app_id (string) —

    The encoded ID of the app.

  • :function_callback_id (string) —

    The callback ID defined in the function’s definition file.

  • :function_id (string) —

    The encoded ID of the function.

  • :user_ids (array) —

    List of encoded user IDs.

See Also:



22
23
24
 
# File 'lib/slack/web/api/endpoints/functions_distributions_permissions.rb', line 22

def functions_distributions_permissions_add(options = {})
  post('functions.distributions.permissions.add', options)
end

#functions_distributions_permissions_list(options = {}) ⇒ Object

List the access type of a custom slack function and include the users with access if its permission_type is set to named_entities

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :function_app_id (string) —

    The encoded ID of the app.

  • :function_callback_id (string) —

    The callback ID defined in the function’s definition file.

  • :function_id (string) —

    The encoded ID of the function.

See Also:



37
38
39
 
# File 'lib/slack/web/api/endpoints/functions_distributions_permissions.rb', line 37

def functions_distributions_permissions_list(options = {})
  post('functions.distributions.permissions.list', options)
end

#functions_distributions_permissions_remove(options = {}) ⇒ Object

Revoke user access to a custom slack function if permission_type set to named_entities

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :function_app_id (string) —

    The encoded ID of the app.

  • :function_callback_id (string) —

    The callback ID defined in the function’s definition file.

  • :function_id (string) —

    The encoded ID of the function.

  • :user_ids (array) —

    List of encoded user IDs.

See Also:



54
55
56
 
# File 'lib/slack/web/api/endpoints/functions_distributions_permissions.rb', line 54

def functions_distributions_permissions_remove(options = {})
  post('functions.distributions.permissions.remove', options)
end

#functions_distributions_permissions_set(options = {}) ⇒ Object

Set the access type of a custom slack function and define the users to be granted access if permission_type is set to named_entities

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :permission_type (enum) —

    The type of permission that defines how the function can be distributed.

  • :function_app_id (string) —

    The encoded ID of the app.

  • :function_callback_id (string) —

    The callback ID defined in the function’s definition file.

  • :function_id (string) —

    The encoded ID of the function.

  • :user_ids (array) —

    List of encoded user IDs.

See Also:



73
74
75
 
# File 'lib/slack/web/api/endpoints/functions_distributions_permissions.rb', line 73

def functions_distributions_permissions_set(options = {})
  post('functions.distributions.permissions.set', options)
end