commonMain.app.bsky.graph.Relationship.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluesky-jvm Show documentation

Bluesky Social API bindings for Kotlin.

The newest version!

@file:Suppress("DEPRECATION")

package app.bsky.graph

import kotlin.Suppress
import kotlinx.serialization.Serializable
import sh.christian.ozone.api.AtUri
import sh.christian.ozone.api.Did

/**
 * lists the bi-directional graph relationships between one actor (not indicated in the object), and
 * the target actors (the DID included in the object)
 *
 * @param following if the actor follows this DID, this is the AT-URI of the follow record
 * @param followedBy if the actor is followed by this DID, contains the AT-URI of the follow record
 */
@Serializable
public data class Relationship(
  public val did: Did,
  /**
   * if the actor follows this DID, this is the AT-URI of the follow record
   */
  public val following: AtUri? = null,
  /**
   * if the actor is followed by this DID, contains the AT-URI of the follow record
   */
  public val followedBy: AtUri? = null,
)