Class ViewInfo

Index

Constructors

Methods

GetViewEntity GetViewEntityByName GetViewID GetViewsForUser

Constructors

constructor

new ViewInfo(): ViewInfo
Returns ViewInfo

Methods

`Static` GetViewEntity

GetViewEntity(viewId, contextUser?): Promise<UserViewEntityExtended>
Loads a new entity object for User Views for the specified viewId and returns it if successful.
Parameters
- viewId: string
  record ID for the view to load
- Optional contextUser: UserInfo
  optional, the user to use for context when loading the view
Returns Promise<UserViewEntityExtended>
UserViewEntityBase (or a subclass of it)

Throws
Error if the view cannot be loaded

Memberof
ViewInfo

Static
Async
- Defined in packages/MJCoreEntities/src/custom/UserViewEntity.ts:740

`Static` GetViewEntityByName

GetViewEntityByName(viewName, contextUser?): Promise<UserViewEntityExtended>
Loads a new entity object for User Views for the specified viewName and returns it if successful.
Parameters
- viewName: string
  name for the view to load
- Optional contextUser: UserInfo
  optional, the user to use for context when loading the view
Returns Promise<UserViewEntityExtended>
UserViewEntityBase (or a subclass of it)

Throws
Error if the view cannot be loaded

Memberof
ViewInfo

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

`Static` GetViewID

GetViewID(viewName): 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 packages/MJCoreEntities/src/custom/UserViewEntity.ts:718

`Static` GetViewsForUser

GetViewsForUser(entityId?, contextUser?): Promise<UserViewEntityExtended[]>
Returns a list of views for the specified user. If no user is specified, the current user is used.
Parameters
- Optional entityId: 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
- Optional contextUser: UserInfo
  optional, the user to use for context when loading the view
Returns Promise<UserViewEntityExtended[]>
an array of UserViewEntityBase objects

Memberof
ViewInfo

Static
Async
- Defined in packages/MJCoreEntities/src/custom/UserViewEntity.ts:700