Work with Users

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

User Class

Represents information about a Slack workspace user.

Usage

See Slack's user object type.

User Methods

The following are methods for User.

getColor()

Signature

public String getColor()

Return Value

Type: String

getEnterpriseUser()

Signature

public Slack.User.EnterpriseUser getEnterpriseUser()

Return Value

Type: Slack.User.EnterpriseUser

getId()

Signature

public String getId()

Return Value

Type: String

getLocale()

Signature

public String getLocale()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

getPresence()

Signature

public String getPresence()

Return Value

Type: String

getProfile()

Signature

public Slack.User.Profile getProfile()

Return Value

Type: Slack.User.Profile

getRealName()

Signature

public String getRealName()

Return Value

Type: String

getTeamId()

Signature

public String getTeamId()

Return Value

Type: String

getTwoFactorType()

Signature

public String getTwoFactorType()

Return Value

Type: String

getTz()

Signature

public String getTz()

Return Value

Type: String

getTzLabel()

Signature

public String getTzLabel()

Return Value

Type: String

getTzOffset()

Signature

public Integer getTzOffset()

Return Value

Type: Integer

getUpdated()

Signature

public Long getUpdated()

Return Value

Type: Long

isAdmin()

Signature

public Boolean isAdmin()

Return Value

Type: Boolean

isAppUser()

Signature

public Boolean isAppUser()

Return Value

Type: Boolean

isBot()

Signature

public Boolean isBot()

Return Value

Type: Boolean

isDeleted()

Signature

public Boolean isDeleted()

Return Value

Type: Boolean

isEmailConfirmed()

Signature

public Boolean isEmailConfirmed()

Return Value

Type: Boolean

isHas2fa()

Signature

public Boolean isHas2fa()

Return Value

Type: Boolean

isHasFiles()

Signature

public Boolean isHasFiles()

Return Value

Type: Boolean

isInvitedUser()

Signature

public Boolean isInvitedUser()

Return Value

Type: Boolean

isOwner()

Signature

public Boolean isOwner()

Return Value

Type: Boolean

isPrimaryOwner()

Signature

public Boolean isPrimaryOwner()

Return Value

Type: Boolean

isRestricted()

Signature

public Boolean isRestricted()

Return Value

Type: Boolean

isStranger()

Signature

public Boolean isStranger()

Return Value

Type: Boolean

isUltraRestricted()

Signature

public Boolean isUltraRestricted()

Return Value

Type: Boolean

isWorkflowBot()

Signature

public Boolean isWorkflowBot()

Return Value

Type: Boolean

isWhoCanShareContactCard()

Signature

public Boolean isWhoCanShareContactCard()

Return Value

Type: Boolean

setAdmin(admin)

Signature

public void setAdmin(Boolean admin)

Parameters

admin

Type: Boolean

Return Value

Type: void

setAppUser(appUser)

Signature

public void setAppUser(Boolean appUser)

Parameters

appUser

Type: Boolean

Return Value

Type: void

setBot(bot)

Signature

public void setBot(Boolean bot)

Parameters

bot

Type: Boolean

Return Value

Type: void

setColor(color)

Signature

public void setColor(String color)

Parameters

color

Type: String

Return Value

Type: void

setDeleted(deleted)

Signature

public void setDeleted(Boolean deleted)

Parameters

deleted

Type: Boolean

Return Value

Type: void

setEmailConfirmed(emailConfirmed)

Signature

public void setEmailConfirmed(Boolean emailConfirmed)

Parameters

emailConfirmed

Type: Boolean

Return Value

Type: void

setEnterpriseUser(enterpriseUser)

Signature

public void setEnterpriseUser(Slack.User.EnterpriseUser enterpriseUser)

Parameters

enterpriseUser

Type: Slack.User.EnterpriseUser

Return Value

Type: void

setHas2fa(has2fa)

Signature

public void setHas2fa(Boolean has2fa)

Parameters

has2fa

Type: Boolean

Return Value

Type: void

setHasFiles(hasFiles)

Signature

public void setHasFiles(Boolean hasFiles)

Parameters

hasFiles

Type: Boolean

Return Value

Type: void

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setInvitedUser(invitedUser)

Signature

public void setInvitedUser(Boolean invitedUser)

Parameters

invitedUser

Type: Boolean

Return Value

Type: void

setLocale(locale)

Signature

public void setLocale(String locale)

Parameters

locale

Type: String

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

setOwner(owner)

Signature

public void setOwner(Boolean owner)

Parameters

owner

Type:

Return Value

Type: void

setPresence(presence)

Signature

public void setPresence(String presence)

Parameters

presence

Type: String

Return Value

Type: void

setPrimaryOwner(primaryOwner)

Signature

public void setPrimaryOwner(Boolean primaryOwner)

Parameters

primaryOwner

Type: Boolean

Return Value

Type: void

setProfile(profile)

Signature

public void setProfile(Slack.User.Profile profile)

Parameters

profile

Type: Slack.User.Profile

Return Value

Type: void

setRealName(realName)

Signature

public void setRealName(String realName)

Parameters

realName

Type: String

Return Value

Type: void

setRestricted(restricted)

Signature

public void setRestricted(Boolean restricted)

Parameters

restricted

Type: Boolean

Return Value

Type: void

setStranger(stranger)

Signature

public void setStranger(Boolean stranger)

Parameters

stranger

Type: Boolean

Return Value

Type: void

setTeamId(teamId)

Signature

public void setTeamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: void

setTwoFactorType(twoFactorType)

Signature

public void setTwoFactorType(String twoFactorType)

Parameters

twoFactorType

Type: String

Return Value

Type: void

setTz(tz)

Signature

public void setTz(String tz)

Parameters

tz

Type: String

Return Value

Type: void

setTzLabel(tzLabel)

Signature

public void setTzLabel(String tzLabel)

Parameters

tzLabel

Type: String

Return Value

Type: void

setTzOffset(tzOffset)

Signature

public void setTzOffset(Integer tzOffset)

Parameters

tzOffset

Type: Integer

Return Value

Type: void

setUltraRestricted(ultraRestricted)

Signature

public void setUltraRestricted(Boolean ultraRestricted)

Parameters

ultraRestricted

Type: Boolean

Return Value

Type: void

setUpdated(updated)

Signature

public void setUpdated(Long updated)

Parameters

updated

Type: Long

Return Value

Type: void

setWhoCanShareContactCard(whoCanShareContactCard)

Signature

public void setWhoCanShareContactCard(Boolean whoCanShareContactCard)

Parameters

whoCanShareContactCard

Type: Boolean

Return Value

Type: void

setWorkflowBot(workflowBot)

Signature

public void setWorkflowBot(Boolean workflowBot)

Parameters

workflowBot

Type: Boolean

Return Value

Type: void

User.EnterpriseUser Class

Represents an enterprise grid user.

Usage

See Slack's user object type.

User.EnterpriseUser Methods

The following are methods for User.EnterpriseUser.

getEnterpriseId()

Signature

public String getEnterpriseId()

Return Value

Type: String

getEnterpriseName()

Signature

public String getEnterpriseName()

Return Value

Type: String

getId()

Signature

public String getId()

Return Value

Type: String

getTeams()

Signature

public List<String> getTeams()

Return Value

Type: List<String>

isAdmin()

Signature

public Boolean isAdmin()

Return Value

Type: Boolean

isOwner()

Signature

public Boolean isOwner()

Return Value

Type: Boolean

setAdmin(isAdmine)

Signature

public void setAdmin(Boolean isAdmin)

Parameters

isAdmin

Type: Boolean

Return Value

Type: void

setEnterpriseId(enterpriseId)

Signature

public void setEnterpriseId(String enterpriseId)

Parameters

enterpriseId

Type: String

Return Value

Type: void

setEnterpriseName(enterpriseName)

Signature

public void setEnterpriseName(String enterpriseName)

Parameters

enterpriseName

Type: String

Return Value

Type: void

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setOwner(isOwner)

Signature

public void setOwner(Boolean isOwner)

Parameters

isOwner

Type: Boolean

Return Value

Type: void

setTeams(teams)

Signature

public void setTeams(List<String> teams)

Parameters

teams

Type: List<String>

Return Value

Type: void

User.Field Class

User.Field Methods

The following are methods for User.Field.

getAlt()

Signature

public String getAlt()

Return Value

Type: String

getLabel()

Signature

public String getLabel()

Return Value

Type: String

getValue()

Signature

public String getValue()

Return Value

Type: String

setAlt(alt)

Signature

public void setAlt(String alt)

Parameters

alt

Type: String

Return Value

Type: void

setLabel(label)

Signature

public void setLabel(String label)

Parameters

label

Type: String

Return Value

Type: void

setValue(value)

Signature

public void setValue(String value)

Parameters

value

Type: String

Return Value

Type: void

User.Profile Class

Represents the user's profile, including the user's title, real and display names, email, and avatar images.

Usage

See Slack's user object type.

User.Profile Methods

The following are methods for User.Profile.

getApiAppId()

Signature

public String getApiAppId()

Return Value

Type: String

getAvatarHash()

Signature

public String getAvatarHash()

Return Value

Type: String

getBotId()

Signature

public String getBotId()

Return Value

Type: String

getDisplayName()

Signature

public String getDisplayName()

Return Value

Type: String

getDisplayNameNormalized()

Signature

public String getDisplayNameNormalized()

Return Value

Type: String

getEmail()

Signature

public String getEmail()

Return Value

Type: String

getFields()

Signature

public Map<String,Slack.User.Field> getFields()

Return Value

Type: Map<String,Slack.User.Field>

getGuestChannels()

Signature

public String getGuestChannels()

Return Value

Type: String

getGuestExpirationTs()

Signature

public Long getGuestExpirationTs()

Return Value

Type: Long

getGuestInvitedBy()

Signature

public String getGuestInvitedBy()

Return Value

Type: String

getImage24()

Signature

public String getImage24()

Return Value

Type: String

getImage32()

Signature

public String getImage32()

Return Value

Type: String

getImage48()

Signature

public String getImage48()

Return Value

Type: String

getImage72()

Signature

public String getImage72()

Return Value

Type: String

getImage192()

Signature

public String getImage192()

Return Value

Type: String

getImage512()

Signature

public String getImage512()

Return Value

Type: String

getImage1024()

Signature

public String getImage1024()

Return Value

Type: String

getImageOriginal()

Signature

public String getImageOriginal()

Return Value

Type: String

getPhone()

Signature

public String getPhone()

Return Value

Type: String

getPronouns()

Signature

public String getPronouns()

Return Value

Type: String

getRealName()

Signature

public String getRealName()

Return Value

Type: String

getRealNameNormalized()

Signature

public String getRealNameNormalized()

Return Value

Type: String

getSkype()

Signature

public String getSkype()

Return Value

Type: String

getStatusEmoji()

Signature

public String getStatusEmoji()

Return Value

Type: String

getStatusEmojiDisplayInfo()

Signature

public List<Slack.User.StatusEmojiDisplayInfo> getStatusEmojiDisplayInfo()

Return Value

Type: String

getStatusEmojiUrl()

Signature

public String getStatusEmojiUrl()

Return Value

Type: String

getStatusExpiration()

Signature

public Long getStatusExpiration()

Return Value

Type: Long

getStatusText()

Signature

public String getStatusText()

Return Value

Type: String

getStatusTextCanonical()

Signature

public String getStatusTextCanonical()

Return Value

Type: String

getTeam()

Signature

public String getTeam()

Return Value

Type: String

getTitle()

Signature

public String getTitle()

Return Value

Type: String

isAlwaysActive()

Signature

public Boolean isAlwaysActive()

Return Value

Type: Boolean

isCustomImage()

Signature

public Boolean isCustomImage()

Return Value

Type: Boolean

setAlwaysActive(alwaysActive)

Signature

public void setAlwaysActive(Boolean alwaysActive)

Parameters

alwaysActive

Type: Boolean

Return Value

Type: void

setApiAppId(apiAppId)

Signature

public void setApiAppId(String apiAppId)

Parameters

apiAppId

Type: String

Return Value

Type: void

setAvatarHash(avatarHash)

Signature

public void setAvatarHash(String avatarHash)

Parameters

avatarHash

Type: String

Return Value

Type: void

setBotId(botId)

Signature

public void setBotId(String botId)

Parameters

botId

Type: String

Return Value

Type: void

setCustomImage(customImage)

Signature

public void setCustomImage(Boolean customImage)

Parameters

customImage

Type: Boolean

Return Value

Type: void

setDisplayName(displayName)

Signature

public void setDisplayName(String displayName)

Parameters

displayName

Type: String

Return Value

Type: void

setDisplayNameNormalized(displayNameNormalized)

Signature

public void setDisplayNameNormalized(String displayNameNormalized)

Parameters

displayNameNormalized

Type: String

Return Value

Type: void

setEmail(email)

Signature

public void setEmail(String email)

Parameters

email

Type: String

Return Value

Type: void

setFields(fields)

Signature

public void setFields(Map<String,Slack.User.Field> fields)

Parameters

fields

Type: Map<String,Slack.User.Field>

Return Value

Type: void

setGuestChannels(guestChannels)

Signature

public void setGuestChannels(String guestChannels)

Parameters

guestChannels

Type: String

Return Value

Type: void

setGuestExpirationTs(guestExpirationTs)

Signature

public void setGuestExpirationTs(Long guestExpirationTs)

Parameters

guestExpirationTs

Type: Long

Return Value

Type: void

setGuestInvitedBy(guestInvitedBy)

Signature

public void setGuestInvitedBy(String guestInvitedBy)

Parameters

guestInvitedBy

Type: String

Return Value

Type: void

setImage24(image24)

Signature

public void setImage24(String image24)

Parameters

image24

Type: String

Return Value

Type: void

setImage32(image32)

Signature

public void setImage32(String image32)

Parameters

image32

Type: String

Return Value

Type: void

setImage48(image48)

Signature

public void setImage48(String image48)

Parameters

image48

Type: String

Return Value

Type: void

setImage72(image72)

Signature

public void setImage72(String image72)

Parameters

image72

Type:

Return Value

Type: void

setImage192(image192)

Signature

public void setImage192(String image192)

Parameters

image192

Type: String

Return Value

Type: void

setImage512(image512)

Signature

public void setImage512(String image512)

Parameters

image512

Type: String

Return Value

Type: void

setImage1024(image1024)

Signature

public void setImage1024(String image1024)

Parameters

image1024

Type: String

Return Value

Type: void

setImageOriginal(imageOriginal)

Signature

public void setImageOriginal(String imageOriginal)

Parameters

imageOriginal

Type: String

Return Value

Type: void

setPhone(phone)

Signature

public void setPhone(String phone)

Parameters

phone

Type: String

Return Value

Type: void

setPronouns(pronouns)

Signature

public void setPronouns(String pronouns)

Parameters

pronouns

Type: String

Return Value

Type: void

setRealName(realName)

Signature

public void setRealName(String realName)

Parameters

realName

Type: String

Return Value

Type: void

setRealNameNormalized(realNameNormalized)

Signature

public void setRealNameNormalized(String realNameNormalized)

Parameters

realNameNormalized

Type: String

Return Value

Type: void

setSkype(skype)

Signature

public void setSkype(String skype)

Parameters

skype

Type: String

Return Value

Type: void

setStatusEmoji(statusEmoji)

Signature

public void setStatusEmoji(String statusEmoji)

Parameters

statusEmoji

Type: String

Return Value

Type: void

setStatusEmojiDisplayInfo(statusEmojiDisplayInfo)

Signature

setStatusEmojiDisplayInfo(statusEmojiDisplayInfo)

Parameters

statusEmojiDisplayInfo

Type: List<Slack.User.StatusEmojiDisplayInfo>

Return Value

Type: void

setStatusEmojiUrl(statusEmojiUrl)

Signature

public void setStatusEmojiUrl(String statusEmojiUrl)

Parameters

statusEmojiUrl

Type: String

Return Value

Type: void

setStatusExpiration(statusExpiration)

Signature

public void setStatusExpiration(Long statusExpiration)

Parameters

statusExpiration

Type: Long

Return Value

Type: void

setStatusText(statusText)

Signature

public void setStatusText(String statusText)

Parameters

statusText

Type: String

Return Value

Type: void

setStatusTextCanonical(statusTextCanonical)

Signature

public void setStatusTextCanonical(String statusTextCanonical)

Parameters

statusTextCanonical

Type: String

Return Value

Type: void

setTeam(team)

Signature

public void setTeam(String team)

Parameters

team

Type: String

Return Value

Type: void

setTitle(title)

Signature

public void setTitle(String title)

Parameters

title

Type: String

Return Value

Type: void

User.StatusEmojiDisplayInfo Class

Represents an enterprise grid user.

User.StatusEmojiDisplayInfo Methods

The following are methods for User.StatusEmojiDisplayInfo.

getEmojiName()

Signature

public String getEmojiName()

Return Value

Type: String

getDisplayAlias()

Signature

public String getDisplayAlias()

Return Value

Type: String

getDisplayUrl()

Signature

public String getDisplayUrl()

Return Value

Type: String

setEmojiName(emojiName)

Signature

public void setEmojiName(String emojiName)

Parameters

emojiName

Type: String

Return Value

Type: void

setDisplayAlias(displayAlias)

Signature

public void setDisplayAlias(String displayAlias)

Parameters

displayAlias

Type: String

Return Value

Type: void

setDisplayUrl()

Signature

public void setDisplayUrl(String displayUrl)

Parameters

displayUrl

Type: String

Return Value

Type: void

UsersConversationsRequest Class

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

public static Slack.UsersConversationsRequest.Builder builder()

Return Value

Type: Slack.UsersConversationsRequest.Builder

UsersConversationsRequest.Builder Class

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

public Slack.UsersConversationsRequest build()

Return Value

Type: Slack.UsersConversationsRequest

cursor(cursor)

Signature

public Slack.UsersConversationsRequest.Builder cursor(String cursor)

Parameters

cursor

Type: String

Return Value

Type: Slack.UsersConversationsRequest.Builder

excludeArchived(excludeArchived)

Signature

public Slack.UsersConversationsRequest.Builder excludeArchived(Boolean excludeArchived)

Parameters

excludeArchived

Type: Boolean

Return Value

Type: Slack.UsersConversationsRequest.Builder

limitValue(limitValue)

Signature

public Slack.UsersConversationsRequest.Builder limitValue(Integer limitValue)

Parameters

limitValue

Type: Integer

Return Value

Type: Slack.UsersConversationsRequest.Builder

teamId(teamId)

Signature

public Slack.UsersConversationsRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.UsersConversationsRequest.Builder

types(types)

Signature

public Slack.UsersConversationsRequest.Builder types(List<Slack.ConversationType> types)

Parameters

types

Type: List<Slack.ConversationType>

Return Value

Type: Slack.UsersConversationsRequest.Builder

user(user)

Signature

public Slack.UsersConversationsRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.UsersConversationsRequest.Builder

UsersConversationsResponse Class

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

public List<Slack.Conversation> getChannels()

Return Value

Type: List<Slack.Conversation>

getResponseMetadata()

Signature

public Slack.ResponseMetadata getResponseMetadata()

Return Value

Type: Slack.ResponseMetadata

setChannels(channels)

Signature

public void setChannels(List<Slack.Conversation> channels)

Parameters

channels

Type: List<Slack.Conversation>

Return Value

Type: void

setResponseMetadata(responseMetadata)

Signature

public void setResponseMetadata(Slack.ResponseMetadata responseMetadata)

Parameters

responseMetadata

Type: Slack.ResponseMetadata

Return Value

Type: void

UsersDeletePhotoRequest.Builder Class

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

public Slack.UsersDeletePhotoRequest build()

Return Value

Type: Slack.UsersDeletePhotoRequest

UsersDeletePhotoRequest Class

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

public static Slack.UsersDeletePhotoRequest.Builder builder()

Return Value

Type: Slack.UsersDeletePhotoRequest.Builder

UsersDeletePhotoResponse Class

Delete the user profile photo.

Usage

See Slack's users.deletePhoto.

UsersDeletePhotoResponse Methods

This class contains standard response methods.

UsersGetPresenceRequest.Builder Class

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

public Slack.UsersGetPresenceRequest build()

Return Value

Type: Slack.UsersGetPresenceRequest

user(user)

Signature

public Slack.UsersGetPresenceRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.UsersGetPresenceRequest.Builder

UsersGetPresenceRequest Class

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

public static Slack.UsersGetPresenceRequest.Builder builder()

Return Value

Type: Slack.UsersGetPresenceRequest.Builder

UsersGetPresenceResponse Class

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

public Integer getConnectionCount()

Return Value

Type: Integer

getLastActivity()

Signature

public Integer getLastActivity()

Return Value

Type: Integer

getPresence()

Signature

public String getPresence()

Return Value

Type: String

isAutoAway()

Signature

public Boolean isAutoAway()

Return Value

Type: Boolean

isManualAway()

Signature

public Boolean isManualAway()

Return Value

Type: Boolean

isOnline()

Signature

public Boolean isOnline()

Return Value

Type: Boolean

setAutoAway(autoAway)

Signature

public void setAutoAway(Boolean autoAway)

Parameters

autoAway

Type: Boolean

Return Value

Type: void

setConnectionCount(connectionCount)

Signature

public void setConnectionCount(Integer connectionCount)

Parameters

connectionCount

Type: Integer

Return Value

Type: void

setLastActivity(lastActivity)

Signature

public void setLastActivity(Integer lastActivity)

Parameters

lastActivity

Type: Integer

Return Value

Type: void

setManualAway(manualAway)

Signature

public void setManualAway(Boolean manualAway)

Parameters

manualAway

Type: Boolean

Return Value

Type: void

setOnline(online)

Signature

public void setOnline(Boolean online)

Parameters

online

Type: Boolean

Return Value

Type: void

setPresence(presence)

Signature

public void setPresence(String presence)

Parameters

presence

Type: String

Return Value

Type: void

UsersIdentityRequest.Builder Class

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

public Slack.UsersIdentityRequest build()

Return Value

Type: Slack.UsersIdentityRequest

UsersIdentityRequest Class

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

public static Slack.UsersIdentityRequest.Builder builder()

Return Value

Type: Slack.UsersIdentityRequest.Builder

UsersIdentityResponse.Team Class

Get a user's identity.

UsersIdentityResponse.Team Methods

The following are methods for UsersIdentityResponse.Team.

getId()

Signature

public String getId()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

UsersIdentityResponse.User Class

Get a user's identity.

UsersIdentityResponse.User Methods

The following are methods for UsersIdentityResponse.User.

getEmail()

Signature

public String getEmail()

Return Value

Type: String

getId()

Signature

public String getId()

Return Value

Type: String

getImage24()

Signature

public String getImage24()

Return Value

Type: String

getImage32()

Signature

public String getImage32()

Return Value

Type: String

getImage48()

Signature

public String getImage48()

Return Value

Type: String

getImage72()

Signature

public String getImage72()

Return Value

Type: String

getImage192()

Signature

public String getImage192()

Return Value

Type: String

getImage512()

Signature

public String getImage512()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

setEmail()

Signature

public void setEmail(String email)

Parameters

email

Type: String

Return Value

Type: void

setId(id)

Signature

public void setId(String id)

Parameters

id

Type: String

Return Value

Type: void

setImage24(image24)

Signature

public void setImage24(String image24)

Parameters

image24

Type: String

Return Value

Type: void

setImage32(image32)

Signature

public void setImage32(String image32)

Parameters

image32

Type: String

Return Value

Type: void

setImage48(image48)

Signature

public void setImage48(String image48)

Parameters

image48

Type: String

Return Value

Type: void

setImage72(image72)

Signature

public void setImage72(String image72)

Parameters

image72

Type: String

Return Value

Type: void

setImage192(image192)

Signature

public void setImage192(String image192)

Parameters

image192

Type: String

Return Value

Type: void

setImage192(image512)

Signature

public void setImage512(String image512)

Parameters

image512

Type: String

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

UsersIdentityResponse Class

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

public Slack.UsersIdentityResponse.Team getTeam()

Return Value

Type: Slack.UsersIdentityResponse.Team

getUser()

Signature

public Slack.UsersIdentityResponse.User getUser()

Return Value

Type: Slack.UsersIdentityResponse.User

setTeam(team)

Signature

public void setTeam(Slack.UsersIdentityResponse.Team team)

Parameters

team

Type: Slack.UsersIdentityResponse.Team

Return Value

Type: void

setUser(user)

Signature

public void setUser(Slack.UsersIdentityResponse.User user)

Parameters

user

Type: Slack.UsersIdentityResponse.User

Return Value

Type: void

UsersInfoRequest Class

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

public static Slack.UsersInfoRequest.Builder builder()

Return Value Type: Slack.UsersInfoRequest.Builder

UsersInfoRequest.Builder Class

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

public Slack.UsersInfoRequest build()

Return Value

Type: Slack.UsersInfoRequest

includeLocale(includeLocale)

Signature

public Slack.UsersInfoRequest.Builder includeLocale(Boolean includeLocale)

Parameters

includeLocale

Type: Boolean

Return Value

Type:Slack.UsersInfoRequest.Builder

user(user)

Required. The user to get info on.

Signature

public Slack.UsersInfoRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.UsersInfoRequest.Builder

UsersInfoResponse Class

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

public Slack.User getUser()

Return Value

Type: Slack.User

setUser(user)

Signature

public void setUser(Slack.User user)

Parameters

user

Type: Slack.User

Return Value

Type: void

UsersListRequest Class

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

public static Slack.UsersListRequest.Builder builder()

Return Value

Type: Slack.UsersListRequest.Builder

UsersListRequest.Builder Class

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

public Slack.UsersListRequest build()

Return Value Type: Slack.UsersListRequest

cursor(cursor)

Signature

public Slack.UsersListRequest.Builder cursor(String cursor)

Parameters

cursor

Type: String

Return Value

Type: Slack.UsersListRequest.Builder

includeLocale(includeLocale)

Signature

public Slack.UsersListRequest.Builder includeLocale(Boolean includeLocale)

Parameters

includeLocale

Type: Boolean

Return Value

Type: Slack.UsersListRequest.Builder

limitValue(limitValue)

Signature

public Slack.UsersListRequest.Builder limitValue(Integer limitValue)

Parameters

limitValue

Type: Integer

Return Value

Type: Slack.UsersListRequest.Builder

teamId(teamId)

Signature

public Slack.UsersListRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.UsersListRequest.Builder

UsersListResponse Class

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

public String getCacheTs()

Return Value

Type: String

getMembers()

Signature

public List<Slack.User> getMembers()

Return Value

Type: List<Slack.User>

getOffset()

Signature

public String getOffset()

Return Value

Type: String

getResponseMetadata()

Signature

public Slack.ResponseMetadata getResponseMetadata()

Return Value

Type: Slack.ResponseMetadata

setCacheTs(cacheTs)

Signature

public void setCacheTs(String cacheTs)

Parameters

cacheTs

Type: String

Return Value

Type: void

setMembers(members)

Signature

public void setMembers(List<Slack.User> members)

Parameters

members

Type: List<Slack.User>

Return Value

Type: void

setOffset(offset)

Signature

public void setOffset(String offset)

Parameters

offset

Type: String

Return Value

Type: void

UsersLookupByEmailRequest Class

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

public static Slack.UsersLookupByEmailRequest.Builder builder()

Return Value

Type: Slack.UsersLookupByEmailRequest.Builder

UsersLookupByEmailRequest.Builder Class

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

public Slack.UsersLookupByEmailRequest build()

Return Value

Type: Slack.UsersLookupByEmailRequest

email(email)

Required. An email address belonging to a user in the workspace.

Signature

public Slack.UsersLookupByEmailRequest.Builder email(String email)

Parameters

email

Type: String

Return Value

Type: Slack.UsersLookupByEmailRequest.Builder

UsersLookupByEmailResponse Class

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

public Slack.User getUser()

Return Value

Type: Slack.User

setUser(user)

Signature

public void setUser(Slack.User user)

Parameters

user

Type: Slack.User

Return Value

Type: void

UsersProfileGetRequest Class

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

public static Slack.UsersProfileGetRequest.Builder builder()

Return Value

Type: Slack.UsersProfileGetRequest.Builder

UsersProfileGetRequest.Builder Class

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

public Slack.UsersProfileGetRequest build()

Return Value

Type: Slack.UsersProfileGetRequest

includeLabels(includeLabels)

Signature

public Slack.UsersProfileGetRequest.Builder includeLabels(Boolean includeLabels)

Parameters

includeLabels

Type: Boolean

Return Value

Type: Slack.UsersProfileGetRequest.Builder

user(user)

Signature

public Slack.UsersProfileGetRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.UsersProfileGetRequest.Builder

UsersProfileGetResponse Class

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.

UsersProfileSetRequest Class

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

public static Slack.UsersProfileSetRequest.Builder builder()

Return Value

Type: Slack.UsersProfileSetRequest.Builder

UsersProfileSetRequest.Builder Class

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

public Slack.UsersProfileSetRequest build()

name(name)

Signature

public Slack.UsersProfileSetRequest.Builder name(String name)

Parameters

name

Type: String

Return Value

Type: Slack.UsersProfileSetRequest.Builder

user(user)

Signature

public Slack.UsersProfileSetRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.UsersProfileSetRequest.Builder

value(value)

Signature

public Slack.UsersProfileSetRequest.Builder value(String value)

Parameters

value

Type: String

Return Value

Type: Slack.UsersProfileSetRequest.Builder

UsersProfileSetResponse Class

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

public String getUsername()

Return Value Type: String

UsersSetActiveRequest Class

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

public static Slack.UsersSetActiveRequest.Builder builder()

Return Value

Type: Slack.UsersSetActiveRequest.Builder

UsersSetActiveRequest.Builder Class

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

public Slack.UsersSetActiveRequest build()

Return Value

Type: Slack.UsersSetActiveRequest

UsersSetActiveResponse Class

Marked a user as active.

Usage

See Slack's users.setActive method.

UsersSetActiveResponse Methods

This class contains standard response methods.

UsersSetPresenceRequest Class

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

public static Slack.UsersSetPresenceRequest.Builder builder()

Return Value

Type: Slack.UsersSetPresenceRequest.Builder

UsersSetPresenceRequest.Builder Class

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

public Slack.UsersSetPresenceRequest build()

Return Value

Type: Slack.UsersSetPresenceRequest

presence(presence)

Required. Either auto or away.

Signature

public Slack.UsersSetPresenceRequest.Builder presence(String presence)

Parameters

presence

Type: String

Return Value

Type: Slack.UsersSetPresenceRequest.Builder

UsersSetPresenceResponse Class

Manually sets user presence.

Usage

See Slack's users.setPresence method.

UsersSetPresenceResponse Methods

This class contains standard response methods.