Class: SlackWebApi::AppsEventAuthorizationsController

Inherits:
BaseController
  • Object
show all
Defined in:
lib/slack_web_api/controllers/apps_event_authorizations_controller.rb

Overview

AppsEventAuthorizationsController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SlackWebApi::BaseController

Instance Method Details

#apps_event_authorizations_list(token, event_context, cursor: nil, limit: nil) ⇒ ApiResponse

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. scope: authorizations:read here

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • event_context (String) —

    Required parameter: TODO: type description

  • cursor (String) (defaults to: nil) —

    Optional parameter: TODO: type description here

  • limit (Integer) (defaults to: nil) —

    Optional parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/slack_web_api/controllers/apps_event_authorizations_controller.rb', line 18

def apps_event_authorizations_list(token,
                                   event_context,
                                   cursor: nil,
                                   limit: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/apps.event.authorizations.list',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .query_param(new_parameter(event_context, key: 'event_context')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(cursor, key: 'cursor'))
               .query_param(new_parameter(limit, key: 'limit'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DefaultSuccessTemplate.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             DefaultErrorTemplateException))
    .execute
end