LogoLogo
  • Introduction
  • What's New?
  • Upgrade Guide
  • Getting Started
    • Requirements
    • Installation
  • Defining Channels
    • Configuration
    • Retrieving Channels
  • Creating and Sending Notifications
    • Defining Notifications
    • Notifiables
    • Sending Notifications
  • Providers
    • DatabaseProvider
    • EmailProvider
    • SlackProvider
      • Slack BlockKit
    • Creating Custom Providers
  • Testing
    • Coming Soon
  • Reference
    • NotificationService
    • BaseNotification
    • SendsNotifications
    • INotifiable
    • BaseProvider
      • DatabaseProvider
        • DatabaseNotificationService
        • HasDatabaseNotifications
        • DatabaseNotificationCursor
        • DatabaseNotification
      • EmailProvider
      • SlackProvider
        • SlackMessage
          • EventMetadata
          • ActionsBlock
          • ContextBlock
          • DividerBlock
          • HeaderBlock
          • ImageBlock
          • SectionBlock
          • ButtonElement
          • ConfirmObject
          • ImageElement
          • TextObject
          • PlainTextOnlyTextObject
  • ForgeBox
  • GitHub
Powered by GitBook
On this page
  • init
  • id
  • button
  • getMemento
  1. Reference
  2. BaseProvider
  3. SlackProvider
  4. SlackMessage

ActionsBlock

PreviousEventMetadataNextContextBlock

Last updated 1 year ago

init

Creates an ActionsBlock instance for the given event type and payload.

Slack Docs:

Name
Type
Required
Default
Description

No arguments

Return: The ActionsBlock instance.

id

Sets a custom identifier for the ActionsBlock instance.

Name
Type
Required
Default
Description

id

string

true

The custom identifier for the ActionsBlock instance.

Return: The ActionsBlock instance.

button

Adds a ButtonElement to this ActionsBlock instance.

Name
Type
Required
Default
Description

text

string

true

The text of the new button element.

Return: The new ButtonElement instance.

Throws: Megaphone.Provider.SlackBlockException when more than 25 elements are added.

getMemento

Converts the ActionsBlock instance to a serializable format.

Name
Type
Required
Default
Description

No arguments

Return: (struct) A struct representing this ActionsBlock instance.

Throws: Megaphone.Provider.SlackBlockException when either 0 or more than 25 elements are present.

{
    "type": "actions"
    "elements": [ ... ],
    "block_id": "optional"
}
https://api.slack.com/reference/block-kit/blocks#actions
ButtonElement