npm - @elliemae/pui-scripting-object - Versions diffs - 1.55.0 → 1.56.1 - Mend

@elliemae/pui-scripting-object 1.55.0 → 1.56.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (289) hide show

package/build/docs/assets/js/{deb01a76.b0489e25.js → deb01a76.04dc34de.js} RENAMED Viewed

	@@ -1 +1 @@
1	- "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object\|\|[]).push([[1453],{47849:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/interfaces/ILoan","title":"ILoan","description":"Methods & Events for interacting with an open loan in the application","source":"@site/docs/api/interfaces/ILoan.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/ILoan","permalink":"/scripting-object/api/interfaces/ILoan","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/ILoan.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IHttp","permalink":"/scripting-object/api/interfaces/IHttp"},"next":{"title":"IMemStorage","permalink":"/scripting-object/api/interfaces/IMemStorage"}}');var s=l(86070),r=l(90116);const a={},t="ILoan",c={},d=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"_dispose()?",id:"_dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"_toJSON()",id:"_tojson",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"all()",id:"all",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Example",id:"example",level:4},{value:"applyLock()",id:"applylock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"fieldId",id:"fieldid",level:5},{value:"lock",id:"lock",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Example",id:"example-1",level:4},{value:"calculate()",id:"calculate",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Example",id:"example-2",level:4},{value:"commit()",id:"commit",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-3",level:4},{value:"execAction()",id:"execaction",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"type",id:"type",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-6",level:4},{value:"Example",id:"example-4",level:4},{value:"getCollection()",id:"getcollection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"name",id:"name",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Throws",id:"throws",level:4},{value:"Example",id:"example-5",level:4},{value:"getCurrentApplication()",id:"getcurrentapplication",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Example",id:"example-6",level:4},{value:"getField()",id:"getfield",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"id",id:"id",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Throws",id:"throws-1",level:4},{value:"Examples",id:"examples",level:4},{value:"getFieldOptions()",id:"getfieldoptions",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"param",id:"param",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Example",id:"example-7",level:4},{value:"getFields()",id:"getfields",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"ids",id:"ids",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-8",level:4},{value:"isReadOnly()",id:"isreadonly",level:3},{value:"Returns",id:"returns-12",level:4},{value:"merge()",id:"merge",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Example",id:"example-9",level:4},{value:"setCurrentApplication()",id:"setcurrentapplication",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Throws",id:"throws-2",level:4},{value:"Example",id:"example-10",level:4},{value:"setEditMode()",id:"seteditmode",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Example",id:"example-11",level:4},{value:"setFields()",id:"setfields",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"fields",id:"fields",level:5},{value:"Returns",id:"returns-16",level:4},{value:"Example",id:"example-12",level:4},{value:"Properties",id:"properties",level:2},{value:"ApplicationSelected",id:"applicationselected",level:3},{value:"Examples",id:"examples-1",level:4},{value:"Change",id:"change",level:3},{value:"Examples",id:"examples-2",level:4},{value:"Close",id:"close",level:3},{value:"Examples",id:"examples-3",level:4},{value:"Committed",id:"committed",level:3},{value:"Examples",id:"examples-4",level:4},{value:"EditModeChange",id:"editmodechange",level:3},{value:"Examples",id:"examples-5",level:4},{value:"FieldChangeSync",id:"fieldchangesync",level:3},{value:"Examples",id:"examples-6",level:4},{value:"id",id:"id-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"MilestoneCompleted",id:"milestonecompleted",level:3},{value:"Examples",id:"examples-7",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Open",id:"open",level:3},{value:"Examples",id:"examples-8",level:4},{value:"PreCommit",id:"precommit",level:3},{value:"Examples",id:"examples-9",level:4},{value:"PreMilestoneComplete",id:"premilestonecomplete",level:3},{value:"Examples",id:"examples-10",level:4},{value:"Sync",id:"sync",level:3},{value:"Examples",id:"examples-11",level:4}];function o(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"iloan",children:"ILoan"})}),"\n",(0,s.jsx)(n.p,{children:"Methods & Events for interacting with an open loan in the application"}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEvents",children:"LoanEvents"})," for supported events"]}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,s.jsx)(n.code,{children:"_dispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,s.jsx)(n.code,{children:"RemotingScriptingObject"})})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,s.jsx)(n.code,{children:"_toJSON"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"all",children:"all()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"all(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get complete Loan object"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"v3 Loan Object"}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const loanData = await loan.all();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"applylock",children:"applyLock()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"applyLock(fieldId: string, lock: boolean): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies or removes the calculation lock on a loan field."}),"\n",(0,s.jsx)(n.p,{children:"In this way you can enable or disable the lock on a loan field programmatically."}),"\n",(0,s.jsx)(n.p,{children:"Parameters are: ID of the field you want to apply or remove the calculation lock and the status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fieldid",children:"fieldId"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"ID of the field you want to apply or remove the calculation lock"}),"\n",(0,s.jsx)(n.h5,{id:"lock",children:"lock"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.applyLock('4001', true);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"calculate",children:"calculate()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"calculate(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Executes calculations and business rules"}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.calculate();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commit",children:"commit()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"commit(): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Commit all pending changes on the current loan"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.precommit event before committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.committed event after committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Business rule violations will prevent the loan from being committed"}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"loan id"}),"\n",(0,s.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.commit();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"execaction",children:"execAction()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<ActionResponse>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Execute loan level action, this is specific to v3 stateful implementation"}),"\n",(0,s.jsx)(n.p,{children:"Invokes state API with all pending changes in current change-set along with requested loan action"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.sync event after the action is executed"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"type",children:"type"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanLevelActions",children:(0,s.jsx)(n.code,{children:"LoanLevelActions"})})}),"\n",(0,s.jsx)(n.p,{children:"type of action to be executed. e.g. updateCorrespondentBalance"}),"\n",(0,s.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"additional parameters for the action"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ActionResponse",children:(0,s.jsx)(n.code,{children:"ActionResponse"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.execAction('calculateEEMMortgage');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcollection",children:"getCollection()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCollection(name: LoanCollection): Promise<LoanCollectionObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns an object reference of type LoanCollection."}),"\n",(0,s.jsx)(n.p,{children:'Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.'}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanCollection",children:(0,s.jsx)(n.code,{children:"LoanCollection"})})}),"\n",(0,s.jsx)(n.p,{children:"collection template name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCollectionObject",children:(0,s.jsx)(n.code,{children:"LoanCollectionObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"collection object"}),"\n",(0,s.jsx)(n.h4,{id:"throws",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if collection name is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const borrowerEmployer = await loan.getCollection('BorrowerEmployer');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcurrentapplication",children:"getCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCurrentApplication(): Promise<ApplicationInfo>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get the current borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ApplicationInfo",children:(0,s.jsx)(n.code,{children:"ApplicationInfo"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const currentApplication = await loan.getCurrentApplication();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfield",children:"getField()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getField(id: string): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get value of the standard or custom field"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"id",children:"id"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"field id"}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"field value. Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"throws-1",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if field id is empty, null or undefined"}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('4001');\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('URLA.X1');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfieldoptions",children:"getFieldOptions()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFieldOptions(param: FieldOptionsParam): Promise<Record<string, FieldOptions[]>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get options for loan fields / custom form controls"}),"\n",(0,s.jsx)(n.p,{children:"supports both standard & custom loan fields."}),"\n",(0,s.jsx)(n.p,{children:"control Ids takes precedence over field Ids."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"param",children:"param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptionsParam",children:(0,s.jsx)(n.code,{children:"FieldOptionsParam"})})}),"\n",(0,s.jsx)(n.p,{children:"parameter for getting field options"}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptions",children:(0,s.jsx)(n.code,{children:"FieldOptions"})}),"[]>>"]}),"\n",(0,s.jsx)(n.p,{children:"array of field options for each field / control id"}),"\n",(0,s.jsx)(n.h4,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ fieldIds: ['1543', '1544'] });\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ controlIds: ['111', '112'] });\n"})}),"\n",(0,s.jsx)(n.p,{children:"Following is a sample field options for field Id 1543:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" 1543: [\n {\n value: 'Manual Underwriting',\n name: 'Manual Underwriting'\n },\n {\n value: 'DU',\n name: 'DU'\n },\n {\n value: 'LP',\n name: 'LP'\n },\n {\n value: 'LQA',\n name: 'LQA'\n },\n {\n value: 'Other',\n name: 'Other'\n }\n]\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfields",children:"getFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFields(ids: string[]): Promise<Record<string, string>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the value of a standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"ids",children:"ids"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The field Ids to get the value of"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">>"]}),"\n",(0,s.jsx)(n.p,{children:"The field values"}),"\n",(0,s.jsx)(n.h4,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValues = await loan.getFields(['4001', '4002']);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"isReadOnly(): Promise<boolean>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the loan is editable or in a read-only state."}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"merge",children:"merge()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"merge(): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Syncs the loan workspace with any changes made by other users."}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.merge();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setcurrentapplication",children:"setCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Switch borrower pair"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.applicationselected event after the borrower pair is switched"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/CurrentApplicationOptions",children:(0,s.jsx)(n.code,{children:"CurrentApplicationOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"throws-2",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if borrower pair infromation is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setCurrentApplication({\n id: '5D3B4A1B-3D3B-4A1B-5D3B-4A1B3D3B4A1B'\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"seteditmode",children:"setEditMode()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setEditMode(options: EditModeOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set UI edit mode for the loan."}),"\n",(0,s.jsx)(n.p,{children:"It doesn't apply loan level lock."}),"\n",(0,s.jsx)(n.p,{children:"Use this api to prevent current user from making edits to the loan file, while a compliance based workflow is in progress"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/EditModeOptions",children:(0,s.jsx)(n.code,{children:"EditModeOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"options for setting edit mode"}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setEditMode({mode: 'READONLY', moduleId: 'urn:encompass:efolder'});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setfields",children:"setFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setFields(fields: Record<string, string>): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set the values of one or more standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Throws an error if non-existing field id is passed. Fields following the non-existing field will not be set."}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.change event for each field that is changed and loan.sync event after all fields are set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fields",children:"fields"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"list of field ids and their values"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setField({'4000': 'John', '4002': 'David'});\n"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"applicationselected",children:"ApplicationSelected"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly ApplicationSelected: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan application is selected"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanApplicationSelectedListener",children:"LoanApplicationSelectedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-1",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.applicationselected',\n callback: ({ eventParams }) => {\n console.log('Application Selected', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'applicationselected', ({ eventParams }) => {\n console.log('Application Selected', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"change",children:"Change"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Change: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired for each loan change made by the user"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanChangeListener",children:"LoanChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-2",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.change',\n callback: ({ eventParams }) => {\n console.log('Loan changed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'change', ({ eventParams }) => {\n console.log('Loan changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"close",children:"Close"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Close: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired prior to closing the loan"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCloseListener",children:"LoanCloseListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-3",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.close',\n callback: ({ eventParams }) => {\n console.log('Loan closing', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'close', ({ eventParams }) => {\n console.log('Loan closing', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"committed",children:"Committed"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Committed: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan changes are committed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCommittedListener",children:"LoanCommittedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-4",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.committed',\n callback: ({ eventParams }) => {\n console.log('Loan committed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'committed', ({ eventParams }) => {\n console.log('Loan committed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editmodechange",children:"EditModeChange"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly EditModeChange: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan edit mode is changed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEditModeChangeListener",children:"LoanEditModeChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-5",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.editModeChange',\n callback: ({ eventParams }) => {\n console.log('Loan edit mode changed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'editModeChange', ({ eventParams }) => {\n console.log('Loan edit mode changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fieldchangesync",children:"FieldChangeSync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly FieldChangeSync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when a loan field is changed\nreturn true to further process the field change, false to cancel the field change"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanFieldChangeSyncListener",children:"LoanFieldChangeSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-6",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.fieldChangeSync',\n callback: ({ eventParams }) => {\n console.log('Loan field changed', eventParams);\n return true;\n });\n criteria: {\n fieldId: { eq: 4000 }\n }\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'fieldChangeSync', ({ eventParams }) => {\n console.log('Loan field changed', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",children:"id"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,s.jsx)(n.code,{children:"id"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"milestonecompleted",children:"MilestoneCompleted"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly MilestoneCompleted: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan milestone is completed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanMilestoneCompletedListener",children:"LoanMilestoneCompletedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-7",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.milestoneCompleted',\n callback: ({ eventParams }) => {\n console.log('Loan milestone completed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'milestoneCompleted', ({ eventParams }) => {\n console.log('Loan milestone completed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,s.jsx)(n.code,{children:"objectType"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"open",children:"Open"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Open: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is opened"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanOpenListener",children:"LoanOpenListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-8",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.open',\n callback: ({ eventParams }) => {\n console.log('Loan open', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'open', ({ eventParams }) => {\n console.log('Loan open', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"precommit",children:"PreCommit"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreCommit: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired prior to saving and pending changes to the loan"}),"\n",(0,s.jsx)(n.p,{children:"One can use this event to perform custom validation and, via the feedback mechanism, prevent the loan from being saved."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreCommitListener",children:"LoanPreCommitListener"})," handles this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-9",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.precommit',\n callback: ({ eventParams }) => {\n console.log('Loan precommit', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'precommit', ({ eventParams }) => {\n console.log('Loan precommit', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"premilestonecomplete",children:"PreMilestoneComplete"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreMilestoneComplete: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired when the user attempts to complete a milestone and allows for custom validation, and cancellation, of the process."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreMilestoneCompleteListener",children:"LoanPreMilestoneCompleteListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-10",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.premilestonecomplete',\n callback: ({ eventParams }) => {\n console.log('Loan pre-milestone complete', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'premilestonecomplete', ({ eventParams }) => {\n console.log('Loan pre-milestone complete', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sync",children:"Sync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Sync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is synced with any changes made by other users or external systems"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanSyncListener",children:"LoanSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-11",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.sync',\n callback: ({ eventParams }) => {\n console.log('Loan synced', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'sync', ({ eventParams }) => {\n console.log('Loan synced', eventParams);\n});\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},90116:(e,n,l)=>{l.d(n,{R:()=>a,x:()=>t});var i=l(30758);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components\|\|s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);
1	+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object\|\|[]).push([[1453],{47849:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api/interfaces/ILoan","title":"ILoan","description":"Methods & Events for interacting with an open loan in the application","source":"@site/docs/api/interfaces/ILoan.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/ILoan","permalink":"/scripting-object/api/interfaces/ILoan","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/ILoan.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"IHttp","permalink":"/scripting-object/api/interfaces/IHttp"},"next":{"title":"IMemStorage","permalink":"/scripting-object/api/interfaces/IMemStorage"}}');var s=l(86070),r=l(90116);const a={},t="ILoan",c={},d=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"_dispose()?",id:"_dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"_toJSON()",id:"_tojson",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"all()",id:"all",level:3},{value:"Returns",id:"returns-2",level:4},{value:"Example",id:"example",level:4},{value:"applyLock()",id:"applylock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"fieldId",id:"fieldid",level:5},{value:"lock",id:"lock",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Example",id:"example-1",level:4},{value:"calculate()",id:"calculate",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Example",id:"example-2",level:4},{value:"commit()",id:"commit",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-3",level:4},{value:"execAction()",id:"execaction",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"type",id:"type",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-6",level:4},{value:"Example",id:"example-4",level:4},{value:"getCollection()",id:"getcollection",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"name",id:"name",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Throws",id:"throws",level:4},{value:"Example",id:"example-5",level:4},{value:"getCurrentApplication()",id:"getcurrentapplication",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Example",id:"example-6",level:4},{value:"getField()",id:"getfield",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"id",id:"id",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Throws",id:"throws-1",level:4},{value:"Examples",id:"examples",level:4},{value:"getFieldOptions()",id:"getfieldoptions",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"param",id:"param",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Example",id:"example-7",level:4},{value:"getFields()",id:"getfields",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"ids",id:"ids",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Example",id:"example-8",level:4},{value:"isReadOnly()",id:"isreadonly",level:3},{value:"Returns",id:"returns-12",level:4},{value:"merge()",id:"merge",level:3},{value:"Returns",id:"returns-13",level:4},{value:"Example",id:"example-9",level:4},{value:"setCurrentApplication()",id:"setcurrentapplication",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Throws",id:"throws-2",level:4},{value:"Example",id:"example-10",level:4},{value:"setEditMode()",id:"seteditmode",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-15",level:4},{value:"Example",id:"example-11",level:4},{value:"setFields()",id:"setfields",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"fields",id:"fields",level:5},{value:"Returns",id:"returns-16",level:4},{value:"Example",id:"example-12",level:4},{value:"Properties",id:"properties",level:2},{value:"ApplicationSelected",id:"applicationselected",level:3},{value:"Examples",id:"examples-1",level:4},{value:"Change",id:"change",level:3},{value:"Examples",id:"examples-2",level:4},{value:"Close",id:"close",level:3},{value:"Examples",id:"examples-3",level:4},{value:"Committed",id:"committed",level:3},{value:"Examples",id:"examples-4",level:4},{value:"EditModeChange",id:"editmodechange",level:3},{value:"Examples",id:"examples-5",level:4},{value:"FieldChangeSync",id:"fieldchangesync",level:3},{value:"Examples",id:"examples-6",level:4},{value:"id",id:"id-1",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"MilestoneCompleted",id:"milestonecompleted",level:3},{value:"Examples",id:"examples-7",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Open",id:"open",level:3},{value:"Examples",id:"examples-8",level:4},{value:"PreCommit",id:"precommit",level:3},{value:"Examples",id:"examples-9",level:4},{value:"PreMilestoneComplete",id:"premilestonecomplete",level:3},{value:"Examples",id:"examples-10",level:4},{value:"Sync",id:"sync",level:3},{value:"Examples",id:"examples-11",level:4}];function o(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"iloan",children:"ILoan"})}),"\n",(0,s.jsx)(n.p,{children:"Methods & Events for interacting with an open loan in the application"}),"\n",(0,s.jsxs)(n.p,{children:["See ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEvents",children:"LoanEvents"})," for supported events"]}),"\n",(0,s.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,s.jsx)(n.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"void"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,s.jsx)(n.code,{children:"_dispose"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,s.jsx)(n.code,{children:"RemotingScriptingObject"})})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,s.jsx)(n.code,{children:"_toJSON"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"all",children:"all()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"all(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get complete Loan object"}),"\n",(0,s.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"v3 Loan Object"}),"\n",(0,s.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const loanData = await loan.all();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"applylock",children:"applyLock()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"applyLock(fieldId: string, lock: boolean): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Applies or removes the calculation lock on a loan field."}),"\n",(0,s.jsx)(n.p,{children:"In this way you can enable or disable the lock on a loan field programmatically."}),"\n",(0,s.jsx)(n.p,{children:"Parameters are: ID of the field you want to apply or remove the calculation lock and the status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fieldid",children:"fieldId"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"ID of the field you want to apply or remove the calculation lock"}),"\n",(0,s.jsx)(n.h5,{id:"lock",children:"lock"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.p,{children:"status you want to set the lock to"}),"\n",(0,s.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.applyLock('4001', true);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"calculate",children:"calculate()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"calculate(): Promise<LoanObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Executes calculations and business rules"}),"\n",(0,s.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanObject",children:(0,s.jsx)(n.code,{children:"LoanObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.calculate();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"commit",children:"commit()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"commit(): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Commit all pending changes on the current loan"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.precommit event before committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.committed event after committing the changes"}),"\n",(0,s.jsx)(n.p,{children:"Business rule violations will prevent the loan from being committed"}),"\n",(0,s.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"loan id"}),"\n",(0,s.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.commit();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"execaction",children:"execAction()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<ActionResponse>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Execute loan level action, this is specific to v3 stateful implementation"}),"\n",(0,s.jsx)(n.p,{children:"Invokes state API with all pending changes in current change-set along with requested loan action"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.sync event after the action is executed"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"type",children:"type"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanLevelActions",children:(0,s.jsx)(n.code,{children:"LoanLevelActions"})})}),"\n",(0,s.jsx)(n.p,{children:"type of action to be executed. e.g. updateCorrespondentBalance"}),"\n",(0,s.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"unknown"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"additional parameters for the action"}),"\n",(0,s.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ActionResponse",children:(0,s.jsx)(n.code,{children:"ActionResponse"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"updated loan object"}),"\n",(0,s.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.execAction('calculateEEMMortgage');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcollection",children:"getCollection()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCollection(name: LoanCollection): Promise<LoanCollectionObject>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns an object reference of type LoanCollection."}),"\n",(0,s.jsx)(n.p,{children:'Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.'}),"\n",(0,s.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/enumerations/LoanCollection",children:(0,s.jsx)(n.code,{children:"LoanCollection"})})}),"\n",(0,s.jsx)(n.p,{children:"collection template name"}),"\n",(0,s.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCollectionObject",children:(0,s.jsx)(n.code,{children:"LoanCollectionObject"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"collection object"}),"\n",(0,s.jsx)(n.h4,{id:"throws",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if collection name is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-5",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const borrowerEmployer = await loan.getCollection('BorrowerEmployer');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getcurrentapplication",children:"getCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getCurrentApplication(): Promise<ApplicationInfo>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Get the current borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/ApplicationInfo",children:(0,s.jsx)(n.code,{children:"ApplicationInfo"})}),">"]}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"example-6",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const currentApplication = await loan.getCurrentApplication();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfield",children:"getField()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getField(id: string): Promise<string>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get value of the standard or custom field"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"id",children:"id"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"field id"}),"\n",(0,s.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"field value. Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"throws-1",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if field id is empty, null or undefined"}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('4001');\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValue = await loan.getField('URLA.X1');\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfieldoptions",children:"getFieldOptions()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFieldOptions(param: FieldOptionsParam): Promise<Record<string, FieldOptions[]>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"get options for loan fields / custom form controls"}),"\n",(0,s.jsx)(n.p,{children:"supports both standard & custom loan fields."}),"\n",(0,s.jsx)(n.p,{children:"control Ids takes precedence over field Ids."}),"\n",(0,s.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"param",children:"param"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptionsParam",children:(0,s.jsx)(n.code,{children:"FieldOptionsParam"})})}),"\n",(0,s.jsx)(n.p,{children:"parameter for getting field options"}),"\n",(0,s.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/FieldOptions",children:(0,s.jsx)(n.code,{children:"FieldOptions"})}),"[]>>"]}),"\n",(0,s.jsx)(n.p,{children:"array of field options for each field / control id"}),"\n",(0,s.jsx)(n.h4,{id:"example-7",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ fieldIds: ['1543', '1544'] });\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldOptions = await loan.getFieldOptions({ controlIds: ['111', '112'] });\n"})}),"\n",(0,s.jsx)(n.p,{children:"Following is a sample field options for field Id 1543:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" 1543: [\n {\n value: 'Manual Underwriting',\n name: 'Manual Underwriting'\n },\n {\n value: 'DU',\n name: 'DU'\n },\n {\n value: 'LP',\n name: 'LP'\n },\n {\n value: 'LQA',\n name: 'LQA'\n },\n {\n value: 'Other',\n name: 'Other'\n }\n]\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"getfields",children:"getFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"getFields(ids: string[]): Promise<Record<string, string>>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Returns the value of a standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Default or blank value is returned if the field is not set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"ids",children:"ids"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,s.jsx)(n.p,{children:"The field Ids to get the value of"}),"\n",(0,s.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">>"]}),"\n",(0,s.jsx)(n.p,{children:"The field values"}),"\n",(0,s.jsx)(n.h4,{id:"example-8",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const fieldValues = await loan.getFields(['4001', '4002']);\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"isreadonly",children:"isReadOnly()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"isReadOnly(): Promise<boolean>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Indicates if the loan is editable or in a read-only state."}),"\n",(0,s.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"merge",children:"merge()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"merge(): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Syncs the loan workspace with any changes made by other users."}),"\n",(0,s.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-9",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.merge();\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setcurrentapplication",children:"setCurrentApplication()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setCurrentApplication(options: CurrentApplicationOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Switch borrower pair"}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.applicationselected event after the borrower pair is switched"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/CurrentApplicationOptions",children:(0,s.jsx)(n.code,{children:"CurrentApplicationOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"borrower pair information"}),"\n",(0,s.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"throws-2",children:"Throws"}),"\n",(0,s.jsx)(n.p,{children:"error if borrower pair infromation is invalid"}),"\n",(0,s.jsx)(n.h4,{id:"example-10",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setCurrentApplication({\n id: '5D3B4A1B-3D3B-4A1B-5D3B-4A1B3D3B4A1B'\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"seteditmode",children:"setEditMode()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setEditMode(options: EditModeOptions): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set UI edit mode for the loan."}),"\n",(0,s.jsx)(n.p,{children:"It doesn't apply loan level lock."}),"\n",(0,s.jsx)(n.p,{children:"Use this api to prevent current user from making edits to the loan file, while a compliance based workflow is in progress"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/EditModeOptions",children:(0,s.jsx)(n.code,{children:"EditModeOptions"})})}),"\n",(0,s.jsx)(n.p,{children:"options for setting edit mode"}),"\n",(0,s.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-11",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setEditMode({mode: 'READONLY', moduleId: 'urn:encompass:efolder'});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"setfields",children:"setFields()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"setFields(fields: Record<string, string>): Promise<void>;\n"})}),"\n",(0,s.jsx)(n.p,{children:"Set the values of one or more standard or custom fields"}),"\n",(0,s.jsx)(n.p,{children:"Throws an error if non-existing field id is passed. Fields following the non-existing field will not be set."}),"\n",(0,s.jsx)(n.p,{children:"Fires the loan.change event for each field that is changed and loan.sync event after all fields are set"}),"\n",(0,s.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsx)(n.h5,{id:"fields",children:"fields"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Record"}),"<",(0,s.jsx)(n.code,{children:"string"}),", ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"list of field ids and their values"}),"\n",(0,s.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h4,{id:"example-12",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"await loan.setField({'4000': 'John', '4002': 'David'});\n"})}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"applicationselected",children:"ApplicationSelected"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly ApplicationSelected: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan application is selected"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanApplicationSelectedListener",children:"LoanApplicationSelectedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-1",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.applicationselected',\n callback: ({ eventParams }) => {\n console.log('Application Selected', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'applicationselected', ({ eventParams }) => {\n console.log('Application Selected', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"change",children:"Change"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Change: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired for each loan change made by the user"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanChangeListener",children:"LoanChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-2",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.change',\n callback: ({ eventParams }) => {\n console.log('Loan changed', eventParams);\n });\n criteria: {\n fieldId: { eq: 4000 }\n }\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'change', ({ eventParams }) => {\n console.log('Loan changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"close",children:"Close"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Close: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired prior to closing the loan"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCloseListener",children:"LoanCloseListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-3",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.close',\n callback: ({ eventParams }) => {\n console.log('Loan closing', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'close', ({ eventParams }) => {\n console.log('Loan closing', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"committed",children:"Committed"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Committed: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan changes are committed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanCommittedListener",children:"LoanCommittedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-4",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.committed',\n callback: ({ eventParams }) => {\n console.log('Loan committed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'committed', ({ eventParams }) => {\n console.log('Loan committed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editmodechange",children:"EditModeChange"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly EditModeChange: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan edit mode is changed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanEditModeChangeListener",children:"LoanEditModeChangeListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-5",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.editModeChange',\n callback: ({ eventParams }) => {\n console.log('Loan edit mode changed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'editModeChange', ({ eventParams }) => {\n console.log('Loan edit mode changed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fieldchangesync",children:"FieldChangeSync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly FieldChangeSync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when a loan field is changed\nreturn true to further process the field change, false to cancel the field change"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanFieldChangeSyncListener",children:"LoanFieldChangeSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-6",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.fieldChangeSync',\n callback: ({ eventParams }) => {\n console.log('Loan field changed', eventParams);\n return true;\n });\n criteria: {\n fieldId: { eq: 4000 }\n }\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'fieldChangeSync', ({ eventParams }) => {\n console.log('Loan field changed', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"id-1",children:"id"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,s.jsx)(n.code,{children:"id"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"milestonecompleted",children:"MilestoneCompleted"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly MilestoneCompleted: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan milestone is completed"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanMilestoneCompletedListener",children:"LoanMilestoneCompletedListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-7",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.milestoneCompleted',\n callback: ({ eventParams }) => {\n console.log('Loan milestone completed', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'milestoneCompleted', ({ eventParams }) => {\n console.log('Loan milestone completed', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,s.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,s.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,s.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,s.jsx)(n.code,{children:"objectType"})})]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"open",children:"Open"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Open: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is opened"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanOpenListener",children:"LoanOpenListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-8",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.open',\n callback: ({ eventParams }) => {\n console.log('Loan open', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'open', ({ eventParams }) => {\n console.log('Loan open', eventParams);\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"precommit",children:"PreCommit"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreCommit: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired prior to saving and pending changes to the loan"}),"\n",(0,s.jsx)(n.p,{children:"One can use this event to perform custom validation and, via the feedback mechanism, prevent the loan from being saved."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreCommitListener",children:"LoanPreCommitListener"})," handles this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-9",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.precommit',\n callback: ({ eventParams }) => {\n console.log('Loan precommit', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'precommit', ({ eventParams }) => {\n console.log('Loan precommit', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"premilestonecomplete",children:"PreMilestoneComplete"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly PreMilestoneComplete: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event is fired when the user attempts to complete a milestone and allows for custom validation, and cancellation, of the process."}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanPreMilestoneCompleteListener",children:"LoanPreMilestoneCompleteListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-10",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.premilestonecomplete',\n callback: ({ eventParams }) => {\n console.log('Loan pre-milestone complete', eventParams);\n return true;\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'premilestonecomplete', ({ eventParams }) => {\n console.log('Loan pre-milestone complete', eventParams);\n return true;\n});\n"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"sync",children:"Sync"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"readonly Sync: IEvent;\n"})}),"\n",(0,s.jsx)(n.p,{children:"event fired when the loan is synced with any changes made by other users or external systems"}),"\n",(0,s.jsxs)(n.p,{children:["Use ",(0,s.jsx)(n.a,{href:"/scripting-object/api/type-aliases/LoanSyncListener",children:"LoanSyncListener"})," to handle this event"]}),"\n",(0,s.jsx)(n.h4,{id:"examples-11",children:"Examples"}),"\n",(0,s.jsx)(n.p,{children:"with v2 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"guest.subscribe({\n eventId: 'loan.sync',\n callback: ({ eventParams }) => {\n console.log('Loan synced', eventParams);\n });\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"with v1 SSF"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"elli.script.subscribe('loan', 'sync', ({ eventParams }) => {\n console.log('Loan synced', eventParams);\n});\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},90116:(e,n,l)=>{l.d(n,{R:()=>a,x:()=>t});var i=l(30758);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components\|\|s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/{e577279e.8cb51fd7.js → e577279e.6790a498.js} RENAMED Viewed

	@@ -1 +1 @@
1	- "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object\|\|[]).push([[4672],{29621:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/type-aliases/Events","title":"Events","description":"","source":"@site/docs/api/type-aliases/Events.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Events","permalink":"/scripting-object/api/type-aliases/Events","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/Events.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EventObjects","permalink":"/scripting-object/api/type-aliases/EventObjects"},"next":{"title":"ExportServices","permalink":"/scripting-object/api/type-aliases/ExportServices"}}');var i=n(86070),a=n(90116);const r={},o="Events",c={},p=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"events",children:"Events"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"type Events = ApplicationEvents & FormEvents & GlobalEvents & LoanEvents & ModuleEvents;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var s=n(30758);const i={},a=s.createContext(i);function r(e){const t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components\|\|i:r(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);
1	+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object\|\|[]).push([[4672],{29621:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/type-aliases/Events","title":"Events","description":"","source":"@site/docs/api/type-aliases/Events.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/Events","permalink":"/scripting-object/api/type-aliases/Events","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/Events.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"EventObjects","permalink":"/scripting-object/api/type-aliases/EventObjects"},"next":{"title":"ExportServices","permalink":"/scripting-object/api/type-aliases/ExportServices"}}');var i=n(86070),a=n(90116);const r={},o="Events",c={},p=[];function l(e){const t={code:"code",h1:"h1",header:"header",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"events",children:"Events"})}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-ts",children:"type Events = ApplicationEvents & FormEvents & GlobalEvents & LoanEvents & ModuleEvents & WebSocketEvents;\n"})})]})}function d(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>o});var s=n(30758);const i={},a=s.createContext(i);function r(e){const t=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components\|\|i:r(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/ebc6cbfc.dfb7a6f6.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[4339],{9122:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>x,frontMatter:()=>r,metadata:()=>s,toc:()=>h});const s=JSON.parse('{"id":"Objects/websocket","title":"WebSocket","description":"API Definition","source":"@site/docs/Objects/websocket.md","sourceDirName":"Objects","slug":"/Objects/websocket","permalink":"/scripting-object/Objects/websocket","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/Objects/websocket.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"TransactionTemplate","permalink":"/scripting-object/Objects/transactiontemplate"},"next":{"title":"Scripting Object API","permalink":"/scripting-object/api/"}}');var c=n(86070),i=n(90116);const r={},l="WebSocket",d={},h=[{value:"Methods",id:"methods",level:2},{value:"Events",id:"events",level:2}];function o(e){const t={a:"a",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(t.header,{children:(0,c.jsx)(t.h1,{id:"websocket",children:"WebSocket"})}),"\n",(0,c.jsx)(t.p,{children:(0,c.jsx)(t.a,{href:"../api/interfaces/IWebSocket",children:"API Definition"})}),"\n",(0,c.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsxs)(t.table,{children:[(0,c.jsx)(t.thead,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Method"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass Web"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"TPO"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Consumer Connect"})]})}),(0,c.jsxs)(t.tbody,{children:[(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.td,{style:{textAlign:"center"},children:(0,c.jsx)(t.a,{href:"../api/interfaces/IWebSocket#subscribe",children:"subscribe"})}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2714"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]}),(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.td,{style:{textAlign:"center"},children:(0,c.jsx)(t.a,{href:"../api/interfaces/IWebSocket#unsubscribe",children:"unsubscribe"})}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2714"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]})]})]}),"\n",(0,c.jsx)(t.h2,{id:"events",children:"Events"}),"\n",(0,c.jsxs)(t.table,{children:[(0,c.jsx)(t.thead,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Event"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Encompass Web"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"TPO"}),(0,c.jsx)(t.th,{style:{textAlign:"center"},children:"Consumer Connect"})]})}),(0,c.jsx)(t.tbody,{children:(0,c.jsxs)(t.tr,{children:[(0,c.jsx)(t.td,{style:{textAlign:"center"},children:(0,c.jsx)(t.a,{href:"../api/interfaces/IWebSocket#message",children:"Message"})}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2714"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"}),(0,c.jsx)(t.td,{style:{textAlign:"center"},children:"\u2716\ufe0f"})]})})]})]})}function x(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,c.jsx)(t,{...e,children:(0,c.jsx)(o,{...e})}):o(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>l});var s=n(30758);const c={},i=s.createContext(c);function r(e){const t=s.useContext(i);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:r(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/eef1b94c.b267d013.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[266],{15409:(e,o,r)=>{r.r(o),r.d(o,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"api/type-aliases/StyleOptions","title":"StyleOptions","description":"CSS style properties that can be applied to fields and table rows","source":"@site/docs/api/type-aliases/StyleOptions.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/StyleOptions","permalink":"/scripting-object/api/type-aliases/StyleOptions","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/StyleOptions.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"StateInfo","permalink":"/scripting-object/api/type-aliases/StateInfo"},"next":{"title":"SubscribeOptions","permalink":"/scripting-object/api/type-aliases/SubscribeOptions"}}');var n=r(86070),s=r(90116);const i={},l="StyleOptions",a={},c=[{value:"Properties",id:"properties",level:2},{value:"backgroundColor?",id:"backgroundcolor",level:3},{value:"borderColor?",id:"bordercolor",level:3},{value:"color?",id:"color",level:3}];function p(e){const o={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.header,{children:(0,n.jsx)(o.h1,{id:"styleoptions",children:"StyleOptions"})}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"type StyleOptions = {\n backgroundColor?: string;\n borderColor?: string;\n color?: string;\n};\n"})}),"\n",(0,n.jsx)(o.p,{children:"CSS style properties that can be applied to fields and table rows\nAll color values should be valid CSS color strings (hex, rgb, named colors, etc.)"}),"\n",(0,n.jsx)(o.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(o.h3,{id:"backgroundcolor",children:"backgroundColor?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional backgroundColor: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Background color (CSS color value)"}),"\n",(0,n.jsx)(o.hr,{}),"\n",(0,n.jsx)(o.h3,{id:"bordercolor",children:"borderColor?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional borderColor: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Border color (CSS color value)"}),"\n",(0,n.jsx)(o.hr,{}),"\n",(0,n.jsx)(o.h3,{id:"color",children:"color?"}),"\n",(0,n.jsx)(o.pre,{children:(0,n.jsx)(o.code,{className:"language-ts",children:"optional color: string;\n"})}),"\n",(0,n.jsx)(o.p,{children:"Text color (CSS color value)"})]})}function d(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},90116:(e,o,r)=>{r.d(o,{R:()=>i,x:()=>l});var t=r(30758);const n={},s=t.createContext(n);function i(e){const o=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(o):{...o,...e}},[o,e])}function l(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:o},e.children)}}}]);

package/build/docs/assets/js/f920ab10.688b6b83.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[8016],{87531:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>s,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"api/enumerations/TokenType","title":"TokenType","description":"token type","source":"@site/docs/api/enumerations/TokenType.md","sourceDirName":"api/enumerations","slug":"/api/enumerations/TokenType","permalink":"/scripting-object/api/enumerations/TokenType","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/enumerations/TokenType.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"ToastType","permalink":"/scripting-object/api/enumerations/ToastType"},"next":{"title":"WebSocketErrorCode","permalink":"/scripting-object/api/enumerations/WebSocketErrorCode"}}');var i=n(86070),o=n(90116);const s={},a="TokenType",c={},d=[{value:"Enumeration Members",id:"enumeration-members",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"tokentype",children:"TokenType"})}),"\n",(0,i.jsx)(t.p,{children:"token type"}),"\n",(0,i.jsx)(t.h2,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Enumeration Member"}),(0,i.jsx)(t.th,{children:"Value"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsxs)(t.td,{children:[(0,i.jsx)("a",{id:"bearer"})," ",(0,i.jsx)(t.code,{children:"BEARER"})]}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:'"Bearer"'})}),(0,i.jsx)(t.td,{children:"Bearer token type"})]})})]})]})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},90116:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>a});var r=n(30758);const i={},o=r.createContext(i);function s(e){const t=r.useContext(o);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]);

package/build/docs/assets/js/fdf27b93.c7d11e68.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[7738],{18532:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"api/interfaces/IAnalytics","title":"IAnalytics","description":"Methods to collect various business analytics & performance related events and report the same","source":"@site/docs/api/interfaces/IAnalytics.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/IAnalytics","permalink":"/scripting-object/api/interfaces/IAnalytics","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/interfaces/IAnalytics.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"WebSocketErrorCode","permalink":"/scripting-object/api/enumerations/WebSocketErrorCode"},"next":{"title":"IApplication","permalink":"/scripting-object/api/interfaces/IApplication"}}');var r=i(86070),t=i(90116);const a={},l="IAnalytics",d={},c=[{value:"Extends",id:"extends",level:2},{value:"Methods",id:"methods",level:2},{value:"_dispose()?",id:"_dispose",level:3},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"_toJSON()",id:"_tojson",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"deleteTimingEventSamplingRatio()",id:"deletetimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters",level:4},{value:"names",id:"names",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Example",id:"example",level:4},{value:"endTiming()",id:"endtiming",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"start",id:"start",level:5},{value:"options",id:"options",level:5},{value:"Returns",id:"returns-3",level:4},{value:"Example",id:"example-1",level:4},{value:"getAllTimingEventSamplingRatios()",id:"getalltimingeventsamplingratios",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Example",id:"example-2",level:4},{value:"getTimingEventSamplingRatio()",id:"gettimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"names",id:"names-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Example",id:"example-3",level:4},{value:"sendBAEvent()",id:"sendbaevent",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"event",id:"event",level:5},{value:"Returns",id:"returns-6",level:4},{value:"setTimingEventSamplingRatio()",id:"settimingeventsamplingratio",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"ratios",id:"ratios",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Example",id:"example-4",level:4},{value:"startTiming()",id:"starttiming",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"name",id:"name",level:5},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"objectType",id:"objecttype",level:3},{value:"Inherited from",id:"inherited-from-3",level:4}];function o(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"ianalytics",children:"IAnalytics"})}),"\n",(0,r.jsx)(n.p,{children:"Methods to collect various business analytics & performance related events and report the same"}),"\n",(0,r.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})})}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"_dispose",children:"_dispose()?"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"optional _dispose(): void;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_dispose",children:(0,r.jsx)(n.code,{children:"_dispose"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"_tojson",children:"_toJSON()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"_toJSON(): RemotingScriptingObject;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/RemotingScriptingObject",children:(0,r.jsx)(n.code,{children:"RemotingScriptingObject"})})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#_tojson",children:(0,r.jsx)(n.code,{children:"_toJSON"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"deletetimingeventsamplingratio",children:"deleteTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"deleteTimingEventSamplingRatio(names: string[]): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Remove sampling configuration for timing events\nFalls back to default sampling ratio (0.25)"}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"array of timing event names"}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.deleteTimingEventSamplingRatio(['api-call', 'user-interaction']);\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"endtiming",children:"endTiming()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"endTiming(start: string | PerfMark, options: TimingOptions): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"end timing measure"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"start",children:"start"}),"\n",(0,r.jsx)(n.p,{children:"name used to start timing measure or return value of the startTiming method"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/PerfMark",children:(0,r.jsx)(n.code,{children:"PerfMark"})})]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TimingOptions",children:(0,r.jsx)(n.code,{children:"TimingOptions"})})}),"\n",(0,r.jsx)(n.p,{children:"additional details related to the measurement"}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"a promise that resolves when the timing measurement is ended"}),"\n",(0,r.jsx)(n.h4,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });\n// do some work\nawait analytics.endTiming(longTaskMeasurement, { appId: 'myApp', appUrl: 'https://myapp.com' });\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const longTaskMeasurement = await analytics.startTiming('LongTask', { appId: 'myApp', appUrl: 'https://myapp.com' });\n// do some work\nawait analytics.endTiming('LongTask', { appId: 'loanApp', appUrl: 'https://loanApp.com' });\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getalltimingeventsamplingratios",children:"getAllTimingEventSamplingRatios()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getAllTimingEventSamplingRatios(): Record<string, number>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Get all configured timing event sampling ratios"}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with timing event names and their sampling ratios"}),"\n",(0,r.jsx)(n.h4,{id:"example-2",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getAllTimingEventSamplingRatios();\nconsole.log(ratios); // { 'api-call': 0.1, 'user-interaction': 0.5 }\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gettimingeventsamplingratio",children:"getTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getTimingEventSamplingRatio(names: string[]): Record<string, number | undefined>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Get sampling ratios for timing events"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"names-1",children:"names"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,r.jsx)(n.p,{children:"array of timing event names"}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"undefined"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with ratios for each event (undefined if using default)"}),"\n",(0,r.jsx)(n.h4,{id:"example-3",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const ratios = analytics.getTimingEventSamplingRatio(['api-call', 'user-interaction']);\nconsole.log(ratios); // { 'api-call': 0.1, 'user-interaction': 0.5 }\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"sendbaevent",children:"sendBAEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"sendBAEvent(event: BAEvent): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"send business analytics event"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"event",children:"event"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/BAEvent",children:(0,r.jsx)(n.code,{children:"BAEvent"})})}),"\n",(0,r.jsx)(n.p,{children:"event to be sent"}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"settimingeventsamplingratio",children:"setTimingEventSamplingRatio()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"setTimingEventSamplingRatio(ratios: Record<string, number>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Set sampling ratios for timing events"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"ratios",children:"ratios"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"number"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"object with timing event names and their sampling ratios (0 to 1)"}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"example-4",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"analytics.setTimingEventSamplingRatio({\n 'api-call': 0.1,\n 'user-interaction': 0.5,\n 'page-load': 0.8\n});\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"starttiming",children:"startTiming()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"startTiming(name: string, options: TimingOptions): Promise<PerfMark>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"start timing measure"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"name",children:"name"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"unique name for the timing measurement. If a measurement with the same name is already running, it will be replaced"}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/TimingOptions",children:(0,r.jsx)(n.code,{children:"TimingOptions"})})}),"\n",(0,r.jsx)(n.p,{children:"additional details related to the measurement"}),"\n",(0,r.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.a,{href:"/scripting-object/api/type-aliases/PerfMark",children:(0,r.jsx)(n.code,{children:"PerfMark"})}),">"]}),"\n",(0,r.jsx)(n.p,{children:"a promise that resolves to a performance mark object"}),"\n",(0,r.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsx)(n.h3,{id:"id",children:"id"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly id: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#id",children:(0,r.jsx)(n.code,{children:"id"})})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"objecttype",children:"objectType"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"readonly objectType: string;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject",children:(0,r.jsx)(n.code,{children:"IScriptingObject"})}),".",(0,r.jsx)(n.a,{href:"/scripting-object/api/interfaces/IScriptingObject#objecttype",children:(0,r.jsx)(n.code,{children:"objectType"})})]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},90116:(e,n,i)=>{i.d(n,{R:()=>a,x:()=>l});var s=i(30758);const r={},t=s.createContext(r);function a(e){const n=s.useContext(t);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);

package/build/docs/assets/js/fdf6128b.999e9e4f.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";(globalThis.webpackChunk_elliemae_pui_scripting_object=globalThis.webpackChunk_elliemae_pui_scripting_object||[]).push([[3749],{47869:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/type-aliases/SystemAdministration","title":"SystemAdministration","description":"Properties","source":"@site/docs/api/type-aliases/SystemAdministration.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/SystemAdministration","permalink":"/scripting-object/api/type-aliases/SystemAdministration","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-scripting-object.git/docs/api/type-aliases/SystemAdministration.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"SubscriptionFilter","permalink":"/scripting-object/api/type-aliases/SubscriptionFilter"},"next":{"title":"TableRowCriteria","permalink":"/scripting-object/api/type-aliases/TableRowCriteria"}}');var n=i(86070),r=i(90116);const a={},o="SystemAdministration",c={},l=[{value:"Properties",id:"properties",level:2},{value:"access",id:"access",level:3},{value:"rights",id:"rights",level:3}];function p(e){const t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",pre:"pre",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"systemadministration",children:"SystemAdministration"})}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"type SystemAdministration = {\n access: boolean;\n rights: string[];\n};\n"})}),"\n",(0,n.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(t.h3,{id:"access",children:"access"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"access: boolean;\n"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"rights",children:"rights"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"rights: string[];\n"})})]})}function d(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},90116:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>o});var s=i(30758);const n={},r=s.createContext(n);function a(e){const t=s.useContext(r);return s.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);