Class UserLoginTypesHelper

Hierarchy

  • UserLoginTypes

Variables

Forbidden Internal Ldap Windows

Methods

add getById getByName remove tryGetById tryGetByName

Methods

add

  • Adds a login type to be able to resolve it by identifier.

    See

    • tryGetById
    • tryGetByName
    • getById
    • getByName

    Parameters

    Returns void

getById

  • Get a login type by identifier, or defaultValue if its not found (Forbidden by default).

    Returns

    Login type found by identifier, or defaultValue when id is unspecified or if its not found.

    Parameters

    • id: undefined | null | number

      Identifier of a login type. Use defaultValue if unspecified.

    • Optional defaultValue: null | UserLoginType

      Default login type to get when id is unspecified or if its not found. Use Forbidden by default.

    Returns UserLoginType

getByName

  • Get a login type by name, or defaultValue if its not found (Forbidden by default).

    Returns

    Login type found by name, or defaultValue when name is unspecified or if its not found.

    Parameters

    • name: undefined | null | string

      Name of a login type. Use defaultValue if unspecified.

    • Optional defaultValue: null | UserLoginType

      Default login type to get when name is unspecified or if its not found. Use Forbidden by default.

    Returns UserLoginType

remove

  • Removes a login type. It will no longer be accessible by identifier.

    See

    • tryGetById
    • tryGetByName
    • getById
    • getByName

    Parameters

    Returns void

tryGetById

  • Get a login type by identifier.

    Returns

    Login type found by identifier, or null, if there is no such login type.

    Parameters

    • id: number

      Identifier of a login type.

    Returns UserLoginType | null

tryGetByName

  • Get a login type by name.

    Returns

    Login type found by name, or null, if there is no such login type.

    Parameters

    • name: string

      Name of a login type.

    Returns UserLoginType | null

Generated using TypeDoc