1. class
  2. Hypervel
  3. \
  4. Notifications
  5. \
  6. Slack
  7. \
  8. BlockKit
  9. \
  10. Composites
  11. \
  12. TextObject

TextObject

class TextObject extends PlainTextOnlyTextObject

Properties

protected string $text

The formatting to use for this text object.

 from  PlainTextOnlyTextObject
protected bool|null $emoji

Indicates whether emojis in a text field should be escaped into the colon emoji format.

 from  PlainTextOnlyTextObject
protected string $type

The formatting to use for this text object.
protected bool|null $verbatim

Whether to skip any preprocessing / auto-conversion of URLs, conversation names, and certain mentions.

Methods

__construct(string $text, int $maxLength = 3000, int $minLength = 1)

Create a new plain text only text object instance.

from  PlainTextOnlyTextObject
PlainTextOnlyTextObject
emoji()

Indicate that emojis should be escaped into the colon emoji format.

from  PlainTextOnlyTextObject
array
toArray()

Get the instance as an array.

TextObject
markdown()

Changes the formatting of this text object to mrkdwn.

TextObject
verbatim()

Indicate that URLs, conversation names and certain mentions should not be auto-linked.

Details

in PlainTextOnlyTextObject at line 25
__construct(string $text, int $maxLength = 3000, int $minLength = 1)

Create a new plain text only text object instance.

Parameters

string $text
int $maxLength
int $minLength

in PlainTextOnlyTextObject at line 41
PlainTextOnlyTextObject emoji()

Indicate that emojis should be escaped into the colon emoji format.

Return Value

PlainTextOnlyTextObject

at line 50
array toArray()

Get the instance as an array.

Return Value

array

at line 28
TextObject markdown()

Changes the formatting of this text object to mrkdwn.

Return Value

TextObject

at line 40
TextObject verbatim()

Indicate that URLs, conversation names and certain mentions should not be auto-linked.

Only applicable for mrkdwn text objects.

Return Value

TextObject