A class exposing functionality for users to manage API keys from the client. It is always scoped to a particular User and can only be accessed via ApiKeys.
InheritanceUser.ApiKeyClient
Namespace: Realms.Sync Assembly: Realm.dll Syntaxpublic class User.ApiKeyClient
Methods | Edit this page View Source CreateAsync(string)
Creates an API key that can be used to authenticate as the user.
Declarationpublic Task<ApiKey> CreateAsync(string name)
Parameters Type Name Description string name
The friendly name of the key.
Returns | Edit this page View Source DeleteAsync(ObjectId)Deletes an API key by id.
Declarationpublic Task DeleteAsync(ObjectId id)
Parameters Type Name Description ObjectId id
The id of the key to delete.
Returns Type Description TaskAn awaitable Task representing the asynchronous delete operation.
| Edit this page View Source DisableAsync(ObjectId)Disables an API key by id.
Declarationpublic Task DisableAsync(ObjectId id)
Parameters Type Name Description ObjectId id
The id of the key to disable.
Returns Type Description TaskAn awaitable Task representing the asynchronous disable operation.
See Also | Edit this page View Source EnableAsync(ObjectId)Enables an API key by id.
Declarationpublic Task EnableAsync(ObjectId id)
Parameters Type Name Description ObjectId id
The id of the key to enable.
Returns Type Description TaskAn awaitable Task representing the asynchronous enable operation.
See Also | Edit this page View Source FetchAllAsync()Fetches all API keys associated with the user.
Declarationpublic Task<IEnumerable<ApiKey>> FetchAllAsync()
Returns Type Description Task<IEnumerable<ApiKey>>
An awaitable task representing the asynchronous lookup operation. Upon completion, the result contains a collection of all API keys for that user.
| Edit this page View Source FetchAsync(ObjectId)Fetches a specific user API key by id.
Declarationpublic Task<ApiKey?> FetchAsync(ObjectId id)
Parameters Type Name Description ObjectId id
The id of the key to fetch.
ReturnsRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4