Interface IConfigBeanModelOptions

Additional properties that can be passed into the constructor in order to set initial values

Remarks

Used to identify additional data that can be set on the model during instantiation. It is expected that implementers will set these properties in the constructor. The value might be overriden by subsequent lifecycle methods or updates.

interface IConfigBeanModelOptions {
    modifyConfigBean?: ((id, model) => Promise<undefined | KosServiceResponse<unknown>>);
    getConfigBean?: ((id) => Promise<undefined | KosServiceResponse<ConfigBeanResponse>>);
}

Hierarchy

  • Partial<IConfigBeanModelOptionsActions>
    • IConfigBeanModelOptions

Service

modifyConfigBean? getConfigBean?

Service

Optional modifyConfigBean

modifyConfigBean?: ((id, model) => Promise<undefined | KosServiceResponse<unknown>>)

Service to update an ConfigBeanModel on the backend.

Type declaration

Remarks

it is expected that the response will not provide any additional data and the system should only assume that a successful response means that the request was accepted by the backend. Successful modification of the model will be broadcast via the appropriate Event Topic.

Returns

  • a Promise that resolves to an empty KosServiceResponse

Optional getConfigBean

getConfigBean?: ((id) => Promise<undefined | KosServiceResponse<ConfigBeanResponse>>)

Service to get a ConfigBeanModel on the backend.

Type declaration

Remarks

it is expected that the response will not provide any additional data and the system should only assume that a successful response means that the request was accepted by the backend. Successful modification of the model will be broadcast via the appropriate Event Topic.

Returns

  • a Promise that resolves to an empty KosServiceResponse

Settings

Member Visibility

Theme

On This Page

modifyConfigBeangetConfigBean