SearchExtClient | Netease Music SDK 开发文档

Hierarchy

BaseClient
- SearchExtClient
  - 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>

load

load(store: any): void

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

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

multiSearch

multiSearch(keyword: string, type?: SearchType): Promise<any>

- Defined in extension/search.ts:70
获取多重搜索 PS: 理论上应该会有 Offset 和 Limit 参数，但是经过我的测试，Type 也没有用，不知道这个和 MusicClient#searchSuggest 的区别

Parameters
- keyword: string
- Default value type: SearchType = SearchType.SONG
Returns Promise<any>

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>

search

search(keyword: string, type?: SearchType, limit?: number, offset?: number): Promise<any>

- Defined in extension/search.ts:26
搜索，顾名思义

Parameters
- keyword: string
- Default value type: SearchType = SearchType.SONG
- Default value limit: number = 30
- Default value offset: number = 0
Returns Promise<any>

searchHot

searchHot(): Promise<any>

- Defined in extension/search.ts:88
获取热搜

Returns Promise<any>

searchSuggest

searchSuggest(keyword: string): Promise<any>

- Defined in extension/search.ts:51
获取搜索建议

Parameters
- keyword: string
Returns Promise<any>

Generated using TypeDoc