ServerQueueParams

@PublicApi
@Immutable
@AutoValue
public abstract class ServerQueueParams

Contains metadata for a queue stored on the server of a add-on application.

Summary

Nested types

Builder for a ServerQueueParams object.

Public methods
static ServerQueueParams.Builder
abstract String

Gets the queue ID of a server.
abstract long

Gets the version of a queue on a server.

Public methods

builder

public static ServerQueueParams.Builder builder()

queueId

public abstract String queueId()

Gets the queue ID of a server. Generally, an app would do something like GET: yourserver.domain/queue/$QUEUE_ID, based on this information, but the implementation is entirely up to the add-on application.

queueVersion

public abstract long queueVersion()

Gets the version of a queue on a server. Generally, this would be incremented to indicate to other clients that the queue has changed and should be reloaded. When either field is changed, the add-on application will be notified, and can act based on their own logic.