This API is deprecated and will be turned down in January 2019. Migrate to Cloud Firestore or another data store as soon as possible to avoid disruptions to your application.

Class: ValuesRemovedEvent

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.

index number

The index of the first removed value.

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.

movedToIndex number

The index in the collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

movedToList gapi.drive.realtime.CollaborativeList

The collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

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.

values Array of any type

The values that were removed.

Method
stopPropagation() void

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

new ValuesRemovedEvent(target, sessionId, userId, compoundOperationNames, isLocal, isUndo, isRedo, index, values, movedToList, movedToIndex)

Parameters

Name Type Optional Description

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.

index

number

 

The index of the first added value.

values

Array of any type

 

The values that were added.

Value must not be null.

movedToList

gapi.drive.realtime.CollaborativeList

 

The collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

movedToIndex

number

 

The index in the collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

Extends
gapi.drive.realtime.BaseModelEvent

Properties

bubbles  boolean

Whether this event bubbles.

Inherited from
gapi.drive.realtime.BaseModelEvent#bubbles

compoundOperationNames  Array of string

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

Inherited from
gapi.drive.realtime.BaseModelEvent#compoundOperationNames

index  number

The index of the first removed value.

isLocal  boolean

True if this event originated in the local session.

Inherited from
gapi.drive.realtime.BaseModelEvent#isLocal

isRedo  boolean

True if this event originated from a redo call.

Inherited from
gapi.drive.realtime.BaseModelEvent#isRedo

isUndo  boolean

True if this event originated from an undo call.

Inherited from
gapi.drive.realtime.BaseModelEvent#isUndo

movedToIndex  number

The index in the collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

movedToList  gapi.drive.realtime.CollaborativeList

The collaborative list that the values were moved to, or null if this delete is not the result of a move operation.

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.

Inherited from
gapi.drive.realtime.BaseModelEvent#preventDefault

sessionId  string

The id of the session that initiated this event.

Inherited from
gapi.drive.realtime.BaseModelEvent#sessionId

target  Object

The collaborative object that initiated this event.

Inherited from
gapi.drive.realtime.BaseModelEvent#target

type  string

The type of the event.

Inherited from
gapi.drive.realtime.BaseModelEvent#type

userId  string

The user id of the user that initiated this event.

Inherited from
gapi.drive.realtime.BaseModelEvent#userId

values  Array of any type

The values that were removed.

Method

stopPropagation()

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

Inherited from
gapi.drive.realtime.BaseModelEvent#stopPropagation

Send feedback about...

Realtime API
Realtime API