Class: QueueChange

  • Represents a queue change message encompassing actions like insert, remove, and update within the Cast framework.

  • Provides properties detailing the change type, affected item IDs, insertion points, reordered IDs, and associated request/sequence information for queue management.

  • Enables communication and synchronization of queue state between senders and receivers within the Cast ecosystem.

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