Class ViewInfo

Index

Constructors

Methods

GetViewEntity GetViewEntityByName GetViewID GetViewsForUser

Constructors

constructor

new ViewInfo(): ViewInfo
Returns ViewInfo

Methods

`Static`GetViewEntity

GetViewEntity(
viewId: string,
contextUser?: UserInfo,
): Promise<MJUserViewEntityExtended>
Gets a User View entity from the UserViewEngine cache.
Parameters
- viewId: string
  record ID for the view to load
- OptionalcontextUser: UserInfo
  optional, the user context for loading views
Returns Promise<MJUserViewEntityExtended>
UserViewEntityBase (or a subclass of it)

Throws
Error if the view is not found in the engine cache

Memberof
ViewInfo

Static
Async
- Defined in MJCoreEntities/src/custom/MJUserViewEntityExtended.ts:799

`Static`GetViewEntityByName

GetViewEntityByName(
viewName: string,
contextUser?: UserInfo,
): Promise<MJUserViewEntityExtended>
Gets a User View entity from the UserViewEngine cache by name.
Parameters
- viewName: string
  name for the view to load
- OptionalcontextUser: UserInfo
  optional, the user context for loading views
Returns Promise<MJUserViewEntityExtended>
UserViewEntityBase (or a subclass of it)

Throws
Error if the view is not found in the engine cache

Memberof
ViewInfo

Static
Async
- Defined in MJCoreEntities/src/custom/MJUserViewEntityExtended.ts:820

`Static`GetViewID

GetViewID(viewName: string): Promise<string>
Returns a view ID for a given viewName
Parameters
- viewName: string
  Name of the view to lookup the ID for
Returns Promise<string>
the ID of the User View record that matches the provided name, if found
- Defined in MJCoreEntities/src/custom/MJUserViewEntityExtended.ts:777

`Static`GetViewsForUser

GetViewsForUser(
entityId?: string,
contextUser?: UserInfo,
): Promise<MJUserViewEntityExtended[]>
Returns a list of views for the specified user. If no user is specified, the current user is used.
Parameters
- OptionalentityId: string
  optional, the entity ID to filter the views by, if not provided, there is no filter on EntityID and all views for the user are returned
- OptionalcontextUser: UserInfo
  optional, the user to use for context when loading the view
Returns Promise<MJUserViewEntityExtended[]>
an array of UserViewEntityBase objects

Memberof
ViewInfo

Static
Async
- Defined in MJCoreEntities/src/custom/MJUserViewEntityExtended.ts:759