Package com.slack.api.bolt.service

Interface InstallationService

All Superinterfaces:

Service

All Known Implementing Classes:

AmazonS3InstallationService, FileInstallationService

public interface InstallationService
extends Service

A service that manages Slack app installations.

Method Summary

Modifier and Type	Method	Description
default void	deleteAll(String enterpriseId, String teamId)	Deletes all installation data for given workspace or organization.
void	deleteBot(Bot bot)	Deletes a bot permission data only.
void	deleteInstaller(Installer installer)	Deletes a user permission data only.
Bot	findBot(String enterpriseId, String teamId)	Returns a bot permission data if exists.
Installer	findInstaller(String enterpriseId, String teamId, String userId)	Returns a user permission data if exists.
default List<LayoutBlock>	getInstallationGuideBlocks(String enterpriseId, String teamId, String userId)	Returns a message (Block Kit) to inform unknown users.
default String	getInstallationGuideText(String enterpriseId, String teamId, String userId)	Returns a message text to inform unknown users.
boolean	isHistoricalDataEnabled()	Returns true if the historical data management is enabled.
default void	saveBot(Bot bot)	Saves an bot installation data.
void	saveInstallerAndBot(Installer installer)	Saves an installation.
void	setHistoricalDataEnabled(boolean isHistoricalDataEnabled)	Set true if the historical data management is enabled.

Methods inherited from interface com.slack.api.bolt.service.Service

initializer

Method Details

isHistoricalDataEnabled

boolean isHistoricalDataEnabled()

Returns true if the historical data management is enabled.

setHistoricalDataEnabled

void setHistoricalDataEnabled(boolean isHistoricalDataEnabled)

Set true if the historical data management is enabled.

saveInstallerAndBot

void saveInstallerAndBot(Installer installer)
                  throws Exception

Saves an installation.

Throws:

Exception

saveBot

default void saveBot(Bot bot)
              throws Exception

Saves an bot installation data.

Throws:

Exception

deleteBot

void deleteBot(Bot bot)
        throws Exception

Deletes a bot permission data only.

Throws:

Exception

deleteInstaller

void deleteInstaller(Installer installer)
              throws Exception

Deletes a user permission data only.

Throws:

Exception

findBot

Bot findBot(String enterpriseId,
 String teamId)

Returns a bot permission data if exists.

findInstaller

Installer findInstaller(String enterpriseId,
 String teamId,
 String userId)

Returns a user permission data if exists.

getInstallationGuideText

default String getInstallationGuideText(String enterpriseId,
 String teamId,
 String userId)

Returns a message text to inform unknown users.

getInstallationGuideBlocks

default List<LayoutBlock> getInstallationGuideBlocks(String enterpriseId,
 String teamId,
 String userId)

Returns a message (Block Kit) to inform unknown users.

deleteAll

default void deleteAll(String enterpriseId,
 String teamId)

Deletes all installation data for given workspace or organization.