slack_web_api v1.2.1 SlackWebAPI.Api.Apps
API calls for all endpoints tagged Apps
.
Link to this section Summary
Functions
Returns list of permissions this app has on a team.
Allows an app to request additional scopes
Returns list of resource grants this app has on a team.
Returns list of scopes this app has on a team.
Returns list of user grants and corresponding scopes this app has on a team.
Enables an app to trigger a permissions modal to grant an app access to a user access scope.
Uninstalls your app from a workspace.
Link to this section Functions
apps_permissions_info(connection, opts \\ [])
apps_permissions_info(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Returns list of permissions this app has on a team.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
none
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
apps_permissions_request(connection, opts \\ [])
apps_permissions_request(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Allows an app to request additional scopes
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :scopes (String.t): A comma separated list of scopes to request for
- :token (String.t): Authentication token. Requires scope:
none
- :trigger_id (String.t): Token used to trigger the permissions API
Returns
{:ok, %{}} on success {:error, info} on failure
apps_permissions_resources_list(connection, opts \\ [])
apps_permissions_resources_list(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Returns list of resource grants this app has on a team.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :cursor (String.t): Paginate through collections of data by setting the
cursor
parameter to anext_cursor
attribute returned by a previous request'sresponse_metadata
. Default value fetches the first "page" of the collection. See pagination for more detail. - :token (String.t): Authentication token. Requires scope:
none
- :limit (integer()): The maximum number of items to return.
- :cursor (String.t): Paginate through collections of data by setting the
Returns
{:ok, %{}} on success {:error, info} on failure
apps_permissions_scopes_list(connection, opts \\ [])
apps_permissions_scopes_list(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Returns list of scopes this app has on a team.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
none
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
apps_permissions_users_list(connection, opts \\ [])
apps_permissions_users_list(Tesla.Env.client(), keyword()) :: {:ok, SlackWebAPI.Model.DefaultSuccessTemplate.t()} | {:error, Tesla.Env.t()}
Returns list of user grants and corresponding scopes this app has on a team.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :cursor (String.t): Paginate through collections of data by setting the
cursor
parameter to anext_cursor
attribute returned by a previous request'sresponse_metadata
. Default value fetches the first "page" of the collection. See pagination for more detail. - :token (String.t): Authentication token. Requires scope:
none
- :limit (integer()): The maximum number of items to return.
- :cursor (String.t): Paginate through collections of data by setting the
Returns
{:ok, %SlackWebAPI.Model.DefaultSuccessTemplate{}} on success {:error, info} on failure
apps_permissions_users_request(connection, opts \\ [])
apps_permissions_users_request(Tesla.Env.client(), keyword()) :: {:ok, SlackWebAPI.Model.DefaultSuccessTemplate.t()} | {:error, Tesla.Env.t()}
Enables an app to trigger a permissions modal to grant an app access to a user access scope.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :scopes (String.t): A comma separated list of user scopes to request for
- :token (String.t): Authentication token. Requires scope:
none
- :user (String.t): The user this scope is being requested for
- :trigger_id (String.t): Token used to trigger the request
Returns
{:ok, %SlackWebAPI.Model.DefaultSuccessTemplate{}} on success {:error, info} on failure
apps_uninstall(connection, opts \\ [])
apps_uninstall(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Uninstalls your app from a workspace.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :client_secret (String.t): Issued when you created your application.
- :token (String.t): Authentication token. Requires scope:
none
- :client_id (String.t): Issued when you created your application.
Returns
{:ok, %{}} on success {:error, info} on failure