Show / Hide Table of Contents

Class UiExtensionParameters

Encapsulates the properties of an UiExtension parameter.

Inheritance
System.Object
UiExtensionParameters
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:Contentful.Core.Models.Management
Assembly:cs.temp.dll.dll
Syntax
public class UiExtensionParameters

Properties

Default

Default value to use for the parameter. Must match the type of parameter, i.e. a bool for a "Boolean" type.

Declaration
public dynamic Default { get; set; }
Property Value
Type Description
System.Object

Description

The description of the parameter.

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

Id

The id of the parameter.

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

Labels

Property to customize the labels for the parameter.

Declaration
public dynamic Labels { get; set; }
Property Value
Type Description
System.Object

Name

The name of the parameter.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Options

If the parameter is of type "Enum", this property is used to specify the values and labels that should be available as options.

Declaration
public List<object> Options { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.Object>

Required

Whether the parameter is required for the extension to work.

Declaration
public bool Required { get; set; }
Property Value
Type Description
System.Boolean

Type

The type of parameter, only allowed values are "Symbol", "Enum", "Number" and "Boolean".

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String
Back to top Copyright © 2015-2016 Contentful
Generated by DocFX