Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace GroupOps

Index

Functions

buildProfileImport

  • buildProfileImport(profileGuid: string, creatorType: string, creatorGuid: string, destinationGuid?: string): Promise<Import>
  • Given a Profile, create an import to recalculate its Group Membership

    Parameters

    • profileGuid: string
    • creatorType: string
    • creatorGuid: string
    • Optional destinationGuid: string

    Returns Promise<Import>

countComponentMembersFromRules

  • countComponentMembersFromRules(group: Group, rules?: GroupRuleWithKey[]): Promise<{ componentCounts: any[]; funnelCounts: any[] }>
  • Take the rules for the group and check how many group members there would have been both individually for each single rule, and then by building up the query step-by-step

    Parameters

    Returns Promise<{ componentCounts: any[]; funnelCounts: any[] }>

countPotentialMembers

  • countPotentialMembers(group: Group, rules?: GroupRuleWithKey[], matchType?: "any" | "all"): Promise<number>
  • Count the members that would be in this group

    Parameters

    • group: Group
    • Optional rules: GroupRuleWithKey[]
    • Default value matchType: "any" | "all" = group.matchType

    Returns Promise<number>

removePreviousRunGroupMembers

  • removePreviousRunGroupMembers(group: Group, run: Run, limit?: number): Promise<number>
  • Part 3 for the Group Run Check if there was anyone we should have removed from a previous Run that was stopped for this Run

    Parameters

    • group: Group
    • run: Run
    • Default value limit: number = 100

    Returns Promise<number>

run

  • run(group: Group, force?: boolean, destinationGuid?: string): Promise<void>
  • Create a Run for this Group

    Parameters

    • group: Group
    • Default value force: boolean = false
    • Optional destinationGuid: string

    Returns Promise<void>

runAddGroupMembers

  • runAddGroupMembers(group: Group, run: Run, limit?: number, offset?: number, highWaterMark?: number, force?: boolean, destinationGuid?: string): Promise<{ groupMembersCount: number; nextHighWaterMark: number; nextOffset: number }>
  • Part 1 of the Group Run Add New Members

    Parameters

    • group: Group
    • run: Run
    • Default value limit: number = 1000
    • Default value offset: number = 0
    • Default value highWaterMark: number = null
    • Default value force: boolean = false
    • Optional destinationGuid: string

    Returns Promise<{ groupMembersCount: number; nextHighWaterMark: number; nextOffset: number }>

runRemoveGroupMembers

  • runRemoveGroupMembers(group: Group, run: Run, limit?: number, destinationGuid?: string): Promise<number>
  • Part 2 of the Group Run Remove Members

    Parameters

    • group: Group
    • run: Run
    • Default value limit: number = 1000
    • Optional destinationGuid: string

    Returns Promise<number>

stopPreviousRuns

  • stopPreviousRuns(group: Group): Promise<void>
  • Stop previous Runs for this Group

    Parameters

    Returns Promise<void>

updateProfileMembership

  • updateProfileMembership(group: Group, profile: Profile): Promise<boolean>
  • Check if the profile should be in this Group

    Parameters

    Returns Promise<boolean>

Generated using TypeDoc