Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProfileOps

Index

Functions

_export

  • _export(profile: Profile, force?: boolean, oldGroupsOverride?: Group[]): Promise<void>
  • Export this Profile to all relevant Sources

    Parameters

    • profile: Profile
    • Default value force: boolean = false
    • Default value oldGroupsOverride: Group[] = []

    Returns Promise<void>

_import

  • _import(profile: Profile, toSave?: boolean, toLock?: boolean): Promise<Profile>
  • Import the properties of this Profile

    Parameters

    • profile: Profile
    • Default value toSave: boolean = true
    • Default value toLock: boolean = true

    Returns Promise<Profile>

addOrUpdateProperties

  • addOrUpdateProperties(profile: Profile, properties: {}): Promise<Profile>
  • Add or Update a Property on this Profile

    Parameters

    • profile: Profile
    • properties: {}
      • [key: string]: Array<string | number | boolean | Date> | any

    Returns Promise<Profile>

addOrUpdateProperty

  • Add or Update many Properties on this Profile

    Parameters

    • profile: Profile
    • hash: {}
      • [key: string]: Array<string | number | boolean | Date>

    Returns Promise<Profile>

arraysAreEqual

  • arraysAreEqual(a: Array<any>, b: Array<any>): boolean
  • Parameters

    • a: Array<any>
    • b: Array<any>

    Returns boolean

findOrCreateByUniqueProfileProperties

  • findOrCreateByUniqueProfileProperties(hash: {}): Promise<{ isNew: boolean; profile: Profile }>
  • The method you'll be using to create profiles with arbitrary data. Hash looks like {email: "person@example.com", id: 123}

    Parameters

    • hash: {}
      • [key: string]: Array<string | number | boolean | Date>

    Returns Promise<{ isNew: boolean; profile: Profile }>

merge

  • Merge 2 Profiles, favoring the first Profile

    Parameters

    Returns Promise<Profile>

properties

  • Get the Properties of this Profile

    Parameters

    Returns Promise<ProfilePropertyType>

removeProperties

  • removeProperties(profile: Profile, properties: Array<string>): Promise<void>
  • Remove all Properties from this Profile

    Parameters

    • profile: Profile
    • properties: Array<string>

    Returns Promise<void>

removeProperty

  • removeProperty(profile: Profile, key: string): Promise<void>
  • Remove a Property on this Profile

    Parameters

    Returns Promise<void>

Generated using TypeDoc