Skip to content

Commit

Permalink
hide and improve docs of uid
Browse files Browse the repository at this point in the history
  • Loading branch information
photovoltex committed Jan 23, 2025
1 parent 4c4598b commit 23c154f
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions connect/src/model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,17 @@ pub enum PlayingTrack {
Index(u32),
/// Represent the uri of a track.
Uri(String),
/// Represent an internal identifier from spotify.
#[doc(hidden)]
/// Represent an internal identifier from spotify.
///
/// The internal identifier is not the id contained in the uri. And rather
/// an unrelated id probably unique in spotify's internal database. But that's
/// just speculation.
///
/// ## Remarks:
/// Is not intended for usage, but required for parsing of some connect messages.
/// This identifier is not available by any public api. It's used for varies in
/// any spotify client, like sorting, displaying which track is currently played
/// and skipping to a track. Mobile uses it pretty intensively but also web and
/// desktop seem to make use of it.
Uid(String),
}

Expand Down

0 comments on commit 23c154f

Please sign in to comment.