Class APIKeyListComponent

List view component for displaying and filtering API keys

Hierarchy (View Summary)

BaseAngularComponent
- APIKeyListComponent

Implements

OnInit
OnChanges

Constructors

constructor

new APIKeyListComponent(): APIKeyListComponent
Returns APIKeyListComponent
Inherited from BaseAngularComponent.constructor

Properties

AllKeys

AllKeys: MJAPIKeyEntity[] = []

CreateRequested

CreateRequested: EventEmitter<void> = ...

CurrentPage

CurrentPage: number = 1

Filter

Filter: APIKeyFilter = 'all'

FilteredKeys

FilteredKeys: MJAPIKeyEntity[] = []

IsLoading

IsLoading: boolean = true

KeyScopeMap

KeyScopeMap: Map<string, KeyScopeInfo> = ...

KeySelected

KeySelected: EventEmitter<MJAPIKeyEntity> = ...

Math

Math: Math = Math

PageSize

PageSize: number = 20

Provider

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.

SearchText

SearchText: string = ''

SortDirection

SortDirection: "asc" | "desc" = 'desc'

SortField

Stats

Stats: {
    active: number;
    expired: number;
    expiring: number;
    neverUsed: number;
    revoked: number;
    total: number;
} = ...

`Static`ɵdir

"ɵdir": unknown

`Static`ɵfac

"ɵfac": ɵɵFactoryDeclaration<BaseAngularComponent, never>

Accessors

EmptyStateTitle

get EmptyStateTitle(): string
Dynamic title for the empty state — reflects search vs filter vs truly-empty.

Returns string
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:347

ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

Returns IMetadataProvider
Inherited from BaseAngularComponent.ProviderToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:17

RunQueryToUse

get RunQueryToUse(): IRunQueryProvider
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

Returns IRunQueryProvider
Inherited from BaseAngularComponent.RunQueryToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:25

RunViewToUse

get RunViewToUse(): IRunViewProvider
Returns either the default RunView provider or the one specified in the Provider property, if it was specified

Returns IRunViewProvider
Inherited from BaseAngularComponent.RunViewToUse
- Defined in Angular/Generic/base-types/dist/base-angular-component.d.ts:21

Methods

applyFilters

applyFilters(): void
Returns void
Deprecated
Use ApplyFilters.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:317

ApplyFilters

ApplyFilters(): void
Apply filters and sorting

Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:230

clearSearch

clearSearch(): void
Returns void
Deprecated
Use ClearSearch.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:342

ClearSearch

ClearSearch(): void
Clear search

Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:336

formatDate

formatDate(date: Date | null): string
Format date for display
Parameters
- date: Date | null
Returns string
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:498

formatExpiration

formatExpiration(date: Date | null): string
Parameters
- date: Date | null
Returns string
Deprecated
Use FormatExpiration.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:541

FormatExpiration

FormatExpiration(date: Date | null): string
Format expiration for display
Parameters
- date: Date | null
Returns string
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:523

getExpirationClass

getExpirationClass(key: MJAPIKeyEntity): string
Parameters
- key: MJAPIKeyEntity
Returns string
Deprecated
Use GetExpirationClass.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:563

GetExpirationClass

GetExpirationClass(key: MJAPIKeyEntity): string
Get expiration status class
Parameters
- key: MJAPIKeyEntity
Returns string
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:548

getFilterCount

getFilterCount(filter: APIKeyFilter): number
Parameters
- filter: APIKeyFilter
Returns number
Deprecated
Use GetFilterCount.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:582

GetFilterCount

GetFilterCount(filter: APIKeyFilter): number
Get filter count
Parameters
- filter: APIKeyFilter
Returns number
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:570

getPageNumbers

getPageNumbers(): number[]
Returns number[]
Deprecated
Use GetPageNumbers.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:467

GetPageNumbers

GetPageNumbers(): number[]
Get page numbers to display

Returns number[]
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:443

GetScopeInfo

GetScopeInfo(key: MJAPIKeyEntity): KeyScopeInfo
Get scope info for a key
Parameters
- key: MJAPIKeyEntity
Returns KeyScopeInfo
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:192

getSortIcon

getSortIcon(
    field:
        | "Status"
        | "__mj_CreatedAt"
        | "User"
        | "Label"
        | "LastUsedAt"
        | "ExpiresAt",
): string
Parameters
- field: "Status" | "__mj_CreatedAt" | "User" | "Label" | "LastUsedAt" | "ExpiresAt"
Returns string
Deprecated
Use GetSortIcon.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:397

GetSortIcon

GetSortIcon(
    field:
        | "Status"
        | "__mj_CreatedAt"
        | "User"
        | "Label"
        | "LastUsedAt"
        | "ExpiresAt",
): string
Get sort icon class
Parameters
- field: "Status" | "__mj_CreatedAt" | "User" | "Label" | "LastUsedAt" | "ExpiresAt"
Returns string
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:391

getTotalPages

getTotalPages(): number
Returns number
Deprecated
Use GetTotalPages.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:422

GetTotalPages

GetTotalPages(): number
Get total pages

Returns number
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:417

goToPage

goToPage(page: number): void
Parameters
- page: number
Returns void
Deprecated
Use GoToPage.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:436

GoToPage

GoToPage(page: number): void
Go to page
Parameters
- page: number
Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:429

loadKeys

loadKeys(): Promise<void>
Returns Promise<void>
Deprecated
Use LoadKeys.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:185

LoadKeys

LoadKeys(): Promise<void>
Load all API keys

Returns Promise<void>
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:93

ngOnChanges

ngOnChanges(changes: { [propName: string]: SimpleChange<any> }): Promise<void>
A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.
Parameters
- changes: { [propName: string]: SimpleChange<any> }
  The changed properties.
Returns Promise<void>
Implementation of OnChanges.ngOnChanges
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:84

ngOnInit

ngOnInit(): Promise<void>
A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns Promise<void>
Implementation of OnInit.ngOnInit
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:80

onSearch

onSearch(): void
Returns void
Deprecated
Use OnSearch.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:329

OnSearch

OnSearch(): void
Handle search input

Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:324

requestCreate

requestCreate(): void
Returns void
Deprecated
Use RequestCreate.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:491

RequestCreate

RequestCreate(): void
Request key creation

Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:486

selectKey

selectKey(key: MJAPIKeyEntity): void
Parameters
- key: MJAPIKeyEntity
Returns void
Deprecated
Use SelectKey.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:479

SelectKey

SelectKey(key: MJAPIKeyEntity): void
Select a key
Parameters
- key: MJAPIKeyEntity
Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:474

setFilter

setFilter(filter: APIKeyFilter): void
Parameters
- filter: APIKeyFilter
Returns void
Deprecated
Use SetFilter.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:366

SetFilter

SetFilter(filter: APIKeyFilter): void
Set filter
Parameters
- filter: APIKeyFilter
Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:360

toggleSort

toggleSort(
    field:
        | "Status"
        | "__mj_CreatedAt"
        | "User"
        | "Label"
        | "LastUsedAt"
        | "ExpiresAt",
): void
Parameters
- field: "Status" | "__mj_CreatedAt" | "User" | "Label" | "LastUsedAt" | "ExpiresAt"
Returns void
Deprecated
Use ToggleSort.
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:384

ToggleSort

ToggleSort(
    field:
        | "Status"
        | "__mj_CreatedAt"
        | "User"
        | "Label"
        | "LastUsedAt"
        | "ExpiresAt",
): void
Toggle sort
Parameters
- field: "Status" | "__mj_CreatedAt" | "User" | "Label" | "LastUsedAt" | "ExpiresAt"
Returns void
- Defined in Angular/Explorer/dashboards/src/APIKeys/api-key-list.component.ts:373

Class APIKeyListComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns APIKeyListComponent

Properties

AllKeys

CreateRequested

CurrentPage

Filter

FilteredKeys

IsLoading

KeyScopeMap

KeySelected

Math

PageSize

Provider

SearchText

SortDirection

SortField

Stats

Staticɵdir

Staticɵfac

Accessors

EmptyStateTitle

Returns string

ProviderToUse

Returns IMetadataProvider

RunQueryToUse

Returns IRunQueryProvider

RunViewToUse

Returns IRunViewProvider

Methods

applyFilters

Returns void

Deprecated

ApplyFilters

Returns void

clearSearch

Returns void

Deprecated

ClearSearch

Returns void

formatDate

Parameters

Returns string

formatExpiration

Parameters

Returns string

Deprecated

FormatExpiration

Parameters

Returns string

getExpirationClass

Parameters

Returns string

Deprecated

GetExpirationClass

Parameters

Returns string

getFilterCount

Parameters

Returns number

Deprecated

GetFilterCount

Parameters

Returns number

getPageNumbers

Returns number[]

Deprecated

GetPageNumbers

Returns number[]

getPaginatedKeys

Returns MJAPIKeyEntity[]

`Static`ɵdir

`Static`ɵfac