Documentation / @imvu/xmlrpc / XmlRpcGateway

Class: XmlRpcGateway

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:135

Client for IMVU's legacy XML-RPC gateway — the API the classic client still uses for things the REST API does not expose, such as resolving a product's current CFL.

Calls are signed with the session from login: X-imvu-auth is md5(userId + securityKey + requestBody).

Constructors

Constructor

new XmlRpcGateway(options?): XmlRpcGateway;

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:143

Parameters

Parameter	Type
options?	XmlRpcGatewayOptions

Returns

XmlRpcGateway

Properties

session?

session?: XmlRpcSession;

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:136

Methods

authorizeProducts()

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

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:229

Resolve products to their current CFL (URL, checksum, parent) and usage rights.

The server also returns every ancestor of each requested product (following parentProductId down to a base product whose parent is 0), since a derived product's CFL imports its parent's. Products the server refuses are omitted.

Parameters

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

Returns

Promise<ProductAuthorization[]>

---

call()

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

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:152

Invoke method and return its decoded result. Faults throw XmlRpcFault.

Parameters

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

Returns

Promise<XmlRpcValue>

---

login()

login(options): Promise<LoginInfo>;

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:195

Log in on the secure host and adopt the issued session.

Parameters

Parameter	Type
options	LoginOptions

Returns

Promise<LoginInfo>

---

logout()

logout(): void;

Defined in: packages/xmlrpc/src/XmlRpcGateway.ts:218

Forget the session (the server-side session is left to expire).

Returns

void