Class: BaseModelEvent

Properties
bubbles boolean

Whether this event bubbles.

compoundOperationNames Array of string

The list of names from the hierarchy of compound operations that initiated this event.

isLocal boolean

True if this event originated in the local session.

isRedo boolean

True if this event originated from a redo call.

isUndo boolean

True if this event originated from an undo call.

preventDefault void

Prevents an event from performing its default action. In the Realtime API, this function is only present for compatibility with the DOM event interface and therefore it does nothing.

sessionId string

The id of the session that initiated this event.

target Object

The collaborative object that initiated this event.

type string

The type of the event.

userId string

The user id of the user that initiated this event.

Method
stopPropagation() void

Stops an event which bubbles from propagating to the target's parent.

new BaseModelEvent(type, target, sessionId, userId, compoundOperationNames, isLocal, isUndo, isRedo)

Parameters

Name Type Optional Description

type

gapi.drive.realtime.EventType

 

The type of the event.

Value must not be null.

target

gapi.drive.realtime.CollaborativeObject

 

The collaborative object that initiated the event.

Value must not be null.

sessionId

string

 

The id of the session that initiated the event.

userId

string

 

The user id of the user that initiated the event.

compoundOperationNames

Array of string

 

The list of names from the hierarchy of compound operations that initiated the event.

Value must not be null.

isLocal

boolean

 

True if the event originated in the local session.

isUndo

boolean

 

True if the event originated from an undo call.

isRedo

boolean

 

True if the event originated from a redo call.

Properties

bubbles  boolean

Whether this event bubbles.

compoundOperationNames  Array of string

The list of names from the hierarchy of compound operations that initiated this event.

isLocal  boolean

True if this event originated in the local session.

isRedo  boolean

True if this event originated from a redo call.

isUndo  boolean

True if this event originated from an undo call.

preventDefault

Prevents an event from performing its default action. In the Realtime API, this function is only present for compatibility with the DOM event interface and therefore it does nothing.

sessionId  string

The id of the session that initiated this event.

target  Object

The collaborative object that initiated this event.

type  string

The type of the event.

userId  string

The user id of the user that initiated this event.

Method

stopPropagation()

Stops an event which bubbles from propagating to the target's parent.

Send feedback about...

Realtime API
Realtime API