Class JModuleApi

Hierarchy (View Summary)

JBaseApi
- JModuleApi

Index

Constructors

Properties

Methods

getConfiguration setConfiguration

Constructors

constructor

new JModuleApi(jApi: JamespotUserApi): JModuleApi
Parameters
- jApi: JamespotUserApi
Returns JModuleApi
Inherited from JBaseApi.constructor
- Defined in jamespot-user-api/src/apis/base.ts:8

Properties

jApi

jApi: JamespotUserApi

network

network: Network

Methods

getConfiguration

getConfiguration(
payload: { moduleName: string },
params?: { signal?: AbortSignal },
): Promise<ApiWrapper<ModuleConfigurationFields, BaseMessages>>
Parameters
- payload: { moduleName: string }
- Optionalparams: { signal?: AbortSignal }
Returns Promise<ApiWrapper<ModuleConfigurationFields, BaseMessages>>
- Defined in jamespot-user-api/src/apis/module/module.ts:7

setConfiguration

setConfiguration(
payload: ModuleConfiguration,
params?: { signal?: AbortSignal },
): Promise<ApiDefaultWrapper<BaseMessages>>
Parameters
- payload: ModuleConfiguration
- Optionalparams: { signal?: AbortSignal }
Returns Promise<ApiDefaultWrapper<BaseMessages>>
- Defined in jamespot-user-api/src/apis/module/module.ts:20