https://cromwellcms.com/assets/js/90d55bad.45c6124b.js

1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[5207],{4865:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return s},contentTitle:function(){return o},metadata:function(){return p},toc:function(){return c},default:function(){return d}});var n=r(5773),l=r(808),a=(r(7378),r(5318)),i=["components"],s={title:"UserFilterInput"},o="Class: UserFilterInput",p={unversionedId:"api/classes/backend.UserFilterInput",id:"api/classes/backend.UserFilterInput",isDocsHomePage:!1,title:"UserFilterInput",description:"backend.UserFilterInput",source:"@site/docs/api/classes/backend.UserFilterInput.md",sourceDirName:"api/classes",slug:"/api/classes/backend.UserFilterInput",permalink:"/docs/api/classes/backend.UserFilterInput",tags:[],version:"current",frontMatter:{title:"UserFilterInput"},sidebar:"tutorialSidebar",previous:{title:"User",permalink:"/docs/api/classes/backend.User"},next:{title:"UserMeta",permalink:"/docs/api/classes/backend.UserMeta"}},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:"address",id:"address",children:[]},{value:"email",id:"email",children:[]},{value:"filters",id:"filters",children:[]},{value:"fullName",id:"fullname",children:[]},{value:"phone",id:"phone",children:[]},{value:"role",id:"role",children:[]},{value:"sorts",id:"sorts",children:[]}]}],m={toc:c};function d(e){var t=e.components,r=(0,l.Z)(e,i);return(0,a.kt)("wrapper",(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"class-userfilterinput"},"Class: UserFilterInput"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/backend"},"backend"),".UserFilterInput"),(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"},"UserFilterInput"))))),(0,a.kt)("h2",{id:"implements"},"Implements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"TUserFilter"))),(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:"#address"},"address")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#email"},"email")),(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:"#fullname"},"fullName")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#phone"},"phone")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"#role"},"role")),(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 UserFilterInput"),"()"),(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:"address"},"address"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"address"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.address"),(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/user.filter.ts#L19"},"system/core/backend/src/models/filters/user.filter.ts:19")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"email"},"email"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"email"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.email"),(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/user.filter.ts#L13"},"system/core/backend/src/models/filters/user.filter.ts:13")),(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-2"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.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-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/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:"fullname"},"fullName"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"fullName"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.fullName"),(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/user.filter.ts#L10"},"system/core/backend/src/models/filters/user.filter.ts:10")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"phone"},"phone"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"phone"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.phone"),(0,a.kt)("h4",{id:"defined-in-4"},"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/user.filter.ts#L16"},"system/core/backend/src/models/filters/user.filter.ts:16")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"role"},"role"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"role"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"TUserRole")),(0,a.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.role"),(0,a.kt)("h4",{id:"defined-in-5"},"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/user.filter.ts#L22"},"system/core/backend/src/models/filters/user.filter.ts:22")),(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-6"},"Implementation of"),(0,a.kt)("p",null,"TUserFilter.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-6"},"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")))}d.isMDXComponent=!0},5318:function(e,t,r){r.d(t,{Zo:function(){return c},kt:function(){return u}});var n=r(7378);function l(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};

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