# Možnosti NEWACTION a objekt akcie prijíma

> Nastaviť NEWACTION a použiť akčný kontext na riešenie požiadaviek.

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

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

## Voľby

| Voľba | Hodnota | Čo robí |
|---|---|---|
| `name` | text | Popis akcie; dostupný je aj ako `$.name`. |
| `action` | `function($, model)` | Kód akcie. `model` je validovaný vstup. |
| `input` | text | Polia tela, ako `name:Type` oddelené čiarkami; `*` pred názvom ho robí povinným. Pozrite stránku o vstupných typoch. |
| `output` | text | Polia odpovede; polia, ktoré nie sú uvedené, sa odstránia. |
| `params` | text | Segmenty `{name}` routy, validované ako `input`. |
| `query` | text | Reťazec dotazu, validovaný ako `input`. |
| `partial` | `true` | Do akcie sa dostanú iba polia, ktoré boli odoslané. Použite pre `PATCH`. |
| `user` | `true` alebo `false` | `true` odpovie 401, keď nie je prihlásený používateľ; `false` akceptuje iba anonymné požiadavky. |
| `permissions` | text alebo pole | `'read,write'`: používateľ potrebuje jedno z nich (alebo byť superadministrátor). |
| `route` | text | Tu deklaruje routu akcie: `'GET /products/'`, alebo `true` pre routu `API`. |
| `middleware` | text | Názvy middleware, ktoré sa spustia pred akciou, oddelené medzerami alebo čiarkami. |
| `timeout` | milisekundy | Keď akcia neodpovie včas, požiadavka zlyhá s chybou `Timeout.`. |
| `cache` | `true` alebo objekt | Výsledok akcie si uložte cez `CACHE`. |
| `config` | objekt | Hodnoty, ktoré akcia číta z `$.config`. |
| `audit` | text | Po úspešnom dokončení zaznamená automatickú udalosť; hranice overuje samostatný recept. [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 `$` akcie

| Člen | Čo to je |
|---|---|
| `$.query`, `$.params` | Validovaný reťazec dotazu a segmenty routy. |
| `$.payload` | Validovaný vstup; je to ten istý objekt ako druhý argument `action`. |
| `$.user` | Prihlásený používateľ. |
| `$.config` | Voľba `config`. |
| `$.name`, `$.id` | Voľba `name` a id akcie. |
| `$.controller` | `$` routy, keď bola akcia volaná z routy, takže `$.controller.body` je nespracované telo. Neexistuje, keď sa akcia volá cez `ACTION()`. |
| `$.callback(value)` | Odpovie hodnotou; filtruje sa cez `output`. Bez argumentov vráti funkciu `(err, response)`. |
| `$.success(value)` | Odpovie `{ success: true }`. |
| `$.invalid(error)` | Odpovie chybou: textom, stavovým kódom alebo `ErrorBuilder`. |
| `$.done(arg)`, `$.successful(fn)` | Vracajú callbacky pre funkcie, ktoré hlásia chybu ako prvý argument. |
| `$.cookie(name, value, expiration)` | Číta alebo zapisuje cookie požiadavky. |
| `$.redirect(url)` | Presmeruje požiadavku. |
| `$.output(name)` | Vyberie, ako routa odpovie: `json`, `html`, `xml`, `text`, `redirect`, `binary`, `jsonstring`, `empty` alebo `file`. |
| `$.unauthorized(...permissions)` | Odpovie 401 a vráti `true`, keď používateľ nemá žiadne z oprávnení. |
| `$.action(name, payload)` | Spustí inú akciu s tou istou požiadavkou. |
| `$.hostname(path)` | Adresa tohto servera. |

```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');
};
```