Class: CultureEvent

CultureEvent(data)

Class representing a Culture Event (our internal term in the software. In the UI and in Engage, this is called a General Recorder file.) When the user records something with the General Recorder, multiple GeneralRecording objects will be created as the user switches between audio and video modes, or takes pictures while recording is paused. When the user is done recording, he enters metadata, and saves. At that point one of these CultureEvent objects is created. So a CultureEvent is a creation of the General Recorder, and includes: - potentially multiple GeneralRecordings - metadata about the setting, etc. - the results of the user processing the recording (transcribing, tagging, etc.)

Constructor

new CultureEvent(data)

Creates a CultureEvent object
Parameters:
Name Type Description
data CultureEvent | Object
Source:

Extends

Members

_id :string

Unique ID for the Culture Event
Type:
  • string
Default Value:
  • ''
Source:

activityPlanIds :Array.<string>

_id's of the ActivityPlans this CLA File is linked to. If empty array, this CLA File was created without an ActivityPlan. To find a specific task in an ActivityPlan that is linked to this CLA File, search through the ActivityPlan's tasks for this CLA File's _id in taskClaFileId. _id's are appended to the end of the list when this CLA File is linked to an ActivityPlan. So, the first ActivityPlan in the list is the one this CLA File was created through (or if the CLA File was not created through an Activity Plan, the first ActivityPlan this CLA File was linked to), unless the user explicitly disassociates this CLA File from that original ActivityPlan.
Type:
  • Array.<string>
Overrides:
Source:

audience :string

The audience of the event
Type:
  • string
Default Value:
  • ''
Source:

canLinkToTask :boolean

if true, show this item in Pending (unless deferToStage prevents it)
Type:
  • boolean
Overrides:
Source:

claUnit :number

What overall CLA unit is this user in?
Type:
  • number
Default Value:
  • 1
Source:

date :string

ISO Date (e.g., '2022-06-20T15:50:40.055Z'), when the CultureEvent was initially saved
Type:
  • string
Default Value:
  • ''
Source:

deferToStage :number

Do not show this item in Pending until User.getClaStageNumber() of the user's CLA Stage is at least this number.
Type:
  • number
Overrides:
Source:

fileNumber :number

file number
Type:
  • number
Overrides:
Source:

generalRecordings :Array.<string>

Array of GeneralRecording Item IDs for all GeneralRecordings that make up this CultureEvent. The General Recorder in the mobile app creates a new GeneralRecording item when the user switches between audio, video, or takes a picture while recording is paused.
Type:
  • Array.<string>
Default Value:
  • []
Source:

imported :boolean

true if the file was imported from a previous export
Type:
  • boolean
Overrides:
Source:

linkedFiles :Array.<string>

Array of file numbers (not _id's)
Type:
  • Array.<string>
Overrides:
Default Value:
  • []
Source:

location :string

Location ID of where the event took place
Type:
  • string
Default Value:
  • ''
Source:

note :string

Event notes
Type:
  • string
Default Value:
  • ''
Source:

phoneticTranscription :string

Phonetic Transcription in plain text. Per Bill, we do not support splitting the phonetic text into sections like we do with the orthographic text. Phonetic text for a CultureEvent is stored all in one simple string.
Type:
  • string
Default Value:
  • ''
Source:

readOnly :boolean

true if we should prevent editing the file
Type:
  • boolean
Overrides:
Source:

searchWords :Array.<string>

Array of IDs of search words
Type:
  • Array.<string>
Default Value:
  • []
Source:

speakers :Array.<string>

Array of Person IDs of those who spoke in the generalRecordings of this CultureEvent
Type:
  • Array.<string>
Default Value:
  • []
Source:

tags :Array.<string>

Array of strings from Tag.tagText
Type:
  • Array.<string>
Source:

title :string

Title of the event
Type:
  • string
Default Value:
  • ''
Source:

Methods

claFileType()

The type of CLA File this is (e.g., CultureEvent, DRE) This method must be overridden in any class that extends CLAFile
Overrides:
Source:

isCE() → {boolean}

returns true if this CLAFile is a CultureEvent
Overrides:
Source:
Returns:
Type
boolean

isDRE() → {boolean}

returns true if this CLAFile is a DRE
Overrides:
Source:
Returns:
Type
boolean

isPE() → {boolean}

returns true if this CLAFile is a PE
Overrides:
Source:
Returns:
Type
boolean

set(data) → {CultureEvent}

Creates an updated CultureEvent object
Parameters:
Name Type Description
data CultureEvent | Object
Source:
Returns:
Type
CultureEvent