GenericTypeAPICallParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.generic.param;

import android.text.TextUtils;
import androidx.annotation.NonNull;

/**
 * 统一类型调用参数
 */
public class GenericTypeAPICallParam {

    /**
     * 调用序列号,调用方产生,在执行结果中带回
     */
    private long sn = 0L;
    /**
     * 调用上下文数据,调用方产生,在执行结果中带回
     */
    private Object data = null;
    /**
     * api 名称
     */
    @NonNull
    private final String name;
    /**
     * api入参，json format
     */
    @NonNull
    private final String param;

    /**
     *
     * @param name api 名称
     * @param param api入参，json format
     *
     */
    public GenericTypeAPICallParam(@NonNull String name, @NonNull String param) {
        this.name = name;
        this.param = param;
    }

    /**
     *
     * @param sn 调用序列号,调用方产生,在执行结果中带回
     * @param data 调用上下文数据,调用方产生,在执行结果中带回
     * @param name api 名称
     * @param param api入参，json format
     */
    public GenericTypeAPICallParam(long sn, Object data, @NonNull String name, @NonNull String param) {
        this.sn = sn;
        this.data = data;
        this.name = name;
        this.param = param;
    }

    /**
     * 获取api 名称
     * @return
     */
    @NonNull
    public String getName() {
        return name;
    }

    /**
     * 获取api入参
     * @return
     */
    @NonNull
    public String getParam() {
        return param;
    }

    /**
     * 获取调用序列号,调用方产生,在执行结果中带回
     * @return
     */
    public long getSn() {
        return sn;
    }

    /**
     * 设置调用序列号,调用方产生,在执行结果中带回
     * @param sn
     */
    public void setSn(long sn) {
        this.sn = sn;
    }

    /**
     * 获取调用上下文数据,调用方产生,在执行结果中带回
     * @return
     */
    public Object getData() {
        return data;
    }

    /**
     * 调用上下文数据,调用方产生,在执行结果中带回
     * @param data
     */
    public void setData(Object data) {
        this.data = data;
    }

    /**
     * 参数是否合法
     * @return
     */
    public boolean isValid(){
        return !TextUtils.isEmpty(name) && !TextUtils.isEmpty(param);
    }
}