Work with Bot Users

The following are Apex classes for the Slack bots API methods.

Represents icons for a bot user.

BotIcons Methods

The following are methods for BotIcons.

getImage36()

Signature

Return Value

Type: String

getImage48()

Signature

Return Value

Type: String

getImage72()

Signature

Return Value

Type: String

setImage36(image36)

Signature

Parameters

image36

Type: String

Return Value

Type: void

setImage48(image48)

Signature

Parameters

image48

Type: String

Return Value

Type: void

setImage72(image72)

Signature

Parameters

image72

Type: String

Return Value

Type: void


Represents the profile information for a bot.

BotProfile Methods

The following are methods for BotProfile.

getAppId()

Signature

Return Value

Type: String

getIcons()

Signature

Return Value

Type: Slack.BotProfile.Icons

getId()

Signature

Return Value

Type: String

getName()

Signature

Return Value

Type: String

getTeamId()

Signature

Return Value

Type: String

getUpdated()

Signature

Return Value

Type: Integer

isDeleted()

Signature

Return Value

Type: Boolean

setAppId(appId)

Signature

Parameters

appId

Type: String

Return Value

Type: void

setDeleted(deleted)

Signature

Parameters

deleted

Type: Boolean

Return Value

Type: void

setIcons(icons)

Signature

Parameters

icons

Type: Slack.BotProfile.Icons

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setTeamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: void

setUpdated(updated)

Signature

Parameters

updated

Type: Integer

Return Value

Type: void


Represents icons on a bot's profile information.

BotProfile.Icons Methods

The following are methods for BotProfile.Icons.

getImage36()

Signature

Return Value

Type: String

getImage48()

Signature

Return Value

Type: String

getImage72()

Signature

Return Value

Type: String

setImage36(image36)

Signature

Parameters

image36

Type: String

Return Value

Type: void

setImage48(image48)

Signature

Parameters

image48

Type: String

Return Value

Type: void

setImage72(image72)

Signature

Parameters

image72

Type: String

Return Value

Type: void


Sends a request to get information about a bot user.

BotsInfoRequest Methods

The following are methods for BotsInfoRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

Return Value

Type: Slack.BotsInfoRequest.Builder


Contains methods to build an instance of the Slack.BotsInfoRequest class.

A Builder object is obtained by invoking one of the BotsInfoRequest.Builder methods defined by the BotsInfoRequest class.

BotsInfoRequest.Builder Methods

The following are methods for BotsInfoRequest.Builder. These methods are optional unless specified otherwise.

bot(bot)

The bot user to get information on.

Signature

Parameters

bot

Type: String

Return Value

Type: Slack.BotsInfoRequest.Builder

build()

Required. Builds an instance of the Slack.BotsInfoRequest class.

Signature

Return Value

Type: Slack.BotsInfoRequest

teamId(teamId)

Encoded team ID or enterprise ID where the bot exists, required if org token is used.

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.BotsInfoRequest.Builder


Gets information about a bot user.

BotsInfoResponse Methods

This class contains standard response methods.

The following are methods for BotsInfoResponse.

getBot()

Signature

Return Value

Type: Slack.BotsInfoResponse.Bot

setBot(bot)

Signature

Parameters

bot

Type: Slack.BotsInfoResponse.Bot

Return Value

Type: void


BotsInfoResponse.Bot Methods

The following are methods for BotsInfoResponse.Bot.

getAppId()

Returns the app ID, for example, A161CLERW.

Signature

Return Value

Type: String

getIcons()

Gets the icons for a bot user.

Signature

Return Value

Type: Slack.BotIcons

getId()

Returns the bot ID, for example, B061F7JD2.

Signature

Return Value

Type: String

getName()

Returns the name of the bot.

Signature

Return Value

Type: String

getUpdated()

Signature

Return Value

Type: Integer

getUserId()

Returns the user ID, for example, U012ABCDEF.

Signature

public String getUserId()

Return Value

Type: String

isDeleted()

Returns true if a bot user is deleted or false if the bot user is still active.

Signature

public Boolean isDeleted()

Return Value

Type: Boolean

setAppId(appId)

Specifies the app ID for the bot.

Signature

Parameters

appId

Type: String

Return Value

Type: void

setIcons(icons)

Sets the icon on a bot user.

Signature

Parameters

icons

Type: Slack.BotIcons

Return Value

Type: void

setDeleted(deleted)

Specifies whether the bot user is deleted.

Signature

Parameters

deleted

Type: Boolean

Return Value

Type: void

setId(id)

Specifies the bot ID.

Signature

Parameters

id

Type: String

Return Value

Type: void

setName(name)

Specifies the bot name.

Signature

Parameters

name

Type: String

Return Value

Type: void

setUpdated(updated)

Signature

Parameters

updated

Type: Integer

Return Value

Type: void

setUserId(userId)

Signature

Parameters

userId

Type: String

Return Value

Type: void