Documentation / @imvu/client / XmlRpcCoordinator

Class: XmlRpcCoordinator

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:46

Owns the client's XML-RPC gateway session. Logs in lazily on the first call, persists the session across runs, re-authenticates once when the server reports the session invalid, and paces calls to a minimum interval.

Constructors

Constructor

new XmlRpcCoordinator(options?): XmlRpcCoordinator;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:56

Parameters

Parameter	Type
options?	XmlRpcCoordinatorOptions

Returns

XmlRpcCoordinator

Properties

gateway

readonly gateway: XmlRpcGateway;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:47

Methods

_clear()

_clear(): void;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:76

Internal

Called by Client.logout. The saved session is kept for the next run.

Returns

void

---

_setCredentials()

_setCredentials(username, password): void;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:68

Internal

Called by Client.login; no gateway request is made until first use.

Parameters

Parameter	Type
username	string
password	string

Returns

void

---

authorizeProducts()

authorizeProducts(products, options?): Promise<ProductAuthorization[]>;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:88

Resolve products to their current CFL URL, checksum and parent (ancestors included).

Parameters

Parameter	Type
products	readonly ( | number | ProductAuthRequest)[]
options?	AuthorizeProductsOptions

Returns

Promise<ProductAuthorization[]>

---

call()

call(
   method, 
   params?, 
   options?
): Promise<XmlRpcValue>;

Defined in: packages/client/src/client/XmlRpcCoordinator.ts:83

Invoke a gateway method with the client's session.

Parameters

Parameter	Type	Default value
method	string	undefined
params?	readonly XmlRpcValue[]	[]
options?	CallOptions	{}

Returns

Promise<XmlRpcValue>