Class default

Implements

DataApiType

Index

Constructors

Methods

getAllVersions getBlobAsArrayBuffer getBlobDescriptorAsArrayBuffer getBlobDescriptorUrl getBlobURL getLatestVersion useLiveAllVersions useLiveLatestVersion

Constructors

constructor

new default(oneApi: OneApi, models: ModelsHelperType): default
Parameters
- oneApi: OneApi
- models: ModelsHelperType
Returns default
- Defined in api/subApis/DataApi.ts:16

Methods

getAllVersions

getAllVersions<
    T extends
        | Access
        | Chum
        | Group
        | IdAccess
        | Instance
        | Person
        | Recipe
        | ChannelInfo
        | ChannelRegistry
        | Profile
        | GroupProfile
        | Someone
        | Leute
        | IoMRequestsRegistry
        | Settings
        | TopicAppRegistry
        | LocalInstancesList
        | SupplyMap
        | DemandMap
        | MatchMap
        | NotifiedUsers,
>(
    idHash: SHA256IdHash<T>,
): Promise<T[]>
Type Parameters
- T extends
      | Access
      | Chum
      | Group
      | IdAccess
      | Instance
      | Person
      | Recipe
      | ChannelInfo
      | ChannelRegistry
      | Profile
      | GroupProfile
      | Someone
      | Leute
      | IoMRequestsRegistry
      | Settings
      | TopicAppRegistry
      | LocalInstancesList
      | SupplyMap
      | DemandMap
      | MatchMap
      | NotifiedUsers
Parameters
- idHash: SHA256IdHash<T>
  id hash of the data to be observed
Returns Promise<T[]>
all current versions of the data
Implementation of DataApiType.getAllVersions
- Defined in api/subApis/DataApi.ts:25

getBlobAsArrayBuffer

getBlobAsArrayBuffer(hash: SHA256Hash<BLOB>): Promise<ArrayBuffer>
Parameters
- hash: SHA256Hash<BLOB>
  hash of the blob to be observed
Returns Promise<ArrayBuffer>
the blob as an array buffer
- Defined in api/subApis/DataApi.ts:97

getBlobDescriptorAsArrayBuffer

getBlobDescriptorAsArrayBuffer(
hash: SHA256Hash<BlobDescriptor>,
): Promise<ArrayBuffer>
Parameters
- hash: SHA256Hash<BlobDescriptor>
  hash of the blob descriptor to be observed
Returns Promise<ArrayBuffer>
the blob descriptor as an array buffer
- Defined in api/subApis/DataApi.ts:113

getBlobDescriptorUrl

getBlobDescriptorUrl(hash: SHA256Hash<BlobDescriptor>): Promise<string>
Parameters
- hash: SHA256Hash<BlobDescriptor>
  hash of the blob descriptor to be observed
Returns Promise<string>
the blob descriptor as a URL
- Defined in api/subApis/DataApi.ts:123

getBlobURL

getBlobURL(hash: SHA256Hash<BLOB>): Promise<string>
Parameters
- hash: SHA256Hash<BLOB>
  hash of the blob to be observed
Returns Promise<string>
the blob as a URL
- Defined in api/subApis/DataApi.ts:105

getLatestVersion

getLatestVersion<T extends OneVersionedObjectTypes>(
idHash: SHA256IdHash<T>,
): Promise<T>
Type Parameters
- T extends OneVersionedObjectTypes
Parameters
- idHash: SHA256IdHash<T>
  id hash of the data to be observed
Returns Promise<T>
the latest version of the data
- Defined in api/subApis/DataApi.ts:66

useLiveAllVersions

useLiveAllVersions<
    T extends
        | Access
        | Chum
        | Group
        | IdAccess
        | Instance
        | Person
        | Recipe
        | ChannelInfo
        | ChannelRegistry
        | Profile
        | GroupProfile
        | Someone
        | Leute
        | IoMRequestsRegistry
        | Settings
        | TopicAppRegistry
        | LocalInstancesList
        | SupplyMap
        | DemandMap
        | MatchMap
        | NotifiedUsers,
>(
    idHash: SHA256IdHash<T>,
    onUpdate: (data: T[]) => void | Promise<void>,
): Promise<() => void>
Type Parameters
- T extends
      | Access
      | Chum
      | Group
      | IdAccess
      | Instance
      | Person
      | Recipe
      | ChannelInfo
      | ChannelRegistry
      | Profile
      | GroupProfile
      | Someone
      | Leute
      | IoMRequestsRegistry
      | Settings
      | TopicAppRegistry
      | LocalInstancesList
      | SupplyMap
      | DemandMap
      | MatchMap
      | NotifiedUsers
Parameters
- idHash: SHA256IdHash<T>
  id hash of the data to be observed
- onUpdate: (data: T[]) => void | Promise<void>
  function to be called when the data changes
Returns Promise<() => void>
disconnect listener function
Implementation of DataApiType.useLiveAllVersions
- Defined in api/subApis/DataApi.ts:42

useLiveLatestVersion

useLiveLatestVersion<T extends OneVersionedObjectTypes>(
idHash: SHA256IdHash<T>,
onUpdate: (data: T) => void | Promise<void>,
): Promise<() => void>
Type Parameters
- T extends OneVersionedObjectTypes
Parameters
- idHash: SHA256IdHash<T>
  id hash of the data to be observed
- onUpdate: (data: T) => void | Promise<void>
  function to be called when the data changes
Returns Promise<() => void>
disconnect listener function
- Defined in api/subApis/DataApi.ts:75

Class default

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns default

Methods

getAllVersions

Type Parameters

Parameters

Returns Promise<T[]>

getBlobAsArrayBuffer

Parameters

Returns Promise<ArrayBuffer>

getBlobDescriptorAsArrayBuffer

Parameters

Returns Promise<ArrayBuffer>

getBlobDescriptorUrl

Parameters

Returns Promise<string>

getBlobURL

Parameters

Returns Promise<string>

getLatestVersion

Type Parameters

Parameters

Returns Promise<T>

useLiveAllVersions

Type Parameters

Parameters

Returns Promise<() => void>

useLiveLatestVersion

Type Parameters

Parameters

Returns Promise<() => void>

Settings

On This Page