@rxap/remote-method/docs/markdown/classes/ProxyRemoteMethod.md

This package provides abstractions for defining and executing remote methods in Angular applications. It includes features such as automatic refreshing, proxying, and error handling. It offers a structured way to manage remote calls and their dependencies

[**@rxap/remote-method v19.0.4**](../README.md)

***

[@rxap/remote-method](../globals.md) / ProxyRemoteMethod

# Class: `abstract` ProxyRemoteMethod\<ReturnType, SourceParameter, TargetParameter\>

Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:17](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L17)

## Extends

- [`BaseRemoteMethod`](BaseRemoteMethod.md)\<`ReturnType`, `SourceParameter`\>

## Type Parameters

• **ReturnType** = `any`

• **SourceParameter** = `any`

• **TargetParameter** = `SourceParameter`

## Constructors

### new ProxyRemoteMethod()

> **new ProxyRemoteMethod**\<`ReturnType`, `SourceParameter`, `TargetParameter`\>(`remoteMethod`, `injector`, `metadata`): [`ProxyRemoteMethod`](ProxyRemoteMethod.md)\<`ReturnType`, `SourceParameter`, `TargetParameter`\>

Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:20](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L20)

#### Parameters

##### remoteMethod

[`BaseRemoteMethod`](BaseRemoteMethod.md)

##### injector

`null` | `Injector`

##### metadata

[`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md) = `remoteMethod.metadata`

#### Returns

[`ProxyRemoteMethod`](ProxyRemoteMethod.md)\<`ReturnType`, `SourceParameter`, `TargetParameter`\>

#### Overrides

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`constructor`](BaseRemoteMethod.md#constructors)

## Properties

### \_\_id

> **\_\_id**: `string`

Defined in: [packages/angular/definition/src/lib/definition.ts:61](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L61)

**`Internal`**

unique internal id

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`__id`](BaseRemoteMethod.md#__id)

***

### \_initialised

> `protected` **\_initialised**: `boolean` = `false`

Defined in: [packages/angular/definition/src/lib/definition.ts:62](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L62)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`_initialised`](BaseRemoteMethod.md#_initialised)

***

### destroyed$

> `readonly` **destroyed$**: `undefined` \| `Subject`\<`void`\>

Defined in: [packages/angular/definition/src/lib/definition.ts:48](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L48)

Emits if the data source is destroyed

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroyed$`](BaseRemoteMethod.md#destroyed$)

***

### executed$

> **executed$**: `Subject`\<`ReturnType`\>

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:42](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L42)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executed$`](BaseRemoteMethod.md#executed$)

***

### executionsInProgress$

> **executionsInProgress$**: `CounterSubject`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:44](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L44)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executionsInProgress$`](BaseRemoteMethod.md#executionsinprogress$)

***

### initialised$

> `readonly` **initialised$**: `undefined` \| `Subject`\<`void`\>

Defined in: [packages/angular/definition/src/lib/definition.ts:52](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L52)

Emits if the data source is initialised

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`initialised$`](BaseRemoteMethod.md#initialised$)

***

### injector

> `readonly` **injector**: `Injector`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:46](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L46)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`injector`](BaseRemoteMethod.md#injector-1)

***

### interceptors

> `readonly` **interceptors**: `undefined` \| `Set`\<`Subject`\<`any`\>\>

Defined in: [packages/angular/definition/src/lib/definition.ts:53](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L53)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`interceptors`](BaseRemoteMethod.md#interceptors)

***

### metadata

> **metadata**: [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)

Defined in: [packages/angular/definition/src/lib/definition.ts:44](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L44)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`metadata`](BaseRemoteMethod.md#metadata-1)

***

### destroyed$

> `readonly` `static` **destroyed$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>

Defined in: [packages/angular/definition/src/lib/definition.ts:41](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L41)

Emits when a new Definition instance is initialised

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroyed$`](BaseRemoteMethod.md#destroyed$-1)

***

### initialised$

> `readonly` `static` **initialised$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>

Defined in: [packages/angular/definition/src/lib/definition.ts:35](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L35)

Emits when a new Definition instance is initialised

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`initialised$`](BaseRemoteMethod.md#initialised$-1)

***

### instances

> `readonly` `static` **instances**: `Map`\<`string`, `BaseDefinition`\<`BaseDefinitionMetadata`\>\>

Defined in: [packages/angular/definition/src/lib/definition.ts:27](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L27)

A map of active Definition instances

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`instances`](BaseRemoteMethod.md#instances)

## Accessors

### id

#### Get Signature

> **get** **id**(): `string`

Defined in: [packages/angular/definition/src/lib/definition.ts:87](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L87)

##### Returns

`string`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`id`](BaseRemoteMethod.md#id)

## Methods

### \_call()

> `protected` **\_call**(`parameters`?): `Promise`\<`any`\>

Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:33](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L33)

#### Parameters

##### parameters?

`SourceParameter`

#### Returns

`Promise`\<`any`\>

#### Overrides

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`_call`](BaseRemoteMethod.md#_call)

***

### applyMetadata()

> **applyMetadata**(`partialMetadata`): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:111](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L111)

#### Parameters

##### partialMetadata

`Partial`\<[`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)\>

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`applyMetadata`](BaseRemoteMethod.md#applymetadata)

***

### call()

> **call**(`parameters`?): `Promise`\<`ReturnType`\>

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:76](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L76)

#### Parameters

##### parameters?

`SourceParameter`

#### Returns

`Promise`\<`ReturnType`\>

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`call`](BaseRemoteMethod.md#call)

***

### ~~destroy()~~

> **destroy**(): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:118](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L118)

#### Returns

`void`

#### Deprecated

use ngOnDestroy instead

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroy`](BaseRemoteMethod.md#destroy)

***

### executed()

> **executed**(`result`): `void`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:86](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L86)

#### Parameters

##### result

`ReturnType`

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executed`](BaseRemoteMethod.md#executed)

***

### getMetadata()

> **getMetadata**(): `null` \| [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)

Defined in: [packages/angular/definition/src/lib/definition.ts:107](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L107)

#### Returns

`null` \| [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`getMetadata`](BaseRemoteMethod.md#getmetadata)

***

### init()

> **init**(): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:127](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L127)

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`init`](BaseRemoteMethod.md#init)

***

### ngOnDestroy()

> **ngOnDestroy**(): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:122](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L122)

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

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`ngOnDestroy`](BaseRemoteMethod.md#ngondestroy)

***

### pauseRefresh()

> **pauseRefresh**(): `void`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:92](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L92)

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`pauseRefresh`](BaseRemoteMethod.md#pauserefresh)

***

### refresh()

> **refresh**(): `void`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:100](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L100)

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`refresh`](BaseRemoteMethod.md#refresh)

***

### resumeRefresh()

> **resumeRefresh**(): `void`

Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:96](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/base.remote-method.ts#L96)

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`resumeRefresh`](BaseRemoteMethod.md#resumerefresh)

***

### transformParameters()

> `abstract` **transformParameters**(`parameters`?): `TargetParameter` \| `Promise`\<`TargetParameter`\>

Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:31](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L31)

#### Parameters

##### parameters?

`SourceParameter`

#### Returns

`TargetParameter` \| `Promise`\<`TargetParameter`\>

***

### add()

> `static` **add**(`definition`): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:94](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L94)

#### Parameters

##### definition

`BaseDefinition`

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`add`](BaseRemoteMethod.md#add)

***

### remove()

> `static` **remove**(`definition`): `void`

Defined in: [packages/angular/definition/src/lib/definition.ts:102](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/definition/src/lib/definition.ts#L102)

#### Parameters

##### definition

`BaseDefinition`

#### Returns

`void`

#### Inherited from

[`BaseRemoteMethod`](BaseRemoteMethod.md).[`remove`](BaseRemoteMethod.md#remove)