Documentation Changelog

This changelog lists documentation changes made to the Apex SDK for Slack (Beta) Developer Guide.

This documentation changes are new for July 3, 2023.

• The UserMapping class is new for the Slack namespace.
• Added a note that four Slack.App class methods have been deprecated and includes an alternative recommendation.

These documentation changes are new for May 11, 2023.

• Added new documentation for Slack Multi-Org Management feature.

These documentation changes are new for April 17, 2023.

• Added new documentation for Slack Mass User Provisioning.
• Added new documentation to support Moving Orgs & Sandbox Refreshes.

These documentation changes are new for February 23, 2023.

• The SLACKPACKAGING feature isn't required when packaging Slack apps.

These documentation changes are new for February 7, 2023.

• Added new flow functionality by using Slack buttons to trigger Flows. 🆕

These documentation changes are new for January 11, 2023.

• Dependent fields, picklists, and packaging are now available.

These documentation changes are new for January 11, 2023.

• Added new slash command functionality to trigger flows.
• Added allowUnauthenticatedUsers method in ActionDispatcher.

These classes are new for the Slack namespace.

• SharedChannelInviteAcceptedEvent
• SharedChannelInviteApprovedEvent
• SharedChannelInviteDeclinedEvent
• SharedChannelInviteReceivedEvent

These documentation changes are new for December 13, 2022.

• Added a limitation about API users in Considerations and Limitations.

These documentation changes are new for November 04, 2022.

• Updated reference documentation for TestHarness.User() and TestHarness.Team.
• Add a section clarifying test client overrides an example.
• Added test example to overwrite the botclient using the TestHarness
• New class added for the Slack namespace.TestHarness.File

These classes are new for the Slack namespace.

• CallableHandler.
• ActionResult.

These documentation changes are new for October 20, 2022.

• Salesforce SDK for Slack now available in Beta.

The following documentation changes are new for September 29, 2022.

• Updated the select component example in an Actions component.

These documentation changes are new for September 15, 2022.

• Updated the File class.

The following documentation changes are new for August 23, 2022.

• Removed Slack Components Date Time Picker warning. Now supports multiple time zones.

These documentation changes are new for July 13, 2022.

• Added a section clarifying user client usage.

These documentation changes are new for July 5, 2022.

• Updated the allowed components in an Actions component.

The following documentation changes are new for May 6, 2022.

• Added a section about enabling channel localization. 🆕
• Updated the Slack and Salesforce User Locales section.
• Clarified that expressions are case-sensitive.
• Added a section about deprecated events.
• Added a section about register a message event handler using the channel types and subtypes.
• Removed getBotClientForEnterprise() and getUserClientForEnterprise() methods as Enterprise Grid isn’t yet supported.

These documentation changes are new for April 29, 2022.

• Added a limitation about scopes in Considerations and Limitations.
• Added a section about Scope Limitations.

The following documentation changes are new for April 25, 2022.

• Clarified and added examples for the Select and External Select components.
• Added data provider examples for Slack.Option and Slack.OptionGroup.

The following documentation changes are new for April 7, 2022.

• Added information about enabling the Slack for Salesforce Beta.
• Added an updated version of the sample app.
• Added information about event subscriptions.
• Added event examples.
• Added reference documentation for TestHarness.executeEvent() and File.Headers class.
• Added a section for creating permissions for a Slack app.
• Added new methods like getHttpResponseHeaders() and setHttpResponseHeaders() to many of the *Response and *Request classes.

The following documentation changes are new for March 28, 2022.

• Added a section about localization limitations.
• Added a note about Slack's block limit for surface components.
• Updated the Apex SDK for Slack considerations and limitations.
• Updated the character limits for modals and homepage views.

The following documentation changes are new for March 25, 2022.

• Added a section about Slack's rate limit.
• Added information on .Builder classes to call out required methods.
• Updated the properties.text description for the section layout component to call out mrkdwn usage.
• Fixed a minor error to include a url for all slash_commands entries in the manifest example for the sample app.
• Fixed the properties.confirm description for the select component.

The following documentation changes are new for March 18, 2022.

• Added a note about localization support for Slack's (optional) input field label.
• Added an updated version of the sample app.

The following documentation changes are new for March 14, 2022.

• Salesforce Slack SDK is now Apex SDK for Slack. The dev guide has been updated to reflect the product name change.
• The TestHarness.Field class has been removed to follow the deprecation of the field component.

The following documentation changes are new for March 10, 2022.

• Added a note about limited time zone support for the date picker, time picker, and date time picker components.

The following documentation changes are new for March 8, 2022.

• Added documentation for the test harness framework and the Apex TestHarness class.
• Added an updated version of the sample app.
• Added the datasource composition object for data providers.
• Added a note about limited support for expressions.
• Updated Use Custom Labels to denote support for the {!label.key} expression.

These documentation changes are new for Mar 2, 2022.

• Added a section about action signing.

These documentation changes are new for Feb 24, 2022.

• Added a note that the field component has been deprecated and recommend an alternative way to render field values.

These documentation changes are new for Feb 9, 2022.

• Added localization information.
• Added input validation.
• Fixed trailing space errors in XML code blocks. The extra space resulted in errors when pushing with SFDX.

These documentation changes are new for Feb 3, 2022.

• Foyer is now Salesforce Slack SDK. The dev guide has been updated to reflect the product name change.
• Added a section Delete a User Mapping.

The following documentation changes are new for Feb 1, 2022.

These classes are new for the Slack namespace.

• BillableInfo
• BotIcons
• BotProfile
• BotProfile.Icons
• Call
• CallParticipant
• Channel
• Conversation
• ErrorResponseMetadata
• Field
• File
• File.Address
• File.PinnedInfo
• File.ShareDetail
• File.Shares
• FileComment
• IntegrationLog
• Latest
• Latest.Edited
• Login
• MatchedItem
• MatchedItem.Address
• MatchedItem.OtherItem
• Message
• Message.Edited
• Message.Icons
• Message.MessageItem
• Message.MessageRoot
• Message.MessageRootReply
• Paging
• Purpose
• Reaction
• ReactionsListRequest
• ReactionsListResponse
• ReactionsListResponse.Icons
• ReactionsListResponse.Item
• ReactionsListResponse.Message
• ReactionsListResponse.MessageRootReply
• ReactionsListResponse.UserProfile
• Reminder
• ResponseMetadata
• SearchResult
• SearchResult.Pagination
• StarsListRequest
• StarsListResponse
• StarsListResponse.Comment
• StarsListResponse.Edited
• StarsListResponse.Item
• StarsListResponse.Message
• StarsListResponse.MessageRootReply
• Team
• Team.Profile
• Team.ProfileOptions
• TeamIcon
• Topic
• User
• User.EnterpriseUser
• User.Field
• User.Profile
• Usergroup
• WarningResponseMetadata
• WorkflowStepInput
• WorkflowStepOutput

These classes were deleted.

• FilesUploadResponse
• FilesUploadRequest
• UsersSetPhotoRequest
• UsersSetPhotoResponse

These classes have changes.

AppsEventAuthorizationsListRequest.Builder has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

AppsEventAuthorizationsListResponse has new methods.

• getAuthorizations()
• setAuthorizations(authorizations)

AuthTeamsListRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

AuthTeamsListResponse has new methods.

• getTeams()
• getResponseMetadata()
• setTeams(teams)
• setResponseMetadata(responseMetadata)

BotClient has changed.

• reactionsList(req) has been added.
• filesUpload(req) has been removed.

BotsInfoResponse has new methods.

• getIcons()
• setIcons(icons)

CallsAddRequest.Builder has a new method.

• users(users)

CallsAddResponse has new methods.

• getCall()
• getReponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

CallsEndResponse has new methods.

• getCall()
• getResponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

CallsInfoResponse has new methods.

• getCall()
• getResponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

CallsParticipantsAddRequest.Builder has a new method.

• users(users)

CallsParticipantsAddResponse has new methods.

• getCall()
• getResponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

CallsParticipantsRemoveRequest.Builder has a new method.

• users(users)

CallsParticipantsRemoveResponse has new methods.

• getCall()
• getResponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

CallsUpdateResponse has new methods.

• getCall()
• getResponseMetadata()
• setCall(call)
• setResponseMetadata(responseMetadata)

ChatPostMessageReponse has new methods.

• getResponseMetadata()
• getMessage()
• setResponseMetadata(responseMetadata)
• setMessage(message)

ChatScheduleMessageResponse.ScheduledMessage has new methods.

• getBotProfile()
• setBotProfile(botProfile)

ChatScheduledMessagesListRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

ChatScheduledMessagesListResponse has new methods.

• getScheduledMessages()
• getResponseMetadata()
• setScheduledMessages(scheduledMessages)
• setResponseMetadata(responseMetadata)

ChatUpdateResponse has new methods.

• getMessage()
• setMessage(message)

ConversationsCreateResponse has new methods.

• getChannel()
• setChannel(channel)

ConversationsHistoryRequest.Builder has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

ConversationsHistoryResponse has new methods.

• getMessages()
• getResponseMetadata()
• setMessages(messages)
• setResponseMetadata(responseMetadata)

ConversationsInfoResponse has new methods.

• getChannel()
• setChannel(channel)

ConversationsInviteResponse has new methods.

• getChannel()
• getErrors()
• setChannel(channel)
• setErrors(errors)

ConversationsJoinResponse has new methods.

• getChannel()
• getResponseMetadata()
• setChannel()
• setResponseMetadata(responseMetadata)

ConversationsListRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

ConversationsListRequest.Builder has a new method.

• types(types)

ConversationsListResponse has new methods.

• getChannels()
• getResponseMetadata()
• setChannels()
• setResponseMetadata(responseMetadata)

ConversationsMarkResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

ConversationsMembersRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

ConversationsMembersResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

ConversationsOpenResponse has new methods.

• getChannel()
• setChannel(channel)

ConversationsRenameResponse has new methods.

• getChannel()
• setChannel(channel)

ConversationsRepliesRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

ConversationsRepliesResponse has new methods.

• getMessages()
• getResponseMetadata()
• setMessages(messages)
• setResponseMetadata(responseMetadata)

ConversationsSetPurposeResponse has new methods.

• getChannel()
• setChannel(channel)

ConversationsSetTopicResponse has new methods.

• getChannel()
• setChannel(channel)

DndTeamInfoResponse has new methods.

• getUsers()
• setUsers(users)

FilesInfoResponse has new methods.

• getFile()
• setFile(file)

FilesListReponse has new methods.

• getFiles()
• getPaging()
• setFiles(files)
• setPaging(paging)

FilesRemoteAddResponse has new methods.

• getFile()
• setFile(file)

FilesRemoteInfoResponse has new methods.

• getFile()
• setFile(file)

FilesRemoteListRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

FilesRemoteListResponse has new methods.

• getFiles()
• getResponseMetadata()
• setFiles(files)
• setResponseMetadata(metadata)

FilesRemoteShareResponse has new methods.

• getFile()
• setFile(file)

FilesRemoteUpdateResponse has new methods.

• getFile()
• setFile(file)

FilesRevokePublicURLResponse has new methods.

• getFile()
• setFile(file)

FilesSharedPublicURLResponse has new methods.

• getFile()
• setFile(file)

PinsAddResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

PinsListReponse has new methods.

• getItems()
• setItems(items)

PinsListResponse.MessageItem has new methods.

• getComment()
• getFile()
• getMessage()
• setComment(comment)
• setFile(file)
• setMessage(message)

ReactionsGetResponse.Message has new methods.

• getBotProfile()
• getReactions()
• setBotProfile(botProfile)
• setReactions(reactions)

RemindersAddRequest has changed.

• The atTime(atTime) method has been renamed to timeValue(timeValue).

RemindersAddResponse has new methods.

• getReminder()
• setReminder(reminder)

RemindersInfoResponse has new methods.

• getReminder()
• setReminder(reminder)

RemindersListResponse has new methods.

• getReminders()
• setReminders(reminders)

SearchAllRequest has changed.

• The sortType(sortType) method has been renamed to sortValue(sortValue).

SearchAllResponse has new methods.

• getMessages()
• getFiles()
• setMessages(messages)
• setFiles(files)

SearchFilesRequest has changed.

• The sortType(sortType) method has been renamed to sortValue(sortValue).

SearchFilesResponse has new methods.

• getFiles()
• setFiles(files)

SearchMessagesRequest has changed.

• The sortType(sortType) method has been renamed to sortValue(sortValue).

SearchMessagesResponse has new methods.

• getMessages()
• setMessages(messages)

TeamAccessLogsResponse has new methods.

• getLogins()
• getPaging()
• setLogins(logins)
• setPaging(paging)

TeamBillableInfoResponse has new methods.

• getBillableInfo()
• setBillableInfo(billableInfo)

TeamInfoResponse has new methods.

• getTeam()
• setTeam()

TeamIntegrationLogsResponse has new methods.

• getLogs()
• getPaging()
• setLogs(logs)
• setPaging(paging)

UserClient has new methods.

• reactionsList(req)
• starsList(req)

UsergroupsCreateResponse has new methods.

• getUsergroup()
• setUsergroup(usergroup)

UsergroupsDisableResponse has new methods.

• getUsergroup()
• setUsergroup(usergroup)

UsergroupsEnableResponse has new methods.

• getUsergroup()
• setUsergroup(usergroup)

UsergroupsListResponse has new methods.

• getUsergroups()
• setUsergroups(usergroups)

UsergroupsUpdateResponse has new methods.

• getUsergroup()
• setUsergroup(usergroup)

UsergroupsUsersUpdateResponse has new methods.

• getUsergroup()
• setUsergroup(usergroup)

UsersConversationsRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

UsersConversationsRequest.Builder has a new method.

• types(types)

UsersConversationsResponse has new methods.

• getChannels()
• getResponseMetadata()
• setChannels(channels)
• setResponseMetadata(responseMetadata)

UsersInfoResponse has new methods.

• getUser()
• setUser(user)

UsersListRequest has changed.

• The maxLimit(maxLimit) method has been renamed to limitValue(limitValue).

UsersListResponse has new methods.

• getMembers()
• getResponseMetadata()
• setMembers(members)
• setResponseMetadata(responseMetadata)

UsersLookupByEmailResponse has new methods.

• getUser()
• setUser(user)

ViewsOpenResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

ViewsPublishResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

ViewsPushResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

ViewsUpdateResponse has new methods.

• getResponseMetadata()
• setResponseMetadata(responseMetadata)

WorkflowsUpdateStepRequest has new methods.

• inputs(inputs)
• outputs(outputs)

These documentation changes are new for January 24, 2022.

• Updated Data Providers to add support for the Select component to use List<Slack.Option> and List<Slack.OptionGroup>.
• Renamed the Implement the External Select Component doc and updated the URL to Work with Options.

These documentation changes are new for January 14, 2022.

• Removed the label property from the checkbox group and radio group examples.

• Added an updated version of the sample app.

• Added User Permissions and Roles to provide an overview on user mapping between Slack and Salesforce.

• Updated Org Connections to include steps for user-mapping removal and a list of connection errors.

• Updated the request_url and redirect_url values in the example manifests on these pages.

  • Deploy a Slack App
  • Sample Apex SDK for Slack App

These documentation changes are new for December 20, 2021.

Added Asset Access to explain how Apex SDK for Slack validates access to an asset across namespaces.

Added examples to:

• ActionPayload
• ChatPostMessageRequest
• HomeView

Added information about events, and added an example of how to respond to the app_home_opened event.

Added information about label expressions and formula expressions.

Added information and basic guidelines about packaging Slack apps.

Added information about scopes and how to determine which scopes to use for an app.

• Added Onboarding with App Home to include examples of how to onboard users using the app_home_opened event.
• Added a note that views aren’t cached.