Member Junction
    Preparing search index...

    Class ResourcePermissionsComponent

    Visual component used to display and manage permissions for a resource. You can wrap this in a dialog or display anywhere else within an Angular application or component.

    Hierarchy (View Summary)

    Implements

    • AfterViewInit
    Index

    Constructors

    constructor

    Properties

    _Loading AllowAddPermissions AllowDeletePermissions AllowEditPermissions AllRoles AllUsers ExcludedRoleNames ExcludedUserEmails PermissionLevels PermissionTypes Provider resourcePermissions ResourceRecordID ResourceTypeID SelectedPermissionLevel SelectedRole SelectedType SelectedUser ShowPermissionLevels ShowSaveButton ShowUserErrorMessages ɵdir ɵfac

    Accessors

    ProviderToUse RunQueryToUse RunReportToUse RunViewToUse

    Methods

    addPermission deletePermission GetEngine ngAfterViewInit permissionAlreadyExists SavePermissions UpdateResourceRecordID

    Constructors

    Properties

    _Loading

    _Loading: boolean = false
    AllowAddPermissions: boolean = true

    Allows you to determine if the user is able to add new permissions for the resource.

    AllowDeletePermissions: boolean = true

    Allows you to determine if the user is able to delete existing permissions for the resource.

    AllowEditPermissions: boolean = true

    Allows you to determine if the user is able to edit existing permissions for the resource.

    AllRoles: RoleInfo[] = []
    AllUsers: MJUserEntity[] = []
    ExcludedRoleNames: string[] = []

    This optional input allows you to exclude certain roles from the list of roles that can be selected for permissions. If existing permissions have been created with roles that are in this list they will still be displayed, but the user will not be able to add new permissions with these roles. This is an array of strings with the NAMES of the roles.

    ExcludedUserEmails: string[] = []

    This optional input allows you to exclude certain users from the list of users that can be selected for permissions. If existing permissions have been created with users that are in this list they will still be displayed, but the user will not be able to add new permissions with these users. This is an array of strings with EMAILS.

    PermissionLevels: string[] = ...

    List of possible permission levels that can be set for the resource. An array of strings, defaults to ['View', 'Edit', 'Owner']

    PermissionTypes: string[] = ...

    Specifies the types of permissions the UI will allow settings for. An array of strings, defaults to ['User', 'Role']

    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    resourcePermissions: MJResourcePermissionEntity[] = []
    ResourceRecordID: string

    Required: the record ID of the resource that the permissions are being set for.

    ResourceTypeID: string

    Required: the ID of the resource type record for the specified resource that the permissions are being set for.

    SelectedPermissionLevel: "View" | "Edit" | "Owner" = 'View'
    SelectedRole: RoleInfo | null = null
    SelectedType: "User" | "Role" = 'Role'
    SelectedUser: MJUserEntity | null = null
    ShowPermissionLevels: boolean = true

    If set to true, the component will show the permission levels to the user. By default this is on. If you have a Resource Type or run-time use case where levels are not relevant, you can turn this off.

    ShowSaveButton: boolean = false

    If set to true, the component will show a Save button to the user and persist the changes to the database when the user clicks the Save button. By default this is off to allow users of the component to wrap the component as desired, and handle the save themselves.

    ShowUserErrorMessages: boolean = false

    By default, this component will not show any error messages to the user. If you want to show error messages to the user, set this to true. The component will always throw exceptions when error occur internally.

    "ɵdir": unknown
    "ɵfac": unknown

    Accessors

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunReportToUse(): IRunReportProvider

      Returns either the default RunReport provider or the one specified in the Provider property, if it was specified

      Returns IRunReportProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    Methods

    • A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods