better-buddy-share-backend
    Preparing search index...

    Class UserRolesDAO

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    db

    Methods

    assignRoleToUser checkIfUserHasPermission executeQuery executeQueryMultiple getUserPermissions getUserRoles mapCacheError mapError mapPostgresError revokeRoleFromUser scalar

    Constructors

    Properties

    db: IDbClient

    Methods

    • Assign a role to a user.

      Overloads:

      assignRoleToUser(userId: number, roleId: number): Promise<boolean | null> Assign by role id without context.

      assignRoleToUser(userId: number, roleName: string): Promise<boolean | null> Assign by role name without context.

      assignRoleToUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Assign by role id within a specific streamer/context.

      assignRoleToUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Assign by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user receiving the role.

      • roleId: number

      Returns Promise<boolean | null>

      true if the operation succeeded, false if it did not, or null in some DB-specific cases.

      DaoError when role identifier type is invalid.

    • Assign a role to a user.

      Overloads:

      assignRoleToUser(userId: number, roleId: number): Promise<boolean | null> Assign by role id without context.

      assignRoleToUser(userId: number, roleName: string): Promise<boolean | null> Assign by role name without context.

      assignRoleToUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Assign by role id within a specific streamer/context.

      assignRoleToUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Assign by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user receiving the role.

      • roleName: string

      Returns Promise<boolean | null>

      true if the operation succeeded, false if it did not, or null in some DB-specific cases.

      DaoError when role identifier type is invalid.

    • Assign a role to a user.

      Overloads:

      assignRoleToUser(userId: number, roleId: number): Promise<boolean | null> Assign by role id without context.

      assignRoleToUser(userId: number, roleName: string): Promise<boolean | null> Assign by role name without context.

      assignRoleToUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Assign by role id within a specific streamer/context.

      assignRoleToUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Assign by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user receiving the role.

      • roleId: number
      • streamerId: number

        Optional context id (e.g. streamer) to scope the assignment.

      Returns Promise<boolean | null>

      true if the operation succeeded, false if it did not, or null in some DB-specific cases.

      DaoError when role identifier type is invalid.

    • Assign a role to a user.

      Overloads:

      assignRoleToUser(userId: number, roleId: number): Promise<boolean | null> Assign by role id without context.

      assignRoleToUser(userId: number, roleName: string): Promise<boolean | null> Assign by role name without context.

      assignRoleToUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Assign by role id within a specific streamer/context.

      assignRoleToUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Assign by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user receiving the role.

      • roleName: string
      • streamerId: number

        Optional context id (e.g. streamer) to scope the assignment.

      Returns Promise<boolean | null>

      true if the operation succeeded, false if it did not, or null in some DB-specific cases.

      DaoError when role identifier type is invalid.

    • Check whether a user has a given permission.

      Overloads:

      checkIfUserHasPermission(userId: number, permissionName: string): Promise<boolean | null> Check by permission name without context.

      checkIfUserHasPermission(userId: number, permissionId: number): Promise<boolean | null> Check by permission id without context.

      checkIfUserHasPermission(userId: number, permissionName: string, streamerId: number): Promise<boolean | null> Check by permission name within a specific streamer/context.

      checkIfUserHasPermission(userId: number, permissionId: number, streamerId: number): Promise<boolean | null> Check by permission id within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • permissionName: string

      Returns Promise<boolean | null>

      true if the user has the permission, false otherwise, or null in DB-specific cases.

      DaoError when permission identifier type is invalid.

    • Check whether a user has a given permission.

      Overloads:

      checkIfUserHasPermission(userId: number, permissionName: string): Promise<boolean | null> Check by permission name without context.

      checkIfUserHasPermission(userId: number, permissionId: number): Promise<boolean | null> Check by permission id without context.

      checkIfUserHasPermission(userId: number, permissionName: string, streamerId: number): Promise<boolean | null> Check by permission name within a specific streamer/context.

      checkIfUserHasPermission(userId: number, permissionId: number, streamerId: number): Promise<boolean | null> Check by permission id within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • permissionId: number

      Returns Promise<boolean | null>

      true if the user has the permission, false otherwise, or null in DB-specific cases.

      DaoError when permission identifier type is invalid.

    • Check whether a user has a given permission.

      Overloads:

      checkIfUserHasPermission(userId: number, permissionName: string): Promise<boolean | null> Check by permission name without context.

      checkIfUserHasPermission(userId: number, permissionId: number): Promise<boolean | null> Check by permission id without context.

      checkIfUserHasPermission(userId: number, permissionName: string, streamerId: number): Promise<boolean | null> Check by permission name within a specific streamer/context.

      checkIfUserHasPermission(userId: number, permissionId: number, streamerId: number): Promise<boolean | null> Check by permission id within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • permissionName: string
      • streamerId: number

        Optional context id.

      Returns Promise<boolean | null>

      true if the user has the permission, false otherwise, or null in DB-specific cases.

      DaoError when permission identifier type is invalid.

    • Check whether a user has a given permission.

      Overloads:

      checkIfUserHasPermission(userId: number, permissionName: string): Promise<boolean | null> Check by permission name without context.

      checkIfUserHasPermission(userId: number, permissionId: number): Promise<boolean | null> Check by permission id without context.

      checkIfUserHasPermission(userId: number, permissionName: string, streamerId: number): Promise<boolean | null> Check by permission name within a specific streamer/context.

      checkIfUserHasPermission(userId: number, permissionId: number, streamerId: number): Promise<boolean | null> Check by permission id within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • permissionId: number
      • streamerId: number

        Optional context id.

      Returns Promise<boolean | null>

      true if the user has the permission, false otherwise, or null in DB-specific cases.

      DaoError when permission identifier type is invalid.

    • Get permissions granted to a user (via roles).

      Overloads:

      getUserPermissions(userId: number): Promise<Permission[]> Get all permissions for the user globally.

      getUserPermissions(userId: number, streamerId: number): Promise<Permission[]> Get permissions for the user within the given streamer/context.

      Parameters

      • userId: number

        ID of the user.

      Returns Promise<Permission[]>

      Array of Permission objects, or empty array when no records found.

    • Get permissions granted to a user (via roles).

      Overloads:

      getUserPermissions(userId: number): Promise<Permission[]> Get all permissions for the user globally.

      getUserPermissions(userId: number, streamerId: number): Promise<Permission[]> Get permissions for the user within the given streamer/context.

      Parameters

      • userId: number

        ID of the user.

      • streamerId: number

        Optional context id to limit the query.

      Returns Promise<Permission[]>

      Array of Permission objects, or empty array when no records found.

    • Get roles assigned to a user.

      Overloads:

      getUserRoles(userId: number): Promise<Role[]> Get all roles assigned to the user globally.

      getUserRoles(userId: number, streamerId: number): Promise<Role[]> Get roles assigned to the user within the given streamer/context.

      Parameters

      • userId: number

        ID of the user.

      Returns Promise<Role[]>

      Array of Role objects, or empty array when no records found.

    • Get roles assigned to a user.

      Overloads:

      getUserRoles(userId: number): Promise<Role[]> Get all roles assigned to the user globally.

      getUserRoles(userId: number, streamerId: number): Promise<Role[]> Get roles assigned to the user within the given streamer/context.

      Parameters

      • userId: number

        ID of the user.

      • streamerId: number

        Optional context id to limit the query.

      Returns Promise<Role[] | null>

      Array of Role objects, or empty array when no records found.

    • Revoke a role from a user.

      Overloads:

      revokeRoleFromUser(userId: number, roleId: number): Promise<boolean | null> Revoke by role id without context.

      revokeRoleFromUser(userId: number, roleName: string): Promise<boolean | null> Revoke by role name without context.

      revokeRoleFromUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Revoke by role id within a specific streamer/context.

      revokeRoleFromUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Revoke by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • roleId: number

      Returns Promise<boolean | null>

      true if revoked, false otherwise, or null if DB returns no definitive result.

      DaoError when role identifier type is invalid.

    • Revoke a role from a user.

      Overloads:

      revokeRoleFromUser(userId: number, roleId: number): Promise<boolean | null> Revoke by role id without context.

      revokeRoleFromUser(userId: number, roleName: string): Promise<boolean | null> Revoke by role name without context.

      revokeRoleFromUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Revoke by role id within a specific streamer/context.

      revokeRoleFromUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Revoke by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • roleName: string

      Returns Promise<boolean | null>

      true if revoked, false otherwise, or null if DB returns no definitive result.

      DaoError when role identifier type is invalid.

    • Revoke a role from a user.

      Overloads:

      revokeRoleFromUser(userId: number, roleId: number): Promise<boolean | null> Revoke by role id without context.

      revokeRoleFromUser(userId: number, roleName: string): Promise<boolean | null> Revoke by role name without context.

      revokeRoleFromUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Revoke by role id within a specific streamer/context.

      revokeRoleFromUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Revoke by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • roleId: number
      • streamerId: number

        Optional context id to scope the revocation.

      Returns Promise<boolean | null>

      true if revoked, false otherwise, or null if DB returns no definitive result.

      DaoError when role identifier type is invalid.

    • Revoke a role from a user.

      Overloads:

      revokeRoleFromUser(userId: number, roleId: number): Promise<boolean | null> Revoke by role id without context.

      revokeRoleFromUser(userId: number, roleName: string): Promise<boolean | null> Revoke by role name without context.

      revokeRoleFromUser(userId: number, roleId: number, streamerId: number): Promise<boolean | null> Revoke by role id within a specific streamer/context.

      revokeRoleFromUser(userId: number, roleName: string, streamerId: number): Promise<boolean | null> Revoke by role name within a specific streamer/context.

      Generic parameters:

      Parameters

      • userId: number

        ID of the user.

      • roleName: string
      • streamerId: number

        Optional context id to scope the revocation.

      Returns Promise<boolean | null>

      true if revoked, false otherwise, or null if DB returns no definitive result.

      DaoError when role identifier type is invalid.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods