Class ContentChannelAdministration
Handles ContentChannels
Inheritance
System.Object
ContentChannelAdministration
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.ContentChannels
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public abstract class ContentChannelAdministrationConstructors
ContentChannelAdministration()
Initializes a new instance of the ContentChannelAdministration class.
Declaration
protected ContentChannelAdministration()Properties
Channels
Lists all registered channels
Declaration
public virtual IEnumerable<ContentChannel> Channels { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<ContentChannel> | The channels. |
Instance
Gets the singleton instance of the ContentChannelAdministration class.
Declaration
public static ContentChannelAdministration Instance { get; set; }Property Value
| Type | Description |
|---|---|
| ContentChannelAdministration | The instance. |
Item[String]
Gets the ContentChannel with the specified channel id.
Declaration
public virtual ContentChannel this[string channelId] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.String | channelId |
Property Value
| Type | Description |
|---|---|
| ContentChannel |
Methods
LoadChannels()
Loads the channels from storage
Declaration
protected abstract IList<ContentChannel> LoadChannels()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ContentChannel> |
RegisterChannel(ContentChannel)
Registers a channel
Declaration
public virtual void RegisterChannel(ContentChannel channel)Parameters
| Type | Name | Description |
|---|---|---|
| ContentChannel | channel | The channel. |
RemoveChannel(ContentChannel)
Removes the channel from storage
Declaration
protected abstract void RemoveChannel(ContentChannel channel)Parameters
| Type | Name | Description |
|---|---|---|
| ContentChannel | channel | The channel. |
SaveChannel(ContentChannel)
Saves the channel to storage
Declaration
protected abstract void SaveChannel(ContentChannel channel)Parameters
| Type | Name | Description |
|---|---|---|
| ContentChannel | channel | The channel. |
TryGetValue(String, out ContentChannel)
Tries to get the channle with specified id
Declaration
public virtual bool TryGetValue(string channelId, out ContentChannel channel)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | channelId | The channel id. |
| ContentChannel | channel | The channel. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if channel exist else false |
UnregisterChannel(String)
Unregisters a channel
Declaration
public virtual void UnregisterChannel(string channelId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | channelId | The channel id. |
UpdateChannel(ContentChannel)
Updates a channel
Declaration
public virtual void UpdateChannel(ContentChannel channel)Parameters
| Type | Name | Description |
|---|---|---|
| ContentChannel | channel | The channel. |
