Class MessageQueue

hook_types

status

delete

• delete(ids: number[], status: string, hours_to_keep?: number): Promise<unknown>

  Delete Messages specified in list of MessageQueueIds

  Parameters

  • ids: number[]

    List of MessageQueueId values
  • status: string

    automatically delete messages that complete with successful execution, default is false
  • Optionalhours_to_keep: number

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

  Returns Promise<unknown>

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

get

• get(ids: number[], status: string, maxcount?: number): Promise<unknown>

  Get Messages specified in list of MessageQueueIds

  Parameters

  • ids: number[]

    List of MessageQueueId values
  • status: string
  • Optionalmaxcount: number = 15

    Maximum number returned. Defaults to 15

  Returns Promise<unknown>

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

getWebooks

• getWebooks(hook_ids: any): Promise<unknown>

  Parameters

  • hook_ids: any

  Returns Promise<unknown>

preferences

• preferences(): Promise<unknown>

  Returns Promise<unknown>

processMessages

• processMessages(ids?: number[], delete_successful?: boolean): Promise<unknown>

  Process Webhook MessageQueue records by MessageQueueId

  Parameters

  • Optionalids: number[]

    List of MessageQueueId values
  • Optionaldelete_successful: boolean = false

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

  Returns Promise<unknown>

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

search

• search(parameters: any, max_results?: number): Promise<unknown>

  Parameters

  • parameters: any
  • Optionalmax_results: number

  Returns Promise<unknown>

update

• update(parameters: any): Promise<unknown>

  Update queue message

  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>

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

updateMessageStatus

• updateMessageStatus(
      ids: number[],
      status: string,
      hours_to_keep?: number,
  ): Promise<unknown>

  Parameters

  • ids: number[]
  • status: string
  • Optionalhours_to_keep: number

  Returns Promise<unknown>