Slack v0.23.5 Slack.Web.Views View Source
Link to this section Summary
Functions
Open a view for a user
Publish a static view for a User
Push a view onto the stack of a root view
Update an existing view
Link to this section Functions
Link to this function
open(token, trigger_id, view, optional_params \\ %{}) View Source
Open a view for a user.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
trigger_id
- Exchange a trigger to post to the user. ex:12345.98765.abcd2358fdea
view
- A view payload. This must be a JSON-encoded string. ex:Ar12345
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.duplicate_external_id
- Error returned when the givenexternal_id
has already be used.ekm_access_denied
- Administrators have suspended the ability to post a message.fatal_error
- The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.invalid_arg_name
- The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.invalid_arguments
- The method was called with invalid arguments.invalid_auth
- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.invalid_charset
- The method was called via aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.no_permission
- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.not_authed
- No authentication token provided.org_login_required
- The workspace is undergoing an enterprise migration and will not be available until migration is complete.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.team_added_to_org
- The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.view_too_large
- Error returned if the provided view is greater than 250kb.
Link to this function
publish(token, user_id, view, optional_params \\ %{}) View Source
Publish a static view for a User.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
user_id
-id
of the user you want publish a view to. ex:U0BPQUNTA
view
- A view payload. This must be a JSON-encoded string. ex:Ar12345
Optional Params
hash
- A string that represents view state to protect against possible race conditions. ex:156772938.1827394
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.duplicate_external_id
- Error returned when the givenexternal_id
has already be used.ekm_access_denied
- Administrators have suspended the ability to post a message.fatal_error
- The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.hash_conflict
- Error returned when the providedhash
doesn't match the current stored value.invalid_arg_name
- The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.invalid_arguments
- The method was called with invalid arguments.invalid_auth
- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.invalid_charset
- The method was called via aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.no_permission
- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.not_allowed_token_type
- The type of token your app used when requesting this method is not allowed.not_authed
- No authentication token provided.not_enabled
- Error returned if ahome
view is published but the Home tab isn't enabled for the app.org_login_required
- The workspace is undergoing an enterprise migration and will not be available until migration is complete.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.team_added_to_org
- The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.view_too_large
- Error returned if the provided view is greater than 250kb.
Link to this function
push(token, trigger_id, view, optional_params \\ %{}) View Source
Push a view onto the stack of a root view.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
trigger_id
- Exchange a trigger to post to the user. ex:12345.98765.abcd2358fdea
view
- A view payload. This must be a JSON-encoded string. ex:Ar12345
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.duplicate_external_id
- Error returned when the givenexternal_id
has already be used.ekm_access_denied
- Administrators have suspended the ability to post a message.fatal_error
- The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.invalid_arg_name
- The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.invalid_arguments
- The method was called with invalid arguments.invalid_auth
- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.invalid_charset
- The method was called via aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.no_permission
- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.not_authed
- No authentication token provided.org_login_required
- The workspace is undergoing an enterprise migration and will not be available until migration is complete.push_limit_reached
- Error returned when the max push limit has been reached for views. Currently the limit is 3.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.team_added_to_org
- The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.view_too_large
- Error returned if the provided view is greater than 250kb.
Link to this function
update(token, view, optional_params \\ %{}) View Source
Update an existing view.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
view
- A view payload. This must be a JSON-encoded string. ex:Ar12345
Optional Params
external_id
- A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Eitherview_id
orexternal_id
is required. ex:bmarley_view2
hash
- A string that represents view state to protect against possible race conditions. ex:156772938.1827394
view_id
- A unique identifier of the view to be updated. Eitherview_id
orexternal_id
is required. ex:VMM512F2U
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.duplicate_external_id
- Error returned when the givenexternal_id
has already be used.ekm_access_denied
- Administrators have suspended the ability to post a message.fatal_error
- The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.hash_conflict
- Error returned when the providedhash
doesn't match the current stored value.invalid_arg_name
- The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.invalid_arguments
- The method was called with invalid arguments.invalid_auth
- Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.invalid_charset
- The method was called via aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.no_permission
- The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.not_authed
- No authentication token provided.not_found
- Error returned when the givenview_id
orexternal_id
doesn't exist.org_login_required
- The workspace is undergoing an enterprise migration and will not be available until migration is complete.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.team_added_to_org
- The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.view_too_large
- Error returned if the provided view is greater than 250kb.