开发文档

unsubscribe

此篇内容尚无原站英文对应版本;切换语言后可浏览英文资料库。
该unsubscribe命令会通知服务器停止发送特定订阅或订阅集的消息。 请求格式的示例:
{
    "id": "Unsubscribe a lot of stuff",
    "command": "unsubscribe",
    "streams": ["ledger","server","transactions","transactions_proposed"],
    "accounts": ["vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"],
    "accounts_proposed": ["vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"],
    "books": [
        {
            "taker_pays": {
                "currency": "STM"
            },
            "taker_gets": {
                "currency": "USD",
                "issuer": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV"
            },
            "both": true
        }
    ]
}
请求中的参数与参数几乎完全相同subscribe,除了它们用于定义要结束的订阅。参数是:
Field Type Description
streams Array (可选)通用流的字符串名称的数组从,包括退订ledger,server,transactions,和transactions_proposed。
accounts Array (可选)用于停止接收更新的唯一Base58帐户地址数组。(如果您之前已专门订阅了这些帐户,则只会停止这些邮件。您不能使用此功能从普通交易流中过滤帐户。)
accounts_proposed Array (可选)类似accounts,但对于accounts_proposed包含尚未验证事务的订阅。
books Array (可选)定义要取消订阅订单的对象数组,如下所述。
rt_accounts和url参数,以及rt_transactions流名称,被弃用,可以在没有进一步的通知被移除。 books数组中的对象的定义与订阅中的对象几乎相同,只是它们没有全部字段。他们的字段如下:
Field Type Description
taker_gets Object 指定接受报价的账户将以哪种货币收到的货币作为具有currency和issuer字段的对象(省略STM的发行者),如货币金额。
taker_pays Object 指定接受报价的账户将支付哪种货币作为具有currency和issuer字段的对象(省略STM的发行者),如货币金额。
both Boolean (可选,默认为false)如果为true,则删除订单两侧的订阅。
一个成功回应的例子:
{
    "id": "Unsubscribe a lot of stuff",
    "result": {},
    "status": "success",
    "type": "response"
}
响应遵循标准格式,成功的结果不包含字段。 可能的错误:
  • 任何通用错误类型。
  • invalidParams - 一个或多个字段指定不正确,或缺少一个或多个必填字段。
  • noPermission- 请求中包含该url字段,但不作为管理员连接。
  • malformedStream- streams请求的字段格式不正确。
  • malformedAccount- 请求中的一个地址accounts或accounts_proposed字段中的地址不是正确格式的STM分类帐地址。
  • 注意:您可以订阅尚未在全局分类帐中输入的地址的流,以便在地址获得资助时收到消息。
  • srcCurMalformed- 请求中taker_pays字段的一个或多个子字段books格式不正确。
  • dstAmtMalformed- 请求中taker_gets字段的一个或多个子字段books格式不正确。
  • srcIsrMalformed- 请求中issuer字段的一个或多taker_pays个子字段的books字段无效。
  • dstIsrMalformed- 请求中issuer字段的一个或多taker_gets个子字段的books字段无效。
  • badMarket- books现场不存在一本或多本所需订单; 例如,为自己交换货币。
THE NEXT CONNECTION

下一次连接,从这里开始。

加入 Stream 社区,一起探索价值互联。

联系我们