Struct SinkholeLinks 

pub struct SinkholeLinks<'a> { /* private fields */ }

Sinkhole link routes, from Client::sinkhole_links: which lists apply to which client identities.

Links belong to the client identity’s owner: you see and manage the links of your own identities (all of them as an Admin), not other users’ links to your shared list.

Implementations

impl<'a> SinkholeLinks<'a>

pub async fn list( &self, filter: &SinkholeLinkFilter, ) -> Result<Vec<SinkholeLink>>

Links of the caller’s client identities, all at once (Core does not paginate them).

GET /api/v1/sinkhole-links

pub async fn create( &self, client_identity_id: Uuid, list_id: Uuid, ) -> Result<SinkholeLink>

Applies a list to a client identity; Relay starts filtering that client’s queries by it. You must own the identity, and the list must be yours or shared.

POST /api/v1/sinkhole-links

Errors

• ErrorCode::NotFound if the identity or the list does not exist.
• ErrorCode::Forbidden if the identity is not yours, or the list is neither yours nor shared.
• ErrorCode::Suspended if the identity or its owner is suspended.
• ErrorCode::Conflict if the link exists.

pub async fn delete( &self, client_identity_id: Uuid, list_id: Uuid, ) -> Result<()>

Stops applying a list to a client identity. The identity’s owner or an Admin only, not the list’s owner.

DELETE /api/v1/sinkhole-links/:client_identify_id/:sinkholelist_id

Errors

• ErrorCode::NotFound if there is no such link.
• ErrorCode::Forbidden if the identity is not yours.
• ErrorCode::Suspended if the identity or its owner is suspended.