Work with Users
The following are Apex classes for the Slack users API methods.
Represents information about a Slack workspace user.
Usage
User Methods
The following are methods for User.
getColor()
Signature
Return Value
Type: String
getEnterpriseUser()
Signature
Return Value
Type: Slack.User.EnterpriseUser
getId()
Signature
Return Value
Type: String
getLocale()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
getPresence()
Signature
Return Value
Type: String
getProfile()
Signature
Return Value
Type: Slack.User.Profile
getRealName()
Signature
Return Value
Type: String
getTeamId()
Signature
Return Value
Type: String
getTwoFactorType()
Signature
Return Value
Type: String
getTz()
Signature
Return Value
Type: String
getTzLabel()
Signature
Return Value
Type: String
getTzOffset()
Signature
Return Value
Type: Integer
getUpdated()
Signature
Return Value
Type: Long
isAdmin()
Signature
Return Value
Type: Boolean
isAppUser()
Signature
Return Value
Type: Boolean
isBot()
Signature
Return Value
Type: Boolean
isDeleted()
Signature
Return Value
Type: Boolean
isEmailConfirmed()
Signature
Return Value
Type: Boolean
isHas2fa()
Signature
Return Value
Type: Boolean
isHasFiles()
Signature
Return Value
Type: Boolean
isInvitedUser()
Signature
Return Value
Type: Boolean
isOwner()
Signature
Return Value
Type: Boolean
isPrimaryOwner()
Signature
Return Value
Type: Boolean
isRestricted()
Signature
Return Value
Type: Boolean
isStranger()
Signature
Return Value
Type: Boolean
isUltraRestricted()
Signature
Return Value
Type: Boolean
isWorkflowBot()
Signature
Return Value
Type: Boolean
isWhoCanShareContactCard()
Signature
Return Value
Type: Boolean
setAdmin(admin)
Signature
Parameters
admin
Type: Boolean
Return Value
Type: void
setAppUser(appUser)
Signature
Parameters
appUser
Type: Boolean
Return Value
Type: void
setBot(bot)
Signature
Parameters
bot
Type: Boolean
Return Value
Type: void
setColor(color)
Signature
Parameters
color
Type: String
Return Value
Type: void
setDeleted(deleted)
Signature
Parameters
deleted
Type: Boolean
Return Value
Type: void
setEmailConfirmed(emailConfirmed)
Signature
Parameters
emailConfirmed
Type: Boolean
Return Value
Type: void
setEnterpriseUser(enterpriseUser)
Signature
Parameters
enterpriseUser
Type: Slack.User.EnterpriseUser
Return Value
Type: void
setHas2fa(has2fa)
Signature
Parameters
has2fa
Type: Boolean
Return Value
Type: void
setHasFiles(hasFiles)
Signature
Parameters
hasFiles
Type: Boolean
Return Value
Type: void
setId(id)
Signature
Parameters
id
Type: String
Return Value
Type: void
setInvitedUser(invitedUser)
Signature
Parameters
invitedUser
Type: Boolean
Return Value
Type: void
setLocale(locale)
Signature
Parameters
locale
Type: String
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
setOwner(owner)
Signature
Parameters
owner
Type:
Return Value
Type: void
setPresence(presence)
Signature
Parameters
presence
Type: String
Return Value
Type: void
setPrimaryOwner(primaryOwner)
Signature
Parameters
primaryOwner
Type: Boolean
Return Value
Type: void
setProfile(profile)
Signature
Parameters
profile
Type: Slack.User.Profile
Return Value
Type: void
setRealName(realName)
Signature
Parameters
realName
Type: String
Return Value
Type: void
setRestricted(restricted)
Signature
Parameters
restricted
Type: Boolean
Return Value
Type: void
setStranger(stranger)
Signature
Parameters
stranger
Type: Boolean
Return Value
Type: void
setTeamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: void
setTwoFactorType(twoFactorType)
Signature
Parameters
twoFactorType
Type: String
Return Value
Type: void
setTz(tz)
Signature
Parameters
tz
Type: String
Return Value
Type: void
setTzLabel(tzLabel)
Signature
Parameters
tzLabel
Type: String
Return Value
Type: void
setTzOffset(tzOffset)
Signature
Parameters
tzOffset
Type: Integer
Return Value
Type: void
setUltraRestricted(ultraRestricted)
Signature
Parameters
ultraRestricted
Type: Boolean
Return Value
Type: void
setUpdated(updated)
Signature
Parameters
updated
Type: Long
Return Value
Type: void
setWhoCanShareContactCard(whoCanShareContactCard)
Signature
Parameters
whoCanShareContactCard
Type: Boolean
Return Value
Type: void
setWorkflowBot(workflowBot)
Signature
Parameters
workflowBot
Type: Boolean
Return Value
Type: void
Represents an enterprise grid user.
Usage
User.EnterpriseUser Methods
The following are methods for User.EnterpriseUser.
getEnterpriseId()
Signature
Return Value
Type: String
getEnterpriseName()
Signature
Return Value
Type: String
getId()
Signature
Return Value
Type: String
getTeams()
Signature
Return Value
Type: List<String>
isAdmin()
Signature
Return Value
Type: Boolean
isOwner()
Signature
Return Value
Type: Boolean
setAdmin(isAdmine)
Signature
Parameters
isAdmin
Type: Boolean
Return Value
Type: void
setEnterpriseId(enterpriseId)
Signature
Parameters
enterpriseId
Type: String
Return Value
Type: void
setEnterpriseName(enterpriseName)
Signature
Parameters
enterpriseName
Type: String
Return Value
Type: void
setId(id)
Signature
Parameters
id
Type: String
Return Value
Type: void
setOwner(isOwner)
Signature
Parameters
isOwner
Type: Boolean
Return Value
Type: void
setTeams(teams)
Signature
Parameters
teams
Type: List<String>
Return Value
Type: void
User.Field Methods
The following are methods for User.Field.
getAlt()
Signature
Return Value
Type: String
getLabel()
Signature
Return Value
Type: String
getValue()
Signature
Return Value
Type: String
setAlt(alt)
Signature
Parameters
alt
Type: String
Return Value
Type: void
setLabel(label)
Signature
Parameters
label
Type: String
Return Value
Type: void
setValue(value)
Signature
Parameters
value
Type: String
Return Value
Type: void
Represents the user's profile, including the user's title, real and display names, email, and avatar images.
Usage
User.Profile Methods
The following are methods for User.Profile.
getApiAppId()
Signature
Return Value
Type: String
getAvatarHash()
Signature
Return Value
Type: String
getBotId()
Signature
Return Value
Type: String
getDisplayName()
Signature
Return Value
Type: String
getDisplayNameNormalized()
Signature
Return Value
Type: String
getEmail()
Signature
Return Value
Type: String
getFields()
Signature
Return Value
Type: Map<String,Slack.User.Field>
getGuestChannels()
Signature
Return Value
Type: String
getGuestExpirationTs()
Signature
Return Value
Type: Long
getGuestInvitedBy()
Signature
Return Value
Type: String
getImage24()
Signature
Return Value
Type: String
getImage32()
Signature
Return Value
Type: String
getImage48()
Signature
Return Value
Type: String
getImage72()
Signature
Return Value
Type: String
getImage192()
Signature
Return Value
Type: String
getImage512()
Signature
Return Value
Type: String
getImage1024()
Signature
Return Value
Type: String
getImageOriginal()
Signature
Return Value
Type: String
getPhone()
Signature
Return Value
Type: String
getPronouns()
Signature
Return Value
Type: String
getRealName()
Signature
Return Value
Type: String
getRealNameNormalized()
Signature
Return Value
Type: String
getSkype()
Signature
Return Value
Type: String
getStatusEmoji()
Signature
Return Value
Type: String
getStatusEmojiDisplayInfo()
Signature
Return Value
Type: String
getStatusEmojiUrl()
Signature
Return Value
Type: String
getStatusExpiration()
Signature
Return Value
Type: Long
getStatusText()
Signature
Return Value
Type: String
getStatusTextCanonical()
Signature
Return Value
Type: String
getTeam()
Signature
Return Value
Type: String
getTitle()
Signature
Return Value
Type: String
isAlwaysActive()
Signature
Return Value
Type: Boolean
isCustomImage()
Signature
Return Value
Type: Boolean
setAlwaysActive(alwaysActive)
Signature
Parameters
alwaysActive
Type: Boolean
Return Value
Type: void
setApiAppId(apiAppId)
Signature
Parameters
apiAppId
Type: String
Return Value
Type: void
setAvatarHash(avatarHash)
Signature
Parameters
avatarHash
Type: String
Return Value
Type: void
setBotId(botId)
Signature
Parameters
botId
Type: String
Return Value
Type: void
setCustomImage(customImage)
Signature
Parameters
customImage
Type: Boolean
Return Value
Type: void
setDisplayName(displayName)
Signature
Parameters
displayName
Type: String
Return Value
Type: void
setDisplayNameNormalized(displayNameNormalized)
Signature
Parameters
displayNameNormalized
Type: String
Return Value
Type: void
setEmail(email)
Signature
Parameters
Type: String
Return Value
Type: void
setFields(fields)
Signature
Parameters
fields
Type: Map<String,Slack.User.Field>
Return Value
Type: void
setGuestChannels(guestChannels)
Signature
Parameters
guestChannels
Type: String
Return Value
Type: void
setGuestExpirationTs(guestExpirationTs)
Signature
Parameters
guestExpirationTs
Type: Long
Return Value
Type: void
setGuestInvitedBy(guestInvitedBy)
Signature
Parameters
guestInvitedBy
Type: String
Return Value
Type: void
setImage24(image24)
Signature
Parameters
image24
Type: String
Return Value
Type: void
setImage32(image32)
Signature
Parameters
image32
Type: String
Return Value
Type: void
setImage48(image48)
Signature
Parameters
image48
Type: String
Return Value
Type: void
setImage72(image72)
Signature
Parameters
image72
Type:
Return Value
Type: void
setImage192(image192)
Signature
Parameters
image192
Type: String
Return Value
Type: void
setImage512(image512)
Signature
Parameters
image512
Type: String
Return Value
Type: void
setImage1024(image1024)
Signature
Parameters
image1024
Type: String
Return Value
Type: void
setImageOriginal(imageOriginal)
Signature
Parameters
imageOriginal
Type: String
Return Value
Type: void
setPhone(phone)
Signature
Parameters
phone
Type: String
Return Value
Type: void
setPronouns(pronouns)
Signature
Parameters
pronouns
Type: String
Return Value
Type: void
setRealName(realName)
Signature
Parameters
realName
Type: String
Return Value
Type: void
setRealNameNormalized(realNameNormalized)
Signature
Parameters
realNameNormalized
Type: String
Return Value
Type: void
setSkype(skype)
Signature
Parameters
skype
Type: String
Return Value
Type: void
setStatusEmoji(statusEmoji)
Signature
Parameters
statusEmoji
Type: String
Return Value
Type: void
setStatusEmojiDisplayInfo(statusEmojiDisplayInfo)
Signature
Parameters
statusEmojiDisplayInfo
Type: List<Slack.User.StatusEmojiDisplayInfo>
Return Value
Type: void
setStatusEmojiUrl(statusEmojiUrl)
Signature
Parameters
statusEmojiUrl
Type: String
Return Value
Type: void
setStatusExpiration(statusExpiration)
Signature
Parameters
statusExpiration
Type: Long
Return Value
Type: void
setStatusText(statusText)
Signature
Parameters
statusText
Type: String
Return Value
Type: void
setStatusTextCanonical(statusTextCanonical)
Signature
Parameters
statusTextCanonical
Type: String
Return Value
Type: void
setTeam(team)
Signature
Parameters
team
Type: String
Return Value
Type: void
setTitle(title)
Signature
Parameters
title
Type: String
Return Value
Type: void
Represents an enterprise grid user.
User.StatusEmojiDisplayInfo Methods
The following are methods for User.StatusEmojiDisplayInfo.
getEmojiName()
Signature
Return Value
Type: String
getDisplayAlias()
Signature
Return Value
Type: String
getDisplayUrl()
Signature
Return Value
Type: String
setEmojiName(emojiName)
Signature
Parameters
emojiName
Type: String
Return Value
Type: void
setDisplayAlias(displayAlias)
Signature
Parameters
displayAlias
Type: String
Return Value
Type: void
setDisplayUrl()
Signature
Parameters
displayUrl
Type: String
Return Value
Type: void
Sends a request to list conversations the calling user may access.
Usage
See Slack's users.conversations method.
UsersConversationsRequest Methods
The following are methods for UsersConversationsRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersConversationsRequest.Builder
Sends a request to list conversations the calling user may access.
UsersConversationsRequest.Builder Methods
The following are methods for UsersConversationsRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.UsersConversationsRequest.
Signature
Return Value
Type: Slack.UsersConversationsRequest
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.UsersConversationsRequest.Builder
excludeArchived(excludeArchived)
Signature
Parameters
excludeArchived
Type: Boolean
Return Value
Type: Slack.UsersConversationsRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.UsersConversationsRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsersConversationsRequest.Builder
types(types)
Signature
Parameters
types
Type: List<Slack.ConversationType>
Return Value
Type: Slack.UsersConversationsRequest.Builder
user(user)
Signature
Parameters
user
Type: String
Return Value
Type: Slack.UsersConversationsRequest.Builder
List conversations the calling user may access.
Usage
See Slack's users.conversations method.
UsersConversationsResponse Methods
This class contains standard response methods.
The following are methods for UsersConversationsResponse.
getChannels()
Signature
Return Value
Type: List<Slack.Conversation>
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setChannels(channels)
Signature
Parameters
channels
Type: List<Slack.Conversation>
Return Value
Type: void
setResponseMetadata(responseMetadata)
Signature
Parameters
responseMetadata
Type: Slack.ResponseMetadata
Return Value
Type: void
Builds a request to delete the user profile photo.
UsersDeletePhotoRequest Methods
The following are methods for UsersDeletePhotoRequest.Builder.
build()
Required. Returns an instance of Slack.UsersDeletePhotoRequest.
Signature
Return Value
Type: Slack.UsersDeletePhotoRequest
Sends a request to delete the user profile photo.
Usage
See Slack's users.deletePhoto.
UsersDeletePhotoRequest Methods
The following are methods for UsersDeletePhotoRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersDeletePhotoRequest.Builder
Delete the user profile photo.
Usage
See Slack's users.deletePhoto.
UsersDeletePhotoResponse Methods
This class contains standard response methods.
Builds a request to get user presence information.
UsersGetPresenceRequest.Builder Methods
The following are methods for UsersGetPresenceRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.UsersGetPresenceRequest.
Signature
Return Value
Type: Slack.UsersGetPresenceRequest
user(user)
Signature
Parameters
user
Type: String
Return Value
Type: Slack.UsersGetPresenceRequest.Builder
Sends a request to get user presence information.
Usage
See Slack's users.getPresence method.
UsersGetPresenceRequest Methods
The following are methods for UsersGetPresenceRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersGetPresenceRequest.Builder
Gets user presence information.
Usage
See Slack's users.getPresence method.
UsersGetPresenceResponse Methods
This class contains standard response methods.
The following are methods for UsersGetPresenceResponse.
getConnectionCount()
Signature
Return Value
Type: Integer
getLastActivity()
Signature
Return Value
Type: Integer
getPresence()
Signature
Return Value
Type: String
isAutoAway()
Signature
Return Value
Type: Boolean
isManualAway()
Signature
Return Value
Type: Boolean
isOnline()
Signature
Return Value
Type: Boolean
setAutoAway(autoAway)
Signature
Parameters
autoAway
Type: Boolean
Return Value
Type: void
setConnectionCount(connectionCount)
Signature
Parameters
connectionCount
Type: Integer
Return Value
Type: void
setLastActivity(lastActivity)
Signature
Parameters
lastActivity
Type: Integer
Return Value
Type: void
setManualAway(manualAway)
Signature
Parameters
manualAway
Type: Boolean
Return Value
Type: void
setOnline(online)
Signature
Parameters
online
Type: Boolean
Return Value
Type: void
setPresence(presence)
Signature
Parameters
presence
Type: String
Return Value
Type: void
Builds a request to get a user's identity.
UsersIdentityRequest.Builder Methods
The following are methods for UsersIdentityRequest.Builder.
build()
Required. Returns an instance of the Slack.UsersIdentityRequest object.
Signature
Return Value
Type: Slack.UsersIdentityRequest
Sends a request to get a user's identity.
Usage
See Slack's users.identity method.
UsersIdentityRequest Methods
The following are methods for UsersIdentityRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersIdentityRequest.Builder
Get a user's identity.
UsersIdentityResponse.Team Methods
The following are methods for UsersIdentityResponse.Team.
getId()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
setId(id)
Signature
Parameters
id
Type: String
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
Get a user's identity.
UsersIdentityResponse.User Methods
The following are methods for UsersIdentityResponse.User.
getEmail()
Signature
Return Value
Type: String
getId()
Signature
Return Value
Type: String
getImage24()
Signature
Return Value
Type: String
getImage32()
Signature
Return Value
Type: String
getImage48()
Signature
Return Value
Type: String
getImage72()
Signature
Return Value
Type: String
getImage192()
Signature
Return Value
Type: String
getImage512()
Signature
Return Value
Type: String
getName()
Signature
Return Value
Type: String
setEmail()
Signature
Parameters
Type: String
Return Value
Type: void
setId(id)
Signature
Parameters
id
Type: String
Return Value
Type: void
setImage24(image24)
Signature
Parameters
image24
Type: String
Return Value
Type: void
setImage32(image32)
Signature
Parameters
image32
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
setImage192(image192)
Signature
Parameters
image192
Type: String
Return Value
Type: void
setImage192(image512)
Signature
Parameters
image512
Type: String
Return Value
Type: void
setName(name)
Signature
Parameters
name
Type: String
Return Value
Type: void
Gets a user's identity.
Usage
See Slack's users.identity method.
UsersIdentityResponse Methods
This class contains standard response methods.
The following are methods for UsersIdentityResponse.
getTeam()
Signature
Return Value
Type: Slack.UsersIdentityResponse.Team
getUser()
Signature
Return Value
Type: Slack.UsersIdentityResponse.User
setTeam(team)
Signature
Parameters
team
Type: Slack.UsersIdentityResponse.Team
Return Value
Type: void
setUser(user)
Signature
Parameters
user
Type: Slack.UsersIdentityResponse.User
Return Value
Type: void
Sends a request to get information about a user.
Usage
See Slack's users.info method.
UsersInfoRequest Methods
The following are methods for UsersInfoRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value Type: Slack.UsersInfoRequest.Builder
Contains methods to build an instance of the Slack.UsersInfoRequest class.
A Builder object is obtained by invoking one of the UsersInfoRequest.Builder methods defined by the UsersInfoRequest class.
UsersInfoRequest.Builder Methods
The following are methods for UsersInfoRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.UsersInfoRequest.
Signature
Return Value
Type: Slack.UsersInfoRequest
includeLocale(includeLocale)
Signature
Parameters
includeLocale
Type: Boolean
Return Value
Type
user(user)
Required. The user to get info on.
Signature
Parameters
user
Type: String
Return Value
Type: Slack.UsersInfoRequest.Builder
Gets information about a user.
Usage
See Slack's users.info method.
UsersInfoResponse Methods
This class contains standard response methods.
The following are methods for UsersInfoResponse.
getUser()
Signature
Return Value
Type: Slack.User
setUser(user)
Signature
Parameters
user
Type: Slack.User
Return Value
Type: void
Sends a request to lists all users in a Slack team.
Usage
See Slack's users.list method.
UsersListRequest Methods
The following are methods for UsersListRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersListRequest.Builder
Contains methods to build an instance of the Slack.UsersListRequest class.
A Builder object is obtained by invoking one of the UsersListRequest.Builder methods defined by the UsersListRequest class.
UsersListRequest.Builder Methods
The following are methods for UsersListRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.UsersListRequest.
Signature
Return Value Type: Slack.UsersListRequest
cursor(cursor)
Signature
Parameters
cursor
Type: String
Return Value
Type: Slack.UsersListRequest.Builder
includeLocale(includeLocale)
Signature
Parameters
includeLocale
Type: Boolean
Return Value
Type: Slack.UsersListRequest.Builder
limitValue(limitValue)
Signature
Parameters
limitValue
Type: Integer
Return Value
Type: Slack.UsersListRequest.Builder
teamId(teamId)
Signature
Parameters
teamId
Type: String
Return Value
Type: Slack.UsersListRequest.Builder
Lists all users in a Slack team.
Usage
See Slack's users.list method.
UsersListResponse Methods
This class contains standard response methods.
The following are methods for UsersListResponse.
getCacheTs()
Signature
Return Value
Type: String
getMembers()
Signature
Return Value
Type: List<Slack.User>
getOffset()
Signature
Return Value
Type: String
getResponseMetadata()
Signature
Return Value
Type: Slack.ResponseMetadata
setCacheTs(cacheTs)
Signature
Parameters
cacheTs
Type: String
Return Value
Type: void
setMembers(members)
Signature
Parameters
members
Type: List<Slack.User>
Return Value
Type: void
setOffset(offset)
Signature
Parameters
offset
Type: String
Return Value
Type: void
Sends a request to find a user with an email address.
Usage
See Slack's users.lookupByEmail method.
UsersLookupByEmailRequest Methods
The following are methods for UsersLookupByEmailRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersLookupByEmailRequest.Builder
Contains methods to build an instance of the Slack.UsersLookupByEmailRequest class.
A Builder object is obtained by invoking one of the UsersLookupByEmailRequest.Builder methods defined by the UsersLookupByEmailRequest class.
UsersLookupByEmailRequest.Builder Methods
The following are methods for UsersLookupByEmailRequest.Builder.
build()
Required. Returns an instance of Slack.UsersLookupByEmailRequest.
Signature
Return Value
Type: Slack.UsersLookupByEmailRequest
email(email)
Required. An email address belonging to a user in the workspace.
Signature
Parameters
Type: String
Return Value
Type: Slack.UsersLookupByEmailRequest.Builder
Find a user with an email address.
Usage
See Slack's users.lookupByEmail method.
UsersLookupByEmailResponse Methods
This class contains standard response methods.
The following are methods for UsersLookupByEmailResponse.
getUser()
Signature
Return Value
Type: Slack.User
setUser(user)
Signature
Parameters
user
Type: Slack.User
Return Value
Type: void
Sends a request to retrieve a user's profile information, including their custom status.
Usage
See Slack's users.profile.get method.
UsersProfileGetRequest Methods
The following are methods for UsersProfileGetRequest.
builder()
Signature
Return Value
Type: Slack.UsersProfileGetRequest.Builder
Contains methods to build an instance of the Slack.UsersProfileGetRequest class.
A Builder object is obtained by invoking one of the UsersProfileGetRequest.Builder methods defined by the UsersProfileGetRequest class.
UsersProfileGetRequest.Builder Methods
The following are methods for UsersProfileGetRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of Slack.UsersProfileGetRequest.
Signature
Return Value
Type: Slack.UsersProfileGetRequest
includeLabels(includeLabels)
Signature
Parameters
includeLabels
Type: Boolean
Return Value
Type: Slack.UsersProfileGetRequest.Builder
user(user)
Signature
Parameters
user
Type: String
Return Value
Type: Slack.UsersProfileGetRequest.Builder
Retrieve a user's profile information, including their custom status.
Usage
See Slack's users.profile.get method.
UsersProfileGetResponse Methods
This class contains standard response methods.
Sends a request to set a user's profile information, including custom status.
Usage
See Slack's users.profile.set method.
UsersProfileSetRequest Methods
The following are methods for UsersProfileSetRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersProfileSetRequest.Builder
Contains methods to build an instance of the Slack.UsersProfileSetRequest class.
A Builder object is obtained by invoking one of the UsersProfileSetRequest.Builder methods defined by the UsersProfileSetRequest class.
UsersProfileSetRequest.Builder Methods
The following are methods for UsersProfileSetRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Returns an instance of `Slack.UsersProfileSetRequest.
Signature
name(name)
Signature
Parameters
name
Type: String
Return Value
Type: Slack.UsersProfileSetRequest.Builder
user(user)
Signature
Parameters
user
Type: String
Return Value
Type: Slack.UsersProfileSetRequest.Builder
value(value)
Signature
Parameters
value
Type: String
Return Value
Type: Slack.UsersProfileSetRequest.Builder
Set a user's profile information, including custom status.
Usage
See Slack's users.profile.set method.
UsersProfileSetResponse Methods
This class contains standard response methods.
The following are methods for UsersProfileSetResponse.
getUsername()
Signature
Return Value Type: String
Sent a request to mark a user as active. Deprecated and non-functional.
Usage
See Slack's users.setActive method.
UsersSetActiveRequest Methods
The following are methods for UsersSetActiveRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersSetActiveRequest.Builder
Contains methods to build an instance of the Slack.UsersSetActiveRequest class.
A Builder object is obtained by invoking one of the UsersSetActiveRequest.Builder methods defined by the UsersSetActiveRequest class.
UsersSetActiveRequest.Builder Methods
The following are methods for UsersSetActiveRequest.Builder.
build()
Required. Returns an instance of Slack.UsersSetActiveRequest.
Signature
Return Value
Type: Slack.UsersSetActiveRequest
Marked a user as active.
Usage
See Slack's users.setActive method.
UsersSetActiveResponse Methods
This class contains standard response methods.
Sends a request to manually sets user presence.
Usage
See Slack's users.setPresence method.
UsersSetPresenceRequest Methods
The following are methods for UsersSetPresenceRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
Return Value
Type: Slack.UsersSetPresenceRequest.Builder
Contains methods to build an instance of the Slack.UsersSetPresenceRequest class.
A Builder object is obtained by invoking one of the UsersSetPresenceRequest.Builder methods defined by the UsersSetPresenceRequest class.
UsersSetPresenceRequest.Builder Methods
The following are methods for UsersSetPresenceRequest.Builder.
build()
Required. Returns an instance of Slack.UsersSetPresenceRequest.
Signature
Return Value
Type: Slack.UsersSetPresenceRequest
presence(presence)
Required. Either auto or away.
Signature
Parameters
presence
Type: String
Return Value
Type: Slack.UsersSetPresenceRequest.Builder
Manually sets user presence.
Usage
See Slack's users.setPresence method.
UsersSetPresenceResponse Methods
This class contains standard response methods.