Class: SlackWebApi::ViewsController

Inherits:
BaseController show all
Defined in:
lib/slack_web_api/controllers/views_controller.rb

Overview

ViewsController

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

#views_open(token, trigger_id, view) ⇒ ApiResponse

Open a view for a user. scope: none to the user. payload](/reference/surfaces/views). This must be a JSON-encoded string.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • trigger_id (String) —

    Required parameter: Exchange a trigger to post

  • view (String) —

    Required parameter: A [view

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



17
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
 
# File 'lib/slack_web_api/controllers/views_controller.rb', line 17

def views_open(token,
               trigger_id,
               view)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/views.open',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .query_param(new_parameter(trigger_id, key: 'trigger_id')
                             .is_required(true))
               .query_param(new_parameter(view, key: 'view')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .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, before getting to any possible'\
                              ' validation errors.',
                             DefaultErrorTemplateException))
    .execute
end

#views_publish(token, user_id, view, hash: nil) ⇒ ApiResponse

Publish a static view for a User. scope: none publish a view to. payload](/reference/surfaces/views). This must be a JSON-encoded string. state to protect against possible race conditions.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • user_id (String) —

    Required parameter: id of the user you want

  • view (String) —

    Required parameter: A [view

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

    Optional parameter: A string that represents view

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/slack_web_api/controllers/views_controller.rb', line 54

def views_publish(token,
                  user_id,
                  view,
                  hash: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/views.publish',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .query_param(new_parameter(user_id, key: 'user_id')
                             .is_required(true))
               .query_param(new_parameter(view, key: 'view')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(hash, key: 'hash'))
               .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, before getting to any possible'\
                              ' validation errors.',
                             DefaultErrorTemplateException))
    .execute
end

#views_push(token, trigger_id, view) ⇒ ApiResponse

Push a view onto the stack of a root view. scope: none to the user. payload](/reference/surfaces/views). This must be a JSON-encoded string.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • trigger_id (String) —

    Required parameter: Exchange a trigger to post

  • view (String) —

    Required parameter: A [view

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/slack_web_api/controllers/views_controller.rb', line 91

def views_push(token,
               trigger_id,
               view)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/views.push',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .query_param(new_parameter(trigger_id, key: 'trigger_id')
                             .is_required(true))
               .query_param(new_parameter(view, key: 'view')
                             .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .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

#views_update(token, view_id: nil, external_id: nil, view: nil, hash: nil) ⇒ ApiResponse

Update an existing view. scope: none view to be updated. Either view_id or external_id is required. 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. object](/reference/surfaces/views). This must be a JSON-encoded string. state to protect against possible race conditions.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

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

    Optional parameter: A unique identifier of the

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

    Optional parameter: A unique identifier of the

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

    Optional parameter: A [view

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

    Optional parameter: A string that represents view

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/slack_web_api/controllers/views_controller.rb', line 130

def views_update(token,
                 view_id: nil,
                 external_id: nil,
                 view: nil,
                 hash: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/views.update',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(view_id, key: 'view_id'))
               .query_param(new_parameter(external_id, key: 'external_id'))
               .query_param(new_parameter(view, key: 'view'))
               .query_param(new_parameter(hash, key: 'hash'))
               .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