Work with Teams

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

Represents a team.

Team Methods

The following are methods for Team.

getDefaultChannels()

Signature

Return Value

Type: List<String>

getDiscoverable()

Signature

Return Value

Type: String

getDomain()

Signature

Return Value

Type: String

getEmailDomain()

Signature

Return Value

Type: String

getEnterpriseDomain()

Signature

Return Value

Type: String

getEnterpriseId()

Signature

Return Value

Type: String

getEnterpriseName()

Signature

Return Value

Type: String

getIcon()

Signature

Return Value

Type: Slack.TeamIcon

getId()

Signature

Return Value

Type: String

getIsVerified()

Signature

Return Value

Type: Boolean

getName()

Signature

Return Value

Type: String

getUrl()

Signature

Return Value

Type: String

setDefaultChannels(defaultChannels)

Signature

Parameters

defaultChannels

Type: List<String>

Return Value

Type: void

setDiscoverable(discoverable)

Signature

Parameters

discoverable

Type: String

Return Value

Type: void

setDomain(domain)

Signature

Parameters

domain

Type: String

Return Value

Type: void

setEmailDomain(emailDomain)

Signature

Parameters

emailDomain

Type: String

Return Value

Type: void

setEnterpriseId(enterpriseId)

Signature

Parameters

enterpriseId

Type: String

Return Value

Type: void

setEnterpriseDomain(enterpriseDomain)

Signature

Parameters

enterpriseDomain

Type: String

Return Value

Type: void

setEnterpriseName(enterpriseName)

Signature

Parameters

enterpriseName

Type: String

Return Value

Type: void

setIcon(icon)

Signature

Parameters

icon

Type: Slack.TeamIcon

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setIsVerified(isVerified)

Signature

Parameters

isVerified

Type: Boolean

Return Value

Type: void

setName(name)

Signature

Parameters

name

Type: String

Return Value

Type: void

setUrl(url)

Signature

Parameters

url

Type: String

Return Value

Type: void

Team.Profile Methods

The following are methods for Team.Profile.

getFieldName()

Signature

Return Value

Type: String

getHint()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getLabel()

Signature

Return Value

Type: String

getOptions()

Signature

Return Value

Type: Slack.Team.ProfileOptions

getOrdering()

Signature

Return Value

Type: Integer

getPossibleValues()

Signature

Return Value

Type: List<String>

getType()

Signature

Return Value

Type: String

isHidden()

Signature

Return Value

Type: String

setFieldName(fieldName)

Signature

Parameters

fieldName

Type: String

Return Value

Type: void

setHidden(hidden)

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

setHint(hintValue)

Signature

Parameters

hintValue

Type: String

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setLabel(label)

Signature

Parameters

label

Type: String

Return Value

Type: void

setOptions(options)

Signature

Parameters

options

Type: Slack.Team.ProfileOptions

Return Value

Type: void

setOrdering(ordering)

Signature

Parameters

ordering

Type: Integer

Return Value

Type: void

setPossibleValues(possibleValues)

Signature

Parameters

possibleValues

Type: List<String>

Return Value

Type: void

setType(type)

Signature

Parameters

type

Type: String

Return Value

Type: void

Team.ProfileOptioms Methods

The following are methods for Team.ProfileOptions.

isprotected()

Signature

Return Value

Type: Boolean

setprotected(_protected)

Signature

Parameters

_protected

Type: Boolean

Return Value

Type: void

Represents the team's icon.

TeamIcon Methods

The following are methods for TeamIcon.

getImage34()

Signature

Return Value

Type: String

getImage44()

Signature

Return Value

Type: String

getImage68()

Signature

Return Value

Type: String

getImage88()

Signature

Return Value

Type: String

getImage102()

Signature

Return Value

Type: String

getImage132()

Signature

Return Value

Type: String

getImage230()

Signature

Return Value

Type: String

getImageOriginal()

Signature

Return Value

Type: String

isImageDefault()

Returns true if a team has not yet set a custom icon.

Signature

Return Value

Type: Boolean

setImage34(image34)

Signature

Parameters

image34

Type: String

Return Value

Type: void

setImage44(image44)

Signature

Parameters

image44

Type: String

Return Value

Type: void

setImage68(image68)

Signature

Parameters

image68

Type: String

Return Value

Type: void

setImage88(image88)

Signature

Parameters

image88

Type: String

Return Value

Type: void

setImage102(image102)

Signature

Parameters

image102

Type: String

Return Value

Type: void

setImage132(image132)

Signature

Parameters

image132

Type: String

Return Value

Type: void

setImage230(image230)

Signature

Parameters

image230

Type: String

Return Value

Type: void

setImageDefault(imageDefault)

Signature

Parameters

imageDefault

Type: Boolean

Return Value

Type: void

setImageOriginal(imageOriginal)

Signature

Parameters

imageOriginal

Type: String

Return Value

Type: void

Represents billable users information.

BillableInfo Methods

The following are methods for BillableInfo.

isBillingActive()

Signature

Return Value

Type: Boolean

setBillingActive(billingActive)

Signature

Parameters

billingActive

Type: Boolean

Represents the integration activity logs for a team.

Usage

See Slack's team.integrationLogs method.

IntegrationLogs Methods

The following are methods for IntegrationLogs.

getAppId()

Signature

Return Value

Type: String

getAppType()

Signature

Return Value

Type: String

getChangeType()

Signature

Return Value

Type: String

getChannel()

Signature

Return Value

Type: String

getDate()

Signature

Return Value

Type: Integer

getReason()

Signature

Return Value

Type: String

getResolution()

Signature

Return Value

Type: String

getRssFeedChangeType()

Signature

Return Value

Type: String

getRssFeedTitle()

Signature

Return Value

Type: String

getRssFeedUrl()

Signature

Return Value

Type: String

getScope()

Signature

Return Value

Type: String

getServiceId()

Signature

Return Value

Type: String

getServiceType()

Signature

Return Value

Type: String

getUserId()

Signature

Return Value

Type: String

getUserName()

Signature

Return Value

Type: String

isRssFeed()

Signature

Return Value

Type: Boolean

setAppId(appId)

Signature

Parameters

appId

Type: String

Return Value

Type: void

setAppType(appType)

Signature

Parameters

appType

Type: String

Return Value

Type: void

setChangeType(changeType)

Signature

Parameters

changeType

Type: String

Return Value

Type: void

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setDate(dateValue)

Signature

Parameters

dateValue

Type: Integer

Return Value

Type: void

setReason(reason)

Signature

Parameters

reason

Type: String

Return Value

Type: void

setResolution(resolution)

Signature

Parameters

resolution

Type: String

Return Value

Type: void

setRssFeed(rssFeed)

Signature

Parameters

rssFeed

Type: Boolean

Return Value

Type: void

setRssFeedChangeType(rssFeedChangeType)

Signature

Parameters

rssFeedChangeType

Type: String

Return Value

Type: void

setRssFeedTitle(rssFeedTitle)

Signature

Parameters

rssFeedTitle

Type: String

Return Value

Type: void

setRssFeedUrl(rssFeedUrl)

Signature

Parameters

rssFeedUrl

Type: String

Return Value

Type: void

setScope(scope)

Signature

Parameters

scope

Type: String

Return Value

Type: void

setServiceId(serviceId)

Signature

Parameters

serviceId

Type: String

Return Value

Type: void

setServiceType(serviceType)

Signature

Parameters

serviceType

Type: String

Return Value

Type: void

setUserId(userId)

Signature

Parameters

userId

Type: String

Return Value

Type: void

setUserName(userName)

Signature

Parameters

userName

Type: String

Return Value

Type: void

Represents an access log entry that contains information about a user accessing Slack, IP address, and user agent combination.

Usage

See Slack's team.accessLogs method.

Login Methods

The following are methods for Login.

getCount()

Signature

Return Value

Type: Integer

getCountry()

Gets the best guess on the country where the access originated, based on the IP address.

Signature

Return Value

Type: String

getDateFirst()

Gets the unix timestamp of the first access log entry for the user, IP address, and user agent combination.

Signature

Return Value

Type: Integer

getDateLast()

Get the most recent unix timestamp for the access log entry.

Signature

Return Value

Type: Integer

getIp()

Gets the IP address of the device that's used for the user access.

Signature

Return Value

Type: String

getIsp()

Gets Slack's best guess at the internet service provider owning the IP address.

Signature

Return Value

Type: String

getRegion()

Gets the best guess on the region where the access originated, based on the IP address.

Signature

Return Value

Type: String

getUserAgent()

Signature

Return Value

Type: String

getUserId()

Signature

Return Value

Type: String

getUsername()

Signature

Return Value

Type: String

setCount(count)

Signature

Parameters

count

Type: Integer

Return Value

Type: void

setCountry(country)

Signature

Parameters

country

Type: String

Return Value

Type: void

setDateFirst(dateFirst)

Signature

Parameters

dateFirst

Type: Integer

Return Value

Type: void

setDateLast(dateLast)

Signature

Parameters

dateLast

Type: Integer

Return Value

Type: void

setIp(ip)

Signature

Parameters

ip

Type: String

Return Value

Type: void

setIsp(isp)

Signature

Parameters

isp

Type: String

Return Value

Type: void

setRegion(region)

Signature

Parameters

region

Type: String

Return Value

Type: void

setUserAgent(userAgent)

Signature

Parameters

userAgent

Type: String

Return Value

Type: void

setUserId(userId)

Signature

Parameters

userId

Type: String

Return Value

Type: void

setUsername(username)

Signature

Parameters

username

Type: String

Return Value

Type: void

Sends a request to get the access logs for the current team.

Usage

See Slack’s team.accessLogs method.

TeamAccessLogsRequest Methods

The following are methods for TeamAccessLogsRequest.

builder()

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

Signature

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

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

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

TeamAccessLogsRequest.Builder Methods

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

before(before)

End of time range of logs to include in results (inclusive). The default is now.

Signature

Parameters

before

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

build()

Required. Returns an instance of Slack.TeamAccessLogsRequest.

Signature

Return Value

Type: Slack.TeamAccessLogsRequest

count(count)

Number of items to return per page. The default is 100.

Signature

Parameters

count

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

page(page)

Page number of results to return. The default is 1.

Signature

Parameters

page

Type: Integer

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

teamId(teamId)

The encoded team ID to get logs from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamAccessLogsRequest.Builder

Gets the access logs for the current team.

Usage

See Slack’s team.accessLogs method.

TeamAccessLogsResponse Methods

This class contains standard response methods.

The following are methods for TeamAccessLogsResponse.

getLogins()

Signature

Return Value

Type: List<Slack.Login>

getPaging()

Signature

Return Value

Type: Slack.Paging

setLogins(logins)

Signature

Parameters

logins

Type: List<Slack.Login>

Return Value

Type: void

setPaging(paging)

Signature

Parameters

paging

Type: Slack.Paging

Return Value

Type: void

Sends a request to get billable users information for the current team.

Usage

See Slack's team.billableInfo method.

TeamBillableInfoRequest Methods

The following are methods for TeamBillableInfoRequest.

builder()

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

Signature

Return Value

Type: Slack.TeamBillableInfoRequest.Builder

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

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

TeamBillableInfoRequestBuilder Methods

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

build()

Required. Returns an instance of Slack.TeamBillableInfoRequest.

Signature

Return Value

Type: Slack.TeamBillableInfoRequest

teamId(teamId)

The encoded team ID to get billable information from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

user(user)

A user to retrieve the billable information for. The default is to return all users.

Signature

Parameters

user

Type: String

Return Value

Type: Slack.TeamBillableInfoRequest.Builder

Gets billable users information for the current team.

Usage

See Slack's team.billableInfo method.

TeamBillableInfoResponse Methods

This class contains standard response methods.

The following are methods for TeamBillableInfoResponse.

getBillableInfo()

Signature

Return Value

Type: Map<String,Slack.BillableInfo>

setBillableInfo(billableInfo)

Signature

Parameters

billableInfo

Type: Map<String,Slack.BillableInfo>

Return Value

Type: void

Sends a request to get information about the current team.

Usage

See Slack’s team.info method.

TeamInfoRequest Methods

The following are methods for TeamInfoRequest.

builder()

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

Signature

Return Value

Type: Slack.TeamInfoRequest.Builder

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

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

TeamInfoRequest.Builder Methods

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

build()

Required. Returns an instance of the Slack.TeamInfoRequest object.

Signature

Return Value

Type: Slack.TeamInfoRequest

team(team)

Signature

Parameters team

Type: String

Return Value

Type: Slack.TeamInfoRequest.Builder

Gets information about the current team.

Usage

See Slack’s team.info method.

TeamInfoResponse Methods

This class contains standard response methods.

The following are methods for TeamInfoResponse.

getTeam()

Signature

Return Value

Type: Slack.Team

setTeam(team)

Signature

Parameters

team

Type: Slack.Team

Return Value

Type: void

Sends a request to get the integration logs for the current team.

Usage

See Slack’s team.integrationLogs method.

TeamIntegrationLogsRequest Methods

The following are methods for TeamIntegrationLogsRequest.

builder()

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

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

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

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

TeamIntegrationLogsRequest.Builder Methods

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

appId(appId)

Filters logs using the ID of this Slack app. The default is to return all logs.

Signature

Parameters

appId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

build()

Required. Returns an instance of the Slack.TeamIntegrationLogsRequest object.

Signature

Return Value

Type: Slack.TeamIntegrationLogsRequest

changeType(changeType)

Filters logs using this change type. Valid values are added, removed, enabled, disabled, and updated. The default is to return all logs.

Signature

Parameters

changeType

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

count(count)

The number of items to return per page. The default is 100.

Signature

Parameters

count

Type: Integer

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

page(page)

The page number of results to return. The default is 1.

Signature

Parameters

page

Type: Integer

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

serviceId(serviceId)

Filters logs using this service. The default is to return all logs.

Signature

Parameters

serviceId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

teamId(teamId)

The encoded team ID to get logs from, which is required if an org token is used.

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

user(user)

Filters logs generated by this user’s actions. The default is to return all logs.

Signature

Parameters

user

Type: String

Return Value

Type: Slack.TeamIntegrationLogsRequest.Builder

Gets the integration logs for the current team.

Usage

See Slack’s team.integrationLogs method.

TeamIntegrationLogsResponse Methods

This class contains standard response methods.

The following are methods for TeamIntegrationLogsResponse.

getLogs()

Signature

Return Value

Type: List<Slack.IntegrationLog>

getPaging()

Signature

Return Value

Type: Slack.Paging

setLogs(logs)

Signature

Parameters

logs

Type: List<Slack.IntegrationLog>

Return Value

Type: void

setPaging(paging)

Signature

Parameters

paging

Type: Slack.Paging

Return Value

Type: void

Sends a request to retrieve a team's profile.

Usage

See Slack’s team.profile.get method.

TeamProfileGetRequest Methods

The following are methods for TeamProfileGetRequest.

builder()

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

Signature

Return Value

Type: Slack.TeamProfileGetRequest.Builder

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

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

TeamProfileGetRequest.Builder Methods

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

build()

Required. Returns an instance of Slack.TeamProfileGetRequest.

Signature

Return Value

Type: Slack.TeamProfileGetRequest

teamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.TeamProfileGetRequest.Builder

visibility(visibility)

Filters by visibility. Valid values are all, visible, or hidden. The default is all.

Signature

Parameters

visibility

Type: String

Return Value

Type: Slack.TeamProfileGetRequest.Builder

Retrieve a team's profile.

Usage

See Slack’s team.profile.get method.

TeamProfileGetResponse Methods

This class contains standard response methods.

The following are methods for TeamProfileGetResponse.

getProfile()

Gets the team’s profile.

Signature

Return Value

Type: Slack.TeamProfileGetResponse.Profiles

setProfile(profile)

Signature

Parameters

profile

Type: Slack.TeamProfileGetResponse.Profiles

Return Value

Type: void