# Možnosti NEWACTION a předmět akce přijímá

> Nastavení NEWACTION a použití akčního kontextu pro zpracování žádostí.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: cs
Content-SHA256: ffb996592c9baff5124b3def55d6d03c92733c2eecaf2259f7ed4484b41b97ec
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

`NEWACTION(name, options)` deklaruje akci. `name` je její id (`Users/insert`): routy ho používají přes `--> *Users/insert` a váš kód přes `ACTION('Users/insert', payload)`.

## Volby

| Volba | Hodnota | Co dělá |
|---|---|---|
| `name` | text | Popis akce; je dostupný také jako `$.name`. |
| `action` | `function($, model)` | Kód akce. `model` je validovaný vstup. |
| `input` | text | Pole těla, jako `name:Type` oddělená čárkami; `*` před názvem je činí povinným. Viz stránka o vstupních typech. |
| `output` | text | Pole odpovědi; pole, která nejsou uvedena, se odstraní. |
| `params` | text | Segmenty `{name}` routy, validované jako `input`. |
| `query` | text | Řetězec dotazu, validovaný jako `input`. |
| `partial` | `true` | Do akce se dostanou pouze pole, která byla odeslána. Použijte pro `PATCH`. |
| `user` | `true` nebo `false` | `true` odpoví 401, když není přihlášen uživatel; `false` přijímá pouze anonymní požadavky. |
| `permissions` | text nebo pole | `'read,write'`: uživatel potřebuje jedno z nich (nebo být superadministrátor). |
| `route` | text | Zde deklaruje routu akce: `'GET /products/'`, nebo `true` pro routu `API`. |
| `middleware` | text | Názvy middleware, které se spustí před akcí, oddělené mezerami nebo čárkami. |
| `timeout` | milisekundy | Když akce neodpoví včas, požadavek selže s chybou `Timeout.`. |
| `cache` | `true` nebo objekt | Výsledek akce uložte přes `CACHE`. |
| `config` | objekt | Hodnoty, které akce čte z `$.config`. |
| `audit` | text | Po úspěšném dokončení zaznamená událost; samostatný recept ověřuje hranice. [action-audit](/en/total5/action-audit/) |
| `csrf`, `encrypt`, `compress`, `publish` | - | [action-transport-boundaries](/en/total5/action-transport-boundaries/) |
| `sa`, `su` | true | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |
| `oninput`, `onoutput` | function | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |
| `extend` | path | [action-hooks-and-admin](/en/total5/action-hooks-and-admin/) |

## Objekt `$` akce

| Člen | Co to je |
|---|---|
| `$.query`, `$.params` | Validovaný řetězec dotazu a segmenty routy. |
| `$.payload` | Validovaný vstup; je to stejný objekt jako druhý argument `action`. |
| `$.user` | Přihlášený uživatel. |
| `$.config` | Volba `config`. |
| `$.name`, `$.id` | Volba `name` a id akce. |
| `$.controller` | `$` routy, když byla akce volána z routy, takže `$.controller.body` je nezpracované tělo. Neexistuje, když se akce volá přes `ACTION()`. |
| `$.callback(value)` | Odpoví hodnotou; filtruje se přes `output`. Bez argumentů vrátí funkci `(err, response)`. |
| `$.success(value)` | Odpoví `{ success: true }`. |
| `$.invalid(error)` | Odpoví chybou: textem, stavovým kódem nebo `ErrorBuilder`. |
| `$.done(arg)`, `$.successful(fn)` | Vracejí callbacky pro funkce, které hlásí chybu jako první argument. |
| `$.cookie(name, value, expiration)` | Čte nebo zapisuje cookie požadavku. |
| `$.redirect(url)` | Přesměruje požadavek. |
| `$.output(name)` | Vybere, jak routa odpoví: `json`, `html`, `xml`, `text`, `redirect`, `binary`, `jsonstring`, `empty` nebo `file`. |
| `$.unauthorized(...permissions)` | Odpoví 401 a vrátí `true`, když uživatel nemá žádné z oprávnění. |
| `$.action(name, payload)` | Spustí jinou akci se stejným požadavkem. |
| `$.hostname(path)` | Adresa tohoto serveru. |

```js definitions/options.js
MIDDLEWARE('tag', function($, next) {
	$.response.headers['x-tag'] = 'on';
	next();
});

var counter = { cached: 0 };
MAIN.counter = counter;

NEWACTION('Options/named', {
	name: 'The name',
	config: { limit: 3 },
	action: function($) {
		$.callback({ name: $.name, id: $.id, limit: $.config.limit });
	}
});

NEWACTION('Options/guarded', {
	name: 'Needs a user',
	user: true,
	permissions: 'read',
	action: function($) {
		$.success();
	}
});

NEWACTION('Options/slow', {
	name: 'Never answers',
	timeout: 300,
	action: function($) {}
});

NEWACTION('Options/cached', {
	name: 'The cache option',
	query: 'page:Number',
	cache: { expire: '1 minute', query: 'page' },
	action: function($) {
		counter.cached++;
		$.callback({ page: $.query.page, runs: counter.cached });
	}
});

NEWACTION('Options/routed', {
	name: 'Declares its own route',
	route: 'GET /routed/ #tag',
	action: function($) {
		$.callback({ routed: true });
	}
});

NEWACTION('Options/output', {
	name: 'Chooses how to answer',
	action: function($) {
		$.output('plain');
		$.callback('plain text');
	}
});

AUTH(function($) {
	if ($.headers['x-user'])
		$.success({ id: '1', permissions: $.headers['x-user'].split(',') });
	else
		$.invalid();
});
```

```js controllers/options.js
exports.install = function() {
	ROUTE('GET /named/ --> *Options/named');
	ROUTE('GET /guarded/ --> *Options/guarded');
	ROUTE('GET /slow/ --> *Options/slow');
	ROUTE('GET /cached/ --> *Options/cached');
	ROUTE('GET /output/ --> *Options/output');
};
```