PHP Class Maknz\Slack\AttachmentAction

Show file Open project: maknz/slack

Protected Properties

Property Type Description
$confirm ActionConfirmation Confirmation field.
$name string The required name field of the action. The name will be returned to your Action URL.
$style string Button style.
$text string The required label for the action.
$type string The required type of the action.
$value string Optional value. It will be sent to your Action URL.

Public Methods

Method Description
__construct ( array $attributes ) : void Instantiate a new AttachmentAction.
getConfirm ( ) : ActionConfirmation
getName ( ) : string
getStyle ( ) : string
getText ( ) : string
getType ( ) : string
getValue ( ) : string
setConfirm ( ActionConfirmation | array $confirm ) : AttachmentAction
setName ( string $name ) : AttachmentAction
setStyle ( string $style ) : AttachmentAction
setText ( string $text ) : AttachmentAction
setType ( string $type ) : AttachmentAction
setValue ( string $value ) : AttachmentAction
toArray ( ) : array Get the array representation of this attachment action.

Method Details

__construct() public method

Instantiate a new AttachmentAction.
public __construct ( array $attributes ) : void
$attributes array
return void

getConfirm() public method

public getConfirm ( ) : ActionConfirmation
return ActionConfirmation

getName() public method

public getName ( ) : string
return string

getStyle() public method

public getStyle ( ) : string
return string

getText() public method

public getText ( ) : string
return string

getType() public method

public getType ( ) : string
return string

getValue() public method

public getValue ( ) : string
return string

setConfirm() public method

public setConfirm ( ActionConfirmation | array $confirm ) : AttachmentAction
$confirm ActionConfirmation | array
return AttachmentAction

setName() public method

public setName ( string $name ) : AttachmentAction
$name string
return AttachmentAction

setStyle() public method

public setStyle ( string $style ) : AttachmentAction
$style string
return AttachmentAction

setText() public method

public setText ( string $text ) : AttachmentAction
$text string
return AttachmentAction

setType() public method

public setType ( string $type ) : AttachmentAction
$type string
return AttachmentAction

setValue() public method

public setValue ( string $value ) : AttachmentAction
$value string
return AttachmentAction

toArray() public method

Get the array representation of this attachment action.
public toArray ( ) : array
return array

Property Details

$confirm protected property

Confirmation field.
protected ActionConfirmation,Maknz\Slack $confirm
return ActionConfirmation

$name protected property

The required name field of the action. The name will be returned to your Action URL.
protected string $name
return string

$style protected property

Button style.
protected string $style
return string

$text protected property

The required label for the action.
protected string $text
return string

$type protected property

The required type of the action.
protected string $type
return string

$value protected property

Optional value. It will be sent to your Action URL.
protected string $value
return string