Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Command

Hierarchy

  • Command

Index

Constructors

Methods

Constructors

constructor

  • new Command(command: string): Command

  • Parameters

    • command: string

    Returns Command

Methods

ackType

  • ackType(value: string): Command
  • ackType(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The acknowledgement message type(s).

batchSize

  • batchSize(value: number): Command
  • batchSize(): number

  • Parameters

    • value: number

    Returns Command

    The updated Command object.

  • Returns number

    The batch size value.

bookmark

  • bookmark(value: string): Command
  • bookmark(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The bookmark value.

command

  • command(value: string): Command
  • command(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The Command name value.

commandId

  • commandId(value: string): Command
  • commandId(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The command id value.

correlationId

  • correlationId(value: string): Command
  • correlationId(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The correlationId value.

data

  • data(value: any): Command
  • data(): any

  • Parameters

    • value: any

    Returns Command

    The updated Command object.

  • Returns any

    The Command data (message payload).

expiration

  • expiration(value: number): Command
  • expiration(): number

  • Parameters

    • value: number

    Returns Command

    The updated Command object.

  • Returns number

    The command expiration value.

filter

  • filter(value: string): Command
  • filter(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The filter value.

options

  • options(value: string): Command
  • options(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The options (comma-delimited) string value.

orderBy

  • orderBy(value: string): Command
  • orderBy(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The orderBy value.

queryId

  • queryId(value: string): Command
  • queryId(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The query id.

sequenceId

  • sequenceId(value: BigInteger): Command
  • sequenceId(): BigInteger

  • Parameters

    • value: BigInteger

    Returns Command

    The updated Command object.

  • Returns BigInteger

    The sequenceId value.

sowKey

  • sowKey(value: string): Command
  • sowKey(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The sow key value.

sowKeys

  • sowKeys(value: string): Command
  • sowKeys(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The sowKeys value.

subId

  • subId(value: string): Command
  • subId(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The subscription id.

subIds

  • subIds(value: string): Command
  • subIds(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The subIds (comma-delimited) value.

topN

  • topN(value: number): Command
  • topN(): number

  • Parameters

    • value: number

    Returns Command

    The updated Command object.

  • Returns number

    The top N value.

topic

  • topic(value: string): Command
  • topic(): string

  • Parameters

    • value: string

    Returns Command

    The updated Command object.

  • Returns string

    The topic value.