Search Results for

    Show / Hide Table of Contents

    Class CustomerInfo

    Customer configuration information

    Inheritance
    object
    CustomerInfo
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class CustomerInfo

    Properties

    AnonymousAccessEnabled

    True if anonymous access to customer's UI is allowed.

    Declaration
    [JsonProperty("anonymousAccessEnabled", Required = Required.Always)]
    public bool AnonymousAccessEnabled { get; set; }
    Property Value
    bool

    ApiUrl

    The base API URL.

    Declaration
    [JsonProperty("apiUrl", Required = Required.Always)]
    [Required]
    public string ApiUrl { get; set; }
    Property Value
    string

    Apps

    Apps registered for this customer

    Declaration
    [JsonProperty("apps", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<CustomerApp> Apps { get; set; }
    Property Value
    ICollection<CustomerApp>

    BaseUrl

    Url to access Frontend service

    Declaration
    [JsonProperty("baseUrl", Required = Required.Always)]
    [Required]
    public string BaseUrl { get; set; }
    Property Value
    string

    BoostValues

    Boost levels that can be applied to a metadata field to boost the the significance of the field in a search operation.

    Declaration
    [JsonProperty("boostValues", Required = Required.Always)]
    [Required]
    public ICollection<double> BoostValues { get; set; }
    Property Value
    ICollection<double>

    CloudName

    Cloud name customer is located in.

    Declaration
    [JsonProperty("cloudName", Required = Required.Always)]
    [Required]
    public string CloudName { get; set; }
    Property Value
    string

    CustomerAlias

    Alias of the customer instance.

    Declaration
    [JsonProperty("customerAlias", Required = Required.Always)]
    [Required]
    public string CustomerAlias { get; set; }
    Property Value
    string

    CustomerId

    The customer ID.

    Declaration
    [JsonProperty("customerId", Required = Required.Always)]
    [Required]
    public string CustomerId { get; set; }
    Property Value
    string

    EnableQueryDetails

    Information if the query details can be enabled when searching. For debug purposes only.

    Declaration
    [JsonProperty("enableQueryDetails", Required = Required.Always)]
    public bool EnableQueryDetails { get; set; }
    Property Value
    bool

    HasDashboard

    True if a dashboard overview template is available.

    Declaration
    [JsonProperty("hasDashboard", Required = Required.Always)]
    public bool HasDashboard { get; set; }
    Property Value
    bool

    IdentityServerUrl

    The base URL of identity server to authenticate the user using OpenID Connect.

    Declaration
    [JsonProperty("identityServerUrl", Required = Required.Always)]
    [Required]
    public string IdentityServerUrl { get; set; }
    Property Value
    string

    IntegrationHost

    Host for integrations (Service Providers)

    Declaration
    [JsonProperty("integrationHost", Required = Required.Always)]
    [Required]
    public string IntegrationHost { get; set; }
    Property Value
    string

    LanguageConfiguration

    Configured languages of customer instance (system, metadata, share, default).

    Declaration
    [JsonProperty("languageConfiguration", Required = Required.Always)]
    public LanguageConfigurationInfo LanguageConfiguration { get; set; }
    Property Value
    LanguageConfigurationInfo

    Languages

    Languages including translations for the configured system and metadata and share languages.

    Declaration
    [JsonProperty("languages", Required = Required.Always)]
    [Required]
    public ICollection<Language> Languages { get; set; }
    Property Value
    ICollection<Language>

    LicenseInformation

    License options and states

    Declaration
    [JsonProperty("licenseInformation", Required = Required.Always)]
    [Required]
    public LicenseInfo LicenseInformation { get; set; }
    Property Value
    LicenseInfo

    LogosUrl

    Base bath to access logos of customer (including trailing slash), available images: name, full, small, background

    Declaration
    [JsonProperty("logosUrl", Required = Required.Always)]
    [Required]
    public string LogosUrl { get; set; }
    Property Value
    string

    ModificationDate

    Declaration
    [JsonProperty("modificationDate", Required = Required.Always)]
    [Required]
    public DateTime ModificationDate { get; set; }
    Property Value
    DateTime

    Name

    The name of the customer instance.

    Declaration
    [JsonProperty("name", Required = Required.Always)]
    [Required]
    public string Name { get; set; }
    Property Value
    string

    OutputFormats

    Configured rendering outputs including translations for the customer instance.

    Declaration
    [JsonProperty("outputFormats", Required = Required.Always)]
    [Required]
    public ICollection<OutputFormatInfo> OutputFormats { get; set; }
    Property Value
    ICollection<OutputFormatInfo>

    Settings

    Customer settings

    Declaration
    [JsonProperty("settings", Required = Required.Always)]
    [Required]
    public CustomerInfoSettings Settings { get; set; }
    Property Value
    CustomerInfoSettings

    Methods

    FromJson(string)

    Declaration
    public static CustomerInfo FromJson(string data)
    Parameters
    string data

    Returns
    CustomerInfo

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX