Class Action

Represents available behavior exposed by an Entity.

Hierarchy

  • Action

Implements

Indexable

[extensions: string]: unknown

Constructors

Properties

Methods

Constructors

Properties

class: string[] = []

List of strings describing the nature of the Action based on the current representation. Possible values are implementation-dependent and should be documented.

fields: Field<unknown>[] = []

Input controls of the Action.

href: string

URI of the action

method: string = 'GET'

Protocol method used when submitting the Action. When missing, the default is assumed to be 'GET'.

name: string

Name identifying the action to be performed. Must be unique within an Entity's actions.

title?: string

Descriptive text about the Action.

type: string = 'application/x-www-form-urlencoded'

Encoding type indicating how fields are serialized when submitting the Action. When missing, the default is assumed to be 'application/x-www-form-urlencoded'.

Methods

  • Returns the Field in fields with the given name, if it exists. Otherwise, returns undefined.

    Parameters

    • name: string

    Returns undefined | Field<unknown>

Generated using TypeDoc