2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2023-01-03 13:54:27 +01:00
< title > JSDoc: Class: BOption< / title >
2018-08-29 20:44:35 +02:00
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
2023-01-03 13:54:27 +01:00
< h1 class = "page-title" > Class: BOption< / h1 >
2018-08-29 20:44:35 +02:00
< section >
< header >
2023-01-03 13:54:27 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > BOption< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
2023-07-15 12:07:45 +02:00
< div class = "class-description" > Option represents a name-value pair, either directly configurable by the user or some system property.< / div >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "BOption" > < span class = "type-signature" > < / span > new BOption< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2019-11-16 19:07:32 +01:00
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "becca_entities_boption.js.html" > becca/entities/boption.js< / a > , < a href = "becca_entities_boption.js.html#line11" > line 11< / a >
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
2022-04-16 00:17:32 +02:00
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
2023-01-03 13:54:27 +01:00
< li > < a href = "AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > < / li >
2022-04-16 00:17:32 +02:00
< / ul >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h3 class = "subsection-title" > Members< / h3 >
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "becca" > < span class = "type-signature" > (protected) < / span > becca< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#becca" > AbstractBeccaEntity#becca< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line55" > line 55< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "isSynced" > < span class = "type-signature" > < / span > isSynced< span class = "type-signature" > :boolean< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
< / li >
< / ul >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:00:37 +02:00
< a href = "becca_entities_boption.js.html" > becca/entities/boption.js< / a > , < a href = "becca_entities_boption.js.html#line29" > line 29< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:00:37 +02:00
< a href = "becca_entities_boption.js.html" > becca/entities/boption.js< / a > , < a href = "becca_entities_boption.js.html#line25" > line 25< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "utcDateModified" > < span class = "type-signature" > < / span > utcDateModified< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:00:37 +02:00
< a href = "becca_entities_boption.js.html" > becca/entities/boption.js< / a > , < a href = "becca_entities_boption.js.html#line31" > line 31< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "value" > < span class = "type-signature" > < / span > value< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / li >
< / ul >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:00:37 +02:00
< a href = "becca_entities_boption.js.html" > becca/entities/boption.js< / a > , < a href = "becca_entities_boption.js.html#line27" > line 27< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-04-16 00:17:32 +02:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "_getContent" > < span class = "type-signature" > (protected) < / span > _getContent< span class = "signature" > ()< / span > < span class = "type-signature" > → {string|Buffer}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractBeccaEntity.html#_getContent" > AbstractBeccaEntity#_getContent< / a >
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-08-10 13:40:26 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line246" > line 246< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
|
< span class = "param-type" > Buffer< / span >
< / dd >
< / dl >
< h4 class = "name" id = "_setContent" > < span class = "type-signature" > (protected) < / span > _setContent< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractBeccaEntity.html#_setContent" > AbstractBeccaEntity#_setContent< / a >
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line124" > line 124< / a >
< / li > < / ul > < / dd >
< / dl >
2022-06-19 14:06:00 +02:00
< h4 class = "name" id = "beforeSaving" > < span class = "type-signature" > (protected) < / span > beforeSaving< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#beforeSaving" > AbstractBeccaEntity#beforeSaving< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line20" > line 20< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
< h4 class = "name" id = "generateHash" > < span class = "type-signature" > (protected) < / span > generateHash< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#generateHash" > AbstractBeccaEntity#generateHash< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line32" > line 32< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
< h4 class = "name" id = "generateIdIfNecessary" > < span class = "type-signature" > (protected) < / span > generateIdIfNecessary< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#generateIdIfNecessary" > AbstractBeccaEntity#generateIdIfNecessary< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line25" > line 25< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
< h4 class = "name" id = "getPojoToSave" > < span class = "type-signature" > (protected) < / span > getPojoToSave< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#getPojoToSave" > AbstractBeccaEntity#getPojoToSave< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line76" > line 76< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
< h4 class = "name" id = "getUtcDateChanged" > < span class = "type-signature" > (protected) < / span > getUtcDateChanged< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#getUtcDateChanged" > AbstractBeccaEntity#getUtcDateChanged< / a >
2022-06-19 14:06:00 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line47" > line 47< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-19 14:06:00 +02:00
< / dl >
2022-04-16 00:17:32 +02:00
< h4 class = "name" id = "markAsDeleted" > < span class = "type-signature" > < / span > markAsDeleted< span class = "signature" > (deleteId< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
2023-08-21 04:17:16 -04:00
Mark the entity as (soft) deleted. It will be completely erased later.
This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
2022-04-16 00:17:32 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > deleteId< / code > < / td >
< td class = "type" >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
null
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#markAsDeleted" > AbstractBeccaEntity#markAsDeleted< / a >
2022-04-16 00:17:32 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-08-10 13:40:26 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line263" > line 263< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "putEntityChange" > < span class = "type-signature" > (protected) < / span > putEntityChange< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
< a href = "AbstractBeccaEntity.html#putEntityChange" > AbstractBeccaEntity#putEntityChange< / a >
< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line64" > line 64< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-04-16 00:17:32 +02:00
< / dl >
2022-12-29 23:12:38 +01:00
< h4 class = "name" id = "save" > < span class = "type-signature" > < / span > save< span class = "signature" > ()< / span > < span class = "type-signature" > → {this}< / span > < / h4 >
2022-04-16 00:17:32 +02:00
< div class = "description" >
Saves entity - executes SQL, but doesn't commit the transaction on its own
< / div >
< dl class = "details" >
< dt class = "tag-overrides" > Overrides:< / dt >
< dd class = "tag-overrides" > < ul class = "dummy" > < li >
2023-01-03 13:54:27 +01:00
< a href = "AbstractBeccaEntity.html#save" > AbstractBeccaEntity#save< / a >
2022-04-16 00:17:32 +02:00
< / li > < / ul > < / dd >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-06-29 20:54:58 +02:00
< a href = "becca_entities_abstract_becca_entity.js.html" > becca/entities/abstract_becca_entity.js< / a > , < a href = "becca_entities_abstract_becca_entity.js.html#line85" > line 85< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
2022-04-16 00:17:32 +02:00
< h5 > Returns:< / h5 >
2021-11-10 21:30:54 +01:00
2022-04-16 00:17:32 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-12-29 23:12:38 +01:00
< span class = "param-type" > this< / span >
2022-04-16 00:17:32 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
2018-08-29 20:44:35 +02:00
2022-04-16 00:17:32 +02:00
2018-08-29 20:44:35 +02:00
< / article >
< / section >
< / div >
< nav >
2023-08-21 04:17:16 -04:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Modules< / h3 > < ul > < li > < a href = "module-sql.html" > sql< / a > < / li > < / ul > < h3 > Classes< / h3 > < ul > < li > < a href = "AbstractBeccaEntity.html" > AbstractBeccaEntity< / a > < / li > < li > < a href = "BAttachment.html" > BAttachment< / a > < / li > < li > < a href = "BAttribute.html" > BAttribute< / a > < / li > < li > < a href = "BBranch.html" > BBranch< / a > < / li > < li > < a href = "BEtapiToken.html" > BEtapiToken< / a > < / li > < li > < a href = "BNote.html" > BNote< / a > < / li > < li > < a href = "BOption.html" > BOption< / a > < / li > < li > < a href = "BRecentNote.html" > BRecentNote< / a > < / li > < li > < a href = "BRevision.html" > BRevision< / a > < / li > < li > < a href = "BackendScriptApi.html" > BackendScriptApi< / a > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#api" > api< / a > < / li > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2023-05-31 14:00:37 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.2< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
