Class: QueueChange

  • The cast.framework.messages.QueueChange class represents a queue change message for actions like insert, remove, or update.

  • Key properties include changeType to indicate the type of change and itemIds which lists the IDs of changed items.

  • insertBefore specifies the ID before which inserted items will be placed.

  • reorderItemIds is used specifically for QUEUE_REORDER responses and contains the list of reordered item IDs.

  • Properties like requestId and sequenceNumber are used for coordinating state and tracking requests.

cast.framework.messages.QueueChange

class   static

Represents a queue change message, such as insert, remove, and update.

Constructor

QueueChange

new QueueChange()

Properties

changeType

(non-null cast.framework.messages.QueueChangeType or undefined)

The actual queue change type.

insertBefore

(number or undefined)

The ID that the inserted items will precede.

itemIds

(non-null Array of number or undefined)

The list of changed item IDs.

reorderItemIds

(non-null Array of number or undefined)

The list of reordered item IDs. This is only used as a response for a QUEUE_REORDER request. The changeType becomes UPDATE, and itemIds contain the full list of queue items.

requestId

(number or undefined)

The corresponding request ID.

sequenceNumber

(number or undefined)

The queue change sequence ID. Used to coordinate state sync between various senders and the receiver.

type

non-null cast.framework.messages.MessageType