Constructor
new CategoryUpdate(clientnullable, categorynullable)
CategoryUpdate Constructor.
CategoryUpdate Constructor.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
client |
Client |
<nullable> |
||
category |
Category |
<nullable> |
null |
Methods
createResponse() → {Response}
Create a response object from the response data.
Create a response object from the response data.
- Source:
Returns:
- Type
- Response
getCategoryActive() → {boolean}
Get Category_Active.
Get Category_Active.
- Source:
Returns:
- Type
- boolean
getCategoryAlternateDisplayPage() → {string}
Get Category_Alternate_Display_Page.
Get Category_Alternate_Display_Page.
- Source:
Returns:
- Type
- string
getCategoryCode() → {string}
Get Category_Code.
Get Category_Code.
- Source:
Returns:
- Type
- string
getCategoryId() → {number}
Get Category_ID.
Get Category_ID.
- Source:
Returns:
- Type
- number
getCategoryName() → {string}
Get Category_Name.
Get Category_Name.
- Source:
Returns:
- Type
- string
getCategoryPageTitle() → {string}
Get Category_Page_Title.
Get Category_Page_Title.
- Source:
Returns:
- Type
- string
getCategoryParentCategory() → {string}
Get Category_Parent_Category.
Get Category_Parent_Category.
- Source:
Returns:
- Type
- string
getCustomFieldValues() → (nullable) {CustomFieldValues}
Get CustomField_Values.
Get CustomField_Values.
- Source:
Returns:
- Type
- CustomFieldValues
getEditCategory() → {string}
Get Edit_Category.
Get Edit_Category.
- Source:
Returns:
- Type
- string
setCategoryActive(categoryActive) → {CategoryUpdate}
Set Category_Active.
Set Category_Active.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryActive |
boolean |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryAlternateDisplayPage(categoryAlternateDisplayPage) → {CategoryUpdate}
Set Category_Alternate_Display_Page.
Set Category_Alternate_Display_Page.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryAlternateDisplayPage |
string |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryCode(categoryCode) → {CategoryUpdate}
Set Category_Code.
Set Category_Code.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryCode |
string |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryId(categoryId) → {CategoryUpdate}
Set Category_ID.
Set Category_ID.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryId |
number |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryName(categoryName) → {CategoryUpdate}
Set Category_Name.
Set Category_Name.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryName |
string |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryPageTitle(categoryPageTitle) → {CategoryUpdate}
Set Category_Page_Title.
Set Category_Page_Title.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryPageTitle |
string |
- Source:
Returns:
- Type
- CategoryUpdate
setCategoryParentCategory(categoryParentCategory) → {CategoryUpdate}
Set Category_Parent_Category.
Set Category_Parent_Category.
Parameters:
| Name | Type | Description |
|---|---|---|
categoryParentCategory |
string |
- Source:
Returns:
- Type
- CategoryUpdate
setCustomFieldValues(customFieldValuesnullable) → {CategoryUpdate}
Set CustomField_Values.
Set CustomField_Values.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
customFieldValues |
CustomFieldValues |
<nullable> |
- Source:
Throws:
Returns:
- Type
- CategoryUpdate
setEditCategory(editCategory) → {CategoryUpdate}
Set Edit_Category.
Set Edit_Category.
Parameters:
| Name | Type | Description |
|---|---|---|
editCategory |
string |
- Source:
Returns:
- Type
- CategoryUpdate
toObject() → {Object}
Reduce the request to a an object.
Reduce the request to a an object.
- Source:
Returns:
- Type
- Object