Google Apps Chat V1 Client - Class UpdateMessageRequest (0.15.0)

Reference documentation and code samples for the Google Apps Chat V1 Client class UpdateMessageRequest.

Request to update a message.

Generated from protobuf message google.chat.v1.UpdateMessageRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ message Message

Required. Message with fields updated.
↳ update_mask Google\Protobuf\FieldMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths. Currently supported field paths: - text - attachment - cards (Requires app authentication.) - cards_v2 (Requires app authentication.) - accessory_widgets (Requires app authentication.) - quoted_message_metadata (Only allows removal of the quoted message.)
↳ allow_missing bool

Optional. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

getMessage

Required. Message with fields updated.

Returns
Type Description
Message|null

hasMessage

clearMessage

setMessage

Required. Message with fields updated.

Parameter
Name Description
var Message
Returns
Type Description
$this

getUpdateMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getAllowMissing

Optional. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

Returns
Type Description
bool

setAllowMissing

Optional. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
message Message

Required. Message with fields updated.
updateMask Google\Protobuf\FieldMask

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:
Returns
Type Description
UpdateMessageRequest