573fd2cd.1d7c5550.js

"use strict";(self.webpackChunkadminforth=self.webpackChunkadminforth||[]).push([[9579],{1788:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>a,frontMatter:()=>i,metadata:()=>t,toc:()=>h});const t=JSON.parse('{"id":"api/Back/interfaces/IOperationalResource","title":"IOperationalResource","description":"Properties","source":"@site/docs/api/Back/interfaces/IOperationalResource.md","sourceDirName":"api/Back/interfaces","slug":"/api/Back/interfaces/IOperationalResource","permalink":"/docs/api/Back/interfaces/IOperationalResource","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"apiSidebar","previous":{"title":"IHttpServer","permalink":"/docs/api/Back/interfaces/IHttpServer"},"next":{"title":"IWebSocketBroker","permalink":"/docs/api/Back/interfaces/IWebSocketBroker"}}');var s=n(4848),l=n(8453);const i={},d="IOperationalResource",c={},h=[{value:"Properties",id:"properties",level:2},{value:"count()",id:"count",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"create()",id:"create",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"createdRecord",id:"createdrecord",level:5},{value:"error?",id:"error",level:5},{value:"ok",id:"ok",level:5},{value:"dataConnector",id:"dataconnector",level:3},{value:"delete()",id:"delete",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"get()",id:"get",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"list()",id:"list",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"update()",id:"update",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4}];function o(e){const r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(r.header,{children:(0,s.jsx)(r.h1,{id:"ioperationalresource",children:"IOperationalResource"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(r.h3,{id:"count",children:"count()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"count"}),": (",(0,s.jsx)(r.code,{children:"filter"}),") => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"number"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"filter"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})})," | (",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})}),")[]"]})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"number"}),">"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"create",children:"create()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"create"}),": (",(0,s.jsx)(r.code,{children:"record"}),") => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"object"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"record"})}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"any"})})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"object"}),">"]}),"\n",(0,s.jsx)(r.h5,{id:"createdrecord",children:"createdRecord"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"createdRecord"}),": ",(0,s.jsx)(r.code,{children:"any"})]}),"\n"]}),"\n",(0,s.jsx)(r.h5,{id:"error",children:"error?"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"optional"})," ",(0,s.jsx)(r.strong,{children:"error"}),": ",(0,s.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsx)(r.h5,{id:"ok",children:"ok"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"ok"}),": ",(0,s.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"dataconnector",children:"dataConnector"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"dataConnector"}),": ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthDataSourceConnectorBase",children:(0,s.jsx)(r.code,{children:"IAdminForthDataSourceConnectorBase"})})]}),"\n"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"delete",children:"delete()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"delete"}),": (",(0,s.jsx)(r.code,{children:"primaryKey"}),") => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"primaryKey"})}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"any"})})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"boolean"}),">"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"get",children:"get()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"get"}),": (",(0,s.jsx)(r.code,{children:"filter"}),") => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsx)(r.tbody,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"filter"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})})," | (",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})}),")[]"]})]})})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),">"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"list",children:"list()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"list"}),": (",(0,s.jsx)(r.code,{children:"filter"}),", ",(0,s.jsx)(r.code,{children:"limit"}),"?, ",(0,s.jsx)(r.code,{children:"offset"}),"?, ",(0,s.jsx)(r.code,{children:"sort"}),"?) => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),"[]>"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"filter"})}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})})," | (",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSingleFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthSingleFilter"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthAndOrFilter",children:(0,s.jsx)(r.code,{children:"IAdminForthAndOrFilter"})}),")[]"]})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.code,{children:"limit"}),"?"]}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"number"})})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.code,{children:"offset"}),"?"]}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"number"})})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.code,{children:"sort"}),"?"]}),(0,s.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSort",children:(0,s.jsx)(r.code,{children:"IAdminForthSort"})})," | ",(0,s.jsx)(r.a,{href:"/docs/api/Back/interfaces/IAdminForthSort",children:(0,s.jsx)(r.code,{children:"IAdminForthSort"})}),"[]"]})]})]})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),"[]>"]}),"\n",(0,s.jsx)(r.hr,{}),"\n",(0,s.jsx)(r.h3,{id:"update",children:"update()"}),"\n",(0,s.jsxs)(r.blockquote,{children:["\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"update"}),": (",(0,s.jsx)(r.code,{children:"primaryKey"}),", ",(0,s.jsx)(r.code,{children:"record"}),") => ",(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,s.jsx)(r.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Parameter"}),(0,s.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"primaryKey"})}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"any"})})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"record"})}),(0,s.jsx)(r.td,{style:{textAlign:"left"},children:(0,s.jsx)(r.code,{children:"any"})})]})]})]}),"\n",(0,s.jsx)(r.h4,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Promise"}),"<",(0,s.jsx)(r.code,{children:"any"}),">"]})]})}function a(e={}){const{wrapper:r}={...(0,l.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>i,x:()=>d});var t=n(6540);const s={},l=t.createContext(s);function i(e){const r=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),t.createElement(l.Provider,{value:r},e.children)}}}]);