Google Apps Chat V1 Client - Class MarkAsDoNotDisturbRequest (0.23.0)

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

Request message for the MarkAsDoNotDisturb method.

Generated from protobuf message google.chat.v1.MarkAsDoNotDisturbRequest

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789. The user's email address or me can also be used as an alias to refer to the caller. For example, users/user\@example.com or users/me.

↳ expire_time Google\Protobuf\Timestamp

The absolute timestamp when the DND state expires.

↳ ttl Google\Protobuf\Duration

The duration from the current time until the DND state expires.

getName

Required. The resource name of the availability to mark as Do Not Disturb.

Format: users/{user}/availability {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789. The user's email address or me can also be used as an alias to refer to the caller. For example, users/user\@example.com or users/me.

Returns
Type Description
string

setName

Required. The resource name of the availability to mark as Do Not Disturb.

Format: users/{user}/availability {user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789. The user's email address or me can also be used as an alias to refer to the caller. For example, users/user\@example.com or users/me.

Parameter
Name Description
var string
Returns
Type Description
$this

getExpireTime

The absolute timestamp when the DND state expires.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExpireTime

setExpireTime

The absolute timestamp when the DND state expires.

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

getTtl

The duration from the current time until the DND state expires.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

setTtl

The duration from the current time until the DND state expires.

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

getExpiration

Returns
Type Description
string