TopExtClient | Netease Music SDK 开发文档

Hierarchy

BaseClient
- TopExtClient
  - MusicClient

Index

Properties

user

Accessors

Methods

Properties

user

user: User

用户信息，当手动调用登录或者 load 之后，此对象会自动实例化通过调用 user.toJSON() 获取可以用于存储的对象，当下次实例化的时候，通过 client.load 恢复登录状态

Accessors

cookie

cookie:

isLogin

isLogin:

Methods

checkLogin

checkLogin(): Promise<void>

Inherited from BaseClient.checkLogin
- Defined in client.ts:28
Returns Promise<void>

getTopAlbum

getTopAlbum(area: TopResourceArea, limit?: number, offset?: number): Promise<any>

- Defined in extension/top.ts:79
新碟上架

Parameters
- area: TopResourceArea
- Default value limit: number = 30
- Default value offset: number = 0
Returns Promise<any>

getTopArtist

getTopArtist(limit?: number, offset?: number): Promise<any>

- Defined in extension/top.ts:100
热门歌手

Parameters
- Default value limit: number = 30
- Default value offset: number = 0
Returns Promise<any>

getTopList

getTopList(type: TopListType): Promise<any>

- Defined in extension/top.ts:58
获取排行榜

Parameters
- type: TopListType
Returns Promise<any>

getTopPlaylist

getTopPlaylist(cat: string, order: TopPlaylistOrder, limit?: number, offset?: number): Promise<any>

- Defined in extension/top.ts:122
获取歌单 ( 网友精选碟 )

Parameters
- cat: string
- order: TopPlaylistOrder
- Default value limit: number = 30
- Default value offset: number = 0
Returns Promise<any>

getTopPlaylistHighquality

getTopPlaylistHighquality(cat: string, limit?: number): Promise<any>

- Defined in extension/top.ts:149
获取精品歌单

Parameters
- cat: string
- Default value limit: number = 30
Returns Promise<any>

load

load(store: any): void

Inherited from BaseClient.load
- Defined in client.ts:24
从存储当中恢复用户

Parameters
- store: any
  
  用户的信息，用于恢复使用
Returns void

request

request(host: string, path: string, method: string, payload?: any): Promise<any>

Inherited from BaseClient.request
- Defined in client.ts:34
Parameters
- host: string
- path: string
- method: string
- Default value payload: any = {csrf_token: '',}
Returns Promise<any>

requestWithSetCookie

requestWithSetCookie(host: string, path: string, method: string, payload?: any): Promise<any>

Inherited from BaseClient.requestWithSetCookie
- Defined in client.ts:40
Parameters
- host: string
- path: string
- method: string
- Default value payload: any = {csrf_token: '',}
Returns Promise<any>

Generated using TypeDoc