ThemePageContentFragments In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 20:00:57 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:00:57

This service is available via Telligent.Evolution.Extensibility.UI.Version1.ThemePageContentFragments and is defined in Telligent.Evolution.Platform.dll

Methods

void Insert(Theme theme, Guid contextId, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string regionName, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void Insert(Theme theme, int contextId, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string regionName, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Obsolete. Does not provide full support. Consider using Insert(Theme, Guid, string, bool, string, ContentFragmentPlacement, string, string, string, string) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void Insert(Theme theme, Guid contextId, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void Insert(Theme theme, int contextId, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Obsolete. Does not provide full support. Consider using Insert(Theme, Guid, string, bool, string, ContentFragmentPlacement, string, string, string) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void InsertInDefault(Theme theme, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void InsertInDefault(Theme theme, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string regionName, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void InsertInFactoryDefault(Theme theme, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

void InsertInFactoryDefault(Theme theme, string pageName, bool isCustom, string existingContentFragmentType, ContentFragmentPlacement placement, string regionName, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
placement	`[[ContentFragmentPlacement In-Process API Supplementary Type\|ContentFragmentPlacement]]`	Placement	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required
contentFragmentConfiguration	`string`	Content Fragment Configuration	Required
contentFragmentWrappingFormat	`string`	Content Fragment Wrapping Format	Required

ConfiguredContentFragmentInformation[] List(Theme theme, int contextId, string pageName, bool isCustom);

Obsolete. Does not provide full support. Consider using List(Theme, Guid, string, bool) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required

Return Type

[[ConfiguredContentFragmentInformation In-Process API Supplementary Type|ConfiguredContentFragmentInformation]][]

ConfiguredContentFragmentInformation[] List(Theme theme, Guid contextId, string pageName, bool isCustom);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required

Return Type

[[ConfiguredContentFragmentInformation In-Process API Supplementary Type|ConfiguredContentFragmentInformation]][]

ConfiguredContentFragmentInformation[] ListDefault(Theme theme, string pageName, bool isCustom);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required

Return Type

[[ConfiguredContentFragmentInformation In-Process API Supplementary Type|ConfiguredContentFragmentInformation]][]

ConfiguredContentFragmentInformation[] ListFactoryDefault(Theme theme, string pageName, bool isCustom);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required

Return Type

[[ConfiguredContentFragmentInformation In-Process API Supplementary Type|ConfiguredContentFragmentInformation]][]

void Remove(Theme theme, Guid contextId, string pageName, bool isCustom, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
contentFragmentType	`string`	Content Fragment Type	Required

void Remove(Theme theme, int contextId, string pageName, bool isCustom, string contentFragmentType);

Obsolete. Does not provide full support. Consider using Remove(Theme, Guid, string, bool, string) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
contentFragmentType	`string`	Content Fragment Type	Required

void Remove(Theme theme, Guid contextId, string pageName, bool isCustom, string regionName, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void Remove(Theme theme, int contextId, string pageName, bool isCustom, string regionName, string contentFragmentType);

Obsolete. Does not provide full support. Consider using Remove(Theme, Guid, string, bool, string, string) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromDefault(Theme theme, string pageName, bool isCustom, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromDefault(Theme theme, string pageName, bool isCustom, string regionName, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromFactoryDefault(Theme theme, string pageName, bool isCustom, string regionName, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromFactoryDefault(Theme theme, string pageName, bool isCustom, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
pageName	`string`	Page Name	Required
isCustom	`bool`	Is Custom	Required
contentFragmentType	`string`	Content Fragment Type	Required

void Replace(Theme theme, Guid contextId, string existingContentFragmentType, string replacementContentFragmentType, string replacementContentFragmentConfiguration, string replacementContentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
replacementContentFragmentType	`string`	Replacement Content Fragment Type	Required
replacementContentFragmentConfiguration	`string`	Replacement Content Fragment Configuration	Required
replacementContentFragmentWrappingFormat	`string`	Replacement Content Fragment Wrapping Format	Required

void Replace(Theme theme, int contextId, string existingContentFragmentType, string replacementContentFragmentType, string replacementContentFragmentConfiguration, string replacementContentFragmentWrappingFormat);

Obsolete. Does not provide full support. Consider using Replace(Theme, Guid, string, string, string, string) instead.

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
replacementContentFragmentType	`string`	Replacement Content Fragment Type	Required
replacementContentFragmentConfiguration	`string`	Replacement Content Fragment Configuration	Required
replacementContentFragmentWrappingFormat	`string`	Replacement Content Fragment Wrapping Format	Required

void ReplaceInDefaults(Theme theme, string existingContentFragmentType, string replacementContentFragmentType, string replacementContentFragmentConfiguration, string replacementContentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
replacementContentFragmentType	`string`	Replacement Content Fragment Type	Required
replacementContentFragmentConfiguration	`string`	Replacement Content Fragment Configuration	Required
replacementContentFragmentWrappingFormat	`string`	Replacement Content Fragment Wrapping Format	Required

void ReplaceInFactoryDefaults(Theme theme, string existingContentFragmentType, string replacementContentFragmentType, string replacementContentFragmentConfiguration, string replacementContentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
existingContentFragmentType	`string`	Existing Content Fragment Type	Required
replacementContentFragmentType	`string`	Replacement Content Fragment Type	Required
replacementContentFragmentConfiguration	`string`	Replacement Content Fragment Configuration	Required
replacementContentFragmentWrappingFormat	`string`	Replacement Content Fragment Wrapping Format	Required