Class UmbCurrentUserContext

This base provides the necessary for a class to become a context-api controller.

Hierarchy (View Summary)

UmbContextBase
- UmbCurrentUserContext

Index

Constructors

Properties

_host allowedSections avatarUrls currentUser documentStartNodeUniques email fallbackPermissions hasAccessToAllLanguages hasAccessToSensitiveData hasDocumentRootAccess hasMediaRootAccess isAdmin languageIsoCode languages mediaStartNodeUniques name permissions unique userName

Accessors

controllerAlias

Constructors

constructor

new UmbCurrentUserContext(host: UmbControllerHost): UmbCurrentUserContext
Parameters
- host: UmbControllerHost
Returns UmbCurrentUserContext
Overrides UmbContextBase.constructor
- Defined in src/packages/user/current-user/current-user.context.ts:34

Properties

_host

_host: UmbControllerHost

`Readonly`allowedSections

allowedSections: Observable<string[] | undefined> = ...

`Readonly`avatarUrls

avatarUrls: Observable<string[] | undefined> = ...

`Readonly`currentUser

currentUser: Observable<UmbCurrentUserModel> = ...

`Readonly`documentStartNodeUniques

documentStartNodeUniques: Observable<UmbReferenceByUnique[] | undefined> = ...

`Readonly`email

email: Observable<string | undefined> = ...

`Readonly`fallbackPermissions

fallbackPermissions: Observable<string[] | undefined> = ...

`Readonly`hasAccessToAllLanguages

hasAccessToAllLanguages: Observable<boolean | undefined> = ...

`Readonly`hasAccessToSensitiveData

hasAccessToSensitiveData: Observable<boolean | undefined> = ...

`Readonly`hasDocumentRootAccess

hasDocumentRootAccess: Observable<boolean | undefined> = ...

`Readonly`hasMediaRootAccess

hasMediaRootAccess: Observable<boolean | undefined> = ...

`Readonly`isAdmin

isAdmin: Observable<boolean | undefined> = ...

`Readonly`languageIsoCode

languageIsoCode: Observable<string | undefined> = ...

`Readonly`languages

languages: Observable<string[] | undefined> = ...

`Readonly`mediaStartNodeUniques

mediaStartNodeUniques: Observable<UmbReferenceByUnique[] | undefined> = ...

`Readonly`name

name: Observable<string | undefined> = ...

`Readonly`permissions

permissions: Observable<unknown[] | undefined> = ...

`Readonly`unique

unique: Observable<string | undefined> = ...

`Readonly`userName

userName: Observable<string | undefined> = ...

Accessors

controllerAlias

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

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    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: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.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 UmbContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Inherited from UmbContextBase.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 UmbContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAllowedSection

getAllowedSection(): string[] | undefined
Get the allowed sections for the current user

Returns string[] | undefined
The allowed sections for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:96

getAvatarUrls

getAvatarUrls(): string[] | undefined
Get the avatar urls for the current user

Returns string[] | undefined
The avatar urls for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:104

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<ResultType | undefined>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<ResultType | undefined>
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 UmbContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getDocumentStartNodeUniques

getDocumentStartNodeUniques(): UmbReferenceByUnique[] | undefined
Get the document start node uniques for the current user

Returns UmbReferenceByUnique[] | undefined
The document start node uniques for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:112

getEmail

getEmail(): string | undefined
Get the email for the current user

Returns string | undefined
The email for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:120

getFallbackPermissions

getFallbackPermissions(): string[] | undefined
Get the fallback permissions for the current user

Returns string[] | undefined
The fallback permissions for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:128

getHasAccessToAllLanguages

getHasAccessToAllLanguages(): boolean | undefined
Get if the current user has access to all languages

Returns boolean | undefined
True if the current user has access to all languages, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:136

getHasAccessToSensitiveData

getHasAccessToSensitiveData(): boolean | undefined
Get if the current user has access to sensitive data

Returns boolean | undefined
True if the current user has access to sensitive data, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:144

getHasDocumentRootAccess

getHasDocumentRootAccess(): boolean | undefined
Get if the current user has document root access

Returns boolean | undefined
True if the current user has document root access, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:152

getHasMediaRootAccess

getHasMediaRootAccess(): boolean | undefined
Get if the current user has media root access

Returns boolean | undefined
True if the current user has media root access, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:160

getHostElement

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

getIsAdmin

getIsAdmin(): boolean | undefined
Get if the current user is an admin

Returns boolean | undefined
True if the current user is an admin, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:168

getLanguageIsoCode

getLanguageIsoCode(): string | undefined
Get the language iso code for the current user

Returns string | undefined
The language iso code for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:176

getLanguages

getLanguages(): string[] | undefined
Get the languages for the current user

Returns string[] | undefined
The languages for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:184

getMediaStartNodeUniques

getMediaStartNodeUniques(): UmbReferenceByUnique[] | undefined
Get the media start node uniques for the current user

Returns UmbReferenceByUnique[] | undefined
The media start node uniques for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:192

getName

getName(): string | undefined
Get the name for the current user

Returns string | undefined
The name for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:200

getPermissions

getPermissions(): unknown[] | undefined
Get the permissions for the current user

Returns unknown[] | undefined
The permissions for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:208

getUmbControllers

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

getUnique

getUnique(): string | undefined
Get the unique for the current user

Returns string | undefined
The unique for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:216

getUserName

getUserName(): string | undefined
Get the user name for the current user

Returns string | undefined
The user name for the current user
- Defined in src/packages/user/current-user/current-user.context.ts:224

isCurrentUserAdmin

isCurrentUserAdmin(): Promise<boolean>
Checks if the current user is an admin.

Returns Promise<boolean>
True if the current user is an admin, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:87

isUserCurrentUser

isUserCurrentUser(userUnique: string): Promise<boolean>
Checks if a user is the current user.
Parameters
- userUnique: string
  The user id to check
Returns Promise<boolean>
True if the user is the current user, otherwise false
- Defined in src/packages/user/current-user/current-user.context.ts:78

load

load(): Promise<void>
Loads the current user. Concurrent callers share the same in-flight promise, so awaiting load() always waits for #currentUser to be populated.

Returns Promise<void>
Resolves once the current user observable has emitted.
- Defined in src/packages/user/current-user/current-user.context.ts:49

observe

observe<
    ObservableType extends Observable<T>
    | undefined,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType extends undefined ? U | undefined : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? UmbObserverController<SpecificT>
        | undefined
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: UmbControllerAlias | null,
): SpecificR
Type Parameters
- ObservableType extends Observable<T> | undefined
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType extends undefined ? U | undefined : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? UmbObserverController<SpecificT>
      | undefined
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: UmbControllerAlias | null
  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 UmbContextBase.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 UmbContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    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: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

Class UmbCurrentUserContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbCurrentUserContext

Properties

_host

ReadonlyallowedSections

ReadonlyavatarUrls

ReadonlycurrentUser

ReadonlydocumentStartNodeUniques

Readonlyemail

ReadonlyfallbackPermissions

ReadonlyhasAccessToAllLanguages

ReadonlyhasAccessToSensitiveData

ReadonlyhasDocumentRootAccess

ReadonlyhasMediaRootAccess

ReadonlyisAdmin

ReadonlylanguageIsoCode

Readonlylanguages

ReadonlymediaStartNodeUniques

Readonlyname

Readonlypermissions

Readonlyunique

ReadonlyuserName

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getAllowedSection

Returns string[] | undefined

getAvatarUrls

Returns string[] | undefined

getContext

Type Parameters

Parameters

Returns Promise<ResultType | undefined>

Description

Memberof

getDocumentStartNodeUniques

Returns UmbReferenceByUnique[] | undefined

getEmail

Returns string | undefined

getFallbackPermissions

Returns string[] | undefined

getHasAccessToAllLanguages

Returns boolean | undefined

getHasAccessToSensitiveData

Returns boolean | undefined

getHasDocumentRootAccess

Returns boolean | undefined

getHasMediaRootAccess

Returns boolean | undefined

getHostElement

Returns Element

getIsAdmin

Returns boolean | undefined

`Readonly`allowedSections

`Readonly`avatarUrls

`Readonly`currentUser

`Readonly`documentStartNodeUniques

`Readonly`email

`Readonly`fallbackPermissions

`Readonly`hasAccessToAllLanguages

`Readonly`hasAccessToSensitiveData

`Readonly`hasDocumentRootAccess

`Readonly`hasMediaRootAccess

`Readonly`isAdmin

`Readonly`languageIsoCode

`Readonly`languages

`Readonly`mediaStartNodeUniques

`Readonly`name

`Readonly`permissions

`Readonly`unique

`Readonly`userName