The following are Apex classes for the Slack usergroups API methods.
Usergroup Class
Represents a group of users.
Usage
See Slack's usergroup object type.
Usergroup Methods
The following are methods for Usergroup.
getAutoType()
Signature
public String getAutoType()
Return Value
Type: String
getChannelCount()
Signature
public Integer getChannelCount()
Return Value
Type: Integer
getCreatedBy()
Signature
public String getCreatedBy()
Return Value
Type: String
getDateCreate()
Signature
public Integer getDateCreate()
Return Value
Type: Integer
getDateDelete()
Signature
public Integer getDateDelete()
Return Value
Type: Integer
getDateUpdate()
Signature
public Integer getDateUpdate()
Return Value
Type: Integer
getDeletedBy()
Signature
public String getDeletedBy()
Return Value
Type: String
getDescription()
Signature
public String getDescription()
Return Value
Type: String
getEnterpriseSubteamId()
Signature
public String getEnterpriseSubteamId()
Return Value
Type: String
getHandle()
Signature
public String getHandle()
Return Value
Type: String
getId()
Signature
public String getId()
Return Value
Type: String
getName()
Signature
public String getName()
Return Value
Type: String
getPrefs()
Signature
public Slack.Usergroup.Prefs getPrefs()
Return Value
Type: Slack.Usergroup.Prefs
getTeamId()
Signature
public String getTeamId()
Return Value
Type: String
getUpdatedBy()
Signature
public String getUpdatedBy()
Return Value
Type: String
getUserCount()
Signature
public Integer getUserCount()
Return Value
Type: Integer
getUsers()
Signature
public List<String> getUsers()
Return Value
Type: List<String>
isAutoProvision()
Signature
public Boolean isAutoProvision()
Return Value
Type: Boolean
isExternal()
Signature
public Boolean isExternal()
Return Value
Type: Boolean
isSubteam()
Signature
public Boolean isSubteam()
Return Value
Type: Boolean
isUsergroup()
Signature
public Boolean isUsergroup()
Return Value
Type: Boolean
setAutoProvision(autoProvision)
Signature
public void setAutoProvision(Boolean autoProvision)
Parameters
autoProvision
Type: Boolean
Return Value
Type: void
setAutoType(autoType)
Signature
public void setAutoType(String autoType)
Parameters
autoType
Type: String
Return Value
Type: void
setChannelCount(channelCount)
Signature
public void setChannelCount(Integer channelCount)
Parameters
channelCount
Type: Integer
Return Value
Type: void
setCreatedBy(createdBy)
Signature
public void setCreatedBy(String createdBy)
Parameters
createdBy
Type: String
Return Value
Type: void
setDateCreate(dateCreate)
Signature
public void setDateCreate(Integer dateCreate)
Parameters
dateCreate
Type: Integer
Return Value
Type: void
setDateDelete(dateDelete)
Signature
public void setDateDelete(Integer dateDelete)
Parameters
dateDelete
Type: Integer
Return Value
Type: void
setDateUpdate(dateUpdate)
Signature
public void setDateUpdate(Integer dateUpdate)
Parameters
dateUpdate
Type: Integer
Return Value
Type: void
setDeletedBy(deletedBy)
Signature
public void setDeletedBy(String deletedBy)
Parameters
deletedBy
Type: String
Return Value
Type: void
setDescription(description)
Signature
public void setDescription(String description)
Parameters
description
Type: String
Return Value
Type: void
setEnterpriseSubteamId(enterpriseSubteamId)
Signature
public void setEnterpriseSubteamId(String enterpriseSubteamId)
Parameters
enterpriseSubteamId
Type: String
Return Value
Type: void
setExternal(external)
Signature
public void setExternal(Boolean external)
Parameters
external
Type: Boolean
Return Value
Type: void
setHandle(handle)
Signature
public void setHandle(String handle)
Parameters
handle
Type: String
Return Value
Type: void
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
setPrefs(prefs)
Signature
public void setPrefs(Slack.Usergroup.Prefs prefs)
Parameters
prefs
Type: Slack.Usergroup.Prefs
Return Value
Type: void
setSubteam(subteam)
Signature
public void setSubteam(Boolean subteam)
Parameters
subteam
Type: Boolean
Return Value
Type: void
setTeamId(teamId)
Signature
public void setTeamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: void
setUpdatedBy(updatedBy)
Signature
public void setUpdatedBy(String updatedBy)
Parameters
updatedBy
Type: String
Return Value
Type: void
setUserCount(userCount)
Signature
public void setUserCount(Integer userCount)
Parameters
userCount
Type: Integer
Return Value
Type: void
setUsergroup(usergroup)
Signature
public void setUsergroup(Boolean usergroup)
Parameters
usergroup
Type: Boolean
Return Value
Type: void
setUsers(users)
Signature
public void setUsers(List<String> users)
Parameters
users
Type: List<String>
Return Value
Type: void
Usergroup.Prefs Class
Represent the default channels and groups (private channels) that members are invited to when they join.
Usage
See Slack's usergroup object type.
Usergroup.Prefs Methods
The following are methods for Usergroup.Prefs.
getChannels()
Signature
public List<String> getChannels()
Return Value
Type: List<String>
getGroups()
Signature
public List<String> getGroups()
Return Value
Type: List<String>
setChannels(channels)
Signature
public void setChannels(List<String> channels)
Parameters
channels
Type: List<String>
Return Value
Type: void
setGroups(groups)
Signature
public void setGroups(List<String> groups)
Parameters
groups
Type: List<String>
Return Value
Type: void
UsergroupsCreateRequest Class
Sends a request to create a user group.
UsergroupsCreateRequest Methods
The following are methods for UsergroupsCreateRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsCreateRequest.Builder builder()
Return Value
Type: Slack.UsergroupsCreateRequest.Builder.
UsergroupsCreateRequest.Builder Class
Sends a request to create a user group.
UsergroupsCreateRequest.Builder Methods
The following are methods for UsergroupsCreateRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsCreateRequest.
Signature
public Slack.UsergroupsCreateRequest build()
Return Value
Type: Slack.UsergroupsCreateRequest
channels(channels)
Signature
public Slack.UsergroupsCreateRequest.Builder channels(List<String> channels)
Parameters
channels
Type: List<String>
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
description(description)
Signature
public Slack.UsergroupsCreateRequest.Builder description(String description)
Parameters
description Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
handle(handle)
Signature
public Slack.UsergroupsCreateRequest.Builder handle(String handle)
Parameters
handle Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
includeCount(includeCount)
Signature
public Slack.UsergroupsCreateRequest.Builder includeCount(Boolean includeCount)
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
name(name)
Required. A name for the User Group. Must be unique among User Groups.
Signature
public Slack.UsergroupsCreateRequest.Builder name(String name)
Parameters
name Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsCreateRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsCreateRequest.Builder
UsergroupsCreateResponse Class
Creates a user group.
UsergroupsCreateResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsCreateResponse.
getUsergroup()
Signature
public Slack.Usergroup getUsergroup()
Return Value
Type: Slack.Usergroup
setUsergroup(usergroup)
Signature
public void setUsergroup(Slack.Usergroup usergroup)
Parameters
usergroup
Type: Slack.Usergroup
UsergroupsDisableRequest.Builder Class
Sends a request to disable an existing user group.
UsergroupsDisableRequest.Builder Methods
The following are methods for UsergroupsDisableRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsDisableRequest.
Signature
public Slack.UsergroupsDisableRequest build()
Return Value
Type: Slack.UsergroupsDisableRequest
includeCount(includeCount)
Signature
public Slack.UsergroupsDisableRequest.Builder includeCount(Boolean includeCount)
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
usergroup(usergroup)
Required. The ID of the user group to disable.
Signature
public Slack.UsergroupsDisableRequest.Builder usergroup(String usergroup)
Parameters
usergroup Type: String
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsDisableRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
UsergroupsDisableRequest Class
Sends a request to disable an existing user group.
UsergroupsDisableRequest Methods
The following are methods for UsergroupsDisableRequest.
builder()
Signature
public static Slack.UsergroupsDisableRequest.Builder builder()
Return Value
Type: Slack.UsergroupsDisableRequest.Builder
UsergroupsDisableResponse Class
Disables an existing user group.
UsergroupsDisableResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsDisableResponse.
getUsergroup()
Signature
public Slack.Usergroup getUsergroup()
Return Value
Type: Slack.Usergroup
setUsergroup(usergroup)
Signature
public void setUsergroup(Slack.Usergroup usergroup)
Parameters
usergroup
Type: Slack.Usergroup
Return Value
Type: void
UsergroupsEnableRequest.Builder Class
Sends a request to enable a user group.
UsergroupsEnableRequest.Builder Methods
The following are methods for UsergroupsEnableRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsEnableRequest.
Signature
public Slack.UsergroupsEnableRequest build()
Return Value
Type: Slack.UsergroupsEnableRequest
includeCount(includeCount)
Signature
public Slack.UsergroupsEnableRequest.Builder usergroup(String usergroup)
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
usergroup(usergroup)
Required. The ID of the user group to enable.
Signature
public Slack.UsergroupsEnableRequest.Builder usergroup(String usergroup)
Parameters
usergroup Type: String
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
UsergroupsEnableRequest Class
Sends a request to enable a user group.
UsergroupsEnableRequest Methods
The following are methods for UsergroupsEnableRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsEnableRequest.Builder builder()
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsEnableRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsEnableRequest.Builder
UsergroupsEnableResponse Class
Enables a user group.
UsergroupsEnableResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsEnableResponse.
getUsergroup()
Signature
public Slack.Usergroup getUsergroup()
Return Value
Type: Slack.Usergroup
setUsergroup(usergroup)
Signature
public void setUsergroup(Slack.Usergroup usergroup)
Parameters
usergroup
Type: Slack.Usergroup
Return Value
Type: void
UsergroupsListRequest.Builder Class
Sends a request to list all user groups for a team.
UsergroupsListRequest.Builder Methods
The following are methods for UsergroupsListRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsListRequest.
Signature
public Slack.UsergroupsListRequest build()
Return Value
Type: Slack.UsergroupsListRequest
includeCount(includeCount)
Signature
public Slack.UsergroupsListRequest.Builder includeCount(Boolean includeCount)
Parameters
includeCount Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
includeDisabled(includeDisabled)
Signature
public Slack.UsergroupsListRequest.Builder includeDisabled(Boolean includeDisabled)
Parameters
includeDisabled Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
includeUsers(includeUsers)
Signature
public Slack.UsergroupsListRequest.Builder includeUsers(Boolean includeUsers)
Parameters
includeUsers Type: Boolean
Return Value
Type: Slack.UsergroupsListRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsListRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsListRequest.Builder
UsergroupsListRequest Class
Sends a request to list all user groups for a team.
UsergroupsListRequest Methods
The following are methods for UsergroupsListRequest.
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsListRequest.Builder builder()
Return Value
Type: Slack.UsergroupsListRequest.Builder
UsergroupsListResponse Class
Lists all user groups for a team.
UsergroupsListResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsListResponse.
getUsergroups()
Signature
public List<Slack.Usergroup> getUsergroups()
Return Value
Type: List<Slack.Usergroup>
setUsergroups(usergroups)
Signature
public void setUsergroups(List<Slack.Usergroup> usergroups)
Parameters
usergroups
Type: List<Slack.Usergroup>
Return Value
Type: void
UsergroupsUpdateRequest.Builder Class
Sends a request to update the list of users for a user group.
UsergroupsUpdateRequest.Builder Methods
The following are methods for UsergroupsUpdateRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsUpdateRequest.
Signature
public Slack.UsergroupsUpdateRequest build()
Return Value
Type: Slack.UsergroupsUpdateRequest
channnels()
Signature
public Slack.UsergroupsUpdateRequest.Builder channels(List<String> channels)
Parameters
channels
Type: List<String>
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
description(description)
Signature
public Slack.UsergroupsUpdateRequest.Builder description(String description)
Parameters
description
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
handle(handle)
Signature
public Slack.UsergroupsUpdateRequest.Builder handle(String handle)
Parameters
handle
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
includeCount(includeCount)
Signature
public Slack.UsergroupsUpdateRequest.Builder includeCount(Boolean includeCount)
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
name(name)
Parameters
name
Type: String
Signature
public Slack.UsergroupsUpdateRequest.Builder name(String name)
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsUpdateRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
usergroup(usergroup)
Required. The ID of the user group to update.
Signature
public Slack.UsergroupsUpdateRequest.Builder usergroup(String usergroup)
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
UsergroupsUpdateRequest Class
Sends a request to update the list of users for a user group.
UsergroupsUpdateRequest Methods
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsUpdateRequest.Builder builder()
Return Value
Type: Slack.UsergroupsUpdateRequest.Builder
UsergroupsUpdateResponse Class
Updates the list of users for a user group.
UsergroupsUpdateResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsUpdateResponse.
getUsergroup()
Signature
public Slack.Usergroup getUsergroup()
Return Value
Type: Slack.Usergroup
setUsergroup(usergroup)
Signature
public void setUsergroup(Slack.Usergroup usergroup)
Parameters
usergroup
Type: Slack.Usergroup
UsergroupsUsersListRequest.Builder Class
Sends a request to list all users in a user group.
UsergroupsUsersListRequest.Builder Methods
The following are methods for UsergroupsUsersListRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsUsersListRequest.
Signature
public Slack.UsergroupsUsersListRequest build()
Return Value
Type: Slack.UsergroupsUsersListRequest
includeDisabled(includeDisabled)
Signature
public Slack.UsergroupsUsersListRequest.Builder includeDisabled(Boolean includeDisabled)
Parameters
includeDisabled
Type: Boolean
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsUsersListRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
usergroup(usergroup)
Required. The ID of the user group to list.
Signature
public Slack.UsergroupsUsersListRequest.Builder usergroup(String usergroup)
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
UsergroupsUsersListRequest Class
Sends a request to list all users in a user group.
UsergroupsUsersListRequest Methods
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsUsersListRequest.Builder builder()
Return Value
Type: Slack.UsergroupsUsersListRequest.Builder
UsergroupsUsersListResponse Class
Lists all users in a user group.
UsergroupsUsersListResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsUsersListResponse.
getUsers()
Signature
public List<String> getUsers()
Return Value
Type: List<String>
setUsers(users)
Signature
public void setUsers(List<String> users)
Parameters
users
Type: String
Return Value
Type: void
UsergroupsUsersUpdateRequest.Builder Class
Sends a request to update the list of users for a user group.
UsergroupsUsersUpdateRequest.Builder Methods
The following are methods for UsergroupsUsersUpdateRequest.Builder. These methods are optional unless specified otherwise.
build()
Required. Builds an instance of Slack.UsergroupsUsersUpdateRequest.
Signature
public Slack.UsergroupsUsersUpdateRequest build()
Return Value
Type: Slack.UsergroupsUsersUpdateRequest
includeCount(includeCount)
Signature
public Slack.UsergroupsUsersUpdateRequest.Builder includeCount(Boolean includeCount)
Parameters
includeCount
Type: Boolean
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
teamId(teamId)
Signature
public Slack.UsergroupsUsersUpdateRequest.Builder teamId(String teamId)
Parameters
teamId
Type: String
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
usergroup(usergroup)
Required. The ID of the user group to update.
Signature
public Slack.UsergroupsUsersUpdateRequest.Builder usergroup(String usergroup)
Parameters
usergroup
Type: String
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
users(users)
Required. A comma-separated string of encoded user IDs that represent the entire list of users for the user group.
Signature
public Slack.UsergroupsUsersUpdateRequest.Builder users(List<String> users)
Parameters
users
Type: List<String>
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
UsergroupsUsersUpdateRequest Class
Sends a request to update the list of users for a user group.
UsergroupsUsersUpdateRequest Methods
builder()
Builds a request object that's used when executing the API call.
Signature
public static Slack.UsergroupsUsersUpdateRequest.Builder builder()
Return Value
Type: Slack.UsergroupsUsersUpdateRequest.Builder
UsergroupsUsersUpdateResponse Class
Updates the list of users for a user group.
UsergroupsUsersUpdateResponse Methods
This class contains standard response methods.
The following are methods for UsergroupsUsersUpdateResponse.
getUsergroup()
Signature
public Slack.Usergroup getUsergroup()
Return Value
Type: Slack.Usergroup
setUsergroup(usergroup)
Signature
public void setUsergroup(Slack.Usergroup usergroup)
Parameters
usergroup
Type: Slack.Usergroup