Home Reference Source
public class | source

Action

Example:

import { Action } from 'remote-protocol';

const action = new Action();

Method Summary

Public Methods
public

exec(session: Session): undefined | Promise

Execute the action.

public

fetch(session: Session): *

Fetch the action value.

public

Returns an arguments list for creating this instance remotely.

public

Get a string that represent this class.

Public Methods

public exec(session: Session): undefined | Promise source

Execute the action.

Params:

NameTypeAttributeDescription
session Session

The current action session

Return:

undefined | Promise

Returns undefined or a Promise if execution is asynchronous

Throw:

Error

If there is a reason to close the session

See:

public fetch(session: Session): * source

Fetch the action value.

Params:

NameTypeAttributeDescription
session Session

The current action session

Return:

*

The action value

Throw:

Error

If there is any error

public toArgumentsList(): Array source

Returns an arguments list for creating this instance remotely.

Return:

Array

The arguments list

See:

public toString(): string source

Get a string that represent this class.

Return:

string

The class constructor name