Class ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>`Abstract`

Type Parameters

ReturnType = any
SourceParameter = any
TargetParameter = SourceParameter

Hierarchy (View Summary)

BaseRemoteMethod<ReturnType, SourceParameter>
- ProxyRemoteMethod

Index

Constructors

Properties

__id _initialised destroyed$ executed$ executionsInProgress$ initialised$ injector interceptors metadata destroyed$ initialised$ instances

Accessors

Methods

_call applyMetadata call destroy executed getMetadata init ngOnDestroy pauseRefresh refresh resumeRefresh transformParameters add remove

Constructors

constructor

new ProxyRemoteMethod<
    ReturnType = any,
    SourceParameter = any,
    TargetParameter = SourceParameter,
>(
    remoteMethod: BaseRemoteMethod,
    injector?: null | Injector,
    metadata?: BaseRemoteMethodMetadata,
): ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>
Type Parameters
- ReturnType = any
- SourceParameter = any
- TargetParameter = SourceParameter
Parameters
- remoteMethod: BaseRemoteMethod
- injector: null | Injector = null
- metadata: BaseRemoteMethodMetadata = remoteMethod.metadata
Returns ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>
Overrides BaseRemoteMethod.constructor
- Defined in packages/angular/remote-method/src/lib/proxy.remote-method.ts:20

Properties

`Internal`__id

__id: string = ...

unique internal id

`Protected`_initialised

_initialised: boolean = false

`Readonly`destroyed$

destroyed$: undefined | Subject<void> = ...

Emits if the data source is destroyed

executed$

executed$: Subject<ReturnType> = ...

executionsInProgress$

executionsInProgress$: CounterSubject = ...

`Readonly`initialised$

initialised$: undefined | Subject<void> = ...

Emits if the data source is initialised

`Readonly`injector

injector: Injector

`Readonly`interceptors

interceptors: undefined | Set<Subject<any>> = ...

metadata

metadata: BaseRemoteMethodMetadata

`Static` `Readonly`destroyed$

destroyed$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`initialised$

initialised$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`instances

instances: Map<string, BaseDefinition<BaseDefinitionMetadata>> = ...

A map of active Definition instances

Accessors

id

get id(): string
Returns string
Inherited from BaseRemoteMethod.id
- Defined in packages/angular/definition/src/lib/definition.ts:87

Methods

destroy

destroy(): void
Returns void
Deprecated
use ngOnDestroy instead
Inherited from BaseRemoteMethod.destroy
- Defined in packages/angular/definition/src/lib/definition.ts:118

executed

executed(result: ReturnType): void
Parameters
- result: ReturnType
Returns void
Inherited from BaseRemoteMethod.executed
- Defined in packages/angular/remote-method/src/lib/base.remote-method.ts:86

getMetadata

getMetadata(): null | BaseRemoteMethodMetadata
Returns null | BaseRemoteMethodMetadata
Inherited from BaseRemoteMethod.getMetadata
- Defined in packages/angular/definition/src/lib/definition.ts:107

init

init(): void
Returns void
Inherited from BaseRemoteMethod.init
- Defined in packages/angular/definition/src/lib/definition.ts:127

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Inherited from BaseRemoteMethod.ngOnDestroy
- Defined in packages/angular/definition/src/lib/definition.ts:122

pauseRefresh

pauseRefresh(): void
Returns void
Inherited from BaseRemoteMethod.pauseRefresh
- Defined in packages/angular/remote-method/src/lib/base.remote-method.ts:92

refresh

refresh(): void
Returns void
Inherited from BaseRemoteMethod.refresh
- Defined in packages/angular/remote-method/src/lib/base.remote-method.ts:100

resumeRefresh

resumeRefresh(): void
Returns void
Inherited from BaseRemoteMethod.resumeRefresh
- Defined in packages/angular/remote-method/src/lib/base.remote-method.ts:96

`Abstract`transformParameters

transformParameters(
parameters?: SourceParameter,
): TargetParameter | Promise<TargetParameter>
Parameters
- Optionalparameters: SourceParameter
Returns TargetParameter | Promise<TargetParameter>
- Defined in packages/angular/remote-method/src/lib/proxy.remote-method.ts:31

`Static`add

add(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseRemoteMethod.add
- Defined in packages/angular/definition/src/lib/definition.ts:94

`Static`remove

remove(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseRemoteMethod.remove
- Defined in packages/angular/definition/src/lib/definition.ts:102

Class ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>

Properties

Internal__id

Protected_initialised

Readonlydestroyed$

executed$

executionsInProgress$

Readonlyinitialised$

Readonlyinjector

Readonlyinterceptors

metadata

Static Readonlydestroyed$

Static Readonlyinitialised$

Static Readonlyinstances

Accessors

id

Returns string

Methods

Protected_call

Parameters

Returns Promise<any>

applyMetadata

Parameters

Returns void

call

Parameters

Returns Promise<ReturnType>

destroy

Returns void

Deprecated

executed

Parameters

Returns void

getMetadata

Returns null | BaseRemoteMethodMetadata

init

Returns void

ngOnDestroy

Returns void

pauseRefresh

Returns void

refresh

Returns void

resumeRefresh

Returns void

AbstracttransformParameters

Parameters

Returns TargetParameter | Promise<TargetParameter>

Staticadd

Parameters

Returns void

Staticremove

Parameters

Returns void

Settings

On This Page

Class ProxyRemoteMethod<ReturnType, SourceParameter, TargetParameter>`Abstract`

`Internal`__id

`Protected`_initialised

`Readonly`destroyed$

`Readonly`initialised$

`Readonly`injector

`Readonly`interceptors

`Static` `Readonly`destroyed$

`Static` `Readonly`initialised$

`Static` `Readonly`instances

`Protected`_call

`Abstract`transformParameters

`Static`add

`Static`remove