Class User

The user class represents a user in nextcloud. async getGroups async isDisabled async getLastLogin async getEmail getId async getDisplayName

Hierarchy

User

Index

Constructors

constructor

Properties

id

Methods

Constructors

constructor

new User(client: Client, id: string, options?: IUserOptions): User

- Defined in src/user.ts:63
the conscructor of the user should only me invoked by the Client

Parameters
- client: Client
- id: string
  
  the user id
- Optional options: IUserOptions
  
  optional options
Returns User

Properties

Readonly id

id: string

Methods

addToMemberUserGroup

addToMemberUserGroup(userGroup: UserGroup): Promise<void>

- Defined in src/user.ts:447
adds the user to a user group as member

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Parameters
- userGroup: UserGroup
  
  the user group
Returns Promise<void>

delete

delete(): Promise<void>

- Defined in src/user.ts:583
deletes a user

async

throws

{UserNotFoundError}

Returns Promise<void>

demoteFromSubadminUserGroup

demoteFromSubadminUserGroup(userGroup: UserGroup): Promise<void>

- Defined in src/user.ts:571
demote the user from beeing a subadmin of the user group

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Parameters
- userGroup: UserGroup
  
  the user group
Returns Promise<void>

demoteFromSuperAdmin

demoteFromSuperAdmin(): Promise<void>

- Defined in src/user.ts:507
demote user from being a super admin

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Returns Promise<void>

disable

disable(): Promise<void>

- Defined in src/user.ts:99
disables the user

async

throws

{UserNotFoundError}

Returns Promise<void>

enable

enable(): Promise<void>

- Defined in src/user.ts:110
enables the user

async

throws

{UserNotFoundError}

Returns Promise<void>

getAddress

getAddress(): Promise<string>

- Defined in src/user.ts:257
returns the phone number

async

throws

{UserNotFoundError}

Returns Promise<string>

address

getDisplayName

getDisplayName(): Promise<string>

- Defined in src/user.ts:135
returns the display name

async

throws

{UserNotFoundError}

Returns Promise<string>

display name

getEmail

getEmail(): Promise<string>

- Defined in src/user.ts:205
returns the email address

async

throws

{UserNotFoundError}

Returns Promise<string>

email adress

getLanguage

getLanguage(): Promise<string>

- Defined in src/user.ts:338
returns the langauge code

async

throws

{UserNotFoundError}

Returns Promise<string>

language code

getLastLogin

getLastLogin(): Promise<Date | null>

- Defined in src/user.ts:121
get the last login date or null if the user has not been logged in yet

async

throws

{UserNotFoundError}

Returns Promise<Date | null>

last login date or null if the user has not been logged in yet

getLocale

getLocale(): Promise<string>

- Defined in src/user.ts:365
returns the locale

async

throws

{UserNotFoundError}

Returns Promise<string>

locale

getMemberUserGroupIds

getMemberUserGroupIds(): Promise<string[]>

- Defined in src/user.ts:433
returns a list of user group ids where the user is member

async

throws

{UserNotFoundError}

Returns Promise<string[]>

a list of user group ids where the user is member

getMemberUserGroups

getMemberUserGroups(): Promise<UserGroup[]>

- Defined in src/user.ts:418
returns a list of user groups where the user is member

async

throws

{UserNotFoundError}

Returns Promise<UserGroup[]>

a list of user groups where the user is member

getPhone

getPhone(): Promise<string>

- Defined in src/user.ts:231
returns the phone number

async

throws

{UserNotFoundError}

Returns Promise<string>

phone number

getQuota

getQuota(): Promise<IUserOptionsQuota>

- Defined in src/user.ts:158
returns information on quota, usage and available space

async

throws

{UserNotFoundError}

Returns Promise<IUserOptionsQuota>

getQuotaUserFriendly

getQuotaUserFriendly(): Promise<IUserQuotaUserFriendly>

- Defined in src/user.ts:168
returns information on quota, usage and available space in a user friendly format

async

throws

{UserNotFoundError}

Returns Promise<IUserQuotaUserFriendly>

getSubadminUserGroupIds

getSubadminUserGroupIds(): Promise<string[]>

- Defined in src/user.ts:541
returns a list of user group ids where the user is subadmin

async

throws

{UserNotFoundError}

Returns Promise<string[]>

a list of user group ids where the user is subadmin

getSubadminUserGroups

getSubadminUserGroups(): Promise<UserGroup[]>

- Defined in src/user.ts:526
returns a list of user groups where the user is subadmin

async

throws

{UserNotFoundError}

Returns Promise<UserGroup[]>

a list of user groups where the user is subadmin

getTwitter

getTwitter(): Promise<string>

- Defined in src/user.ts:311
returns the twitter handle

async

throws

{UserNotFoundError}

Returns Promise<string>

twitter handle

getWebsite

getWebsite(): Promise<string>

- Defined in src/user.ts:284
returns the website

async

throws

{UserNotFoundError}

Returns Promise<string>

website

isEnabled

isEnabled(): Promise<boolean>

- Defined in src/user.ts:89
returns true if the user is enabled

async

throws

{UserNotFoundError}

Returns Promise<boolean>

true if the user is enabled

isSuperAdmin

isSuperAdmin(): Promise<boolean>

- Defined in src/user.ts:479
true if the user is a superadmin

async

throws

{UserNotFoundError}

Returns Promise<boolean>

true if the user is a superadmin

promoteToSuperAdmin

promoteToSuperAdmin(): Promise<void>

- Defined in src/user.ts:492
promote user to super admin

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Returns Promise<void>

promoteToUserGroupSubadmin

promoteToUserGroupSubadmin(userGroup: UserGroup): Promise<void>

- Defined in src/user.ts:555
promote the user to be a subadmin of the user group

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Parameters
- userGroup: UserGroup
  
  the user group
Returns Promise<void>

removeFromMemberUserGroup

removeFromMemberUserGroup(userGroup: UserGroup): Promise<void>

- Defined in src/user.ts:463
remove the user from a user group as member

async

throws

{UserNotFoundError}

throws

{UserGroupDoesNotExistError}

throws

{InsufficientPrivilegesError}

throws

{OperationFailedError}

Parameters
- userGroup: UserGroup
  
  the user group
Returns Promise<void>

resendWelcomeEmail

resendWelcomeEmail(): Promise<void>

- Defined in src/user.ts:404
resends the welcome email

async

throws

{UserResendWelcomeEmailError}

Returns Promise<void>

setAddress

setAddress(value: string): Promise<void>

- Defined in src/user.ts:269
set the address

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the address
Returns Promise<void>

setDisplayName

setDisplayName(value: string): Promise<void>

- Defined in src/user.ts:147
set the display name

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the display name
Returns Promise<void>

setEmail

setEmail(value: string): Promise<void>

- Defined in src/user.ts:217
set the email address

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the email address
Returns Promise<void>

setLanguage

setLanguage(value: string): Promise<void>

- Defined in src/user.ts:350
set the language code like EN, DE, FR...

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the language code
Returns Promise<void>

setLocale

setLocale(value: string): Promise<void>

- Defined in src/user.ts:377
set the locale like EN, DE, FR...

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the locale
Returns Promise<void>

setPassword

setPassword(value: string): Promise<void>

- Defined in src/user.ts:390
set the password

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the password
Returns Promise<void>

setPhone

setPhone(value: string): Promise<void>

- Defined in src/user.ts:243
set phone number

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the phone number
Returns Promise<void>

setQuota

setQuota(value: string): Promise<void>

- Defined in src/user.ts:194
sets the quota limit of the user

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the quota string like "1 GB", "100 MB"
Returns Promise<void>

setTwitter

setTwitter(value: string): Promise<void>

- Defined in src/user.ts:323
set the twitter handle

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the twitter handle
Returns Promise<void>

setWebsite

setWebsite(value: string): Promise<void>

- Defined in src/user.ts:296
set the website

async

throws

{UserNotFoundError}

throws

{UserUpdateError}

Parameters
- value: string
  
  the website
Returns Promise<void>

Generated using TypeDoc