@elliemae/pui-app-sdk 5.36.2 → 5.37.0

package/build/docs/assets/js/f72a372a.95621bd7.js

@@ -0,0 +1 @@
+"use strict";(globalThis.webpackChunk_elliemae_pui_app_sdk=globalThis.webpackChunk_elliemae_pui_app_sdk||[]).push([[3292],{116(e,n,s){s.d(n,{R:()=>l,x:()=>d});var i=s(758);const r={},t=i.createContext(r);function l(e){const n=i.useContext(t);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(t.Provider,{value:n},e.children)}},8024(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>o,frontMatter:()=>l,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"id":"api/classes/CMicroAppGuest","title":"CMicroAppGuest\\\\<AppObjects, AppEvents\\\\>","description":"Micro-frontend guest application class (singleton).","source":"@site/docs/api/classes/CMicroAppGuest.md","sourceDirName":"api/classes","slug":"/api/classes/CMicroAppGuest","permalink":"/app-sdk/api/classes/CMicroAppGuest","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/classes/CMicroAppGuest.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Analytics","permalink":"/app-sdk/api/classes/Analytics"},"next":{"title":"CMicroAppHost\\\\<AppObjects, AppEvents\\\\>","permalink":"/app-sdk/api/classes/CMicroAppHost"}}');var r=s(6070),t=s(116);const l={},d="CMicroAppGuest<AppObjects, AppEvents>",c={},a=[{value:"Example",id:"example",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"AppObjects",id:"appobjects",level:3},{value:"AppEvents",id:"appevents",level:3},{value:"Implements",id:"implements",level:2},{value:"Accessors",id:"accessors",level:2},{value:"uuid",id:"uuid",level:3},{value:"Get Signature",id:"get-signature",level:4},{value:"Returns",id:"returns",level:5},{value:"Implementation of",id:"implementation-of",level:4},{value:"Methods",id:"methods",level:2},{value:"addScriptingObject()",id:"addscriptingobject",level:3},{value:"Type Parameters",id:"type-parameters-1",level:4},{value:"SO",id:"so",level:5},{value:"Parameters",id:"parameters",level:4},{value:"so",id:"so-1",level:5},{value:"params?",id:"params",level:5},{value:"Returns",id:"returns-1",level:4},{value:"Implementation of",id:"implementation-of-1",level:4},{value:"dispatchEvent()",id:"dispatchevent",level:3},{value:"Type Parameters",id:"type-parameters-2",level:4},{value:"EventId",id:"eventid",level:5},{value:"Params",id:"params-1",level:5},{value:"Options",id:"options",level:5},{value:"Parameters",id:"parameters-1",level:4},{value:"params",id:"params-2",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Implementation of",id:"implementation-of-2",level:4},{value:"getHost()",id:"gethost",level:3},{value:"Returns",id:"returns-3",level:4},{value:"getLogger()",id:"getlogger",level:3},{value:"Returns",id:"returns-4",level:4},{value:"getObject()",id:"getobject",level:3},{value:"Type Parameters",id:"type-parameters-3",level:4},{value:"ObjectId",id:"objectid",level:5},{value:"Parameters",id:"parameters-2",level:4},{value:"objectId",id:"objectid-1",level:5},{value:"Returns",id:"returns-5",level:4},{value:"Implementation of",id:"implementation-of-3",level:4},{value:"getProps()",id:"getprops",level:3},{value:"Returns",id:"returns-6",level:4},{value:"<del>getRef()</del>",id:"getref",level:3},{value:"Type Parameters",id:"type-parameters-4",level:4},{value:"T",id:"t",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Deprecated",id:"deprecated",level:4},{value:"Implementation of",id:"implementation-of-4",level:4},{value:"init()",id:"init",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"options",id:"options-1",level:5},{value:"Returns",id:"returns-8",level:4},{value:"Implementation of",id:"implementation-of-5",level:4},{value:"mount()",id:"mount",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"options",id:"options-2",level:5},{value:"Returns",id:"returns-9",level:4},{value:"Implementation of",id:"implementation-of-6",level:4},{value:"navigate()",id:"navigate",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"url",id:"url",level:5},{value:"state?",id:"state",level:5},{value:"Returns",id:"returns-10",level:4},{value:"Implementation of",id:"implementation-of-7",level:4},{value:"removeScriptingObject()",id:"removescriptingobject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"objectId",id:"objectid-2",level:5},{value:"Returns",id:"returns-11",level:4},{value:"Implementation of",id:"implementation-of-8",level:4},{value:"subscribe()",id:"subscribe",level:3},{value:"Type Parameters",id:"type-parameters-5",level:4},{value:"EventId",id:"eventid-1",level:5},{value:"Parameters",id:"parameters-7",level:4},{value:"params",id:"params-3",level:5},{value:"Returns",id:"returns-12",level:4},{value:"Implementation of",id:"implementation-of-9",level:4},{value:"unmount()",id:"unmount",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"options",id:"options-3",level:5},{value:"Returns",id:"returns-13",level:4},{value:"Implementation of",id:"implementation-of-10",level:4},{value:"unsubscribe()",id:"unsubscribe",level:3},{value:"Type Parameters",id:"type-parameters-6",level:4},{value:"EventId",id:"eventid-2",level:5},{value:"Parameters",id:"parameters-9",level:4},{value:"params",id:"params-4",level:5},{value:"Returns",id:"returns-14",level:4},{value:"Implementation of",id:"implementation-of-11",level:4},{value:"getInstance()",id:"getinstance",level:3},{value:"Type Parameters",id:"type-parameters-7",level:4},{value:"AppObjects",id:"appobjects-1",level:5},{value:"AppEvents",id:"appevents-1",level:5},{value:"Parameters",id:"parameters-10",level:4},{value:"params?",id:"params-5",level:5},{value:"Returns",id:"returns-15",level:4},{value:"isHosted()",id:"ishosted",level:3},{value:"Returns",id:"returns-16",level:4},{value:"isInitialized()",id:"isinitialized",level:3},{value:"Returns",id:"returns-17",level:4}];function p(e){const n={code:"code",del:"del",em:"em",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:"cmicroappguestappobjects-appevents",children:"CMicroAppGuest<AppObjects, AppEvents>"})}),"\n",(0,r.jsx)(n.p,{children:"Micro-frontend guest application class (singleton).\nManages communication between a guest micro-app and its host application.\nSupports both SSF (Shared Service Framework) and App Bridge communication methods."}),"\n",(0,r.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"const guest = new CMicroAppGuest({\n  onInit: ({ history, theme, prevState }) => {\n    console.log('Guest initialized');\n  },\n  onMount: ({ container }) => {\n    // Render your React app\n    ReactDOM.render(<App />, container);\n  },\n  onUnmount: ({ container }) => {\n    // Cleanup\n    ReactDOM.unmountComponentAtNode(container);\n    return { savedState: 'some data' };\n  }\n});\n"})}),"\n",(0,r.jsx)(n.h2,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h3,{id:"appobjects",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom scripting objects"}),"\n",(0,r.jsx)(n.h3,{id:"appevents",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.p,{children:"Type of custom event listeners"}),"\n",(0,r.jsx)(n.h2,{id:"implements",children:"Implements"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"IMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"accessors",children:"Accessors"}),"\n",(0,r.jsx)(n.h3,{id:"uuid",children:"uuid"}),"\n",(0,r.jsx)(n.h4,{id:"get-signature",children:"Get Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"get uuid(): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unique identifier for the microapp instance."}),"\n",(0,r.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.uuid\n"})}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n",(0,r.jsx)(n.h3,{id:"addscriptingobject",children:"addScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"addScriptingObject<SO>(so: SO, params?: AddScriptingObjectParams): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"add scripting object for child microapp to use"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so",children:"SO"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SO"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"IScriptingObject"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"so-1",children:"so"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"SO"})}),"\n",(0,r.jsx)(n.p,{children:"The scripting object to be added."}),"\n",(0,r.jsx)(n.h5,{id:"params",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"AddScriptingObjectParams"})}),"\n",(0,r.jsx)(n.p,{children:"Optional parameters for adding the scripting object."}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-1",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.addScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"dispatchevent",children:"dispatchEvent()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"dispatchEvent<EventId, Params, Options>(params: DispatchEventParam<EventId, Params, Options>): Promise<void | unknown[]>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Dispatches an event to the child microapp."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h5,{id:"params-1",children:"Params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Params"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"any"})]}),"\n",(0,r.jsx)(n.h5,{id:"options",children:"Options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Options"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventOptions"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-2",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"DispatchEventParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"Params"}),", ",(0,r.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Event parameters."}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"void"})," | ",(0,r.jsx)(n.code,{children:"unknown"}),"[]>"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves with the combined results of dispatched events."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-2",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.dispatchEvent\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"gethost",children:"getHost()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getHost(): \n  | IMicroAppHost<Partial<ScriptingObjectTypes>, Events>\n  | IMicroFEHost<Partial<ScriptingObjectTypes>, Events>\n  | SSFGuest<Partial<ScriptingObjectTypes>, Events>\n  | undefined;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:["| ",(0,r.jsx)(n.code,{children:"IMicroAppHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"IMicroFEHost"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"SSFGuest"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">\n| ",(0,r.jsx)(n.code,{children:"undefined"})]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getlogger",children:"getLogger()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getLogger(): MicroFrontEndLogger;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MicroFrontEndLogger"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getobject",children:"getObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getObject<ObjectId>(objectId: ObjectId): Promise<AppObjects[ObjectId] | null>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Retrieves a reference to a scripting object (or proxy) by its unique name."}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid",children:"ObjectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ObjectId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-1",children:"objectId"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ObjectId"})}),"\n",(0,r.jsx)(n.p,{children:"The unique name of the scripting object."}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),"[",(0,r.jsx)(n.code,{children:"ObjectId"}),"] | ",(0,r.jsx)(n.code,{children:"null"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["A promise that resolves to the scripting object reference or ",(0,r.jsx)(n.code,{children:"null"})," if not found."]}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-3",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getprops",children:"getProps()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getProps(): GuestProps<Partial<ScriptingObjectTypes>, Events>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"GuestProps"}),"<",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">, ",(0,r.jsx)(n.code,{children:"Events"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getref",children:(0,r.jsx)(n.del,{children:"getRef()"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"getRef<T>(): T | null;\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Retrieves a generic reference of type ",(0,r.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-4",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"t",children:"T"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"T"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"})," | ",(0,r.jsx)(n.code,{children:"null"})]}),"\n",(0,r.jsxs)(n.p,{children:["The reference of type ",(0,r.jsx)(n.code,{children:"T"})," or ",(0,r.jsx)(n.code,{children:"null"})," if not available."]}),"\n",(0,r.jsx)(n.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,r.jsx)(n.p,{children:"This method is deprecated and will be removed in future versions."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-4",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.getRef\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"init",children:"init()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"init(options: InitOptions<AppObjects, AppEvents>): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Initializes the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-1",children:"options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"InitOptions"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"Options for initializing the microapp."}),"\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.code,{children:"void"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves when initialization is complete."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-5",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.init\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"mount",children:"mount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"mount(options: MountOptions): Promise<void>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Mounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-2",children:"options"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"MountOptions"})," = ",(0,r.jsx)(n.code,{children:"..."})]}),"\n",(0,r.jsx)(n.p,{children:"Options for mounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-9",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 microapp is successfully mounted."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-6",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.mount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"navigate",children:"navigate()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"navigate(url: To, state?: any): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Navigates the microapp to a specified URL with an optional state."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"url",children:"url"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"To"})}),"\n",(0,r.jsx)(n.p,{children:"The target URL to navigate to."}),"\n",(0,r.jsx)(n.h5,{id:"state",children:"state?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"any"})}),"\n",(0,r.jsx)(n.p,{children:"Optional state to pass during navigation."}),"\n",(0,r.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-7",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.navigate\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removescriptingobject",children:"removeScriptingObject()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"removeScriptingObject(objectId: Extract<keyof AppObjects, string>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"removes scripting object from child microapp use"}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"objectid-2",children:"objectId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Extract"}),"<keyof ",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"unique id of the scripting object"}),"\n",(0,r.jsx)(n.h4,{id:"returns-11",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-8",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.removeScriptingObject\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"subscribe",children:"subscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"subscribe<EventId>(params: SubscribeParam<EventId, AppEvents[EventId]>): string;\n"})}),"\n",(0,r.jsx)(n.p,{children:"subscribe to the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-5",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-1",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-3",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"SubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),"[",(0,r.jsx)(n.code,{children:"EventId"}),"]>"]}),"\n",(0,r.jsx)(n.p,{children:"the parameters for the subscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-9",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.subscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unmount",children:"unmount()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unmount(options: MountOptions): Promise<JSONValue>;\n"})}),"\n",(0,r.jsx)(n.p,{children:"Unmounts the microapp with the provided options."}),"\n",(0,r.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"options-3",children:"options"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"MountOptions"})}),"\n",(0,r.jsx)(n.p,{children:"Options for unmounting the microapp."}),"\n",(0,r.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"JSONValue"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"A promise that resolves to a JSON value upon successful unmounting."}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-10",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unmount\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"unsubscribe",children:"unsubscribe()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"unsubscribe<EventId>(params: UnsubscribeParam<EventId>): void;\n"})}),"\n",(0,r.jsx)(n.p,{children:"unsubscribe from the scripting object event"}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-6",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"eventid-2",children:"EventId"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"EventId"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-4",children:"params"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"UnsubscribeParam"}),"<",(0,r.jsx)(n.code,{children:"EventId"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"parameters for the unsubscription"}),"\n",(0,r.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"void"})}),"\n",(0,r.jsx)(n.h4,{id:"implementation-of-11",children:"Implementation of"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"IMicroAppGuest.unsubscribe\n"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"getinstance",children:"getInstance()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static getInstance<AppObjects, AppEvents>(params?: ConstructorParams): CMicroAppGuest<AppObjects, AppEvents>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-7",children:"Type Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"appobjects-1",children:"AppObjects"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppObjects"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"ScriptingObjects"})," = ",(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"ScriptingObjectTypes"}),">"]}),"\n",(0,r.jsx)(n.h5,{id:"appevents-1",children:"AppEvents"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"AppEvents"})," ",(0,r.jsx)(n.em,{children:"extends"})," ",(0,r.jsx)(n.code,{children:"EventListeners"})," = ",(0,r.jsx)(n.code,{children:"Events"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsx)(n.h5,{id:"params-5",children:"params?"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"ConstructorParams"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-15",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"CMicroAppGuest"}),"<",(0,r.jsx)(n.code,{children:"AppObjects"}),", ",(0,r.jsx)(n.code,{children:"AppEvents"}),">"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"ishosted",children:"isHosted()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isHosted(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-16",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isinitialized",children:"isInitialized()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"static isInitialized(): boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"returns-17",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})})]})}function o(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}}}]);