GroupActivities · IOS API REFERENCE

GroupSessionEvent.Action.QueueChange

struct · SDK 27.1

struct QueueChange

A type that describes a modification to the playback queue. Use this type to inform the participant about changes to the playback queue associated with the current activity. Your app manages the queue, along with any additions or changes. You use this type to communicate those changes back to the participant using the system UI. When a change occurs, configure this type with information about the change, and wrap it in a ``GroupSessionEvent/Action-swift.struct`` type. Pass the action to the ``GroupSession/showNotice(_:)`` method to display the change to the participant.

Members (2)

static

added

TypeScript

static added(item: GroupSessionEvent_Action_QueueChange_Item): GroupSessionEvent_Action_QueueChange

Swift declaration

static func added(_ item: GroupSessionEvent.Action.QueueChange.Item) -> GroupSessionEvent.Action.QueueChange

Returns a queue change for an added item. Before showing a notice to the user, call this method to generate a type for the added item. Pass this type to the ``GroupSessionEvent/Action-swift.struct/updatedQueue(_:)`` method to create the postable action. - Parameters: - item: The item the participant added to the queue. - Returns: A type that contains information about the change.

static

setUpNext

TypeScript

static setUpNext(item: GroupSessionEvent_Action_QueueChange_Item): GroupSessionEvent_Action_QueueChange

Swift declaration

static func setUpNext(_ item: GroupSessionEvent.Action.QueueChange.Item) -> GroupSessionEvent.Action.QueueChange

Returns a queue change for a new up-next item. Before showing a notice to the user, call this method to generate a type for the changed up-next item. Pass this type to the ``GroupSessionEvent/Action-swift.struct/updatedQueue(_:)`` method to create the postable action. - Parameters: - item: The next item in the queue. - Returns: A type that contains information about the change.

Skipped declarations

No declarations were skipped in this snapshot.

All GroupActivities types →