https://cromwellcms.com/assets/js/d617b4f2.29d308b5.js

1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[5702],{4220:function(t,e,n){n.r(e),n.d(e,{frontMatter:function(){return s},contentTitle:function(){return o},metadata:function(){return p},toc:function(){return c},default:function(){return m}});var r=n(5773),i=n(808),a=(n(7378),n(5318)),l=["components"],s={title:"CustomEntityFilterInput"},o="Class: CustomEntityFilterInput",p={unversionedId:"api/classes/backend.CustomEntityFilterInput",id:"api/classes/backend.CustomEntityFilterInput",isDocsHomePage:!1,title:"CustomEntityFilterInput",description:"backend.CustomEntityFilterInput",source:"@site/docs/api/classes/backend.CustomEntityFilterInput.md",sourceDirName:"api/classes",slug:"/api/classes/backend.CustomEntityFilterInput",permalink:"/docs/api/classes/backend.CustomEntityFilterInput",tags:[],version:"current",frontMatter:{title:"CustomEntityFilterInput"},sidebar:"tutorialSidebar",previous:{title:"CustomEntity",permalink:"/docs/api/classes/backend.CustomEntity"},next:{title:"CustomEntityInput",permalink:"/docs/api/classes/backend.CustomEntityInput"}},c=[{value:"Hierarchy",id:"hierarchy",children:[]},{value:"Implements",id:"implements",children:[]},{value:"Table of contents",id:"table-of-contents",children:[{value:"Constructors",id:"constructors",children:[]},{value:"Properties",id:"properties",children:[]}]},{value:"Constructors",id:"constructors-1",children:[{value:"constructor",id:"constructor",children:[]}]},{value:"Properties",id:"properties-1",children:[{value:"entityType",id:"entitytype",children:[]},{value:"filters",id:"filters",children:[]},{value:"name",id:"name",children:[]},{value:"sorts",id:"sorts",children:[]}]}],u={toc:c};function m(t){var e=t.components,n=(0,i.Z)(t,l);return(0,a.kt)("wrapper",(0,r.Z)({},u,n,{components:e,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"class-customentityfilterinput"},"Class: CustomEntityFilterInput"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/backend"},"backend"),".CustomEntityFilterInput"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput"},(0,a.kt)("inlineCode",{parentName:"a"},"BaseFilterInput"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"CustomEntityFilterInput"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"TCustomEntityFilter"))),(0,a.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,a.kt)("h3",{id:"constructors"},"Constructors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#constructor"},"constructor"))),(0,a.kt)("h3",{id:"properties"},"Properties"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#entitytype"},"entityType")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#filters"},"filters")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#name"},"name")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#sorts"},"sorts"))),(0,a.kt)("h2",{id:"constructors-1"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new CustomEntityFilterInput"),"()"),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput"},"BaseFilterInput"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput#constructor"},"constructor")),(0,a.kt)("h2",{id:"properties-1"},"Properties"),(0,a.kt)("h3",{id:"entitytype"},"entityType"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"entityType"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"TCustomEntityFilter.entityType"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/filters/custom-entity.filter.ts#L10"},"system/core/backend/src/models/filters/custom-entity.filter.ts:10")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"filters"},"filters"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"filters"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.PropertySearch"},(0,a.kt)("inlineCode",{parentName:"a"},"PropertySearch")),"[]"),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,"TCustomEntityFilter.filters"),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput"},"BaseFilterInput"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput#filters"},"filters")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/filters/base-filter.filter.ts#L8"},"system/core/backend/src/models/filters/base-filter.filter.ts:8")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,a.kt)("p",null,"TCustomEntityFilter.name"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/filters/custom-entity.filter.ts#L13"},"system/core/backend/src/models/filters/custom-entity.filter.ts:13")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sorts"},"sorts"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sorts"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.SortByOptions"},(0,a.kt)("inlineCode",{parentName:"a"},"SortByOptions")),"[]"),(0,a.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,a.kt)("p",null,"TCustomEntityFilter.sorts"),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput"},"BaseFilterInput"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.BaseFilterInput#sorts"},"sorts")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/filters/base-filter.filter.ts#L11"},"system/core/backend/src/models/filters/base-filter.filter.ts:11")))}m.isMDXComponent=!0},5318:function(t,e,n){n.d(e,{Zo:function(){return c},kt:function(){return d}});var r=n(7378);function i(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function a(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);e&&(r=r.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,r)}return n}function l(t){for(var e=1;e<arguments.length;e++){var n=null!=arguments[e]?arguments[e]:{};

1e%2?a(Object(n),!0).forEach((function(e){i(t,e,n[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(n,e))}))}return t}function s(t,e){if(null==t)return{};var n,r,i=function(t,e){if(null==t)return{};var n,r,i={},a=Object.keys(t);for(r=0;r<a.length;r++)n=a[r],e.indexOf(n)>=0||(i[n]=t[n]);return i}(t,e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);for(r=0;r<a.length;r++)n=a[r],e.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(i[n]=t[n])}return i}var o=r.createContext({}),p=function(t){var e=r.useContext(o),n=e;return t&&(n="function"==typeof t?t(e):l(l({},e),t)),n},c=function(t){var e=p(t.components);return r.createElement(o.Provider,{value:e},t.children)},u={inlineCode:"code",wrapper:function(t){var e=t.children;return r.createElement(r.Fragment,{},e)}},m=r.forwardRef((function(t,e){var n=t.components,i=t.mdxType,a=t.originalType,o=t.parentName,c=s(t,["components","mdxType","originalType","parentName"]),m=p(n),d=i,f=m["".concat(o,".").concat(d)]||m[d]||u[d]||a;return n?r.createElement(f,l(l({ref:e},c),{},{components:n})):r.createElement(f,l({ref:e},c))}));function d(t,e){var n=arguments,i=e&&e.mdxType;if("string"==typeof t||i){var a=n.length,l=new Array(a);l[0]=m;var s={};for(var o in e)hasOwnProperty.call(e,o)&&(s[o]=e[o]);s.originalType=t,s.mdxType="string"==typeof t?t:i,l[1]=s;for(var p=2;p<a;p++)l[p]=n[p];return r.createElement.apply(null,l)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);