MessageExtClient | Netease Music SDK 开发文档

Hierarchy

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

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>

sendPlaylistMessage

sendPlaylistMessage(userIds: number | number[], text: string, playlistId: number): Promise<any>

- Defined in extension/message.ts:40
发送私信(带歌单)

说明 : 登陆后调用此接口 , 传入用户 id 和要发送的信息和歌单 id, 可以发送带歌单的私信(注:不能发送重复的歌单)

Parameters
- userIds: number | number[]
  
  用户 ID
- text: string
  
  要发送的私信
- playlistId: number
  
  歌单列表
Returns Promise<any>

sendTextMessage

sendTextMessage(userIds: number | number[], text: string): Promise<any>

- Defined in extension/message.ts:12
发送私信

说明：登陆后调用此接口 , 传入用户 id 和要发送的信息, 可以发送私信,返回内容为历史私信,包含带歌单的私信信息(注:不能发送私信给自己)

Parameters
- userIds: number | number[]
  
  用户 ID
- text: string
  
  要发送的消息
Returns Promise<any>

Generated using TypeDoc