Nextcloud PHP API (master)

IProvideUserSecretBackend

Interface IProvideUserSecretBackend

Tags
since
23.0.0

Table of Contents

Methods

getCurrentUserSecret()  : non-empty-string|null
Optionally returns a stable per-user secret. This secret is for instance used to secure file encryption keys.

Methods

getCurrentUserSecret()

Optionally returns a stable per-user secret. This secret is for instance used to secure file encryption keys.

public getCurrentUserSecret() : non-empty-string|null
Tags
throws
HintException

when the backend is configured to return a per-user secret but is unable to do so.

since
23.0.0
35.0.0

The returns value is now optional.

Return values
non-empty-string|null

Returns the per-user secret if the backend is configured or null otherwise.

On this page

Search results