io.getlime.push.model.entity.PushMessageSendResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powerauth-push-model Show documentation

PowerAuth Push Server RESTful Model Classes

There is a newer version: 1.9.1

/*
 * Copyright 2016 Wultra s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.getlime.push.model.entity;

import io.getlime.push.model.enumeration.Mode;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * Class that contains push message sending result data.
 *
 * @author Petr Dvorak, [email protected]
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class PushMessageSendResult extends BasePushMessageSendResult {

    /**
     * Data associated with push messages sent to iOS devices.
     */
    private final PlatformResult ios;

    /**
     * Data associated with push messages sent to Android devices.
     */
    private final PlatformResult android;

    /**
     * Data associated with push messages sent to Huawei devices.
     */
    private final PlatformResult huawei;

    /**
     * Default constructor.
     */
    public PushMessageSendResult() {
        this.ios = new PlatformResult();
        this.android = new PlatformResult();
        this.huawei =  new PlatformResult();
    }

    /**
     * Primary constructor.
     *
     * @param mode Mode of push message sending.
     */
    public PushMessageSendResult(Mode mode) {
        super(mode);
        this.ios = new PlatformResult();
        this.android = new PlatformResult();
        this.huawei =  new PlatformResult();
    }

    /**
     * Result for the platform.
     */
    @Data
    public static class PlatformResult {

        /**
         * Number of messages that were sent successfully.
         */
        private int sent;

        /**
         * Number of messages that were sent with failure
         */
        private int failed;

        /**
         * Number of messages that are still in pending state after attempted sending
         */
        private int pending;

        /**
         * Total number of messages that were attempted to send
         */
        private int total;

    }
}