Class default

constructor

• new default(idHash): default

• Parameters

  • idHash: SHA256IdHash<Someone>

  Returns default

ReadonlyidHash

onUpdate

addIdentity

• addIdentity(identity): Promise<void>

• Add an identity to the someone object and save it.

  Parameters

  • identity: SHA256IdHash<Person>

  Returns Promise<void>

addProfile

• addProfile(profile): Promise<void>

• Add a profile to this someone object.

  Parameters

  • profile: SHA256IdHash<Profile>

  Returns Promise<void>

alternateIdentities

• alternateIdentities(): Promise<SHA256IdHash<Person>[]>

• Retrieve all identities managed by this someone object except the main identity.

  Returns Promise<SHA256IdHash<Person>[]>

collectAllDescriptionsOfType

• collectAllDescriptionsOfType<T>(type, identity?): Promise<PersonDescriptionInterfaces[T][]>

• Return all descriptions from all profiles.

  Type Parameters

  • T extends keyof PersonDescriptionInterfaces

  Parameters

  • type: T
  • Optionalidentity: SHA256IdHash<Person>

  Returns Promise<PersonDescriptionInterfaces[T][]>

collectAllEndpointsOfType

• collectAllEndpointsOfType<T>(type, identity?): Promise<CommunicationEndpointInterfaces[T][]>

• Return all endpoints from all profiles.

  Type Parameters

  • T extends keyof CommunicationEndpointInterfaces

  Parameters

  • type: T
  • Optionalidentity: SHA256IdHash<Person>

  Returns Promise<CommunicationEndpointInterfaces[T][]>

createProfile

• createProfile(profileId, personId, owner, communicationEndpoints?, personDescriptions?): Promise<default>

• Create a new profile for a specific person.

  Parameters

  • profileId: string
  • personId: SHA256IdHash<Person>
  • owner: SHA256IdHash<Person>
  • communicationEndpoints: CommunicationEndpointTypes[] = []
  • personDescriptions: PersonDescriptionTypes[] = []

  Returns Promise<default>

getDefaultProfileDisplayName

• getDefaultProfileDisplayName(identity, myId): Promise<string>

• Get the profile name from one of the default profiles.

  It will first try to find the profile that we edited (I am owner). Then it will try to find the profile that the person itself edited (He is owner) Then it will look for a default profile from any owner.

  Parameters

  • identity: SHA256IdHash<Person>
  • myId: SHA256IdHash<Person>

    This needs to be my own main identity, because profiles with this owner will supersede the other profiles.

  Returns Promise<string>

getDefaultProfileDisplayNames

• getDefaultProfileDisplayNames(myId): Promise<Map<SHA256IdHash<Person>, string>>

• Parameters

  • myId: SHA256IdHash<Person>

  Returns Promise<Map<SHA256IdHash<Person>, string>>

getMainProfileDisplayName

• getMainProfileDisplayName(): Promise<string>

• Returns Promise<string>

hasData

• hasData(): boolean

• Returns whether this model has data loaded.

  If this returns false, then the 'hash', 'profileId' ... properties will throw when being accessed.

  Returns boolean

identities

• identities(): SHA256IdHash<Person>[]

• Get all identities managed by this someone object.

  Returns SHA256IdHash<Person>[]

loadLatestVersion

• loadLatestVersion(): Promise<void>

• Load the latest someone version.

  Returns Promise<void>

loadVersion

• loadVersion(version): Promise<void>

• Load a specific someone version.

  Parameters

  • version: SHA256Hash<Someone>

  Returns Promise<void>

mainIdentity

• mainIdentity(): Promise<SHA256IdHash<Person>>

• Retrieve the main identity by looking it up in the main profile.

  Returns Promise<SHA256IdHash<Person>>

mainProfile

• mainProfile(): Promise<default>

• Returns Promise<default>

mainProfileLazyLoad

• mainProfileLazyLoad(): default

• Returns default

managesIdentity

• managesIdentity(identity): boolean

• Checks whether this identity is managed by this someone object.

  Parameters

  • identity: SHA256IdHash<Person>

  Returns boolean

profiles

• profiles(identity?): Promise<default[]>

• Get the profiles managed by this someone object.

  Parameters

  • Optionalidentity: SHA256IdHash<Person>

  Returns Promise<default[]>

profilesLazyLoad

• profilesLazyLoad(identity?): default[]

• Get the profiles managed by this someone object.

  Note that this will return ProfileModel instances that have no data in them. You have to use loadLatestVersion on it in order to get the data.

  Parameters

  • Optionalidentity: SHA256IdHash<Person>

    Get the profiles only for this identity. If not specified, get all profiles for all identities managed by this someone object.

  Returns default[]

removeIdentity

• removeIdentity(identity): Promise<void>

• Remove an identity to the someone object

  Parameters

  • identity: SHA256IdHash<Person>

  Returns Promise<void>

removeProfile

• removeProfile(profile): Promise<void>

• Remove a profile to this someone object.

  Parameters

  • profile: SHA256IdHash<Profile>

  Returns Promise<void>

saveAndLoad

• saveAndLoad(): Promise<void>

• Save the someone 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.

  Returns Promise<void>

setMainIdentity

• setMainIdentity(identity): Promise<void>

• Sets the main identity by guessing which profile to use as mainProfile

  Parameters

  • identity: SHA256IdHash<Person>

  Returns Promise<void>

setMainProfile

• setMainProfile(profile): Promise<void>

• Set the main profile.

  Throws if the identity referenced by this profile is not managed by this someone object.

  Parameters

  • profile: SHA256IdHash<Profile>

  Returns Promise<void>

setMainProfileIfNotDefault

• setMainProfileIfNotDefault(profile): Promise<void>

• Set the main profile only when the saved profile is not the main profile.

  Throws if the identity referenced by this profile is not managed by this someone object.

  Parameters

  • profile: SHA256IdHash<Profile>

  Returns Promise<void>

StaticconstructFromLatestVersion

• constructFromLatestVersion(idHash): Promise<default>

• Construct a new SomeoneModel with the latest version loaded.

  Parameters

  • idHash: SHA256IdHash<Someone>

  Returns Promise<default>

StaticconstructFromVersion

• constructFromVersion(version): Promise<default>

• Construct a new SomeoneModel with a specific version loaded.

  Parameters

  • version: SHA256Hash<Someone>

  Returns Promise<default>

StaticconstructWithNewSomeone

• constructWithNewSomeone(someoneId, mainProfile): Promise<default>

• Create a someone if it does not exist.

  If you specify descriptions and / or endpoints here and a someone version already exists without those endpoints and / or descriptions it will add them again.

  Parameters

  • someoneId: string
  • mainProfile: SHA256IdHash<Profile>

  Returns Promise<default>

  The latest version of the someone or an empty someone.