Class FutureModel

Name

FutureModel

Version

1.0.0

Author

Matthew Holman maholman@coca-cola.com

Represents a future.

Hierarchy (view full)

Implements

Action

cancelFuture

Constructor

constructor

Lifecycle

load

Subscription Updates the Future model when a `kos.future/ID` event is received from the server.

handleFutureUpdated

Action

cancelFuture

  • cancelFuture(): Promise<void>

  • Returns Promise<void>

    Remark

    Cancels the current future.

    If a service was passed in as part of the options in the constructor then it will be used. Otherwise the default services will be invoked.

    See

    cancelFutureService

Constructor

constructor

  • new FutureModel(modelId, options, context): FutureModel

  • Parameters

    • modelId: string

      the unique modelId for this Future

    • options: IFutureModelOptions<Record<string, unknown>>

      any options that should be merged into the Future

    • context: KosCreationContext

    Returns FutureModel

    Params

    options.id - the unique id of the Future

    Params

    options.name - the name of the Future

Lifecycle

load

  • load(): Promise<void>

  • Returns Promise<void>

    Remarks

    No action is taken as part of the load lifecycle method.

    In future additional information about the workspace could be loaded

Subscription Updates the Future model when a `kos.future/ID` event is received from the server.

handleFutureUpdated

  • handleFutureUpdated(future): void

  • Parameters

    Returns void

    See

    FutureResponse

Settings

Member Visibility

Theme

On This Page

cancelFutureconstructorloadhandleFutureUpdated