Google Apps Chat V1 Client - Class DeleteMessageRequest (0.6.0)

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

Request to delete a message.

Generated from protobuf message google.chat.v1.DeleteMessageRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. Resource name of the message. Format: spaces/{space}/messages/{message} If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.
↳ force bool

When true, deleting a message also deletes its threaded replies. When false, if a message has threaded replies, deletion fails. Only applies when authenticating as a user. Has no effect when authenticating as a Chat app.

getName

Required. Resource name of the message.

Format: spaces/{space}/messages/{message} If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.

Returns
Type Description
string

setName

Required. Resource name of the message.

Format: spaces/{space}/messages/{message} If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

When true, deleting a message also deletes its threaded replies. When false, if a message has threaded replies, deletion fails.

Only applies when authenticating as a user. Has no effect when authenticating as a Chat app.

Returns
Type Description
bool

setForce

When true, deleting a message also deletes its threaded replies. When false, if a message has threaded replies, deletion fails.

Only applies when authenticating as a user. Has no effect when authenticating as a Chat app.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of the message.

Format: spaces/{space}/messages/{message}

If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message. Please see Google\Apps\Chat\V1\ChatServiceClient::messageName() for help formatting this field.
Returns
Type Description
Google\Apps\Chat\V1\DeleteMessageRequest