Search Results for

    Show / Hide Table of Contents

    Class ChannelUserLayoutConfig

    Channel user layout configuration.

    Inheritance
    System.Object
    LayoutConfig
    ChannelUserLayoutConfig
    Inherited Members
    LayoutConfig.Zone
    LayoutConfig.Priority
    Namespace: FM.LiveSwitch
    Assembly: FM.LiveSwitch.dll
    Syntax
    public class ChannelUserLayoutConfig : 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[]

    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 user layout config from JSON.

    Declaration
    public static ChannelUserLayoutConfig FromJson(string channelUserLayoutConfigJson)
    Parameters
    Type Name Description
    System.String channelUserLayoutConfigJson

    The channel user layout configuration as JSON.

    Returns
    Type Description
    ChannelUserLayoutConfig

    The channel user 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 user layout configuration to JSON.

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

    The channel user layout configuration as JSON.

    ToJson(ChannelUserLayoutConfig)

    Serializes a channel user layout config to JSON.

    Declaration
    public static string ToJson(ChannelUserLayoutConfig channelUserLayoutConfig)
    Parameters
    Type Name Description
    ChannelUserLayoutConfig channelUserLayoutConfig

    The channel user layout configuration.

    Returns
    Type Description
    System.String

    The channel user layout configuration as JSON.

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