/**
 * Copyright © 2016-2026 The Thingsboard Authors
 *
 * 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 org.thingsboard.server.common.data.mobile.layout;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonView;
import io.swagger.v3.oas.annotations.media.DiscriminatorMapping;
import io.swagger.v3.oas.annotations.media.Schema;
import org.thingsboard.server.common.data.Views;

import java.io.Serializable;

@Schema(
        description = "Configuration for a mobile page",
        discriminatorProperty = "type",
        discriminatorMapping = {
                @DiscriminatorMapping(value = "DEFAULT", schema = DefaultMobilePage.class),
                @DiscriminatorMapping(value = "DASHBOARD", schema = DashboardPage.class),
                @DiscriminatorMapping(value = "WEB_VIEW", schema = WebViewPage.class),
                @DiscriminatorMapping(value = "CUSTOM", schema = CustomMobilePage.class)
        }
)
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonTypeInfo(
        use = JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.EXISTING_PROPERTY,
        property = "type")
@JsonSubTypes({
        @JsonSubTypes.Type(value = DefaultMobilePage.class, name = "DEFAULT"),
        @JsonSubTypes.Type(value = DashboardPage.class, name = "DASHBOARD"),
        @JsonSubTypes.Type(value = WebViewPage.class, name = "WEB_VIEW"),
        @JsonSubTypes.Type(value = CustomMobilePage.class, name = "CUSTOM")
})
public interface MobilePage extends Serializable {

    @Schema(requiredMode = Schema.RequiredMode.REQUIRED)
    @JsonView(Views.Private.class)
    MobilePageType getType();

    @JsonView(Views.Private.class)
    boolean isVisible();

}
