smartsocket/dist/smartsocket.classes.socketfunction.d.ts

45 lines
1.3 KiB
TypeScript
Raw Permalink Normal View History

2018-03-15 01:29:40 +00:00
import * as plugins from './smartsocket.plugins';
2017-07-07 20:02:19 +00:00
import { SocketRole } from './smartsocket.classes.socketrole';
2016-08-09 21:37:25 +00:00
/**
* interface of the contructor options of class SocketFunction
*/
export interface ISocketFunctionConstructorOptions {
2016-08-09 21:37:25 +00:00
funcName: string;
funcDef: any;
allowedRoles: SocketRole[];
2016-08-09 09:42:21 +00:00
}
2016-08-09 21:37:25 +00:00
/**
* interface of the Socket Function call, in other words the object that routes a call to a function
2016-08-09 21:37:25 +00:00
*/
export interface ISocketFunctionCall {
funcName: string;
funcDataArg: any;
2016-08-07 16:59:39 +00:00
}
/**
* interface for function definition of SocketFunction
*/
export interface IFuncDef {
(dataArg: any): PromiseLike<any>;
}
2018-03-15 01:29:40 +00:00
export declare let allSocketFunctions: plugins.lik.Objectmap<SocketFunction>;
2016-08-09 09:42:21 +00:00
/**
2016-08-09 21:37:25 +00:00
* class that respresents a function that can be transparently called using a SocketConnection
2016-08-09 09:42:21 +00:00
*/
2016-08-07 16:59:39 +00:00
export declare class SocketFunction {
name: string;
funcDef: IFuncDef;
2016-08-07 16:59:39 +00:00
roles: SocketRole[];
2016-08-09 09:42:21 +00:00
/**
* the constructor for SocketFunction
*/
constructor(optionsArg: ISocketFunctionConstructorOptions);
2016-08-09 09:42:21 +00:00
/**
2017-07-07 20:02:19 +00:00
* invokes the function of this SocketFunction
2016-08-09 09:42:21 +00:00
*/
2017-07-07 20:02:19 +00:00
invoke(dataArg: ISocketFunctionCall): Promise<any>;
2016-08-09 09:42:21 +00:00
/**
2017-07-07 20:02:19 +00:00
* notifies a role about access to this SocketFunction
2016-08-09 09:42:21 +00:00
*/
2017-07-07 20:02:19 +00:00
private _notifyRole(socketRoleArg);
2016-08-07 16:59:39 +00:00
}