Files
onspring-api-sdk-javascript/src/models/ListField.ts
T

58 lines
1.8 KiB
TypeScript

import { type FieldStatus } from '../enums/FieldStatus';
import { type FieldType } from '../enums/FieldType';
import { type Multiplicity } from '../enums/Multiplicity';
import { Field } from './Field';
import { type ListValue } from './ListValue';
/**
* @class ListField - Represents a list field.
*/
export class ListField extends Field {
/**
* @property {Multiplicity} multiplicity - The multiplicity of the list field.
*/
public multiplicity: Multiplicity;
/**
* @property {number} listId - The id of the list the list field belongs to.
*/
public listId: number;
/**
* @property {ListValue[]} values - The list values of the list field.
*/
public values: ListValue[];
/**
* @constructor - Creates a new ListField.
* @param {number} id - The id of the list field.
* @param {number} appId - The id of the app the list field belongs to.
* @param {string} name - The name of the list field.
* @param {FieldType} type - The type of the list field.
* @param {FieldStatus} status - The status of the list field.
* @param {boolean} isRequired - Whether the list field is required.
* @param {boolean} isUnique - Whether the list field is unique.
* @param {Multiplicity} multiplicity - The multiplicity of the list field.
* @param {number} listId - The id of the list the list field belongs to.
* @param {ListValue[]} values - The list values of the list field.
* @returns {ListField} - A new ListField.
*/
constructor(
id: number,
appId: number,
name: string,
type: FieldType,
status: FieldStatus,
isRequired: boolean,
isUnique: boolean,
multiplicity: Multiplicity,
listId: number,
values: ListValue[]
) {
super(id, appId, name, type, status, isRequired, isUnique);
this.multiplicity = multiplicity;
this.listId = listId;
this.values = values;
}
}