Search Results for

    Show / Hide Table of Contents

    Class AppInfo

    Contains information about an application wishing to use the Chroma SDK.

    Inheritance
    Object
    AppInfo
    Namespace: Colore.Data
    Assembly: Colore.dll
    Syntax
    public sealed class AppInfo : Object

    Constructors

    AppInfo(String, String, String, String, Category)

    Initializes a new instance of the AppInfo class, set to support all available devices.

    Declaration
    public AppInfo(string title, string description, string authorName, string authorContact, Category category)
    Parameters
    Type Name Description
    String title

    Application title.

    String description

    Application description.

    String authorName

    Name of the application author.

    String authorContact

    Contact information for the author.

    Category category

    Application category.

    AppInfo(String, String, String, String, IEnumerable<ApiDeviceType>, Category)

    Initializes a new instance of the AppInfo class.

    Declaration
    public AppInfo(string title, string description, string authorName, string authorContact, IEnumerable<ApiDeviceType> supportedDevices, Category category)
    Parameters
    Type Name Description
    String title

    Application title.

    String description

    Application description.

    String authorName

    Name of the application author.

    String authorContact

    Contact information for the author.

    IEnumerable<ApiDeviceType> supportedDevices

    List of devices this application supports.

    Category category

    Application category.

    Exceptions
    Type Condition
    ArgumentNullException

    Thrown if a required parameter is null.

    Properties

    Author

    Gets author information for this application.

    Declaration
    public Author Author { get; }
    Property Value
    Type Description
    Author

    Category

    Gets the category of this application.

    Declaration
    public Category Category { get; }
    Property Value
    Type Description
    Category

    Description

    Gets the application description.

    Declaration
    public string Description { get; }
    Property Value
    Type Description
    String

    SupportedDevices

    Gets a list of devices this application supports.

    Declaration
    public IReadOnlyCollection<ApiDeviceType> SupportedDevices { get; }
    Property Value
    Type Description
    IReadOnlyCollection<ApiDeviceType>
    Remarks

    Newtonsoft.Json cannot deserialize into an IEnumerable<T>, but since we only serialize this class, it will not be an issue.

    Title

    Gets the title of this application.

    Declaration
    public string Title { get; }
    Property Value
    Type Description
    String
    In This Article
    Back to top Copyright © 2015-2021 by Adam Hellberg and Brandon Scott
    Generated by DocFX