@celo/identity › "offchain/accessors/name" › PrivateNameAccessor

Class: PrivateNameAccessor

Hierarchy

• PrivateSimpleAccessor‹NameType›

↳ PrivateNameAccessor

Implements

• PrivateAccessor‹NameType›

Index

Constructors

• constructor

Properties

• dataPath
• read
• type
• wrapper

Methods

• allowAccess
• readAsResult
• write

Constructors

constructor

+ new PrivateNameAccessor(wrapper: OffchainDataWrapper): PrivateNameAccessor

Overrides PrivateSimpleAccessor.constructor

Defined in packages/sdk/identity/src/offchain/accessors/name.ts:17

Parameters:

Name	Type
wrapper	OffchainDataWrapper

Returns: PrivateNameAccessor

Properties

Readonly dataPath

• dataPath: string

Inherited from PrivateSimpleAccessor.dataPath

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:78

---

read

• read: function = makeAsyncThrowable(this.readAsResult.bind(this))

Implementation of PrivateAccessor.read

Inherited from PrivateSimpleAccessor.read

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:103

Type declaration:

▸ (...args: TArgs): Promise‹TResult›

Parameters:

Name	Type
...args	TArgs

---

Readonly type

• type: Type‹NameType›

Inherited from PrivateSimpleAccessor.type

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:77

---

Readonly wrapper

• wrapper: OffchainDataWrapper

Overrides PrivateSimpleAccessor.wrapper

Defined in packages/sdk/identity/src/offchain/accessors/name.ts:18

Methods

allowAccess

▸ allowAccess(toAddresses: Address[], symmetricKey?: Buffer): Promise‹void | InvalidDataError‹› | OffchainError‹› | UnknownCiphertext‹› | UnavailableKey‹› | InvalidKey‹››

Inherited from PrivateSimpleAccessor.allowAccess

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:89

Parameters:

Name	Type
toAddresses	Address[]
symmetricKey?	Buffer

Returns: Promise‹void | InvalidDataError‹› | OffchainError‹› | UnknownCiphertext‹› | UnavailableKey‹› | InvalidKey‹››

---

readAsResult

▸ readAsResult(account: Address): Promise‹Result‹NameType, SchemaErrors››

Inherited from PrivateSimpleAccessor.readAsResult

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:93

Parameters:

Name	Type
account	Address

Returns: Promise‹Result‹NameType, SchemaErrors››

---

write

▸ write(data: NameType, toAddresses: Address[], symmetricKey?: Buffer): Promise‹void | InvalidDataError‹› | OffchainError‹› | UnknownCiphertext‹› | UnavailableKey‹› | InvalidKey‹››

Inherited from PrivateSimpleAccessor.write

Defined in packages/sdk/identity/src/offchain/accessors/simple.ts:81

Parameters:

Name	Type
data	NameType
toAddresses	Address[]
symmetricKey?	Buffer

Returns: Promise‹void | InvalidDataError‹› | OffchainError‹› | UnknownCiphertext‹› | UnavailableKey‹› | InvalidKey‹››