Class ops.Member
Defined in: Member.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
ops.Member(memberId, properties)
Class to represent a member in WebODF.
|
| Method Attributes | Method Name and Description |
|---|---|
| <inner> |
Returns the member ID of the member
|
| <inner> |
Returns the properties of the member
(including fullName, color, and imageUrl)
|
| <inner> |
removeProperties(removedProperties)
Removes the properties specified in the object.
|
| <inner> |
setProperties(newProperties)
Sets some properties on the member
|
Class Detail
ops.Member(memberId, properties)
Class to represent a member in WebODF.
A member is uniquely identified by it's memberId,
and this class encapsulates various things like
the full name and also custom properties that can represent
information like the avatar image, color, etc.
Custom properties that may contain some reserved keys such as fullName
(string), imageUrl (string representing a URL) and color (string
representing CSS color value) can be passed.
- Parameters:
- {!string} memberId
- The unique identifier of this member.
- {!ops.MemberProperties} properties
Method Detail
<inner>
{!string}
getMemberId()
Returns the member ID of the member
- Returns:
- {!string}
<inner>
{!ops.MemberProperties}
getProperties()
Returns the properties of the member
(including fullName, color, and imageUrl)
- Returns:
- {!ops.MemberProperties}
<inner>
{undefined}
removeProperties(removedProperties)
Removes the properties specified in the object.
'fullName', 'color', and 'imageUrl' are not
removable, they will be filtered out of
removedProperties if found.
- Parameters:
-
{!Object.
- Returns:
- {undefined}
<inner>
{undefined}
setProperties(newProperties)
Sets some properties on the member
- Parameters:
- {!Object.} newProperties
- Returns:
- {undefined}
