Function login

  • login(User, username, password, code?, additionalData?): Promise<{
        message: string;
        user?: User & UserData & {
            abilities?: string[];
            email?: string;
            group?: Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: null | (User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...);
            };
            groups?: (Group & GroupData & {
                abilities?: (...)[];
                email?: string;
                phone?: string;
                user?: null | (User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...);
            })[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    }>

  • Parameters

    • User: typeof User
    • username: string
    • password: string
    • Optional code: string
    • Optional additionalData: {
          [k: string]: any;
      }
      • [k: string]: any

    Returns Promise<{
        message: string;
        user?: User & UserData & {
            abilities?: string[];
            email?: string;
            group?: Group & GroupData & {
                abilities?: string[];
                email?: string;
                phone?: string;
                user?: null | (User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...);
            };
            groups?: (Group & GroupData & {
                abilities?: (...)[];
                email?: string;
                phone?: string;
                user?: null | (User & UserData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; group?: (Group & GroupData & { abilities?: string[] | undefined; email?: string | undefined; phone?: string | undefined; user?: (User & ... 1 more ... & ...) | ... 1 more ... | undefined; }) | undefined; gro...);
            })[];
            inheritAbilities?: boolean;
            newEmailAddress?: string;
            phone?: string;
        };
    }>

Settings

Member Visibility

Theme