Class default

constructor

• new default(groupIdHash, profileIdHash): default

• Parameters

  • groupIdHash: SHA256IdHash<Group>
  • profileIdHash: SHA256IdHash<GroupProfile>

  Returns default

ReadonlygroupIdHash

name

onUpdated

persons

Optionalpicture

ReadonlyprofileIdHash

internalGroupName

• get internalGroupName(): string

• Returns the name of the loaded Group object.

  Returns string

  Throws

  if nothing was loaded

loadedVersion

• get loadedVersion(): undefined | SHA256Hash<GroupProfile>

• Returns the profile version that was loaded.

  Returns undefined | SHA256Hash<GroupProfile>

hasData

• hasData(): boolean

• Returns whether this model has data loaded.

  If this returns false, then the 'internalGroupName' property will throw and group members list and name and picture will be empty / undefined.

  Returns boolean

loadLatestVersion

• loadLatestVersion(): Promise<void>

• Load the latest profile version.

  Returns Promise<void>

loadVersion

• loadVersion(version): Promise<void>

• Load a specific profile version.

  Parameters

  • version: SHA256Hash<GroupProfile>

  Returns Promise<void>

saveAndLoad

• saveAndLoad(): Promise<void>

• Save the profile to disk and load the latest version.

  Why is there no pure save() function? The cause are CRDTs. The object that is eventually written to disk might differ from the current state of this instance. This happens when new data was received via chum since the last load. This means that we don't have a hash representing the current state.

  TODO: It is possible to write the intermediary state and obtain a hash. So we can implement a pure save() function. But this requires the lower levels to write the top level object of the tree and return the corresponding hash to the caller. The storeVersionedObjectCRDT and the plan interfaces don't support that right now in a easy to grasp way.

  Returns Promise<void>

shutdown

• shutdown(): Promise<void>

• Returns Promise<void>

StaticconstructFromLatestProfileVersion

• constructFromLatestProfileVersion(groupIdHash): Promise<default>

• Construct a new GroupModel with the latest version loaded.

  Parameters

  • groupIdHash: SHA256IdHash<Group>

  Returns Promise<default>

StaticconstructFromLatestProfileVersionByGroupName

• constructFromLatestProfileVersionByGroupName(groupName): Promise<default>

• Construct from internal group name.

  Internal group name is the name parameter of the Group object.

  Parameters

  • groupName: string

  Returns Promise<default>

StaticconstructFromProfileVersion

• constructFromProfileVersion(version): Promise<default>

• Construct a new GroupModel with a specific version loaded.

  Parameters

  • version: SHA256Hash<GroupProfile>

  Returns Promise<default>

StaticconstructWithNewGroup

• constructWithNewGroup(groupName?): Promise<default>

• Create a group and profile if they do not exist.

  If it already exists, it will simply return the existing group.

  Parameters

  • OptionalgroupName: string

    Name if not given the internal name will be random, and the profile name will be 'unnamed group'

  Returns Promise<default>

  The latest version of the group or an empty group.