Class CQApiClient

Inheritance
System.Object
CQApiClient
CQHTTPClient
CQReverseWSClient
CQWebsocketClient
Namespace: cqhttp.Cyan.Clients
Assembly: cqhttp.Cyan.dll
Syntax
public class CQApiClient : object

Constructors

| Improve this Doc View Source

CQApiClient(ICaller, IListener, Boolean, Boolean)

Declaration
public CQApiClient(ICaller caller, IListener listener, bool use_group_table = false, bool use_message_table = false)
Parameters
Type Name Description
ICaller caller
IListener listener
System.Boolean use_group_table
System.Boolean use_message_table

Fields

| Improve this Doc View Source

caller

Declaration
protected ICaller caller
Field Value
Type Description
ICaller
| Improve this Doc View Source

group_table

指向本实例的群组记录对象

Declaration
public GroupTable group_table
Field Value
Type Description
GroupTable
| Improve this Doc View Source

initiate_task

Declaration
protected Task initiate_task
Field Value
Type Description
Task
| Improve this Doc View Source

instance_version_info

当前酷Q实例的各种参数

Declaration
public InstanceVersionInfo instance_version_info
Field Value
Type Description
InstanceVersionInfo
| Improve this Doc View Source

listener

Declaration
protected IListener listener
Field Value
Type Description
IListener
| Improve this Doc View Source

message_table

消息记录

Declaration
public MessageTable message_table
Field Value
Type Description
MessageTable

Properties

| Improve this Doc View Source

alive

表示插件是否正常运行

Declaration
public bool alive { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

initiated

是否已经初始化完成（检查连通性并获取self_id与self_nick）

Declaration
public bool initiated { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

is_pro

连接到的实例是否为酷Q pro

Declaration
public bool is_pro { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

self_id

当前实例的QQ号

Declaration
public long self_id { get; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

self_nick

当前实例的QQ昵称

Declaration
public string self_nick { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

HandleEvent(CQEvent)

Declaration
protected Task<CQResponse> HandleEvent(CQEvent e)
Parameters
Type Name Description
CQEvent e
Returns
Type Description
Task<CQResponse>
| Improve this Doc View Source

Initiate()

检查连通性并获取self_id与self_nick

Declaration
protected System.Threading.Tasks.Task Initiate()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SendMessageAsync(MessageType, Int64, Message)

发送消息(自行构造)

Declaration
public Task<SendmsgResult> SendMessageAsync(MessageType messageType, long target, Message message)
Parameters
Type Name Description
MessageType messageType
System.Int64 target
Message message
Returns
Type Description
Task<SendmsgResult>
| Improve this Doc View Source

SendMessageAsync((MessageType, Int64), Message)

发送消息(自行构造)

Declaration
public Task<SendmsgResult> SendMessageAsync((MessageType, long) target, Message message)
Parameters
Type Name Description
System.ValueTuple<MessageType, System.Int64> target
Message message
Returns
Type Description
Task<SendmsgResult>
| Improve this Doc View Source

SendRequestAsync(ApiRequest)

调用相应API

Declaration
public Task<ApiResult> SendRequestAsync(ApiRequest x)
Parameters
Type Name Description
ApiRequest x
Returns
Type Description
Task<ApiResult>
| Improve this Doc View Source

SendTextAsync(MessageType, Int64, String)

发送纯文本消息

Declaration
public Task<SendmsgResult> SendTextAsync(MessageType messageType, long target, string text)
Parameters
Type Name Description
MessageType messageType
System.Int64 target
System.String text
Returns
Type Description
Task<SendmsgResult>
| Improve this Doc View Source

SendTextAsync((MessageType, Int64), String)

发送纯文本消息

Declaration
public Task<SendmsgResult> SendTextAsync((MessageType, long) target, string text)
Parameters
Type Name Description
System.ValueTuple<MessageType, System.Int64> target
System.String text
Returns
Type Description
Task<SendmsgResult>

Events

| Improve this Doc View Source

OnEvent

Declaration
public event CQApiClient.OnEventDelegate OnEvent
Event Type
Type Description
CQApiClient.OnEventDelegate
| Improve this Doc View Source

OnEventAsync

异步执行命令，忽略返回值

Declaration
public event CQApiClient.OnEventDelegateAsync OnEventAsync
Event Type
Type Description
CQApiClient.OnEventDelegateAsync