Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DestinationOps

Index

Functions

checkSendExportParallelism

  • checkSendExportParallelism(app: App, destination: Destination, taskName: string, taskArgs: {}, synchronous: boolean): Promise<boolean>
  • Parameters

    • app: App
    • destination: Destination
    • taskName: string
    • taskArgs: {}
      • [key: string]: any
    • synchronous: boolean

    Returns Promise<boolean>

destinationConnectionOptions

destinationMappingOptions

exportGroupMembers

  • exportGroupMembers(destination: Destination, force?: boolean): Promise<void>
  • Export all the Group Members of the Groups that this Destination is Tracking

    Parameters

    • destination: Destination
    • Default value force: boolean = false

    Returns Promise<void>

exportProfile

  • exportProfile(destination: Destination, profile: Profile, runs: Run[], imports: Array<Import>, synchronous?: boolean, force?: boolean): Promise<void | { errors: ErrorWithProfileGuid[]; retryDelay: number; success: boolean } | { error: Error; retryDelay: number; success: boolean }>
  • Given a Destination and a Profile (and lots of related data), create all the exports that should be sent

    Parameters

    • destination: Destination
    • profile: Profile
    • runs: Run[]
    • imports: Array<Import>
    • Default value synchronous: boolean = false
    • Default value force: boolean = false

    Returns Promise<void | { errors: ErrorWithProfileGuid[]; retryDelay: number; success: boolean } | { error: Error; retryDelay: number; success: boolean }>

formatOutgoingProfileProperties

  • Format Grouparoo's profile properties to the type the destination wants.

    Parameters

    Returns any

formatProfilePropertiesForDestination

  • formatProfilePropertiesForDestination(_export: Export, destination: Destination, key: "oldProfileProperties" | "newProfileProperties"): Promise<{}>
  • Parameters

    • _export: Export
    • destination: Destination
    • key: "oldProfileProperties" | "newProfileProperties"

    Returns Promise<{}>

getExportArrayProperties

profilePreview

  • profilePreview(destination: Destination, profile: Profile, mapping: Mappings, destinationGroupMemberships: {}): Promise<{ anonymousId: string; createdAt: number; guid: string; properties: ProfilePropertyType; updatedAt: number } & { groupNames: string[]; properties: {} }>
  • Get a preview of a Profile for this Destination It is assumed that the profile provided is already in a Group tracked by this Destination

    Parameters

    Returns Promise<{ anonymousId: string; createdAt: number; guid: string; properties: ProfilePropertyType; updatedAt: number } & { groupNames: string[]; properties: {} }>

safelyIncrementExportRunRuns

  • safelyIncrementExportRunRuns(exportRuns: ExportRun[], column: "profilesExported" | "exportsCreated"): Promise<void>
  • It's possible the run that created this export has been removed (it was from a deleting group).

    Parameters

    • exportRuns: ExportRun[]
    • column: "profilesExported" | "exportsCreated"

    Returns Promise<void>

sendExport

  • sendExport(destination: Destination, _export: Export, synchronous?: boolean): Promise<void | { error: Error; retryDelay: number; success: boolean }>
  • Send an export previously created to the destination

    Parameters

    • destination: Destination
    • _export: Export
    • Default value synchronous: boolean = false

    Returns Promise<void | { error: Error; retryDelay: number; success: boolean }>

sendExports

  • Send all pending exports previously created to the destination in a batch. Batch size is handled by the task export:sendBatch.

    Parameters

    • destination: Destination
    • _exports: Export[]
    • Default value synchronous: boolean = false

    Returns Promise<void | { errors: ErrorWithProfileGuid[]; retryDelay: number; success: boolean }>

trackGroup

  • Track a Group

    Parameters

    Returns Promise<void>

unTrackGroup

  • unTrackGroup(destination: Destination): Promise<void>
  • Un-track a Group

    Parameters

    Returns Promise<void>

Generated using TypeDoc