Hierarchy

  • MessageQueue

Properties

hook_types: Object = ...

Hook Types - Unknown: 0, ActivityUpdate: 1, Email: 2, WebHook: 3

status: Object = ...

Statuses - Pending: 0, Processing: 1, Complete: 2, Failed: 3

Methods

  • Delete Messages specified in list of MessageQueueIds

    Returns

    Returns Promise object that represents a collection of QueueMessages which have been processed

    Parameters

    • ids: number[]

      List of MessageQueueId values

    • status: string

      automatically delete messages that complete with successful execution, default is false

    • Optional hours_to_keep: number

      utomatically delete messages that complete with successful execution, default is false

    Returns Promise<unknown>

  • Get Messages specified in list of MessageQueueIds

    Returns

    Returns Promise object that represents a collection of QueueMessages which have been processed

    Parameters

    • ids: number[]

      List of MessageQueueId values

    • status: string
    • Optional maxcount: number = 15

      Maximum number returned. Defaults to 15

    Returns Promise<unknown>

  • Parameters

    • hook_ids: any

    Returns Promise<unknown>

  • Process Webhook MessageQueue records by MessageQueueId

    Returns

    Returns Promise object that represents a collection of QueueMessages which have been processed

    Parameters

    • Optional ids: number[]

      List of MessageQueueId values

    • Optional delete_successful: boolean = false

      automatically delete messages that complete with successful execution, default is false

    Returns Promise<unknown>

  • Parameters

    • parameters: any
    • Optional max_results: number

    Returns Promise<unknown>

  • Update queue message

    Returns

    Returns Promise object that represents an Object with the desired GIS service definitions

    Parameters

    • parameters: any

      Provide allowed parameters:

       {
      HookId: number,
      Id: number,
      Packet: string,
      Result: string,
      Status: string, // Available options: Pending, Processing, Complete, Failed
      HookType: string // Available options: Unknown, ActivityUpdate, Email, WebHook
      }

    Returns Promise<unknown>

  • Parameters

    • ids: number[]
    • status: string
    • Optional hours_to_keep: number

    Returns Promise<unknown>