clientprotocol/org.inthewaves.kotlinsignald.clientprotocol.v1.structures/GetGroupRevisionPagesRequest

GetGroupRevisionPagesRequest

data class GetGroupRevisionPagesRequest(account: String, groupId: String, fromRevision: Int, includeFirstRevision: Boolean?) : SignaldRequestBodyV1<GroupHistoryPage>

Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change.

Constructors

fun GetGroupRevisionPagesRequest(account: String, groupId: String, fromRevision: Int, includeFirstRevision: Boolean? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): GroupHistoryPage

open override fun submit(socketCommunicator: SocketCommunicator, id: String): GroupHistoryPage

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): GroupHistoryPage

open suspend override fun submitSuspend(socketCommunicator: SuspendSocketCommunicator, id: String): GroupHistoryPage

Properties

account

val account: String

The account to interact with

fromRevision

val fromRevision: Int

The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned.

groupId

val groupId: String

Example: "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE="

val id: String

The id to include in the request. This is expected to be present in the response JSON.

includeFirstRevision

val includeFirstRevision: Boolean? = null

Whether to include the first state in the returned pages (default false)

version

val version: String

The version to include in the request. As this class won't be used to deserialize the response, the Required annotation is being used to force this field to be serialized