Construction — SDK 0.9 — Wiki NimbyRails France

Contexte d’utilisation

Module	Package	Source SDK
Kotlin/JVM	fr.nimby.sdk	kotlin-client/src/main/kotlin/fr/nimby/sdk/Construction.kt

API publique du SDK 0.9.0-alpha.2. Chaque entrée donne la signature Kotlin et son contrat : sens de la valeur, conditions d’utilisation et effets à connaître. Choisissez les imports du module indiqué ci-dessus.

Imports de cette page

import fr.nimby.sdk.ConstructionResult
import fr.nimby.sdk.ConstructionState

ConstructionResult

fr.nimby.sdk · class

data class ConstructionResult(
    val state: ConstructionState, val token: Long, val createdIds: List<Long>,
    val reason: Int, val canUndo: Boolean,
)

Résultat d’une opération de construction expérimentale. Conserver le ticket pour suivre un état PENDING ou une réponse incertaine ; ne jamais répéter la création pour attendre.

ConstructionResult.state

fr.nimby.sdk · val

val state: ConstructionState

État courant de l’opération, à traiter explicitement.

ConstructionResult.token

fr.nimby.sdk · val

val token: Long

Ticket opaque associé à la partie/session d’édition. Le conserver avant toute écriture et ne pas le réutiliser après changement de partie.

ConstructionResult.createdIds

fr.nimby.sdk · val

val createdIds: List<Long>

Identités des signaux effectivement rapportés comme créés ; conserver aussi en cas de résultat partiel.

ConstructionResult.reason

fr.nimby.sdk · val

val reason: Int

Code de refus ou de résultat à conserver au journal avec le ticket et l’état ; ne pas déduire une réussite du seul code.

ConstructionResult.canUndo

fr.nimby.sdk · val

val canUndo: Boolean

Possibilité d’annulation au moment du résultat ; une commande intermédiaire peut l’invalider.

ConstructionState

fr.nimby.sdk · class

enum class ConstructionState {
    READY,
    APPLIED,
    UNDONE,
    REJECTED,
    PARTIAL,
    PENDING
}

Étapes et résultats distincts d’une opération. Un état en attente ou partiel ne doit pas être traité comme une réussite complète.

ConstructionState.READY

fr.nimby.sdk · enum-entry

READY

Préparation acceptée ; aucun signal ajouté par cette préparation.

ConstructionState.APPLIED

fr.nimby.sdk · enum-entry

APPLIED

Création appliquée ; lire createdIds et canUndo.

ConstructionState.UNDONE

fr.nimby.sdk · enum-entry

UNDONE

Annulation appliquée.

ConstructionState.REJECTED

fr.nimby.sdk · enum-entry

REJECTED

Opération refusée ; lire reason et l’état de la partie avant une autre demande.

ConstructionState.PARTIAL

fr.nimby.sdk · enum-entry

PARTIAL

Résultat partiel ; conserver les identités retournées et examiner la situation, sans renvoyer la série entière.

ConstructionState.PENDING

fr.nimby.sdk · enum-entry

PENDING

Opération encore en attente ; consulter le ticket avec poll.