Class UmbMemberTypeDetailServerDataSource

A data source for the Member Type that fetches data from the server UmbMemberTypeDetailServerDataSource

Implements

Hierarchy (View Summary)

UmbControllerBase
- UmbMemberTypeDetailServerDataSource

Implements

UmbDetailDataSource<UmbMemberTypeDetailModel>

Constructors

constructor

new UmbMemberTypeDetailServerDataSource(
host: UmbControllerHost,
controllerAlias?: UmbControllerAlias,
): UmbMemberTypeDetailServerDataSource
Parameters
- host: UmbControllerHost
- OptionalcontrollerAlias: UmbControllerAlias
Returns UmbMemberTypeDetailServerDataSource
Inherited from UmbControllerBase.constructor
- Defined in src/libs/class-api/class.mixin.ts:19

Properties

_host

_host: UmbControllerHost

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbControllerBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

create

create(
    model: UmbMemberTypeDetailModel,
    parentUnique?: null | string,
): Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Inserts a new Member Type on the server
Parameters
- model: UmbMemberTypeDetailModel
  Member Type Model
- parentUnique: null | string = null
Returns Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.create
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:93

createScaffold

createScaffold(
preset?: Partial<UmbMemberTypeDetailModel>,
): Promise<{ data: UmbMemberTypeDetailModel }>
Creates a new Member Type scaffold
Parameters
- Optionalpreset: Partial<UmbMemberTypeDetailModel> = {}
  Optional preset data to merge with the scaffold
Returns Promise<{ data: UmbMemberTypeDetailModel }>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.createScaffold
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:31

delete

delete(unique: string): Promise<UmbApiWithErrorResponse>
Deletes a Member Type on the server
Parameters
- unique: string
  The unique identifier of the Member Type to delete
Returns Promise<UmbApiWithErrorResponse>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.delete
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:195

destroy

destroy(): void
Returns void
Inherited from UmbControllerBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbControllerBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbControllerBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

read

read(
    unique: string,
): Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Fetches a Member Type with the given id from the server
Parameters
- unique: string
  The unique identifier of the Member Type to fetch
Returns Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.read
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:60

readMany

readMany(
    uniques: string[],
): Promise<
    | { data: never[]; error?: undefined }
    | {
        data: undefined | UmbMemberTypeDetailModel[];
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Fetches multiple Member Types by their unique IDs from the server
Parameters
- uniques: string[]
  The unique IDs of the member types to fetch
Returns Promise<
    | { data: never[]; error?: undefined }
    | {
        data: undefined | UmbMemberTypeDetailModel[];
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.readMany
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:74

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbControllerBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

update

update(
    model: UmbMemberTypeDetailModel,
): Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Updates a MemberType on the server
Parameters
- model: UmbMemberTypeDetailModel
  Member Type Model
Returns Promise<
    {
        data: undefined
        | UmbMemberTypeDetailModel;
        error: undefined | UmbApiError | UmbCancelError;
    },
>
Memberof
UmbMemberTypeDetailServerDataSource
Implementation of UmbDetailDataSource.update
- Defined in src/packages/members/member-type/repository/detail/member-type-detail.server.data-source.ts:145

Class UmbMemberTypeDetailServerDataSource

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbMemberTypeDetailServerDataSource

Properties

_host

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

create

Parameters

Returns Promise< { data: undefined | UmbMemberTypeDetailModel; error: undefined | UmbApiError | UmbCancelError; },>

Memberof

createScaffold

Parameters

Returns Promise<{ data: UmbMemberTypeDetailModel }>

Memberof

delete

Parameters

Returns Promise<UmbApiWithErrorResponse>

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R>

Description

Memberof

read

Parameters

Returns Promise<
{
data: undefined
| UmbMemberTypeDetailModel;
error: undefined | UmbApiError | UmbCancelError;
},
>

Returns Promise<
{
data: undefined
| UmbMemberTypeDetailModel;
error: undefined | UmbApiError | UmbCancelError;
},
>

Returns Promise<
| { data: never[]; error?: undefined }
| {
data: undefined | UmbMemberTypeDetailModel[];
error: undefined | UmbApiError | UmbCancelError;
},
>

Returns Promise<
{
data: undefined
| UmbMemberTypeDetailModel;
error: undefined | UmbApiError | UmbCancelError;
},
>