Google Apps Chat V1 Client - Class SpaceEvent (0.6.1)

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

An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat.

Generated from protobuf message google.chat.v1.SpaceEvent

Namespace

Google \ Apps \ Chat \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Resource name of the space event. Format: spaces/{space}/spaceEvents/{spaceEvent}
↳ event_time Google\Protobuf\Timestamp

Time when the event occurred.
↳ event_type string

Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For spaceEvents.list() requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for messages: * * New message: google.workspace.chat.message.v1.created * * Updated message: google.workspace.chat.message.v1.updated * * Deleted message: google.workspace.chat.message.v1.deleted * * Multiple new messages: google.workspace.chat.message.v1.batchCreated * * Multiple updated messages: google.workspace.chat.message.v1.batchUpdated * * Multiple deleted messages: google.workspace.chat.message.v1.batchDeleted Supported event types for memberships: * * New membership: google.workspace.chat.membership.v1.created * * Updated membership: google.workspace.chat.membership.v1.updated * * Deleted membership: google.workspace.chat.membership.v1.deleted * * Multiple new memberships: google.workspace.chat.membership.v1.batchCreated * * Multiple updated memberships: google.workspace.chat.membership.v1.batchUpdated * * Multiple deleted memberships: google.workspace.chat.membership.v1.batchDeleted Supported event types for reactions: * * New reaction: google.workspace.chat.reaction.v1.created * * Deleted reaction: google.workspace.chat.reaction.v1.deleted * * Multiple new reactions: google.workspace.chat.reaction.v1.batchCreated * * Multiple deleted reactions: google.workspace.chat.reaction.v1.batchDeleted Supported event types about the space: * * Updated space: google.workspace.chat.space.v1.updated * * Multiple space updates: google.workspace.chat.space.v1.batchUpdated
↳ message_created_event_data MessageCreatedEventData

Event payload for a new message. Event type: google.workspace.chat.message.v1.created
↳ message_updated_event_data MessageUpdatedEventData

Event payload for an updated message. Event type: google.workspace.chat.message.v1.updated
↳ message_deleted_event_data MessageDeletedEventData

Event payload for a deleted message. Event type: google.workspace.chat.message.v1.deleted
↳ message_batch_created_event_data MessageBatchCreatedEventData

Event payload for multiple new messages. Event type: google.workspace.chat.message.v1.batchCreated
↳ message_batch_updated_event_data MessageBatchUpdatedEventData

Event payload for multiple updated messages. Event type: google.workspace.chat.message.v1.batchUpdated
↳ message_batch_deleted_event_data MessageBatchDeletedEventData

Event payload for multiple deleted messages. Event type: google.workspace.chat.message.v1.batchDeleted
↳ space_updated_event_data SpaceUpdatedEventData

Event payload for a space update. Event type: google.workspace.chat.space.v1.updated
↳ space_batch_updated_event_data SpaceBatchUpdatedEventData

Event payload for multiple updates to a space. Event type: google.workspace.chat.space.v1.batchUpdated
↳ membership_created_event_data MembershipCreatedEventData

Event payload for a new membership. Event type: google.workspace.chat.membership.v1.created
↳ membership_updated_event_data MembershipUpdatedEventData

Event payload for an updated membership. Event type: google.workspace.chat.membership.v1.updated
↳ membership_deleted_event_data MembershipDeletedEventData

Event payload for a deleted membership. Event type: google.workspace.chat.membership.v1.deleted
↳ membership_batch_created_event_data MembershipBatchCreatedEventData

Event payload for multiple new memberships. Event type: google.workspace.chat.membership.v1.batchCreated
↳ membership_batch_updated_event_data MembershipBatchUpdatedEventData

Event payload for multiple updated memberships. Event type: google.workspace.chat.membership.v1.batchUpdated
↳ membership_batch_deleted_event_data MembershipBatchDeletedEventData

Event payload for multiple deleted memberships. Event type: google.workspace.chat.membership.v1.batchDeleted
↳ reaction_created_event_data ReactionCreatedEventData

Event payload for a new reaction. Event type: google.workspace.chat.reaction.v1.created
↳ reaction_deleted_event_data ReactionDeletedEventData

Event payload for a deleted reaction. Event type: google.workspace.chat.reaction.v1.deleted
↳ reaction_batch_created_event_data ReactionBatchCreatedEventData

Event payload for multiple new reactions. Event type: google.workspace.chat.reaction.v1.batchCreated
↳ reaction_batch_deleted_event_data ReactionBatchDeletedEventData

Event payload for multiple deleted reactions. Event type: google.workspace.chat.reaction.v1.batchDeleted

getName

Resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Returns
Type Description
string

setName

Resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

Parameter
Name Description
var string
Returns
Type Description
$this

getEventTime

Time when the event occurred.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEventTime

clearEventTime

setEventTime

Time when the event occurred.

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

getEventType

Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For spaceEvents.list() requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version.

Supported event types for messages:

  • New message: google.workspace.chat.message.v1.created
  • Updated message: google.workspace.chat.message.v1.updated
  • Deleted message: google.workspace.chat.message.v1.deleted
  • Multiple new messages: google.workspace.chat.message.v1.batchCreated
  • Multiple updated messages: google.workspace.chat.message.v1.batchUpdated
  • Multiple deleted messages: google.workspace.chat.message.v1.batchDeleted Supported event types for memberships:
    • New membership: google.workspace.chat.membership.v1.created
    • Updated membership: google.workspace.chat.membership.v1.updated
    • Deleted membership: google.workspace.chat.membership.v1.deleted
    • Multiple new memberships: google.workspace.chat.membership.v1.batchCreated
    • Multiple updated memberships: google.workspace.chat.membership.v1.batchUpdated
    • Multiple deleted memberships: google.workspace.chat.membership.v1.batchDeleted Supported event types for reactions:
    • New reaction: google.workspace.chat.reaction.v1.created
    • Deleted reaction: google.workspace.chat.reaction.v1.deleted
    • Multiple new reactions: google.workspace.chat.reaction.v1.batchCreated
    • Multiple deleted reactions: google.workspace.chat.reaction.v1.batchDeleted Supported event types about the space:
    • Updated space: google.workspace.chat.space.v1.updated
    • Multiple space updates: google.workspace.chat.space.v1.batchUpdated
Returns
Type Description
string

setEventType

Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For spaceEvents.list() requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version.

Supported event types for messages:

  • New message: google.workspace.chat.message.v1.created
  • Updated message: google.workspace.chat.message.v1.updated
  • Deleted message: google.workspace.chat.message.v1.deleted
  • Multiple new messages: google.workspace.chat.message.v1.batchCreated
  • Multiple updated messages: google.workspace.chat.message.v1.batchUpdated
  • Multiple deleted messages: google.workspace.chat.message.v1.batchDeleted Supported event types for memberships:
    • New membership: google.workspace.chat.membership.v1.created
    • Updated membership: google.workspace.chat.membership.v1.updated
    • Deleted membership: google.workspace.chat.membership.v1.deleted
    • Multiple new memberships: google.workspace.chat.membership.v1.batchCreated
    • Multiple updated memberships: google.workspace.chat.membership.v1.batchUpdated
    • Multiple deleted memberships: google.workspace.chat.membership.v1.batchDeleted Supported event types for reactions:
    • New reaction: google.workspace.chat.reaction.v1.created
    • Deleted reaction: google.workspace.chat.reaction.v1.deleted
    • Multiple new reactions: google.workspace.chat.reaction.v1.batchCreated
    • Multiple deleted reactions: google.workspace.chat.reaction.v1.batchDeleted Supported event types about the space:
    • Updated space: google.workspace.chat.space.v1.updated
    • Multiple space updates: google.workspace.chat.space.v1.batchUpdated
Parameter
Name Description
var string
Returns
Type Description
$this

getMessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

Returns
Type Description
MessageCreatedEventData|null

hasMessageCreatedEventData

setMessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

Parameter
Name Description
var MessageCreatedEventData
Returns
Type Description
$this

getMessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

Returns
Type Description
MessageUpdatedEventData|null

hasMessageUpdatedEventData

setMessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

Parameter
Name Description
var MessageUpdatedEventData
Returns
Type Description
$this

getMessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

Returns
Type Description
MessageDeletedEventData|null

hasMessageDeletedEventData

setMessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

Parameter
Name Description
var MessageDeletedEventData
Returns
Type Description
$this

getMessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

Returns
Type Description
MessageBatchCreatedEventData|null

hasMessageBatchCreatedEventData

setMessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

Parameter
Name Description
var MessageBatchCreatedEventData
Returns
Type Description
$this

getMessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

Returns
Type Description
MessageBatchUpdatedEventData|null

hasMessageBatchUpdatedEventData

setMessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

Parameter
Name Description
var MessageBatchUpdatedEventData
Returns
Type Description
$this

getMessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

Returns
Type Description
MessageBatchDeletedEventData|null

hasMessageBatchDeletedEventData

setMessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

Parameter
Name Description
var MessageBatchDeletedEventData
Returns
Type Description
$this

getSpaceUpdatedEventData

Event payload for a space update.

Event type: google.workspace.chat.space.v1.updated

Returns
Type Description
SpaceUpdatedEventData|null

hasSpaceUpdatedEventData

setSpaceUpdatedEventData

Event payload for a space update.

Event type: google.workspace.chat.space.v1.updated

Parameter
Name Description
var SpaceUpdatedEventData
Returns
Type Description
$this

getSpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

Returns
Type Description
SpaceBatchUpdatedEventData|null

hasSpaceBatchUpdatedEventData

setSpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

Parameter
Name Description
var SpaceBatchUpdatedEventData
Returns
Type Description
$this

getMembershipCreatedEventData

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created

Returns
Type Description
MembershipCreatedEventData|null

hasMembershipCreatedEventData

setMembershipCreatedEventData

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created

Parameter
Name Description
var MembershipCreatedEventData
Returns
Type Description
$this

getMembershipUpdatedEventData

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

Returns
Type Description
MembershipUpdatedEventData|null

hasMembershipUpdatedEventData

setMembershipUpdatedEventData

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

Parameter
Name Description
var MembershipUpdatedEventData
Returns
Type Description
$this

getMembershipDeletedEventData

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

Returns
Type Description
MembershipDeletedEventData|null

hasMembershipDeletedEventData

setMembershipDeletedEventData

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

Parameter
Name Description
var MembershipDeletedEventData
Returns
Type Description
$this

getMembershipBatchCreatedEventData

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

Returns
Type Description
MembershipBatchCreatedEventData|null

hasMembershipBatchCreatedEventData

setMembershipBatchCreatedEventData

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

Parameter
Name Description
var MembershipBatchCreatedEventData
Returns
Type Description
$this

getMembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

Returns
Type Description
MembershipBatchUpdatedEventData|null

hasMembershipBatchUpdatedEventData

setMembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

Parameter
Name Description
var MembershipBatchUpdatedEventData
Returns
Type Description
$this

getMembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

Returns
Type Description
MembershipBatchDeletedEventData|null

hasMembershipBatchDeletedEventData

setMembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

Parameter
Name Description
var MembershipBatchDeletedEventData
Returns
Type Description
$this

getReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

Returns
Type Description
ReactionCreatedEventData|null

hasReactionCreatedEventData

setReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

Parameter
Name Description
var ReactionCreatedEventData
Returns
Type Description
$this

getReactionDeletedEventData

Event payload for a deleted reaction.

Event type: google.workspace.chat.reaction.v1.deleted

Returns
Type Description
ReactionDeletedEventData|null

hasReactionDeletedEventData

setReactionDeletedEventData

Event payload for a deleted reaction.

Event type: google.workspace.chat.reaction.v1.deleted

Parameter
Name Description
var ReactionDeletedEventData
Returns
Type Description
$this

getReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

Returns
Type Description
ReactionBatchCreatedEventData|null

hasReactionBatchCreatedEventData

setReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

Parameter
Name Description
var ReactionBatchCreatedEventData
Returns
Type Description
$this

getReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

Returns
Type Description
ReactionBatchDeletedEventData|null

hasReactionBatchDeletedEventData

setReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

Parameter
Name Description
var ReactionBatchDeletedEventData
Returns
Type Description
$this

getPayload

Returns
Type Description
string