Class Users

Hierarchy

Base
- Users

Index

Constructors

Properties

Accessors

Methods

comments favorite favorites follower followers following followings get getAlt getV2 likes playlists search searchAlt searchV2 tracks tracksV2 webProfiles

Constructors

constructor

new Users(sc): Users
Parameters
- sc: Soundcloud
Returns Users
Inherited from Base.constructor
- Defined in entities/Base.ts:4

Properties

`Readonly` sc

Accessors

api

get api(): API
Returns API
Inherited from Base.api
- Defined in entities/Base.ts:5

Methods

comments

comments(userResolvable): Promise<SoundcloudComment[]>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudComment[]>

Deprecated
Gets all comments by the user.
- Defined in entities/Users.ts:139

favorite

favorite(userResolvable, trackResolvable): Promise<SoundcloudTrack>
Parameters
- userResolvable: string | number
- trackResolvable: string | number
Returns Promise<SoundcloudTrack>

Deprecated
Gets a specific favorite track.
- Defined in entities/Users.ts:178

favorites

favorites(userResolvable): Promise<SoundcloudTrack[]>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudTrack[]>

Deprecated
use likes Gets all of a users favorite tracks.
- Defined in entities/Users.ts:149

follower

follower(userResolvable, anotherUserResolvable): Promise<SoundcloudUser>
Parameters
- userResolvable: string | number
- anotherUserResolvable: string | number
Returns Promise<SoundcloudUser>

Deprecated
Gets a specific follower.
- Defined in entities/Users.ts:128

followers

followers(userResolvable): Promise<SoundcloudUserCollection>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudUserCollection>

Deprecated
Gets all of a users followers.
- Defined in entities/Users.ts:118

following

following(userResolvable, anotherUserResolvable): Promise<SoundcloudUser>
Parameters
- userResolvable: string | number
- anotherUserResolvable: string | number
Returns Promise<SoundcloudUser>

Deprecated
Gets a specific following.
- Defined in entities/Users.ts:107

followings

followings(userResolvable): Promise<SoundcloudUserCollection>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudUserCollection>

Deprecated
Gets all the users the user is following.
- Defined in entities/Users.ts:97

get

get(userResolvable): Promise<any>
Parameters
- userResolvable: string | number
Returns Promise<any>

Deprecated
use getV2 Gets a user by URL or ID.
- Defined in entities/Users.ts:40

getAlt

getAlt(url): Promise<SoundcloudUserV2>
Gets a user by URL (web scraping)
Parameters
- url: string
Returns Promise<SoundcloudUserV2>
- Defined in entities/Users.ts:215

getV2

getV2(userResolvable): Promise<SoundcloudUserV2>
Fetches a user from URL or ID using Soundcloud v2 API.
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudUserV2>
- Defined in entities/Users.ts:50

likes

likes(userResolvable, limit?): Promise<SoundcloudTrackV2[]>
Gets all of a users liked tracks.
Parameters
- userResolvable: string | number
- Optional limit: number
Returns Promise<SoundcloudTrackV2[]>
- Defined in entities/Users.ts:158

playlists

playlists(userResolvable): Promise<SoundcloudPlaylist[]>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudPlaylist[]>

Deprecated
Gets all the playlists by the user.
- Defined in entities/Users.ts:87

search

search(params?): Promise<SoundcloudUser[]>
Parameters
- Optional params: SoundcloudUserFilter
Returns Promise<SoundcloudUser[]>

Deprecated
use searchV2 Searches for users.
- Defined in entities/Users.ts:23

searchAlt

searchAlt(query): Promise<SoundcloudUserV2[]>
Searches for users (web scraping)
Parameters
- query: string
Returns Promise<SoundcloudUserV2[]>
- Defined in entities/Users.ts:197

searchV2

searchV2(params?): Promise<SoundcloudUserSearchV2>
Searches for users using the v2 API.
Parameters
- Optional params: SoundcloudUserFilterV2
Returns Promise<SoundcloudUserSearchV2>
- Defined in entities/Users.ts:31

tracks

tracks(userResolvable): Promise<SoundcloudTrack[]>
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudTrack[]>

Deprecated
Gets all the tracks by the user.
- Defined in entities/Users.ts:60

tracksV2

tracksV2(userResolvable): Promise<SoundcloudTrackV2[]>
Gets all the tracks by the user using Soundcloud v2 API.
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudTrackV2[]>
- Defined in entities/Users.ts:68

webProfiles

webProfiles(userResolvable): Promise<SoundcloudWebProfile[]>
Gets all the web profiles on a users sidebar.
Parameters
- userResolvable: string | number
Returns Promise<SoundcloudWebProfile[]>
- Defined in entities/Users.ts:188