Search Results for

    Show / Hide Table of Contents

    Class ChannelLayoutConfig

    Channel layout configuration.

    Inheritance
    System.Object
    LayoutConfig
    ChannelLayoutConfig
    Inherited Members
    LayoutConfig.Zone
    LayoutConfig.Priority
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public class ChannelLayoutConfig : LayoutConfig

    Properties

    ExcludedClientIds

    Gets or sets the client identifiers to exclude.

    Declaration
    public string[] ExcludedClientIds { get; set; }
    Property Value
    Type Description
    System.String[]

    ExcludedConnectionIds

    Gets or sets the connection identifiers to exclude.

    Declaration
    public string[] ExcludedConnectionIds { get; set; }
    Property Value
    Type Description
    System.String[]

    ExcludedDeviceIds

    Gets or sets the device identifiers to exclude.

    Declaration
    public string[] ExcludedDeviceIds { get; set; }
    Property Value
    Type Description
    System.String[]

    ExcludedUserIds

    Gets or sets the user identifiers to exclude.

    Declaration
    public string[] ExcludedUserIds { get; set; }
    Property Value
    Type Description
    System.String[]

    Methods

    DeserializeProperties(String, String)

    Deserializes the properties.

    Declaration
    protected override void DeserializeProperties(string key, string valueJson)
    Parameters
    Type Name Description
    System.String key

    The key.

    System.String valueJson

    The value in JSON format.

    Overrides
    LayoutConfig.DeserializeProperties(String, String)

    FromJson(String)

    Deserializes a channel layout config from JSON.

    Declaration
    public static ChannelLayoutConfig FromJson(string channelLayoutConfigJson)
    Parameters
    Type Name Description
    System.String channelLayoutConfigJson

    The channel layout configuration as JSON.

    Returns
    Type Description
    ChannelLayoutConfig

    The channel layout configuration.

    SerializeProperties(Dictionary<String, String>)

    Serializes the properties.

    Declaration
    protected override void SerializeProperties(Dictionary<string, string> jsonObject)
    Parameters
    Type Name Description
    Dictionary<System.String, System.String> jsonObject

    The JSON object.

    Overrides
    LayoutConfig.SerializeProperties(Dictionary<String, String>)

    ToJson()

    Serializes this channel layout configuration to JSON.

    Declaration
    public string ToJson()
    Returns
    Type Description
    System.String

    The channel layout configuration as JSON.

    ToJson(ChannelLayoutConfig)

    Serializes a channel layout config to JSON.

    Declaration
    public static string ToJson(ChannelLayoutConfig channelLayoutConfig)
    Parameters
    Type Name Description
    ChannelLayoutConfig channelLayoutConfig

    The layout configuration.

    Returns
    Type Description
    System.String

    The channel layout configuration as JSON.

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.16.0