https://cromwellcms.com/assets/js/f47a2c74.aec24d64.js

1"use strict";(self.webpackChunk_cromwell_website=self.webpackChunk_cromwell_website||[]).push([[8383],{9776:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return l},contentTitle:function(){return s},metadata:function(){return o},toc:function(){return c},default:function(){return m}});var a=n(5773),r=n(808),p=(n(7378),n(5318)),i=["components"],l={title:"BasePageInput"},s="Class: BasePageInput",o={unversionedId:"api/classes/backend.BasePageInput",id:"api/classes/backend.BasePageInput",isDocsHomePage:!1,title:"BasePageInput",description:"backend.BasePageInput",source:"@site/docs/api/classes/backend.BasePageInput.md",sourceDirName:"api/classes",slug:"/api/classes/backend.BasePageInput",permalink:"/docs/api/classes/backend.BasePageInput",tags:[],version:"current",frontMatter:{title:"BasePageInput"},sidebar:"tutorialSidebar",previous:{title:"BasePageEntity",permalink:"/docs/api/classes/backend.BasePageEntity"},next:{title:"BasePageMeta",permalink:"/docs/api/classes/backend.BasePageMeta"}},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:"customMeta",id:"custommeta",children:[]},{value:"isEnabled",id:"isenabled",children:[]},{value:"meta",id:"meta",children:[]},{value:"pageDescription",id:"pagedescription",children:[]},{value:"pageTitle",id:"pagetitle",children:[]},{value:"slug",id:"slug",children:[]}]}],u={toc:c};function m(e){var t=e.components,n=(0,r.Z)(e,i);return(0,p.kt)("wrapper",(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("h1",{id:"class-basepageinput"},"Class: BasePageInput"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/backend"},"backend"),".BasePageInput"),(0,p.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("p",{parentName:"li"},(0,p.kt)("strong",{parentName:"p"},(0,p.kt)("inlineCode",{parentName:"strong"},"BasePageInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.AttributeInput"},(0,p.kt)("inlineCode",{parentName:"a"},"AttributeInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CouponInput"},(0,p.kt)("inlineCode",{parentName:"a"},"CouponInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CustomEntityInput"},(0,p.kt)("inlineCode",{parentName:"a"},"CustomEntityInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.OrderInput"},(0,p.kt)("inlineCode",{parentName:"a"},"OrderInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.PluginInput"},(0,p.kt)("inlineCode",{parentName:"a"},"PluginInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CreatePost"},(0,p.kt)("inlineCode",{parentName:"a"},"CreatePost"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.UpdatePost"},(0,p.kt)("inlineCode",{parentName:"a"},"UpdatePost"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CreateProductCategory"},(0,p.kt)("inlineCode",{parentName:"a"},"CreateProductCategory"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.UpdateProductCategory"},(0,p.kt)("inlineCode",{parentName:"a"},"UpdateProductCategory"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.ProductVariantInput"},(0,p.kt)("inlineCode",{parentName:"a"},"ProductVariantInput"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CreateProduct"},(0,p.kt)("inlineCode",{parentName:"a"},"CreateProduct"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.UpdateProduct"},(0,p.kt)("inlineCode",{parentName:"a"},"UpdateProduct"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.InputTag"},(0,p.kt)("inlineCode",{parentName:"a"},"InputTag"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.CreateUser"},(0,p.kt)("inlineCode",{parentName:"a"},"CreateUser"))),(0,p.kt)("p",{parentName:"li"},"\u21b3 ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/classes/backend.UpdateUser"},(0,p.kt)("inlineCode",{parentName:"a"},"UpdateUser"))))),(0,p.kt)("h2",{id:"implements"},"Implements"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("inlineCode",{parentName:"li"},"TBasePageEntityInput"))),(0,p.kt)("h2",{id:"table-of-contents"},"Table of contents"),(0,p.kt)("h3",{id:"constructors"},"Constructors"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#constructor"},"constructor"))),(0,p.kt)("h3",{id:"properties"},"Properties"),(0,p.kt)("ul",null,(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#custommeta"},"customMeta")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#isenabled"},"isEnabled")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#meta"},"meta")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#pagedescription"},"pageDescription")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#pagetitle"},"pageTitle")),(0,p.kt)("li",{parentName:"ul"},(0,p.kt)("a",{parentName:"li",href:"#slug"},"slug"))),(0,p.kt)("h2",{id:"constructors-1"},"Constructors"),(0,p.kt)("h3",{id:"constructor"},"constructor"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("strong",{parentName:"p"},"new BasePageInput"),"()"),(0,p.kt)("h2",{id:"properties-1"},"Properties"),(0,p.kt)("h3",{id:"custommeta"},"customMeta"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"customMeta"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,p.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,p.kt)("h4",{id:"implementation-of"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.customMeta"),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L32"},"system/core/backend/src/models/inputs/base-page.input.ts:32")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"isenabled"},"isEnabled"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"isEnabled"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"boolean")),(0,p.kt)("h4",{id:"implementation-of-1"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.isEnabled"),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L26"},"system/core/backend/src/models/inputs/base-page.input.ts:26")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"meta"},"meta"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"meta"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"TBasePageMeta")),(0,p.kt)("h4",{id:"implementation-of-2"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.meta"),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L29"},"system/core/backend/src/models/inputs/base-page.input.ts:29")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"pagedescription"},"pageDescription"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"pageDescription"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"string")),(0,p.kt)("h4",{id:"implementation-of-3"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.pageDescription"),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L23"},"system/core/backend/src/models/inputs/base-page.input.ts:23")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"pagetitle"},"pageTitle"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"pageTitle"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"string")),(0,p.kt)("h4",{id:"implementation-of-4"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.pageTitle"),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L20"},"system/core/backend/src/models/inputs/base-page.input.ts:20")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"slug"},"slug"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"slug"),": ",(0,p.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,p.kt)("inlineCode",{parentName:"p"},"string")),(0,p.kt)("h4",{id:"implementation-of-5"},"Implementation of"),(0,p.kt)("p",null,"TBasePageEntityInput.slug"),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/CromwellCMS/Cromwell/blob/master/system/core/backend/src/models/inputs/base-page.input.ts#L17"},"system/core/backend/src/models/inputs/base-page.input.ts:17")))}m.isMDXComponent=!0},5318:function(e,t,n){n.d(t,{Zo:function(){return c},kt:function(){return d}});var a=n(7378);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};

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