Files
sdk/docs/TransportCapabilities.md

7.6 KiB

TransportCapabilities

Properties

Name Type Description Notes
Actions Pointer to bool Actions is whether the transport renders an INTERACTIVE control natively, and it is the flag to read before composing one. The vocabulary is a closed kind-tagged union (envelope.go), exactly four kinds, each carrying only its own field plus an optional label: command — a bot command to run (`command`), rendered as a button that invokes it. url — an external link (`url`), rendered as a link button. select — a menu (`options`, each a label and the value choosing it returns), rendered as a picker. approval — a reference to an approval request (`approval.id`), rendered as approve/deny controls bound to that id. False on every transport, and nothing refuses a send for it: actions are accepted, validated per kind, and flattened by renderText to one line each after the text — `[label] command`, `[label] url`, `[label] opt opt`, `[label] approval requested: <id>`. So a caller that needs a real control must read this flag and degrade itself; a caller that only needs the choice communicated can send actions and take the text form.
Dm Pointer to bool DM is whether the transport carries a DIRECT message at all. True for slack, teams, telegram and whatsapp — whatsapp is nothing else, since the Cloud API addresses a person's number and there is no channel a third party joins. False for discord, honestly: that ingress is guild-scoped slash commands — an interaction without a guild id is refused at the endpoint — so nothing ever arrives classified as a DM, no reply route is ever learned for one, and a send addressed at a Discord DM is refused 409. [optional]
Edit Pointer to bool Edit is whether a sent message can be rewritten in place. True for slack alone. It is what lets a turn keep ONE message — progress, then the answer — and a transport without it shows the answer only. [optional]
Group Pointer to bool Group is whether the transport carries multi-person channels — a Discord guild transport, a Slack channel, a Teams channel or group chat, a Telegram group or supergroup. False on whatsapp alone, which has no such channel to carry. [optional]
Media Pointer to bool Media is whether the transport renders an ATTACHMENT natively. False everywhere, and a send is not refused for it: renderText flattens each attachment to one `kind: url (mime)` line after the text rather than dropping it. A transport whose egress passes the raw text straight through would drop the attachment instead, and an attachment-only send would reach the platform with nothing to say — which is why the flag and the flattening are pinned together. [optional]
Thread Pointer to bool Thread is whether a reply can be threaded UNDER a specific message. True for slack alone: it is the only transport whose ingress reports a thread (thread_ts, published as the envelope's replyTo) and whose send posts back into it. Discord's replyTo makes an inline reply rather than a thread, Telegram's and WhatsApp's each quote one message, and Teams carries no reply target at all — a replyTo sent to it is ignored. [optional]

Methods

NewTransportCapabilities

func NewTransportCapabilities() *TransportCapabilities

NewTransportCapabilities instantiates a new TransportCapabilities object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewTransportCapabilitiesWithDefaults

func NewTransportCapabilitiesWithDefaults() *TransportCapabilities

NewTransportCapabilitiesWithDefaults instantiates a new TransportCapabilities object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetActions

func (o *TransportCapabilities) GetActions() bool

GetActions returns the Actions field if non-nil, zero value otherwise.

GetActionsOk

func (o *TransportCapabilities) GetActionsOk() (*bool, bool)

GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetActions

func (o *TransportCapabilities) SetActions(v bool)

SetActions sets Actions field to given value.

HasActions

func (o *TransportCapabilities) HasActions() bool

HasActions returns a boolean if a field has been set.

GetDm

func (o *TransportCapabilities) GetDm() bool

GetDm returns the Dm field if non-nil, zero value otherwise.

GetDmOk

func (o *TransportCapabilities) GetDmOk() (*bool, bool)

GetDmOk returns a tuple with the Dm field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDm

func (o *TransportCapabilities) SetDm(v bool)

SetDm sets Dm field to given value.

HasDm

func (o *TransportCapabilities) HasDm() bool

HasDm returns a boolean if a field has been set.

GetEdit

func (o *TransportCapabilities) GetEdit() bool

GetEdit returns the Edit field if non-nil, zero value otherwise.

GetEditOk

func (o *TransportCapabilities) GetEditOk() (*bool, bool)

GetEditOk returns a tuple with the Edit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEdit

func (o *TransportCapabilities) SetEdit(v bool)

SetEdit sets Edit field to given value.

HasEdit

func (o *TransportCapabilities) HasEdit() bool

HasEdit returns a boolean if a field has been set.

GetGroup

func (o *TransportCapabilities) GetGroup() bool

GetGroup returns the Group field if non-nil, zero value otherwise.

GetGroupOk

func (o *TransportCapabilities) GetGroupOk() (*bool, bool)

GetGroupOk returns a tuple with the Group field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetGroup

func (o *TransportCapabilities) SetGroup(v bool)

SetGroup sets Group field to given value.

HasGroup

func (o *TransportCapabilities) HasGroup() bool

HasGroup returns a boolean if a field has been set.

GetMedia

func (o *TransportCapabilities) GetMedia() bool

GetMedia returns the Media field if non-nil, zero value otherwise.

GetMediaOk

func (o *TransportCapabilities) GetMediaOk() (*bool, bool)

GetMediaOk returns a tuple with the Media field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMedia

func (o *TransportCapabilities) SetMedia(v bool)

SetMedia sets Media field to given value.

HasMedia

func (o *TransportCapabilities) HasMedia() bool

HasMedia returns a boolean if a field has been set.

GetThread

func (o *TransportCapabilities) GetThread() bool

GetThread returns the Thread field if non-nil, zero value otherwise.

GetThreadOk

func (o *TransportCapabilities) GetThreadOk() (*bool, bool)

GetThreadOk returns a tuple with the Thread field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetThread

func (o *TransportCapabilities) SetThread(v bool)

SetThread sets Thread field to given value.

HasThread

func (o *TransportCapabilities) HasThread() bool

HasThread returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]