com.kucoin.futures.core.KucoinFuturesPrivateWSClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kucoin-futures-java-sdk Show documentation
kucoin-futures-java-sdk
The newest version!
/*
 * Copyright 2019 Mek Global Limited
 */
package com.kucoin.futures.core;

import com.kucoin.futures.core.websocket.KucoinFuturesAPICallback;
import com.kucoin.futures.core.websocket.event.*;
import com.kucoin.futures.core.model.enums.PrivateChannelEnum;

/**
 * Created by chenshiwei on 2019/1/10.
 */
public interface KucoinFuturesPrivateWSClient extends KucoinFuturesPublicWSClient {

    /**
     * When a stop-limit order is triggered, you would receive an activate message which means that this order started the matching life cycle.
     *
     * @param callback
     * @return The subscription UUID, or null if sending failed.
     */
    @Deprecated
    String onStopOrderActivate(KucoinFuturesAPICallback> callback);

    /**
     *
     *
     * @param callback
     * @return
     */
    String onStopOrderLifecycle(KucoinFuturesAPICallback> callback);

    /**
     * You will receive this message when an account balance changes. The message contains the details of the change.
     *
     * @param callback
     * @return The subscription UUID, or null if sending failed.
     */
    String onAccountBalance(KucoinFuturesAPICallback> callback);

    /**
     * You will receive this message when the position changes.
     *
     * @param callback
     * @param symbols
     * @return
     */
    String onPositionChange(KucoinFuturesAPICallback> callback, String ... symbols);

    /**
     * All Position Change Events
     *
     * @param callback
     * @return
     */
    String onPositionAllChange(KucoinFuturesAPICallback> callback);


    /**
     * Margin Mode Change Events
     * @param callback
     * @return
     */
    String onMarginModeChange(KucoinFuturesAPICallback> callback);


    /**
     * Cross Leverage Change Events
     * @param callback
     * @return
     */
    String onCrossLeverageChange(KucoinFuturesAPICallback> callback);

    /**
     * You will receive a message when the specified symbol order changes
     *
     * @param callback
     * @param symbol
     * @return
     */
    String onOrderChange(KucoinFuturesAPICallback> callback, String symbol);


    /**
     * You will receive this message when the order changes.
     *
     * @param callback
     * @return
     */
    String onOrderChange(KucoinFuturesAPICallback> callback);

    /**
     * Unsubscribe from topics you have subscribed to.
     *
     * @param channelEnum
     * @param symbols
     * @return The ID for the unsubscribe request, or null if sending failed.
     */
    String unsubscribe(PrivateChannelEnum channelEnum, String... symbols);

}