Class: Collaborator

Properties
color string

The HTML color associated with this collaborator. When possible, collaborators are assigned unique colors.

displayName string

The display name for this collaborator.

isAnonymous boolean

True if this collaborator is anonymous, false otherwise.

isMe boolean

True if this collaborator is the local user, false otherwise.

permissionId string

The permission ID for this collaborator. This ID is stable for a given user and is compatible with the Drive API permissions APIs. Use the userId property for all other uses.

photoUrl string

A URL that points to the profile photo for this collaborator, or to a generic profile photo for anonymous collaborators.

sessionId string

The session ID for this collaborator. A single user may have multiple sessions if they have the same document open on multiple devices or in multiple browser tabs.

userId string

The user ID for this collaborator. This ID is stable for a given user and is compatible with most Google APIs except the Drive API permission APIs. For an ID which is compatible with the Drive API permission APIs, use the permissionId property.

new Collaborator(sessionId, userId, displayName, color, isMe, isAnonymous, photoUrl, permissionId)

A collaborator on the document.

Parameters

Name Type Optional Description

sessionId

string

 

The session ID for the collaborator.

userId

string

 

The user ID for the collaborator.

displayName

string

 

The display name for the collaborator.

color

string

 

The HTML color associated with this collaborator.

isMe

boolean

 

True if the collaborator is the local user, false otherwise.

isAnonymous

boolean

 

True if the collaborator is anonymous, false otherwise.

photoUrl

string

 

A URL that points to the profile photo of the collaborator

permissionId

string

 

The permission ID for the collaborator.

Properties

color  string

The HTML color associated with this collaborator. When possible, collaborators are assigned unique colors.

displayName  string

The display name for this collaborator.

isAnonymous  boolean

True if this collaborator is anonymous, false otherwise.

isMe  boolean

True if this collaborator is the local user, false otherwise.

permissionId  string

The permission ID for this collaborator. This ID is stable for a given user and is compatible with the Drive API permissions APIs. Use the userId property for all other uses.

photoUrl  string

A URL that points to the profile photo for this collaborator, or to a generic profile photo for anonymous collaborators.

sessionId  string

The session ID for this collaborator. A single user may have multiple sessions if they have the same document open on multiple devices or in multiple browser tabs.

userId  string

The user ID for this collaborator. This ID is stable for a given user and is compatible with most Google APIs except the Drive API permission APIs. For an ID which is compatible with the Drive API permission APIs, use the permissionId property.

Send feedback about...

Realtime API
Realtime API