atKey Reference
Learn how to create atKeys for your chosen platform
AtKey
Please note that any reference to the word "AtKey" in this document is not associated with cryptographic keys. The atKey is the "key" of the key-value pair that makes up an atRecord.
This article explains how to create an atKey in the atSDK.
If you are unfamiliar with atKeys please read this first.
Flutter / Dart
Package Installation
The at_commons package contains common elements used in a number of Atsign's Flutter and Dart packages. This package needs to be included in the application in order to create atKeys.
First add the package to your project:
flutter pub add at_commons
Usage
See below for how to create the various types of atKeys.
Public atKey
To create a public atKey, first use the AtKey.public
builder to configure it, then call .build
to create it.
static PublicKeyBuilder public(String key,
{String? namespace, String sharedBy = ''})
The build
method on PublicKeyBuilder
takes no parameters.
Example
public:phone.wavi@alice
AtKey myPublicID = AtKey.public('phone', namespace: 'wavi', sharedBy: '@alice').build();
Self atKey
To create a self atkeyD, first use the AtKey.self
builder to configure it, then call .build
to create it.
static SelfKeyBuilder self(String key,
{String? namespace, String sharedBy = ''})
The build
method on SelfKeyBuilder
takes no parameters.
Example
phone.wavi@alice
AtKey mySelfID = AtKey.self('phone', namespace: 'wavi', sharedBy: '@alice').build();
Shared atKey
To create a shared atKey, first use the AtKey.shared
builder to configure it, then call .build
to create it.
static SharedKeyBuilder shared(String key,
{String? namespace, String sharedBy = ''})
The build
method on SharedKeyBuilder
takes no parameters.
Example
@bob:phone.wavi@alice
AtKey sharedKey = (AtKey.shared('phone', 'wavi')
..sharedWith('@bob')).build();
Caching shared atKeys
To cache a shared atKey, you can do a cascade call on SharedKeyBuilder.cache
.
AtKey atKey = (AtKey.shared('phone', namespace: 'wavi', sharedBy: '@alice')
..sharedWith('@bob')
..cache(1000, true))
.build();
API Docs
You can find the API reference for the entire package available on pub.
The AtKey
class API reference is available here.
Last updated