Interface IUserBuilder

Interface for creating a user. Please note, a username and email provided must be unique else you will NOT be able to successfully save the user object.

Hierarchy

IUserBuilder

Index

Properties

Methods

getDisplayName getEmails getUser getUsername setData setDisplayName setEmails setUsername

Properties

kind

kind: USER

Methods

getDisplayName

getDisplayName(): string
Gets the display name of this user.

Returns string
- Defined in src/definition/accessors/IUserBuilder.ts:42

getEmails

getEmails(): IUserEmail[]
Gets emails of the user

Returns IUserEmail[]
- Defined in src/definition/accessors/IUserBuilder.ts:30

getUser

getUser(): Partial<IUser>
Gets the user

Returns Partial<IUser>
- Defined in src/definition/accessors/IUserBuilder.ts:59

getUsername

getUsername(): string
Gets the username of this user

Returns string
- Defined in src/definition/accessors/IUserBuilder.ts:54

setData

setData(user): IUserBuilder
Provides a convient way to set the data for the user. Note: Providing an "id" field here will be ignored.
Parameters
- user: Partial<IUser>
  
  the user data to set
Returns IUserBuilder
- Defined in src/definition/accessors/IUserBuilder.ts:18

setDisplayName

setDisplayName(name): IUserBuilder
Sets the display name of this user.
Parameters
- name: string
  
  the display name of the user
Returns IUserBuilder
- Defined in src/definition/accessors/IUserBuilder.ts:37

setEmails

setEmails(emails): IUserBuilder
Sets emails of the user
Parameters
- emails: IUserEmail[]
  
  the array of email addresses of the user
Returns IUserBuilder
- Defined in src/definition/accessors/IUserBuilder.ts:25

setUsername

setUsername(username): IUserBuilder
Sets the username for the user
Parameters
- username: string
  
  username of the user
Returns IUserBuilder
- Defined in src/definition/accessors/IUserBuilder.ts:49

Generated using TypeDoc