Options
All
  • Public
  • Public/Protected
  • All
Menu

Class User

Basic user representing the format of user data within this application.

Hierarchy

  • User

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new User(data?: Partial<Omit<User, "fullName" | "listName">>): User
  • Instanciates a new User and (optionally) hydrates with data

    Parameters

    • Default value data: Partial<Omit<User, "fullName" | "listName">> = {}

      An object literal used to hydrate the User class.

    Returns User

Properties

email

email: string = ""

User's email address

example

waldo@harvard.edu

eppn

eppn: string = ""

Unique ID representing a user. See [[HarvardKeyProfile.eppn]] for more information

example

4A2849CF119852@harvard.edu

firstName

firstName: string = ""

User's first name

example

James

groups

groups: GROUP[] = []

A list of grouper group names that the user belongs to

example
['authorized-admins-seas-course-planning']

lastName

lastName: string = ""

User's Last name

example

Waldo

Accessors

fullName

  • get fullName(): string

listName

  • get listName(): string

Generated using TypeDoc