GedcomX FS JS Class: Comment

new Comment( [json])

Comment on a discussion

Parameters:

Name	Type	Argument	Description
`json`	Object	<optional>

Extends

ExtensibleData

Methods

addField(field)

Add a field

Parameters:

Name	Type	Description
`field`	Field

Inherited From:

ExtensibleData#addField

Returns:

this

Type: ExtensibleData

addLink(link)

Add a link

Parameters:

Name	Type	Description
`link`	Link

Inherited From:

ExtensibleData#addLink

Returns:

this

Type: ExtensibleData

getContributor()

Get the contributor

Returns:

contributor

Type: ResourceReference

getCreated()

Get the created

Returns:

created

Type: Date

getFields()

Get the fields

Inherited From:

ExtensibleData#getFields

Returns:

Type: Array.<Field>

getId()

Get the object's id.

Inherited From:

ExtensibleData#getId

Returns:

Type: String

getLink(rel)

Get a link

Parameters:

Name	Type	Description
`rel`	String

Inherited From:

ExtensibleData#getLink

Returns:

Type: Link

getLinks()

Get the links

Inherited From:

ExtensibleData#getLinks

Returns:

Type: Array.<Link>

getText()

Get the text

Returns:

text

Type: String

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

ExtensibleData#init

Returns:

Comment this

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setContributor(contributor)

Set the contributor

Parameters:

Name	Type	Description
`contributor`	ResourceReference

Returns:

this

Type: Comment

setCreated(created)

Set the created

Parameters:

Name	Type	Description
`created`	Date \| Integer

Returns:

this

Type: Comment

setFields(fields)

Set the fields

Parameters:

Name	Type	Description
`fields`	Array.<Field>

Inherited From:

ExtensibleData#setFields

Returns:

this

Type: ExtensibleData

setId(id)

Set the object's id.

Parameters:

Name	Type	Description
`id`	String

Inherited From:

ExtensibleData#setId

Returns:

This object, for chaining.

Type: ExtensibleData

setLinks(links)

Set the links

Parameters:

Name	Type	Description
`links`	Links

Inherited From:

ExtensibleData#setLinks

Returns:

this

Type: ExtensibleData

setText(text)

Set the text

Parameters:

Name	Type	Description
`text`	String

Returns:

this

Type: Comment

toJSON()

Export the object as JSON

Overrides:

ExtensibleData#toJSON

Returns:

JSON object

Type: Object