Shared/com.erfangholami.androidsolidservices.shared.model.sharing

Package-level declarations

Types

data class AccessGrant(val direction: AccessGrantDirection, val counterpartWebId: String, val resourceUri: String, val mode: ShareMode, val status: AccessGrantStatus, val source: AccessGrantSource, val grantedAt: String?, val requestUri: String?) : Parcelable

A single access relationship between the current user and another agent over a resource, unified across every source the library can observe:

AccessGrantDirection

enum AccessGrantDirection : Enum<AccessGrantDirection>

Direction of an AccessGrant relative to the current user.

AccessGrantSource

enum AccessGrantSource : Enum<AccessGrantSource>

Where an AccessGrant was observed.

AccessGrantStatus

enum AccessGrantStatus : Enum<AccessGrantStatus>

Whether an AccessGrant is in effect or pending a decision.

CatalogEntry

data class CatalogEntry(val resourceUri: String, val title: String, val description: String?, val depictionUri: String?) : Parcelable

One row in an owner-published catalog.

GivenShare

data class GivenShare(val receiver: ShareReceiver, val mode: ShareMode, val resourceUri: String, val createdAt: String? = null, val resourceType: String? = null, val resourceName: String? = null) : Parcelable

A share the user has given (created) — the user grants receiver access of mode on resourceUri. Stored in {podRoot}/solidshare/shares/given_shares.ttl.

ParsedShareLink

data class ParsedShareLink(val resourceUri: String, val ownerWebId: String?, val resourceType: String? = null) : Parcelable

The decoded contents of a solidshare:// share deep link.

ReceivedShare

data class ReceivedShare(val ownerWebId: String, val mode: ShareMode, val resourceUri: String, val addedAt: String? = null, val resourceType: String? = null, val resourceName: String? = null) : Parcelable

A share the user has received — ownerWebId has granted the current user mode on resourceUri. Stored in {podRoot}/solidshare/shares/received_shares.ttl.

ShareMode

enum ShareMode : Enum<ShareMode>

Access mode granted to the receiver of a share.

ShareNotification

data class ShareNotification(val notificationUri: String, val type: ShareNotificationType, val ownerWebId: String, val resourceUri: String, val mode: ShareMode?, val summary: String?, val publishedAt: String?, val targetWebId: String? = null, val resourceType: String? = null, val resourceName: String? = null) : Parcelable

One inbox notification surfaced to the receiver — either an offer of new access (ShareNotificationType.OFFER) or a notice that previously-granted access was withdrawn (ShareNotificationType.UNDO).

ShareNotificationType

enum ShareNotificationType : Enum<ShareNotificationType>

Kind of share notification carried by the LDN inbox.

ShareReceiver

sealed class ShareReceiver : Parcelable

Identifies the recipient of a share.

ShareRequest

data class ShareRequest(val requestUri: String, val requesterWebId: String, val resourceUri: String, val requestedMode: ShareMode, val summary: String?, val publishedAt: String?) : Parcelable

Inbox notification representing a request from another agent asking the current user (the resource owner) to grant access.

Properties

CATALOG_FILE_NAME

const val CATALOG_FILE_NAME: String

GIVEN_SHARES_FILE_NAME

const val GIVEN_SHARES_FILE_NAME: String

RECEIVED_SHARES_FILE_NAME

const val RECEIVED_SHARES_FILE_NAME: String

SHARES_CONTAINER_NAME

const val SHARES_CONTAINER_NAME: String

SOLID_SHARE_URI_SCHEME

const val SOLID_SHARE_URI_SCHEME: String

Custom URI scheme that opens scanned shares directly in the SolidShare app.

SOLIDSHARE_CONTAINER_NAME

const val SOLIDSHARE_CONTAINER_NAME: String

Pod-relative paths used by the sharing feature.

Functions

collapseByOwner

fun List<ReceivedShare>.collapseByOwner(): List<ReceivedShare>

The received-share counterpart of collapseByReceiver: one ReceivedShare per (ownerWebId, resourceUri) at the strongest ShareMode, preserving the earliest known ReceivedShare.addedAt and the first known ReceivedShare.resourceType / ReceivedShare.resourceName.

collapseByReceiver

fun List<GivenShare>.collapseByReceiver(): List<GivenShare>

Collapses a flat list of GivenShare — which may carry several rows for one (receiver, resourceUri) when a grant writes multiple implied acl:modes (e.g. Read+Append for "Add", Read+Write for "Edit") — into a single row per pair carrying the strongest ShareMode. Each receiver therefore appears once per resource at its effective access level. The earliest known GivenShare.createdAt is preserved, as are the first known GivenShare.resourceType / GivenShare.resourceName.