Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IQueueService

Service for managing IQueues

Hierarchy

Index

Properties

Methods

Properties

queues

queues: IQueue[]

Available queues

Methods

createDocumentItem

  • Creates a new Document queue item

    Parameters

    • artifactId: number

      Document artifact ID

    Returns IDocumentItem

    Newly created Document queue item

createQueue

  • createQueue(name: string, items?: (number | IQueueItem)[], ...rest: any[]): IQueue

  • Creates a new IQueue

    Parameters

    • name: string

      The name of the Queue that is displayed to the user

    • Optional items: (number | IQueueItem)[]

      Items in the queue

    • Rest ...rest: any[]

    Returns IQueue

    Newly created queue

createRdoFileItem

  • createRdoFileItem(fileFieldArtifactId: number, fileId: number): IRDOFileItem

  • Creates a new RDO file queue item

    Parameters

    • fileFieldArtifactId: number

      Artifact ID of the file field on the Relativity Object Type

    • fileId: number

      File ID of the file uploaded to the field

    Returns IRDOFileItem

    Newly created RDO File queue item

deleteQueue

  • deleteQueue(id: string): boolean

  • Deletes an IQueue

    Parameters

    • id: string

      ID of the queue to delete

    Returns boolean

    Boolean indicating if the queue was successfully deleted

getQueueById

  • getQueueById(id: string): IQueue

  • Retrieves an IQueue by ID

    Parameters

    • id: string

      ID of the queue to retrieve

    Returns IQueue

    Queue with the given ID

off

  • Unregisters an event handler

    Parameters

    • eventType: QueueServiceEventType

      Event to unregister from

    • Optional handler: EventHandler

      Event handler function. If not passed in, it removes all event handlers.

    • Optional once: boolean

      Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)

    Returns void

on

once