Class User

User

Date

2/1/2024 - 2:44:47 AM

Export

Constructors

constructor

new User(params): User
Creates an instance of User.
Parameters
- params: UserConfig
Returns User
Date
2/9/2024 - 5:54:11 AM
- Defined in src/user/index.ts:41

Properties

`Private` `Readonly` api

api: API

`Private` `Readonly` sdk

sdk: FilenSDK

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

Methods

account

account(): Promise<UserAccountResponse>
Fetch user account.

Returns Promise<UserAccountResponse>
Date
2/20/2024 - 6:42:45 AM

Async
- Defined in src/user/index.ts:105

acquireResourceLock

acquireResourceLock(param0): Promise<void>
Lock a resource.
Parameters
- param0: {
      lockUUID: string;
      maxTries?: number;
      resource: string;
      tryTimeout?: number;
  }
  - lockUUID: string
  - Optional maxTries?: number
  - resource: string
  - Optional tryTimeout?: number
Returns Promise<void>
Async
- Defined in src/user/index.ts:601

appearOffline

appearOffline(param0): Promise<void>
Toggle appear offline status on/off.
Parameters
- param0: {
  enabled: boolean;
  }
  - enabled: boolean
Returns Promise<void>
Date
2/20/2024 - 7:18:12 AM

Async
- Defined in src/user/index.ts:552

baseFolder

baseFolder(): Promise<string>
Fetch the user's base folder UUID.

Returns Promise<string>
Date
2/20/2024 - 6:40:17 AM

Async
- Defined in src/user/index.ts:67

cancelSubscription

cancelSubscription(param0): Promise<void>
Cancel a subscription.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<void>
Date
2/20/2024 - 7:12:09 AM

Async
- Defined in src/user/index.ts:452

changeEmail

changeEmail(param0): Promise<void>
Change email.
Parameters
- param0: {
  email: string;
  password: string;
  }
  - email: string
  - password: string
Returns Promise<void>
Date
2/20/2024 - 6:50:24 AM

Async
- Defined in src/user/index.ts:155

changePassword

changePassword(param0): Promise<string>
Change password.
Parameters
- param0: {
  currentPassword: string;
  newPassword: string;
  }
  - currentPassword: string
  - newPassword: string
Returns Promise<string>
Date
2/20/2024 - 7:03:26 AM

Async
- Defined in src/user/index.ts:311

checkAPIKeyValidity

checkAPIKeyValidity(): Promise<boolean>
Check if the current API key is valid.

Returns Promise<boolean>
Async
- Defined in src/user/index.ts:362

createSubscription

createSubscription(param0): Promise<string>
Create a subscription payment flow. Returns the payment gateway URL.
Parameters
- param0: {
  paymentMethod: PaymentMethods;
  planId: number;
  }
  - paymentMethod: PaymentMethods
  - planId: number
Returns Promise<string>
Date
2/20/2024 - 7:13:19 AM

Async
- Defined in src/user/index.ts:467

delete

delete(param0): Promise<void>
Request account deletion.
Parameters
- param0: {
  twoFactorCode?: string;
  }
  - Optional twoFactorCode?: string
Returns Promise<void>
Date
2/20/2024 - 6:54:22 AM

Async
- Defined in src/user/index.ts:272

deleteAllVersionedFiles

deleteAllVersionedFiles(): Promise<void>
Delete all versioned files.

Returns Promise<void>
Date
2/20/2024 - 6:54:57 AM

Async
- Defined in src/user/index.ts:284

deleteEverything

deleteEverything(): Promise<void>
Delete all files and directories.

Returns Promise<void>
Date
2/20/2024 - 6:55:20 AM

Async
- Defined in src/user/index.ts:296

didExportMasterKeys

didExportMasterKeys(): Promise<void>
Mark the current master keys as exported.

Returns Promise<void>
Async
- Defined in src/user/index.ts:351

disableTwoFactorAuthentication

disableTwoFactorAuthentication(param0): Promise<void>
Disable two factor authentication.
Parameters
- param0: {
  twoFactorCode: string;
  }
  - twoFactorCode: string
Returns Promise<void>
Date
2/20/2024 - 7:05:03 AM

Async
- Defined in src/user/index.ts:404

enableTwoFactorAuthentication

enableTwoFactorAuthentication(param0): Promise<string>
Enable two factor authentication. Returns the recovery keys.
Parameters
- param0: {
  twoFactorCode: string;
  }
  - twoFactorCode: string
Returns Promise<string>
Date
2/20/2024 - 7:04:35 AM

Async
- Defined in src/user/index.ts:390

event

event(param0): Promise<UserEvent>
Fetch info about an event.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<UserEvent>
Date
2/20/2024 - 7:10:44 AM

Async
- Defined in src/user/index.ts:438

events

events(params?): Promise<UserEvent[]>
Fetch events based on timestamp and filter. Timestamp can be used for pagination.
Parameters
- Optional params: {
  filter?: "all";
  timestamp?: number;
  }
  - Optional filter?: "all"
  - Optional timestamp?: number
Returns Promise<UserEvent[]>
Async
- Defined in src/user/index.ts:416

gdpr

gdpr(): Promise<UserGDPRResponse>
Fetch GDPR info.

Returns Promise<UserGDPRResponse>
Date
2/20/2024 - 6:43:36 AM

Async
- Defined in src/user/index.ts:117

generateInvoice

generateInvoice(param0): Promise<string>
Generate a PDF invoice. Returns PDF data as a Base64 encoded string.
Parameters
- param0: {
  uuid: string;
  }
  - uuid: string
Returns Promise<string>
Date
2/20/2024 - 7:14:22 AM

Async
- Defined in src/user/index.ts:481

info

info(): Promise<UserInfoResponse>
Fetch the user's info.

Returns Promise<UserInfoResponse>
Date
2/20/2024 - 6:39:47 AM

Async
- Defined in src/user/index.ts:55

loginAlerts

loginAlerts(param0): Promise<void>
Toggle login alerts on/off.
Parameters
- param0: {
  enabled: boolean;
  }
  - enabled: boolean
Returns Promise<void>
Date
2/20/2024 - 7:16:54 AM

Async
- Defined in src/user/index.ts:524

profile

profile(param0): Promise<UserProfileResponse>
Fetch a user's public profile.
Parameters
- param0: {
  id: number;
  }
  - id: number
Returns Promise<UserProfileResponse>
Date
2/20/2024 - 7:19:15 AM

Async
- Defined in src/user/index.ts:566

publicKey

publicKey(param0): Promise<string>
Get a user's public key.
Parameters
- param0: {
  email: string;
  }
  - email: string
Returns Promise<string>
Date
2/20/2024 - 6:41:01 AM

Async
- Defined in src/user/index.ts:81

refreshResourceLock

refreshResourceLock(param0): Promise<void>
Refresh a resource lock.
Parameters
- param0: {
  lockUUID: string;
  resource: string;
  }
  - lockUUID: string
  - resource: string
Returns Promise<void>
Async
- Defined in src/user/index.ts:665

releaseResourceLock

releaseResourceLock(param0): Promise<void>
Unlock a resource.
Parameters
- param0: {
  lockUUID: string;
  resource: string;
  }
  - lockUUID: string
  - resource: string
Returns Promise<void>
Async
- Defined in src/user/index.ts:643

requestAffiliatePayout

requestAffiliatePayout(param0): Promise<void>
Request an affiliate payout.
Parameters
- param0: {
  address: string;
  method: string;
  }
  - address: string
  - method: string
Returns Promise<void>
Date
2/20/2024 - 7:15:26 AM

Async
- Defined in src/user/index.ts:496

resourceLockStatus

resourceLockStatus(param0): Promise<"locked">
Fetch resource lock status.
Parameters
- param0: {
  resource: string;
  }
  - resource: string
Returns Promise<"locked">
Async
- Defined in src/user/index.ts:686

settings

settings(): Promise<UserSettingsResponse>
Fetch the user's settings.

Returns Promise<UserSettingsResponse>
Date
2/20/2024 - 6:41:53 AM

Async
- Defined in src/user/index.ts:93

updateDesktopLastActive

updateDesktopLastActive(param0): Promise<void>
Update desktop last active timestamp.
Parameters
- param0: {
  timestamp: number;
  }
  - timestamp: number
Returns Promise<void>
Date
2/20/2024 - 7:20:56 AM

Async
- Defined in src/user/index.ts:580

updateNickname

updateNickname(param0): Promise<void>
Update account nickname.
Parameters
- param0: {
  nickname: string;
  }
  - nickname: string
Returns Promise<void>
Date
2/20/2024 - 7:17:43 AM

Async
- Defined in src/user/index.ts:538

updatePersonalInformation

updatePersonalInformation(param0): Promise<void>
Update personal information.
Parameters
- param0: {
      city?: string;
      companyName?: string;
      country?: string;
      firstName?: string;
      lastName?: string;
      postalCode?: string;
      street?: string;
      streetNumber?: string;
      vatId?: string;
  }
  - Optional city?: string
  - Optional companyName?: string
  - Optional country?: string
  - Optional firstName?: string
  - Optional lastName?: string
  - Optional postalCode?: string
  - Optional street?: string
  - Optional streetNumber?: string
  - Optional vatId?: string
Returns Promise<void>
Date
2/20/2024 - 6:52:44 AM

Async
- Defined in src/user/index.ts:198

uploadAvatar

uploadAvatar(param0): Promise<void>
Upload an avatar.
Parameters
- param0: {
  buffer: Buffer;
  }
  - buffer: Buffer
Returns Promise<void>
Date
2/20/2024 - 6:46:44 AM

Async
- Defined in src/user/index.ts:131

versioning

versioning(param0): Promise<void>
Toggle file versioning on/off.
Parameters
- param0: {
  enabled: boolean;
  }
  - enabled: boolean
Returns Promise<void>
Date
2/20/2024 - 7:16:11 AM

Async
- Defined in src/user/index.ts:510

Class User

Date

Export

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: UserConfig

Returns User

Date

Properties

Private Readonly api

Private Readonly sdk

Private Readonly sdkConfig

Methods

account

Returns Promise<UserAccountResponse>

Date

Async

acquireResourceLock

Parameters

param0: { lockUUID: string; maxTries?: number; resource: string; tryTimeout?: number; }

lockUUID: string

Optional maxTries?: number

resource: string

Optional tryTimeout?: number

Returns Promise<void>

Async

appearOffline

Parameters

param0: { enabled: boolean; }

enabled: boolean

Returns Promise<void>

Date

Async

baseFolder

Returns Promise<string>

Date

Async

cancelSubscription

Parameters

param0: { uuid: string; }

uuid: string

Returns Promise<void>

Date

Async

changeEmail

Parameters

param0: { email: string; password: string; }

email: string

password: string

Returns Promise<void>

Date

Async

changePassword

Parameters

param0: { currentPassword: string; newPassword: string; }

currentPassword: string

newPassword: string

Returns Promise<string>

Date

Async

checkAPIKeyValidity

Returns Promise<boolean>

Async

createSubscription

Parameters

param0: { paymentMethod: PaymentMethods; planId: number; }

paymentMethod: PaymentMethods

planId: number

Returns Promise<string>

Date

Async

delete

Parameters

param0: { twoFactorCode?: string; }

Optional twoFactorCode?: string

`Private` `Readonly` api

`Private` `Readonly` sdk

`Private` `Readonly` sdkConfig

param0: {
lockUUID: string;
maxTries?: number;
resource: string;
tryTimeout?: number;
}

`Optional` maxTries?: number

`Optional` tryTimeout?: number

param0: {
enabled: boolean;
}

param0: {
uuid: string;
}

param0: {
email: string;
password: string;
}

param0: {
currentPassword: string;
newPassword: string;
}

param0: {
paymentMethod: PaymentMethods;
planId: number;
}

param0: {
twoFactorCode?: string;
}

`Optional` twoFactorCode?: string

param0: {
twoFactorCode: string;
}

param0: {
twoFactorCode: string;
}

param0: {
uuid: string;
}

`Optional` params: {
filter?: "all";
timestamp?: number;
}

`Optional` filter?: "all"

`Optional` timestamp?: number

param0: {
uuid: string;
}

param0: {
enabled: boolean;
}

param0: {
id: number;
}