@celo/identity › "offchain/accessors/binary" › PrivateBinaryAccessor

Class: PrivateBinaryAccessor

Schema for writing any encrypted binary data.

Hierarchy

• PrivateBinaryAccessor

↳ PrivatePictureAccessor

Implements

• PrivateAccessor‹Buffer›

Index

Constructors

• constructor

Properties

• dataPath
• read
• wrapper

Methods

• allowAccess
• readAsResult
• write

Constructors

constructor

+ new PrivateBinaryAccessor(wrapper: OffchainDataWrapper, dataPath: string): PrivateBinaryAccessor

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:41

Parameters:

Name	Type
wrapper	OffchainDataWrapper
dataPath	string

Returns: PrivateBinaryAccessor

Properties

Readonly dataPath

• dataPath: string

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:42

---

read

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

Implementation of PrivateAccessor.read

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:56

Type declaration:

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

Parameters:

Name	Type
...args	TArgs

---

Readonly wrapper

• wrapper: OffchainDataWrapper

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:42

Methods

allowAccess

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

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:48

Parameters:

Name	Type
toAddresses	Address[]
symmetricKey?	Buffer

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

---

readAsResult

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

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:52

Parameters:

Name	Type
account	Address

Returns: Promise‹Result‹Buffer‹›, SchemaErrors››

---

write

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

Defined in packages/sdk/identity/src/offchain/accessors/binary.ts:44

Parameters:

Name	Type
data	Buffer
toAddresses	Address[]
symmetricKey?	Buffer

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