client/com.erfangholami.androidsolidservices.client.sdk/SolidTicketsDataModule

SolidTicketsDataModule

Client SDK for the Solid Tickets data module — the user's wallet: schema:Ticket resources stored on their pod and registered in the Solid type index.

Calls are delegated over IPC to the Android Solid Services app, which owns the login and the tokens. Obtain an instance via Solid.getTicketsDataModule. Collect ticketsDataModuleServiceConnectionState and wait for true before issuing calls. All operations are suspend functions, return null when the service yields no result, and throw SolidException on failure.

Types

Companion

object Companion

Functions

createTicket

suspend fun createTicket(webId: String, newTicket: NewTicket, storage: String? = null, artifact: ByteArray? = null, artifactContentType: String? = null, images: NewTicketImages? = null, isPrivate: Boolean = true, container: String? = null): Ticket?

Creates a ticket on the user's pod, in its own sub-container of the tickets container.

deleteTicket

suspend fun deleteTicket(webId: String, ticketUri: String): Ticket?

Deletes the ticket at ticketUri: its index row and its whole sub-container (document, artifact, stored images). Returns the removed ticket.

getTicket

suspend fun getTicket(webId: String, ticketUri: String): Ticket?

Reads the full ticket document at ticketUri.

getTicketArtifact

suspend fun getTicketArtifact(webId: String, artifactUri: String): TicketArtifact?

Reads a binary stored with a ticket — the original artifact or a stored pass image. Subject to the ~1 MB Binder transaction limit.

listTickets

suspend fun listTickets(webId: String): TicketList?

Returns the cached tickets index for webId — enough to render a wallet list without fetching each ticket document.

putTicketArtifact

suspend fun putTicketArtifact(webId: String, ticketUri: String, artifact: ByteArray, artifactContentType: String, images: NewTicketImages? = null): Ticket?

Replaces the ticket's stored artifact (and any provided pass-image roles) with fresh bytes, refreshing the document links. Travels inline over Binder, so it is subject to the ~1 MB transaction limit.

ticketsDataModuleServiceConnectionState

fun ticketsDataModuleServiceConnectionState(): Flow<Boolean>

Hot Flow of the IPC service connection state; emits true once connected.

updateTicket

suspend fun updateTicket(webId: String, ticketUri: String, updated: NewTicket): Ticket?

Rewrites the ticket at ticketUri from updated with replace semantics: properties absent from updated are removed. The created date and the artifact link are preserved.