ThemeFooterContentFragments In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:06:43 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:06:43

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

Methods

void Insert(Theme theme, Guid contextId, 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
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 existingContentFragmentType, ContentFragmentPlacement placement, string regionName, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Obsolete. Does not provide full support. Consider using Insert(Theme, Guid, 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
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 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
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 existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Obsolete. Does not provide full support. Consider using Insert(Theme, Guid, 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
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 existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	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 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
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 existingContentFragmentType, ContentFragmentPlacement placement, string contentFragmentType, string contentFragmentConfiguration, string contentFragmentWrappingFormat);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	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 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
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);

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

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`int`	Context Id	Required

Return Type

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

ConfiguredContentFragmentInformation[] List(Theme theme, Guid contextId);

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contextId	`Guid`	Context Id	Required

Return Type

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

ConfiguredContentFragmentInformation[] ListDefault(Theme theme);

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required

Return Type

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

ConfiguredContentFragmentInformation[] ListFactoryDefault(Theme theme);

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required

Return Type

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

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

Parameters

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

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

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

Parameters

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

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

Parameters

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

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

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

Parameters

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

void RemoveFromDefault(Theme theme, string contentFragmentType);

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromDefault(Theme theme, string regionName, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromFactoryDefault(Theme theme, string regionName, string contentFragmentType);

Parameters

Name	Type	Description	Required
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	Required
regionName	`string`	Region Name	Required
contentFragmentType	`string`	Content Fragment Type	Required

void RemoveFromFactoryDefault(Theme theme, string contentFragmentType);

Parameters

Name	Type	Description	Required	Default	Options
theme	`[[Theme In-Process API Supplementary Type\|Theme]]`	Theme	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 ReplaceInDefault(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 ReplaceInFactoryDefault(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